@cosmoops/connect-sdk 0.32.0 → 0.33.0

package/dist/esm/server/handler.js

@@ -96,6 +96,24 @@ function redirect(location, cookies = []) {
  * workspace it is not signed into, and a client-supplied `workspaceId`
  * is exactly that hole.
  */
+/**
+ * The visitor's own address, for Connect's per-visitor limiter.
+ *
+ * **Left-most `x-forwarded-for` entry**, which is the same precedence Connect's
+ * own `/api/book` and `/api/auth/session` use, and the same caveat applies: the
+ * left-most entry is the client as the first proxy saw it, and a client can
+ * prepend to that header. That makes it unsuitable for authorization and fine
+ * for this - it partitions your application's own budget between visitors, and
+ * the ceilings that actually cap spending are per key and per application.
+ *
+ * `null` where nothing forwarded one - a local dev server, or a platform that
+ * does not set it. Connect then counts every visitor in one shared bucket,
+ * which is a stricter limit rather than an exemption.
+ */
+function visitorIpOf(request) {
+    const forwarded = request.headers.get("x-forwarded-for")?.split(",")[0]?.trim();
+    return forwarded || request.headers.get("x-real-ip") || null;
+}
 export function createConnectHandler(options) {
     const basePath = (options.basePath ?? "/api/connect").replace(/\/+$/, "");
     const { client, session } = options;
@@ -327,6 +345,130 @@ export function createConnectHandler(options) {
             return json({ readiness, subscription });
         },
         "GET /plans": async () => json(await client.billing.listPlans()),
+        /* ---------------------------------------------------------------------- */
+        /* The visitor assistant - the only routes here with no session at all     */
+        /* ---------------------------------------------------------------------- */
+        /**
+         * `POST /visitor/session`, `/visitor/chat`, `/visitor/book`.
+         *
+         * Three routes that take **no session**, which makes them the exception to
+         * the rule every other route here follows. That is not a hole: the caller
+         * is a stranger on a public page, and there is no account for a session to
+         * identify. The question "whose data is this" has a different answer here -
+         * it is the *application's*, and the application is the one thing this
+         * bridge does hold a credential for.
+         *
+         * So the scoping that `requireWorkspace` provides elsewhere is provided
+         * here by Connect's own configuration: the workspace a call books into and
+         * the knowledge it answers from come from the application record, and no
+         * field in any of these bodies names a tenant. A browser cannot widen that
+         * by asking, because there is nothing to ask with.
+         *
+         * **`GET /company-profile` is the precedent and the limit of it.** That one
+         * is unauthenticated because the answer is identical for every caller.
+         * These are unauthenticated because the *caller* has no identity - but the
+         * answer is still per application, and spending is still per application.
+         * Which is why they are the only routes here that pass the visitor's own
+         * address along: the limiters on the far side count a visitor, and this
+         * bridge is the only thing that knows which one.
+         */
+        "POST /visitor/session": async (request) => {
+            const body = (await request.json().catch(() => null));
+            /*
+             * **The workspace is the browser's claim here, and that is the one thing
+             * this bridge must not simply relay.** Every other route on this bridge
+             * resolves the tenant from the caller's session; a visitor has none, so
+             * the widget names the customer whose site it is on - and a page can name
+             * any of them.
+             *
+             * Connect checks the workspace against your subscriptions, so the worst
+             * case is bounded to *your own* customers rather than the platform's. That
+             * is still one customer's budget spent from another's page, so an
+             * application serving several customers should resolve the workspace from
+             * its own widget record - by the embed token in the snippet, say - rather
+             * than trusting this field. The SDK cannot do that for you: it does not
+             * know what your widgets are keyed by.
+             */
+            if (typeof body?.workspaceId !== "string") {
+                throw new ConnectError({
+                    status: 400,
+                    code: "validation_error",
+                    message: "workspaceId is required",
+                    endpoint: "POST /visitor/session",
+                });
+            }
+            return json(await client.visitor.startSession({
+                workspaceId: body.workspaceId,
+                page: typeof body.page === "string" ? body.page : null,
+                resume: typeof body.resume === "string" ? body.resume : null,
+            }, { visitorIp: visitorIpOf(request) }));
+        },
+        "POST /visitor/chat": async (request) => {
+            const body = (await request.json().catch(() => null));
+            if (typeof body?.sessionId !== "string" ||
+                typeof body?.workspaceId !== "string" ||
+                typeof body?.message !== "string") {
+                throw new ConnectError({
+                    status: 400,
+                    code: "validation_error",
+                    message: "sessionId, workspaceId and message are required",
+                    endpoint: "POST /visitor/chat",
+                });
+            }
+            const upstream = await client.visitor.chat({
+                sessionId: body.sessionId,
+                workspaceId: body.workspaceId,
+                message: body.message,
+                ...(typeof body.assistantName === "string"
+                    ? { assistantName: body.assistantName }
+                    : {}),
+                ...(typeof body.bookingEventTypeSlug === "string"
+                    ? { bookingEventTypeSlug: body.bookingEventTypeSlug }
+                    : {}),
+            }, { visitorIp: visitorIpOf(request) });
+            /*
+             * Piped, never buffered - awaiting the body would collect the whole reply
+             * server-side and deliver it in one lump, which is the only thing
+             * streaming was for. The browser hanging up propagates down this pipe and
+             * stops generation upstream, which on this surface also stops the
+             * spending.
+             */
+            return new Response(upstream.body, {
+                status: upstream.status,
+                headers: {
+                    "content-type": upstream.headers.get("content-type") ?? "text/event-stream",
+                    "cache-control": "no-store",
+                    // Without this a proxy in front of your app may buffer the whole
+                    // stream to inspect it, which undoes the streaming end to end.
+                    "x-accel-buffering": "no",
+                    "x-content-type-options": "nosniff",
+                },
+            });
+        },
+        "POST /visitor/book": async (request) => {
+            const body = (await request.json().catch(() => null));
+            if (typeof body?.sessionId !== "string" ||
+                typeof body?.workspaceId !== "string" ||
+                typeof body?.eventTypeSlug !== "string" ||
+                typeof body?.startAt !== "string") {
+                throw new ConnectError({
+                    status: 400,
+                    code: "validation_error",
+                    message: "sessionId, workspaceId, eventTypeSlug and startAt are required",
+                    endpoint: "POST /visitor/book",
+                });
+            }
+            return json(await client.visitor.book({
+                sessionId: body.sessionId,
+                workspaceId: body.workspaceId,
+                eventTypeSlug: body.eventTypeSlug,
+                startAt: body.startAt,
+                name: typeof body.name === "string" ? body.name : "",
+                phone: typeof body.phone === "string" ? body.phone : "",
+                email: typeof body.email === "string" ? body.email : null,
+                notes: typeof body.notes === "string" ? body.notes : null,
+            }, { visitorIp: visitorIpOf(request) }));
+        },
         /**
          * The platform's legal identity and grievance channel.
          *

package/dist/esm/server/resources/ai.js

@@ -139,4 +139,54 @@ export class AiResource {
         });
         return result.data;
     }
+    /**
+     * How ready the site at a domain is for AI agents.
+     *
+     * Probes for an MCP server, an OpenAPI description, `llms.txt`, structured
+     * data and a markdown twin; evaluates the site's `robots.txt` against the
+     * assistants that actually fetch pages; checks whether its content survives
+     * without JavaScript and whether a bot wall refuses agents outright. Then
+     * grades what it found and says what to fix first.
+     *
+     * Needs an API key scoped to **`ai:readiness`**, which is separate from every
+     * other AI scope because it is the widest outbound surface on the API - it
+     * POSTs to candidate MCP endpoints and fetches the home page under two user
+     * agents.
+     *
+     * ```ts
+     * const result = await connect.ai.readiness({ domain: "acme.com" });
+     * if (result.status === "assessed") {
+     *   console.log(result.report.grade, result.report.topFix?.fix);
+     * }
+     * ```
+     *
+     * Four things to know before wiring it in:
+     *
+     * - **Set your client timeout to at least 90 seconds.** A cold assessment
+     *   runs the whole probe before answering and can take up to a minute; many
+     *   HTTP clients default to 30s and abandon a request that was about to
+     *   succeed. Cached reads return in milliseconds and are the normal case -
+     *   reports are held for a week.
+     * - **A week, not ninety days**, because a report is a to-do list somebody is
+     *   working through. Pass `refresh` after shipping a fix to see it land.
+     * - **Handle `status: "error"` checks as unknown, not as failures.** They mean
+     *   Connect could not measure that check, and they are excluded from the
+     *   score rather than counted against it.
+     * - **`skipped` says whose problem it is.** `unreachable` means the site did
+     *   not answer; `provider_unavailable` means Connect's own assessment service
+     *   did. Only the second is worth retrying silently, and neither should be
+     *   shown as a failing grade.
+     */
+    readiness(input, options = {}) {
+        return request(this.transport, {
+            method: "POST",
+            path: "/ai/readiness",
+            json: {
+                domain: input.domain,
+                ...(input.refresh ? { refresh: true } : {}),
+            },
+            headers: actingAs(input.asUser),
+            signal: options.signal,
+        });
+    }
 }

package/dist/esm/server/resources/enrichment.js

@@ -97,4 +97,63 @@ export class EnrichmentResource {
             signal: options.signal,
         });
     }
