@lynx-js/genui 0.0.1-rc.0

package/a2ui-prompt/README.md

@@ -0,0 +1,65 @@
+# A2UI Prompt
+
+`@lynx-js/genui/a2ui-prompt` provides A2UI system prompt construction utilities for
+CLI and backend usage.
+
+The source of truth for the built-in prompt and catalog is
+`packages/genui/server/agent`. This package re-exports and bundles those server
+agent sources for publishing, so the server package stays self-contained for
+package-root deployments while CLI users can still install a standalone prompt
+package.
+
+## Usage
+
+Build a prompt with the built-in A2UI basic catalog:
+
+```ts
+import { buildA2UISystemPrompt } from '@lynx-js/genui/a2ui-prompt';
+
+const prompt = buildA2UISystemPrompt();
+```
+
+Read generated catalog artifacts and build a prompt for a custom catalog:
+
+```ts
+import {
+  buildA2UISystemPrompt,
+  readA2UICatalogFromDirectory,
+} from '@lynx-js/genui/a2ui-prompt';
+
+const catalog = readA2UICatalogFromDirectory({
+  catalogDir: 'dist/catalog',
+  catalogId: 'https://example.com/catalogs/custom/v1/catalog.json',
+});
+
+const prompt = buildA2UISystemPrompt({ catalog });
+```
+
+`readA2UICatalogFromDirectory` expects generated files such as
+`<Component>/catalog.json` and optional function definitions under `functions/`.
+Use `genui a2ui generate catalog` or
+`@lynx-js/genui/a2ui-catalog-extractor` to create those artifacts.
+
+## Exports
+
+- `buildA2UISystemPrompt`
+- `A2UI_SYSTEM_PROMPT`
+- `BASIC_CATALOG`
+- `BASIC_CATALOG_ID`
+- `renderCatalogReference`
+- `createA2UICatalogFromManifests`
+- `readA2UICatalogFromDirectory`
+
+## Local Development
+
+Build the publishable bundle:
+
+```bash
+pnpm -C packages/genui/a2ui-prompt build
+```
+
+Run the package type check:
+
+```bash
+pnpm -C packages/genui/a2ui-prompt exec tsc -p tsconfig.json --noEmit
+```

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

@@ -0,0 +1,91 @@
+export declare const A2UI_PROTOCOL_VERSION = "v0.9";
+
+export declare const A2UI_SYSTEM_PROMPT: string;
+
+export declare interface A2UICatalog {
+    id: string;
+    label: string;
+    version?: string;
+    components: A2UIComponentSpec[];
+    extraRules?: string[];
+    examples?: A2UIExample[];
+    functions?: A2UIFunctionSpec[];
+}
+
+export declare interface A2UIComponentProp {
+    name: string;
+    type: string;
+    description?: string;
+    required?: boolean;
+    enums?: readonly string[];
+    schema?: JsonSchema;
+}
+
+export declare interface A2UIComponentSpec {
+    name: string;
+    summary: string;
+    props: A2UIComponentProp[];
+    requiresAction?: boolean;
+    containerShape?: 'children' | 'child' | 'tabs' | 'trigger-content' | 'none';
+}
+
+export declare interface A2UIExample {
+    name: string;
+    user: string;
+    messages: unknown[];
+}
+
+export declare interface A2UIFunctionSpec {
+    description?: string;
+    name: string;
+    parameters: JsonSchema;
+    returnType: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'any' | 'void';
+}
+
+export declare const BASIC_CATALOG: A2UICatalog;
+
+export declare const BASIC_CATALOG_EXAMPLES: A2UIExample[];
+
+export declare const BASIC_CATALOG_ID = "https://a2ui.org/specification/v0_9/basic_catalog.json";
+
+export declare function buildA2UISystemPrompt(opts?: BuildSystemPromptOptions): string;
+
+export declare interface BuildSystemPromptOptions {
+    catalog?: A2UICatalog;
+    appendix?: string;
+}
+
+export declare function createA2UICatalogFromManifests(options: {
+    catalogId: string;
+    componentManifests: Record<string, JsonSchema>[];
+    examples?: A2UIExample[];
+    extraRules?: string[];
+    functions?: A2UIFunctionSpec[];
+    label?: string;
+    version?: string;
+}): A2UICatalog;
+
+export declare interface JsonSchema {
+    type?: string;
+    enum?: unknown;
+    oneOf?: JsonSchema[];
+    items?: JsonSchema;
+    properties?: Record<string, JsonSchema>;
+    required?: string[];
+    description?: string;
+    additionalProperties?: unknown;
+}
+
+export declare interface ReadA2UICatalogDirectoryOptions {
+    catalogDir: string;
+    catalogId: string;
+    cwd?: string;
+    label?: string;
+    version?: string;
+}
+
+export declare function readA2UICatalogFromDirectory(options: ReadA2UICatalogDirectoryOptions): A2UICatalog;
+
+export declare function renderCatalogReference(catalog: A2UICatalog): string;
+
+export { }