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

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

@@ -0,0 +1,70 @@
+import handler from '../completeCheckout';
+import completeCheckoutEvent from './__mocks__/completeCheckout';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(completeCheckoutEvent)).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: {
+                setOrder: jest.fn(),
+                setPage: jest.fn()
+            },
+            publish: {
+                placeOrder: jest.fn(),
+                pageView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, completeCheckoutEvent);
+
+        expect(mockSdk.context.setOrder).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setOrder.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "grandTotal": 40,
+              "orderId": "001",
+              "orderType": "checkout",
+              "payments": Array [
+                Object {
+                  "paymentMethodCode": "Visa",
+                  "paymentMethodName": "Visa",
+                  "total": 40,
+                },
+              ],
+              "shipping": Object {
+                "shippingAmount": 13,
+                "shippingMethod": "method",
+              },
+            }
+        `);
+
+        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": "Order Confirmation",
+              "pageType": "Order Confirmation Page",
+            }
+        `);
+
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+        expect(mockSdk.publish.placeOrder).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,43 @@
+import handler from '../createAccount';
+import createAccountEvent from './__mocks__/createAccount';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(createAccountEvent)).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()
+            },
+            publish: {
+                createAccount: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, createAccountEvent);
+
+        expect(mockSdk.context.setAccount).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setAccount.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "emailAddress": "Stephen.Strange@fake.email",
+              "firstName": "Stephen",
+              "lastName": "Strange",
+            }
+        `);
+
+        expect(mockSdk.publish.createAccount).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,43 @@
+import handler from '../editAccount';
+import editAccountEvent from './__mocks__/editAccount';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(editAccountEvent)).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()
+            },
+            publish: {
+                editAccount: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, editAccountEvent);
+
+        expect(mockSdk.context.setAccount).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setAccount.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "emailAddress": "Stephen.Strange@fake.email",
+              "firstName": "Stephen",
+              "lastName": "Strange",
+            }
+        `);
+
+        expect(mockSdk.publish.editAccount).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,46 @@
+import handler from '../pageView';
+import cmsPageViewEvent from './__mocks__/pageView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(cmsPageViewEvent)).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()
+            },
+            publish: {
+                pageView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, cmsPageViewEvent);
+
+        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": "Home Page - Venia",
+              "pageType": "CMS",
+            }
+        `);
+
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,55 @@
+import handler from '../placeOrder';
+import placeOrderEvent from './__mocks__/placeOrderButtonClicked';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(placeOrderEvent)).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: {
+                setOrder: jest.fn()
+            },
+            publish: {
+                placeOrder: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, placeOrderEvent);
+
+        expect(mockSdk.context.setOrder).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setOrder.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "grandTotal": 466.01,
+              "orderType": "checkout",
+              "payments": Array [
+                Object {
+                  "paymentMethodCode": "Credit Card",
+                  "paymentMethodName": "Credit Card",
+                  "total": 466.01,
+                },
+              ],
+              "shipping": Object {
+                "shippingAmount": 0,
+                "shippingMethod": "Free",
+              },
+            }
+        `);
+
+        // Since we're sending this event after loading the order confirmation page,
+        // We don't need to send it here since we don't have an order number anyways.
+        expect(mockSdk.publish.placeOrder).toHaveBeenCalledTimes(0);
+    });
+});

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

@@ -0,0 +1,64 @@
+import handler from '../productPageView';
+import productPageViewEvent from './__mocks__/productPageView';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(productPageViewEvent)).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(),
+                setProduct: jest.fn()
+            },
+            publish: {
+                pageView: jest.fn(),
+                productPageView: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, productPageViewEvent);
+
+        expect(mockSdk.context.setProduct).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setProduct.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "canonicalUrl": "selena-pants",
+              "name": "Selena Pants",
+              "pricing": Object {
+                "currencyCode": "USD",
+                "maximalPrice": 40,
+              },
+              "productId": "234d",
+              "sku": "343g3434t",
+            }
+        `);
+
+        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": "Selena Pants",
+              "pageType": "PDP",
+            }
+        `);
+
+        expect(mockSdk.publish.productPageView).toHaveBeenCalledTimes(1);
+        expect(mockSdk.publish.pageView).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,119 @@
+import handler from '../searchRequestSent';
+import {
+    searchRequestEvent,
+    searchbarRequestEvent
+} from './__mocks__/searchRequestSent';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(searchRequestEvent)).toBeTruthy();
+    });
+
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(searchbarRequestEvent)).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: {
+                setSearchInput: jest.fn()
+            },
+            publish: {
+                searchRequestSent: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, searchRequestEvent);
+
+        expect(mockSdk.context.setSearchInput).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setSearchInput.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "units": Array [
+                Object {
+                  "currentPage": 1,
+                  "filter": Array [
+                    Object {
+                      "attribute": "category_id",
+                      "in": Array [
+                        "Bottoms,11",
+                      ],
+                    },
+                    Object {
+                      "attribute": "fashion_color",
+                      "in": Array [
+                        "Rain,34",
+                        "Mint,25",
+                      ],
+                    },
+                  ],
+                  "pageSize": 12,
+                  "phrase": "selena",
+                  "queryTypes": Array [
+                    "products",
+                  ],
+                  "searchUnitId": "productPage",
+                  "sort": Array [
+                    Object {
+                      "attribute": "relevance",
+                      "direction": "DESC",
+                    },
+                  ],
+                },
+              ],
+            }
+        `);
+
+        expect(mockSdk.publish.searchRequestSent).toHaveBeenCalledTimes(1);
+    });
+
+    it('calls the correct sdk functions with the correct context value', () => {
+        const mockSdk = {
+            context: {
+                setSearchInput: jest.fn()
+            },
+            publish: {
+                searchRequestSent: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, searchbarRequestEvent);
+
+        expect(mockSdk.context.setSearchInput).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setSearchInput.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "units": Array [
+                Object {
+                  "currentPage": 1,
+                  "filter": Array [],
+                  "pageSize": 3,
+                  "phrase": "selena",
+                  "queryTypes": Array [
+                    "products",
+                  ],
+                  "searchUnitId": "productPage",
+                  "sort": Array [
+                    Object {
+                      "attribute": undefined,
+                      "direction": undefined,
+                    },
+                  ],
+                },
+              ],
+            }
+        `);
+
+        expect(mockSdk.publish.searchRequestSent).toHaveBeenCalledTimes(1);
+    });
+});

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