+    /**
+     * How **visible** the business at a domain is online, scored out of 100.
+     *
+     * The third sibling of `company()` and `brand()`: that one answers what a
+     * business does, the other what it looks like, and this one answers how
+     * findable it is - by a search engine, by a customer, and by the assistants
+     * that increasingly answer questions about a business before anybody visits
+     * its site.
+     *
+     * Needs an API key scoped to **`enrichment:presence`** - separate from
+     * `enrichment:read` and `enrichment:brand` because it is the widest outbound
+     * read of the three: roughly twenty fetches across the site's well-known
+     * paths, and sometimes a headless browser.
+     *
+     * ```ts
+     * const result = await connect.enrichment.presence({ domain: "acme.com" });
+     * if (result.status === "scanned") {
+     *   for (const next of result.scan.recommendations) {
+     *     console.log(`${next.priority}. ${next.title} - ${next.fix}`);
+     *   }
+     * }
+     * ```
+     *
+     * Four things to know before wiring it in:
+     *
+     * - **The score is computed, not generated.** Every point comes from a check
+     *   run against something actually observed, and every check ships with its
+     *   weight, what was seen and the URL that settles it - so the total is
+     *   reconstructable. A model only orders `recommendations` and writes the
+     *   prose; it cannot move the number. That is the whole reason this is worth
+     *   showing a customer: ask a model how good a company's web presence is and
+     *   it answers 72 with total confidence for a site it never read.
+     * - **`social` is claimed, never verified.** Those are URLs the site itself
+     *   printed. Nothing proves the account belongs to that business - render it
+     *   as "linked from their site". Check `machineReadable` too: `false` means
+     *   a real profile that search engines have to infer from a footer link,
+     *   which is a specific, common and easily fixed finding.
+     * - **A low score is a success, not a skip.** Every check failing is the most
+     *   useful report this produces. Only `unreachable` means the site did not
+     *   answer - and `provider_unavailable` means *Connect* did not, which is
+     *   never something to tell your user about their own site.
+     * - **Set your client timeout to at least 90 seconds.** A cold scan runs the
+     *   whole probe before answering; many HTTP clients default to 30s and
+     *   abandon a request that was about to succeed. Cached scans return in
+     *   milliseconds, and cached is the normal case - results are held for a
+     *   fortnight, so you pay the cold path roughly once per domain.
+     */
+    presence(input, options = {}) {
+        return request(this.transport, {
+            method: "POST",
+            path: "/enrichment/presence",
+            json: {
+                domain: input.domain,
+                ...(input.refresh ? { refresh: true } : {}),
+            },
+            headers: actingAs(input.asUser),
+            signal: options.signal,
+        });
+    }
 }

