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

package/src/handlers/__tests__/__mocks__/orderConfirmationPageView.js

@@ -0,0 +1,67 @@
+export default {
+    type: 'ORDER_CONFIRMATION_PAGE_VIEW',
+    payload: {
+        order_number: '000000267',
+        cart_id: 'I3XbPvRJhujwf2C2MWhevLgifr9xyXpL',
+        amount: {
+            grand_total: {
+                value: 84.53,
+                currency: 'USD',
+                __typename: 'Money'
+            },
+            discounts: null,
+            __typename: 'CartPrices'
+        },
+        shipping: [
+            {
+                amount: {
+                    value: 0,
+                    currency: 'USD',
+                    __typename: 'Money'
+                },
+                carrier_title: 'Free Shipping',
+                method_title: 'Free',
+                __typename: 'SelectedShippingMethod'
+            }
+        ],
+        payment: {
+            purchase_order_number: null,
+            title: 'Credit Card',
+            __typename: 'SelectedPaymentMethod'
+        },
+        products: [
+            {
+                uid: 'MzA3NQ==',
+                product: {
+                    uid: 'OQ==',
+                    sku: 'VA19-GO-NA',
+                    name: 'Gold Omni Bangle Set',
+                    thumbnail: {
+                        url:
+                            'https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va19-go_main.jpg',
+                        __typename: 'ProductImage'
+                    },
+                    __typename: 'SimpleProduct'
+                },
+                prices: {
+                    price: {
+                        currency: 'USD',
+                        value: 78,
+                        __typename: 'Money'
+                    },
+                    row_total: {
+                        value: 78,
+                        __typename: 'Money'
+                    },
+                    total_item_discount: {
+                        value: 0,
+                        __typename: 'Money'
+                    },
+                    __typename: 'CartItemPrices'
+                },
+                quantity: 1,
+                __typename: 'SimpleCartItem'
+            }
+        ]
+    }
+};

package/src/handlers/__tests__/__mocks__/pageView.js

@@ -0,0 +1,7 @@
+export default {
+    type: 'CMS_PAGE_VIEW',
+    payload: {
+        title: 'Home Page - Venia',
+        url_key: 'venia-new-home'
+    }
+};

package/src/handlers/__tests__/__mocks__/placeOrderButtonClicked.js

