@agent-cards/commerce-sdk 0.0.0-stage → 0.1.0

package/dist/definition.d.ts

@@ -0,0 +1,100 @@
+/**
+ * The buy tool as a model sees it: one name, one description, and a strict
+ * JSON Schema with three required fields. The delivery address and the
+ * shopper's id are construction options, never model inputs, so a model can
+ * neither change where an order goes nor buy for someone else.
+ */
+export declare const BUY_TOOL_NAME = "buy";
+/** What the model reads before it calls the tool. Every sentence is a rule the model follows. */
+export declare const BUY_TOOL_DESCRIPTION: string;
+/** What the model sends: all three fields, every time. */
+export interface BuyToolInput {
+    ask: string;
+    confirm: boolean;
+    new_order: boolean;
+}
+/** A type, not an interface, so it fits the SDKs' own input schema types, which take any key. */
+export type BuyToolInputSchema = {
+    type: 'object';
+    properties: {
+        ask: {
+            type: 'string';
+            description: string;
+        };
+        confirm: {
+            type: 'boolean';
+            description: string;
+        };
+        new_order: {
+            type: 'boolean';
+            description: string;
+        };
+    };
+    required: Array<keyof BuyToolInput>;
+    additionalProperties: false;
+};
+export interface BuyToolDefinition {
+    name: string;
+    description: string;
+    input_schema: BuyToolInputSchema;
+}
+/** A fresh copy of the tool's definition, so a caller that edits one never changes another. */
+export declare function buyToolDefinition(): BuyToolDefinition;
+/**
+ * The model's input, checked against the schema: an object, or its JSON text,
+ * with `ask` a string and `confirm` and `new_order` booleans, and nothing
+ * else. Throws a TypeError whose message tells the model what to send.
+ */
+export declare function parseBuyToolInput(value: unknown): BuyToolInput;
+/** The buy tool in OpenAI's function-calling format, which the OpenAI SDK, OpenRouter's chat API and most other model APIs take. */
+export interface OpenAIBuyTool {
+    type: 'function';
+    function: {
+        name: string;
+        description: string;
+        parameters: BuyToolInputSchema;
+        strict: true;
+    };
+}
+/** A fresh copy of the tool in OpenAI's function-calling format: plain JSON, so an SDK that sends it as is sends exactly this. */
+export declare function openAIBuyTool(): OpenAIBuyTool;
+/** What a Standard Schema check returns: the model's input, checked, or why it does not fit. */
+export type BuyToolInputCheck = {
+    readonly value: BuyToolInput;
+    readonly issues?: undefined;
+} | {
+    readonly issues: ReadonlyArray<{
+        readonly message: string;
+    }>;
+};
+/**
+ * The input schema as a Standard Schema that also hands over its JSON Schema,
+ * the form the Vercel AI SDK reads from a tool's `inputSchema`. The shape is
+ * the published Standard Schema one, so the package names no schema library.
+ */
+export interface BuyToolStandardSchema {
+    readonly '~standard': {
+        readonly version: 1;
+        readonly vendor: string;
+        readonly validate: (value: unknown) => BuyToolInputCheck;
+        readonly jsonSchema: {
+            readonly input: (options: {
+                readonly target: string;
+            }) => BuyToolInputSchema;
+            readonly output: (options: {
+                readonly target: string;
+            }) => BuyToolInputSchema;
+        };
+        /** Read by type inference only, never set. */
+        readonly types?: {
+            readonly input: BuyToolInput;
+            readonly output: BuyToolInput;
+        } | undefined;
+    };
+}
+/**
+ * The Standard Schema of the tool's input. `validate` checks the model's
+ * input as `parseBuyToolInput` does, and reports a refusal in the words
+ * `refusal` gives it, so the model reads what to send.
+ */
+export declare function buyToolStandardSchema(refusal: (error: unknown) => string): BuyToolStandardSchema;

package/dist/definition.js

