@askdialog/dialog-sdk 1.0.11 → 1.0.13

package/README.md

@@ -37,8 +37,19 @@ const client = new Dialog({
   apiKey: 'YOUR_API_KEY', // required
   locale: 'TARGETED_LOCALE', // required
   callbacks: {
-    addToCart: () => Promise<void>, // required
-    getProduct: () => Promise<Product>, // required
+    addToCart: async ({
+    productId,
+    quantity,
+    variantId,
+  }: {
+    productId: string;
+    quantity: number;
+    variantId?: string;
+  }) => Promise<void>, // required
+    getProduct: async (
+        productId: string,
+        variantId?: string
+    ) => Promise<SimplifiedProduct>, // required
   },
 });
 ```
@@ -48,7 +59,7 @@ The locale specifies the language you want to use.
 The addToCart function is triggered when a user clicks the AddToCart button.
 The getProduct function is used to display product information in the assistant.
 
-When the client is instantiated, it will automatically insert in the DOM the Dialog Assistant script, so you can interact with the assistant with `sendProductMessage` and `sendGenericMessage`.
+When the client is instantiated, it will automatically insert into the DOM the Dialog Assistant script, so you can interact with the assistant using `sendProductMessage` or `sendGenericMessage`.
 
 ### Getters
 
@@ -130,12 +141,16 @@ Example of expected result:
 const client = new Dialog({
     ...,
     callbacks: {
-        getProduct: () => {
-            // Call your api to retrieve product information
-            const response = await fetch('....');
-            const data = await response.json();
-            // To define
-            return {};
+        getProduct: (
+            productId: string,
+            variantId?: string): Promise<SimplifiedProduct> => {
+                // Call your api to retrieve product information
+                const response = await fetch('....');
+                const data = await response.json();
+                // Need to match SimplifiedProduct type
+                return {
+                    ...
+                };
         }
     },
 });
@@ -147,7 +162,15 @@ const client = new Dialog({
 const client = new Dialog({
     ...,
     callbacks: {
-        addToCart: () => {
+        addToCart: ({
+            productId,
+            quantity,
+            variantId,
+        }: {
+            productId: string;
+            quantity: number;
+            variantId?: string;
+        }): Promise<void> => {
             // Call your api to trigger addToCart
             const response = await fetch('....');
 
@@ -161,10 +184,10 @@ const client = new Dialog({
 
 ### Theming (Still in construction)
 
-We are currently working on the theming part so you may find some issues. Contact us if you need more customisation.
+We are currently working on the theming part so you may find some issues. Contact us if you need more customization.
 
 
-⚠️ Title, description and content properties are used only to theme the vue component for the moment.
+⚠️ Title, description and content properties are used only to theme the Vue component for the moment.
 
 ```typescript
 const client = new Dialog({

package/dist/Dialog.d.ts

@@ -25,10 +25,10 @@ export declare class Dialog {
     sendProductMessage(params: ProductQuestionPayload): void;
     sendGenericMessage(params: GenericQuestionPayload): void;
     getProduct(productId: string, variantId?: string): Promise<SimplifiedProduct>;
-    addToCart({ productId, variantId, quantity, }: {
+    addToCart({ productId, quantity, variantId, }: {
         productId: string;
-        variantId: string;
         quantity: number;
+        variantId?: string;
     }): Promise<void>;
     registerAddToCartEvent({ productId, variantId, quantity, }: {
         productId: string;

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,SAAS,EACT,QAAQ,GACT,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;KAClB,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;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"}

package/dist/Dialog.js

@@ -77,7 +77,7 @@ export class Dialog {
     getProduct(productId, variantId) {
         return this._callbacks.getProduct(productId, variantId);
     }
-    addToCart({ productId, variantId, quantity, }) {
+    addToCart({ productId, quantity, variantId, }) {
         return this._callbacks.addToCart({ productId, variantId, quantity });
     }
     registerAddToCartEvent({ productId, variantId, quantity, }) {

package/dist/types/constructor.d.ts

@@ -4,10 +4,10 @@ export interface DialogConstructor {
     apiKey: string;
     locale: string;
     callbacks: {
-        addToCart: ({ productId, variantId, quantity, }: {
+        addToCart: ({ productId, quantity, variantId, }: {
             productId: string;
-            variantId: string;
             quantity: number;
+            variantId?: string;
         }) => Promise<void>;
         getProduct: (productId: string, variantId?: string) => Promise<SimplifiedProduct>;
     };

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

@@ -1 +1 @@
-{"version":3,"file":"constructor.d.ts","sourceRoot":"","sources":["../../src/types/constructor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE;QACT,SAAS,EAAE,CAAC,EACV,SAAS,EACT,SAAS,EACT,QAAQ,GACT,EAAE;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,SAAS,EAAE,MAAM,CAAC;YAClB,QAAQ,EAAE,MAAM,CAAC;SAClB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,UAAU,EAAE,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,KACf,OAAO,CAAC,iBAAiB,CAAC,CAAC;KACjC,CAAC;IACF,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"constructor.d.ts","sourceRoot":"","sources":["../../src/types/constructor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE;QACT,SAAS,EAAE,CAAC,EACV,SAAS,EACT,QAAQ,EACR,SAAS,GACV,EAAE;YACD,SAAS,EAAE,MAAM,CAAC;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,UAAU,EAAE,CACV,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,KACf,OAAO,CAAC,iBAAiB,CAAC,CAAC;KACjC,CAAC;IACF,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/package.json

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