Lynx

genui / a2ui-catalog-extractor

a2ui-catalog-extractor

索引

接口

Interface描述
A2UICatalogFull catalog manifest consumed by A2UI agents and renderers.
CatalogArtifactsComponent and function artifacts produced by a single extraction pass.
CatalogComponentComponent schema discovered from an interface annotated with @a2uiCatalog.
CatalogFunctionA function discovered in source via @a2uiFunction, with its origin path.
ExtractCatalogFromTypeDocOptionsOptions used when extracting catalog metadata from an existing TypeDoc project reflection.
ExtractCatalogOptionsSource and compiler inputs used when extracting catalog metadata.
FunctionDefinitionSerializable definition for a client-side function exposed to an agent.
JsonSchemaJSON Schema subset emitted for A2UI component props and function arguments.
WriteComponentCatalogOptionsOptions for writing extracted catalog artifacts to disk.

函数

Function描述
createA2UICatalogBuild a full A2UI catalog manifest from component and function artifacts.
extractCatalogComponentsRun TypeDoc over source files and extract A2UI component schemas.
extractCatalogComponentsFromTypeDocJsonExtract A2UI component schemas from a serialized TypeDoc JSON project.
extractCatalogComponentsFromTypeDocProjectExtract A2UI component schemas from an already converted TypeDoc project.
extractCatalogFunctionsRun TypeDoc over source files and extract A2UI function definitions.
extractCatalogFunctionsFromTypeDocJsonExtract A2UI function definitions from a serialized TypeDoc JSON project.
extractCatalogFunctionsFromTypeDocProjectExtract A2UI function definitions from an already converted TypeDoc project.
findCatalogSourceFilesFind supported source files under a file or directory path.
writeA2UICatalogWrite a full A2UI catalog manifest as catalog.json.
writeCatalogArtifactsBootstrap TypeDoc once and emit component manifests plus the full catalog. Preferred entry point for the CLI — running the conversion twice doubles cold-start latency on large catalogs.
writeCatalogComponentsWrite component schema artifacts that were already extracted.
writeCatalogFunctionDefinitionsExtract A2UI function definitions and write one JSON artifact per function.
writeCatalogFunctionsWrite function definition artifacts that were already extracted.
writeComponentCatalogsExtract component schemas and write one catalog.json per component.
除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。