@@ -0,0 +1,161 @@
+export default {
+    type: 'CHECKOUT_PLACE_ORDER_BUTTON_CLICKED',
+    payload: {
+        cart_id: 'adaIGWl4UsoKOGIeX17FPrnMq3bXHVZA',
+        amount: {
+            grand_total: {
+                value: 466.01,
+                currency: 'USD',
+                __typename: 'Money'
+            },
+            discounts: null,
+            __typename: 'CartPrices'
+        },
+        shipping: [
+            {
+                amount: {
+                    value: 0,
+                    currency: 'USD',
+                    __typename: 'Money'
+                },
+                carrier_title: 'Free Shipping',
+                method_title: 'Free',
+                __typename: 'SelectedShippingMethod'
+            }
+        ],
+        payment: {
+            purchase_order_number: null,
+            title: 'Credit Card',
+            __typename: 'SelectedPaymentMethod'
+        },
+        products: [
+            {
+                uid: 'Mjk3Nw==',
+                product: {
+                    uid: 'MTEzNw==',
+                    sku: 'VP08',
+                    name: 'Bella Eyelet Capris',
+                    thumbnail: {
+                        url:
+                            'https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/p/vp08-rn_main_2.jpg',
+                        __typename: 'ProductImage'
+                    },
+                    __typename: 'ConfigurableProduct'
+                },
+                prices: {
+                    price: {
+                        currency: 'USD',
+                        value: 98,
+                        __typename: 'Money'
+                    },
+                    row_total: {
+                        value: 294,
+                        __typename: 'Money'
+                    },
+                    total_item_discount: {
+                        value: 0,
+                        __typename: 'Money'
+                    },
+                    __typename: 'CartItemPrices'
+                },
+                quantity: 3,
+                configurable_options: [
+                    {
+                        configurable_product_option_uid:
+                            'Y29uZmlndXJhYmxlLzExMzcvMTU3',
+                        option_label: 'Fashion Color',
+                        configurable_product_option_value_uid:
+                            'Y29uZmlndXJhYmxlLzE1Ny8zNQ==',
+                        value_label: 'Mint',
+                        __typename: 'SelectedConfigurableOption'
+                    },
+                    {
+                        configurable_product_option_uid:
+                            'Y29uZmlndXJhYmxlLzExMzcvMTkw',
+                        option_label: 'Fashion Size',
+                        configurable_product_option_value_uid:
+                            'Y29uZmlndXJhYmxlLzE5MC80OQ==',
+                        value_label: '6',
+                        __typename: 'SelectedConfigurableOption'
+                    }
+                ],
+                __typename: 'ConfigurableCartItem'
+            },
+            {
+                uid: 'Mjk3OQ==',
+                product: {
+                    uid: 'MTE1OA==',
+                    sku: 'VA09',
+                    name: 'Thin Leather Braided Belt',
+                    thumbnail: {
+                        url:
+                            'https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va09-br_main_2.jpg',
+                        __typename: 'ProductImage'
+                    },
+                    __typename: 'ConfigurableProduct'
+                },
+                prices: {
+                    price: {
+                        currency: 'USD',
+                        value: 38,
+                        __typename: 'Money'
+                    },
+                    row_total: {
+                        value: 38,
+                        __typename: 'Money'
+                    },
+                    total_item_discount: {
+                        value: 0,
+                        __typename: 'Money'
+                    },
+                    __typename: 'CartItemPrices'
+                },
+                quantity: 1,
+                configurable_options: [
+                    {
+                        configurable_product_option_uid:
+                            'Y29uZmlndXJhYmxlLzExNTgvMTkw',
+                        option_label: 'Fashion Size',
+                        configurable_product_option_value_uid:
+                            'Y29uZmlndXJhYmxlLzE5MC80NA==',
+                        value_label: 'M',
+                        __typename: 'SelectedConfigurableOption'
+                    }
+                ],
+                __typename: 'ConfigurableCartItem'
+            },
+            {
+                uid: 'Mjk4Nw==',
+                product: {
+                    uid: 'MTI=',
+                    sku: 'VA22-SI-NA',
+                    name: 'Silver Amor Bangle Set',
+                    thumbnail: {
+                        url:
+                            'https://master-7rqtwti-mfwmkrjfqvbjk.us-4.magentosite.cloud/media/catalog/product/cache/609faca36a4bc16a754bc2f43c184970/v/a/va22-si_main.jpg',
+                        __typename: 'ProductImage'
+                    },
+                    __typename: 'SimpleProduct'
+                },
+                prices: {
+                    price: {
+                        currency: 'USD',
+                        value: 98,
+                        __typename: 'Money'
+                    },
+                    row_total: {
+                        value: 98,
+                        __typename: 'Money'
+                    },
+                    total_item_discount: {
+                        value: 0,
+                        __typename: 'Money'
+                    },
+                    __typename: 'CartItemPrices'
+                },
+                quantity: 1,
+                __typename: 'SimpleCartItem'
+            }
+        ]
+    }
+};

package/src/handlers/__tests__/__mocks__/productPageView.js

@@ -0,0 +1,15 @@
+export default {
+    type: 'PRODUCT_PAGE_VIEW',
+    payload: {
+        id: '234d',
+        name: 'Selena Pants',
+        sku: '343g3434t',
+        currency_code: 'USD',
+        price_range: {
+            maximum_price: {
+                final_price: 40
+            }
+        },
+        url_key: 'selena-pants'
+    }
+};

package/src/handlers/__tests__/__mocks__/searchPageRequest.js

