bin astryx: ./clients/cli/bin/astryx.mjs
bin cli: ./clients/cli/bin/astryx.mjs
no exports
function blog: (slug?: string) => Promise<BlogListResponse | BlogDetailResponse>
function build: (query?: string, options?: { cwd?: string; type?: SearchDomain; limit?: number }) => Promise<BuildHelpResponse | BuildKitResponse>
function component: (name?: string | string[], options?: { cwd?: string | undefined; list?: boolean | undefined; category?: string | undefined; package?: string | undefined; props?: boolean | undefined; source?: boole … #2ac332d1) => Promise<(ComponentListResponse | ComponentBatchResponse | ComponentDetailResponse | ComponentDetailPropsResponse | ComponentDetailSourceResponse | ComponentDeta … #41d44aa7
function discover: (query?: string, options?: DiscoverOptions) => Promise<DiscoverListResponse | DiscoverDetailResponse | DiscoverDetailDocResponse | DiscoverItemResponse | DiscoverSearchResponse>
function docs: (topic?: string, section?: string, options?: { lang?: string | undefined; zh?: boolean | undefined; dense?: boolean | undefined; index?: boolean | undefined; depth?: number | "all" | undefined; detail?: "c … #601fa90d) => Promise<DocsListResponse | DocsIndexResponse | DocsDetailResponse | DocsDetailSectionResponse | DocsNodeResponse>
function doctor: (options?: DoctorOptions) => Promise<{ type: "doctor"; data: DoctorReport }>
function gapReport: (component: string | undefined, options?: GapReportOptions) => Promise<GapReportCategoriesResponse | GapReportReceiptResponse>
function generateTonalPalette: (input: TonalPaletteGenerationInput) => TonalPaletteCandidate
function hook: (name?: string, options?: { cwd?: string | undefined; list?: boolean | undefined; category?: string | undefined; params?: boolean | undefined; detail?: "compact" | "full" | "brief" | und … #9fea52ed) => Promise<{ type: string; data: unknown }>
function icon @experimental: (query?: string, options?: IconOptions) => Promise<IconSearchResponse | IconDetailResponse | IconListResponse | IconSetIconsResponse | IconDefinitionsResponse>
function iconAdd @experimental: (exportName: string | undefined, options: IconAddOptions) => Promise<IconAddResponse | IconDefinitionMatchesResponse | IconAddVariantsResponse>
function iconMap @experimental: (definition: string | undefined, icon: string | undefined, options?: IconMapOptions) => Promise<IconMapResponse | IconMapManyResponse>
function iconNewDefinition @experimental: (name: string, options?: IconNewDefinitionOptions) => Promise<IconNewDefinitionResponse>
function iconNewSet @experimental: (name: string, options?: IconNewSetOptions) => Promise<IconNewSetResponse>
function iconUse @experimental: (selector: string, {…}?: { cwd?: string }) => Promise<IconUseResponse>
function init: (options?: InitOptions, {…}?: { cwd?: string }) => Promise<InitRunResponse | InitRemoveResponse | InitUserResponse>
function integrationAdd: (kind: IntegrationAddKind, name: string, options?: IntegrationAddOptions) => Promise<IntegrationAddResponse>
function integrationAddAgentDoc: (line: string, options?: IntegrationAddAgentDocOptions) => Promise<IntegrationAddResponse>
function integrationAddCodemod: (name: string, options: IntegrationAddCodemodOptions) => Promise<IntegrationAddResponse>
function integrationAddComponent: (name: string, options?: IntegrationAddComponentOptions) => Promise<IntegrationAddResponse>
function integrationAddDoc: (name: string, options?: IntegrationAddDocOptions) => Promise<IntegrationAddResponse>
function integrationAddTemplate: (name: string, options?: IntegrationAddTemplateOptions) => Promise<IntegrationAddResponse>
function integrationAddTheme: (name: string, options?: IntegrationAddThemeOptions) => Promise<IntegrationAddResponse>
function integrationCheck: (options?: IntegrationCheckOptions) => Promise<IntegrationCheckCommandResponse>
function integrationComponentConflicts: (pkg?: string, options?: IntegrationAuthoringOptions) => Promise<IntegrationComponentConflictResponse>
function integrationDocConflicts: (pkg?: string, options?: IntegrationAuthoringOptions) => Promise<IntegrationDocConflictResponse>
function integrationPackCheck: (options?: IntegrationPackCheckOptions) => Promise<IntegrationPackCheckResponse>
function integrationTemplateConflicts: (pkg?: string, options?: IntegrationAuthoringOptions) => Promise<IntegrationTemplateConflictResponse>
function listThemes: () => BundledTheme[]
function search: (query: string, options?: { cwd?: string | undefined; type?: "template" | "component" | "hook" | "theme" | "doc" | undefined; limit?: number | undefined }) => Promise<SearchResponse>
function summarizeIssues: (issues: Issue[]) => { errors: number; warnings: number }
function swizzle: (component?: string, options?: { cwd?: string; output?: string; package?: string; list?: boolean; overwrite?: boolean }) => Promise<SwizzleListResponse | SwizzleCopyResponse>
function template: (name?: string, options?: { targetPath?: string | undefined; overwrite?: boolean | undefined; list?: boolean | undefined; skeleton?: boolean | undefined; cdn?: string | boolean | undefin … #f5e81f6a) => Promise<{ type: string; data: unknown }>
function themeAdd: (slug: string, options?: { targetPath?: string; overwrite?: boolean; import?: boolean; cwd?: string; package?: string }) => Promise<ThemeAppResponse>
function themeBuild: (file: string, options?: { out?: string; check?: boolean; iconsSpecifier?: string }, ctx?: { cwd?: string; projectCore?: boolean }) => Promise<ThemeBuildResponse | ThemeBuildCheckResponse | null>
function themeEject: (slug: string, options?: { targetPath?: string; overwrite?: boolean; cwd?: string; package?: string }) => Promise<ThemeEjectResponse>
function themeList: () => ThemeListResponse
function themeListAvailable: (options?: { cwd?: string; package?: string }) => Promise<ThemeListResponse>
function themeListCopySources: (options?: { cwd?: string; package?: string }) => Promise<ThemeListResponse>
function themePaletteGenerate: (configPath: string, options?: { out?: string; preview?: string; overwrite?: boolean }, {…}?: { cwd?: string }) => ThemePaletteGenerateResponse
function themeRemove: (slug: string, options?: { cwd?: string }) => Promise<ThemeAppResponse>
function themeTargets: (filter?: string, {…}?: { cwd?: string }) => Promise<ThemeTargetsResponse>
function themeTemplate: (options?: { targetPath?: string; overwrite?: boolean; cwd?: string }) => ThemeTemplateResponse
function themeUse: (slug: string, options?: { cwd?: string }) => Promise<ThemeAppResponse>
function upgrade: (options?: UpgradeOptions, {…}?: { cwd?: string }) => Promise<UpgradeListResponse | UpgradeRegistryResponse | UpgradeStatusResponse | UpgradeRunResponse>
function validateIntegration: (pkg?: string, options?: { cwd?: string }) => Promise<ValidateIntegrationResponse>
class AstryxError
code: string
suggestions: Suggestion[] | undefined
inherits Error
const logger: Logger
type AgentDocsSummary
action: "refreshed" | "would-refresh" | "nudge-init" | "error" | "none"
files: string[]
fromVersions: string[]
installedVersion: string
refreshed: boolean
status: "missing" | "stale" | "current"
type BatchResponse<TType extends string, TResult, TCandidate>
data: { count: number; results: BatchRow<TResult, TCandidate>[] }
type: TType
type BatchRow<TResult, TCandidate> = ({ selector: string; status: "found"; result: TResult } | { selector: string; status: "ambiguous"; code: string; error: string; candidates: TCandidate[] } | { s … #243e2d4b
type BlockComponentsReport
findings: []
status: "checked"
unchecked: Array<{ file: string; name: string; reason: string }>
type BlockEntry
category: string
description: string
displayName: string
isShowcase: boolean
name: string
package: string
type BlogDetailData = BlogPost & { feedUrl: string; text: string }
type BlogDetailResponse
data: BlogDetailData
type: "blog.detail"
type BlogListData
feedUrl: string
posts: BlogPost[]
type BlogListResponse
data: BlogListData
type: "blog.list"
type BlogPost
authors?: string[] | undefined
date?: string | undefined
description?: string | undefined
link?: string | undefined
slug: string
textUrl?: string | null | undefined
title: string
type?: string | undefined
type BuildAlternative
command: string
description: string
displayName: string
name: string
package: string
type BuildHelpResponse
data: { playbook: true; title: string; steps: BuildPlaybookStep[]; rules: string[]; related: BuildPlaybookCommand[] }
type: "build.help"
type BuildKitResponse
data: { query: string; hasResults: boolean; matchCount: number; directMatch: boolean; start: BuildStart | null; pages: SearchResultEntry[]; blocks: SearchResultEntry[ … #fe91e123
type: "build.kit"
type BuildOptions
cwd?: string | undefined
limit?: number | undefined
type?: SearchDomain | undefined
type BuildPlaybookCommand
command: string
purpose?: string | undefined
type BuildPlaybookStep
commands: BuildPlaybookCommand[]
returns?: string | undefined
title: string
type BuildStart
alternatives: BuildAlternative[]
basis: "direct" | "closest" | "fallback"
command: string
description: string
displayName: string
name: string
notes?: string[] | undefined
package: string
reason: string
type CliBehindCore
cliVersion: string
command: string
type ComponentBatchCandidate
component: string
installed: true
kind: "component"
package: string
type ComponentBatchResponse = BatchResponse<"component.batch", ComponentSingleResponse, ComponentBatchCandidate>
type ComponentBatchResult = BatchRow<ComponentSingleResponse, ComponentBatchCandidate>
type ComponentBriefEntry
description: string
import: string
name: string
package: string
type ComponentDetailBlocksResponse
data: { component: string; showcase: BlockEntry | null; examples: BlockEntry[]; related: BlockEntry[] }
package: string
type: "component.detail.blocks"
type ComponentDetailPropsResponse
data: ComponentPropDoc[]
package: string
type: "component.detail.props"
type ComponentDetailResponse
data: ComponentDoc & ComponentOwnership & ComponentDetailScope
package: string
type: "component.detail"
type ComponentDetailScope
parentDoc?: string | undefined
type ComponentDetailShowcaseResponse
data: { component: string; aspectRatio: number; source: string }
package: string
type: "component.detail.showcase"
type ComponentDetailSourceResponse
data: { component: string; source: string }
package: string
type: "component.detail.source"
type ComponentListData = ({ detail: "names"; components: Record<string, ComponentListEntry[]> } | { detail: "compact"; components: Record<string, ComponentBriefEntry[]> } | { detail: "f … #e4bf4b19
type ComponentListEntry
import?: string | undefined
name: string
package: string
type ComponentListResponse
data: ComponentListData
type: "component.list"
type ComponentOptions
blocks?: boolean | undefined
category?: string | undefined
cwd?: string | undefined
dense?: boolean | undefined
detail?: "compact" | "full" | "brief" | undefined
lang?: string | undefined
list?: boolean | undefined
package?: string | undefined
props?: boolean | undefined
showcase?: boolean | undefined
source?: boolean | undefined
zh?: boolean | undefined
type ComponentOwnership
import: string
package: string
sourceAvailable: boolean
type ComponentSingleResponse = (ComponentDetailResponse | ComponentDetailPropsResponse | ComponentDetailSourceResponse | ComponentDetailShowcaseResponse | ComponentDetailBlocksResponse)
type CopiedPassage
line: number | null
message: string
otherOwner: "package" | "core"
otherTopic: string
owner: string
passages: number
section: string | null
text: string
topic: string
words: number
type CoreTemplateMatch
name: string
type: "page" | "block"
type DiscoverAvailableEntry
agentDocs?: string[] | undefined
aliases?: string[] | undefined
codemods?: string[] | undefined
components: string[]
description?: string | undefined
docs?: string[] | undefined
iconSets?: string[] | undefined
install?: string | undefined
name: string
package: string
source: string
templates?: string[] | undefined
themes?: string[] | undefined
version?: string | undefined
type DiscoverDetailDocResponse
data: ComponentDoc
package: string
type: "discover.detail.doc"
type DiscoverDetailResponse
data: DiscoverListEntry & { installed: boolean; installedVersion?: string; aliases?: string[]; source?: string; installedAs?: string; install?: string; versions?: DiscoverVersion[] }
package: string
type: "discover.detail"
type DiscoverItemResponse
data: { package: string; version?: string; kind: DiscoverKind; name: string; title?: string; summary?: string; keywords?: string[]; license?: string; iconCount?: numb … #d7b8a6a9
package: string
type: "discover.item"
type DiscoverListEntry
agentDocs?: string[] | undefined
category: string
codemods?: string[] | undefined
components: string[]
description?: string | undefined
displayName?: string | undefined
docs?: string[] | undefined
iconSets?: string[] | undefined
latest?: string | undefined
name: string
package: string
templates?: string[] | undefined
themes?: string[] | undefined
version?: string | undefined
type DiscoverListMeta
available?: DiscoverAvailableEntry[] | undefined
configured?: boolean | undefined
sources?: DiscoverSourceState[] | undefined
type DiscoverListResponse
data: DiscoverListEntry[]
meta?: DiscoverListMeta | undefined
type: "discover.list"
type DiscoverOptions
available?: boolean | undefined
components?: boolean | undefined
installed?: boolean | undefined
lang?: string | undefined
limit?: number | undefined
type?: DiscoverKind | undefined
zh?: boolean | undefined
type DiscoverSearchEntry
component: string
installed: boolean
kind: DiscoverKind | "package"
package: string
summary?: string | undefined
title?: string | undefined
type DiscoverSearchResponse
data: { query: string; matches: DiscoverSearchEntry[]; total?: number }
type: "discover.search"
type DiscoverSourceState
complete?: boolean | undefined
error?: string | undefined
from: string
generatedAt?: string | undefined
name: string
savedAt?: string | undefined
status: "fresh" | "saved" | "failed"
type DocFluff
density: number | null
file: string
kind: "phrase" | "density"
line: number | null
message: string
phrase: string | null
section: string | null
topic: string
type DocLink = DocLink
type DocNamesReport
findings: []
status: "checked"
unchecked: Array<{ file: string; name: string; reason: string }>
type DocTypesReport = DocTypesReport & { fixtures?: number }
type DocsCommand = "astryx docs" | `astryx docs ${string}`
type DocsDetailResponse
data: Omit<DocsReadDoc, "sections"> & { sections: DocsDetailSection[]; links: DocsLinks; replacedPackage?: string }
package: string
type: "docs.detail"
type DocsDetailSection = DocsReadSection & { package: string }
type DocsDetailSectionResponse
data: DocsReadSection & { links: DocsLinks }
package: string
type: "docs.detail.section"
type DocsIndex
description: string
links: DocsLinks
name: string
replacedPackage?: string | undefined
replaces?: string | undefined
sections: DocsIndexSection[]
title: string
type DocsIndexEntry
id: string
summary: string
title: string
type DocsIndexResponse
data: DocsIndex
package: string
type: "docs.index"
type DocsIndexSection = DocsIndexEntry & { package: string }
type DocsLinks
next?: DocsCommand | undefined
previous?: DocsCommand | undefined
related?: DocsCommand[] | undefined
up: DocsCommand
type DocsListEntry
description: string
package: string
replacedPackage?: string | undefined
replaces?: string | undefined
topic: string
type DocsListNamespace
description: string
package: string
topic: string
type DocsListResponse
data: DocsListEntry[]
meta?: { namespaces?: DocsListNamespace[]; notLoaded?: Array<{ package: string; message: string }> } | undefined
type: "docs.list"
type DocsNode
breadcrumb: DocsNodeLink[]
childCount?: number | undefined
content: ReferenceContentBlock[]
id: string | null
kind: string
links: DocsLinks
package: string
route: string
slots: DocsNodeSlot[]
stability?: "experimental" | undefined
summary: string
title: string
type DocsNodeChild
childCount?: number | undefined
content?: ReferenceContentBlock[] | undefined
kind: string
name: string
package: string
replacedPackage?: string | undefined
replaces?: string | undefined
route: string
sections?: DocsReadSection[] | undefined
slots?: DocsNodeSlot[] | undefined
stability?: "experimental" | undefined
summary: string
title: string
type DocsNodeLink
route: string
title: string
type DocsNodeResponse
data: DocsNode
package: string
type: "docs.node"
type DocsNodeSlot
children: DocsNodeChild[]
name: string
title: string
type DocsOptions
cwd?: string | undefined
dense?: boolean | undefined
depth?: number | "all" | undefined
detail?: "compact" | "full" | "brief" | undefined
index?: boolean | undefined
lang?: string | undefined
zh?: boolean | undefined
type DocsReadDoc = Omit<ReferenceDoc, "sections"> & { sections: DocsReadSection[] }
type DocsReadSection = Omit<ReferenceSection, "content" | "before" | "after"> & { content: ReferenceContentBlock[] }
type DoctorCheck
fix?: string | undefined
id: string
label: string
message: string
status: DoctorStatus
type DoctorOptions
built?: string | undefined
cwd?: string | undefined
type DoctorResponse
data: { checks: DoctorCheck[]; summary: DoctorSummary }
type: "doctor"
type DoctorStatus = "pass" | "warn" | "fail" | "info"
type DoctorSummary
fail: number
info: number
pass: number
warn: number
type GapReportAggregateStatus = "filed" | "partial" | "failed" | "routed_only" | "consent_required" | "skipped"
type GapReportCategoriesResponse
data: GapReportCategoryEntry[]
meta?: { destinations: GapReportDestination[]; ask: string } | undefined
type: "gap-report.categories"
type GapReportCategory = "missing_component" | "missing_variant" | "layout_gap" | "styling_gap" | "a11y_gap" | "api_friction" | "docs_gap" | "other"
type GapReportCategoryEntry
label: string
value: GapReportCategory
type GapReportDelivery
audience: "internal" | "public" | null
handler: string
handlerType: "project" | "integration" | "fallback"
message: string | null
status: GapReportDeliveryStatus
url: string | null
type GapReportDeliveryStatus = "filed" | "routed_only" | "skipped" | "failed" | "consent_required"
type GapReportDestination
default: boolean
issuesUrl: string | null
to: string | null
type GapReportOptions
category?: GapReportCategory | undefined
confirmPublic?: boolean | undefined
cwd?: string | undefined
detail?: string | undefined
listCategories?: boolean | undefined
package?: string | undefined
reason?: string | undefined
to?: string | undefined
type GapReportReceipt
ask?: string | undefined
deliveries: GapReportDelivery[]
destinations?: GapReportDestination[] | undefined
filedCount: number
issuesUrl: string | null
package: string
routedOnlyCount: number
status: GapReportAggregateStatus
type GapReportReceiptResponse
data: GapReportReceipt
type: "gap-report.file"
type HookBriefEntry
description: string
import: string
name: string
type HookDetailParamsResponse
data: HookParamDoc[]
package: string
type: "hook.detail.params"
type HookDetailResponse
data: HookDoc
package: string
type: "hook.detail"
type HookDoc = HookDoc
type HookListData = { detail: "names"; components: Record<string, string[]> } | { detail: "compact"; components: Record<string, HookBriefEntry[]> } | { detail: "full"; components: Record<string, HookDoc[]> }
type HookListResponse
data: HookListData
package: string
type: "hook.list"
type HookOptions
category?: string | undefined
cwd?: string | undefined
detail?: "compact" | "full" | "brief" | undefined
lang?: string | undefined
list?: boolean | undefined
params?: boolean | undefined
zh?: boolean | undefined
type HookParamDoc = HookParamDoc
type IconSetCoverage
set: string
suggestions: Array<{ definition: string; icon: string }>
unchecked: Array<{ icon?: string; adapter?: string; entry?: string; reason: string }>
unmappedDefinitions: Array<{ name: string; description: string; words: string[] }>
type InitOptions
agent?: string | undefined
agentDocsPath?: string | string[] | undefined
all?: boolean | undefined
features?: string | undefined
removeAgents?: boolean | undefined
templateName?: string | undefined
user?: boolean | undefined
type InitRemoveResponse
data: { removed: boolean }
type: "init.remove"
type InitRunData
docsError: { kind: "path-safety" | "install-failed"; message?: string } | null
docsWritten: string[]
features: string[]
mode: "default" | "features"
nextSteps: boolean
template: "workflow" | "created" | "skipped" | null
templatePath: string | null
theme: boolean
themeTemplate: "created" | "skipped" | "failed" | null
themeTemplatePath: string | null
type InitRunResponse
data: InitRunData
type: "init.run"
type InitUserAction = "written" | "linked" | "unchanged" | "removed" | "absent" | "kept"
type InitUserData
command: string
files: InitUserFile[]
warnings: string[]
type InitUserFile
action: InitUserAction
path: string
reason?: "edited" | "not-astryx" | undefined
type InitUserResponse
data: InitUserData
type: "init.user"
type IntegrationAddAgentDocOptions = IntegrationAddBaseOptions
type IntegrationAddBaseOptions
cwd?: string | undefined
dryRun?: boolean | undefined
type IntegrationAddCodemodOptions = IntegrationAddBaseOptions & { to: string }
type IntegrationAddComponentOptions = IntegrationAddBaseOptions
type IntegrationAddData
dryRun: boolean
files: string[]
from?: string | undefined
kind: "theme" | "component" | "doc" | "template" | "codemod" | "agent-doc"
manifest: string
name: string
root: { path: string; created: boolean } | null
written: boolean
type IntegrationAddDocOptions = IntegrationAddBaseOptions & { replaces?: string; extends?: string; parent?: string }
type IntegrationAddKind = "theme" | "component" | "doc" | "template" | "codemod" | "agent-doc"
type IntegrationAddOptions
cwd?: string | undefined
dryRun?: boolean | undefined
extends?: string | undefined
from?: string | undefined
parent?: string | undefined
replaces?: string | undefined
templateType?: "page" | "block" | undefined
to?: string | undefined
type IntegrationAddResponse
data: IntegrationAddData
type: "integration.add"
type IntegrationAddTemplateOptions = IntegrationAddBaseOptions & { type?: "page" | "block" }
type IntegrationAddThemeOptions = IntegrationAddBaseOptions & { from?: string }
type IntegrationAuthoringOptions
cwd?: string | undefined
type IntegrationCheckCommandResponse
data: { validated: boolean; name: string | null; version: string | null; strict: boolean; next: boolean; checks: IntegrationCheckResult[]; errors: number; warnings: n … #a9648d16
type: "integration.check"
type IntegrationCheckFailure
check: IntegrationCheckName
code: string
component?: string | undefined
file?: string | undefined
fix?: string | undefined
line?: number | undefined
message: string
prop?: string | undefined
severity: "error"
type IntegrationCheckName = "validate" | "components" | "templates" | "docs"
type IntegrationCheckOptions
cwd?: string | undefined
next?: boolean | undefined
strict?: boolean | undefined
type IntegrationCheckReport
findings: Array<{ severity?: string }>
reason?: string | undefined
status: "checked" | "skipped"
type IntegrationCheckResponse = ValidateIntegrationResponse | IntegrationComponentConflictResponse | IntegrationTemplateConflictResponse | IntegrationDocConflictResponse
type IntegrationCheckResult
check: IntegrationCheckName
errors: number
failed: boolean
response: IntegrationCheckResponse
skipped: string[]
warnings: number
type IntegrationComponentConflict
command: string
integrationPackage: string
message: string
name: string
severity: "warning"
type IntegrationComponentConflictResponse
data: { validated: boolean; name: string | null; version: string | null; conflicts: IntegrationComponentConflict[]; issues: AstryxIntegrationIssue[]; propDrift?: PropDriftReport }
type: "integration.component-conflicts"
type IntegrationDocConflictResponse
data: { validated: boolean; name: string | null; version: string | null; findings: IntegrationDocFinding[]; copiedPassages: CopiedPassage[]; fluff: DocFluff[]; strayP … #50d658c0
type: "integration.doc-conflicts"
type IntegrationDocFinding
coreTopic: string
message: string
relationship: "replaces" | "extends" | "accidental"
severity: "info" | "error"
topic: string
type IntegrationPackCheckOptions
cwd?: string | undefined
type IntegrationPackCheckResponse
data: PackCheckData
type: "integration.pack-check"
type IntegrationTemplateConflict
command: string
coreMatches: CoreTemplateMatch[]
id: string
integrationName: string
integrationPackage: string
integrationType: "page" | "block"
message: string
severity: "warning"
type IntegrationTemplateConflictResponse
data: { validated: boolean; name: string | null; version: string | null; conflicts: IntegrationTemplateConflict[]; issues: AstryxIntegrationIssue[] }
type: "integration.template-conflicts"
type LoadedIntegration
__declaredKeys?: string[] | undefined
__manifestFile: string
__packageDir: string
__spec: string
__unknownKeys?: string[] | undefined
codemods?: string | undefined
components?: string | undefined
docs?: string | undefined
issuesUrl?: string | undefined
name: string
templates?: string | undefined
version?: string | undefined
type Logger = Logger
type OlderCliNote
field: "stability" | "icons"
file: string
kind: "template" | "namespace"
message: string
type PackCheckContributionIdentities
agentDocsAppend: string[]
codemods: { version: string; id: string }[]
components: string[]
docs: string[]
iconSets?: string[] | undefined
templates: { id: string; type: string; name: string; replaces?: string }[]
themes: { slug: string; exportName: string }[]
type PackCheckData
contributions: { local: PackCheckContributionIdentities | null; packed: PackCheckContributionIdentities | null }
inventory: PackCheckInventory
issues: AstryxIntegrationIssue[]
name: string | null
packable: boolean
tarball: PackCheckTarball | null
version: string | null
type PackCheckInventory
expectedFiles: number
manifest: string | null
packedFiles: number
roots: PackCheckInventoryRoot[]
type PackCheckInventoryRoot
complete: boolean
expectedFiles: number
kind: "themes" | "components" | "templates" | "codemods" | "docs" | "iconSets"
missingFiles: string[]
path: string
type PackCheckResponse = IntegrationPackCheckResponse
type PackCheckTarball
fileCount: number
filename: string
size: number
unpackedSize: number
type PropDriftFinding = PropDriftFinding
type PropDriftReport = PropDriftReport
type ProtectedCodemodFile
codemods: string[]
commands: string[]
declarations: string[]
file: string
reasons: string[]
type PublicImportUnchecked
file: string
reason: string
specifier: string
type PublicImportsReport
findings: never[]
status: "checked"
unchecked: PublicImportUnchecked[]
type RegenerateFile
codemods: string[]
commands: string[]
file: string
messages: string[]
type RegistryCompositionFileSummary
action: "current" | "user-modified" | "would-update" | "updated" | "would-merge" | "merged" | "would-refresh-receipt" | "receipt-refreshed" | "conflict" | "missing" | "invalid" | "target-changed"
conflictFile?: string | undefined
message?: string | undefined
path: string
type RegistryCompositionItemSummary
action: "current" | "user-modified" | "would-update" | "updated" | "would-merge" | "merged" | "would-refresh-receipt" | "receipt-refreshed" | "conflict" | "invalid" | "fetch-error" | "write-error"
files: RegistryCompositionFileSummary[]
item: string
message?: string | undefined
path?: string | undefined
type RegistryCompositionSummary
applied: boolean
conflicts: number
current: number
failed: number
found: number
invalid: number
items: RegistryCompositionItemSummary[]
merged: number
missing: number
ok: boolean
receiptsRefreshed: number
updated: number
wouldMerge: number
wouldRefreshReceipt: number
wouldUpdate: number
type SearchDomain = "component" | "hook" | "doc" | "template" | "theme"
type SearchOptions
cwd?: string | undefined
limit?: number | undefined
type?: SearchDomain | undefined
type SearchResponse
data: { query: string; matchCount: number; results: SearchResultEntry[] }
meta?: { partial?: { skipped: SearchDomain[]; reason: string } } | undefined
type: "search"
type SearchResultEntry
command: string
description: string
displayName?: string | undefined
domain: SearchDomain
import?: string | undefined
kind?: "page" | "block" | undefined
name: string
package: string
parent?: string | undefined
reason: string
score: number
section?: string | undefined
title?: string | undefined
type StrayPointer
field: string | null
file: string
kind: "topic" | "component"
line: number | null
link: string
message: string
pointer: string
section: string | null
topic: string
type SwizzleCopyResponse
data: { component: string; package: string; outputDir: string; filesCopied: number; files: string[]; usesStyleX: boolean; feedback?: SwizzleFeedback | undefined }
package: string
type: "swizzle.copy"
type SwizzleFeedback
ghCommand?: string | undefined
issuesUrl: string
type SwizzleListResponse
data: string[]
package: string
type: "swizzle.list"
type SwizzleOptions
cwd?: string | undefined
list?: boolean | undefined
output?: string | undefined
overwrite?: boolean | undefined
package?: string | undefined
type TemplateCdnResponse
data: { path: string; version: string; written: boolean; reason: "exists" | null }
type: "template.cdn"
type TemplateCopyResponse
data: { template: string; outputDir: string; fileName: string; filesCopied: number; demoMediaReplaced: number; demoContentReplaced: number; notes: string[]; missingPa … #84827e49
package: string
type: "template.copy"
type TemplateIconsReport
kept: Array<{ module: string | null; export: string; reason: string; suggestion?: { set: string; id: string; module: string; export: string; confidence: "likely" } }>
mapped: Array<{ source: { module: string; export: string }; target: { set: string; package: string; id: string; module: string; export: string }; by: "match" | "definition"; dropped?: string[] }>
reason: string
set: string | null
status: "selected" | "none" | "ambiguous" | "missing" | "withdrawn"
type TemplateListEntry
alsoExampleFor?: string[] | undefined
alsoShowcaseFor?: string[] | undefined
aspectRatio?: number | undefined
category?: string | undefined
componentsUsed?: string[] | undefined
description: string
displayName?: string | undefined
exampleFor?: string | undefined
id: string
isReady: boolean
isShowcase?: boolean | undefined
name: string
package: string
replaces?: string | undefined
scaffold?: boolean | undefined
type: "page" | "block"
type TemplateListResponse
data: TemplateListEntry[]
type: "template.list"
type TemplateOptions
cdn?: string | boolean | undefined
list?: boolean | undefined
package?: string | undefined
show?: boolean | undefined
skeleton?: boolean | undefined
type?: "page" | "block" | undefined
type TemplateShowResponse
data: { template: string; description: string; type: "page" | "block"; components: string[]; source: string; demoMediaReplaced: number; demoContentReplaced: number; icons?: TemplateIconsReport | undefined }
package: string
type: "template.show"
type TemplateSkeletonResponse
data: { template: string; description: string; components: string[]; skeleton: string }
package: string
type: "template.skeleton"
type ThemeAppEntry
fontStylesheet?: string | undefined
module: string
owner: string
slug: string
source: "bundled" | "package" | "local"
stylesheet: string
type ThemeAppResponse
data: { themes: ThemeAppEntry[]; default: string; modulePath: string; change: { action: "add" | "remove" | "use"; slug: string; changed: boolean; firstAdd: boolean } }
package?: string | undefined
type: "theme.app"
type ThemeBuildBatchResponse
data: { count: number; results: Array<{ file: string; receipt: ThemeBuildResponse | ThemeBuildCheckResponse | null }> }
type: "theme.build.batch"
type ThemeBuildCheckResponse
data: { name: string; upToDate: boolean; stale: Array<{ path: string; reason: "missing" | "outdated" }>; checked: string[] }
type: "theme.build.check"
type ThemeBuildResponse
data: { name: string; tokenCount: number; componentCount: number; sizeKB: number; outputs: { css: string; cssDts: string; js: string; dts: string; variantsDts?: strin … #6bfc32a4
type: "theme.build"
type ThemeEjectResponse
data: { slug: string; displayName: string; maintained: boolean; package: string; outputDir: string; entry: string; exportName: string; files: string[] }
type: "theme.eject"
type ThemeListEntry
description: string
displayName: string
maintained: boolean
package?: string | undefined
slug: string
type ThemeListResponse
data: ThemeListEntry[]
meta?: { unmigratedCopies: ThemeUnmigratedCopy[] } | undefined
type: "theme.list"
type ThemePaletteGenerateResponse
data: { recipe: "astryx-oklch-v1"; status: "candidate"; familyCount: number; stopCount: number; modes: string[]; output: string | null; receipt: string | null; previe … #f5a77735
type: "theme.palette.generate"
type ThemeTargetEntry
className: string
component: string
key: string
props: string[]
states: string[]
type ThemeTargetsResponse
data: { filter: string | null; componentCount: number; targets: ThemeTargetEntry[] }
type: "theme.targets"
type ThemeTemplateResponse
data: { path: string; written: boolean; reason: "exists" | null }
type: "theme.template"
type ThemeUnmigratedCopy
descriptor: string
path: string
slug: string
source: string
upgradeCommand: string
type TonalPaletteAnchor
color: string
maxDeltaE?: number | undefined
mode: "light" | "dark"
policy: "exact" | "bounded" | "flexible"
stop: number
type TonalPaletteCandidate
black: "#000000"
palette: Record<string, { name: string; light?: Record<string, string>; dark?: Record<string, string> }>
recipe: "astryx-oklch-v1"
schemaVersion: 1
status: "candidate"
stops: number[]
white: "#ffffff"
type TonalPaletteCoordinationDiagnostics
chromaRatio: number | null
closestFamilies: [string, string] | null
minimumFamilyDeltaE: number | null
mode: "light" | "dark"
stop: number
strongestFamily: string | null
weakestFamily: string | null
type TonalPaletteFamilyInput
anchors?: TonalPaletteAnchor[] | undefined
id: string
kind?: "neutral" | "chromatic" | undefined
name?: string | undefined
seed: string
type TonalPaletteGenerationInput
families: TonalPaletteFamilyInput[]
modeStrategy?: "light-only" | "dark-only" | "light-and-dark" | undefined
neutralProfile?: "custom" | "neutral-v1" | "warm-v1" | "cool-v1" | undefined
stops?: number[] | undefined
vibrancy?: number | undefined
type TonalPaletteGenerationReceipt
candidateFormatVersion: "palette-typescript-v1" | "palette-json-v1"
candidateSha256: string
diagnostics: { families: Record<string, { light?: TonalPaletteRampDiagnostics; dark?: TonalPaletteRampDiagnostics }>; coordination: TonalPaletteCoordinationDiagnostics[] }
generatorVersion: "palette-generator-v1"
preview?: { version: string; sha256: string } | undefined
recipe: "astryx-oklch-v1"
request: TonalPaletteNormalizedRequest
schemaVersion: 1
type TonalPaletteNormalizedRequest
families: Array<{ id: string; name: string; seed: string; kind: "chromatic" | "neutral"; anchors: TonalPaletteAnchor[] }>
modeStrategy: "light-only" | "dark-only" | "light-and-dark"
neutralProfile: "neutral-v1" | "warm-v1" | "cool-v1" | "custom"
recipe: "astryx-oklch-v1"
stops: number[]
vibrancy: number
type TonalPaletteRampDiagnostics
anchors: Array<TonalPaletteAnchor & { generatedColor: string; deltaE: number }>
gamutMappedStops: number[]
hueIdentityRisk: "blue-to-purple" | "yellow-to-brown" | null
maximumAdjacentDeltaE: number
maximumHueDrift: number
minimumAdjacentDeltaE: number
monotonic: boolean
type UpgradeFailureReceipt = UpgradeRunResponse["data"]
type UpgradeListEntry
name: string
optional: boolean
package: string
title: string
version: string
type UpgradeListResponse
data: UpgradeListEntry[]
type: "upgrade.list"
type UpgradeOptions
apply?: boolean | undefined
codemod?: string | undefined
force?: boolean | undefined
from?: string | undefined
installDeps?: boolean | undefined
integration?: string[] | undefined
list?: boolean | undefined
path?: string | undefined
registry?: boolean | undefined
skipCodemod?: string[] | undefined
type UpgradeRegistryResponse
data: RegistryCompositionSummary
type: "upgrade.registry"
type UpgradeRunResponse
data: { from: string; to: string; codemods: number; integrations: string[]; agentDocsRefreshed: boolean; agentDocs: AgentDocsSummary; sourcePathFound: boolean; regist … #9586693f
type: "upgrade.run"
type UpgradeStatusResponse
data: { status: "up_to_date"; from: string; to: string; agentDocs: AgentDocsSummary; registryCompositions?: RegistryCompositionSummary } | { status: "no_codemods"; fr … #1f9b5984
type: "upgrade.status"
type ValidateIntegrationOptions
cwd?: string | undefined
type ValidateIntegrationResponse
data: { validated: boolean; name: string | null; version: string | null; issues: AstryxIntegrationIssue[]; notes?: Array<{ code: string; message: string; next?: boole … #8a3ce43f
type: "integration.validate"
function render @experimental: (file: string, options?: RenderOptions) => Promise<RenderPageResponse | RenderReverseResponse>
type RenderOptions
cwd?: string | undefined
out?: string | undefined
overwrite?: boolean | undefined
reverse?: boolean | undefined
title?: string | undefined
type RenderPageResponse
data: { input: string; output: string; bytes: number; files: string[]; stylesheets: string[]; classes: number; cssBytes: number; images: number; warnings: RenderWarning[] }
type: "render.page"
type RenderReverseResponse
data: { input: string; mode: "embedded" | "rebuilt"; output: string; files: string[]; exact: boolean; missing?: string[] | undefined; components?: string[] | undefine … #2d35150e
type: "render.reverse"
type RenderWarning
code: "dropped-children" | "remote-asset" | "missing-asset" | "page-output" | "page-script" | "no-astryx-styles" | "chart-size" | "not-embedded"
message: string
function parseCodemod: (input: unknown, label?: string) => AstryxCodemod | AstryxConfigCodemod
function parseCommand: (input: unknown, label?: string) => CommandDoc
function parseComponent: (input: unknown, label?: string) => ComponentDoc
function parseConfig: (input: unknown, label?: string) => AstryxConfig
function parseDebugEvent: (input: unknown, label?: string) => DebugEvent
function parseDiscoverCatalog: (value: unknown, label?: string, {…}?: { iconSets?: boolean }) => DiscoverCatalog
function parseDoc: (input: unknown, label?: string) => ComponentDoc | HookDoc | FunctionDoc | ReferenceDoc | TemplateDoc | SchemaDoc | CommandDoc | EnumDoc | NamespaceDoc | ThemeDoc | IconSetDoc | IconDefinitionDoc
function parseEnum: (input: unknown, label?: string) => EnumDoc
function parseFunction: (input: unknown, label?: string) => FunctionDoc
function parseGapReportHandler: (input: unknown, label?: string) => GapReportHandler
function parseGapReportReceipt: (input: unknown) => GapReportHandlerReceipt | null
function parseHook: (input: unknown, label?: string) => HookDoc
function parseIconDefinition @experimental: (input: unknown, label?: string) => IconDefinitionDoc
function parseIconSet @experimental: (input: unknown, label?: string) => IconSetDoc
function parseIconSetData @experimental: (input: unknown, label?: string) => IconSetData
function parseIntegration: (input: unknown, label?: string) => AstryxIntegration
function parseLegacyDoc: (input: unknown, label?: string) => ComponentDoc | HookDoc | ReferenceDoc
function parseNamespace: (input: unknown, label?: string) => NamespaceDoc
function parseReference: (input: unknown, label?: string) => ReferenceDoc
function parseSchema: (input: unknown, label?: string) => SchemaDoc
function parseTemplate: (input: unknown, label?: string) => TemplateDoc
function parseTheme: (input: unknown, label?: string) => ThemeDoc
type ArtifactId = string & {readonly [artifactIdBrand]: true}
interface ArtifactIdentity
id: ArtifactId
kind: ContributionKind
name: string
providerId: ProviderId
interface AstryxCodemod extends AstryxCodemodDef
description?: string
fileExtensions?: string[]
isOptional: boolean
title: string
transform: AstryxCodemodTransform
type: 'code'
interface AstryxCodemodApi
jscodeshift: unknown
report: (...args: unknown[]) => void
stats: (...args: unknown[]) => void
interface AstryxCodemodDef
description?: string
fileExtensions?: string[]
isOptional?: boolean
title: string
transform: AstryxCodemodTransform
interface AstryxCodemodFile
path: string
source: string
type AstryxCodemodTransform = ( file: AstryxCodemodFile, api: AstryxCodemodApi, ) => string | null | undefined
interface AstryxConfig
debug?: DebugConfig
discover?: DiscoverSource
experimental?: { xle?: { components?: Record<string, XleComponent> }; iconSet?: string } @experimental
gapReport?: GapReportHandler
hooks?: { postCodemod?: PostCodemodHook[] }
integrations?: string[]
issuesUrl?: string
interface AstryxConfigCodemod extends AstryxConfigCodemodDef
description?: string
isOptional: boolean
title: string
transform: AstryxCodemodTransform
type: 'config'
interface AstryxConfigCodemodDef
description?: string
isOptional?: boolean
title: string
transform: AstryxCodemodTransform
interface AstryxIntegration
agentDocs?: { append?: readonly string[] }
cliCommand?: string
codemods?: string
components?: string
docs?: string
docsiteUrl?: string
experimental?: { iconSets?: string } @experimental
issuesUrl?: string
providerId?: string
templates?: string
themes?: string
type AuthoredDoc = | ComponentDoc | HookDoc | FunctionDoc | ReferenceDoc | TemplateDoc | SchemaDoc | CommandDoc | EnumDoc | NamespaceDoc | IconDefinitionDoc
interface AuthoredDocEntry<TDoc extends AuthoredDoc = AuthoredDoc>
authored: AuthoredDocSnapshot<TDoc>
id: DocId
kind: AuthoredDocKindOf<TDoc>
provider: ProviderInstance
source: AuthoredDocSource
stableName: string
interface AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
placement?: DocPlacement
stability?: 'experimental'
type AuthoredDocKind = | 'component' | 'function' | 'generic' | 'page' | 'block' | 'schema' | 'command' | 'enum' | 'namespace' | 'icon-definition'
type AuthoredDocKindOf<TDoc extends AuthoredDoc> = TDoc extends ComponentDoc ? 'component' : TDoc extends HookDoc | FunctionDoc ? 'function' : TDoc extends ReferenceDoc ? 'generic' : TDoc extends TemplateDoc ? T … #52eec1cb
type AuthoredDocSnapshot<TDoc extends AuthoredDoc = AuthoredDoc> = DeepReadonly<TDoc>
interface AuthoredDocSource
digest: ContentDigest
group: string
path: string
interface CollectionDocBlock
presentation?: 'list' | 'cards' | 'compact'
source: {slot: string}
title?: string
type: 'collection'
whenEmpty?: 'show' | 'omit'
interface CommandArgDoc
description?: string
name: string
param?: string
required?: boolean
variadic?: boolean
interface CommandDoc extends AuthoredDocGraphFields
aliases?: string[]
args?: CommandArgDoc[]
audience?: DocAudience
deprecated?: string
description?: string
displayName: string
examples?: CommandExampleDoc[]
exitCodes?: {code: number; when: string}[]
fn?: string
name: string
namespace?: string
notes?: ReferenceContentBlock[]
options?: CommandOptionDoc[]
outsideProject?: CommandOutsideProject
placement?: DocPlacement
related?: string[]
stability?: 'experimental'
subcommands?: string[]
summary: string
type?: 'command'
interface CommandExampleDoc
cli: string
label?: string
output?: string
interface CommandOptionDoc
choices?: string[]
cliOnly?: boolean
default?: string | boolean | string[]
description?: string
flag: string
param?: string
type CommandOutsideProject = 'same' | 'refuse' | 'own'
interface ComponentAccessibilityRequirement
category?: 'Color contrast' | 'Keyboard' | 'Semantics' | 'Content'
criterion?: string
description: string
name: string
requirement?: string
states?: string[]
type ComponentAccessibilityThemeApplicability = 'Required' | 'Conditional' | 'Supplemental' | 'Decorative'
interface ComponentAccessibilityThemeCoverage
notMeasured?: string[]
tables: ComponentAccessibilityThemeTable[]
theme: string
interface ComponentAccessibilityThemeMeasurement
applicability?: ComponentAccessibilityThemeApplicability
breakdown?: Array<{ label: string; value: string; detail?: string; colorPair: { foreground: string; background: string }; status?: 'Pass' | 'Fail' }>
colorPair?: { foreground: string; background: string }
detail?: string
label: string
status?: 'Pass' | 'Fail'
value: string
interface ComponentAccessibilityThemeMode
mode: 'Light' | 'Dark'
results: ComponentAccessibilityThemeResult[]
interface ComponentAccessibilityThemeResult
measurements: ComponentAccessibilityThemeMeasurement[]
name: string
status: ComponentAccessibilityThemeStatus
type ComponentAccessibilityThemeStatus = 'Pass' | 'Fail' | 'Not tested'
interface ComponentAccessibilityThemeTable
description?: string
modes: ComponentAccessibilityThemeMode[]
title?: string
interface ComponentAnatomyElement
description: string
name: string
required: boolean
interface ComponentBestPractice
description: string
guidance: boolean
type ComponentDoc = SingleComponentDoc | MultiComponentDoc | SubComponentDoc
interface ComponentEntry
description: string
displayName: string
examples?: ComponentExampleDoc[]
isHiddenFromOverview?: boolean
name: string
params?: HookParamDoc[]
playground?: ComponentPlaygroundConfig
props?: ComponentPropDoc[]
registry?: RegistryDocIdentity
relatedComponents?: string[]
relatedHooks?: string[]
returns?: HookReturnDoc[]
usage?: UsageDoc
interface ComponentExampleDoc
code: string
label?: string
interface ComponentGroupDoc
canonical: string
description: string
name: string
interface ComponentPlaygroundConfig
appShellMobile?: boolean
defaults?: Record<string, unknown>
overlay?: boolean
overlayControl?: { stateProp: string; openValue: unknown }
wrapper?: { component: string; props?: Record<string, unknown>; slotProp?: string }
interface ComponentPropDoc
default?: string
description: string
name: string
required?: boolean
slotElements?: ComponentSlotElement[]
stability?: 'experimental'
type: string
interface ComponentSlotElement
__element: string
children?: string | ComponentSlotElement | (string | ComponentSlotElement)[]
props?: Record<string, unknown>
interface ComponentThemingDerivedVar
expand?: 'container'
property: string
replaces?: boolean
vars?: string[]
interface ComponentThemingTarget
className: string
states?: string[]
visualProps?: string[]
interface ComponentThemingVar
default: string
derived?: boolean
description: string
formula?: string
name: string
private?: boolean
interface ComponentTranslationDoc
components?: { name: string; displayName?: string; description: string; propDescriptions?: Record<string, string>; isHiddenFromOverview?: boolean }[]
description?: string
displayName?: string
name?: string
propDescriptions?: Record<string, string>
usage?: { description?: string; bestPractices?: ComponentBestPractice[]; accessibility?: ComponentAccessibilityRequirement[]; anatomy?: ComponentAnatomyElement[] }
type ContentDigest = string & {readonly [contentDigestBrand]: true}
type ContributionKind = AuthoredDocKind | 'theme' | 'codemod' | 'agent-doc'
type DebugConfig = DebugEventHandler
interface DebugEvent
args: Record<string, unknown>
argv: string[]
command: string
commandPath: string[]
durationMs: number
endedAt: string
env: DebugEventEnv
error: DebugEventError | null
exitCode: number | null
globalOptions: Record<string, unknown>
id: string
optionSources: Record<string, DebugOptionSource>
options: Record<string, unknown>
outcome: DebugOutcome
output: DebugEventOutput
project: DebugEventProject
redacted: boolean
schemaVersion: DebugSchemaVersion
signal: string | null
startedAt: string
interface DebugEventEnv
agent: string | null
agentIdentity: string | null
agentSessionId: string | null
agentSessionIdHash: string | null
agentSessionIdSource: string | null
arch: string
ci: boolean
ciName: string | null
cliVersion: string | null
invocationSource: DebugInvocationSource
locale: string | null
nodeVersion: string
oneOff: boolean
packageManager: string | null
platform: string
timezone: string | null
tty: boolean
interface DebugEventError
code: string | null
message: string
name: string
stack: string | null
type DebugEventHandler = (event: DebugEvent) => void
interface DebugEventOutput
directMatch: boolean | null
emptyResult: boolean | null
envelopeTypes: string[]
handled: boolean
helpDisplayed: boolean
jsonMode: boolean
resultCount: number | null
resultKind: DebugResultKind | null
stderr: string
stderrBytes: number
stdout: string
stdoutBytes: number
truncated: boolean
interface DebugEventProject
hasConfig: boolean | null
inProject: boolean | null
initialized: boolean | null
integrationCount: number | null
type DebugInvocationSource = 'human' | 'ai' | 'automation' | 'unknown'
type DebugOptionSource = 'cli' | 'default' | 'env' | 'config' | 'implied'
type DebugOutcome = 'ok' | 'error' | 'parse-error' | 'fatal' | 'rejected' | 'incomplete'
type DebugResultKind = | 'component' | 'hook' | 'doc' | 'template' | 'theme' | 'integration' | 'migration' | 'command' | 'mixed' | 'none'
type DebugSchemaVersion = 1 | 2 | 3
interface DiscoverCatalog
packages: DiscoverPackage[]
schemaVersion: 1
source: { name: string; generatedAt: string; complete: boolean }
interface DiscoverContribution
definitions?: string[] @experimental
iconCount?: number @experimental
keywords?: string[]
kind: DiscoverKind
name: string
summary?: string
title?: string
type DiscoverKind = | 'component' | 'template' | 'doc' | 'theme' | 'codemod' | 'agent-doc' | 'icon-set'
interface DiscoverPackage
aliases: string[]
contributions: DiscoverContribution[]
description?: string
integration: string
latest: string | null
package: string
versions: DiscoverVersion[]
type DiscoverSource = ( context: DiscoverSourceContext, ) => Promise<DiscoverCatalog>
interface DiscoverSourceContext
package?: string
signal: AbortSignal
version?: string
interface DiscoverVersion
prerelease: boolean
publishedAt: string | null
status: string
version: string
type DocAudience = 'public' | 'internal'
type DocId = ArtifactId & {readonly [docIdBrand]: true}
interface DocPlacement
order?: number
parent: string
slot?: string
interface EnumDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
description: string
displayName: string
members: EnumMemberDoc[]
name: string
namespace?: string
placement?: DocPlacement
stability?: 'experimental'
type?: 'enum'
interface EnumMemberDoc
deprecated?: string
description: string
stability?: 'experimental'
value: string
interface FunctionDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
category?: string
command?: string
description?: string
displayName: string
examples?: FunctionExampleDoc[]
importPath?: string
keywords?: string[]
kind?: 'hook' | 'api'
name: string
namespace?: string
params: HookParamDoc[]
placement?: DocPlacement
related?: string[]
relatedComponents?: string[]
relatedHooks?: string[]
returns: FunctionReturnDoc[]
signature?: string
stability?: 'experimental'
summary?: string
throws?: FunctionThrowsDoc[]
type?: 'function'
usage?: UsageDoc
interface FunctionExampleDoc
code: string
label?: string
result?: string
interface FunctionReturnDoc
description: string
name?: string
type: string
interface FunctionThrowsDoc
code: string
when: string
interface GapReport
category: GapReportCategory
categoryLabel: string
component: string
detail?: string
intention: string
schemaVersion: 1
source: DebugInvocationSource
target: GapReportTarget
timestamp: string
type GapReportCategory = | 'missing_component' | 'missing_variant' | 'layout_gap' | 'styling_gap' | 'a11y_gap' | 'api_friction' | 'docs_gap' | 'other'
interface GapReportHandler
audience: 'internal' | 'public'
handle: ( report: GapReport, context: GapReportHandlerContext, ) => GapReportHandlerReceipt | Promise<GapReportHandlerReceipt>
interface GapReportHandlerContext
signal: AbortSignal
interface GapReportHandlerReceipt
message?: string
status: 'filed' | 'routed_only' | 'skipped'
url?: string
interface GapReportTarget
issuesUrl: string | null
package: string
version: string | null
type GraphContentBlock = WorkflowDocBlock | CollectionDocBlock | ReferenceDocBlock
interface HookDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
category?: string
displayName: string
group?: string
importPath?: string
keywords?: string[]
name: string
params: HookParamDoc[]
placement?: DocPlacement
registry?: RegistryDocIdentity
relatedComponents?: string[]
relatedHooks?: string[]
returns: HookReturnDoc[]
stability?: 'experimental'
type?: 'function'
usage: UsageDoc
interface HookParamDoc
default?: string
description: string
name: string
required?: boolean
type: string
interface HookReturnDoc
description: string
name: string
type: string
interface HookTranslationDoc
description?: string
displayName?: string
name?: string
paramDescriptions?: Record<string, string>
returnDescriptions?: Record<string, string>
usage?: { description?: string; bestPractices?: ComponentBestPractice[]; accessibility?: ComponentAccessibilityRequirement[] }
interface IconDefinitionDoc @experimental
builtIn?: true
description: string
name: string
stability?: 'experimental'
type: 'icon-definition'
words: string[]
interface IconSetAdapter @experimental
export: string
module: string
interface IconSetData @experimental
adapter?: IconSetAdapter
default?: IconSetDefault
exclude?: string[]
generated?: string
icons: IconSetIcon[]
map?: Record<string, string>
module: string
schemaVersion: 1
source?: IconSetSource
themeMap?: string
variants?: string[]
interface IconSetDefault @experimental
variant?: string
interface IconSetDoc @experimental
description: string
displayName: string
license: string
maintained: boolean
name: string
type: 'icon-set'
interface IconSetIcon @experimental
export: string
id: string
matches?: IconSetMatch[]
module?: string
variants?: IconSetVariant[]
words: string[]
interface IconSetMatch @experimental
confidence: IconSetMatchConfidence
export: string
set: string
variant?: string
type IconSetMatchConfidence @experimental = 'exact' | 'strong' | 'likely'
interface IconSetSource @experimental
package: string
version: string
interface IconSetVariant @experimental
export: string
module?: string
variant: string
type IntegrationTemplateDoc = IntegrationPageTemplateDoc | IntegrationBlockTemplateDoc
interface MultiComponentDoc extends ComponentBaseDoc
aliases?: string[]
audience?: DocAudience
category?: | 'Action' | 'Chat' | 'Container' | 'Content' | 'Form Controls' | 'Data Input' | 'Data Visualization' | 'Feedback & Status' | 'Layout' | 'Navigation' | 'Overlay' | 'Table & List' | 'Utility'
components: (ComponentEntry | ComponentRef)[]
displayName: string
examples?: ComponentExampleDoc[]
group?: string
hidden?: boolean
hiddenComponents?: string[]
import?: string
isHiddenFromOverview?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
playground?: ComponentPlaygroundConfig
registry?: RegistryDocIdentity
replaces?: string
stability?: 'experimental'
theming?: { container?: boolean; targets: ComponentThemingTarget[]; vars?: ComponentThemingVar[]; derived?: ComponentThemingDerivedVar[] }
type?: 'component'
usage: UsageDoc
interface NamespaceAdoptionRule
groupBy?: 'kind'
into: string
source: NamespaceAdoptionSource
interface NamespaceAdoptionSource
group: string
kinds?: AuthoredDocKind[]
packages?: 'all' @experimental
interface NamespaceDoc extends AuthoredDocGraphFields
adopts?: NamespaceAdoptionRule[]
aliases?: string[]
audience?: DocAudience
blocks?: (ReferenceContentBlock | GraphContentBlock)[]
keywords?: string[]
name: string
placement?: DocPlacement
slots: Record<string, NamespaceSlot>
stability?: 'experimental'
summary: string
title: string
type: 'namespace'
type NamespaceProviderScope = 'same' | 'configured'
interface NamespaceSlot
accepts: NamespaceSlotAcceptance
title: string
interface NamespaceSlotAcceptance
kinds: AuthoredDocKind[]
providers?: NamespaceProviderScope
type PostCodemodHook
buildCommand: (ctx: { packageDir: string; files: string[] }) => | PostCodemodCommand | null | undefined | Promise<PostCodemodCommand | null | undefined>
name?: string
type ProviderId = string & {readonly [providerIdBrand]: true}
interface ProviderInstance
id: ProviderInstanceId
packageName: string
packageVersion: string
providerId: ProviderId
sourceDigest: ContentDigest
type ProviderInstanceId = string & { readonly [providerInstanceIdBrand]: true }
type ReferenceContentBlock = | {type: 'prose'; text: string} | {type: 'heading'; level: 3 | 4 | 5 | 6; text: string} | {type: 'code'; lang: string; code: string; label?: string} | {type: 't … #10678c65
interface ReferenceDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
category?: string
description: string
extends?: string
keywords?: string[]
name: string
placement?: DocPlacement
replaces?: string
sections: ReferenceSection[]
stability?: 'experimental'
title: string
tokenCategory?: string
type?: 'generic'
interface ReferenceDocBlock
presentation?: 'summary' | 'compact' | 'full'
projection?: { fields?: string[]; sections?: string[] }
target: string
type: 'reference'
interface ReferenceSection
after?: string
before?: string
category?: string
content: (ReferenceContentBlock | ReferenceDocBlock)[]
id?: string
previewType?: ReferenceTokenPreviewType
title: string
type ReferenceTokenPreviewType = | 'swatch' | 'shadow-box' | 'radius-box' | 'spacing-bar' | 'size-bar' | 'border-line' | 'duration-bar' | 'easing-curve' | 'font-sample'
interface ReferenceTranslationDoc
description: string
sections: { section: string; title: string; content: ( {type: 'prose'; text: string} | {type: 'list'; items: string[]} | null )[] }[]
interface SchemaDoc extends AuthoredDocGraphFields
aliases?: string[]
appliesTo?: string
audience?: DocAudience
description: string
displayName: string
examples?: {label?: string; code: string}[]
fields: SchemaFieldDoc[]
name: string
namespace?: string
notes?: ReferenceContentBlock[]
placement?: DocPlacement
stability?: 'experimental'
type?: 'schema'
interface SchemaFieldDoc
default?: string
deprecated?: string
description: string
example?: string
fields?: SchemaFieldDoc[]
name: string
required?: boolean
stability?: 'experimental'
type: string
interface SingleComponentDoc extends ComponentBaseDoc
aliases?: string[]
audience?: DocAudience
category?: | 'Action' | 'Chat' | 'Container' | 'Content' | 'Form Controls' | 'Data Input' | 'Data Visualization' | 'Feedback & Status' | 'Layout' | 'Navigation' | 'Overlay' | 'Table & List' | 'Utility'
displayName: string
examples?: ComponentExampleDoc[]
group?: string
hidden?: boolean
hiddenComponents?: string[]
import?: string
isHiddenFromOverview?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
playground?: ComponentPlaygroundConfig
props: ComponentPropDoc[]
registry?: RegistryDocIdentity
replaces?: string
stability?: 'experimental'
theming?: { container?: boolean; targets: ComponentThemingTarget[]; vars?: ComponentThemingVar[]; derived?: ComponentThemingDerivedVar[] }
type?: 'component'
usage: UsageDoc
type TemplateCategory = | 'Dashboard - Analytics' | 'Dashboard - Comparison' | 'Dashboard - KPI Summary' | 'Dashboard - Monitoring' | 'Dashboard - Executive Summary' | 'Dashboard - Sco … #e7c18378
type TemplateDoc = PageTemplateDoc | BlockTemplateDoc
interface ThemeDoc
description: string
displayName: string
maintained: boolean
name: string
type: 'theme'
interface UsageDoc
accessibility?: ComponentAccessibilityRequirement[]
accessibilityThemeCoverage?: ComponentAccessibilityThemeCoverage[]
anatomy?: ComponentAnatomyElement[]
bestPractices?: ComponentBestPractice[]
description: string
interface WorkflowDocBlock
steps: WorkflowStep[]
title?: string
type: 'workflow'
interface WorkflowStep
description?: string
references?: string[]
title: string
interface CliLog
error: (...args: unknown[]) => void
info: (...args: unknown[]) => void
message?: (...args: unknown[]) => void
step: (...args: unknown[]) => void
success: (...args: unknown[]) => void
warn: (...args: unknown[]) => void
interface CodemodEntry
codemod: { title: string; description?: string; isOptional?: boolean; fileExtensions?: string[]; transform: CodemodTransform }
id: string
package: string
type: 'code' | 'config'
version?: string
interface CodemodRunResult
changedFiles: string[]
declinedCandidates?: Array<{ file: string; codemod: string; location?: string; reason: string }>
errors: Array<{file: string; codemod: string; error: string}>
filesChanged: number
protectedFiles: Array<{ file: string; codemod: string; reason: string; declaration: string; generated: boolean; command?: string }>
writtenFiles: string[]
type CodemodTransform = ( file: AstryxCodemodFile, api: CodemodTransformApi, ) => string | null | undefined
interface CodemodTransformApi
jscodeshift: JscodeshiftFactory
report: (...args: unknown[]) => void
stats: (...args: unknown[]) => void
interface JscodeshiftFactory
withParser: (parser: string) => any
AstryxCodemod (./authoring)
AstryxCodemodApi (./authoring)
AstryxCodemodDef (./authoring)
AstryxCodemodFile (./authoring)
AstryxCodemodTransform (./authoring)
AstryxConfigCodemod (./authoring)
AstryxConfigCodemodDef (./authoring)
interface PostCodemodCommand
args?: string[]
command: string
options?: { cwd?: string; env?: Record<string, string | undefined>; timeout?: number }
interface XleComponent
default?: boolean
description?: string
from: string
AstryxConfig (./authoring)
DebugConfig (./authoring)
PostCodemodHook (./authoring)
DebugEvent (./authoring)
DebugEventEnv (./authoring)
DebugEventError (./authoring)
DebugEventHandler (./authoring)
DebugEventOutput (./authoring)
DebugEventProject (./authoring)
DebugInvocationSource (./authoring)
DebugOptionSource (./authoring)
DebugOutcome (./authoring)
DebugResultKind (./authoring)
DebugSchemaVersion (./authoring)
interface BaseTemplateDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
category?: TemplateCategory
description?: string
displayName: string
icons?: Record<string, string> @experimental
isHiddenFromOverview?: boolean
isReady?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
registry?: RegistryDocIdentity
replaces?: string
scaffold?: boolean
stability?: 'experimental'
interface BlockTemplateDoc extends BaseTemplateDoc
aliases?: string[]
alsoExampleFor?: string[]
alsoShowcaseFor?: string[]
aspectRatio: number
audience?: DocAudience
category?: TemplateCategory
componentsUsed?: string[]
description?: string
displayName: string
exampleFor?: string
icons?: Record<string, string> @experimental
isHiddenFromOverview?: boolean
isReady?: boolean
isShowcase?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
registry?: RegistryDocIdentity
replaces?: string
scaffold?: boolean
scale?: number
stability?: 'experimental'
type: 'block'
interface ComponentBaseDoc extends AuthoredDocGraphFields
aliases?: string[]
audience?: DocAudience
category?: | 'Action' | 'Chat' | 'Container' | 'Content' | 'Form Controls' | 'Data Input' | 'Data Visualization' | 'Feedback & Status' | 'Layout' | 'Navigation' | 'Overlay' | 'Table & List' | 'Utility'
displayName: string
examples?: ComponentExampleDoc[]
group?: string
hidden?: boolean
hiddenComponents?: string[]
import?: string
isHiddenFromOverview?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
playground?: ComponentPlaygroundConfig
registry?: RegistryDocIdentity
replaces?: string
stability?: 'experimental'
theming?: { container?: boolean; targets: ComponentThemingTarget[]; vars?: ComponentThemingVar[]; derived?: ComponentThemingDerivedVar[] }
type?: 'component'
usage: UsageDoc
interface ComponentRef
name: string
interface IntegrationBlockTemplateDoc extends Omit< BlockTemplateDoc, 'category' >
aliases?: string[]
alsoExampleFor?: string[]
alsoShowcaseFor?: string[]
aspectRatio: number
audience?: DocAudience
category?: string
componentsUsed?: string[]
description?: string
displayName: string
exampleFor?: string
icons?: Record<string, string> @experimental
isHiddenFromOverview?: boolean
isReady?: boolean
isShowcase?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
registry?: RegistryDocIdentity
replaces?: string
scaffold?: boolean
scale?: number
stability?: 'experimental'
type: 'block'
interface IntegrationPageTemplateDoc extends Omit< PageTemplateDoc, 'category' >
aliases?: string[]
audience?: DocAudience
category?: string
description?: string
displayName: string
icons?: Record<string, string> @experimental
isHiddenFromOverview?: boolean
isReady?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
registry?: RegistryDocIdentity
replaces?: string
scaffold?: boolean
stability?: 'experimental'
type: 'page'
interface PageTemplateDoc extends BaseTemplateDoc
aliases?: string[]
audience?: DocAudience
category?: TemplateCategory
description?: string
displayName: string
icons?: Record<string, string> @experimental
isHiddenFromOverview?: boolean
isReady?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
registry?: RegistryDocIdentity
replaces?: string
scaffold?: boolean
stability?: 'experimental'
type: 'page'
interface RegistryDocIdentity
aliases?: string[]
slug?: string
interface SubComponentDoc extends Omit<ComponentBaseDoc, 'usage'>
aliases?: string[]
audience?: DocAudience
category?: | 'Action' | 'Chat' | 'Container' | 'Content' | 'Form Controls' | 'Data Input' | 'Data Visualization' | 'Feedback & Status' | 'Layout' | 'Navigation' | 'Overlay' | 'Table & List' | 'Utility'
description: string
displayName: string
examples?: ComponentExampleDoc[]
group?: string
hidden?: boolean
hiddenComponents?: string[]
import?: string
isHiddenFromOverview?: boolean
keywords?: string[]
name: string
placement?: DocPlacement
playground?: ComponentPlaygroundConfig
props: ComponentPropDoc[]
registry?: RegistryDocIdentity
replaces?: string
stability?: 'experimental'
subComponentOf: string
theming?: { container?: boolean; targets: ComponentThemingTarget[]; vars?: ComponentThemingVar[]; derived?: ComponentThemingDerivedVar[] }
type?: 'component'
usage?: UsageDoc
AuthoredDocGraphFields (./authoring)
AuthoredDocKind (./authoring)
CollectionDocBlock (./authoring)
CommandArgDoc (./authoring)
CommandDoc (./authoring)
CommandExampleDoc (./authoring)
CommandOptionDoc (./authoring)
CommandOutsideProject (./authoring)
ComponentAccessibilityRequirement (./authoring)
ComponentAccessibilityThemeApplicability (./authoring)
ComponentAccessibilityThemeCoverage (./authoring)
ComponentAccessibilityThemeMeasurement (./authoring)
ComponentAccessibilityThemeMode (./authoring)
ComponentAccessibilityThemeResult (./authoring)
ComponentAccessibilityThemeStatus (./authoring)
ComponentAccessibilityThemeTable (./authoring)
ComponentAnatomyElement (./authoring)
ComponentBestPractice (./authoring)
ComponentDoc (./authoring)
ComponentEntry (./authoring)
ComponentExampleDoc (./authoring)
ComponentGroupDoc (./authoring)
ComponentPlaygroundConfig (./authoring)
ComponentPropDoc (./authoring)
ComponentSlotElement (./authoring)
ComponentThemingDerivedVar (./authoring)
ComponentThemingTarget (./authoring)
ComponentThemingVar (./authoring)
ComponentTranslationDoc (./authoring)
DocAudience (./authoring)
DocPlacement (./authoring)
EnumDoc (./authoring)
EnumMemberDoc (./authoring)
FunctionDoc (./authoring)
FunctionExampleDoc (./authoring)
FunctionReturnDoc (./authoring)
FunctionThrowsDoc (./authoring)
GraphContentBlock (./authoring)
HookDoc (./authoring)
HookParamDoc (./authoring)
HookReturnDoc (./authoring)
HookTranslationDoc (./authoring)
IconDefinitionDoc (./authoring)
IconSetAdapter (./authoring)
IconSetData (./authoring)
IconSetDefault (./authoring)
IconSetDoc (./authoring)
IconSetIcon (./authoring)
IconSetMatch (./authoring)
IconSetMatchConfidence (./authoring)
IconSetSource (./authoring)
IconSetVariant (./authoring)
IntegrationTemplateDoc (./authoring)
MultiComponentDoc (./authoring)
NamespaceAdoptionRule (./authoring)
NamespaceAdoptionSource (./authoring)
NamespaceDoc (./authoring)
NamespaceProviderScope (./authoring)
NamespaceSlot (./authoring)
NamespaceSlotAcceptance (./authoring)
ReferenceContentBlock (./authoring)
ReferenceDoc (./authoring)
ReferenceDocBlock (./authoring)
ReferenceSection (./authoring)
ReferenceTokenPreviewType (./authoring)
ReferenceTranslationDoc (./authoring)
SchemaDoc (./authoring)
SchemaFieldDoc (./authoring)
SingleComponentDoc (./authoring)
TemplateCategory (./authoring)
TemplateDoc (./authoring)
ThemeDoc (./authoring)
UsageDoc (./authoring)
WorkflowDocBlock (./authoring)
WorkflowStep (./authoring)
function runHostedCli: (options?: HostedCliOptions) => Promise<HostedCliResult>
interface HostedCliOptions
argv?: readonly string[]
cliCommand?: string
cwd?: string
declinedProjectCli?: string
discoverSources?: readonly DiscoverSource[]
integrations?: readonly string[]
roots?: readonly string[]
interface HostedCliResult
packages: HostedPackage[]
status: number
interface HostedPackage
name: string
source: 'project' | 'package-set'
version: string | null
AstryxIntegration (./authoring)
GapReport (./authoring)
GapReportCategory (./authoring)
GapReportHandler (./authoring)
GapReportHandlerContext (./authoring)
GapReportHandlerReceipt (./authoring)
GapReportTarget (./authoring)
function allErrorCodes: () => ErrorCode[]
function assertResponse: <T extends string>(raw: unknown, type: T) => CLIResponse & {apiVersion: number; type: T}
function isError: (result: unknown) => result is CLIError | CLIUnsupportedError
function isErrorCode: (value: unknown) => value is ErrorCode
function jsonError: (message: string, suggestions?: Suggestion[], code?: ErrorCode) => never
function jsonOut: (response: CLIResponse) => void
function parseResponse: (raw: unknown) => (CLIResponse & {apiVersion: number}) | CLIError | CLIUnsupportedError
const ERROR_CODES: Readonly<Record<ErrorCode, ErrorCode>>
interface AnsweredBy
cli: string
copy: 'project' | 'starting' | 'matched' | 'carried' | 'fallback'
core: string | null
interface CLIError
apiVersion: number
code: ErrorCode
error: string
receipt?: Record<string, unknown>
suggestions?: Suggestion[]
interface CLIManifest
apiVersion: number
commands: ManifestCommand[]
description: string
globalMode: {docs: string; summary: string}
globalOptions: ManifestOption[]
jsonSupported: string[]
name: 'astryx'
responseTypes: Record<string, string[]>
version: string
interface CLIResponse
data: unknown
meta?: {answeredBy?: AnsweredBy} & Record<string, unknown>
package?: string
type: string
type CLIResult<T> = T | CLIError | CLIUnsupportedError
interface CLIUnsupportedError
apiVersion: number
code: ErrorCode
error: `JSON output is not supported for the '${string}' command`
type ErrorCode = | 'ERR_UNKNOWN' | 'ERR_UNKNOWN_COMMAND' | 'ERR_UNKNOWN_SUBCOMMAND' | 'ERR_INVALID_OPTION' | 'ERR_INVALID_ARGUMENT' | 'ERR_MISSING_ARGUMENT' | 'ERR_INVALID_LANG' … #af6fd468
interface ManifestArgument
description: string
name: string
required: boolean
variadic: boolean
interface ManifestCommand
aliases?: string[]
arguments: ManifestArgument[]
description: string
examples?: string[]
exitCodes?: {code: number; when: string}[]
json: boolean
name: string
options: ManifestOption[]
outsideProject?: 'same' | 'refuse' | 'own'
responseTypes?: string[]
subcommands?: ManifestCommand[]
interface ManifestOption
choices?: string[]
default?: unknown
description: string
flag: string
negate?: boolean
type: 'boolean' | 'string' | 'enum'
interface ManifestResponse
data: CLIManifest
type: 'manifest'
interface Suggestion
name: string
reason?: string
AgentDocsSummary (./api)
BlockComponentsReport (./api)
BlockEntry (./api)
BlogDetailData (./api)
BlogDetailResponse (./api)
BlogListData (./api)
BlogListResponse (./api)
BlogPost (./api)
BuildAlternative (./api)
BuildHelpResponse (./api)
BuildKitResponse (./api)
BuildOptions (./api)
BuildPlaybookCommand (./api)
BuildPlaybookStep (./api)
BuildStart (./api)
CliBehindCore (./api)
ComponentBatchCandidate (./api)
ComponentBatchResponse (./api)
ComponentBatchResult (./api)
ComponentBriefEntry (./api)
ComponentDetailBlocksResponse (./api)
ComponentDetailPropsResponse (./api)
ComponentDetailResponse (./api)
ComponentDetailScope (./api)
ComponentDetailShowcaseResponse (./api)
ComponentDetailSourceResponse (./api)
ComponentListData (./api)
ComponentListEntry (./api)
ComponentListResponse (./api)
ComponentOptions (./api)
ComponentOwnership (./api)
ComponentSingleResponse (./api)
CopiedPassage (./api)
CoreTemplateMatch (./api)
DiscoverAvailableEntry (./api)
DiscoverDetailDocResponse (./api)
DiscoverDetailResponse (./api)
DiscoverItemResponse (./api)
DiscoverListEntry (./api)
DiscoverListMeta (./api)
DiscoverListResponse (./api)
DiscoverOptions (./api)
DiscoverSearchEntry (./api)
DiscoverSearchResponse (./api)
DiscoverSourceState (./api)
DocFluff (./api)
DocLink (./api)
DocNamesReport (./api)
DocTypesReport (./api)
DocsCommand (./api)
DocsDetailResponse (./api)
DocsDetailSection (./api)
DocsDetailSectionResponse (./api)
DocsIndex (./api)
DocsIndexEntry (./api)
DocsIndexResponse (./api)
DocsIndexSection (./api)
DocsLinks (./api)
DocsListEntry (./api)
DocsListNamespace (./api)
DocsListResponse (./api)
DocsNode (./api)
DocsNodeChild (./api)
DocsNodeLink (./api)
DocsNodeResponse (./api)
DocsNodeSlot (./api)
DocsOptions (./api)
DocsReadDoc (./api)
DocsReadSection (./api)
DoctorCheck (./api)
DoctorOptions (./api)
DoctorResponse (./api)
DoctorStatus (./api)
DoctorSummary (./api)
GapReportAggregateStatus (./api)
GapReportCategoriesResponse (./api)
GapReportCategory (./api)
GapReportCategoryEntry (./api)
GapReportDelivery (./api)
GapReportDeliveryStatus (./api)
GapReportDestination (./api)
GapReportOptions (./api)
GapReportReceipt (./api)
GapReportReceiptResponse (./api)
HookBriefEntry (./api)
HookDetailParamsResponse (./api)
HookDetailResponse (./api)
HookDoc (./api)
HookListData (./api)
HookListResponse (./api)
HookOptions (./api)
HookParamDoc (./api)
IconSetCoverage (./api)
InitOptions (./api)
InitRemoveResponse (./api)
InitRunData (./api)
InitRunResponse (./api)
InitUserAction (./api)
InitUserData (./api)
InitUserFile (./api)
InitUserResponse (./api)
IntegrationAuthoringOptions (./api)
IntegrationComponentConflict (./api)
IntegrationComponentConflictResponse (./api)
IntegrationDocConflictResponse (./api)
IntegrationDocFinding (./api)
IntegrationPackCheckOptions (./api)
IntegrationPackCheckResponse (./api)
IntegrationTemplateConflict (./api)
IntegrationTemplateConflictResponse (./api)
LoadedIntegration (./api)
OlderCliNote (./api)
PackCheckContributionIdentities (./api)
PackCheckData (./api)
PackCheckInventory (./api)
PackCheckInventoryRoot (./api)
PackCheckResponse (./api)
PackCheckTarball (./api)
PropDriftFinding (./api)
PropDriftReport (./api)
ProtectedCodemodFile (./api)
PublicImportUnchecked (./api)
PublicImportsReport (./api)
RegenerateFile (./api)
RegistryCompositionFileSummary (./api)
RegistryCompositionItemSummary (./api)
RegistryCompositionSummary (./api)
SearchDomain (./api)
SearchOptions (./api)
SearchResponse (./api)
SearchResultEntry (./api)
StrayPointer (./api)
SwizzleCopyResponse (./api)
SwizzleFeedback (./api)
SwizzleListResponse (./api)
SwizzleOptions (./api)
TemplateCdnResponse (./api)
TemplateCopyResponse (./api)
TemplateIconsReport (./api)
TemplateListEntry (./api)
TemplateListResponse (./api)
TemplateOptions (./api)
TemplateShowResponse (./api)
TemplateSkeletonResponse (./api)
ThemeAppEntry (./api)
ThemeAppResponse (./api)
ThemeBuildBatchResponse (./api)
ThemeBuildCheckResponse (./api)
ThemeBuildResponse (./api)
ThemeEjectResponse (./api)
ThemeListEntry (./api)
ThemeListResponse (./api)
ThemePaletteGenerateResponse (./api)
ThemeTargetEntry (./api)
ThemeTargetsResponse (./api)
ThemeTemplateResponse (./api)
ThemeUnmigratedCopy (./api)
TonalPaletteAnchor (./api)
TonalPaletteCandidate (./api)
TonalPaletteCoordinationDiagnostics (./api)
TonalPaletteFamilyInput (./api)
TonalPaletteGenerationInput (./api)
TonalPaletteGenerationReceipt (./api)
TonalPaletteNormalizedRequest (./api)
TonalPaletteRampDiagnostics (./api)
UpgradeFailureReceipt (./api)
UpgradeListEntry (./api)
UpgradeListResponse (./api)
UpgradeOptions (./api)
UpgradeRegistryResponse (./api)
UpgradeRunResponse (./api)
UpgradeStatusResponse (./api)
ValidateIntegrationOptions (./api)
ValidateIntegrationResponse (./api)
AuthoredDocGraphFields (./authoring)
AuthoredDocKind (./authoring)
BaseTemplateDoc (./doc)
BlockTemplateDoc (./doc)
CollectionDocBlock (./authoring)
CommandArgDoc (./authoring)
CommandDoc (./authoring)
CommandExampleDoc (./authoring)
CommandOptionDoc (./authoring)
CommandOutsideProject (./authoring)
ComponentAccessibilityRequirement (./authoring)
ComponentAccessibilityThemeApplicability (./authoring)
ComponentAccessibilityThemeCoverage (./authoring)
ComponentAccessibilityThemeMeasurement (./authoring)
ComponentAccessibilityThemeMode (./authoring)
ComponentAccessibilityThemeResult (./authoring)
ComponentAccessibilityThemeStatus (./authoring)
ComponentAccessibilityThemeTable (./authoring)
ComponentAnatomyElement (./authoring)
ComponentBaseDoc (./doc)
ComponentBestPractice (./authoring)
ComponentDoc (./authoring)
ComponentEntry (./authoring)
ComponentExampleDoc (./authoring)
ComponentGroupDoc (./authoring)
ComponentPlaygroundConfig (./authoring)
ComponentPropDoc (./authoring)
ComponentRef (./doc)
ComponentSlotElement (./authoring)
ComponentThemingDerivedVar (./authoring)
ComponentThemingTarget (./authoring)
ComponentThemingVar (./authoring)
ComponentTranslationDoc (./authoring)
DocAudience (./authoring)
DocPlacement (./authoring)
EnumDoc (./authoring)
EnumMemberDoc (./authoring)
FunctionDoc (./authoring)
FunctionExampleDoc (./authoring)
FunctionReturnDoc (./authoring)
FunctionThrowsDoc (./authoring)
GraphContentBlock (./authoring)
HookDoc (./authoring)
HookParamDoc (./authoring)
HookReturnDoc (./authoring)
HookTranslationDoc (./authoring)
IconDefinitionDoc (./authoring)
IconSetAdapter (./authoring)
IconSetData (./authoring)
IconSetDefault (./authoring)
IconSetDoc (./authoring)
IconSetIcon (./authoring)
IconSetMatch (./authoring)
IconSetMatchConfidence (./authoring)
IconSetSource (./authoring)
IconSetVariant (./authoring)
IntegrationBlockTemplateDoc (./doc)
IntegrationPageTemplateDoc (./doc)
IntegrationTemplateDoc (./authoring)
MultiComponentDoc (./authoring)
NamespaceAdoptionRule (./authoring)
NamespaceAdoptionSource (./authoring)
NamespaceDoc (./authoring)
NamespaceProviderScope (./authoring)
NamespaceSlot (./authoring)
NamespaceSlotAcceptance (./authoring)
PageTemplateDoc (./doc)
ReferenceContentBlock (./authoring)
ReferenceDoc (./authoring)
ReferenceDocBlock (./authoring)
ReferenceSection (./authoring)
ReferenceTokenPreviewType (./authoring)
ReferenceTranslationDoc (./authoring)
RegistryDocIdentity (./doc)
SchemaDoc (./authoring)
SchemaFieldDoc (./authoring)
SingleComponentDoc (./authoring)
SubComponentDoc (./doc)
TemplateCategory (./authoring)
TemplateDoc (./authoring)
ThemeDoc (./authoring)
UsageDoc (./authoring)
WorkflowDocBlock (./authoring)
WorkflowStep (./authoring)
function checkExpression: (expression: string, registry: SerializedRegistry | object, opts?: CheckOptions) => CheckResult
function detectForm: (source: string) => 'compact' | 'outline'
function expand: (doc: unknown, registry: object, opts?: {componentName?: string}) => {code: string; componentsUsed: string[]; states: number; todos: string[]}
function expandExpression: (expression: string, registry: SerializedRegistry | object, opts?: ExpandOptions) => ExpandResult
function hydrateRegistry: (json: SerializedRegistry) => object
function parse: (source: string, opts?: {form?: string}) => unknown
function serializeRegistry: (registry: object) => SerializedRegistry
function toCompact: (doc: unknown) => string
function toOutline: (doc: unknown) => string
function validate: (doc: unknown, registry: object, blocks?: XLEBlock[], opts?: {loose?: boolean}) => {errors: XLEIssue[]; warnings: XLEIssue[]}
class XLEParseError
col: number
line: number
inherits Error
const ALIAS_TABLE: Record<string, string>
const SPACING_STEPS: number[]
interface CheckOptions
blocks?: XLEBlock[]
form?: 'auto' | 'compact' | 'outline'
loose?: boolean
interface CheckResult
compact?: string
errors: XLEIssue[]
form?: 'compact' | 'outline'
ok: boolean
outline?: string
parseError?: {message: string; line?: number; col?: number}
valid?: boolean
warnings: string[]
interface ExpandOptions extends CheckOptions
blocks?: XLEBlock[]
form?: 'auto' | 'compact' | 'outline'
loose?: boolean
name?: string
type ExpandResult = | {ok: false; errors: XLEIssue[]} | { ok: true; form: 'compact' | 'outline'; code: string; componentsUsed: string[]; states: number; todos: string[]; warnings: string[] }
interface SerializedRegistry
aliases: Array<[string, string]>
componentNames: string[]
components: Array<{ name: string; exportName: string; dirName: string; importPath: string; undocumented?: boolean; props: Array<Record<string, unknown>> }>
interface XLEBlock
category?: string
description?: string
dirName: string
interface XLEIssue
col?: number
formatted: string
kind?: string
line?: number
message: string
suggestions?: string[]
attr data-astryx-media (public data attribute)
attr data-astryx-theme (public data attribute)