package/dist/esm/server/resources/visitor.js

@@ -0,0 +1,222 @@
+import { request } from "../http.js";
+/**
+ * The header a bridge forwards the visitor's own address on.
+ *
+ * It exists because `x-forwarded-for` cannot do this job here: by the time your
+ * backend calls Connect, that header describes the hop from *your server*, and
+ * the address Connect's per-visitor limiter needs is the one on the hop before
+ * it - which only your bridge has seen.
+ *
+ * **What it is and is not trusted for.** It partitions your own application's
+ * budget fairly between visitors; it does not grant anything. A caller sending a
+ * fresh value per request defeats only the per-visitor limiter and is still
+ * bounded by the per-key burst limit and the per-application daily ceiling -
+ * which are the two that actually cap spending, and neither is client-supplied.
+ * Omit it and every visitor shares one bucket, which is a stricter limit rather
+ * than an exemption.
+ */
+const VISITOR_IP_HEADER = "x-connect-visitor-ip";
+function visitorHeaders(options) {
+    return options?.visitorIp ? { [VISITOR_IP_HEADER]: options.visitorIp } : {};
+}
+/**
+ * The public chat bubble on your own marketing site.
+ *
+ * The one resource here whose caller is **not** one of your users. There is no
+ * `asUser`, no `workspaceId` and no session anywhere in it: the counterpart is a
+ * stranger who has no account, and everything the assistant may say or do is
+ * configuration a platform admin set on your application record.
+ *
+ * That is why none of these methods takes an id naming anything. The workspace a
+ * call books into, the event type it books, the knowledge it answers from and the
+ * daily budget it spends are all read from your application - so nothing a
+ * visitor types, and nothing an injection attempt in your own chat window
+ * achieves, reaches a different tenant.
+ *
+ * **Never call these from a browser.** They take your API key, like every other
+ * resource on this client. `createConnectHandler` already exposes them on your
+ * own origin for `<ConnectVisitorChat>` to use, which is how the credential stays
+ * server-side.
+ */
+export class VisitorResource {
+    transport;
+    /**
+     * The knowledge base behind the assistant - see `VisitorKnowledgeResource`.
+     *
+     * Nested rather than a top-level resource, because it is meaningless on its
+     * own: it exists to decide what *this* assistant may say.
+     */
+    knowledge;
+    constructor(transport) {
+        this.transport = transport;
+        this.knowledge = new VisitorKnowledgeResource(transport);
+    }
+    /**
+     * Open a conversation, or reopen one.
+     *
+     * Generates nothing - the greeting and the suggested questions come off the
+     * application record - so this is the one call in the flow that is always fast,
+     * which is what lets a bubble paint real copy instead of a spinner.
+     *
+     * Pass `resume` with a `sessionId` you kept and the transcript comes back with
+     * it. A `resume` that is expired, unknown or another application's silently
+     * starts a fresh conversation rather than failing: the token is the only thing
+     * being offered and it is being rejected, so there is nothing for the visitor
+     * to do about an error.
+     */
+    startSession(input, options = {}) {
+        return request(this.transport, {
+            method: "POST",
+            path: "/visitor/session",
+            json: {
+                workspaceId: input.workspaceId,
+                page: input.page ?? null,
+                resume: input.resume ?? null,
+            },
+            headers: visitorHeaders(options),
+            signal: options.signal,
+        });
+    }
+    /**
+     * One turn, streamed.
+     *
+     * Returns the raw `Response` rather than a parsed body, the same way
+     * `ai.chat` does: this answers server-sent events, and buffering them here
+     * would throw away the only reason to stream. The events are `delta`
+     * (`{text}`), `done` (`VisitorTurnDone`) and `error` (`{message}`).
+     *
+     * **The transcript is not a parameter**, which is the security property this
+     * endpoint is built around: the caller is ultimately a browser on a public
+     * page, and a client that can supply its own transcript can supply one in
+     * which anything has already been established. Only the conversation id and
+     * the new message travel.
+     */
+    chat(input, options = {}) {
+        return request(this.transport, {
+            method: "POST",
+            path: "/visitor/chat",
+            json: input,
+            headers: visitorHeaders(options),
+            raw: true,
+            signal: options.signal,
+        });
+    }
+    /**
+     * Book the call a visitor chose.
+     *
+     * `startAt` must be a time the turn's own slot lookup returned - an arbitrary
+     * instant is refused. That, plus a name and phone collected in real fields,
+     * is what makes it impossible to book an appointment at a time nobody offered
+     * or with a phone number a model parsed out of prose.
+     *
+     * A conversation books at most one appointment; a second call answers `409`.
+     */
+    book(input, options = {}) {
+        return request(this.transport, {
+            method: "POST",
+            path: "/visitor/book",
+            headers: visitorHeaders(options),
+            signal: options.signal,
+            json: {
+                ...input,
+                startAt: input.startAt instanceof Date ? input.startAt.toISOString() : input.startAt,
+                email: input.email ?? null,
+                notes: input.notes ?? null,
+            },
+        });
+    }
+}
+/**
+ * A subscribing workspace's **public** knowledge base - what their website chat
+ * may tell strangers.
+ *
+ * ## It is deliberately not their Context Index
+ *
+ * `ai.chat` answers from a workspace's Drive-fed corpus, for a signed-in member
+ * of that workspace. This is a separate store that holds only what somebody
+ * explicitly published, and the separation is the reason a publishable widget
+ * credential is safe to publish: everything the widget can reach was already
+ * meant for the public.
+ *
+ * Do not try to fill it by uploading to Drive. Nothing reaches this store as a
+ * side effect of anything else - that is the invariant, not an inconvenience.
+ *
+ * ## Publishing is its own call
+ *
+ * `save` always writes a draft. `publish` is what makes text readable by
+ * strangers, so no edit can do it by accident, and `unpublish` can fail - which
+ * means the item is **still live**, not that the call was pointless.
+ */
+export class VisitorKnowledgeResource {
+    transport;
+    constructor(transport) {
+        this.transport = transport;
+    }
+    /** Everything, drafts included - the list a customer audits. */
+    list(workspaceId) {
+        return request(this.transport, {
+            method: "GET",
+            path: "/visitor/knowledge",
+            query: { workspaceId },
+        });
+    }
+    /**
+     * Create or edit a draft.
+     *
+     * A body over the cap is **refused rather than truncated** - split a long page
+     * into sections, which is also what makes retrieval work.
+     */
+    async save(input) {
+        const result = await request(this.transport, {
+            method: "POST",
+            path: "/visitor/knowledge",
+            json: {
+                ...input,
+                itemId: input.itemId ?? null,
+                sourceRef: input.sourceRef ?? null,
+            },
+        });
+        return result.item;
+    }
+    /**
+     * Make one item readable by strangers.
+     *
+     * May be slow: the publish that outgrows the prompt provisions a retrieval
+     * corpus and indexes everything published so far. An indexing failure still
+     * publishes and comes back with `indexState: "failed"` and `indexError` set,
+     * so a provider hiccup never makes your button look broken.
+     */
+    async publish(input) {
+        const result = await request(this.transport, {
+            method: "POST",
+            path: "/visitor/knowledge/publish",
+            json: input,
+        });
+        return result.item;
+    }
+    /**
+     * Take one item out of what strangers can read.
+     *
+     * **A failure means it is still live.** The retrievable copy is removed before
+     * the record is flipped, so a provider that refuses the delete aborts rather
+     * than leaving an item your screen shows as withdrawn that the widget goes on
+     * quoting. Surface the error and let them retry; do not grey the row out
+     * optimistically.
+     */
+    async unpublish(input) {
+        const result = await request(this.transport, {
+            method: "POST",
+            path: "/visitor/knowledge/unpublish",
+            json: input,
+        });
+        return result.item;
+    }
+    /** Remove it entirely. A published item is unpublished first. */
+    async delete(input) {
+        await request(this.transport, {
+            method: "POST",
+            path: "/visitor/knowledge/delete",
+            json: input,
+        });
+    }
+}

