@lynx-js/genui 0.0.1-rc.0 → 0.0.1

package/a2ui-catalog-extractor/README.md

@@ -2,12 +2,16 @@
 
 English | [简体中文](./readme.zh_cn.md)
 
-`@lynx-js/genui/a2ui-catalog-extractor` turns TypeScript component
-interfaces into A2UI component catalog JSON. You write the public
-component contract once as a TypeScript `interface`, describe it with
-normal TypeDoc comments, and let this package generate the JSON Schema
+`@lynx-js/genui/a2ui-catalog-extractor` is the internal TypeDoc-powered extraction
+engine behind `genui a2ui generate catalog`. It turns TypeScript component
+interfaces into A2UI component catalog JSON. You write the public component
+contract once as a TypeScript `interface`, describe it with normal TypeDoc
+comments, and run the public `genui a2ui` command to generate the JSON Schema
 that an A2UI agent can read.
 
+For user-facing scripts, use `genui a2ui generate catalog`. Treat
+this package as the implementation layer for extraction behavior and tests.
+
 ## What It Does
 
 A2UI catalogs describe what components a renderer supports. For each
@@ -54,10 +58,10 @@ the marked interface.
 
 ### Package manager
 
-Install the extractor as a development dependency:
+Run the public CLI after installing `@lynx-js/genui`:
 
 ```bash
-pnpm add -D @lynx-js/genui
+genui a2ui --help
 ```
 
 Then add a script to your package:
@@ -65,7 +69,7 @@ Then add a script to your package:
 ```json
 {
   "scripts": {
-    "build:catalog": "a2ui-catalog-extractor --catalog-dir src/catalog --out-dir dist/catalog"
+    "build:catalog": "genui a2ui generate catalog --catalog-dir src/catalog --out-dir dist/catalog"
   }
 }
 ```
@@ -128,7 +132,7 @@ extractor that this interface should become a catalog component named
 Run:
 
 ```bash
-a2ui-catalog-extractor --catalog-dir src/catalog --out-dir dist/catalog
+genui a2ui generate catalog --catalog-dir src/catalog --out-dir dist/catalog
 ```
 
 The extractor scans the catalog directory, finds interfaces marked with
@@ -386,15 +390,13 @@ export interface CardProps {
 
 ## CLI Reference
 
-The package exposes the standalone `a2ui-catalog-extractor` binary. The
-`@lynx-js/genui-cli` also exposes this flow as
-`genui a2ui generate catalog`.
+The public CLI entry point is
+`genui a2ui generate catalog`. It delegates to this package
+internally.
 
 ### Generate catalog artifacts
 
 ```bash
-a2ui-catalog-extractor [options]
-# or
 genui a2ui generate catalog [options]
 ```
 
@@ -413,7 +415,13 @@ all inputs, removes duplicates, sorts them, and then runs TypeDoc.
 The scanner accepts `.ts`, `.tsx`, `.js`, `.jsx`, `.mts`, and `.cts`
 files. It ignores `.d.ts`, `node_modules`, `dist`, and `.turbo`.
 
-## Programmatic API
+## Repository-internal Programmatic API
+
+These exports are documented for maintainers of `@lynx-js/genui-cli`, extractor
+tests, and repository-internal tooling. They are not the external integration
+surface for product code. Product build scripts should call
+`genui a2ui generate catalog` instead of importing this package
+directly.
 
 ### Generate components from source files
 
@@ -479,7 +487,7 @@ writeCatalogComponents(components, {
 The equivalent CLI command is:
 
 ```bash
-a2ui-catalog-extractor --typedoc-json typedoc.json --out-dir dist/catalog
+genui a2ui generate catalog --typedoc-json typedoc.json --out-dir dist/catalog
 ```
 
 ### Create a full A2UI catalog object

package/a2ui-catalog-extractor/bin/a2ui-catalog-extractor.js

@@ -2,5 +2,4 @@
 // Copyright 2026 The Lynx Authors. All rights reserved.
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
-// eslint-disable-next-line import/no-unresolved -- Generated by the package build.
 import '../dist/cli.js';