@agent-cards/commerce-sdk 0.1.0 → 0.5.0

package/dist/handler.d.ts

@@ -1,11 +1,13 @@
 /**
- * A Node or Express `(req, res)` handler for an Agentcard webhook endpoint. It
- * reads the raw bytes, checks the signature, hands the event to your callback,
- * and answers once the callback is done: 200 when it returns, 500 when it
- * throws, so Agentcard delivers the event again instead of losing it.
+ * Handlers for an Agentcard webhook endpoint, for a Node or Express `(req, res)`
+ * route and for a route that takes a web `Request`, such as a Next.js route
+ * handler. Each reads the raw bytes, checks the signature, hands the event to
+ * your callback, and answers once the callback is done: 200 when it returns,
+ * 500 when it throws, so Agentcard delivers the event again instead of losing it.
  */
 import { type AgentcardEvent, type VerifyOptions } from './verify.js';
 import { type PurchaseMessage } from './message.js';
+import { type ShopperMessage } from './shopper-message.js';
 /** The parts of a Node or Express request the handler reads. */
 export interface WebhookRequest {
     headers: Record<string, string | string[] | undefined>;
@@ -35,6 +37,23 @@ export interface PurchaseAgentWebhookOptions extends Pick<VerifyOptions, 'tolera
      */
     onError?: (error: unknown, event: AgentcardEvent | undefined) => void | Promise<void>;
 }
+/** The parts of a web `Request` the fetch handler reads. */
+export interface WebhookFetchRequest {
+    headers: {
+        get(name: string): string | null;
+    };
+    /** The body as a stream, read chunk by chunk so a body past the size cap is never held whole. */
+    body?: {
+        getReader(): {
+            read(): Promise<{
+                done: boolean;
+                value?: Uint8Array;
+            }>;
+            cancel(reason?: unknown): Promise<void>;
+        };
+    } | null;
+    arrayBuffer(): Promise<ArrayBuffer>;
+}
 /**
  * A `(req, res)` handler for your Agentcard webhook endpoint. A delivery with a
  * missing, malformed, stale or wrong signature gets a 400 and reaches no
@@ -43,6 +62,40 @@ export interface PurchaseAgentWebhookOptions extends Pick<VerifyOptions, 'tolera
  * callback is done: 200 when it returns, and 500 when it throws, so Agentcard
  * delivers the event again. Agentcard waits 10 seconds for an answer, so keep
  * the callback short. Agentcard delivers at least once, and again after a 500,
- * so handle each `message.eventId` once.
+ * so handle each `message.eventId` once. `agentcardWebhook` does that for you.
  */
 export declare function purchaseAgentWebhook(secret: string, onMessage: (message: PurchaseMessage, event: AgentcardEvent) => void | Promise<void>, opts?: PurchaseAgentWebhookOptions): (req: WebhookRequest, res: WebhookResponse) => Promise<void>;
+export interface AgentcardWebhookOptions extends PurchaseAgentWebhookOptions {
+    /** The secret Agentcard returned once, when you created the endpoint. */
+    secret: string;
+    /**
+     * Receives each message for one of your shoppers, under your own id for them: post
+     * `message.text` into that shopper's chat, or hand `message.note` to your agent. Runs once per
+     * event, never for a stale message, and the delivery answers 500 when it throws, so Agentcard
+     * delivers the event again.
+     */
+    onMessage: (externalUserId: string, message: ShopperMessage, event: AgentcardEvent) => void | Promise<void>;
+    /**
+     * Receives every verified event that is no message for one of your shoppers: another event type,
+     * such as `vault.card_stored`, and a shopper message for a shopper you gave Agentcard no id for.
+     */
+    onEvent?: (event: AgentcardEvent) => void | Promise<void>;
+}
+/** The handler `agentcardWebhook` returns: a Node or Express `(req, res)` handler, with `fetch` for a web `Request`. */
+export interface AgentcardWebhookHandler {
+    (req: WebhookRequest, res: WebhookResponse): Promise<void>;
+    /** The same handler for a web `Request`, such as a Next.js route handler's: `export const POST = webhook.fetch`. */
+    fetch(request: WebhookFetchRequest): Promise<Response>;
+}
+/**
+ * One handler for every Agentcard event your shoppers should hear about. It checks each delivery's
+ * signature, skips an event this process already handled, reads the message the event carries for
+ * a shopper
+ * (`readShopperMessage`), drops a message whose link or window has closed (`isStale`), and calls
+ * `onMessage` with your own id for the shopper and the message, Agentcard's own text included.
+ * Every other verified event goes to `onEvent`. The answer waits for the callback: 200 when it
+ * returns, 500 when it throws, and an event whose callback threw runs again on the next delivery.
+ * The handled events live in this process's memory: with more than one server, deduplicate on
+ * `message.eventId` in your own storage too.
+ */
+export declare function agentcardWebhook(opts: AgentcardWebhookOptions): AgentcardWebhookHandler;