@@ -0,0 +1,22 @@
+export default {
+    type: 'SEARCH_REQUEST',
+    payload: {
+        query: 'belt',
+        refinements: [
+            {
+                attribute: 'category_id',
+                value: new Set(['Accessories,3']),
+                isRange: false
+            },
+            {
+                attribute: 'fashion_size',
+                value: new Set(['M,44']),
+                isRange: false
+            }
+        ],
+        sort: {
+            attribute: 'relevance',
+            order: 'DESC'
+        }
+    }
+};

package/src/handlers/__tests__/__mocks__/searchRequestSent.js

@@ -0,0 +1,34 @@
+export const searchRequestEvent = {
+    type: 'SEARCH_REQUEST',
+    payload: {
+        query: 'selena',
+        refinements: [
+            {
+                attribute: 'category_id',
+                value: new Set(['Bottoms,11']),
+                isRange: false
+            },
+            {
+                attribute: 'fashion_color',
+                value: new Set(['Rain,34', 'Mint,25']),
+                isRange: false
+            }
+        ],
+        sort: {
+            attribute: 'relevance',
+            order: 'DESC'
+        },
+        pageSize: 12,
+        currentPage: 1
+    }
+};
+
+export const searchbarRequestEvent = {
+    type: 'SEARCHBAR_REQUEST',
+    payload: {
+        query: 'selena',
+        currentPage: 1,
+        pageSize: 3,
+        refinements: []
+    }
+};

package/src/handlers/__tests__/__mocks__/searchResponseReceived.js

@@ -0,0 +1,106 @@
+export const searchResponseEvent = {
+    type: 'SEARCH_RESPONSE',
+    payload: {
+        categories: [
+            {
+                __typename: 'AggregationOption',
+                label: 'Bottoms',
+                value: '11'
+            },
+            {
+                __typename: 'AggregationOption',
+                label: 'Pants & Shorts',
+                value: '12'
+            }
+        ],
+        facets: [],
+        page: 1,
+        perPage: 3,
+        products: [
+            {
+                __typename: 'ConfigurableProduct',
+                id: 1144,
+                uid: 'MTE0NA==',
+                sku: 'VP01',
+                name: 'Selena Pants',
+                small_image: {
+                    __typename: 'ProductImage',
+                    url:
+                        'https://beacon-rjroszy-vzsrtettsztvg.us-4.magentosite.cloud/media/catalog/product/cache/37f3b100da589f62b6681aad6ae5936f/v/p/vp01-ll_main_2.jpg'
+                },
+                url_key: 'selena-pants',
+                url_suffix: '.html',
+                price: {
+                    __typename: 'ProductPrices',
+                    regularPrice: {
+                        __typename: 'Price',
+                        amount: {
+                            __typename: 'Money',
+                            value: 108,
+                            currency: 'USD'
+                        }
+                    }
+                },
+                price_range: {
+                    __typename: 'PriceRange',
+                    maximum_price: {
+                        __typename: 'ProductPrice',
+                        final_price: {
+                            __typename: 'Money',
+                            currency: 'USD',
+                            value: 108
+                        },
+                        discount: {
+                            __typename: 'ProductDiscount',
+                            amount_off: 0
+                        }
+                    }
+                }
+            }
+        ],
+        searchRequestId: 'selena',
+        searchUnitId: 'search-bar',
+        suggestions: [
+            {
+                __typename: 'ConfigurableProduct',
+                id: 1144,
+                uid: 'MTE0NA==',
+                sku: 'VP01',
+                name: 'Selena Pants',
+                small_image: {
+                    __typename: 'ProductImage',
+                    url:
+                        'https://beacon-rjroszy-vzsrtettsztvg.us-4.magentosite.cloud/media/catalog/product/cache/37f3b100da589f62b6681aad6ae5936f/v/p/vp01-ll_main_2.jpg'
+                },
+                url_key: 'selena-pants',
+                url_suffix: '.html',
+                price: {
+                    __typename: 'ProductPrices',
+                    regularPrice: {
+                        __typename: 'Price',
+                        amount: {
+                            __typename: 'Money',
+                            value: 108,
+                            currency: 'USD'
+                        }
+                    }
+                },
+                price_range: {
+                    __typename: 'PriceRange',
+                    maximum_price: {
+                        __typename: 'ProductPrice',
+                        final_price: {
+                            __typename: 'Money',
+                            currency: 'USD',
+                            value: 108
+                        },
+                        discount: {
+                            __typename: 'ProductDiscount',
+                            amount_off: 0
+                        }
+                    }
+                }
+            }
+        ]
+    }
+};

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

