@magento/experience-platform-connector 1.0.0-alpha.1

package/src/handlers/__tests__/shoppingCartPageView.spec.js

@@ -0,0 +1,198 @@
+import handler from '../shoppingCartPageView';
+
+import miniCartViewEvent from './__mocks__/miniCartView';
+import cartPageViewEvent from './__mocks__/cartPageView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(cartPageViewEvent)).toBeTruthy();
+    });
+
+    it('returns false for non supported event types', () => {
+        expect(handler.canHandle(miniCartViewEvent)).toBeFalsy();
+    });
+});
+
+describe('handle()', () => {
+    it('calls the correct sdk functions with the correct context value', () => {
+        const mockSdk = {
+            context: {
+                setShoppingCart: jest.fn(),
+                setPage: jest.fn()
+            },
+            publish: {
+                shoppingCartView: jest.fn(),
+                pageView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, cartPageViewEvent);
+
+        expect(mockSdk.context.setShoppingCart).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setShoppingCart.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "giftMessageSelected": false,
+              "giftWrappingSelected": false,
+              "id": "kAR5Gg6uPC6J5wGY0ebecyKfX905epmU",
+              "items": Array [
+                Object {
+                  "configurableOptions": Array [
+                    Object {
+                      "id": 157,
+                      "optionLabel": "Fashion Color",
+                      "valueId": "Y29uZmlndXJhYmxlLzE1Ny8zMQ==",
+                      "valueLabel": "Peach",
+                    },
+                    Object {
+                      "id": 190,
+                      "optionLabel": "Fashion Size",
+                      "valueId": "Y29uZmlndXJhYmxlLzE5MC80Mw==",
+                      "valueLabel": "L",
+                    },
+                  ],
+                  "formattedPrice": "",
+                  "id": "MjQ2Ng==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 78,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 78,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": "rowena-skirt",
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/s/vsk02-ll_main_2.jpg",
+                    "name": "Rowena Skirt",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 78,
+                      "minimalPrice": 78,
+                      "regularPrice": 78,
+                    },
+                    "productType": "ConfigurableProduct",
+                    "sku": "VSK02",
+                  },
+                  "quantity": 1,
+                },
+                Object {
+                  "configurableOptions": null,
+                  "formattedPrice": "",
+                  "id": "MjQ4Mg==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 68,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 136,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": "silver-cirque-earrings",
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va17-si_main.jpg",
+                    "name": "Silver Cirque Earrings",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 68,
+                      "minimalPrice": 68,
+                      "regularPrice": 68,
+                    },
+                    "productType": "SimpleProduct",
+                    "sku": "VA17-SI-NA",
+                  },
+                  "quantity": 2,
+                },
+                Object {
+                  "configurableOptions": Array [
+                    Object {
+                      "id": 157,
+                      "optionLabel": "Fashion Color",
+                      "valueId": "Y29uZmlndXJhYmxlLzE1Ny8zMQ==",
+                      "valueLabel": "Peach",
+                    },
+                    Object {
+                      "id": 190,
+                      "optionLabel": "Fashion Size",
+                      "valueId": "Y29uZmlndXJhYmxlLzE5MC80NA==",
+                      "valueLabel": "M",
+                    },
+                  ],
+                  "formattedPrice": "",
+                  "id": "MjQ4Mw==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 48,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 144,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": "antonia-infinity-scarf",
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va04-ll_main_2.jpg",
+                    "name": "Antonia Infinity Scarf",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 48,
+                      "minimalPrice": 48,
+                      "regularPrice": 48,
+                    },
+                    "productType": "ConfigurableProduct",
+                    "sku": "VA04",
+                  },
+                  "quantity": 3,
+                },
+              ],
+              "possibleOnepageCheckout": false,
+              "prices": Object {
+                "subtotalExcludingTax": Object {
+                  "currency": "USD",
+                  "value": 358,
+                },
+              },
+            }
+        `);
+
+        expect(mockSdk.publish.shoppingCartView).toHaveBeenCalledTimes(1);
+
+        expect(mockSdk.context.setPage).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setPage.mock.calls[0][0]).toMatchInlineSnapshot(`
+            Object {
+              "eventType": "visibilityHidden",
+              "maxXOffset": 0,
+              "maxYOffset": 0,
+              "minXOffset": 0,
+              "minYOffset": 0,
+              "pageName": "Cart",
+              "pageType": "Cart",
+            }
+        `);
+
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+    });
+});

package/src/handlers/__tests__/shoppingMiniCartView.spec.js

@@ -0,0 +1,36 @@
+import handler from '../shoppingMiniCartView';
+
+import miniCartViewEvent from './__mocks__/miniCartView';
+import cartPageViewEvent from './__mocks__/cartPageView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(miniCartViewEvent)).toBeTruthy();
+    });
+
+    it('returns false for non supported event types', () => {
+        expect(handler.canHandle(cartPageViewEvent)).toBeFalsy();
+    });
+});
+
+describe('handle()', () => {
+    it('calls the correct sdk functions with the correct context value', () => {
+        const mockSdk = {
+            context: {
+                setShoppingCart: jest.fn()
+            },
+            publish: {
+                shoppingCartView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, miniCartViewEvent);
+
+        expect(mockSdk.context.setShoppingCart).toHaveBeenCalledTimes(1);
+        expect(
+            mockSdk.context.setShoppingCart.mock.calls[0][0]
+        ).toMatchSnapshot();
+
+        expect(mockSdk.publish.shoppingCartView).toHaveBeenCalledTimes(1);
+    });
+});

package/src/handlers/__tests__/signIn.spec.js

@@ -0,0 +1,73 @@
+import handler from '../signIn';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        const mockEvent = {
+            type: 'USER_SIGN_IN',
+            payload: {}
+        };
+        expect(handler.canHandle(mockEvent)).toBeTruthy();
+    });
+
+    it('returns false for non supported event types', () => {
+        const mockEvent = {
+            type: 'USER_SIGN_OUT',
+            payload: {}
+        };
+        expect(handler.canHandle(mockEvent)).toBeFalsy();
+    });
+});
+
+describe('handle()', () => {
+    it('calls the correct sdk functions with the correct context value', () => {
+        const mockSdk = {
+            context: {
+                setAccount: jest.fn(),
+                setShopper: jest.fn()
+            },
+            publish: {
+                signIn: jest.fn()
+            }
+        };
+
+        const mockEvent = {
+            type: 'USER_SIGN_IN',
+            payload: {
+                email: 'doctor.strange@fake.email',
+                firstname: 'Stephen',
+                is_subscribed: false,
+                lastname: 'Strange',
+                __typename: 'Customer'
+            }
+        };
+
+        handler.handle(mockSdk, mockEvent);
+
+        expect(mockSdk.context.setShopper).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setShopper.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "shopperId": "logged-in",
+            }
+        `);
+
+        expect(mockSdk.context.setAccount).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setAccount.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "emailAddress": "doctor.strange@fake.email",
+              "firstName": "Stephen",
+              "lastName": "Strange",
+            }
+        `);
+
+        expect(mockSdk.publish.signIn).toHaveBeenCalledTimes(1);
+        expect(mockSdk.publish.signIn.mock.calls[0][0]).toMatchInlineSnapshot(`
+            Object {
+              "personalEmail": Object {
+                "address": "doctor.strange@fake.email",
+              },
+            }
+        `);
+    });
+});

package/src/handlers/__tests__/startCheckout.spec.js

@@ -0,0 +1,193 @@
+import handler from '../startCheckout';
+import startCheckoutEvent from './__mocks__/checkoutPageView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(startCheckoutEvent)).toBeTruthy();
+    });
+
+    it('returns false for non supported event types', () => {
+        const mockEvent = {
+            type: 'USER_SIGN_OUT',
+            payload: {}
+        };
+        expect(handler.canHandle(mockEvent)).toBeFalsy();
+    });
+});
+
+describe('handle()', () => {
+    it('calls the correct sdk functions with the correct context value', () => {
+        const mockSdk = {
+            context: {
+                setPage: jest.fn(),
+                setShoppingCart: jest.fn()
+            },
+            publish: {
+                pageView: jest.fn(),
+                initiateCheckout: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, startCheckoutEvent);
+
+        expect(mockSdk.context.setPage).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setPage.mock.calls[0][0]).toMatchInlineSnapshot(`
+            Object {
+              "eventType": "visibilityHidden",
+              "maxXOffset": 0,
+              "maxYOffset": 0,
+              "minXOffset": 0,
+              "minYOffset": 0,
+              "pageName": "Checkout",
+              "pageType": "Checkout",
+            }
+        `);
+
+        expect(mockSdk.context.setShoppingCart).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setShoppingCart.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "giftMessageSelected": false,
+              "giftWrappingSelected": false,
+              "id": "adaIGWl4UsoKOGIeX17FPrnMq3bXHVZA",
+              "items": Array [
+                Object {
+                  "configurableOptions": Array [
+                    Object {
+                      "id": undefined,
+                      "optionLabel": "Fashion Color",
+                      "valueId": "Y29uZmlndXJhYmxlLzE1Ny8zNQ==",
+                      "valueLabel": "Mint",
+                    },
+                    Object {
+                      "id": undefined,
+                      "optionLabel": "Fashion Size",
+                      "valueId": "Y29uZmlndXJhYmxlLzE5MC80OQ==",
+                      "valueLabel": "6",
+                    },
+                  ],
+                  "formattedPrice": "",
+                  "id": "Mjk3Nw==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 98,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 294,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": undefined,
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/p/vp08-rn_main_2.jpg",
+                    "name": "Bella Eyelet Capris",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 98,
+                      "minimalPrice": 98,
+                      "regularPrice": 98,
+                    },
+                    "productType": "ConfigurableProduct",
+                    "sku": "VP08",
+                  },
+                  "quantity": 3,
+                },
+                Object {
+                  "configurableOptions": Array [
+                    Object {
+                      "id": undefined,
+                      "optionLabel": "Fashion Size",
+                      "valueId": "Y29uZmlndXJhYmxlLzE5MC80NA==",
+                      "valueLabel": "M",
+                    },
+                  ],
+                  "formattedPrice": "",
+                  "id": "Mjk3OQ==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 38,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 38,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": undefined,
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va09-br_main_2.jpg",
+                    "name": "Thin Leather Braided Belt",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 38,
+                      "minimalPrice": 38,
+                      "regularPrice": 38,
+                    },
+                    "productType": "ConfigurableProduct",
+                    "sku": "VA09",
+                  },
+                  "quantity": 1,
+                },
+                Object {
+                  "configurableOptions": null,
+                  "formattedPrice": "",
+                  "id": "Mjk4Nw==",
+                  "prices": Object {
+                    "__typename": "CartItemPrices",
+                    "price": Object {
+                      "__typename": "Money",
+                      "currency": "USD",
+                      "value": 98,
+                    },
+                    "row_total": Object {
+                      "__typename": "Money",
+                      "value": 98,
+                    },
+                    "total_item_discount": Object {
+                      "__typename": "Money",
+                      "value": 0,
+                    },
+                  },
+                  "product": Object {
+                    "canonicalUrl": undefined,
+                    "mainImageUrl": "https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va22-si_main.jpg",
+                    "name": "Silver Amor Bangle Set",
+                    "pricing": Object {
+                      "currencyCode": "USD",
+                      "maximalPrice": 98,
+                      "minimalPrice": 98,
+                      "regularPrice": 98,
+                    },
+                    "productType": "SimpleProduct",
+                    "sku": "VA22-SI-NA",
+                  },
+                  "quantity": 1,
+                },
+              ],
+              "possibleOnepageCheckout": false,
+              "prices": Object {
+                "subtotalExcludingTax": Object {
+                  "currency": "USD",
+                  "value": 430,
+                },
+              },
+            }
+        `);
+
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+        expect(mockSdk.publish.initiateCheckout).toHaveBeenCalledTimes(1);
+    });
+});

