@searchspring/snap-controller 0.63.5 → 0.65.0

package/dist/esm/Autocomplete/AutocompleteController.js

@@ -37,12 +37,62 @@ export class AutocompleteController extends AbstractController {
     constructor(config, { client, store, urlManager, eventManager, profiler, logger, tracker }, context) {
         super(config, { client, store, urlManager, eventManager, profiler, logger, tracker }, context);
         this.type = ControllerTypes.autocomplete;
+        this.events = {
+            product: {},
+        };
         this.track = {
-            // TODO: add in future when autocomplete supports result click tracking
             product: {
-                click: () => {
-                    this.log.warn('product.click tracking is not currently supported in this controller type');
+                clickThrough: (e, result) => {
+                    if (this.events.product[result.id]?.clickThrough) {
+                        return;
+                    }
+                    const data = getAutocompleteSchemaData({ params: this.params, store: this.store, results: [result] });
+                    this.tracker.events.autocomplete.clickThrough({ data, siteId: this.config.globals?.siteId });
+                    this.events.product[result.id] = this.events.product[result.id] || {};
+                    this.events.product[result.id].clickThrough = true;
+                    this.eventManager.fire('track.product.clickThrough', { controller: this, event: e, products: [result], trackEvent: data });
+                },
+                click: (e, result) => {
+                    if (result.type === 'banner') {
+                        return;
+                    }
+                    // TODO: closest might be going too far - write own function to only go n levels up - additionally check that href includes result.url
+                    const href = e.target?.getAttribute('href') || e.target?.closest('a')?.getAttribute('href');
+                    if (href) {
+                        this.track.product.clickThrough(e, result);
+                    }
+                    else {
+                        // TODO: in future, send as an interaction event
+                    }
+                },
+                render: (result) => {
+                    if (this.events.product[result.id]?.render)
+                        return;
+                    const data = getAutocompleteSchemaData({ params: this.params, store: this.store, results: [result] });
+                    this.tracker.events.autocomplete.render({ data, siteId: this.config.globals?.siteId });
+                    this.events.product[result.id] = this.events.product[result.id] || {};
+                    this.events.product[result.id].render = true;
+                    this.eventManager.fire('track.product.render', { controller: this, products: [result], trackEvent: data });
+                },
+                impression: (result) => {
+                    if (this.events.product[result.id]?.impression)
+                        return;
+                    const data = getAutocompleteSchemaData({ params: this.params, store: this.store, results: [result] });
+                    this.tracker.events.autocomplete.impression({ data, siteId: this.config.globals?.siteId });
+                    this.events.product[result.id] = this.events.product[result.id] || {};
+                    this.events.product[result.id].impression = true;
+                    this.eventManager.fire('track.product.impression', { controller: this, products: [result], trackEvent: data });
                 },
+                addToCart: (result) => {
+                    const data = getAutocompleteSchemaData({ params: this.params, store: this.store, results: [result] });
+                    this.tracker.events.autocomplete.addToCart({ data, siteId: this.config.globals?.siteId });
+                    this.eventManager.fire('track.product.addToCart', { controller: this, products: [result], trackEvent: data });
+                },
+            },
+            redirect: (redirectURL) => {
+                const data = getAutocompleteRedirectSchemaData({ redirectURL });
+                this.tracker.events.autocomplete.redirect({ data, siteId: this.config.globals?.siteId });
+                this.eventManager.fire('track.product.redirect', { controller: this, redirectURL, trackEvent: data });
             },
         };
         this.handlers = {
@@ -257,6 +307,8 @@ export class AutocompleteController extends AbstractController {
                 if (!this.initialized) {
                     await this.init();
                 }
+                // reset events for new search
+                this.events = { product: {} };
                 // if urlManager has no query, there will be no need to get params and no query
                 if (!this.urlManager.state.query) {
                     return;
@@ -382,6 +434,10 @@ export class AutocompleteController extends AbstractController {
                 this.store.loading = false;
             }
         };
+        this.addToCart = async (product) => {
+            this.track.product.addToCart(product);
+            this.eventManager.fire('addToCart', { controller: this, products: [product] });
+        };
         // deep merge config with defaults
         this.config = deepmerge(defaultConfig, this.config);
         this.store.setConfig(this.config);
@@ -409,6 +465,7 @@ export class AutocompleteController extends AbstractController {
             await next();
             const redirectURL = ac.controller.store.merchandising?.redirect;
             if (redirectURL && this.config?.settings?.redirects?.merchandising) {
+                this.track.redirect(redirectURL);
                 window.location.href = redirectURL;
                 return false;
             }
@@ -429,9 +486,7 @@ export class AutocompleteController extends AbstractController {
     get params() {
         const urlState = this.urlManager.state;
         const params = deepmerge({ ...getSearchParams(urlState) }, this.config.globals);
-        const userId = this.tracker.getUserId();
-        const sessionId = this.tracker.getContext().sessionId;
-        const pageLoadId = this.tracker.getContext().pageLoadId;
+        const { userId, sessionId, pageLoadId, shopperId } = this.tracker.getContext();
         params.tracking = params.tracking || {};
         params.tracking.domain = window.location.href;
         if (userId) {
@@ -454,7 +509,6 @@ export class AutocompleteController extends AbstractController {
                 params.personalization = params.personalization || {};
                 params.personalization.lastViewed = lastViewedItems.join(',');
             }
-            const shopperId = this.tracker.getShopperId();
             if (shopperId) {
                 params.personalization = params.personalization || {};
                 params.personalization.shopper = shopperId;
@@ -633,3 +687,69 @@ function unbindFormParameters(form, fn) {
         }
     }
 }
+function getAutocompleteRedirectSchemaData({ redirectURL }) {
+    return {
+        redirect: redirectURL,
+    };
+}
+function getAutocompleteSchemaData({ params, store, results, }) {
+    const filters = params.filters?.reduce((acc, filter) => {
+        const key = filter.background ? 'bgfilter' : 'filter';
+        acc[key] = acc[key] || [];
+        const value = filter.type === 'range' &&
+            !isNaN(filter.value?.low) &&
+            !isNaN(filter.value?.low)
+            ? [`low=${filter.value?.low}`, `high=${filter.value?.high}`]
+            : [`${filter.value}`];
+        const existing = acc[key].find((item) => item.field === filter.field);
+        if (existing && !existing.value.includes(value[0])) {
+            existing.value.push(...value);
+        }
+        else {
+            acc[key].push({
+                field: filter.field,
+                value,
+            });
+        }
+        return acc;
+    }, {});
+    return {
+        q: params.search?.query?.string || '',
+        correctedQuery: params.search?.originalQuery || '',
+        ...filters,
+        sort: [
+            {
+                field: store.sorting.current?.field,
+                dir: store.sorting.current?.direction,
+            },
+        ],
+        pagination: {
+            totalResults: store.pagination.totalResults,
+            page: store.pagination.page,
+            resultsPerPage: store.pagination.pageSize,
+        },
+        merchandising: {
+            personalized: store.merchandising.personalized,
+            redirect: store.merchandising.redirect,
+            triggeredCampaigns: (store.merchandising.campaigns?.length &&
+                store.merchandising.campaigns?.map((campaign) => {
+                    const experiement = store.merchandising.experiments.find((experiment) => experiment.campaignId === campaign.id);
+                    return {
+                        id: campaign.id,
+                        experimentId: experiement?.experimentId,
+                        variationId: experiement?.variationId,
+                    };
+                })) ||
+                undefined,
+        },
+        results: results?.map((result) => {
+            const core = result.mappings.core;
+            return {
+                uid: core.uid || '',
+                // childUid: core.uid,
+                sku: core.sku,
+                // childSku: core.sku,
+            };
+        }) || [],
+    };
+}

package/dist/esm/Finder/FinderController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FinderController.d.ts","sourceRoot":"","sources":["../../../src/Finder/FinderController.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAkB,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAiB7G,qBAAa,gBAAiB,SAAQ,kBAAkB;IAChD,IAAI,kBAA0B;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;gBAGtC,MAAM,EAAE,sBAAsB,EAC9B,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IA+B3B,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA+BhC;IAED,IAAI,QAAa,QAAQ,IAAI,CAAC,CAkB5B;IAEF,KAAK,QAAO,IAAI,CAId;IAEF,MAAM,QAAa,QAAQ,IAAI,CAAC,CAoI9B;CACF"}
+{"version":3,"file":"FinderController.d.ts","sourceRoot":"","sources":["../../../src/Finder/FinderController.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE,OAAO,KAAK,EAAE,sBAAsB,EAAkB,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAiB7G,qBAAa,gBAAiB,SAAQ,kBAAkB;IAChD,IAAI,kBAA0B;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;gBAGtC,MAAM,EAAE,sBAAsB,EAC9B,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IA+B3B,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CA6BhC;IAED,IAAI,QAAa,QAAQ,IAAI,CAAC,CAkB5B;IAEF,KAAK,QAAO,IAAI,CAId;IAEF,MAAM,QAAa,QAAQ,IAAI,CAAC,CAoI9B;CACF"}

package/dist/esm/Finder/FinderController.js

@@ -194,9 +194,7 @@ export class FinderController extends AbstractController {
     }
     get params() {
         const urlState = this.urlManager.state;
-        const userId = this.tracker.getUserId();
-        const sessionId = this.tracker.getContext().sessionId;
-        const pageLoadId = this.tracker.getContext().pageLoadId;
+        const { userId, sessionId, pageLoadId } = this.tracker.getContext();
         const tracking = {};
         if (userId) {
             tracking.userId = userId;

package/dist/esm/Recommendation/RecommendationController.d.ts

@@ -1,5 +1,4 @@
 import { Product } from '@searchspring/snap-store-mobx';
-import { BeaconEvent } from '@searchspring/snap-tracker';
 import { AbstractController } from '../Abstract/AbstractController';
 import { ControllerTypes } from '../types';
 import type { RecommendationStore } from '@searchspring/snap-store-mobx';
@@ -7,28 +6,25 @@ import type { RecommendRequestModel } from '@searchspring/snap-client';
 import type { RecommendationControllerConfig, ControllerServices, ContextVariables } from '../types';
 type RecommendationTrackMethods = {
     product: {
-        click: (e: MouseEvent, result: Product) => BeaconEvent | undefined;
-        render: (result: Product) => BeaconEvent | undefined;
-        impression: (result: Product) => BeaconEvent | undefined;
-        removedFromBundle: (result: Product) => BeaconEvent | undefined;
-        addedToBundle: (result: Product) => BeaconEvent | undefined;
+        clickThrough: (e: MouseEvent, result: Product) => void;
+        click: (e: MouseEvent, result: Product) => void;
+        render: (result: Product) => void;
+        impression: (result: Product) => void;
+        addToCart: (result: Product) => void;
+    };
+    bundle: {
+        addToCart: (results: Product[]) => void;
     };
-    click: (e: MouseEvent) => BeaconEvent | undefined;
-    addBundle: (e: MouseEvent, results: Product[]) => BeaconEvent | undefined;
-    impression: () => BeaconEvent | undefined;
-    render: (results?: Product[]) => BeaconEvent | undefined;
 };
 export declare class RecommendationController extends AbstractController {
     type: ControllerTypes;
     store: RecommendationStore;
     config: RecommendationControllerConfig;
     events: {
-        click?: BeaconEvent;
-        impression?: BeaconEvent;
-        render?: BeaconEvent;
-        product?: Record<string, {
-            impression?: BeaconEvent;
-            render?: BeaconEvent;
+        product: Record<string, {
+            clickThrough?: boolean;
+            impression?: boolean;
+            render?: boolean;
         }>;
     };
     constructor(config: RecommendationControllerConfig, { client, store, urlManager, eventManager, profiler, logger, tracker }: ControllerServices, context?: ContextVariables);

package/dist/esm/Recommendation/RecommendationController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecommendationController.d.ts","sourceRoot":"","sources":["../../../src/Recommendation/RecommendationController.ts"],"names":[],"mappings":"AAGA,OAAO,EAAa,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAEzE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,KAAK,EAAE,8BAA8B,EAAiB,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEpH,KAAK,0BAA0B,GAAG;IACjC,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,KAAK,WAAW,GAAG,SAAS,CAAC;QACnE,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,WAAW,GAAG,SAAS,CAAC;QACrD,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,WAAW,GAAG,SAAS,CAAC;QACzD,iBAAiB,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,WAAW,GAAG,SAAS,CAAC;QAChE,aAAa,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,WAAW,GAAG,SAAS,CAAC;KAC5D,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,WAAW,GAAG,SAAS,CAAC;IAClD,SAAS,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,WAAW,GAAG,SAAS,CAAC;IAC1E,UAAU,EAAE,MAAM,WAAW,GAAG,SAAS,CAAC;IAC1C,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,WAAW,GAAG,SAAS,CAAC;CACzD,CAAC;AAUF,qBAAa,wBAAyB,SAAQ,kBAAkB;IACxD,IAAI,kBAAkC;IACrC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,8BAA8B,CAAC;IAE/C,MAAM,EAAE;QACP,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,UAAU,CAAC,EAAE,WAAW,CAAC;QACzB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,UAAU,CAAC,EAAE,WAAW,CAAC;YAAC,MAAM,CAAC,EAAE,WAAW,CAAA;SAAE,CAAC,CAAC;KAC7E,CAKC;gBAGD,MAAM,EAAE,8BAA8B,EACtC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IA4C3B,KAAK,EAAE,0BAA0B,CAwS5B;IAEL,IAAI,MAAM,IAAI,qBAAqB,CA2BlC;IAED,MAAM,QAAa,QAAQ,IAAI,CAAC,CA0H9B;CACF"}
+{"version":3,"file":"RecommendationController.d.ts","sourceRoot":"","sources":["../../../src/Recommendation/RecommendationController.ts"],"names":[],"mappings":"AAEA,OAAO,EAAa,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,KAAK,EAAE,8BAA8B,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAIrG,KAAK,0BAA0B,GAAG;IACjC,OAAO,EAAE;QACR,YAAY,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QACvD,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QAChD,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QAClC,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QACtC,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;KACrC,CAAC;IACF,MAAM,EAAE;QACP,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;KACxC,CAAC;CACF,CAAC;AAUF,qBAAa,wBAAyB,SAAQ,kBAAkB;IACxD,IAAI,kBAAkC;IACrC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,MAAM,EAAE,8BAA8B,CAAC;IAE/C,MAAM,EAAE;QACP,OAAO,EAAE,MAAM,CACd,MAAM,EACN;YACC,YAAY,CAAC,EAAE,OAAO,CAAC;YACvB,UAAU,CAAC,EAAE,OAAO,CAAC;YACrB,MAAM,CAAC,EAAE,OAAO,CAAC;SACjB,CACD,CAAC;KACF,CAEC;gBAGD,MAAM,EAAE,8BAA8B,EACtC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IAwC3B,KAAK,EAAE,0BAA0B,CAyD/B;IAEF,IAAI,MAAM,IAAI,qBAAqB,CA4BlC;IAED,MAAM,QAAa,QAAQ,IAAI,CAAC,CA6H9B;CACF"}