package/dist/handler.js

@@ -1,11 +1,13 @@
 /**
- * A Node or Express `(req, res)` handler for an Agentcard webhook endpoint. It
- * reads the raw bytes, checks the signature, hands the event to your callback,
- * and answers once the callback is done: 200 when it returns, 500 when it
- * throws, so Agentcard delivers the event again instead of losing it.
+ * Handlers for an Agentcard webhook endpoint, for a Node or Express `(req, res)`
+ * route and for a route that takes a web `Request`, such as a Next.js route
+ * handler. Each reads the raw bytes, checks the signature, hands the event to
+ * your callback, and answers once the callback is done: 200 when it returns,
+ * 500 when it throws, so Agentcard delivers the event again instead of losing it.
  */
 import { AgentcardSignatureError, InvalidEventBodyError, toleranceOf, verifyAgentcardWebhook, } from './verify.js';
 import { readPurchaseMessage } from './message.js';
+import { isStale, readShopperMessage } from './shopper-message.js';
 /** A signed Agentcard delivery is a few kilobytes; a body past this size did not come from Agentcard. */
 const MAX_BODY_BYTES = 1024 * 1024;
 const RAW_BODY_GONE = 'The webhook request reached the handler with its body already parsed and no raw bytes kept, so the signature cannot be checked. ' +
@@ -95,6 +97,132 @@ async function readRawBody(req) {
         return undefined;
     return readStream(req);
 }
