@waniwani/sdk 0.18.0 → 0.19.1

package/dist/legacy/index.d.ts

@@ -143,7 +143,7 @@ interface KbClient {
  * first-class names at runtime (the widget transport passes these through
  * verbatim instead of namespacing them as custom widget events).
  */
-declare const EVENT_TYPES: readonly ["session.started", "page.viewed", "tool.called", "quote.requested", "quote.succeeded", "quote.failed", "link.clicked", "purchase.completed", "widget_render", "user.identified", "price_shown", "prices_compared", "option_selected", "lead_qualified", "converted"];
+declare const EVENT_TYPES: readonly ["session.started", "page.viewed", "tool.called", "link.clicked", "widget_render", "user.identified", "price_shown", "prices_compared", "option_selected", "lead_qualified", "converted"];
 type EventType = (typeof EVENT_TYPES)[number];
 /**
  * Properties for `page.viewed` — emitted once when the chat widget initializes
@@ -172,17 +172,9 @@ interface ToolCalledProperties {
     /** Retrieval traces for kb.search() calls made inside this tool handler. */
     kbSearch?: KbSearchTrace[];
 }
-interface QuoteSucceededProperties {
-    amount?: number;
-    currency?: string;
-}
 interface LinkClickedProperties {
     url?: string;
 }
