@genkit-ai/a2ui 0.5.0-rc.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,314 @@
+# @genkit-ai/a2ui
+
+A Genkit plugin that brings [A2UI](https://a2ui.org/) ("Agent to UI"), a
+transport-agnostic, JSON-based streaming UI protocol, to Genkit agents.
+
+An A2UI-enabled agent can stream more than prose. It streams rich, interactive UI
+**surfaces** (cards, lists, forms, buttons) that a client renders incrementally
+as the model responds. The whole server-side integration is a single model
+middleware: add `a2ui()` to an agent's `use` array and nothing else changes.
+
+> Status: experimental.
+
+## Installation
+
+Install the plugin in your project:
+
+```bash
+npm i @genkit-ai/a2ui
+```
+
+To render surfaces in the browser you will also want a renderer and its
+supporting packages. A2UI ships renderers for several frameworks:
+[`@a2ui/lit`](https://www.npmjs.com/package/@a2ui/lit),
+[`@a2ui/react`](https://www.npmjs.com/package/@a2ui/react), and
+[`@a2ui/angular`](https://www.npmjs.com/package/@a2ui/angular). The examples
+below use the Lit renderer:
+
+```bash
+npm i @a2ui/lit @a2ui/web_core @a2ui/markdown-it
+```
+
+You will also load the **Material Symbols Outlined** font on the client (the
+basic catalog's `Icon` component renders names as font ligatures). See the
+[renderer note](#renderer-requirements) below.
+
+
+## Quickstart
+
+### 1. Add the middleware on the server
+
+Add `a2ui()` to your agent's `use` array. That is the entire server-side setup.
+
+```ts
+import { genkit } from 'genkit/beta';
+import { googleAI } from '@genkit-ai/google-genai';
+import { a2ui } from '@genkit-ai/a2ui';
+
+const ai = genkit({ plugins: [googleAI()] });
+
+export const uiAgent = ai.defineAgent({
+  name: 'uiAgent',
+  model: 'googleai/gemini-flash-latest',
+  system: 'You help users. Render UI when it is clearer than prose.',
+  use: [a2ui()], // <- A2UI support (defaults to the bundled 'basic' catalog)
+});
+```
+
+It works the same on a one-shot `generate`:
+
+```ts
+const res = await ai.generate({
+  prompt: 'Show me the weather in Tokyo',
+  use: [a2ui()],
+});
+```
+
+### 2. Render surfaces on the client
+
+`@genkit-ai/a2ui/client` is browser-safe (no Node dependencies). Consume the
+agent with `remoteAgent` from `genkit/beta/client`, pull A2UI envelopes off each
+chunk with `a2uiEnvelopesFromParts`, and feed them to a renderer. The example
+below uses [`@a2ui/lit`](https://www.npmjs.com/package/@a2ui/lit), but the same
+approach works with the [`@a2ui/react`](https://www.npmjs.com/package/@a2ui/react)
+and [`@a2ui/angular`](https://www.npmjs.com/package/@a2ui/angular) renderers:
+
+```ts
+import { MessageProcessor } from '@a2ui/web_core/v0_9';
+import { basicCatalog } from '@a2ui/lit/v0_9';
+import '@a2ui/lit/v0_9'; // registers <a2ui-surface> + basic components
+import { a2uiEnvelopesFromParts } from '@genkit-ai/a2ui/client';
+import { remoteAgent } from 'genkit/beta/client';
+
+const processor = new MessageProcessor([basicCatalog]);
+processor.onSurfaceCreated((s) => {
+  document.querySelector('a2ui-surface').surface = s;
+});
+
+const chat = remoteAgent({ url: '/api/uiAgent' }).chat();
+const turn = chat.sendStream('weather in Tokyo');
+for await (const chunk of turn.stream) {
+  if (chunk.text) appendProse(chunk.text);
+  const envelopes = a2uiEnvelopesFromParts(chunk.raw.modelChunk?.content);
+  if (envelopes.length) processor.processMessages(envelopes);
+}
+```
+
+If you are not using the full agent client, `@genkit-ai/a2ui/client` also ships a
+lightweight `streamA2uiAgent({ url, message, sessionId })` async-generator helper
+that yields `{ type: 'text' }` and `{ type: 'envelopes' }` events.
+
+> See [`js/testapps/a2ui`](../../testapps/a2ui) for a complete, runnable sample
+> (Express backend plus a Vite + Lit frontend).
+
+## Options
+
+Pass options to `a2ui()` to control the catalog, prompt injection, and
+validation:
+
+| Option         | Default    | Description                                                                                                                     |
+| -------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `catalog`      | `'basic'`  | The id of the catalog describing what the agent may render.                                                                    |
+| `instructions` | `'system'` | Where to inject catalog capabilities. `'none'` injects nothing.                                                                |
+| `validate`     | `'warn'`   | Validate emitted envelopes against the catalog. `'warn'` logs and drops bad blocks; `'strict'` throws; `'off'` skips checking. |
+| `surfaceId`    | fresh UUID | Surface id policy. Defaults to a new UUID per surface; pass a fixed string to reuse one id for every surface.                  |
+| `version`      | `'v0.9'`   | Protocol version stamped on envelopes.                                                                                         |
+
+## Handling user actions
+
+When a user interacts with a surface (for example, presses a `Button`), the
+renderer emits an `A2uiClientAction`. Turn it into an agent input with
+`actionToMessage` and send it as the next turn:
+
+```ts
+import { actionToMessage, type A2uiClientAction } from '@genkit-ai/a2ui/client';
+
+const processor = new MessageProcessor([basicCatalog], (action) => {
+  const turn = chat.sendStream({ message: actionToMessage(action) });
+  // …consume turn.stream like above…
+});
+```
+
+The action's `name` is sent as the user message; the full action (including its
+`context`) is attached as an a2ui data part so the agent can react to it.
+
+### Forms
+
+Input components (`TextField`, `CheckBox`, `Slider`) do **not** send their values
+automatically. To capture what the user entered, the model must:
+
+1. Bind each input's `value` to a data-model path (`{ "path": "/email" }`).
+2. Echo those same paths in the submit `Button`'s `action.event.context`.
+
+The catalog capabilities injected into the system prompt already instruct the
+model to do this. Without both steps, the action arrives with an empty `context`.
+
+### Renderer requirements
+
+The `@a2ui/lit` basic catalog needs two host-side pieces to render fully:
+
+- A **MarkdownRenderer** provided via Lit context (for example, backed by
+  `@a2ui/markdown-it`). `Text` heading variants are rendered as Markdown.
+- The **Material Symbols Outlined** font. The `Icon` component renders names as
+  font ligatures.
+
+Without them, headings show as literal `##` and icons show as literal names. See
+[`js/testapps/a2ui`](../../testapps/a2ui) for the wiring.
+
+## Custom catalogs
+
+The `catalog` option is a **catalog id** resolved from the Genkit registry. The
+bundled `'basic'` catalog (mirroring `@a2ui/web_core`'s basic catalog) is the
+default and needs no registration.
+
+To match your own layout elements and design system, define a custom catalog,
+register it with `loadCatalog`, and reference it by id.
+
+### Catalog format
+
+An A2UI catalog describes the components the model is allowed to emit:
+
+- `id`: A globally unique URI identifying the catalog (used as `catalogId` on
+  `createSurface`).
+- `components`: An array of components, where each has:
+  - `name`: The component type name, matching the renderer type (for example
+    `CustomCard`, `Text`).
+  - `description`: A clear, one-line summary of what the component is and when to
+    use it.
+  - `props`: A compact, model-facing text description of its properties (kept as
+    a simple, human-readable string to minimize system prompt token usage).
+
+### Option A: load from a JSON file
+
+Create a JSON file (for example `./my-catalog.json`) following this format:
+
+```json
+{
+  "id": "https://my-app.org/catalogs/custom.json",
+  "components": [
+    {
+      "name": "Banner",
+      "description": "Displays a prominent alert banner at the top of a section.",
+      "props": "title: string (required); severity?: info|warning|error."
+    },
+    {
+      "name": "Text",
+      "description": "Displays a plain or inline-markdown text run.",
+      "props": "text: string (required); variant?: body|caption."
+    }
+  ]
+}
+```
+
+Then register it under a lookup identifier (for example `'my-catalog'`) on the
+server:
+
+```ts
+import { loadCatalog } from '@genkit-ai/a2ui';
+
+await loadCatalog(ai, { id: 'my-catalog', file: './my-catalog.json' });
+```
+
+### Option B: in-memory definition
+
+You can construct and register an `A2uiCatalog` directly:
+
+```ts
+import { loadCatalog, type A2uiCatalog } from '@genkit-ai/a2ui';
+
+const myCatalog: A2uiCatalog = {
+  id: 'https://my-app.org/catalogs/custom.json',
+  components: [
+    {
+      name: 'Banner',
+      description: 'Displays a prominent alert banner at the top of a section.',
+      props: 'title: string (required); severity?: info|warning|error.',
+    },
+    {
+      name: 'Text',
+      description: 'Displays a plain or inline-markdown text run.',
+      props: 'text: string (required); variant?: body|caption.',
+    },
+  ],
+};
+
+await loadCatalog(ai, { id: 'my-catalog', catalog: myCatalog });
+```
+
+### Using a registered catalog
+
+Once registered, reference the lookup id in your `a2ui()` options:
+
+```ts
+export const uiAgent = ai.defineAgent({
+  name: 'uiAgent',
+  model: 'googleai/gemini-flash-latest',
+  use: [a2ui({ catalog: 'my-catalog' })],
+});
+```
+
+Catalogs live in the registry (value type `a2ui-catalog`) so the middleware can
+resolve them by id and, in the future, tooling can list them.
+
+## Security and the trust boundary
+
+Generative UI moves model output into the DOM, so treat every surface an agent
+emits as **untrusted input**. The `a2ui()` middleware's `validate` option
+(including `'strict'`) checks envelope structure and component *type names*
+against the catalog only. It does **not** validate component props or data-model
+values: model-controlled values such as `Image.url` and `Text` (inline Markdown,
+which a renderer may turn into HTML) pass through untouched. `'strict'` is a
+well-formedness check, not a security boundary.
+
+A prompt-injected or simply mistaken model can therefore emit an arbitrary remote
+image URL, or Markdown that a renderer turns into HTML. To keep that safe:
+
+- **The renderer/catalog owns prop sanitization.** Whatever renders a surface
+  (for example `@a2ui/lit` plus your Markdown renderer) is responsible for
+  escaping and sanitizing prop values before they reach the DOM. If you ship a
+  custom catalog, its renderer must sanitize its own components' props.
+- **Restrict remote sources at the host.** Serve the app with a Content Security
+  Policy that limits `img-src` (and other fetch directives) to origins you trust,
+  so a model-supplied image or link URL cannot exfiltrate data or load
+  unexpected content.
+- **Do not put secrets in the data model.** Anything bound into a surface's data
+  model can be echoed back through an action's `context`.
+
+If you need server-side control over props (for example, allow-listing image
+hosts), add your own model middleware after `a2ui()` to inspect and rewrite the
+emitted a2ui parts.
+
+## How it works
+
+### One representation
+
+A2UI rides on its own part channel: a Genkit `data` part carrying the mime type
+`application/a2ui+json` whose `data` is an object `{ envelopes }` wrapping an
+array of A2UI envelope messages. This maps 1:1 onto the A2A binding of the A2UI
+spec, so an A2A or MCP binding can drop in later for free.
+
+- A **mixed** turn is a message whose content is `[textPart, a2uiPart, …]`.
+- A **pure-surface** turn is the special case with no text parts.
+- Downstream consumers (client transport, `@a2ui/web_core`) only ever see a2ui
+  parts. "Pure vs mixed" is a prompting choice, not a separate code path.
+
+### The middleware pipeline
+
+On each model call inside the agent's tool loop, `a2ui()`:
+
+1. Injects the catalog's capabilities into the system prompt so the model knows
+   what UI it may render (unless `instructions: 'none'`).
+2. Intercepts the model's output, both the streamed chunks and the final
+   aggregated message.
+3. Extracts `a2ui` fenced code blocks from the model's text.
+4. Validates them against the catalog (per the `validate` option).
+5. Rewrites them into canonical a2ui data parts.
+
+Inbound a2ui parts (for example, a surface action sent back as the next turn, or
+replayed history) are summarized into plain text before the underlying model sees
+them, so a model that does not understand the a2ui mime type can still reason
+about prior surfaces and user actions.
+
+## License
+
+Apache-2.0

package/lib/catalog.d.mts

@@ -0,0 +1,70 @@
+/**
+ * Copyright 2026 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * The registry value type under which A2UI catalogs are stored, so the
+ * {@link a2ui} middleware can look them up by id (and, in the future, tooling
+ * can list them). Register with `ai.registry.registerValue(...)` via
+ * {@link loadCatalog}.
+ */
+declare const A2UI_CATALOG_VALUE_TYPE = "a2ui-catalog";
+/**
+ * The default catalog id used by the {@link a2ui} middleware when none is
+ * given. Resolves to the bundled {@link basicCatalog}.
+ */
+declare const DEFAULT_CATALOG_ID = "basic";
+/** A component the model may use, plus a short description of its props. */
+interface A2uiCatalogComponent {
+    /** The component type name, e.g. `Text`. */
+    name: string;
+    /** One-line description of what the component renders. */
+    description: string;
+    /**
+     * A short, model-facing description of the component's props. Kept as plain
+     * text (rather than a JSON Schema) to keep the injected prompt compact.
+     */
+    props: string;
+}
+/** A parsed catalog: an id plus the components it exposes. */
+interface A2uiCatalog {
+    /** Globally-unique catalog id (also used as `catalogId` on `createSurface`). */
+    id: string;
+    /** The components available in this catalog. */
+    components: A2uiCatalogComponent[];
+}
+/**
+ * The set of icon names the basic catalog's `Icon` component supports. Names
+ * outside this list render as literal text (the renderer degrades gracefully),
+ * so the prompt lists them to steer the model toward valid names. Note the
+ * middleware validates component *types* against the catalog but does not
+ * validate individual `Icon` name values.
+ */
+declare const BASIC_ICON_NAMES: readonly ["accountCircle", "add", "arrowBack", "arrowForward", "attachFile", "calendarToday", "call", "camera", "check", "close", "delete", "download", "edit", "event", "error", "fastForward", "favorite", "favoriteOff", "folder", "help", "home", "info", "locationOn", "lock", "lockOpen", "mail", "menu", "moreVert", "moreHoriz", "notificationsOff", "notifications", "pause", "payment", "person", "phone", "photo", "play", "print", "refresh", "rewind", "search", "send", "settings", "share", "shoppingCart", "skipNext", "skipPrevious", "star", "starHalf", "starOff", "stop", "upload", "visibility", "visibilityOff", "volumeDown", "volumeMute", "volumeOff", "volumeUp", "warning"];
+/**
+ * The A2UI "Basic Catalog" (v0.9), mirroring the components published by
+ * `@a2ui/web_core`'s basic catalog. Use this to render standard UI without
+ * defining your own design system.
+ */
+declare const basicCatalog: A2uiCatalog;
+/**
+ * Renders a catalog into model-facing instructions describing the A2UI protocol
+ * and the available components. Injected into the system prompt by the
+ * middleware when `instructions !== 'none'`.
+ */
+declare function renderCatalogInstructions(catalog: A2uiCatalog): string;
+/** The literal placeholder the model is told to use for surface ids. */
+declare const SURFACE_ID_PLACEHOLDER = "SURFACE_ID";
+
+export { A2UI_CATALOG_VALUE_TYPE, type A2uiCatalog, type A2uiCatalogComponent, BASIC_ICON_NAMES, DEFAULT_CATALOG_ID, SURFACE_ID_PLACEHOLDER, basicCatalog, renderCatalogInstructions };

package/lib/catalog.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright 2026 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * The registry value type under which A2UI catalogs are stored, so the
+ * {@link a2ui} middleware can look them up by id (and, in the future, tooling
+ * can list them). Register with `ai.registry.registerValue(...)` via
+ * {@link loadCatalog}.
+ */
+declare const A2UI_CATALOG_VALUE_TYPE = "a2ui-catalog";
+/**
+ * The default catalog id used by the {@link a2ui} middleware when none is
+ * given. Resolves to the bundled {@link basicCatalog}.
+ */
+declare const DEFAULT_CATALOG_ID = "basic";
+/** A component the model may use, plus a short description of its props. */
+interface A2uiCatalogComponent {
+    /** The component type name, e.g. `Text`. */
+    name: string;
+    /** One-line description of what the component renders. */
+    description: string;
+    /**
+     * A short, model-facing description of the component's props. Kept as plain
+     * text (rather than a JSON Schema) to keep the injected prompt compact.
+     */
+    props: string;
+}
+/** A parsed catalog: an id plus the components it exposes. */
+interface A2uiCatalog {
+    /** Globally-unique catalog id (also used as `catalogId` on `createSurface`). */
+    id: string;
+    /** The components available in this catalog. */
+    components: A2uiCatalogComponent[];
+}
+/**
+ * The set of icon names the basic catalog's `Icon` component supports. Names
+ * outside this list render as literal text (the renderer degrades gracefully),
+ * so the prompt lists them to steer the model toward valid names. Note the
+ * middleware validates component *types* against the catalog but does not
+ * validate individual `Icon` name values.
+ */
+declare const BASIC_ICON_NAMES: readonly ["accountCircle", "add", "arrowBack", "arrowForward", "attachFile", "calendarToday", "call", "camera", "check", "close", "delete", "download", "edit", "event", "error", "fastForward", "favorite", "favoriteOff", "folder", "help", "home", "info", "locationOn", "lock", "lockOpen", "mail", "menu", "moreVert", "moreHoriz", "notificationsOff", "notifications", "pause", "payment", "person", "phone", "photo", "play", "print", "refresh", "rewind", "search", "send", "settings", "share", "shoppingCart", "skipNext", "skipPrevious", "star", "starHalf", "starOff", "stop", "upload", "visibility", "visibilityOff", "volumeDown", "volumeMute", "volumeOff", "volumeUp", "warning"];
+/**
+ * The A2UI "Basic Catalog" (v0.9), mirroring the components published by
+ * `@a2ui/web_core`'s basic catalog. Use this to render standard UI without
+ * defining your own design system.
+ */
+declare const basicCatalog: A2uiCatalog;
+/**
+ * Renders a catalog into model-facing instructions describing the A2UI protocol
+ * and the available components. Injected into the system prompt by the
+ * middleware when `instructions !== 'none'`.
+ */
+declare function renderCatalogInstructions(catalog: A2uiCatalog): string;
+/** The literal placeholder the model is told to use for surface ids. */
+declare const SURFACE_ID_PLACEHOLDER = "SURFACE_ID";
+
+export { A2UI_CATALOG_VALUE_TYPE, type A2uiCatalog, type A2uiCatalogComponent, BASIC_ICON_NAMES, DEFAULT_CATALOG_ID, SURFACE_ID_PLACEHOLDER, basicCatalog, renderCatalogInstructions };