@genkit-ai/vercel-ai 0.2.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,415 @@
+# @genkit-ai/vercel-ai
+
+A [Genkit](https://github.com/genkit-ai/genkit) plugin that provides a
+[Vercel AI SDK](https://sdk.vercel.ai/) `ChatTransport` for connecting
+`useChat` to Genkit Agents.
+
+Use this plugin to build rich chat UIs in React (Next.js, Vite, etc.) that
+stream responses from Genkit agents — including multi-turn conversations,
+tool calls, and interrupt-based human-in-the-loop flows — with zero
+custom plumbing.
+
+## Installation
+
+```bash
+npm install @genkit-ai/vercel-ai
+```
+
+### Peer dependencies
+
+| Package | Required | Notes |
+| ------- | -------- | ----- |
+| `genkit` | ✅ | `>=1.0.0` — the agent API used by this transport lives in the `genkit/beta` subpath. |
+| `ai` | ✅ | `^6.0.0` — provides `ChatTransport`, `UIMessage`, etc. |
+| `@ai-sdk/react` | Client only | `^3.0.0` — only needed where you call the `useChat` hook (browser). |
+
+> **Note:** `@ai-sdk/react` is not a declared peer dependency of this package
+> because the server-side entry point does not require it. Install it
+> yourself in any project that uses `useChat`.
+
+## Quick start
+
+### 1. Define a Genkit agent (server)
+
+```ts
+// app/api/chat/weather/route.ts  (Next.js App Router example)
+import { appRoute } from '@genkit-ai/next';
+import { genkit } from 'genkit/beta';
+import { googleAI } from '@genkit-ai/google-genai';
+
+const ai = genkit({ plugins: [googleAI()] });
+
+const weatherAgent = ai.defineAgent({
+  name: 'weatherAgent',
+  model: 'googleai/gemini-flash-latest',
+  tools: [/* your tools here */],
+});
+
+export const POST = appRoute(weatherAgent);
+```
+
+Or with Express:
+
+```ts
+import { expressHandler } from '@genkit-ai/express';
+import express from 'express';
+
+const app = express();
+app.post('/api/chat/weather', expressHandler(weatherAgent));
+app.listen(3000);
+```
+
+### 2. Connect from the client
+
+```tsx
+'use client';
+import { useChat } from '@ai-sdk/react';
+import { GenkitChatTransport } from '@genkit-ai/vercel-ai/client';
+import { useMemo } from 'react';
+
+export default function Chat() {
+  const transport = useMemo(
+    () => new GenkitChatTransport({ url: '/api/chat/weather' }),
+    []
+  );
+  // The `useChat` `id` is sent to the agent as its `sessionId`; it must be a UUID.
+  const chatId = useMemo(() => crypto.randomUUID(), []);
+
+  const { messages, input, handleInputChange, handleSubmit, status } =
+    useChat({ id: chatId, transport });
+
+
+  return (
+    <div>
+      {messages.map((m) => (
+        <div key={m.id}>
+          <strong>{m.role}:</strong>{' '}
+          {m.parts
+            .filter((p) => p.type === 'text')
+            .map((p) => p.text)
+            .join('')}
+        </div>
+      ))}
+      <form onSubmit={handleSubmit}>
+        <input value={input} onChange={handleInputChange} />
+        <button type="submit" disabled={status !== 'ready'}>
+          Send
+        </button>
+      </form>
+    </div>
+  );
+}
+```
+
+That's it — text streaming, multi-turn history, tool calls, and interrupts
+all work out of the box.
+
+## Works with AI Elements
+
+This transport is fully compatible with
+[AI Elements](https://elements.ai-sdk.dev/) — the component library and
+custom [shadcn/ui](https://ui.shadcn.com/) registry for building AI-native
+applications. Since `GenkitChatTransport` implements the standard
+`ChatTransport` interface, all AI Elements components (`Conversation`,
+`Message`, `Tool`, `PromptInput`, etc.) work out of the box with Genkit
+agents.
+
+```tsx
+'use client';
+import { useChat } from '@ai-sdk/react';
+import { GenkitChatTransport } from '@genkit-ai/vercel-ai/client';
+import { useMemo } from 'react';
+
+import {
+  Conversation, ConversationContent, ConversationScrollButton,
+} from '@/components/ai-elements/conversation';
+import { Message, MessageContent, MessageResponse } from '@/components/ai-elements/message';
+import {
+  PromptInput, PromptInputTextarea, PromptInputFooter, PromptInputSubmit,
+} from '@/components/ai-elements/prompt-input';
+import { Tool, ToolHeader, ToolContent, ToolInput, ToolOutput } from '@/components/ai-elements/tool';
+
+export default function Chat() {
+  const transport = useMemo(
+    () => new GenkitChatTransport({ url: '/api/chat/weather' }),
+    []
+  );
+  // The `useChat` `id` is sent to the agent as its `sessionId`; it must be a UUID.
+  const chatId = useMemo(() => crypto.randomUUID(), []);
+  const { messages, status, sendMessage } = useChat({ id: chatId, transport });
+
+
+  return (
+    <Conversation>
+      <ConversationContent>
+        {messages.map((message) => (
+          <Message key={message.id} from={message.role}>
+            <MessageContent>
+              {message.parts.map((part, i) => {
+                if (part.type === 'text' && part.text) {
+                  return <MessageResponse key={i}>{part.text}</MessageResponse>;
+                }
+                if (part.type.startsWith('tool-')) {
+                  const toolPart = part as any;
+                  return (
+                    <Tool key={i}>
+                      <ToolHeader type={toolPart.type} state={toolPart.state} />
+                      <ToolContent>
+                        <ToolInput input={toolPart.input} />
+                        <ToolOutput output={toolPart.output} />
+                      </ToolContent>
+                    </Tool>
+                  );
+                }
+                return null;
+              })}
+            </MessageContent>
+          </Message>
+        ))}
+      </ConversationContent>
+      <ConversationScrollButton />
+      <PromptInput onSubmit={(msg) => sendMessage({ text: msg.text })}>
+        <PromptInputTextarea placeholder="Message..." />
+        <PromptInputFooter>
+          <div />
+          <PromptInputSubmit status={status} />
+        </PromptInputFooter>
+      </PromptInput>
+    </Conversation>
+  );
+}
+```
+
+See the full working example in
+[`js/testapps/vercel-ai-elements`](../../testapps/vercel-ai-elements) which
+demonstrates multi-agent selection, tool call rendering, and interrupt-based
+human-in-the-loop approval flows — all powered by AI SDK Elements.
+
+## Entry points
+
+| Import path | Environment | Contents |
+| ----------- | ----------- | -------- |
+| `@genkit-ai/vercel-ai` | Server / shared | Mapping utilities (`mapUIMessageToGenkit`, `mapUIPartToGenkit`, etc.) and re-exported `UIMessage` type |
+| `@genkit-ai/vercel-ai/client` | Browser / client | `GenkitChatTransport` class |
+
+The `/client` entry point is browser-safe and has no Node.js dependencies.
+
+## API
+
+### `GenkitChatTransport`
+
+```ts
+import { GenkitChatTransport } from '@genkit-ai/vercel-ai/client';
+
+const transport = new GenkitChatTransport({
+  url: '/api/chat/weather',
+  headers: { Authorization: 'Bearer token' },         // static headers
+  // headers: () => ({ Authorization: `Bearer ${getToken()}` }),  // or dynamic
+});
+```
+
+#### Configuration
+
+| Option | Type | Description |
+| ------ | ---- | ----------- |
+| `url` | `string` | **Required.** URL of the Genkit agent endpoint. |
+| `headers` | `Record<string, string> \| () => Record<string, string>` | Optional HTTP headers to include on every request. Accepts a static object or a function for dynamic values (e.g. auth tokens). |
+
+> **The `useChat` `id` must be a bare UUID.** The transport sends the chat
+> `id` to the agent as its Genkit `sessionId`, and the agent server requires
+> session ids to be bare UUIDs. Generate one with `crypto.randomUUID()` and
+> pass it to `useChat({ id })`. If you omit `id`, the AI SDK generates a
+> non-UUID id and the transport will return an error.
+
+```tsx
+import { useMemo } from 'react';
+
+const chatId = useMemo(() => crypto.randomUUID(), []);
+const { messages, sendMessage } = useChat({ id: chatId, transport });
+```
+
+#### Server-managed session state
+
+Conversation state is **fully server-managed**. The transport sends the chat
+`id` to the agent as a `sessionId`, and the agent persists per-session state in
+its configured `SessionStore`. Each turn automatically resumes the session's
+latest snapshot — there is **no client-side snapshot bookkeeping** to manage or
+persist, and nothing is lost on a page reload (the server holds the state).
+
+To continue an existing conversation, simply reuse the same UUID `id`.
+
+#### Restoring a conversation after a reload
+
+Because state is server-managed, resuming the *next* turn requires nothing more
+than reusing the same UUID `id`. The only thing the client must rebuild is the
+*rendered* message list (`useChat` owns those, and they are not persisted by
+the transport).
+
+Use `messagesFromSnapshot` to rebuild the visible messages from a Genkit
+`SessionSnapshot` (loaded via a `/state` flow keyed by the same `sessionId`):
+
+```tsx
+import { useChat } from '@ai-sdk/react';
+import { GenkitChatTransport } from '@genkit-ai/vercel-ai/client';
+import { messagesFromSnapshot } from '@genkit-ai/vercel-ai';
+import { runFlow } from 'genkit/beta/client';
+import { useEffect, useMemo, useState } from 'react';
+
+export default function RestoredChat({ sessionId }: { sessionId: string }) {
+  const transport = useMemo(() => new GenkitChatTransport({ url: '/api/chat/weather' }), []);
+  const [initialMessages, setInitialMessages] = useState([]);
+
+  useEffect(() => {
+    (async () => {
+      // Load the latest snapshot for this session (returns a SessionSnapshot).
+      const snapshot = await runFlow({ url: '/api/chat/weather/state', input: sessionId });
+      // Rebuild the visible message list from the snapshot.
+      setInitialMessages(messagesFromSnapshot(snapshot.state.messages));
+    })();
+  }, [sessionId]);
+
+  // Reuse the same UUID `id` so the next turn resumes the server-side session.
+  const { messages, sendMessage } = useChat({ id: sessionId, transport, messages: initialMessages });
+  // ...render messages, send new turns — continuity is preserved.
+}
+```
+
+`messagesFromSnapshot` merges Genkit's separate tool request / tool response
+messages into single AI SDK tool parts (so each tool call renders as one
+element), maps `reasoning` and `media` parts, preserves part `metadata`, and
+emits any unresolved tool request (e.g. a pending interrupt) in the
+`input-available` state so the UI can still resolve it.
+
+> **Tip:** the `sessionId` you load the snapshot with must be the same UUID you
+> pass as the `useChat` `id`, so the rendered messages and the server-side
+> session stay in sync.
+
+#### Regenerating a response
+
+When the UI triggers a regeneration (the AI SDK sends
+`trigger: 'regenerate-message'`), the transport re-runs the last user message
+as a **fresh turn** against the current server-side session state. This
+produces a new answer to the same prompt. Because state is server-managed by
+`sessionId`, there is no client-side snapshot pointer to rewind to — the
+regenerated turn is appended to the session like any other turn.
+
+#### How it works
+
+1. **Sends messages** via Genkit's `streamFlow` client — a browser-safe HTTP
+   client that POSTs to the agent endpoint and reads the NDJSON streaming
+   response.
+2. **Transforms** Genkit's `AgentStreamChunk` events into Vercel AI SDK
+   `UIMessageChunk` events (`text-delta`, `tool-input-available`,
+   `tool-output-available`, etc.).
+3. **Sends the session id** — the transport passes `init: { sessionId: chatId }`
+   to the agent, which persists per-session state server-side and resumes the
+   session's latest snapshot on each turn. No client-side snapshot tracking is
+   needed.
+4. **Handles interrupts** — when an agent pauses for human input (via
+   `defineInterrupt`), the transport surfaces the pending tool call to the UI.
+   On the next `sendMessages` call the resolved tool results are detected
+   directly from the message history, and the transport automatically sends a
+   `resume` payload instead of a new message.
+
+
+### Interrupts (human-in-the-loop)
+
+Genkit agents can **pause** mid-run to ask a human for input via
+`defineInterrupt` (or a tool that calls `interrupt()`). When this happens,
+the transport surfaces the paused tool call to `useChat` as a tool part in
+the `input-available` state. There are two ways to resolve it:
+
+1. **Respond** — supply the tool's output directly (the human's decision
+   _is_ the result). This is what a `defineInterrupt` tool expects.
+2. **Restart** — ask the agent to **re-run** the tool server-side, optionally
+   attaching metadata. Useful for tools that `interrupt()` until confirmed and
+   then compute a real result on resume (their `resumed` argument is set).
+
+Both are driven by the AI SDK's native HITL primitives — `addToolResult` plus
+`sendAutomaticallyWhen` — so no manual `setMessages`/`flushSync` is needed:
+
+```tsx
+import { useChat } from '@ai-sdk/react';
+import {
+  GenkitChatTransport,
+  restartInterrupt,
+} from '@genkit-ai/vercel-ai/client';
+import { lastAssistantMessageIsCompleteWithToolCalls } from 'ai';
+
+const { messages, addToolResult } = useChat({
+  transport: new GenkitChatTransport({ url: '/api/chat/banking' }),
+  // Auto-resume once every paused tool call has a result.
+  sendAutomaticallyWhen: lastAssistantMessageIsCompleteWithToolCalls,
+});
+
+// 1. Respond: provide the tool output (resume.respond).
+addToolResult({
+  tool: 'userApproval',
+  toolCallId,
+  output: { approved: true, feedback: 'Looks good' },
+});
+
+// 2. Restart: re-run the tool (resume.restart). The metadata becomes the
+//    tool's `resumed` argument server-side.
+addToolResult({
+  tool: 'getExchangeRate',
+  toolCallId,
+  output: restartInterrupt({ confirmedAt: Date.now() }),
+});
+```
+
+> **Note:** Genkit interrupts map to the AI SDK's `addToolResult` flow, **not**
+> the tool-_approval_ flow (`needsApproval` / `addToolApprovalResponse`). A
+> Genkit interrupt never executes server-side on its own — the value you pass
+> to `addToolResult` _is_ the resolution. Use `restartInterrupt()` when you
+> want the agent to re-run the tool instead of accepting a supplied output.
+
+See the full working example in
+[`js/testapps/vercel-ai-elements`](../../testapps/vercel-ai-elements), which
+demonstrates both the approval (`userApproval`) and restart (`getExchangeRate`)
+flows.
+
+### Mapping utilities
+
+The root entry point (`@genkit-ai/vercel-ai`) exports mapping functions
+between Vercel AI SDK `UIMessage` types and Genkit `MessageData`, plus
+helper functions used by the transport:
+
+| Function | Direction | Description |
+| -------- | --------- | ----------- |
+| `mapUIMessageToGenkit(msg)` | UI → Genkit | Convert a Vercel `UIMessage` to a Genkit `MessageData` |
+| `mapUIPartToGenkit(part)` | UI → Genkit | Convert a single `UIMessagePart` to Genkit `Part[]` |
+| `messagesFromSnapshot(msgs)` | Genkit → UI | Convert a `SessionSnapshot`'s `state.messages` into `UIMessage[]` for rehydrating `useChat` (pairs tool requests/responses, preserves metadata) |
+| `mapGenkitMessageToUI(msg)` | Genkit → UI | Convert a single Genkit `MessageData` into a `UIMessage` |
+| `extractResolvedToolResults(msgs)` | — | Extract resolved tool invocation results from the message array |
+| `findLastUserMessage(msgs)` | — | Find the last user message in a `UIMessage[]` |
+
+Tool/part metadata is preserved in both directions: `mapUIPartToGenkit`
+carries a UI part's `metadata` onto the Genkit part, and `messagesFromSnapshot`
+carries a Genkit part's `metadata` back onto the UI part.
+
+
+The `UIMessage` type is also re-exported from the `ai` package for convenience.
+
+## Features
+
+- **Text streaming** — streams token-by-token text deltas to the UI
+- **Multi-turn conversations** — automatic server-managed session continuity keyed by the `useChat` `id` (`sessionId`)
+- **Tool calls** — surfaces tool inputs and outputs as they happen
+
+- **Interrupts (human-in-the-loop)** — first-class support for `defineInterrupt` tools; pause and resume flows with user input
+- **Custom headers** — static or dynamic headers for authentication
+- **Browser-safe** — the `/client` entry point has no Node.js dependencies
+- **Zero config** — no `ChatSessionStore` needed on the client side
+
+## Requirements
+
+- Genkit `>=1.0.0` — the agent API (`defineAgent`, `streamFlow`) used by this
+  transport is exposed via the `genkit/beta` subpath of the main `1.x` package.
+- Vercel AI SDK `>=6.0.0` (for `useChat` with `ChatTransport`)
+- `@ai-sdk/react` `>=3.0.0` (client-side, for the `useChat` hook)
+- Node.js `>=20` (server-side)
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).