@@ -0,0 +1,137 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`handle() calls the correct sdk functions with the correct context value 1`] = `
+Object {
+  "giftMessageSelected": false,
+  "giftWrappingSelected": false,
+  "id": "kAR5Gg6uPC6J5wGY0ebecyKfX905epmU",
+  "items": Array [
+    Object {
+      "configurableOptions": Array [
+        Object {
+          "id": undefined,
+          "optionLabel": "Fashion Color",
+          "valueId": "Y29uZmlndXJhYmxlLzE1Ny8zMQ==",
+          "valueLabel": "Peach",
+        },
+        Object {
+          "id": undefined,
+          "optionLabel": "Fashion Size",
+          "valueId": "Y29uZmlndXJhYmxlLzE5MC80Mw==",
+          "valueLabel": "L",
+        },
+      ],
+      "formattedPrice": "",
+      "id": "MjQ2Ng==",
+      "prices": Object {
+        "__typename": "CartItemPrices",
+        "price": Object {
+          "__typename": "Money",
+          "currency": "USD",
+          "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,
+        },
+        "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": undefined,
+          "optionLabel": "Fashion Color",
+          "valueId": "Y29uZmlndXJhYmxlLzE1Ny8zMQ==",
+          "valueLabel": "Peach",
+        },
+        Object {
+          "id": undefined,
+          "optionLabel": "Fashion Size",
+          "valueId": "Y29uZmlndXJhYmxlLzE5MC80NA==",
+          "valueLabel": "M",
+        },
+      ],
+      "formattedPrice": "",
+      "id": "MjQ4Mw==",
+      "prices": Object {
+        "__typename": "CartItemPrices",
+        "price": Object {
+          "__typename": "Money",
+          "currency": "USD",
+          "value": 48,
+        },
+        "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,
+    },
+  },
+}
+`;

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

@@ -0,0 +1,73 @@
+import handler from '../addToCart';
+import {
+    addSimpleProductEvent,
+    addConfigurableProductEvent
+} from './__mocks__/cartAddItem';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(addSimpleProductEvent)).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: {
+                setShoppingCart: jest.fn()
+            },
+            publish: {
+                addToCart: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, addConfigurableProductEvent);
+
+        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 {
+                  "prices": Object {
+                    "price": Object {
+                      "currency": "USD",
+                      "value": 78,
+                    },
+                  },
+                  "product": Object {
+                    "configurableOptions": Array [
+                      Object {
+                        "optionLabel": undefined,
+                        "valueLabel": undefined,
+                      },
+                    ],
+                    "name": "Johanna Skirt",
+                    "sku": "VSK03",
+                  },
+                },
+              ],
+              "possibleOnepageCheckout": false,
+              "prices": Object {
+                "subtotalExcludingTax": Object {
+                  "currency": "USD",
+                  "value": 78,
+                },
+              },
+            }
+        `);
+
+        expect(mockSdk.publish.addToCart).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,55 @@
+import handler from '../categoryPageView';
+
+import categoryPageViewEvent from './__mocks__/categoryPageView';
+import miniCartViewEvent from './__mocks__/miniCartView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(categoryPageViewEvent)).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: {
+                setCategory: jest.fn(),
+                setPage: jest.fn()
+            },
+            publish: {
+                pageView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, categoryPageViewEvent);
+
+        expect(mockSdk.context.setCategory).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setCategory.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "name": "Dresses",
+              "urlKey": "venia-dresses",
+              "urlPath": "venia-dresses",
+            }
+        `);
+
+        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": "Dresses",
+              "pageType": "Category",
+            }
+        `);
+
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+    });
+});