@askdialog/dialog-sdk 2.1.0 → 2.3.0

package/README.md

@@ -338,12 +338,25 @@ client.registerAddToCartEvent({
     price: '12.00' // {string} - Optional
 });
 
+// Checkout is order-level: call ONCE per completed order with the order total.
+// `orderValue` is what the "Revenue generated" dashboard reads.
+// Do NOT call this per line item — without an order total, revenue resolves to 0.
 client.registerSubmitCheckoutEvent({
-    productId: 'ProductIdentifier', // {string} - Required
-    quantity: 1, // {number} - Required
-    price: '12.00', // {string} - Required
+    orderValue: 59.98, // {number} - Required - the order total
     currency: 'EUR', // {string} - Optional
-    variantId: 'VariantIdentifier' // {string} - Optional
+    transactionId: 'OrderIdentifier', // {string} - Optional - order id, used to de-duplicate reloads
+    items: [ // {array} - Optional - line items, for product-level attribution only
+        { productId: 'ProductIdentifier', quantity: 1, price: 29.99, variantId: 'VariantIdentifier' },
+    ],
+});
+
+// Deprecated per-line signature — still accepted for backward compatibility,
+// but carries no order total so revenue cannot be computed. Prefer the call above.
+client.registerSubmitCheckoutEvent({
+    productId: 'ProductIdentifier',
+    quantity: 1,
+    price: '12.00',
+    currency: 'EUR',
 });
 ```
 

package/dist/Dialog.d.ts

@@ -2,7 +2,7 @@ import { DialogConstructor } from "./types/constructor";
 import { Theme } from "./types/theme";
 import { DetailedLocaleInfo } from "./utils/localization";
 import { Suggestion } from "./types/suggestion";
-import { GenericQuestionPayload, OpenAssistantPayload, ProductQuestionPayload } from "./types/events";
+import { GenericQuestionPayload, LegacyCheckoutParams, OpenAssistantPayload, ProductQuestionPayload, SubmitCheckoutParams } from "./types/events";
 import { SimplifiedProduct } from "./types/product";
 import { EventsHandler } from "./EventsHandler";
 import { AssistantEvent } from "./types/assistantEvent";
@@ -45,13 +45,7 @@ export declare class Dialog {
         currency?: string;
         variantId?: string;
     }): void;
-    registerSubmitCheckoutEvent({ productId, quantity, currency, variantId, price, }: {
-        productId: string;
-        quantity: number;
-        price: string;
-        currency?: string;
-        variantId?: string;
-    }): void;
+    registerSubmitCheckoutEvent(params: SubmitCheckoutParams | LegacyCheckoutParams): void;
     private _loadAssistant;
 }
 //# sourceMappingURL=Dialog.d.ts.map

package/dist/Dialog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Dialog.d.ts","sourceRoot":"","sources":["../src/Dialog.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAEL,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,qBAAa,MAAM;IACjB,gBAAuB,OAAO,SAAuB;IAErD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,UAAU,CAGhB;IACF,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;gBAE1B,EACV,MAAM,EACN,MAAM,EACN,WAAW,EACX,SAAS,EACT,KAAK,EACL,MAAM,GACP,EAAE,iBAAiB;IAepB,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,aAAa,IAAI,aAAa,CAExC;IAEM,2BAA2B,IAAI,kBAAkB,GAAG,IAAI;IAI/D,OAAO,CAAC,uBAAuB;IAkBlB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAK5D,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAKjD,cAAc,IAAI,IAAI;IAItB,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIxD,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAOxD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAIjE,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAInD,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAIhB,SAAS,CAAC,EACrB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBV,sBAAsB,CAAC,EAC5B,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAWD,2BAA2B,CAAC,EACjC,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAWR,OAAO,CAAC,cAAc;CA4BvB"}
+{"version":3,"file":"Dialog.d.ts","sourceRoot":"","sources":["../src/Dialog.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAEL,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,qBAAa,MAAM;IACjB,gBAAuB,OAAO,SAAuB;IAErD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAC,CAAS;IAE9B,OAAO,CAAC,UAAU,CAGhB;IACF,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;gBAE1B,EACV,MAAM,EACN,MAAM,EACN,WAAW,EACX,SAAS,EACT,KAAK,EACL,MAAM,GACP,EAAE,iBAAiB;IAYpB,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,aAAa,IAAI,aAAa,CAExC;IAEM,2BAA2B,IAAI,kBAAkB,GAAG,IAAI;IAI/D,OAAO,CAAC,uBAAuB;IAkBlB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAK5D,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,IAAI;IAKjD,cAAc,IAAI,IAAI;IAItB,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAIxD,kBAAkB,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI;IAOxD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAIjE,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAInD,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAIhB,SAAS,CAAC,EACrB,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBV,sBAAsB,CAAC,EAC5B,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,IAAI;IAkBD,2BAA2B,CAChC,MAAM,EAAE,oBAAoB,GAAG,oBAAoB,GAClD,IAAI;IA0BP,OAAO,CAAC,cAAc;CA4BvB"}

package/dist/Dialog.js

@@ -8,6 +8,7 @@ import { DialogEvents, } from "./types/events";
 import { EventsHandler } from "./EventsHandler";
 import { loadSuggestions } from "./services/suggestions";
 import { config } from "./config";
+import { exposeSdkOnWindowDialog } from "./windowAudit";
 export class Dialog {
     static VERSION = packageJson.version;
     _apiKey;
@@ -25,10 +26,7 @@ export class Dialog {
         this._theme = { ...defaultTheme, ...theme };
         this._userId = this._createOrRetrieveUserId(userId);
         this._eventsHandler = new EventsHandler(locale, userId);
-        window.dialog = {
-            instance: this,
-            version: Dialog.VERSION,
-        };
+        exposeSdkOnWindowDialog(this, Dialog.VERSION);
         this._loadAssistant();
     }
     get apiKey() {
@@ -115,14 +113,31 @@ export class Dialog {
             currency,
         });
     }
-    registerSubmitCheckoutEvent({ productId, quantity, currency, variantId, price, }) {
+    // Order-level: call ONCE per completed order with the order total.
+    // `orderValue` is what the dashboard's "Revenue generated" reads — do not
+    // call this per line item (that has no total and revenue resolves to 0).
+    //
+    // The legacy per-line signature (`{ productId, quantity, price }`) is still
+    // accepted for backward compatibility so existing installs keep working
+    // after an upgrade, but it is deprecated: it carries no order total.
+    registerSubmitCheckoutEvent(params) {
+        if ("orderValue" in params) {
+            this._eventsHandler.emitExternalEvent(DialogEvents.TRACK_SUBMIT_CHECKOUT, {
+                userId: this._userId,
+                orderValue: params.orderValue,
+                currency: params.currency,
+                transactionId: params.transactionId,
+                items: params.items,
+            });
+            return;
+        }
         this._eventsHandler.emitExternalEvent(DialogEvents.TRACK_SUBMIT_CHECKOUT, {
             userId: this._userId,
-            productId,
-            variantId,
-            quantity,
-            price,
-            currency,
+            productId: params.productId,
+            variantId: params.variantId,
+            quantity: params.quantity,
+            price: params.price,
+            currency: params.currency,
         });
     }
     _loadAssistant() {

package/dist/__tests__/windowAudit.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=windowAudit.spec.d.ts.map

package/dist/__tests__/windowAudit.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"windowAudit.spec.d.ts","sourceRoot":"","sources":["../../src/__tests__/windowAudit.spec.ts"],"names":[],"mappings":""}

package/dist/__tests__/windowAudit.spec.js

@@ -0,0 +1,87 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { addAuditCapability, exposeSdkOnWindowDialog, registerDialogInstallation, } from "../windowAudit";
+const globalWithWindow = globalThis;
+const getAudit = () => globalWithWindow.window?.dialog?.audit;
+const fakeInstance = { apiKey: "test" };
+beforeEach(() => {
+    globalWithWindow.window = {};
+});
+afterEach(() => {
+    delete globalWithWindow.window;
+    vi.clearAllMocks();
+});
+describe("exposeSdkOnWindowDialog", () => {
+    it("exposes instance and version when window.dialog is absent", () => {
+        exposeSdkOnWindowDialog(fakeInstance, "2.1.0");
+        const dialog = globalWithWindow.window?.dialog;
+        expect(dialog?.instance).toBe(fakeInstance);
+        expect(dialog?.version).toBe("2.1.0");
+        expect(getAudit()?.methods[0]).toMatchObject({
+            method: "sdk",
+            version: "2.1.0",
+        });
+    });
+    it("preserves keys owned by GTM (setVariant/getVariant/_queue)", () => {
+        const setVariant = vi.fn();
+        const getVariant = vi.fn();
+        const queue = [["setVariant", { variantId: "VAR_1" }]];
+        globalWithWindow.window = {
+            dialog: { setVariant, getVariant, _queue: queue },
+        };
+        exposeSdkOnWindowDialog(fakeInstance, "2.1.0");
+        const dialog = globalWithWindow.window.dialog;
+        expect(dialog?.setVariant).toBe(setVariant);
+        expect(dialog?.getVariant).toBe(getVariant);
+        expect(dialog?._queue).toBe(queue);
+        expect(dialog?.instance).toBe(fakeInstance);
+        expect(getAudit()?.methods[0]).toMatchObject({
+            method: "sdk",
+            version: "2.1.0",
+        });
+    });
+    it("preserves audit entries registered by another path and warns on coexistence", () => {
+        registerDialogInstallation({ method: "gtm", source: "dialog-instant.js" });
+        exposeSdkOnWindowDialog(fakeInstance, "2.1.0");
+        const audit = getAudit();
+        expect(audit?.methods.map((entry) => entry.method)).toEqual(["gtm", "sdk"]);
+        expect(audit?.warnings).toEqual([
+            "multiple installation methods detected: gtm, sdk",
+        ]);
+    });
+    it("does not duplicate the sdk entry when instantiated twice", () => {
+        exposeSdkOnWindowDialog(fakeInstance, "2.1.0");
+        exposeSdkOnWindowDialog(fakeInstance, "2.1.0");
+        expect(getAudit()?.methods).toHaveLength(1);
+    });
+    it("is a no-op without a window (SSR safety)", () => {
+        delete globalWithWindow.window;
+        expect(() => exposeSdkOnWindowDialog(fakeInstance, "2.1.0")).not.toThrow();
+        expect(() => addAuditCapability("pdp-block")).not.toThrow();
+    });
+});
+describe("registerDialogInstallation", () => {
+    it("only fills missing fields on re-registration of the same method", () => {
+        registerDialogInstallation({ method: "react", version: "2.0.2" });
+        registerDialogInstallation({ method: "react", version: "9.9.9" });
+        expect(getAudit()?.methods).toHaveLength(1);
+        expect(getAudit()?.methods[0]?.version).toBe("2.0.2");
+    });
+    it("fills missing nested build fields without erasing existing ones", () => {
+        registerDialogInstallation({ method: "gtm", build: { commit: "abc1234" } });
+        registerDialogInstallation({
+            method: "gtm",
+            build: { commit: "fff9999", version: "1.2.3" },
+        });
+        expect(getAudit()?.methods[0]?.build).toEqual({
+            commit: "abc1234",
+            version: "1.2.3",
+        });
+    });
+});
+describe("addAuditCapability", () => {
+    it("adds capabilities without duplicates", () => {
+        addAuditCapability("pdp-block");
+        addAuditCapability("pdp-block");
+        expect(getAudit()?.capabilities).toEqual(["pdp-block"]);
+    });
+});

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./Dialog";
 export * from "./EventsHandler";
 export * from "./types";
+export * from "./windowAudit";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,SAAS,CAAC;AACxB,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -1,3 +1,4 @@
 export * from "./Dialog";
 export * from "./EventsHandler";
 export * from "./types";
+export * from "./windowAudit";

package/dist/types/events.d.ts

@@ -42,7 +42,38 @@ export interface TrackEventPayload {
     price?: string;
     currency?: string;
 }
-export type DialogEventPayload = ProductQuestionPayload | GenericQuestionPayload | DiagnosticPayload | OpenAssistantPayload | TrackEventPayload;
+export interface CheckoutLineItem {
+    productId: string;
+    variantId?: string;
+    quantity: number;
+    price?: number;
+}
+export interface SubmitCheckoutEventPayload {
+    userId?: string;
+    orderValue: number;
+    currency?: string;
+    transactionId?: string;
+    items?: CheckoutLineItem[];
+}
+export interface SubmitCheckoutParams {
+    orderValue: number;
+    currency?: string;
+    transactionId?: string;
+    items?: CheckoutLineItem[];
+}
+/**
+ * @deprecated Per-line checkout has no order total, so "Revenue generated"
+ * resolves to 0. Pass the order total via {@link SubmitCheckoutParams} instead,
+ * once per completed order.
+ */
+export interface LegacyCheckoutParams {
+    productId: string;
+    quantity: number;
+    price?: string;
+    currency?: string;
+    variantId?: string;
+}
+export type DialogEventPayload = ProductQuestionPayload | GenericQuestionPayload | DiagnosticPayload | OpenAssistantPayload | TrackEventPayload | SubmitCheckoutEventPayload;
 export interface DialogEvent<T = DialogEventPayload> {
     type: DialogEvents;
     payload: T;

package/dist/types/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,oBAAY,YAAY;IACtB,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,qBAAqB;IACjC,qBAAqB,qBAAqB;IAC1C,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;CAChD;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG,cAAc,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,oBAAoB,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAMD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,kBAAkB,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,GACpB,iBAAiB,CAAC;AAEtB,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,kBAAkB;IACjD,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC;CACZ"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,+BAA+B,CAAC;AAEhE,oBAAY,YAAY;IACtB,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,YAAY,qBAAqB;IACjC,qBAAqB,qBAAqB;IAC1C,iBAAiB,sBAAsB;IACvC,qBAAqB,0BAA0B;CAChD;AACD,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG,cAAc,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,oBAAoB,CAAC;IACjC,GAAG,EAAE,MAAM,CAAC;CACb;AAQD,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAKD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAOD,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAGD,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAC1B,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,GACpB,iBAAiB,GACjB,0BAA0B,CAAC;AAE/B,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,kBAAkB;IACjD,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC;CACZ"}

package/dist/types/global.d.ts

@@ -1,10 +1,12 @@
 import { Dialog } from "../Dialog";
+import { DialogAudit } from "../windowAudit";
 declare global {
     interface Window {
         dialog?: {
             instance?: Dialog;
             version?: string;
-        };
+            audit?: DialogAudit;
+        } & Record<string, unknown>;
     }
 }
 export {};

package/dist/types/global.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../src/types/global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,MAAM,CAAC,EAAE;YACP,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;KACH;CACF;AAED,OAAO,EAAE,CAAC"}
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../src/types/global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QAGd,MAAM,CAAC,EAAE;YACP,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,WAAW,CAAC;SACrB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAC7B;CACF;AAED,OAAO,EAAE,CAAC"}

package/dist/windowAudit.d.ts

@@ -0,0 +1,41 @@
+import type { Dialog } from "./Dialog";
+/**
+ * Miniature copy of the window.dialog.audit merge helper — canonical source:
+ * dialog-ecom/packages/lib-dialog-window (contract: dialogAuditSchema in
+ * dialog-ecom's @dialog/shared-schemas). Kept in sync by hand: the surface is
+ * public and additive-only — never overwrite keys owned by other installation
+ * paths (GTM setVariant/getVariant/_queue, widget audit entries).
+ */
+export type DialogInstallationMethod = "shopify-extension" | "gtm" | "sdk" | "react" | "vue" | "prestashop";
+export type DialogAuditCapability = "setVariant" | "assistant-modal" | "assistant-bar" | "pdp-block";
+export interface DialogAuditMethodEntry {
+    method: DialogInstallationMethod;
+    version?: string;
+    build?: {
+        version?: string;
+        commit?: string;
+    };
+    source?: string;
+    registeredAt: string;
+}
+export interface DialogAudit {
+    methods: DialogAuditMethodEntry[];
+    context: {
+        hostname?: string;
+        platform?: string;
+        organizationSlug?: string;
+    };
+    capabilities: DialogAuditCapability[];
+    consent?: unknown;
+    warnings: string[];
+}
+export type DialogInstallationEntryInput = Omit<DialogAuditMethodEntry, "registeredAt">;
+export declare const registerDialogInstallation: (entry: DialogInstallationEntryInput) => void;
+export declare const addAuditCapability: (capability: DialogAuditCapability) => void;
+/**
+ * Exposes the SDK on window.dialog without erasing fields owned by other
+ * installation paths (e.g. GTM's setVariant/getVariant), then registers the
+ * sdk entry in window.dialog.audit.
+ */
+export declare const exposeSdkOnWindowDialog: (instance: Dialog, version: string) => void;
+//# sourceMappingURL=windowAudit.d.ts.map

package/dist/windowAudit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"windowAudit.d.ts","sourceRoot":"","sources":["../src/windowAudit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAChC,mBAAmB,GACnB,KAAK,GACL,KAAK,GACL,OAAO,GACP,KAAK,GACL,YAAY,CAAC;AAEjB,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,WAAW,CAAC;AAEhB,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,wBAAwB,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,OAAO,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,YAAY,EAAE,qBAAqB,EAAE,CAAC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,sBAAsB,EACtB,cAAc,CACf,CAAC;AAwDF,eAAO,MAAM,0BAA0B,GACrC,OAAO,4BAA4B,KAClC,IAmBF,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,YAAY,qBAAqB,KAAG,IAQtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAClC,UAAU,MAAM,EAChB,SAAS,MAAM,KACd,IAUF,CAAC"}

package/dist/windowAudit.js

@@ -0,0 +1,78 @@
+const MULTIPLE_METHODS_WARNING_PREFIX = "multiple installation methods detected:";
+const getHost = () => typeof window === "undefined"
+    ? undefined
+    : window;
+const ensureAudit = () => {
+    const host = getHost();
+    if (host === undefined) {
+        return undefined;
+    }
+    host.dialog = host.dialog ?? {};
+    host.dialog.audit = host.dialog.audit ?? {
+        methods: [],
+        context: {},
+        capabilities: [],
+        warnings: [],
+    };
+    return host.dialog.audit;
+};
+const refreshCoexistenceWarning = (audit) => {
+    audit.warnings = audit.warnings.filter((warning) => !warning.startsWith(MULTIPLE_METHODS_WARNING_PREFIX));
+    if (audit.methods.length >= 2) {
+        const methods = audit.methods.map((entry) => entry.method).join(", ");
+        audit.warnings.push(`${MULTIPLE_METHODS_WARNING_PREFIX} ${methods}`);
+    }
+};
+// First write wins per nested field: an existing partial build (e.g. commit
+// only) never blocks a later registration from filling the missing fields.
+const mergeBuildFields = (existing, entry) => {
+    if (entry === undefined) {
+        return existing;
+    }
+    return {
+        version: existing?.version ?? entry.version,
+        commit: existing?.commit ?? entry.commit,
+    };
+};
+export const registerDialogInstallation = (entry) => {
+    const audit = ensureAudit();
+    if (audit === undefined) {
+        return;
+    }
+    const existing = audit.methods.find((candidate) => candidate.method === entry.method);
+    if (existing === undefined) {
+        audit.methods.push({ ...entry, registeredAt: new Date().toISOString() });
+        refreshCoexistenceWarning(audit);
+        return;
+    }
+    // First write wins per field: a later registration only fills gaps and
+    // never erases what another script recorded.
+    existing.version = existing.version ?? entry.version;
+    existing.build = mergeBuildFields(existing.build, entry.build);
+    existing.source = existing.source ?? entry.source;
+};
+export const addAuditCapability = (capability) => {
+    const audit = ensureAudit();
+    if (audit === undefined) {
+        return;
+    }
+    if (!audit.capabilities.includes(capability)) {
+        audit.capabilities.push(capability);
+    }
+};
+/**
+ * Exposes the SDK on window.dialog without erasing fields owned by other
+ * installation paths (e.g. GTM's setVariant/getVariant), then registers the
+ * sdk entry in window.dialog.audit.
+ */
+export const exposeSdkOnWindowDialog = (instance, version) => {
+    if (typeof window === "undefined") {
+        return;
+    }
+    window.dialog = {
+        ...window.dialog,
+        instance,
+        version,
+    };
+    registerDialogInstallation({ method: "sdk", version });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@askdialog/dialog-sdk",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "private": false,
   "description": "Dialog SDK",
   "main": "dist/index.js",
@@ -28,7 +28,8 @@
   "devDependencies": {
     "esbuild": "^0.25.12",
     "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0"
+    "eslint-plugin-import": "^2.32.0",
+    "vitest": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
@@ -44,6 +45,7 @@
     "build:prod": "pnpm run clean && pnpm run set-config production && tsc",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
+    "test": "vitest run",
     "test-type": "tsc --noEmit",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink",