@lynx-js/genui 0.0.2 → 0.0.4

package/a2ui-catalog-extractor/skills/a2ui-catalog-extractor/SKILL.md

@@ -15,7 +15,7 @@ Use this skill when a task involves authoring, updating, debugging, or generatin
 4. Generate component catalog files with:
 
 ```bash
-a2ui-catalog-extractor --catalog-dir src/catalog --out-dir dist/catalog
+a2ui-catalog-extractor --catalog-dir src/catalog --out-dir dist
 ```
 
 ## Supported Type Shapes

package/a2ui-prompt/README.md

@@ -35,8 +35,9 @@ const catalog = readA2UICatalogFromDirectory({
 const prompt = buildA2UISystemPrompt({ catalog });
 ```
 
-`readA2UICatalogFromDirectory` expects generated files such as
-`<Component>/catalog.json` and optional function definitions under `functions/`.
+`readA2UICatalogFromDirectory` prefers the full catalog file, such as
+`dist/catalog.json`, and falls back to generated component files such as
+`catalog/<Component>/catalog.json`.
 Use `genui a2ui generate catalog` to create those artifacts.
 
 ## Exports

package/a2ui-prompt/dist/index.d.ts

@@ -2,6 +2,10 @@ export declare const A2UI_PROTOCOL_VERSION = "v0.9";
 
 export declare const A2UI_SYSTEM_PROMPT: string;
 
+/**
+ * Prompt-ready A2UI catalog including components, rules, examples, and
+ * optional client functions.
+ */
 export declare interface A2UICatalog {
     id: string;
     label: string;
@@ -12,6 +16,9 @@ export declare interface A2UICatalog {
     functions?: A2UIFunctionSpec[];
 }
 
+/**
+ * Prompt-facing description of a single A2UI component prop.
+ */
 export declare interface A2UIComponentProp {
     name: string;
     type: string;
@@ -21,6 +28,9 @@ export declare interface A2UIComponentProp {
     schema?: JsonSchema;
 }
 
+/**
+ * Prompt-facing component specification derived from a catalog manifest.
+ */
 export declare interface A2UIComponentSpec {
     name: string;
     summary: string;
@@ -29,12 +39,19 @@ export declare interface A2UIComponentSpec {
     containerShape?: 'children' | 'child' | 'tabs' | 'trigger-content' | 'none';
 }
 
+/**
+ * Validated user request and message sequence included as an in-context A2UI
+ * example.
+ */
 export declare interface A2UIExample {
     name: string;
     user: string;
     messages: unknown[];
 }
 
+/**
+ * Prompt-facing schema for a client-side function the agent may call.
+ */
 export declare interface A2UIFunctionSpec {
     description?: string;
     name: string;
@@ -48,13 +65,22 @@ export declare const BASIC_CATALOG_EXAMPLES: A2UIExample[];
 
 export declare const BASIC_CATALOG_ID = "https://a2ui.org/specification/v0_9/basic_catalog.json";
 
+/**
+ * Build the full A2UI system prompt for the supplied catalog.
+ */
 export declare function buildA2UISystemPrompt(opts?: BuildSystemPromptOptions): string;
 
+/**
+ * Options used to customize the generated A2UI system prompt.
+ */
 export declare interface BuildSystemPromptOptions {
     catalog?: A2UICatalog;
     appendix?: string;
 }
 
+/**
+ * Convert generated component manifests into a prompt-ready A2UI catalog.
+ */
 export declare function createA2UICatalogFromManifests(options: {
     catalogId: string;
     componentManifests: Record<string, JsonSchema>[];
@@ -65,7 +91,11 @@ export declare function createA2UICatalogFromManifests(options: {
     version?: string;
 }): A2UICatalog;
 
+/**
+ * JSON Schema subset used in prompt-facing catalog descriptions.
+ */
 export declare interface JsonSchema {
+    const?: unknown;
     type?: string;
     enum?: unknown;
     oneOf?: JsonSchema[];
@@ -74,8 +104,12 @@ export declare interface JsonSchema {
     required?: string[];
     description?: string;
     additionalProperties?: unknown;
+    unevaluatedProperties?: unknown;
 }
 
+/**
+ * Options for loading generated A2UI catalog artifacts from a directory.
+ */
 export declare interface ReadA2UICatalogDirectoryOptions {
     catalogDir: string;
     catalogId: string;
@@ -84,8 +118,15 @@ export declare interface ReadA2UICatalogDirectoryOptions {
     version?: string;
 }
 
+/**
+ * Read generated component and function manifests and convert them into a
+ * prompt-ready A2UI catalog.
+ */
 export declare function readA2UICatalogFromDirectory(options: ReadA2UICatalogDirectoryOptions): A2UICatalog;
 
+/**
+ * Render an A2UI catalog into the Markdown reference embedded in prompts.
+ */
 export declare function renderCatalogReference(catalog: A2UICatalog): string;
 
 export { }