package/src/handlers/addToCart.js

@@ -0,0 +1,60 @@
+const canHandle = event => event.type === 'CART_ADD_ITEM';
+
+const handle = (sdk, event) => {
+    const { payload } = event;
+
+    const {
+        cartId,
+        currencyCode,
+        priceTotal,
+        quantity,
+        name,
+        sku,
+        selectedOptions
+    } = payload;
+
+    const configurableOptions = selectedOptions
+        ? [
+              {
+                  optionLabel: selectedOptions.attribute,
+                  valueLabel: selectedOptions.value
+              }
+          ]
+        : null;
+
+    const cartItemContext = {
+        id: cartId,
+        prices: {
+            subtotalExcludingTax: {
+                value: priceTotal * quantity,
+                currency: currencyCode
+            }
+        },
+        items: [
+            {
+                product: {
+                    name: name,
+                    sku: sku,
+                    configurableOptions: configurableOptions
+                },
+                prices: {
+                    price: {
+                        value: priceTotal,
+                        currency: currencyCode
+                    }
+                }
+            }
+        ],
+        possibleOnepageCheckout: false,
+        giftMessageSelected: false,
+        giftWrappingSelected: false
+    };
+
+    sdk.context.setShoppingCart(cartItemContext);
+    sdk.publish.addToCart();
+};
+
+export default {
+    canHandle,
+    handle
+};