@@ -0,0 +1,103 @@
+/**
+ * The buy tool as a model sees it: one name, one description, and a strict
+ * JSON Schema with three required fields. The delivery address and the
+ * shopper's id are construction options, never model inputs, so a model can
+ * neither change where an order goes nor buy for someone else.
+ */
+export const BUY_TOOL_NAME = 'buy';
+/** What the model reads before it calls the tool. Every sentence is a rule the model follows. */
+export const BUY_TOOL_DESCRIPTION = [
+    'Buy what this shopper asks for at real stores.',
+    "Put the shopper's own words in `ask`.",
+    'Tell the shopper what `reply` says, in your own voice.',
+    'Show the shopper the cart before you confirm it.',
+    'Set `confirm` to true only when the shopper just said yes to the cart in your last result, says they added the card for a cart that waits, says they approved, or asks for the approval link again.',
+    'Never write a link.',
+    'Each link reaches the shopper on its own.',
+    'When `link_sent` is true, tell the shopper a link is waiting for them.',
+    'Product links reach the shopper on their own, beside your reply: when `product_links_sent` is above zero and the shopper asks for links, tell them the links are there; never write or invent a URL.',
+    'A `placing` status means the order is going through, so never ask for another approval.',
+    'Tell the shopper they need not reply only when `shopper_need_not_reply` is true.',
+    'After `needs_card` with a cart, Agentcard keeps the cart, so set `confirm` to true once the shopper says they added the card.',
+    "After `needs_card` with no cart, call this tool again with the shopper's request once they say they added a card.",
+    'Set `new_order` to true only when the shopper drops the cart.',
+].join(' ');
+/** A fresh copy of the tool's definition, so a caller that edits one never changes another. */
+export function buyToolDefinition() {
+    return {
+        name: BUY_TOOL_NAME,
+        description: BUY_TOOL_DESCRIPTION,
+        input_schema: {
+            type: 'object',
+            properties: {
+                ask: { type: 'string', description: 'What the shopper said, in their own words.' },
+                confirm: {
+                    type: 'boolean',
+                    description: 'True only when the shopper just said yes to the cart in your last result, says they added the card for a cart that waits, says they approved, or asks for the approval link again. False otherwise.',
+                },
+                new_order: { type: 'boolean', description: 'True only when the shopper drops the cart to start a new order. False otherwise.' },
+            },
+            required: ['ask', 'confirm', 'new_order'],
+            additionalProperties: false,
+        },
+    };
+}
+const FIELDS = new Set(['ask', 'confirm', 'new_order']);
+/**
+ * The model's input, checked against the schema: an object, or its JSON text,
+ * with `ask` a string and `confirm` and `new_order` booleans, and nothing
+ * else. Throws a TypeError whose message tells the model what to send.
+ */
+export function parseBuyToolInput(value) {
+    let input = value;
+    if (typeof input === 'string') {
+        try {
+            input = JSON.parse(input);
+        }
+        catch {
+            throw new TypeError('The buy tool takes a JSON object with ask, confirm and new_order.');
+        }
+    }
+    if (typeof input !== 'object' || input === null || Array.isArray(input)) {
+        throw new TypeError('The buy tool takes an object with ask, confirm and new_order.');
+    }
+    const fields = input;
+    const extra = Object.keys(fields).find((key) => !FIELDS.has(key));
+    if (extra !== undefined)
+        throw new TypeError(`The buy tool takes only ask, confirm and new_order, and ${extra} is not one of them.`);
+    if (typeof fields.ask !== 'string')
+        throw new TypeError("Set ask to the shopper's words, as a string.");
+    if (typeof fields.confirm !== 'boolean')
+        throw new TypeError('Set confirm to true or false.');
+    if (typeof fields.new_order !== 'boolean')
+        throw new TypeError('Set new_order to true or false.');
+    return { ask: fields.ask, confirm: fields.confirm, new_order: fields.new_order };
+}
+/** A fresh copy of the tool in OpenAI's function-calling format: plain JSON, so an SDK that sends it as is sends exactly this. */
+export function openAIBuyTool() {
+    const { name, description, input_schema } = buyToolDefinition();
+    return { type: 'function', function: { name, description, parameters: input_schema, strict: true } };
+}
+/**
+ * The Standard Schema of the tool's input. `validate` checks the model's
+ * input as `parseBuyToolInput` does, and reports a refusal in the words
+ * `refusal` gives it, so the model reads what to send.
+ */
+export function buyToolStandardSchema(refusal) {
+    const schema = () => buyToolDefinition().input_schema;
+    return {
+        '~standard': {
+            version: 1,
+            vendor: 'agentcard',
+            validate: (value) => {
+                try {
+                    return { value: parseBuyToolInput(value) };
+                }
+                catch (error) {
+                    return { issues: [{ message: refusal(error) }] };
+                }
+            },
+            jsonSchema: { input: schema, output: schema },
+        },
+    };
+}