+/** Hands an error to `onError`, or to `console.error`. A reporter that throws or rejects never takes the process down. */
+function reporter(onError) {
+    return (error, event) => {
+        try {
+            const reported = onError ? onError(error, event) : console.error('Agentcard webhook:', error);
+            // A reporter that rejects must not leave an unhandled rejection, which ends a plain Node server's process.
+            if (reported && typeof reported.then === 'function')
+                reported.then(undefined, () => { });
+        }
+        catch {
+            // A failing reporter must never take the process down with it.
+        }
+    };
+}
+function checkSecret(secret) {
+    if (typeof secret !== 'string' || secret === '') {
+        throw new TypeError('Pass the webhook endpoint secret Agentcard returned when you created the endpoint.');
+    }
+}
+/** Verifies one raw delivery and runs its callbacks. The answer waits for them, so a callback that fails gets the event delivered again. */
+async function answer(raw, signature, secret, verifyOpts, dispatch, report) {
+    let event;
+    try {
+        event = verifyAgentcardWebhook(raw, signature, secret, verifyOpts);
+    }
+    catch (error) {
+        if (error instanceof AgentcardSignatureError)
+            return { status: 400, body: { error: 'invalid_signature', reason: error.reason } };
+        if (error instanceof InvalidEventBodyError)
+            return { status: 400, body: { error: 'invalid_body' } };
+        report(error, undefined);
+        return { status: 500, body: { error: 'verification_failed' } };
+    }
+    if (await dispatch(event))
+        return { status: 200, body: { received: true } };
+    return { status: 500, body: { error: 'callback_failed' } };
+}
+/** The `(req, res)` handler around one delivery's answer. It never rejects: an unhandled rejection would end a plain Node server's process. */
+function nodeHandler(handleRaw, report) {
+    const handle = async (req, res) => {
+        let raw;
+        try {
+            raw = await readRawBody(req);
+        }
+        catch (error) {
+            if (error instanceof BodyTooLargeError)
+                return send(res, 413, { error: 'body_too_large' });
+            return send(res, 400, { error: 'unreadable_body' });
+        }
+        if (raw === undefined) {
+            report(new Error(RAW_BODY_GONE), undefined);
+            return send(res, 500, { error: 'raw_body_unavailable' });
+        }
+        const outcome = await handleRaw(raw, headerValue(req.headers['agentcard-signature']));
+        send(res, outcome.status, outcome.body);
+    };
+    return async (req, res) => {
+        try {
+            await handle(req, res);
+        }
+        catch (error) {
+            report(error, undefined);
+        }
+    };
+}
+/**
+ * The body of a web request, read chunk by chunk. Past the size cap it stops reading, cancels the
+ * stream and throws, so a caller with no signature cannot make the server hold a large body.
+ */
+async function readFetchBody(request) {
+    if (!request.body || typeof request.body.getReader !== 'function')
+        return new Uint8Array(await request.arrayBuffer());
+    const reader = request.body.getReader();
+    const chunks = [];
+    let size = 0;
+    for (;;) {
+        const { done, value } = await reader.read();
+        if (done)
+            break;
+        if (!value)
+            continue;
+        size += value.length;
+        if (size > MAX_BODY_BYTES) {
+            await reader.cancel().catch(() => { });
+            throw new BodyTooLargeError();
+        }
+        chunks.push(value);
+    }
+    const out = new Uint8Array(size);
+    let offset = 0;
+    for (const chunk of chunks) {
+        out.set(chunk, offset);
+        offset += chunk.length;
+    }
+    return out;
+}
+/** A web `Response` with a JSON body, built from the runtime's own `Response`. */
+function webResponse(outcome) {
+    return new Response(JSON.stringify(outcome.body), { status: outcome.status, headers: { 'content-type': 'application/json' } });
+}
+/** The web `Request` handler around one delivery's answer. It never rejects. */
+function fetchHandler(handleRaw, report) {
+    return async (request) => {
+        try {
+            const declared = Number(request.headers.get('content-length'));
+            if (Number.isFinite(declared) && declared > MAX_BODY_BYTES)
+                return webResponse({ status: 413, body: { error: 'body_too_large' } });
+            let raw;
+            try {
+                raw = await readFetchBody(request);
+            }
+            catch (error) {
+                if (error instanceof BodyTooLargeError)
+                    return webResponse({ status: 413, body: { error: 'body_too_large' } });
+                return webResponse({ status: 400, body: { error: 'unreadable_body' } });
+            }
+            if (raw.length > MAX_BODY_BYTES)
+                return webResponse({ status: 413, body: { error: 'body_too_large' } });
+            return webResponse(await handleRaw(raw, request.headers.get('agentcard-signature') ?? undefined));
+        }
+        catch (error) {
+            report(error, undefined);
+            return webResponse({ status: 500, body: { error: 'handler_failed' } });
+        }
+    };
+}
 /**
  * A `(req, res)` handler for your Agentcard webhook endpoint. A delivery with a
  * missing, malformed, stale or wrong signature gets a 400 and reaches no
@@ -103,28 +231,15 @@ async function readRawBody(req) {
  * callback is done: 200 when it returns, and 500 when it throws, so Agentcard
  * delivers the event again. Agentcard waits 10 seconds for an answer, so keep
  * the callback short. Agentcard delivers at least once, and again after a 500,
- * so handle each `message.eventId` once.
+ * so handle each `message.eventId` once. `agentcardWebhook` does that for you.
  */
 export function purchaseAgentWebhook(secret, onMessage, opts = {}) {
-    if (typeof secret !== 'string' || secret === '') {
-        throw new TypeError('Pass the webhook endpoint secret Agentcard returned when you created the endpoint.');
-    }
+    checkSecret(secret);
     if (typeof onMessage !== 'function') {
         throw new TypeError('Pass onMessage, the function that receives each purchase message.');
     }
     const verifyOpts = { toleranceSeconds: toleranceOf(opts) };
-    const report = (error, event) => {
-        try {
-            const reported = opts.onError ? opts.onError(error, event) : console.error('Agentcard webhook:', error);
-            // A reporter that rejects must not leave an unhandled rejection, which ends a plain Node server's process.
-            if (reported && typeof reported.then === 'function')
-                reported.then(undefined, () => { });
-        }
-        catch {
-            // A failing reporter must never take the process down with it.
-        }
-    };
-    /** Runs the callback for one verified event. True when the delivery is done, false when the callback threw. */
+    const report = reporter(opts.onError);
     const dispatch = async (event) => {
         let message;
         try {
@@ -147,44 +262,90 @@ export function purchaseAgentWebhook(secret, onMessage, opts = {}) {
             return false;
         }
     };
-    const handle = async (req, res) => {
-        let raw;
+    return nodeHandler((raw, signature) => answer(raw, signature, secret, verifyOpts, dispatch, report), report);
+}
+/** How many handled event ids the handler remembers, the oldest forgotten first. */
+const HANDLED_EVENTS_KEPT = 10_000;
+/**
+ * One handler for every Agentcard event your shoppers should hear about. It checks each delivery's
+ * signature, skips an event this process already handled, reads the message the event carries for
+ * a shopper
+ * (`readShopperMessage`), drops a message whose link or window has closed (`isStale`), and calls
+ * `onMessage` with your own id for the shopper and the message, Agentcard's own text included.
+ * Every other verified event goes to `onEvent`. The answer waits for the callback: 200 when it
+ * returns, 500 when it throws, and an event whose callback threw runs again on the next delivery.
+ * The handled events live in this process's memory: with more than one server, deduplicate on
+ * `message.eventId` in your own storage too.
+ */
+export function agentcardWebhook(opts) {
+    if (opts === null || typeof opts !== 'object')
+        throw new TypeError('Pass { secret, onMessage }.');
+    checkSecret(opts.secret);
+    if (typeof opts.onMessage !== 'function') {
+        throw new TypeError('Pass onMessage, the function that receives each message for a shopper.');
+    }
+    const secret = opts.secret;
+    const verifyOpts = { toleranceSeconds: toleranceOf(opts) };
+    const report = reporter(opts.onError);
+    // The events this process finished, and the ones it is running. A redelivery of a finished event
+    // runs nothing, and one that lands while the first delivery still runs waits for its answer.
+    const finished = new Set();
+    const running = new Map();
+    const finish = (eventId) => {
+        finished.add(eventId);
+        if (finished.size > HANDLED_EVENTS_KEPT)
+            finished.delete(finished.values().next().value);
+    };
+    /** Runs the callback for one event. True when the delivery is done, false when the callback threw. */
+    const run = async (event) => {
+        let message;
         try {
-            raw = await readRawBody(req);
+            message = readShopperMessage(event);
         }
         catch (error) {
-            if (error instanceof BodyTooLargeError)
-                return send(res, 413, { error: 'body_too_large' });
-            return send(res, 400, { error: 'unreadable_body' });
+            // A message the package cannot read reads the same way on every delivery, so it is not sent again.
+            report(error, event);
+            finish(event.id);
+            return true;
         }
-        if (raw === undefined) {
-            report(new Error(RAW_BODY_GONE), undefined);
-            return send(res, 500, { error: 'raw_body_unavailable' });
+        // A message whose link or window closed before it arrived reaches no callback, whichever one it would reach.
+        if (message && isStale(message)) {
+            finish(event.id);
+            return true;
         }
-        let event;
         try {
-            event = verifyAgentcardWebhook(raw, headerValue(req.headers['agentcard-signature']), secret, verifyOpts);
+            if (message?.externalUserId) {
+                await opts.onMessage(message.externalUserId, message, event);
+            }
+            else if (opts.onEvent) {
+                await opts.onEvent(event);
+            }
         }
         catch (error) {
-            if (error instanceof AgentcardSignatureError)
-                return send(res, 400, { error: 'invalid_signature', reason: error.reason });
-            if (error instanceof InvalidEventBodyError)
-                return send(res, 400, { error: 'invalid_body' });
-            report(error, undefined);
-            return send(res, 500, { error: 'verification_failed' });
+            // Not marked finished, so the next delivery of the event runs the callback again.
+            report(error, event);
+            return false;
         }
-        // The answer waits for the callback, so a callback that fails gets the event delivered again.
-        if (await dispatch(event))
-            return send(res, 200, { received: true });
-        return send(res, 500, { error: 'callback_failed' });
+        finish(event.id);
+        return true;
     };
-    // The handler never rejects: an unhandled rejection would end a plain Node server's process.
-    return async (req, res) => {
+    const dispatch = async (event) => {
+        if (finished.has(event.id))
+            return true;
+        const inFlight = running.get(event.id);
+        if (inFlight)
+            return inFlight;
+        const attempt = run(event);
+        running.set(event.id, attempt);
         try {
-            await handle(req, res);
+            return await attempt;
         }
-        catch (error) {
-            report(error, undefined);
+        finally {
+            running.delete(event.id);
         }
     };
+    const handleRaw = (raw, signature) => answer(raw, signature, secret, verifyOpts, dispatch, report);
+    const handler = nodeHandler(handleRaw, report);
+    handler.fetch = fetchHandler(handleRaw, report);
+    return handler;
 }

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 export { verifyAgentcardWebhook, AgentcardSignatureError, type AgentcardSignatureReason, type AgentcardEvent, type VerifyOptions, } from './verify.js';
 export { readPurchaseMessage, type PurchaseMessage, type PurchaseMessageKind, type PurchaseFacts, } from './message.js';
-export { purchaseAgentWebhook, type PurchaseAgentWebhookOptions, type WebhookRequest, type WebhookResponse, } from './handler.js';
-export { AgentcardClient, AgentcardApiError, BUY_TURN_TIMEOUT_MS, DEFAULT_BASE_URL, type AgentcardClientOptions, type FetchLike, type Shopper, type BuyRequest, type BuyDeliveryAddress, type BuyTurn, type BuyStatus, type BuyCart, type BuyCartLine, type BuyStore, type BuyCatalog, type BuyCatalogItem, type BuyPaymentSource, type BuyConversation, type BuyLastCheckout, type BuyOrder, type VaultLink, } from './client.js';
+export { readShopperMessage, isStale, SHOPPER_EVENT_TYPES, type ShopperMessage, type ShopperMessageKind, type ShopperFacts, type ShopperEventType, type OrderStatus, } from './shopper-message.js';
+export { agentcardWebhook, purchaseAgentWebhook, type AgentcardWebhookOptions, type AgentcardWebhookHandler, type PurchaseAgentWebhookOptions, type WebhookFetchRequest, type WebhookRequest, type WebhookResponse, } from './handler.js';
+export { AgentcardClient, AgentcardApiError, BUY_TURN_TIMEOUT_MS, DEFAULT_BASE_URL, type AgentcardClientOptions, type FetchLike, type Shopper, type BuyRequest, type BuyDeliveryAddress, type BuyTurn, type BuyStatus, type BuyCart, type BuyCartLine, type BuyStore, type BuyCatalog, type BuyCatalogItem, type BuyFlightItinerary, type BuyPaymentSource, type BuyConversation, type BuyLastCheckout, type BuyOrder, type VaultLink, type BuyNextAction, type BuyPick, } from './client.js';
 export { BUY_TOOL_NAME, BUY_TOOL_DESCRIPTION, buyToolDefinition, parseBuyToolInput, type BuyToolDefinition, type BuyToolInput, type BuyToolInputSchema, type BuyToolInputCheck, type BuyToolStandardSchema, type OpenAIBuyTool, } from './definition.js';
+export { toMessages, messageStream, type MessageStream, type MessageStreamOptions, } from './messages.js';
 export { buyTool, type BuyTool, type BuyToolOptions, type BuyToolResult, type BuyToolStatus, type BuyToolLink, type BuyToolProduct, } from './buy-tool.js';
+export { ackFor, type AckForOptions } from './ack.js';
 export { forModel, stripLinks, type BuyToolModelView, type BuyToolModelCart, type BuyToolModelProduct, } from './model-view.js';
 export { toAnthropicTool, toOpenRouterTool, type AnthropicBuyTool, type OpenRouterToolkit, type ZodLike, } from './adapters.js';

package/dist/index.js

@@ -1,8 +1,11 @@
 export { verifyAgentcardWebhook, AgentcardSignatureError, } from './verify.js';
 export { readPurchaseMessage, } from './message.js';
-export { purchaseAgentWebhook, } from './handler.js';
+export { readShopperMessage, isStale, SHOPPER_EVENT_TYPES, } from './shopper-message.js';
+export { agentcardWebhook, purchaseAgentWebhook, } from './handler.js';
 export { AgentcardClient, AgentcardApiError, BUY_TURN_TIMEOUT_MS, DEFAULT_BASE_URL, } from './client.js';
 export { BUY_TOOL_NAME, BUY_TOOL_DESCRIPTION, buyToolDefinition, parseBuyToolInput, } from './definition.js';
+export { toMessages, messageStream, } from './messages.js';
 export { buyTool, } from './buy-tool.js';
+export { ackFor } from './ack.js';
 export { forModel, stripLinks, } from './model-view.js';
 export { toAnthropicTool, toOpenRouterTool, } from './adapters.js';

package/dist/message.d.ts

@@ -9,13 +9,15 @@ import { type AgentcardEvent } from './verify.js';
  * - `order_placed`: the shopper approved, and Agentcard placed the order.
  * - `order_failed`: the order failed after the approval, and nothing more happens for that approval.
  * - `order_not_placed_yet`: the shopper approved, and the order is not placed yet.
+ * - `order_unconfirmed`: the store's reply to the order was lost, so the order may exist; Agentcard is confirming it.
  * - `approval_expiring`: the approval link expires soon; `text` carries the link.
  * - `approval_expired`: the approval expired before the shopper answered, and nothing was charged.
  * - `card_link_unfinished`: the shopper has not added a card from their card link; `text` carries the link again.
  * - `card_link_expired`: the card link expired before the shopper added a card.
  * - `cart_idle`: a cart sat without being sent for approval; `facts.nudgeNumber` counts the nudges.
+ * - `card_added`: the shopper saved a card from the card link your app sent, and can check out with it.
  */
-export type PurchaseMessageKind = 'order_placed' | 'order_failed' | 'order_not_placed_yet' | 'approval_expiring' | 'approval_expired' | 'card_link_unfinished' | 'card_link_expired' | 'cart_idle';
+export type PurchaseMessageKind = 'order_placed' | 'order_failed' | 'order_not_placed_yet' | 'order_unconfirmed' | 'approval_expiring' | 'approval_expired' | 'card_link_unfinished' | 'card_link_expired' | 'cart_idle' | 'card_added';
 /** The message's values one by one, for a company that writes its own copy. A fact that does not apply is absent. */
 export interface PurchaseFacts {
     merchantName?: string;

package/dist/messages.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Text cut into the messages a shopper reads one at a time. A chat app sends each paragraph as its
+ * own message, so a reply written as three paragraphs arrives as three texts. A blank line ends a
+ * paragraph, with two exceptions that keep a block whole: a fenced code block, and a list whose
+ * items a blank line separates.
+ */
+/**
+ * The text as separate messages, in order: one per paragraph, each trimmed, with empty ones left
+ * out. One or more blank lines end a paragraph. A fenced code block stays one message whatever blank
+ * lines it holds, and so does a list whose items blank lines separate.
+ *
+ * ```ts
+ * toMessages('Found two.\n\nWant the first one?'); // ['Found two.', 'Want the first one?']
+ * ```
+ */
+export declare function toMessages(text: string): string[];
+/** What `messageStream` hands back: push each piece of text as it arrives, then end once it stops. */
+export interface MessageStream {
+    /** Adds the next piece of text. Each message the piece completes goes to `onMessage` in order, after the one before it settled. */
+    push(delta: string): void;
+    /**
+     * The text is whole: the last message goes to `onMessage`. Resolves once every `onMessage` call
+     * settled, and rejects with the first error one threw or rejected with. A push after `end` throws.
+     */
+    end(): Promise<void>;
+}
+export interface MessageStreamOptions {
+    /**
+     * Hears each message, once and in order, as soon as the text after it ends it. A returned promise
+     * is awaited before the next message goes out, so an asynchronous send never delivers out of order.
+     * After a send fails, no later message is sent, and `end` rejects with the failure.
+     */
+    onMessage: (message: string) => void | Promise<void>;
+}
+/**
+ * Cuts streamed text into the messages `toMessages` finds, as it arrives. Each paragraph goes to
+ * `onMessage` the moment the blank line that ends it arrives, whatever the pieces split it into. A
+ * paragraph inside a list waits for the first characters of the line after the blank, which say
+ * whether the list goes on. `end` hands over the last message and waits for every send.
+ *
+ * ```ts
+ * const paragraphs = messageStream({ onMessage: (text) => sendToShopper(text) });
+ * stream.on('text', (delta) => paragraphs.push(delta));
+ * await stream.done();
+ * await paragraphs.end();
+ * ```
+ */
+export declare function messageStream(options: MessageStreamOptions): MessageStream;