package/dist/types/client/components/visitor-chat.d.ts

@@ -0,0 +1,120 @@
+export interface ConnectVisitorChatProps {
+    /**
+     * The customer whose website this widget is on.
+     *
+     * Required, and it is the one field that decides whose published knowledge the
+     * assistant answers from and whose diary it books into. Your bridge checks it
+     * against your own subscriptions before it reaches Connect.
+     */
+    workspaceId: string;
+    /**
+     * What the assistant calls itself, and the copy shown before anybody types.
+     *
+     * **Yours, not Connect's.** These never reach the model and are rendered from
+     * your own store, which is what lets the bubble paint its first frame with no
+     * network call at all. Connect holds what it enforces; you hold what you draw.
+     */
+    assistantName?: string;
+    greeting?: string;
+    /** Opening questions offered as buttons. Three is what fits above a phone keyboard. */
+    suggestions?: readonly string[];
+    /** A published event type slug in that workspace, to offer a call. Omit for no booking. */
+    bookingEventTypeSlug?: string | null;
+    /**
+     * Where `createConnectHandler` is mounted. Defaults to `/api/connect`, which
+     * is its own default.
+     *
+     * Passed explicitly here, rather than only inherited from `ConnectProvider`,
+     * because this component is built to work on a page that has no provider -
+     * see the component's own note.
+     */
+    basePath?: string;
+    /**
+     * The page the visitor is on, passed to Connect as context.
+     *
+     * Left unset it uses `location.pathname`. Pass something more meaningful - a
+     * page title, a product slug - where the path is not descriptive.
+     */
+    page?: string;
+    /** The bubble's accessible label, and the panel's heading. */
+    title?: string;
+    /** Start open. The panel owns its state after that. */
+    defaultOpen?: boolean;
+    /**
+     * Show the bubble even to a signed-in user. Off by default.
+     *
+     * The default is the useful one: a signed-in member has your product's own
+     * support surfaces and, if you mount it, `<ConnectAskAi>` - which is grounded
+     * in their actual workspace and can therefore answer things this assistant
+     * cannot. Two bubbles in the same corner is also the one layout bug this
+     * component could cause, since `<ConnectAskAi>` sits at the same `z-30`
+     * bottom-right position.
+     *
+     * Turn it on for a marketing site that is a separate surface from the
+     * application, where "signed in" says nothing about what the visitor is
+     * reading.
+     */
+    showWhenSignedIn?: boolean;
+    /**
+     * Replaces `fetch`, for a mount with **no `ConnectProvider`** around it.
+     *
+     * Inside a provider this is not needed and not read: the component goes
+     * through `mutateResource`/`streamResource`, which already use whatever
+     * `fetch` that provider was given - so Storybook and the docs site work by
+     * wrapping it, with nothing passed here.
+     */
+    fetch?: (input: string, init?: RequestInit) => Promise<Response>;
+}
+/**
+ * The public chat bubble: a visitor with no account asks about your product,
+ * books a call, or gets started.
+ *
+ * ## It runs on pages that have no `ConnectProvider`
+ *
+ * Deliberately, and it is the main thing separating this component from every
+ * other one here. A marketing page usually has no session to hold and nothing
+ * on it that needs one, so requiring the provider would mean wrapping a
+ * landing page in an auth context to put a chat bubble on it. It reads the
+ * context through `useConnectOptional` and uses it only for `basePath` and the
+ * injected `fetch`; both have props, and both have defaults.
+ *
+ * ## Nothing happens until somebody opens it
+ *
+ * The conversation is minted on first open, never on mount. On a busy marketing
+ * site mounting would mean one Firestore write and one wasted session row per
+ * *page view*, for a bubble most visitors never touch - and the bubble itself
+ * needs no server state to render. The greeting arrives with that first call
+ * and is stored copy rather than generated, so opening costs one fast round
+ * trip and the visitor is reading real words immediately.
+ *
+ * ## It is built for a phone first
+ *
+ * Open, it is a full-height sheet on a narrow viewport and an anchored panel
+ * from `sm` up - a marketing chat that covers a desktop browser is harder to
+ * use, and one that does not cover a phone has nowhere to put a keyboard.
+ * `h-dvh` rather than `h-screen`, so the sheet tracks the visual viewport when
+ * the keyboard opens; `env(safe-area-inset-bottom)` on the composer, so the
+ * send button is not under a home indicator.
+ *
+ * The composer's input type is **the server's decision**, not a guess from what
+ * the assistant said - see `VisitorField`. That is what puts an `@` on the
+ * keyboard when an email is wanted and lets iOS offer a verification code
+ * straight from the notification.
+ *
+ * ## The times are drawn from the tool result, never the prose
+ *
+ * A turn that looked up availability carries the slots as structured data, and
+ * the buttons come from that. So a time the visitor taps is one the server
+ * offered, which is the property `/visitor/book` relies on and cannot check for
+ * itself.
+ *
+ * ## Replies render as text, not markdown
+ *
+ * `<ConnectAskAi>` lazy-loads a markdown renderer because it answers questions
+ * about a workspace's documents, where tables and code blocks carry meaning.
+ * This answers three-sentence questions about a product on a marketing page.
+ * Shipping 462 KB of renderer to a landing page for prose that is deliberately
+ * kept to a couple of lines is the wrong trade, so line breaks are preserved
+ * and nothing else is parsed.
+ */
+export declare function ConnectVisitorChat({ workspaceId, assistantName, greeting, suggestions, bookingEventTypeSlug, basePath, page, title, defaultOpen, showWhenSignedIn, fetch: fetchProp, }: ConnectVisitorChatProps): import("react").JSX.Element | null;

package/dist/types/client/components/visitor-stream.d.ts

@@ -0,0 +1,42 @@
+import type { VisitorSlotOffer, VisitorToolCall, VisitorTurnDone } from "../../types.js";
+/**
+ * The visitor turn's wire format, read.
+ *
+ * **A named-event reader, where `<ConnectAskAi>`'s is data-only.** That one
+ * consumes the AI SDK's UI message stream, where every frame is a `data:` line
+ * carrying a `type` field. This endpoint answers `event:`/`data:` pairs instead,
+ * for the reason the route explains: the UI message protocol exists for
+ * `useChat`, which owns the message list client-side, and this surface
+ * deliberately does not let the client own the transcript.
+ *
+ * Kept out of the component and pure so it can be tested without a DOM. The
+ * three behaviours worth pinning are all here: a frame split across two network
+ * reads, a malformed frame, and a stream that ends without its `done`.
+ */
+export interface VisitorStreamHandlers {
+    onDelta(text: string): void;
+    onDone(done: VisitorTurnDone): void;
+    /**
+     * A failure the server reported *after* the stream opened.
+     *
+     * It arrives as an event rather than a status because the status was already
+     * sent, and the message is written as a sentence for the same reason - it is
+     * shown to the visitor verbatim.
+     */
+    onError(message: string): void;
+}
+export declare function readVisitorStream(response: Response, handlers: VisitorStreamHandlers): Promise<void>;
+/**
+ * The times a turn looked up, lifted out of its tool calls.
+ *
+ * **This is what the buttons are drawn from, never the assistant's sentence.** A
+ * time the visitor taps is then one the server offered, which is what makes it
+ * impossible to book an appointment at a time nobody gave - the property
+ * `/visitor/book` depends on and cannot check for itself.
+ *
+ * `null` when the turn looked nothing up, and also when the lookup *refused* -
+ * a tool answering `ok: false` is the assistant being told there is nothing
+ * available, and it says so in prose. Rendering an empty slot list under that
+ * would be a second, emptier way of saying the same thing.
+ */
+export declare function visitorSlotOfferFrom(toolCalls: readonly VisitorToolCall[]): VisitorSlotOffer | null;