package/dist/handler.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+import { type AgentcardEvent, type VerifyOptions } from './verify.js';
+import { type PurchaseMessage } from './message.js';
+/** The parts of a Node or Express request the handler reads. */
+export interface WebhookRequest {
+    headers: Record<string, string | string[] | undefined>;
+    /** The bytes from `express.raw`, the text from `express.text`, or a body a JSON parser already parsed. */
+    body?: unknown;
+    /** The bytes a parser kept beside the parsed body: `express.json({ verify })`, NestJS and Firebase keep them here. */
+    rawBody?: unknown;
+    /** True once the request stream has been read to the end. */
+    readableEnded?: boolean;
+    on?(event: string, listener: (...args: any[]) => void): unknown;
+}
+/** The parts of a Node or Express response the handler writes. */
+export interface WebhookResponse {
+    statusCode: number;
+    setHeader(name: string, value: string): unknown;
+    end(body?: string): unknown;
+}
+export interface PurchaseAgentWebhookOptions extends Pick<VerifyOptions, 'toleranceSeconds'> {
+    /** Receives every verified event that is not a purchase message, such as `merchant.connected`. */
+    onEvent?: (event: AgentcardEvent) => void | Promise<void>;
+    /**
+     * Receives what went wrong: an error thrown by `onMessage` or `onEvent`, whose
+     * delivery then answers 500, a purchase message the package cannot read, or a
+     * request whose raw body was already gone. The event is undefined when no
+     * event was read. A reporter that throws or rejects is ignored. Default:
+     * `console.error`.
+     */
+    onError?: (error: unknown, event: AgentcardEvent | undefined) => void | Promise<void>;
+}
+/**
+ * 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
+ * callback. A verified delivery runs `onMessage` for a purchase message, or
+ * `opts.onEvent` for any other event, and the handler answers when the
+ * 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.
+ */
+export declare function purchaseAgentWebhook(secret: string, onMessage: (message: PurchaseMessage, event: AgentcardEvent) => void | Promise<void>, opts?: PurchaseAgentWebhookOptions): (req: WebhookRequest, res: WebhookResponse) => Promise<void>;

package/dist/handler.js

