@burdenoff/website-sdk 2026.922.5 → 2026.923.1

package/dist/explore-D25zoXy9.d.mts

@@ -0,0 +1,240 @@
+import * as react from 'react';
+import { E as ExploreProduct, a as ExploreReference } from './explore-types-B5sdOC5M.mjs';
+import { Components } from 'react-markdown';
+
+/**
+ * The answer stylesheet as an element. Safe to mount more than once — the rules are
+ * idempotent — so a page that shows answers and nothing else still gets them.
+ */
+declare function ExploreAnswerStyles(): react.JSX.Element;
+/**
+ * Origins an answer may embed images from: every catalog product's website, apex and
+ * `www.` alike (Botlit ships on www.botlit.ai, everything else on the apex, and either can
+ * appear in the corpus). https only.
+ */
+declare function inlineImageOrigins(products: readonly Pick<ExploreProduct, "website">[]): Set<string>;
+/**
+ * True when `src` is an https URL on a catalog product site. The backend already strips
+ * every image it did not put in the answer; this is the browser's own check, so a model
+ * that slips an arbitrary URL past it still cannot make the visitor's browser fetch it.
+ */
+declare function isInlineImageAllowed(src: unknown, origins: ReadonlySet<string>): src is string;
+/**
+ * An answer as READABLE TEXT, for the clipboard.
+ *
+ * What counts as "our internal markup artefacts", and why each choice:
+ *
+ * - **Image embeds go.** `![Concept illustration of …](https://…/01.webp)` is a picture this
+ *   page injected into the answer; pasted into an email it is a URL and an alt string, and
+ *   neither is the answer. The caption line the backend writes under it is ordinary prose and
+ *   stays.
+ * - **Links become `label (url)`.** The destination is information the reader may need; the
+ *   bracket-paren syntax is not. Dropping the URL would quietly strip the page it came from.
+ * - **Citation markers `[3]` stay.** They are the only attribution the copied text carries,
+ *   and they are the answer's own — not something the UI added. The sources they point at are
+ *   listed right next to the button that copied this.
+ * - **Emphasis, headings, blockquote and rule markers go**, because `**` and `###` are
+ *   instructions to a renderer, not words.
+ * - **A table keeps its pipes.** Pasted into a README, an issue or a chat it is a table
+ *   again; flattened into sentences it is not.
+ * - **Fenced code is verbatim**, fences included, minus nothing but the fence lines
+ *   themselves: stripping `*` or `_` inside a code block would corrupt the code.
+ *
+ * Built from `message.content` rather than from the rendered DOM: `textContent` on the bubble
+ * would fold every paragraph, list item and table cell into one run-on line.
+ */
+declare function answerPlainText(markdown: string): string;
+/**
+ * The same answer as something to SAY, for read-aloud.
+ *
+ * It shares every rule above but the two that are right for a paste and wrong for a voice:
+ *
+ * - **A link is its label.** The clipboard keeps `label (https://…)` because a pasted answer
+ *   loses the page otherwise. Spoken, that is a URL spelled out character by character in
+ *   the middle of a sentence — and the prompt asks for two to five links in every answer, so
+ *   it is not an edge case. The sources are listed under the answer either way.
+ * - **A table is read as rows, not as pipes.** `| --- | --- |` is a line of punctuation and
+ *   the pipes are column rules, neither of which is a word. Each row is read with its cells
+ *   under their own column headings — the phone layout, out loud — so a plan list still says
+ *   which number is the price. Comparisons and plan lists are exactly the answers the
+ *   feature was built for (CONTRACT.md §7), which is what makes this worth a second mode.
+ *
+ * Everything else stays deliberately identical, including citation markers: they are the
+ * answer's own attribution in both, and a listener hearing "two" after a claim is hearing
+ * the same thing a reader sees.
+ */
+declare function answerSpeechText(markdown: string): string;
+/**
+ * The strings the markdown overrides render.
+ *
+ * Deliberately three fields rather than the whole `ExploreStrings`: the chat and a published
+ * answer page carry different chrome vocabularies, and these three are the only words the
+ * ANSWER itself needs. `ExploreStrings` satisfies this structurally, so the chat passes its
+ * own `T` unchanged.
+ */
+interface AnswerRendererStrings {
+    /** Accessible name of the scrollable box a table sits in. */
+    answerTable: string;
+    /** The badge laid over a concept illustration embedded in an answer. */
+    conceptIllustration: string;
+    /** Read out after a link that opens a new tab. */
+    opensInNewTab: string;
+}
+interface ExploreAnswerBodyProps {
+    /** The answer, exactly as the harness wrote it: GitHub-flavoured markdown. */
+    children: string;
+    /** The three strings the overrides render. `ExploreStrings` satisfies this. */
+    strings: AnswerRendererStrings;
+    /** Origins an inline image may come from — see {@link inlineImageOrigins}. */
+    imageOrigins: ReadonlySet<string>;
+    /**
+     * False while the answer is still streaming, which suppresses its images: a partial is cut
+     * mid-token, so an image URL in it may be half-written, and the backend has not yet dropped
+     * the images it does not allow. A settled answer — every published one — is `true`.
+     */
+    enabled?: boolean;
+    /**
+     * Extra markdown overrides, merged OVER the shared ones.
+     *
+     * Pass a module-level constant, never an object built during render: react-markdown uses an
+     * override as the element TYPE, so a component re-created on every render remounts
+     * everything under it — an image would be fetched again, and one that had been hidden for
+     * failing to load would come back.
+     */
+    components?: Components;
+    /** Extra classes for the prose wrapper. */
+    className?: string;
+}
+/**
+ * An answer, rendered.
+ *
+ * The wrapper carries `boff-prose` and `boff-explore-body`: the first styles ordinary
+ * markdown, the second is what every rule in {@link EXPLORE_ANSWER_CSS} is scoped to. A page
+ * that renders this must also mount `<ProseStyles />` and `<ExploreAnswerStyles />`, or a
+ * wide table has nothing holding it inside the page.
+ *
+ * The set of images that failed to load is held HERE rather than in each image, so a source
+ * that 404s stays hidden even when the markdown re-renders from scratch underneath it.
+ */
+declare function ExploreAnswerBody({ children, strings, imageOrigins, enabled, components, className, }: ExploreAnswerBodyProps): react.JSX.Element;
+
+interface ExplorePageProps {
+    /**
+     * SEO metadata. Every field is optional and each one falls back to a default
+     * derived from {@link ExplorePageProps.productSlug}, so a site that passes
+     * nothing still gets a correct head — see `defaultExploreSeo`.
+     *
+     * Pass this only to say something the default cannot. All 38 sites used to
+     * hard-code the same two sentences here, which is how every one of them ended
+     * up announcing "Explore Burdenoff products with AI" — product-first on a page
+     * whose whole purpose is to ask the visitor about their problem, and simply
+     * the wrong brand on 37 of them.
+     */
+    seo?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+        image?: string;
+        url?: string;
+    };
+    /** Slug of the product site this page lives on — a soft hint to the harness. */
+    productSlug?: string;
+    /**
+     * Example prompts shown when `exploreCatalog` supplies none. Resolution
+     * order: catalog → this prop → the SDK's built-in list.
+     */
+    examplePrompts?: string[];
+    /** Extra classes for the page root. */
+    className?: string;
+    /**
+     * `viewport` (default) pins the chat to the viewport with an internally
+     * scrolling transcript — the right feel for a dedicated `/explore` route.
+     * `auto` lets the page grow, for embedding inside a longer page.
+     *
+     * `viewport` also means "this component IS the page": only in that mode does it take over
+     * `history.scrollRestoration` and correct a restored scroll offset that has parked the
+     * page in the site footer. An `auto` embed never touches its host page's scrolling.
+     */
+    heightMode?: "viewport" | "auto";
+    /**
+     * Chrome to subtract in `viewport` mode — the site header height. A number is treated as
+     * pixels. Default `0`.
+     *
+     * Pre-measurement fallback ONLY. Once mounted the pane measures its own top, so an
+     * approximate value is fine and the keyboard case is handled; see `measurePane` in
+     * `ExplorePage`.
+     */
+    viewportOffset?: string | number;
+    /** SPA navigation for internal CTA paths. Falls back to a plain link. */
+    onNavigate?: (path: string) => void;
+    /** Fired with the message text every time a send is accepted. */
+    onSend?: (message: string) => void;
+    /** Overrides `exploreCatalog.welcomeTitle` — also the page `<h1>`. */
+    welcomeTitle?: string;
+    /** Overrides `exploreCatalog.welcomeBody`. */
+    welcomeBody?: string;
+    /**
+     * BCP-47 locale to render in. Defaults to the document's own `lang`, then the browser.
+     * Only the six the products ship are recognised (en, zh, hi, es, ar, ta); anything else
+     * falls back to English.
+     */
+    locale?: string;
+}
+/**
+ * The product's own logo, derived from the reference's origin.
+ *
+ * Every Burdenoff product site serves `/favicon.svg`, so the logo needs no registry and no
+ * bundled assets — the reference URL already names the product. Deliberately NOT
+ * `/favicon-512.png`: that path returns 200 with `text/html` because the SPA fallback
+ * answers unknown paths, so it would render as a broken image rather than 404 into the
+ * fallback below.
+ */
+declare function logoUrlOf(url: string): string | null;
+/**
+ * The kinds of page an answer can cite.
+ *
+ * `PAGE` is the catch-all for a catalog site's own marketing pages, so the list is total for
+ * anything on one of our origins; a reference that is NOT on a catalog origin gets no kind at
+ * all (see `referenceKindOf`).
+ */
+type ExploreReferenceKind = "CONCEPT" | "DOCS" | "PRICING" | "USE_CASE" | "PAGE";
+/**
+ * What KIND of page a reference points at, decided from its URL alone.
+ *
+ * Deliberately not from the title: titles are model-written prose in six languages, so
+ * "Pricing" in one answer is "Precios" in the next and "Plans and pricing" in the one after.
+ * The URL is the only part of a reference nobody paraphrases.
+ *
+ * Reasoned against the catalog origins exactly as `isInlineImageAllowed` is: a URL that is
+ * not on a product site we list gets `null` rather than a guessed label, because the whole
+ * value of the row is that it says what the evidence IS.
+ */
+declare function referenceKindOf(url: string, origins: ReadonlySet<string>): ExploreReferenceKind | null;
+/**
+ * Apex origin → the product's display name, built from the catalog the same way
+ * `inlineImageOrigins` builds its allow-list.
+ *
+ * The display name matters: `ExploreReference.product` carries the slug, so a row built from
+ * it says "vibecontrols" next to a page that calls itself VibeControls everywhere else.
+ */
+declare function productNamesByOrigin(products: readonly Pick<ExploreProduct, "name" | "website">[]): Map<string, string>;
+/** The shape of one answer's evidence, as the chips render it. */
+interface ExploreProvenance {
+    /** Every reference the answer cites, including any we could not classify. */
+    total: number;
+    /** Kinds present, in `REFERENCE_KIND_ORDER`, with how many sources each covers. */
+    kinds: Array<{
+        kind: ExploreReferenceKind;
+        count: number;
+    }>;
+    /** Product names, in the order the answer first cited them. */
+    products: string[];
+}
+/**
+ * Summarise what an answer is grounded in. Pure, and derived entirely from `references` —
+ * there is no backend field behind this row.
+ */
+declare function summariseReferences(references: readonly ExploreReference[], origins: ReadonlySet<string>, productNames: ReadonlyMap<string, string>): ExploreProvenance;
+declare function ExplorePage({ seo, productSlug, examplePrompts, className, heightMode, viewportOffset, onNavigate, onSend, welcomeTitle, welcomeBody, locale, }: ExplorePageProps): react.JSX.Element;
+
+export { type AnswerRendererStrings as A, ExploreAnswerBody as E, type ExploreAnswerBodyProps as a, ExploreAnswerStyles as b, ExplorePage as c, type ExplorePageProps as d, answerPlainText as e, answerSpeechText as f, isInlineImageAllowed as g, type ExploreProvenance as h, inlineImageOrigins as i, type ExploreReferenceKind as j, logoUrlOf as l, productNamesByOrigin as p, referenceKindOf as r, summariseReferences as s };

