@waniwani/sdk 0.14.0 → 0.14.2

package/dist/chat/express-js/index.d.ts

@@ -57,7 +57,28 @@ interface KbClient {
     sources(): Promise<KbSource[]>;
 }
 
-type EventType = "session.started" | "tool.called" | "quote.requested" | "quote.succeeded" | "quote.failed" | "link.clicked" | "purchase.completed" | "widget_render" | "widget_click" | "widget_link_click" | "widget_error" | "widget_scroll" | "widget_form_field" | "widget_form_submit" | "user.identified" | "price_shown" | "prices_compared" | "option_selected" | "lead" | "converted";
+type EventType = "session.started" | "page.viewed" | "tool.called" | "quote.requested" | "quote.succeeded" | "quote.failed" | "link.clicked" | "purchase.completed" | "widget_render" | "widget_click" | "widget_link_click" | "widget_error" | "widget_scroll" | "widget_form_field" | "widget_form_submit" | "user.identified" | "price_shown" | "prices_compared" | "option_selected" | "lead" | "converted";
+/**
+ * Properties for `page.viewed` — emitted once when the chat widget initializes
+ * on a host page (the top of the funnel). Attributed to the anonymous
+ * `visitorId` (mapped to `externalUserId`), never to a session: a page view
+ * must not create a session, otherwise sessions would equal page views and the
+ * "landed → started a conversation" funnel collapses.
+ */
+interface PageViewedProperties {
+    /** Full URL of the host page the widget loaded on. */
+    url?: string;
+    /** Referrer of the host page, if any. */
+    referrer?: string;
+    /** Embed mode the widget initialized in. */
+    mode?: "inline" | "floating";
+    /** Resolved device type from the visitor context. */
+    deviceType?: "mobile" | "tablet" | "desktop";
+    /** Primary browser language (BCP-47). */
+    language?: string;
+    /** IANA timezone of the visitor. */
+    timezone?: string;
+}
 interface ToolCalledProperties {
     name?: string;
     type?: "pricing" | "product_info" | "availability" | "support" | "other";
@@ -132,6 +153,9 @@ interface BaseTrackEvent extends TrackingContext {
 }
 type TrackEvent = ({
     event: "session.started";
+} & BaseTrackEvent) | ({
+    event: "page.viewed";
+    properties?: PageViewedProperties;
 } & BaseTrackEvent) | ({
     event: "tool.called";
     properties?: ToolCalledProperties;

package/dist/chat/index.d.ts

@@ -110,13 +110,13 @@ interface ChatAppearance {
     variables?: ChatTheme;
 }
 /**
- * Tool call rendering mode.
+ * Tool-call activity rendering mode. Steps are grouped into one collapsible
+ * "chain of thought".
  *
- * - `true` (default) — full request/response panels.
- * - `"titles-only"` — a compact text indicator with the tool title, no
- *   JSON panels.
- * - `false` — tool calls are hidden entirely; a generic working indicator
- *   shows while tools run.
+ * - `true` (default) — each step expands to its request/response JSON.
+ * - `"titles-only"` — step labels only, no JSON.
+ * - `false` — the chain (and the reasoning trace) are hidden entirely; only
+ *   a generic working indicator shows while the agent works.
  */
 type ShowToolCalls = boolean | "titles-only";
 
@@ -238,13 +238,14 @@ interface ChatBaseProps {
      */
     debug?: boolean;
     /**
-     * How tool calls are rendered in the chat.
+     * How the agent's tool-call activity renders. Steps are grouped into a
+     * single collapsible "chain of thought" that auto-expands while the agent
+     * works and collapses to a summary once it settles.
      *
-     * - `true` (default) — full request/response panels.
-     * - `"titles-only"` — a compact text indicator with the tool title, no
-     *   JSON panels.
-     * - `false` — tool calls are hidden entirely; a generic working
-     *   indicator shows while tools run.
+     * - `true` (default) — each step expands to its request/response JSON.
+     * - `"titles-only"` — step labels only, no JSON.
+     * - `false` — the chain is hidden entirely, along with the reasoning
+     *   trace; only the generic "On it…" indicator shows while the agent works.
      *
      * MCP App widgets attached to a tool call are always rendered.
      */
@@ -581,6 +582,13 @@ interface WaniwaniChatOverrides {
      * tweak individual built-in strings without contributing a full locale.
      */
     messages?: MessageOverrides;
+    /**
+     * Opt out of the top-of-funnel `page.viewed` event fired once on mount.
+     * Defaults to `false` (the event fires). Set `true` on surfaces where a
+     * page view is meaningless and would pollute the customer's funnel — an
+     * already-authenticated app shell, an internal tool, a preview, etc.
+     */
+    disablePageView?: boolean;
 }
 /**
  * Hosted-tier WaniWani chat. The React counterpart to the `<script>` embed.