@@ -0,0 +1,190 @@
+/**
+ * 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.
+ */
+import { AgentcardSignatureError, InvalidEventBodyError, toleranceOf, verifyAgentcardWebhook, } from './verify.js';
+import { readPurchaseMessage } from './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. ' +
+    "Mount the route with express.raw({ type: 'application/json' }) before any express.json(), or keep the bytes with " +
+    'express.json({ verify: (req, _res, buf) => { Object.assign(req, { rawBody: buf }); } }).';
+class BodyTooLargeError extends Error {
+}
+function send(res, status, body) {
+    res.statusCode = status;
+    res.setHeader('content-type', 'application/json');
+    res.end(JSON.stringify(body));
+}
+function headerValue(value) {
+    return Array.isArray(value) ? value.join(',') : value;
+}
+function toBytes(chunk) {
+    if (chunk instanceof Uint8Array)
+        return chunk;
+    if (typeof chunk === 'string')
+        return new TextEncoder().encode(chunk);
+    throw new TypeError('The request stream yielded something other than bytes.');
+}
+/** Reads the request stream to its end. Past the size cap it keeps draining and keeps nothing. */
+function readStream(req) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        let size = 0;
+        let tooLarge = false;
+        let failed;
+        req.on('data', (chunk) => {
+            if (tooLarge || failed !== undefined)
+                return;
+            try {
+                const bytes = toBytes(chunk);
+                size += bytes.length;
+                if (size > MAX_BODY_BYTES) {
+                    tooLarge = true;
+                    chunks.length = 0;
+                    return;
+                }
+                chunks.push(bytes);
+            }
+            catch (err) {
+                failed = err;
+            }
+        });
+        req.on('end', () => {
+            if (failed !== undefined)
+                return reject(failed);
+            if (tooLarge)
+                return reject(new BodyTooLargeError());
+            const out = new Uint8Array(size);
+            let offset = 0;
+            for (const chunk of chunks) {
+                out.set(chunk, offset);
+                offset += chunk.length;
+            }
+            resolve(out);
+        });
+        req.on('error', reject);
+        // A client that disconnects mid-body ends the read; after 'end' this reject is a no-op.
+        req.on('close', () => reject(new Error('The request closed before its body ended.')));
+    });
+}
+function savedBody(req) {
+    if (typeof req.rawBody === 'string' || req.rawBody instanceof Uint8Array)
+        return req.rawBody;
+    if (typeof req.body === 'string' || req.body instanceof Uint8Array)
+        return req.body;
+    return undefined;
+}
+/**
+ * The raw body, wherever it is: bytes a parser kept, bytes or text from a raw
+ * or text parser, or the unread stream. Undefined when a JSON parser already
+ * consumed the stream and kept no bytes. Every source is held to the same
+ * size cap, text counted in UTF-8 bytes.
+ */
+async function readRawBody(req) {
+    const saved = savedBody(req);
+    if (saved !== undefined) {
+        const size = typeof saved === 'string' ? new TextEncoder().encode(saved).length : saved.length;
+        if (size > MAX_BODY_BYTES)
+            throw new BodyTooLargeError();
+        return saved;
+    }
+    if (req.readableEnded === true || typeof req.on !== 'function')
+        return undefined;
+    return readStream(req);
+}
+/**
+ * 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
+ * callback. A verified delivery runs `onMessage` for a purchase message, or
+ * `opts.onEvent` for any other event, and the handler answers when the
+ * 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.
+ */
+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.');
+    }
+    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 dispatch = async (event) => {
+        let message;
+        try {
+            message = readPurchaseMessage(event);
+        }
+        catch (error) {
+            // A purchase message the package cannot read reads the same way on every delivery, so it is not sent again.
+            report(error, event);
+            return true;
+        }
+        try {
+            if (message)
+                await onMessage(message, event);
+            else if (opts.onEvent)
+                await opts.onEvent(event);
+            return true;
+        }
+        catch (error) {
+            report(error, event);
+            return false;
+        }
+    };
+    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' });
+        }
+        let event;
+        try {
+            event = verifyAgentcardWebhook(raw, headerValue(req.headers['agentcard-signature']), secret, verifyOpts);
+        }
+        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' });
+        }
+        // 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' });
+    };
+    // The handler never rejects: an unhandled rejection would end a plain Node server's process.
+    return async (req, res) => {
+        try {
+            await handle(req, res);
+        }
+        catch (error) {
+            report(error, undefined);
+        }
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+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 { BUY_TOOL_NAME, BUY_TOOL_DESCRIPTION, buyToolDefinition, parseBuyToolInput, type BuyToolDefinition, type BuyToolInput, type BuyToolInputSchema, type BuyToolInputCheck, type BuyToolStandardSchema, type OpenAIBuyTool, } from './definition.js';
+export { buyTool, type BuyTool, type BuyToolOptions, type BuyToolResult, type BuyToolStatus, type BuyToolLink, type BuyToolProduct, } from './buy-tool.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

@@ -0,0 +1,8 @@
+export { verifyAgentcardWebhook, AgentcardSignatureError, } from './verify.js';
+export { readPurchaseMessage, } from './message.js';
+export { 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 { buyTool, } from './buy-tool.js';
+export { forModel, stripLinks, } from './model-view.js';
+export { toAnthropicTool, toOpenRouterTool, } from './adapters.js';

package/dist/message.d.ts

@@ -0,0 +1,78 @@
+/**
+ * `purchase.message`: one event type for every moment of a purchase that a
+ * shopper should hear about. Each message carries the text to send as is, a
+ * note for the company's agent, and the same values as facts.
+ */
+import { type AgentcardEvent } from './verify.js';
+/**
+ * The moment a message is about:
+ * - `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.
+ * - `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.
+ */
+export type PurchaseMessageKind = 'order_placed' | 'order_failed' | 'order_not_placed_yet' | 'approval_expiring' | 'approval_expired' | 'card_link_unfinished' | 'card_link_expired' | 'cart_idle';
+/** 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;
+    /** The total in the currency's minor unit: 2306 is $23.06. */
+    totalCents?: number;
+    /** The three-letter currency code. */
+    currency?: string;
+    cardBrand?: string;
+    cardLast4?: string;
+    orderId?: string;
+    /** Why an order failed or was not placed, in words. */
+    reason?: string;
+    approvalUrl?: string;
+    /** When the approval link stops working, as an ISO 8601 timestamp. */
+    approvalExpiresAt?: string;
+    cardLinkUrl?: string;
+    /** Until when the order is retried, as an ISO 8601 timestamp. */
+    retryUntil?: string;
+    /**
+     * Until when the message holds, as an ISO 8601 timestamp: the expiry of any link or window its text
+     * names. Absent when the message stays true. A message read after it is stale: drop it.
+     */
+    validUntil?: string;
+    /** 1 for a cart's first nudge, 2 for its second. */
+    nudgeNumber?: number;
+}
+/** A `purchase.message` event, read. */
+export interface PurchaseMessage {
+    /** The event id. Agentcard delivers at least once: handle each id once. */
+    eventId: string;
+    /**
+     * The moment the message is about: one of the kinds above, or a kind Agentcard adds later,
+     * read as its own name. Give a `switch` over it a default branch that sends `text`.
+     */
+    kind: PurchaseMessageKind | (string & {});
+    /** The shopper's Agentcard user id. */
+    userId: string;
+    /** Your own id for the shopper, when you gave Agentcard one. */
+    externalUserId: string | null;
+    /** Ready to send to the shopper as is. */
+    text: string;
+    /**
+     * For your agent: the facts of what happened, marked as written by the system and not typed by
+     * the shopper. Empty when the message carries no note; send `text` then.
+     */
+    note: string;
+    facts: PurchaseFacts;
+    /** The OAuth client id of the app the shopper connected through. */
+    clientId: string | null;
+    /** False for a sandbox event. */
+    livemode: boolean;
+    /** Unix seconds. */
+    created: number;
+}
+/**
+ * The message a `purchase.message` event carries, or null for any other event
+ * type. Pass the event `verifyAgentcardWebhook` returned. Throws a TypeError
+ * when a purchase message lacks its kind, user_id or text.
+ */
+export declare function readPurchaseMessage(event: AgentcardEvent): PurchaseMessage | null;

package/dist/message.js

@@ -0,0 +1,76 @@
+/**
+ * `purchase.message`: one event type for every moment of a purchase that a
+ * shopper should hear about. Each message carries the text to send as is, a
+ * note for the company's agent, and the same values as facts.
+ */
+import { isRecord } from './verify.js';
+/** The event type every purchase message arrives as. */
+const PURCHASE_MESSAGE_EVENT = 'purchase.message';
+const STRING_FACTS = [
+    ['merchant_name', 'merchantName'],
+    ['currency', 'currency'],
+    ['card_brand', 'cardBrand'],
+    ['card_last4', 'cardLast4'],
+    ['order_id', 'orderId'],
+    ['reason', 'reason'],
+    ['approval_url', 'approvalUrl'],
+    ['approval_expires_at', 'approvalExpiresAt'],
+    ['card_link_url', 'cardLinkUrl'],
+    ['retry_until', 'retryUntil'],
+    ['valid_until', 'validUntil'],
+];
+const NUMBER_FACTS = [
+    ['total_cents', 'totalCents'],
+    ['nudge_number', 'nudgeNumber'],
+];
+function readFacts(raw) {
+    const facts = {};
+    if (!isRecord(raw))
+        return facts;
+    for (const [wire, name] of STRING_FACTS) {
+        const value = raw[wire];
+        if (typeof value === 'string' && value !== '')
+            facts[name] = value;
+    }
+    for (const [wire, name] of NUMBER_FACTS) {
+        const value = raw[wire];
+        if (typeof value === 'number' && Number.isFinite(value))
+            facts[name] = value;
+    }
+    return facts;
+}
+function requiredString(data, field) {
+    const value = data[field];
+    if (typeof value !== 'string' || value === '') {
+        throw new TypeError(`The purchase.message event has no ${field}. Every purchase message carries kind, user_id and text.`);
+    }
+    return value;
+}
+/**
+ * The message a `purchase.message` event carries, or null for any other event
+ * type. Pass the event `verifyAgentcardWebhook` returned. Throws a TypeError
+ * when a purchase message lacks its kind, user_id or text.
+ */
+export function readPurchaseMessage(event) {
+    if (event.type !== PURCHASE_MESSAGE_EVENT)
+        return null;
+    const data = event.data;
+    const kind = requiredString(data, 'kind');
+    const userId = requiredString(data, 'user_id');
+    const text = requiredString(data, 'text');
+    // Without a note, the text alone still tells the shopper what happened.
+    const note = typeof data.note === 'string' ? data.note : '';
+    const connection = isRecord(data.connection) ? data.connection : {};
+    return {
+        eventId: event.id,
+        kind,
+        userId,
+        externalUserId: typeof data.external_user_id === 'string' && data.external_user_id !== '' ? data.external_user_id : null,
+        text,
+        note,
+        facts: readFacts(data.facts),
+        clientId: typeof connection.client_id === 'string' && connection.client_id !== '' ? connection.client_id : null,
+        livemode: event.livemode,
+        created: event.created,
+    };
+}