package/dist/explore-I4QnY4J9.d.ts

@@ -0,0 +1,240 @@
+import * as react from 'react';
+import { E as ExploreProduct, a as ExploreReference } from './explore-types-B5sdOC5M.js';
+import { Components } from 'react-markdown';
+
+/**
+ * The answer stylesheet as an element. Safe to mount more than once — the rules are
+ * idempotent — so a page that shows answers and nothing else still gets them.
+ */
+declare function ExploreAnswerStyles(): react.JSX.Element;
+/**
+ * Origins an answer may embed images from: every catalog product's website, apex and
+ * `www.` alike (Botlit ships on www.botlit.ai, everything else on the apex, and either can
+ * appear in the corpus). https only.
+ */
+declare function inlineImageOrigins(products: readonly Pick<ExploreProduct, "website">[]): Set<string>;
+/**
+ * True when `src` is an https URL on a catalog product site. The backend already strips
+ * every image it did not put in the answer; this is the browser's own check, so a model
+ * that slips an arbitrary URL past it still cannot make the visitor's browser fetch it.
+ */
+declare function isInlineImageAllowed(src: unknown, origins: ReadonlySet<string>): src is string;
+/**
+ * An answer as READABLE TEXT, for the clipboard.
+ *
+ * What counts as "our internal markup artefacts", and why each choice:
+ *
+ * - **Image embeds go.** `![Concept illustration of …](https://…/01.webp)` is a picture this
+ *   page injected into the answer; pasted into an email it is a URL and an alt string, and
+ *   neither is the answer. The caption line the backend writes under it is ordinary prose and
+ *   stays.
+ * - **Links become `label (url)`.** The destination is information the reader may need; the
+ *   bracket-paren syntax is not. Dropping the URL would quietly strip the page it came from.
+ * - **Citation markers `[3]` stay.** They are the only attribution the copied text carries,
+ *   and they are the answer's own — not something the UI added. The sources they point at are
+ *   listed right next to the button that copied this.
+ * - **Emphasis, headings, blockquote and rule markers go**, because `**` and `###` are
+ *   instructions to a renderer, not words.
+ * - **A table keeps its pipes.** Pasted into a README, an issue or a chat it is a table
+ *   again; flattened into sentences it is not.
+ * - **Fenced code is verbatim**, fences included, minus nothing but the fence lines
+ *   themselves: stripping `*` or `_` inside a code block would corrupt the code.
+ *
+ * Built from `message.content` rather than from the rendered DOM: `textContent` on the bubble
+ * would fold every paragraph, list item and table cell into one run-on line.
+ */
+declare function answerPlainText(markdown: string): string;
+/**
+ * The same answer as something to SAY, for read-aloud.
+ *
+ * It shares every rule above but the two that are right for a paste and wrong for a voice:
+ *
+ * - **A link is its label.** The clipboard keeps `label (https://…)` because a pasted answer
+ *   loses the page otherwise. Spoken, that is a URL spelled out character by character in
+ *   the middle of a sentence — and the prompt asks for two to five links in every answer, so
+ *   it is not an edge case. The sources are listed under the answer either way.
+ * - **A table is read as rows, not as pipes.** `| --- | --- |` is a line of punctuation and
+ *   the pipes are column rules, neither of which is a word. Each row is read with its cells
+ *   under their own column headings — the phone layout, out loud — so a plan list still says
+ *   which number is the price. Comparisons and plan lists are exactly the answers the
+ *   feature was built for (CONTRACT.md §7), which is what makes this worth a second mode.
+ *
+ * Everything else stays deliberately identical, including citation markers: they are the
+ * answer's own attribution in both, and a listener hearing "two" after a claim is hearing
+ * the same thing a reader sees.
+ */
+declare function answerSpeechText(markdown: string): string;
+/**
+ * The strings the markdown overrides render.
+ *
+ * Deliberately three fields rather than the whole `ExploreStrings`: the chat and a published
+ * answer page carry different chrome vocabularies, and these three are the only words the
+ * ANSWER itself needs. `ExploreStrings` satisfies this structurally, so the chat passes its
+ * own `T` unchanged.
+ */
+interface AnswerRendererStrings {
+    /** Accessible name of the scrollable box a table sits in. */
+    answerTable: string;
+    /** The badge laid over a concept illustration embedded in an answer. */
+    conceptIllustration: string;
+    /** Read out after a link that opens a new tab. */
+    opensInNewTab: string;
+}
+interface ExploreAnswerBodyProps {
+    /** The answer, exactly as the harness wrote it: GitHub-flavoured markdown. */
+    children: string;
+    /** The three strings the overrides render. `ExploreStrings` satisfies this. */
+    strings: AnswerRendererStrings;
+    /** Origins an inline image may come from — see {@link inlineImageOrigins}. */
+    imageOrigins: ReadonlySet<string>;
+    /**
+     * False while the answer is still streaming, which suppresses its images: a partial is cut
+     * mid-token, so an image URL in it may be half-written, and the backend has not yet dropped
+     * the images it does not allow. A settled answer — every published one — is `true`.
+     */
+    enabled?: boolean;
+    /**
+     * Extra markdown overrides, merged OVER the shared ones.
+     *
+     * Pass a module-level constant, never an object built during render: react-markdown uses an
+     * override as the element TYPE, so a component re-created on every render remounts
+     * everything under it — an image would be fetched again, and one that had been hidden for
+     * failing to load would come back.
+     */
+    components?: Components;
+    /** Extra classes for the prose wrapper. */
+    className?: string;
+}
+/**
+ * An answer, rendered.
+ *
+ * The wrapper carries `boff-prose` and `boff-explore-body`: the first styles ordinary
+ * markdown, the second is what every rule in {@link EXPLORE_ANSWER_CSS} is scoped to. A page
+ * that renders this must also mount `<ProseStyles />` and `<ExploreAnswerStyles />`, or a
+ * wide table has nothing holding it inside the page.
+ *
+ * The set of images that failed to load is held HERE rather than in each image, so a source
+ * that 404s stays hidden even when the markdown re-renders from scratch underneath it.
+ */
+declare function ExploreAnswerBody({ children, strings, imageOrigins, enabled, components, className, }: ExploreAnswerBodyProps): react.JSX.Element;
+
+interface ExplorePageProps {
+    /**
+     * SEO metadata. Every field is optional and each one falls back to a default
+     * derived from {@link ExplorePageProps.productSlug}, so a site that passes
+     * nothing still gets a correct head — see `defaultExploreSeo`.
+     *
+     * Pass this only to say something the default cannot. All 38 sites used to
+     * hard-code the same two sentences here, which is how every one of them ended
+     * up announcing "Explore Burdenoff products with AI" — product-first on a page
+     * whose whole purpose is to ask the visitor about their problem, and simply
+     * the wrong brand on 37 of them.
+     */
+    seo?: {
+        title?: string;
+        description?: string;
+        keywords?: string;
+        image?: string;
+        url?: string;
+    };
+    /** Slug of the product site this page lives on — a soft hint to the harness. */
+    productSlug?: string;
+    /**
+     * Example prompts shown when `exploreCatalog` supplies none. Resolution
+     * order: catalog → this prop → the SDK's built-in list.
+     */
+    examplePrompts?: string[];
+    /** Extra classes for the page root. */
+    className?: string;
+    /**
+     * `viewport` (default) pins the chat to the viewport with an internally
+     * scrolling transcript — the right feel for a dedicated `/explore` route.
+     * `auto` lets the page grow, for embedding inside a longer page.
+     *
+     * `viewport` also means "this component IS the page": only in that mode does it take over
+     * `history.scrollRestoration` and correct a restored scroll offset that has parked the
+     * page in the site footer. An `auto` embed never touches its host page's scrolling.
+     */
+    heightMode?: "viewport" | "auto";
+    /**
+     * Chrome to subtract in `viewport` mode — the site header height. A number is treated as
+     * pixels. Default `0`.
+     *
+     * Pre-measurement fallback ONLY. Once mounted the pane measures its own top, so an
+     * approximate value is fine and the keyboard case is handled; see `measurePane` in
+     * `ExplorePage`.
+     */
+    viewportOffset?: string | number;
+    /** SPA navigation for internal CTA paths. Falls back to a plain link. */
+    onNavigate?: (path: string) => void;
+    /** Fired with the message text every time a send is accepted. */
+    onSend?: (message: string) => void;
+    /** Overrides `exploreCatalog.welcomeTitle` — also the page `<h1>`. */
+    welcomeTitle?: string;
+    /** Overrides `exploreCatalog.welcomeBody`. */
+    welcomeBody?: string;
+    /**
+     * BCP-47 locale to render in. Defaults to the document's own `lang`, then the browser.
+     * Only the six the products ship are recognised (en, zh, hi, es, ar, ta); anything else
+     * falls back to English.
+     */
+    locale?: string;
+}
+/**
+ * The product's own logo, derived from the reference's origin.
+ *
+ * Every Burdenoff product site serves `/favicon.svg`, so the logo needs no registry and no
+ * bundled assets — the reference URL already names the product. Deliberately NOT
+ * `/favicon-512.png`: that path returns 200 with `text/html` because the SPA fallback
+ * answers unknown paths, so it would render as a broken image rather than 404 into the
+ * fallback below.
+ */
+declare function logoUrlOf(url: string): string | null;
+/**
+ * The kinds of page an answer can cite.
+ *
+ * `PAGE` is the catch-all for a catalog site's own marketing pages, so the list is total for
+ * anything on one of our origins; a reference that is NOT on a catalog origin gets no kind at
+ * all (see `referenceKindOf`).
+ */
+type ExploreReferenceKind = "CONCEPT" | "DOCS" | "PRICING" | "USE_CASE" | "PAGE";
+/**
+ * What KIND of page a reference points at, decided from its URL alone.
+ *
+ * Deliberately not from the title: titles are model-written prose in six languages, so
+ * "Pricing" in one answer is "Precios" in the next and "Plans and pricing" in the one after.
+ * The URL is the only part of a reference nobody paraphrases.
+ *
+ * Reasoned against the catalog origins exactly as `isInlineImageAllowed` is: a URL that is
+ * not on a product site we list gets `null` rather than a guessed label, because the whole
+ * value of the row is that it says what the evidence IS.
+ */
+declare function referenceKindOf(url: string, origins: ReadonlySet<string>): ExploreReferenceKind | null;
+/**
+ * Apex origin → the product's display name, built from the catalog the same way
+ * `inlineImageOrigins` builds its allow-list.
+ *
+ * The display name matters: `ExploreReference.product` carries the slug, so a row built from
+ * it says "vibecontrols" next to a page that calls itself VibeControls everywhere else.
+ */
+declare function productNamesByOrigin(products: readonly Pick<ExploreProduct, "name" | "website">[]): Map<string, string>;
+/** The shape of one answer's evidence, as the chips render it. */
+interface ExploreProvenance {
+    /** Every reference the answer cites, including any we could not classify. */
+    total: number;
+    /** Kinds present, in `REFERENCE_KIND_ORDER`, with how many sources each covers. */
+    kinds: Array<{
+        kind: ExploreReferenceKind;
+        count: number;
+    }>;
+    /** Product names, in the order the answer first cited them. */
+    products: string[];
+}
+/**
+ * Summarise what an answer is grounded in. Pure, and derived entirely from `references` —
+ * there is no backend field behind this row.
+ */
+declare function summariseReferences(references: readonly ExploreReference[], origins: ReadonlySet<string>, productNames: ReadonlyMap<string, string>): ExploreProvenance;
+declare function ExplorePage({ seo, productSlug, examplePrompts, className, heightMode, viewportOffset, onNavigate, onSend, welcomeTitle, welcomeBody, locale, }: ExplorePageProps): react.JSX.Element;
+
+export { type AnswerRendererStrings as A, ExploreAnswerBody as E, type ExploreAnswerBodyProps as a, ExploreAnswerStyles as b, ExplorePage as c, type ExplorePageProps as d, answerPlainText as e, answerSpeechText as f, isInlineImageAllowed as g, type ExploreProvenance as h, inlineImageOrigins as i, type ExploreReferenceKind as j, logoUrlOf as l, productNamesByOrigin as p, referenceKindOf as r, summariseReferences as s };