@@ -0,0 +1,143 @@
+import handler from '../searchResponseReceived';
+import { searchResponseEvent } from './__mocks__/searchResponseReceived';
+
+describe('canHandle()', () => {
+    it('returns true for the correct event type', () => {
+        expect(handler.canHandle(searchResponseEvent)).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: {
+                setSearchResults: jest.fn()
+            },
+            publish: {
+                searchResponseReceived: jest.fn()
+            }
+        };
+
+        handler.handle(mockSdk, searchResponseEvent);
+
+        expect(mockSdk.context.setSearchResults).toHaveBeenCalledTimes(1);
+        expect(mockSdk.context.setSearchResults.mock.calls[0][0])
+            .toMatchInlineSnapshot(`
+            Object {
+              "units": Array [
+                Object {
+                  "categories": Array [
+                    Object {
+                      "__typename": "AggregationOption",
+                      "label": "Bottoms",
+                      "value": "11",
+                    },
+                    Object {
+                      "__typename": "AggregationOption",
+                      "label": "Pants & Shorts",
+                      "value": "12",
+                    },
+                  ],
+                  "facets": Array [],
+                  "page": 1,
+                  "perPage": 3,
+                  "products": Array [
+                    Object {
+                      "__typename": "ConfigurableProduct",
+                      "id": 1144,
+                      "name": "Selena Pants",
+                      "price": Object {
+                        "__typename": "ProductPrices",
+                        "regularPrice": Object {
+                          "__typename": "Price",
+                          "amount": Object {
+                            "__typename": "Money",
+                            "currency": "USD",
+                            "value": 108,
+                          },
+                        },
+                      },
+                      "price_range": Object {
+                        "__typename": "PriceRange",
+                        "maximum_price": Object {
+                          "__typename": "ProductPrice",
+                          "discount": Object {
+                            "__typename": "ProductDiscount",
+                            "amount_off": 0,
+                          },
+                          "final_price": Object {
+                            "__typename": "Money",
+                            "currency": "USD",
+                            "value": 108,
+                          },
+                        },
+                      },
+                      "sku": "VP01",
+                      "small_image": Object {
+                        "__typename": "ProductImage",
+                        "url": "https://beacon-rjroszy-vzsrtettsztvg.us-4.magentosite.cloud/media/catalog/product/cache/37f3b100da589f62b6681aad6ae5936f/v/p/vp01-ll_main_2.jpg",
+                      },
+                      "uid": "MTE0NA==",
+                      "url_key": "selena-pants",
+                      "url_suffix": ".html",
+                    },
+                  ],
+                  "searchRequestId": "selena",
+                  "searchUnitId": "search-bar",
+                  "suggestions": Array [
+                    Object {
+                      "__typename": "ConfigurableProduct",
+                      "id": 1144,
+                      "name": "Selena Pants",
+                      "price": Object {
+                        "__typename": "ProductPrices",
+                        "regularPrice": Object {
+                          "__typename": "Price",
+                          "amount": Object {
+                            "__typename": "Money",
+                            "currency": "USD",
+                            "value": 108,
+                          },
+                        },
+                      },
+                      "price_range": Object {
+                        "__typename": "PriceRange",
+                        "maximum_price": Object {
+                          "__typename": "ProductPrice",
+                          "discount": Object {
+                            "__typename": "ProductDiscount",
+                            "amount_off": 0,
+                          },
+                          "final_price": Object {
+                            "__typename": "Money",
+                            "currency": "USD",
+                            "value": 108,
+                          },
+                        },
+                      },
+                      "sku": "VP01",
+                      "small_image": Object {
+                        "__typename": "ProductImage",
+                        "url": "https://beacon-rjroszy-vzsrtettsztvg.us-4.magentosite.cloud/media/catalog/product/cache/37f3b100da589f62b6681aad6ae5936f/v/p/vp01-ll_main_2.jpg",
+                      },
+                      "uid": "MTE0NA==",
+                      "url_key": "selena-pants",
+                      "url_suffix": ".html",
+                    },
+                  ],
+                },
+              ],
+            }
+        `);
+
+        expect(mockSdk.publish.searchResponseReceived).toHaveBeenCalledTimes(1);
+    });
+});