-interface PurchaseCompletedProperties {
-    amount?: number;
-    currency?: string;
-}
 interface PriceShownProperties {
     amount: number;
     currency: string;
@@ -269,19 +261,9 @@ type TrackEvent = ({
 } & BaseTrackEvent) | ({
     event: "tool.called";
     properties?: ToolCalledProperties;
-} & BaseTrackEvent) | ({
-    event: "quote.requested";
-} & BaseTrackEvent) | ({
-    event: "quote.succeeded";
-    properties?: QuoteSucceededProperties;
-} & BaseTrackEvent) | ({
-    event: "quote.failed";
 } & BaseTrackEvent) | ({
     event: "link.clicked";
     properties?: LinkClickedProperties;
-} & BaseTrackEvent) | ({
-    event: "purchase.completed";
-    properties?: PurchaseCompletedProperties;
 } & BaseTrackEvent) | ({
     event: "user.identified";
 } & BaseTrackEvent) | ({
@@ -310,11 +292,7 @@ interface LegacyTrackEvent extends TrackingContext {
     properties?: Record<string, unknown>;
     toolName?: string;
     toolType?: ToolCalledProperties["type"];
-    quoteAmount?: number;
-    quoteCurrency?: string;
     linkUrl?: string;
-    purchaseAmount?: number;
-    purchaseCurrency?: string;
 }
 /**
  * Public track input accepted by `client.track()`.
@@ -435,6 +413,21 @@ interface ScopedWaniWaniClient {
      * `sessionId` later). `undefined` when the host provided no session id.
      */
     readonly sessionId?: string;
+    /**
+     * The anonymous visitor id, resolved from the request meta. Present on the
+     * web chat surface (a persisted per-device id threaded through as
+     * `waniwani/visitorId`); `undefined` on hosts that do not supply one, such
+     * as Claude. Ingest accepts it as an identity in its own right, so use it
+     * to correlate events before a session or user id exists.
+     */
+    readonly visitorId?: string;
+    /**
+     * The external user id, resolved from the request meta (e.g. `openai/userId`
+     * for ChatGPT's anonymous users, or a host-provided `externalUserId`). Read
+     * it alongside `sessionId`/`visitorId` — whichever the current host provides.
+     * `undefined` when the host supplied no user id.
+     */
+    readonly externalUserId?: string;
     /**
      * Track an event — request meta is automatically merged. Also exposes the
      * revenue helpers flat (`track.priceShown()`, `track.converted()`, …), which
@@ -1436,6 +1429,14 @@ type DeepPartial<T> = T extends (...args: never[]) => unknown ? T : T extends ob
 } : T;
 type MessageOverrides = DeepPartial<Messages>;
 
+/**
+ * A visitor id to apply, or a resolver that produces one. The resolver may be
+ * sync (`() => posthog.get_distinct_id()`) or async
+ * (`async () => (await sdk.ready()).id`), for analytics SDKs whose id is only
+ * available after they bootstrap.
+ */
+type VisitorIdInput = string | (() => string | undefined | null | Promise<string | undefined | null>);
+
 /**
  * Built-in theme presets. `auto` follows the host's `prefers-color-scheme`
  * and switches at runtime without re-rendering.
@@ -1538,6 +1539,15 @@ interface WelcomeConfig {
     /** Suggestion cards shown in the welcome screen. Disappear after the first message. */
     suggestions?: string[];
 }
+/** Where a suggestion pill came from. */
+/**
+ * Every place a suggestion pill can come from. The single source of truth:
+ * {@link SuggestionOrigin} derives from it, and runtime validation reads it,
+ * so adding an origin is a one-line change.
+ */
+declare const SUGGESTION_ORIGINS: readonly ["channel", "page", "flow", "followup"];
+/** Where a suggestion pill came from. */
+type SuggestionOrigin = (typeof SUGGESTION_ORIGINS)[number];
 interface SuggestionsConfig {
     /**
      * Initial suggestions to show before the user sends their first message.
@@ -1545,8 +1555,14 @@ interface SuggestionsConfig {
      */
     initial?: string[];
     /**
-     * Enable AI-generated suggestions after each response.
-     * Defaults to `true` when suggestions config is provided.
+     * Which providers may fill the pill row. Omitted, this defaults to
+     * `["channel", "page", "followup"]`: starter prompts and generated
+     * follow-ups render, flow-driven pills stay opt-in.
+     */
+    origins?: SuggestionOrigin[];
+    /**
+     * @deprecated Use `origins`. `true` maps to every origin, `false` to none.
+     * Will be removed in a future minor release.
      */
     dynamic?: boolean;
 }
@@ -1594,6 +1610,21 @@ interface ChatBaseProps {
     appearance?: ChatAppearance;
     /** Per-slot class name overrides. See {@link ChatClassNames}. */
     classNames?: ChatClassNames;
+    /**
+     * Override the anonymous visitor id the widget generates with one you
+     * already track (a PostHog / Amplitude / Segment distinct id, your own
+     * cookie, etc.). The chat sends it on every request, so Waniwani sessions
+     * and events correlate to the same visitor, and server-side MCP tools and
+     * flows read it back as `context.waniwani.visitorId`.
+     *
+     * A string, or a resolver that returns one — sync
+     * (`() => posthog.get_distinct_id()`) or async
+     * (`async () => (await sdk.ready()).id`), for analytics SDKs whose id is
+     * only ready after they bootstrap. A blank / failed result is ignored, so
+     * the auto-generated, `localStorage`-persisted id is kept. Leave unset to
+     * always use the auto id.
+     */
+    visitorId?: VisitorIdInput;
     /** Additional headers to send with chat API requests */
     headers?: Record<string, string>;
     /** Additional body fields to send with each chat request */
@@ -1613,8 +1644,11 @@ interface ChatBaseProps {
     /** Callback fired when a response is received */
     onResponseReceived?: () => void;
     /**
-     * Enable AI-generated suggestions after each response.
-     * `true` enables with defaults (3 suggestions), object allows config, `false`/undefined disables.
+     * Suggestion pill configuration. Unset: no suggestions. An object sets
+     * starter prompts (`initial`) and which origins may fill the per-turn
+     * pill row (`origins`); `origins: ["flow"]` (or any list including
+     * `"flow"`) opts into flow-driven pills. `true` enables every origin with
+     * defaults; `false` hides the pill row entirely.
      */
     suggestions?: boolean | SuggestionsConfig;
     /**