@askdialog/dialog-sdk 1.0.15 → 1.0.16

package/README.md

@@ -232,4 +232,31 @@ const client = new Dialog({
 });
 ```
 
+### Tracking
 
+Our SDK includes a tracking system to monitor user interactions in your purchase flow.
+
+#### Automatic Tracking
+
+When a user interacts with our assistant and clicks on an "Add to Cart" CTA, it automatically triggers the previously configured `addToCart` callback (see "Client Instantiation" section). These events are tracked internally by our system.
+
+#### Manual Tracking
+
+However, we cannot automatically detect cart additions or checkout completions that occur **after** using our assistant. To get accurate data in your Dialog dashboards, you should use the following tracking methods:
+
+#### Available Methods
+
+```typescript
+
+client.registerAddToCartEvent({
+    productId: 'ProductIdentifier', // {string} - Required
+    quantity: 1, // {number} - Required
+    variantId: 'VariantIdentifier' // {string} - Optional
+});
+
+client.registerSubmitCheckoutEvent({
+    productId: 'ProductIdentifier', // {string} - Required
+    quantity: 1, // {number} - Required
+    variantId: 'VariantIdentifier' // {string} - Optional
+});
+```

package/dist/Dialog.d.ts

@@ -32,10 +32,14 @@ export declare class Dialog {
     }): Promise<void>;
     registerAddToCartEvent({ productId, variantId, quantity, }: {
         productId: string;
-        variantId: string;
+        variantId?: string;
+        quantity: number;
+    }): void;
+    registerSubmitCheckoutEvent({ productId, variantId, quantity, }: {
+        productId: string;
+        variantId?: string;
         quantity: number;
     }): void;
-    registerSubmitCheckoutEvent(): 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":"AAEA,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;AAMpD,qBAAa,MAAM;IACjB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,UAAU,CAchB;IACF,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,SAAS,CAAW;gBAEhB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAc3E,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;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,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAItB,SAAS,CAAC,EACf,SAAS,EACT,QAAQ,EACR,SAAS,GACV,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIV,sBAAsB,CAAC,EAC5B,SAAS,EACT,SAAS,EACT,QAAQ,GACT,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI;IAQD,2BAA2B,IAAI,IAAI;IAI1C,OAAO,CAAC,cAAc;CA0BvB"}
+{"version":3,"file":"Dialog.d.ts","sourceRoot":"","sources":["../src/Dialog.ts"],"names":[],"mappings":"AAEA,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;AAMpD,qBAAa,MAAM;IACjB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IAExB,OAAO,CAAC,UAAU,CAchB;IACF,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,SAAS,CAAW;gBAEhB,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,iBAAiB;IAc3E,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,KAAK,IAAI,KAAK,CAExB;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAE1B;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,UAAU,CACf,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,iBAAiB,CAAC;IAIhB,SAAS,CAAC,EACrB,SAAS,EACT,QAAQ,EACR,SAAS,GACV,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMV,sBAAsB,CAAC,EAC5B,SAAS,EACT,SAAS,EACT,QAAQ,GACT,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI;IAUD,2BAA2B,CAAC,EACjC,SAAS,EACT,SAAS,EACT,QAAQ,GACT,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,IAAI;IAUR,OAAO,CAAC,cAAc;CA0BvB"}

package/dist/Dialog.js

@@ -77,18 +77,28 @@ export class Dialog {
     getProduct(productId, variantId) {
         return this._callbacks.getProduct(productId, variantId);
     }
-    addToCart({ productId, quantity, variantId, }) {
-        return this._callbacks.addToCart({ productId, variantId, quantity });
+    async addToCart({ productId, quantity, variantId, }) {
+        await this._callbacks.addToCart({ productId, variantId, quantity });
+        this.registerAddToCartEvent({ productId, variantId, quantity });
+        return;
     }
     registerAddToCartEvent({ productId, variantId, quantity, }) {
         this._tracking.track(TrackingEvents.USER_ADDED_TO_CART, {
+            user_id: this._userId,
             product_id: productId,
             variant_id: variantId,
             quantity,
+            locale: this._locale,
         });
     }
-    registerSubmitCheckoutEvent() {
-        this._tracking.track(TrackingEvents.USER_SUBMITTED_CHECKOUT);
+    registerSubmitCheckoutEvent({ productId, variantId, quantity, }) {
+        this._tracking.track(TrackingEvents.USER_SUBMITTED_CHECKOUT, {
+            user_id: this._userId,
+            product_id: productId,
+            variant_id: variantId,
+            quantity,
+            locale: this._locale,
+        });
     }
     _loadAssistant() {
         const localeInfo = getDetailedLocaleInfo(this._locale);

package/dist/Tracking.d.ts

@@ -3,6 +3,7 @@ export declare class Tracking {
     private _posthog;
     private readonly _token;
     private readonly _apiHost;
+    private readonly _apiKey;
     constructor(apiKey: string);
     track(event: TrackingEvents, properties?: Record<string, unknown>): void;
 }

package/dist/Tracking.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Tracking.d.ts","sourceRoot":"","sources":["../src/Tracking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqD;IAC5E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8B;gBAE3C,MAAM,EAAE,MAAM;IASnB,KAAK,CACV,KAAK,EAAE,cAAc,EACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,IAAI;CAGR"}
+{"version":3,"file":"Tracking.d.ts","sourceRoot":"","sources":["../src/Tracking.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAC/C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA8B;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,MAAM;IAUnB,KAAK,CACV,KAAK,EAAE,cAAc,EACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,IAAI;CASR"}

package/dist/Tracking.js

@@ -1,9 +1,12 @@
 import posthog from 'posthog-js';
+import { config } from './config';
 export class Tracking {
     _posthog;
-    _token = 'phc_EKMR6Jt4OTMEYmoUlz0v58KPwqcFxI7aZCLckpSD8Tv';
+    _token = config.posthogApiKey;
     _apiHost = 'https://eu.i.posthog.com';
+    _apiKey;
     constructor(apiKey) {
+        this._apiKey = apiKey;
         this._posthog = posthog.init(this._token, {
             api_host: this._apiHost,
         });
@@ -12,6 +15,12 @@ export class Tracking {
         });
     }
     track(event, properties) {
-        this._posthog.capture(event, properties);
+        const defaultProperties = {
+            $host: window.location.hostname,
+            $pathname: window.location.pathname,
+            url: window.location.href,
+            apiKey: this._apiKey,
+        };
+        this._posthog.capture(event, { ...defaultProperties, ...properties });
     }
 }

package/dist/config/config.development.d.ts

@@ -1,6 +1,7 @@
 export declare const config: {
     baseApiUrl: string;
     assistantUrl: string;
+    posthogApiKey: string;
 };
 export type Config = typeof config;
 //# sourceMappingURL=config.development.d.ts.map

package/dist/config/config.development.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.development.d.ts","sourceRoot":"","sources":["../../src/config/config.development.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}
+{"version":3,"file":"config.development.d.ts","sourceRoot":"","sources":["../../src/config/config.development.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAIlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}

package/dist/config/config.development.js

@@ -1,4 +1,5 @@
 export const config = {
     baseApiUrl: 'https://abkjr5ukvi.execute-api.eu-west-1.amazonaws.com',
     assistantUrl: 'https://d2bycosa71tnxv.cloudfront.net/assets/index.js',
+    posthogApiKey: 'phc_WM5MRkqG7AiqOKeTmNKj0fNIl41ZOQex7wRhEswRlTA',
 };

package/dist/config/config.production.d.ts

@@ -1,6 +1,7 @@
 export declare const config: {
     baseApiUrl: string;
     assistantUrl: string;
+    posthogApiKey: string;
 };
 export type Config = typeof config;
 //# sourceMappingURL=config.production.d.ts.map

package/dist/config/config.production.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.production.d.ts","sourceRoot":"","sources":["../../src/config/config.production.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}
+{"version":3,"file":"config.production.d.ts","sourceRoot":"","sources":["../../src/config/config.production.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAIlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}

package/dist/config/config.production.js

@@ -1,4 +1,5 @@
 export const config = {
     baseApiUrl: 'https://rtbzcxkmwj.execute-api.eu-west-1.amazonaws.com',
     assistantUrl: 'https://d2zm7i5bmzo6ze.cloudfront.net/assets/index.js',
+    posthogApiKey: 'phc_EKMR6Jt4OTMEYmoUlz0v58KPwqcFxI7aZCLckpSD8Tv'
 };

package/dist/config/index.d.ts

@@ -1,6 +1,7 @@
 export declare const config: {
     baseApiUrl: string;
     assistantUrl: string;
+    posthogApiKey: string;
 };
 export type Config = typeof config;
 //# sourceMappingURL=index.d.ts.map

package/dist/config/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/config/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAIlB,CAAC;AACF,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC"}

package/dist/config/index.js

@@ -1,4 +1,5 @@
 export const config = {
     baseApiUrl: 'https://rtbzcxkmwj.execute-api.eu-west-1.amazonaws.com',
     assistantUrl: 'https://d2zm7i5bmzo6ze.cloudfront.net/assets/index.js',
+    posthogApiKey: 'phc_EKMR6Jt4OTMEYmoUlz0v58KPwqcFxI7aZCLckpSD8Tv'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@askdialog/dialog-sdk",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "private": false,
   "description": "Dialog SDK",
   "main": "dist/index.js",