package/dist/{explore-types-DvQPiL1t.d.mts → explore-types-B5sdOC5M.d.mts}

@@ -43,7 +43,7 @@ type ExploreCtaKind = "CONTACT" | "PARTNERS" | "PRICING" | "SERVICES" | "WAITLIS
  * gateway emits when it rate-limits at the edge; the SDK client also produces
  * `TIMEOUT` / `NETWORK_ERROR` for transport failures.
  */
-type ExploreErrorCode = "EXPLORE_DISABLED" | "RATE_LIMITED" | "EXPLORE_GLOBAL_LIMIT" | "CAPTCHA_REQUIRED" | "CAPTCHA_FAILED" | "MESSAGE_TOO_LONG" | "MESSAGE_EMPTY" | "CONVERSATION_LIMIT" | "CONVERSATION_BUSY" | "UPSTREAM_UNAVAILABLE" | "NOT_FOUND" | "HTTP_429" | "TIMEOUT" | "NETWORK_ERROR";
+type ExploreErrorCode = "EXPLORE_DISABLED" | "RATE_LIMITED" | "EXPLORE_GLOBAL_LIMIT" | "CAPTCHA_REQUIRED" | "CAPTCHA_FAILED" | "MESSAGE_TOO_LONG" | "MESSAGE_EMPTY" | "CONVERSATION_LIMIT" | "CONVERSATION_BUSY" | "UPSTREAM_UNAVAILABLE" | "NOT_FOUND" | "INVALID_EMAIL" | "ESCALATION_FAILED" | "HTTP_429" | "TIMEOUT" | "NETWORK_ERROR";
 /** `type ExploreReference` — a cited source page for an answer. */
 interface ExploreReference {
     url: string;
@@ -276,5 +276,78 @@ interface ExploreMessageQueryData {
 interface SendExploreMessageMutationData {
     sendExploreMessage: SendExploreMessageResult;
 }
+/**
+ * `input EscalateExploreConversationInput`.
+ *
+ * `email` is the only thing the visitor is asked for. It is **personal data**: it belongs in
+ * this input and nowhere else — never in `localStorage`, never in an `ExploreMessage`, never
+ * in an analytics call. See the note on {@link ESCALATE_EXPLORE_CONVERSATION_MUTATION}.
+ */
+interface EscalateExploreConversationInput {
+    /** The thread being handed over. A share (`?c=`) secret is NOT one. */
+    conversationToken: string;
+    /** Validated strictly server-side; a bad address comes back as `INVALID_EMAIL`. */
+    email: string;
+    /** Optional free text. Hard-capped server-side at 2000 and TRUNCATED, never rejected. */
+    note?: string | null;
+    /** Only when `exploreCatalog.captchaRequired`. Same v3 action as a chat message. */
+    recaptchaToken?: string;
+    /** `PlatformProduct` id of the site, so the ticket reaches that product's support inbox. */
+    productId?: string;
+}
+/** `type ExploreEscalation` — the handover on record, as the SERVER holds it. */
+interface ExploreEscalation {
+    /**
+     * Where the reply is actually going.
+     *
+     * On a repeat submit this is the address the FIRST handover used, not the one just typed
+     * into the box — so this is the value to show back, never the local draft.
+     */
+    email: string;
+    createdAt: string;
+}
+/** `type EscalateExploreConversationResult`. */
+interface EscalateExploreConversationResult {
+    /**
+     * False when a handover already existed — the double-clicked button, the retried request,
+     * the reloaded page.
+     *
+     * **Not an error.** The conversation is with a human either way, and the UI must read as
+     * success on both values. The server enforces one handover per conversation with a UNIQUE
+     * index rather than a check-then-insert, so two concurrent submits produce one ticket and
+     * one of them gets this.
+     */
+    created: boolean;
+    escalation: ExploreEscalation;
+}
+/**
+ * Hand this conversation to a person.
+ *
+ * Awaited and NOT fire-and-forget (unlike {@link RECORD_EXPLORE_CLICK_MUTATION}): it is the
+ * one explore write that throws, because it ends with a visitor being told a person has
+ * their question. "We passed it on" must never be shown for a handover that did not happen.
+ *
+ * **The address the visitor types is personal data.** It travels in these variables and
+ * stops there. Do not persist it, do not fold it into the transcript (`messages` is what the
+ * hook writes to localStorage), and do not pass it to `onSend` or any analytics call — the
+ * server already has everything a support agent needs.
+ */
+declare const ESCALATE_EXPLORE_CONVERSATION_MUTATION = "\n  mutation EscalateExploreConversation(\n    $input: EscalateExploreConversationInput!\n  ) {\n    escalateExploreConversation(input: $input) {\n      created\n      escalation {\n        email\n        createdAt\n      }\n    }\n  }\n";
+/**
+ * How many characters the note field accepts before it stops taking more.
+ *
+ * Mirrors the server's hard cap so the box does not invite text it will silently truncate.
+ * Same status as {@link EXPLORE_FEEDBACK_COMMENT_SOFT_MAX}: a courtesy, not the limit that
+ * holds.
+ */
+declare const EXPLORE_ESCALATION_NOTE_SOFT_MAX = 2000;
+/**
+ * Whether `value` is worth sending to the mutation at all.
+ *
+ * A local pre-flight, never a promise of deliverability. Keep it a SUBSET of what the server
+ * accepts: a client that rejects something the server would have taken costs the visitor
+ * their answer with nobody able to see why.
+ */
+declare function looksLikeDeliverableEmail(value: string): boolean;
 
-export { type ExploreProduct as E, SEND_EXPLORE_MESSAGE_MUTATION as S, type ExploreReference as a, type ExploreLimits as b, type ExploreCatalog as c, type ExploreMessage as d, type ExploreFeedbackRating as e, type ExploreFeedbackReason as f, EXPLORE_CATALOG_QUERY as g, EXPLORE_CATALOG_QUERY_WITHOUT_HIGHLIGHTS as h, EXPLORE_MESSAGE_QUERY as i, type ExploreCatalogQueryData as j, type ExploreConceptHighlight as k, type ExploreConversation as l, type ExploreCtaKind as m, type ExploreCtaLink as n, type ExploreErrorCode as o, type ExploreMessageQueryData as p, type ExploreMessageRole as q, type ExploreMessageStatus as r, type SendExploreMessageInput as s, type SendExploreMessageMutationData as t, type SendExploreMessageResult as u };
+export { looksLikeDeliverableEmail as A, type ExploreProduct as E, SEND_EXPLORE_MESSAGE_MUTATION as S, type ExploreReference as a, type ExploreLimits as b, type ExploreCatalog as c, type ExploreMessage as d, type ExploreFeedbackRating as e, type ExploreFeedbackReason as f, ESCALATE_EXPLORE_CONVERSATION_MUTATION as g, EXPLORE_CATALOG_QUERY as h, EXPLORE_CATALOG_QUERY_WITHOUT_HIGHLIGHTS as i, EXPLORE_ESCALATION_NOTE_SOFT_MAX as j, EXPLORE_MESSAGE_QUERY as k, type EscalateExploreConversationInput as l, type EscalateExploreConversationResult as m, type ExploreCatalogQueryData as n, type ExploreConceptHighlight as o, type ExploreConversation as p, type ExploreCtaKind as q, type ExploreCtaLink as r, type ExploreErrorCode as s, type ExploreEscalation as t, type ExploreMessageQueryData as u, type ExploreMessageRole as v, type ExploreMessageStatus as w, type SendExploreMessageInput as x, type SendExploreMessageMutationData as y, type SendExploreMessageResult as z };

package/dist/{explore-types-DvQPiL1t.d.ts → explore-types-B5sdOC5M.d.ts}

@@ -43,7 +43,7 @@ type ExploreCtaKind = "CONTACT" | "PARTNERS" | "PRICING" | "SERVICES" | "WAITLIS
  * gateway emits when it rate-limits at the edge; the SDK client also produces
  * `TIMEOUT` / `NETWORK_ERROR` for transport failures.
  */
-type ExploreErrorCode = "EXPLORE_DISABLED" | "RATE_LIMITED" | "EXPLORE_GLOBAL_LIMIT" | "CAPTCHA_REQUIRED" | "CAPTCHA_FAILED" | "MESSAGE_TOO_LONG" | "MESSAGE_EMPTY" | "CONVERSATION_LIMIT" | "CONVERSATION_BUSY" | "UPSTREAM_UNAVAILABLE" | "NOT_FOUND" | "HTTP_429" | "TIMEOUT" | "NETWORK_ERROR";
+type ExploreErrorCode = "EXPLORE_DISABLED" | "RATE_LIMITED" | "EXPLORE_GLOBAL_LIMIT" | "CAPTCHA_REQUIRED" | "CAPTCHA_FAILED" | "MESSAGE_TOO_LONG" | "MESSAGE_EMPTY" | "CONVERSATION_LIMIT" | "CONVERSATION_BUSY" | "UPSTREAM_UNAVAILABLE" | "NOT_FOUND" | "INVALID_EMAIL" | "ESCALATION_FAILED" | "HTTP_429" | "TIMEOUT" | "NETWORK_ERROR";
 /** `type ExploreReference` — a cited source page for an answer. */
 interface ExploreReference {
     url: string;
@@ -276,5 +276,78 @@ interface ExploreMessageQueryData {
 interface SendExploreMessageMutationData {
     sendExploreMessage: SendExploreMessageResult;
 }
+/**
+ * `input EscalateExploreConversationInput`.
+ *
+ * `email` is the only thing the visitor is asked for. It is **personal data**: it belongs in
+ * this input and nowhere else — never in `localStorage`, never in an `ExploreMessage`, never
+ * in an analytics call. See the note on {@link ESCALATE_EXPLORE_CONVERSATION_MUTATION}.
+ */
+interface EscalateExploreConversationInput {
+    /** The thread being handed over. A share (`?c=`) secret is NOT one. */
+    conversationToken: string;
+    /** Validated strictly server-side; a bad address comes back as `INVALID_EMAIL`. */
+    email: string;
+    /** Optional free text. Hard-capped server-side at 2000 and TRUNCATED, never rejected. */
+    note?: string | null;
+    /** Only when `exploreCatalog.captchaRequired`. Same v3 action as a chat message. */
+    recaptchaToken?: string;
+    /** `PlatformProduct` id of the site, so the ticket reaches that product's support inbox. */
+    productId?: string;
+}
+/** `type ExploreEscalation` — the handover on record, as the SERVER holds it. */
+interface ExploreEscalation {
+    /**
+     * Where the reply is actually going.
+     *
+     * On a repeat submit this is the address the FIRST handover used, not the one just typed
+     * into the box — so this is the value to show back, never the local draft.
+     */
+    email: string;
+    createdAt: string;
+}
+/** `type EscalateExploreConversationResult`. */
+interface EscalateExploreConversationResult {
+    /**
+     * False when a handover already existed — the double-clicked button, the retried request,
+     * the reloaded page.
+     *
+     * **Not an error.** The conversation is with a human either way, and the UI must read as
+     * success on both values. The server enforces one handover per conversation with a UNIQUE
+     * index rather than a check-then-insert, so two concurrent submits produce one ticket and
+     * one of them gets this.
+     */
+    created: boolean;
+    escalation: ExploreEscalation;
+}
+/**
+ * Hand this conversation to a person.
+ *
+ * Awaited and NOT fire-and-forget (unlike {@link RECORD_EXPLORE_CLICK_MUTATION}): it is the
+ * one explore write that throws, because it ends with a visitor being told a person has
+ * their question. "We passed it on" must never be shown for a handover that did not happen.
+ *
+ * **The address the visitor types is personal data.** It travels in these variables and
+ * stops there. Do not persist it, do not fold it into the transcript (`messages` is what the
+ * hook writes to localStorage), and do not pass it to `onSend` or any analytics call — the
+ * server already has everything a support agent needs.
+ */
+declare const ESCALATE_EXPLORE_CONVERSATION_MUTATION = "\n  mutation EscalateExploreConversation(\n    $input: EscalateExploreConversationInput!\n  ) {\n    escalateExploreConversation(input: $input) {\n      created\n      escalation {\n        email\n        createdAt\n      }\n    }\n  }\n";
+/**
+ * How many characters the note field accepts before it stops taking more.
+ *
+ * Mirrors the server's hard cap so the box does not invite text it will silently truncate.
+ * Same status as {@link EXPLORE_FEEDBACK_COMMENT_SOFT_MAX}: a courtesy, not the limit that
+ * holds.
+ */
+declare const EXPLORE_ESCALATION_NOTE_SOFT_MAX = 2000;
+/**
+ * Whether `value` is worth sending to the mutation at all.
+ *
+ * A local pre-flight, never a promise of deliverability. Keep it a SUBSET of what the server
+ * accepts: a client that rejects something the server would have taken costs the visitor
+ * their answer with nobody able to see why.
+ */
+declare function looksLikeDeliverableEmail(value: string): boolean;
 
-export { type ExploreProduct as E, SEND_EXPLORE_MESSAGE_MUTATION as S, type ExploreReference as a, type ExploreLimits as b, type ExploreCatalog as c, type ExploreMessage as d, type ExploreFeedbackRating as e, type ExploreFeedbackReason as f, EXPLORE_CATALOG_QUERY as g, EXPLORE_CATALOG_QUERY_WITHOUT_HIGHLIGHTS as h, EXPLORE_MESSAGE_QUERY as i, type ExploreCatalogQueryData as j, type ExploreConceptHighlight as k, type ExploreConversation as l, type ExploreCtaKind as m, type ExploreCtaLink as n, type ExploreErrorCode as o, type ExploreMessageQueryData as p, type ExploreMessageRole as q, type ExploreMessageStatus as r, type SendExploreMessageInput as s, type SendExploreMessageMutationData as t, type SendExploreMessageResult as u };
+export { looksLikeDeliverableEmail as A, type ExploreProduct as E, SEND_EXPLORE_MESSAGE_MUTATION as S, type ExploreReference as a, type ExploreLimits as b, type ExploreCatalog as c, type ExploreMessage as d, type ExploreFeedbackRating as e, type ExploreFeedbackReason as f, ESCALATE_EXPLORE_CONVERSATION_MUTATION as g, EXPLORE_CATALOG_QUERY as h, EXPLORE_CATALOG_QUERY_WITHOUT_HIGHLIGHTS as i, EXPLORE_ESCALATION_NOTE_SOFT_MAX as j, EXPLORE_MESSAGE_QUERY as k, type EscalateExploreConversationInput as l, type EscalateExploreConversationResult as m, type ExploreCatalogQueryData as n, type ExploreConceptHighlight as o, type ExploreConversation as p, type ExploreCtaKind as q, type ExploreCtaLink as r, type ExploreErrorCode as s, type ExploreEscalation as t, type ExploreMessageQueryData as u, type ExploreMessageRole as v, type ExploreMessageStatus as w, type SendExploreMessageInput as x, type SendExploreMessageMutationData as y, type SendExploreMessageResult as z };