@searchspring/snap-controller 0.64.0 → 0.65.0

package/dist/cjs/Search/SearchController.js

@@ -81,6 +81,8 @@ var AbstractController_1 = require("../Abstract/AbstractController");
 var snap_store_mobx_1 = require("@searchspring/snap-store-mobx");
 var getParams_1 = require("../utils/getParams");
 var types_1 = require("../types");
+var BACKGROUND_FILTER_FIELD_MATCHES = ['collection', 'category', 'categories', 'hierarchy'];
+var BACKGROUND_FILTERS_VALUE_FLAGS = [1, 0, '1', '0', 'true', 'false', true, false];
 var defaultConfig = {
     id: 'search',
     globals: {},
@@ -105,19 +107,24 @@ var SearchController = /** @class */ (function (_super) {
         var _this = _super.call(this, config, { client: client, store: store, urlManager: urlManager, eventManager: eventManager, profiler: profiler, logger: logger, tracker: tracker }, context) || this;
         _this.type = types_1.ControllerTypes.search;
         _this.previousResults = [];
+        _this.pageType = 'search';
+        _this.events = { product: {} };
         _this.track = {
             product: {
-                click: function (e, result) {
-                    var _a, _b, _c, _d;
+                clickThrough: function (e, result) {
+                    var _a, _b, _c, _d, _e, _f;
+                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.clickThrough) {
+                        return;
+                    }
                     var target = e.target;
-                    var resultHref = ((_b = (_a = result.display) === null || _a === void 0 ? void 0 : _a.mappings.core) === null || _b === void 0 ? void 0 : _b.url) || ((_c = result.mappings.core) === null || _c === void 0 ? void 0 : _c.url);
+                    var resultHref = ((_c = (_b = result.display) === null || _b === void 0 ? void 0 : _b.mappings.core) === null || _c === void 0 ? void 0 : _c.url) || ((_d = result.mappings.core) === null || _d === void 0 ? void 0 : _d.url) || '';
                     var elemHref = target === null || target === void 0 ? void 0 : target.getAttribute('href');
                     // the href that should be used for restoration - if the elemHref contains the resultHref - use resultHref
                     var storedHref = (elemHref === null || elemHref === void 0 ? void 0 : elemHref.indexOf(resultHref)) != -1 ? resultHref : elemHref || resultHref;
                     var scrollMap = {};
                     // generate the selector using element class and parent classes
                     var selector = generateHrefSelector(target, storedHref);
-                    var domRect = selector ? (_d = document === null || document === void 0 ? void 0 : document.querySelector(selector)) === null || _d === void 0 ? void 0 : _d.getBoundingClientRect() : undefined;
+                    var domRect = selector ? (_e = document === null || document === void 0 ? void 0 : document.querySelector(selector)) === null || _e === void 0 ? void 0 : _e.getBoundingClientRect() : undefined;
                     // store element position data to scrollMap
                     if (selector || storedHref || domRect) {
                         try {
@@ -135,17 +142,64 @@ var SearchController = /** @class */ (function (_super) {
                     }
                     // store position data or empty object
                     _this.storage.set('scrollMap', scrollMap);
-                    // track
-                    var _e = result.attributes, intellisuggestData = _e.intellisuggestData, intellisuggestSignature = _e.intellisuggestSignature;
-                    var event = _this.tracker.track.product.click({
-                        intellisuggestData: intellisuggestData,
-                        intellisuggestSignature: intellisuggestSignature,
-                        href: elemHref || resultHref,
+                    var data = getSearchSchemaData({ params: _this.params, store: _this.store, results: [result] });
+                    _this.tracker.events[_this.pageType].clickThrough({ data: data, siteId: (_f = _this.config.globals) === null || _f === void 0 ? void 0 : _f.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: function (e, result) {
+                    var _a, _b, _c;
+                    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
+                    var href = ((_a = e.target) === null || _a === void 0 ? void 0 : _a.getAttribute('href')) || ((_c = (_b = e.target) === null || _b === void 0 ? void 0 : _b.closest('a')) === null || _c === void 0 ? void 0 : _c.getAttribute('href'));
+                    if (href) {
+                        _this.track.product.clickThrough(e, result);
+                    }
+                    else {
+                        // TODO: in future, send as an interaction event
+                    }
+                },
+                render: function (result) {
+                    var _a, _b;
+                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.render) {
+                        return;
+                    }
+                    var data = getSearchSchemaData({ params: _this.params, store: _this.store, results: [result] });
+                    _this.tracker.events[_this.pageType].render({ data: data, siteId: (_b = _this.config.globals) === null || _b === void 0 ? void 0 : _b.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: function (result) {
+                    var _a, _b;
+                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.impression) {
+                        return;
+                    }
+                    var data = getSearchSchemaData({ params: _this.params, store: _this.store, results: [result] });
+                    _this.tracker.events[_this.pageType].impression({ data: data, siteId: (_b = _this.config.globals) === null || _b === void 0 ? void 0 : _b.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: function (result) {
+                    var _a;
+                    var data = getSearchSchemaData({ params: _this.params, store: _this.store, results: [result] });
+                    _this.tracker.events[_this.pageType].addToCart({
+                        data: data,
+                        siteId: (_a = _this.config.globals) === null || _a === void 0 ? void 0 : _a.siteId,
                     });
-                    _this.eventManager.fire('track.product.click', { controller: _this, event: e, result: result, trackEvent: event });
-                    return event;
+                    _this.eventManager.fire('track.product.addToCart', { controller: _this, products: [result], trackEvent: data });
                 },
             },
+            redirect: function (redirectURL) {
+                var _a;
+                var data = getSearchRedirectSchemaData({ redirectURL: redirectURL });
+                _this.tracker.events.search.redirect({ data: data, siteId: (_a = _this.config.globals) === null || _a === void 0 ? void 0 : _a.siteId });
+                _this.eventManager.fire('track.product.redirect', { controller: _this, redirectURL: redirectURL, trackEvent: data });
+            },
         };
         _this.search = function () { return __awaiter(_this, void 0, void 0, function () {
             var params_1, err_1, stringyParams, prevStringyParams, searchProfile, meta, response, preventBackfill, dontBackfill, backfillRequests, backfillResponses, backfillResults, afterSearchProfile, err_2, afterStoreProfile, err_3, err_4;
@@ -163,9 +217,11 @@ var SearchController = /** @class */ (function (_super) {
                         _o.label = 2;
                     case 2:
                         params_1 = this.params;
-                        if (((_d = (_c = this.params.search) === null || _c === void 0 ? void 0 : _c.query) === null || _d === void 0 ? void 0 : _d.string) && ((_f = (_e = this.params.search) === null || _e === void 0 ? void 0 : _e.query) === null || _f === void 0 ? void 0 : _f.string.length)) {
+                        // reset events for new search
+                        this.events = { product: {} };
+                        if (((_d = (_c = params_1.search) === null || _c === void 0 ? void 0 : _c.query) === null || _d === void 0 ? void 0 : _d.string) && ((_f = (_e = params_1.search) === null || _e === void 0 ? void 0 : _e.query) === null || _f === void 0 ? void 0 : _f.string.length)) {
                             // save it to the history store
-                            this.store.history.save(this.params.search.query.string);
+                            this.store.history.save(params_1.search.query.string);
                         }
                         this.store.loading = true;
                         _o.label = 3;
@@ -373,6 +429,13 @@ var SearchController = /** @class */ (function (_super) {
                 }
             });
         }); };
+        _this.addToCart = function (product) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.track.product.addToCart(product);
+                this.eventManager.fire('addToCart', { controller: this, products: [product] });
+                return [2 /*return*/];
+            });
+        }); };
         // deep merge config with defaults
         _this.config = (0, deepmerge_1.default)(defaultConfig, _this.config);
         // set restorePosition to be enabled by default when using infinite (if not provided)
@@ -386,6 +449,53 @@ var SearchController = /** @class */ (function (_super) {
         });
         // set last params to undefined for compare in search
         _this.storage.set('lastStringyParams', undefined);
+        _this.eventManager.on('beforeSearch', function (_a, next) {
+            var request = _a.request;
+            return __awaiter(_this, void 0, void 0, function () {
+                var req, query, hasCategoryBackgroundFilters;
+                var _b, _c, _d;
+                return __generator(this, function (_e) {
+                    switch (_e.label) {
+                        case 0: 
+                        // wait for other middleware to resolve
+                        return [4 /*yield*/, next()];
+                        case 1:
+                            // wait for other middleware to resolve
+                            _e.sent();
+                            if (((_b = this.context) === null || _b === void 0 ? void 0 : _b.pageType) === 'category') {
+                                this.pageType = 'category';
+                                return [2 /*return*/];
+                            }
+                            req = request;
+                            query = (_c = req.search) === null || _c === void 0 ? void 0 : _c.query;
+                            if (!query) {
+                                hasCategoryBackgroundFilters = (_d = req.filters) === null || _d === void 0 ? void 0 : _d.filter(function (filter) { return filter.background; }).filter(function (filter) {
+                                    return BACKGROUND_FILTER_FIELD_MATCHES.find(function (bgFilter) {
+                                        var _a;
+                                        return (_a = filter.field) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes(bgFilter);
+                                    });
+                                }).filter(function (filter) {
+                                    return BACKGROUND_FILTERS_VALUE_FLAGS.every(function (flag) {
+                                        switch (filter.type) {
+                                            case 'range':
+                                                var rangeFilter = filter;
+                                                return rangeFilter.value !== flag;
+                                            case 'value':
+                                            default:
+                                                var valueFilter = filter;
+                                                return valueFilter.value !== flag;
+                                        }
+                                    });
+                                });
+                                if (hasCategoryBackgroundFilters === null || hasCategoryBackgroundFilters === void 0 ? void 0 : hasCategoryBackgroundFilters.length) {
+                                    this.pageType = 'category';
+                                }
+                            }
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        });
         // add 'afterSearch' middleware
         _this.eventManager.on('afterSearch', function (search, next) { return __awaiter(_this, void 0, void 0, function () {
             var config, redirectURL, searchStore, nonBackgroundFilters;
@@ -399,6 +509,7 @@ var SearchController = /** @class */ (function (_super) {
                         if (redirectURL && ((_d = (_c = config === null || config === void 0 ? void 0 : config.settings) === null || _c === void 0 ? void 0 : _c.redirects) === null || _d === void 0 ? void 0 : _d.merchandising) && !((_f = (_e = search === null || search === void 0 ? void 0 : search.response) === null || _e === void 0 ? void 0 : _e.filters) === null || _f === void 0 ? void 0 : _f.length) && !searchStore.loaded) {
                             //set loaded to true to prevent infinite search/reloading from happening
                             searchStore.loaded = true;
+                            this.track.redirect(redirectURL);
                             window.location.replace(redirectURL);
                             return [2 /*return*/, false];
                         }
@@ -558,17 +669,15 @@ var SearchController = /** @class */ (function (_super) {
             }
             params.tracking = params.tracking || {};
             params.tracking.domain = window.location.href;
-            var userId = this.tracker.getUserId();
+            var _e = this.tracker.getContext(), userId = _e.userId, sessionId = _e.sessionId, pageLoadId = _e.pageLoadId, shopperId = _e.shopperId;
             if (userId) {
                 params.tracking.userId = userId;
             }
-            var sessionId = this.tracker.getContext().sessionId;
             if (sessionId) {
                 params.tracking.sessionId = sessionId;
             }
-            var pageId = this.tracker.getContext().pageLoadId;
-            if (pageId) {
-                params.tracking.pageLoadId = pageId;
+            if (pageLoadId) {
+                params.tracking.pageLoadId = pageLoadId;
             }
             if (!((_d = (_c = this.config.globals) === null || _c === void 0 ? void 0 : _c.personalization) === null || _d === void 0 ? void 0 : _d.disabled)) {
                 var cartItems = this.tracker.cookies.cart.get();
@@ -581,7 +690,6 @@ var SearchController = /** @class */ (function (_super) {
                     params.personalization = params.personalization || {};
                     params.personalization.lastViewed = lastViewedItems.join(',');
                 }
-                var shopperId = this.tracker.getShopperId();
                 if (shopperId) {
                     params.personalization = params.personalization || {};
                     params.personalization.shopper = shopperId;
@@ -641,3 +749,66 @@ function generateHrefSelector(element, href, levels) {
     return;
 }
 exports.generateHrefSelector = generateHrefSelector;
+function getSearchRedirectSchemaData(_a) {
+    var redirectURL = _a.redirectURL;
+    return {
+        redirect: redirectURL,
+    };
+}
+function getSearchSchemaData(_a) {
+    var _b, _c, _d, _e, _f, _g, _h, _j;
+    var params = _a.params, store = _a.store, results = _a.results;
+    var filters = (_b = params.filters) === null || _b === void 0 ? void 0 : _b.reduce(function (acc, filter) {
+        var _a;
+        var _b, _c, _d, _e;
+        var key = filter.background ? 'bgfilter' : 'filter';
+        acc[key] = acc[key] || [];
+        var value = filter.type === 'range' &&
+            !isNaN((_b = filter.value) === null || _b === void 0 ? void 0 : _b.low) &&
+            !isNaN((_c = filter.value) === null || _c === void 0 ? void 0 : _c.low)
+            ? ["low=".concat((_d = filter.value) === null || _d === void 0 ? void 0 : _d.low), "high=".concat((_e = filter.value) === null || _e === void 0 ? void 0 : _e.high)]
+            : ["".concat(filter.value)];
+        var existing = acc[key].find(function (item) { return item.field === filter.field; });
+        if (existing && !existing.value.includes(value[0])) {
+            (_a = existing.value).push.apply(_a, value);
+        }
+        else {
+            acc[key].push({
+                field: filter.field,
+                value: value,
+            });
+        }
+        return acc;
+    }, {});
+    return __assign(__assign({ q: ((_d = (_c = params.search) === null || _c === void 0 ? void 0 : _c.query) === null || _d === void 0 ? void 0 : _d.string) || '', correctedQuery: (_e = params.search) === null || _e === void 0 ? void 0 : _e.originalQuery }, filters), { sort: [
+            {
+                field: (_f = store.sorting.current) === null || _f === void 0 ? void 0 : _f.field,
+                dir: (_g = store.sorting.current) === null || _g === void 0 ? void 0 : _g.direction,
+            },
+        ], pagination: {
+            totalResults: store.pagination.totalResults,
+            page: store.pagination.page,
+            resultsPerPage: store.pagination.pageSize,
+        }, merchandising: {
+            personalized: store.merchandising.personalized,
+            redirect: store.merchandising.redirect,
+            triggeredCampaigns: (((_h = store.merchandising.campaigns) === null || _h === void 0 ? void 0 : _h.length) &&
+                ((_j = store.merchandising.campaigns) === null || _j === void 0 ? void 0 : _j.map(function (campaign) {
+                    var experiement = store.merchandising.experiments.find(function (experiment) { return experiment.campaignId === campaign.id; });
+                    return {
+                        id: campaign.id,
+                        experimentId: experiement === null || experiement === void 0 ? void 0 : experiement.experimentId,
+                        variationId: experiement === null || experiement === void 0 ? void 0 : experiement.variationId,
+                    };
+                }))) ||
+                undefined,
+        }, results: (results === null || results === void 0 ? void 0 : results.map(function (result) {
+            var core = result.mappings.core;
+            return {
+                uid: core.uid || '',
+                // childUid: core.uid,
+                sku: core.sku,
+                // childSku: core.sku,
+            };
+        })) || [] });
+}

package/dist/esm/Autocomplete/AutocompleteController.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { StorageStore } from '@searchspring/snap-store-mobx';
+import { StorageStore, Product, Banner } from '@searchspring/snap-store-mobx';
 import { AbstractController } from '../Abstract/AbstractController';
 import { ControllerTypes } from '../types';
 import { AutocompleteStore } from '@searchspring/snap-store-mobx';
@@ -8,14 +8,26 @@ import type { AutocompleteRequestModel } from '@searchspring/snapi-types';
 export declare const INPUT_DELAY = 200;
 type AutocompleteTrackMethods = {
     product: {
-        click: (e: MouseEvent, result: any) => void;
+        clickThrough: (e: MouseEvent, result: Product) => void;
+        click: (e: MouseEvent, result: Product | Banner) => void;
+        render: (result: Product) => void;
+        impression: (result: Product) => void;
+        addToCart: (results: Product) => void;
     };
+    redirect: (redirectURL: string) => void;
 };
 export declare class AutocompleteController extends AbstractController {
     type: ControllerTypes;
     store: AutocompleteStore;
     config: AutocompleteControllerConfig;
     storage: StorageStore;
+    events: {
+        product: Record<string, {
+            clickThrough?: boolean;
+            impression?: boolean;
+            render?: boolean;
+        }>;
+    };
     constructor(config: AutocompleteControllerConfig, { client, store, urlManager, eventManager, profiler, logger, tracker }: ControllerServices, context?: ContextVariables);
     track: AutocompleteTrackMethods;
     get params(): AutocompleteRequestModel;
@@ -39,6 +51,7 @@ export declare class AutocompleteController extends AbstractController {
     bind(): Promise<void>;
     searchTrending: () => Promise<void>;
     search: () => Promise<void>;
+    addToCart: (product: Product) => Promise<void>;
 }
 export {};
 //# sourceMappingURL=AutocompleteController.d.ts.map

package/dist/esm/Autocomplete/AutocompleteController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AutocompleteController.d.ts","sourceRoot":"","sources":["../../../src/Autocomplete/AutocompleteController.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAa,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,4BAA4B,EAAiC,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAElI,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAG1E,eAAO,MAAM,WAAW,MAAM,CAAC;AA+B/B,KAAK,wBAAwB,GAAG;IAC/B,OAAO,EAAE;QACR,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,KAAK,IAAI,CAAC;KAC5C,CAAC;CACF,CAAC;AAEF,qBAAa,sBAAuB,SAAQ,kBAAkB;IACtD,IAAI,kBAAgC;IACnC,KAAK,EAAE,iBAAiB,CAAC;IACzB,MAAM,EAAE,4BAA4B,CAAC;IACtC,OAAO,EAAE,YAAY,CAAC;gBAG5B,MAAM,EAAE,4BAA4B,EACpC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IAyD3B,KAAK,EAAE,wBAAwB,CAO7B;IAEF,IAAI,MAAM,IAAI,wBAAwB,CA0CrC;IAEK,UAAU,CAAC,YAAY,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BhE,KAAK,IAAI,IAAI;IASb,QAAQ;;0BAEc,aAAa,KAAG,QAAQ,OAAO,GAAG,SAAS,CAAC;wBAkDpD,aAAa,KAAG,IAAI;uBAMrB,UAAU,KAAG,IAAI;4BAQN,MAAM,SAAS,CAAC,gBAAgB,CAAC,KAAG,QAAQ,IAAI,CAAC;mCAgDhD,MAAM,WAAW,CAAC,gBAAgB,CAAC,KAAG,IAAI;uBAqBtD,KAAK;;;;uBAyDL,UAAU,KAAG,IAAI;;MAS5B;IAEF,MAAM,IAAI,IAAI;IAgBR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgF3B,cAAc,QAAa,QAAQ,IAAI,CAAC,CAwBtC;IAEF,MAAM,QAAa,QAAQ,IAAI,CAAC,CA0I9B;CACF"}
+{"version":3,"file":"AutocompleteController.d.ts","sourceRoot":"","sources":["../../../src/Autocomplete/AutocompleteController.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAa,OAAO,EAAqB,MAAM,EAAE,MAAM,+BAA+B,CAAC;AAC5G,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,KAAK,EAAE,4BAA4B,EAAiC,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAElI,OAAO,KAAK,EAAE,wBAAwB,EAAgE,MAAM,2BAA2B,CAAC;AAWxI,eAAO,MAAM,WAAW,MAAM,CAAC;AA+B/B,KAAK,wBAAwB,GAAG;IAC/B,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,GAAG,MAAM,KAAK,IAAI,CAAC;QACzD,MAAM,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QAClC,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;QACtC,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;KACtC,CAAC;IACF,QAAQ,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC,CAAC;AAEF,qBAAa,sBAAuB,SAAQ,kBAAkB;IACtD,IAAI,kBAAgC;IACnC,KAAK,EAAE,iBAAiB,CAAC;IACzB,MAAM,EAAE,4BAA4B,CAAC;IACtC,OAAO,EAAE,YAAY,CAAC;IAE7B,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,4BAA4B,EACpC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAC1F,OAAO,CAAC,EAAE,gBAAgB;IA0D3B,KAAK,EAAE,wBAAwB,CAqD7B;IAEF,IAAI,MAAM,IAAI,wBAAwB,CAwCrC;IAEK,UAAU,CAAC,YAAY,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2BhE,KAAK,IAAI,IAAI;IASb,QAAQ;;0BAEc,aAAa,KAAG,QAAQ,OAAO,GAAG,SAAS,CAAC;wBAkDpD,aAAa,KAAG,IAAI;uBAMrB,UAAU,KAAG,IAAI;4BAQN,MAAM,SAAS,CAAC,gBAAgB,CAAC,KAAG,QAAQ,IAAI,CAAC;mCAgDhD,MAAM,WAAW,CAAC,gBAAgB,CAAC,KAAG,IAAI;uBAqBtD,KAAK;;;;uBAyDL,UAAU,KAAG,IAAI;;MAS5B;IAEF,MAAM,IAAI,IAAI;IAgBR,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgF3B,cAAc,QAAa,QAAQ,IAAI,CAAC,CAwBtC;IAEF,MAAM,QAAa,QAAQ,IAAI,CAAC,CA6I9B;IAEF,SAAS,YAAmB,OAAO,KAAG,QAAQ,IAAI,CAAC,CAGjD;CACF"}

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"}