@waniwani/sdk 0.12.18 → 0.13.0

package/dist/legacy/index.d.ts

@@ -132,7 +132,7 @@ 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";
+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";
 interface ToolCalledProperties {
     name?: string;
     type?: "pricing" | "product_info" | "availability" | "support" | "other";
@@ -148,6 +148,34 @@ interface PurchaseCompletedProperties {
     amount?: number;
     currency?: string;
 }
+interface PriceShownProperties {
+    amount: number;
+    currency: string;
+    itemId?: string;
+    label?: string;
+}
+interface ComparedPriceOption {
+    id: string;
+    amount: number;
+    currency: string;
+}
+interface PricesComparedProperties {
+    options: ComparedPriceOption[];
+}
+interface OptionSelectedProperties {
+    id: string;
+    amount: number;
+    currency: string;
+}
+interface LeadProperties {
+    source?: string;
+}
+interface ConvertedProperties {
+    amount: number;
+    currency: string;
+    /** When the conversion actually happened — for backdated off-platform sales. */
+    occurredAt?: string;
+}
 interface TrackingContext {
     /**
      * MCP request metadata passed through to the API.
@@ -197,6 +225,21 @@ type TrackEvent = ({
     properties?: PurchaseCompletedProperties;
 } & BaseTrackEvent) | ({
     event: "user.identified";
+} & BaseTrackEvent) | ({
+    event: "price_shown";
+    properties?: PriceShownProperties;
+} & BaseTrackEvent) | ({
+    event: "prices_compared";
+    properties?: PricesComparedProperties;
+} & BaseTrackEvent) | ({
+    event: "option_selected";
+    properties?: OptionSelectedProperties;
+} & BaseTrackEvent) | ({
+    event: "lead";
+    properties?: LeadProperties;
+} & BaseTrackEvent) | ({
+    event: "converted";
+    properties?: ConvertedProperties;
 } & BaseTrackEvent);
 /**
  * Legacy tracking shape supported for existing integrations.
@@ -216,6 +259,54 @@ interface LegacyTrackEvent extends TrackingContext {
  * Public track input accepted by `client.track()`.
  */
 type TrackInput = TrackEvent | LegacyTrackEvent;
+interface RevenuePriceShownInput extends TrackingContext, PriceShownProperties {
+}
+interface RevenuePricesComparedInput extends TrackingContext, PricesComparedProperties {
+}
+interface RevenueOptionSelectedInput extends TrackingContext, OptionSelectedProperties {
+}
+/**
+ * Input for `track.lead()`. `source` is the lead's acquisition source
+ * (the `lead` event property, e.g. "newsletter") — on this helper it shadows
+ * the envelope `source` from the tracking context. To set a custom envelope
+ * source on a lead, use the generic `track({ event: "lead", … })`.
+ */
+interface RevenueLeadInput extends TrackingContext, LeadProperties {
+}
+interface RevenueConvertedInput extends TrackingContext, ConvertedProperties {
+}
+/**
+ * Revenue-oriented helpers, flat on `client.track.*` (e.g.
+ * `client.track.priceShown()`, `client.track.converted()`). Decoupled from
+ * product primitives — each maps to a typed first-class revenue event.
+ */
+interface RevenueTrackingApi {
+    priceShown: (input: RevenuePriceShownInput) => Promise<{
+        eventId: string;
+    }>;
+    pricesCompared: (input: RevenuePricesComparedInput) => Promise<{
+        eventId: string;
+    }>;
+    optionSelected: (input: RevenueOptionSelectedInput) => Promise<{
+        eventId: string;
+    }>;
+    lead: (input?: RevenueLeadInput) => Promise<{
+        eventId: string;
+    }>;
+    converted: (input: RevenueConvertedInput) => Promise<{
+        eventId: string;
+    }>;
+}
+/**
+ * `client.track` — callable for generic events (`track(event)`), with the
+ * revenue helpers attached flat: `track.priceShown()`, `track.lead()`,
+ * `track.converted()`, etc.
+ */
+interface TrackFn extends RevenueTrackingApi {
+    (event: TrackInput): Promise<{
+        eventId: string;
+    }>;
+}
 interface TrackingConfig {
     /** Events API V2 endpoint path. */
     endpointPath?: string;
@@ -255,10 +346,11 @@ interface TrackingClient {
     /**
      * Track an event using modern or legacy input shape.
      * Returns a deterministic event id immediately after enqueue.
+     *
+     * Also exposes the revenue helpers flat: `client.track.priceShown()`,
+     * `client.track.lead()`, `client.track.converted()`, etc.
      */
-    track: (event: TrackInput) => Promise<{
-        eventId: string;
-    }>;
+    track: TrackFn;
     /**
      * Flush all currently buffered events.
      */
@@ -276,10 +368,12 @@ interface TrackingClient {
  * when the server is wrapped with `withWaniwani()`.
  */
 interface ScopedWaniWaniClient {
-    /** Track an event — request meta is automatically merged. */
-    track(event: TrackInput): Promise<{
-        eventId: string;
-    }>;
+    /**
+     * Track an event — request meta is automatically merged. Also exposes the
+     * revenue helpers flat (`track.priceShown()`, `track.converted()`, …), which
+     * inherit the same scoped meta (so identity is carried from the request).
+     */
+    track: TrackFn;
     /** Identify a user — request meta is automatically merged. */
     identify(userId: string, properties?: Record<string, unknown>): Promise<{
         eventId: string;