@burdenoff/website-sdk 2026.922.3 → 2026.922.5

package/dist/components/explore.d.mts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { E as ExploreProduct } from '../explore-types-CPF1QoMn.mjs';
+import { E as ExploreProduct, a as ExploreReference } from '../explore-types-DvQPiL1t.mjs';
 
 interface ExplorePageProps {
     /**
@@ -85,6 +85,96 @@ declare function inlineImageOrigins(products: readonly Pick<ExploreProduct, "web
  * 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;
+/**
+ * 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;
+/**
+ * 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;
 declare function ExplorePage({ seo, productSlug, examplePrompts, className, heightMode, viewportOffset, onNavigate, onSend, welcomeTitle, welcomeBody, locale, }: ExplorePageProps): react.JSX.Element;
 
-export { ExplorePage, type ExplorePageProps, inlineImageOrigins, isInlineImageAllowed, logoUrlOf };
+export { ExplorePage, type ExplorePageProps, type ExploreProvenance, type ExploreReferenceKind, answerPlainText, answerSpeechText, inlineImageOrigins, isInlineImageAllowed, logoUrlOf, productNamesByOrigin, referenceKindOf, summariseReferences };

package/dist/components/explore.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { E as ExploreProduct } from '../explore-types-CPF1QoMn.js';
+import { E as ExploreProduct, a as ExploreReference } from '../explore-types-DvQPiL1t.js';
 
 interface ExplorePageProps {
     /**
@@ -85,6 +85,96 @@ declare function inlineImageOrigins(products: readonly Pick<ExploreProduct, "web
  * 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;
+/**
+ * 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;
+/**
+ * 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;
 declare function ExplorePage({ seo, productSlug, examplePrompts, className, heightMode, viewportOffset, onNavigate, onSend, welcomeTitle, welcomeBody, locale, }: ExplorePageProps): react.JSX.Element;
 
-export { ExplorePage, type ExplorePageProps, inlineImageOrigins, isInlineImageAllowed, logoUrlOf };
+export { ExplorePage, type ExplorePageProps, type ExploreProvenance, type ExploreReferenceKind, answerPlainText, answerSpeechText, inlineImageOrigins, isInlineImageAllowed, logoUrlOf, productNamesByOrigin, referenceKindOf, summariseReferences };