package/src/handlers/categoryPageView.js

@@ -0,0 +1,34 @@
+const canHandle = event => event.type === 'CATEGORY_PAGE_VIEW';
+
+const handle = (sdk, event) => {
+    const { payload } = event;
+
+    const { name, url_key, url_path } = payload;
+
+    const categoryContext = {
+        name,
+        urlKey: url_key,
+        urlPath: url_path
+    };
+
+    sdk.context.setCategory(categoryContext);
+
+    // Send out page view event
+    const pageContext = {
+        pageType: 'Category',
+        pageName: name,
+        eventType: 'visibilityHidden',
+        maxXOffset: 0,
+        maxYOffset: 0,
+        minXOffset: 0,
+        minYOffset: 0
+    };
+
+    sdk.context.setPage(pageContext);
+    sdk.publish.pageView();
+};
+
+export default {
+    canHandle,
+    handle
+};

package/src/handlers/completeCheckout.js

@@ -0,0 +1,49 @@
+const canHandle = event => event.type === 'ORDER_CONFIRMATION_PAGE_VIEW';
+
+const handle = (sdk, event) => {
+    const { payload } = event;
+
+    const grandTotal = payload.amount.grand_total.value;
+
+    const { order_number, payment, shipping } = payload;
+
+    const orderContext = {
+        orderId: order_number,
+        grandTotal: grandTotal,
+        orderType: 'checkout',
+        payments: [
+            {
+                paymentMethodCode: payment.title,
+                paymentMethodName: payment.title,
+                total: grandTotal
+            }
+        ],
+        shipping: {
+            shippingMethod: shipping[0].method_title,
+            shippingAmount: shipping[0].amount.value
+        }
+    };
+
+    sdk.context.setOrder(orderContext);
+
+    sdk.publish.placeOrder();
+
+    // Send out page view event
+    const pageContext = {
+        pageType: 'Order Confirmation Page',
+        pageName: 'Order Confirmation',
+        eventType: 'visibilityHidden',
+        maxXOffset: 0,
+        maxYOffset: 0,
+        minXOffset: 0,
+        minYOffset: 0
+    };
+
+    sdk.context.setPage(pageContext);
+    sdk.publish.pageView();
+};
+
+export default {
+    canHandle,
+    handle
+};

package/src/handlers/createAccount.js

@@ -0,0 +1,25 @@
+const canHandle = event => event.type === 'USER_CREATE_ACCOUNT';
+
+const handle = (sdk, event) => {
+    const { payload } = event;
+
+    const { firstName, lastName, email } = payload;
+
+    const accountContext = {
+        firstName,
+        lastName,
+        emailAddress: email
+    };
+
+    sdk.context.setAccount(accountContext);
+    sdk.publish.createAccount({
+        personalEmail: {
+            address: email
+        }
+    });
+};
+
+export default {
+    canHandle,
+    handle
+};