@searchspring/snap-controller 0.72.1 → 0.73.5

package/dist/cjs/Recommendation/RecommendationController.js

@@ -70,7 +70,6 @@ var deepmerge_1 = __importDefault(require("deepmerge"));
 var snap_store_mobx_1 = require("@searchspring/snap-store-mobx");
 var AbstractController_1 = require("../Abstract/AbstractController");
 var types_1 = require("../types");
-var beacon_1 = require("@searchspring/beacon");
 var isClickWithinProductLink_1 = require("../utils/isClickWithinProductLink");
 var defaultConfig = {
     id: 'recommend',
@@ -86,69 +85,101 @@ var RecommendationController = /** @class */ (function (_super) {
         var _b;
         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.recommendation;
-        _this.events = {
-            product: {},
-        };
+        _this.events = {};
         _this.track = {
             product: {
                 clickThrough: function (e, result) {
-                    var _a, _b;
-                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.clickThrough)
+                    var _a, _b, _c, _d;
+                    var responseId = result.responseId;
+                    if ((_b = (_a = _this.events[responseId]) === null || _a === void 0 ? void 0 : _a.product[result.id]) === null || _b === void 0 ? void 0 : _b.productClickThrough)
                         return;
-                    var data = getRecommendationsSchemaData({ store: _this.store, results: [result] });
+                    var beaconResult = {
+                        type: result.type,
+                        uid: result.id,
+                        parentId: result.id,
+                        sku: (_c = result.mappings.core) === null || _c === void 0 ? void 0 : _c.sku,
+                    };
+                    var data = {
+                        tag: _this.store.profile.tag,
+                        responseId: responseId,
+                        results: [beaconResult],
+                    };
                     _this.eventManager.fire('track.product.clickThrough', { controller: _this, event: e, product: result, trackEvent: data });
-                    _this.tracker.events.recommendations.clickThrough({ 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].clickThrough = true;
+                    _this.tracker.events.recommendations.clickThrough({ data: data, siteId: (_d = _this.config.globals) === null || _d === void 0 ? void 0 : _d.siteId });
+                    _this.events[responseId].product[result.id] = _this.events[responseId].product[result.id] || {};
+                    _this.events[responseId].product[result.id].productClickThrough = true;
                 },
                 click: function (e, result) {
-                    var _a;
-                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.click) {
-                        return;
-                    }
+                    var _a, _b, _c, _d, _e;
+                    var responseId = result.responseId;
                     if (result.type === 'banner') {
-                        return;
+                        if ((_b = (_a = _this.events[responseId]) === null || _a === void 0 ? void 0 : _a.product[result.id]) === null || _b === void 0 ? void 0 : _b.inlineBannerClickThrough) {
+                            return;
+                        }
+                        _this.track.product.clickThrough(e, result);
+                        _this.events[responseId].product[result.id] = _this.events[responseId].product[result.id] || {};
+                        _this.events[responseId].product[result.id].inlineBannerClickThrough = true;
+                        setTimeout(function () {
+                            _this.events[responseId].product[result.id].inlineBannerClickThrough = false;
+                        }, isClickWithinProductLink_1.CLICK_DUPLICATION_TIMEOUT);
+                    }
+                    else if ((0, isClickWithinProductLink_1.isClickWithinProductLink)(e, result)) {
+                        if ((_e = (_d = (_c = _this.events) === null || _c === void 0 ? void 0 : _c[responseId]) === null || _d === void 0 ? void 0 : _d.product[result.id]) === null || _e === void 0 ? void 0 : _e.productClickThrough) {
+                            return;
+                        }
+                        _this.track.product.clickThrough(e, result);
+                        _this.events[responseId].product[result.id] = _this.events[responseId].product[result.id] || {};
+                        _this.events[responseId].product[result.id].productClickThrough = true;
+                        setTimeout(function () {
+                            _this.events[responseId].product[result.id].productClickThrough = false;
+                        }, isClickWithinProductLink_1.CLICK_DUPLICATION_TIMEOUT);
                     }
-                    (0, isClickWithinProductLink_1.isClickWithinProductLink)(e, result) && _this.track.product.clickThrough(e, result);
-                    _this.events.product[result.id] = _this.events.product[result.id] || {};
-                    _this.events.product[result.id].click = true;
-                    setTimeout(function () {
-                        _this.events.product[result.id].click = false;
-                    }, isClickWithinProductLink_1.CLICK_DUPLICATION_TIMEOUT);
                 },
                 impression: function (result) {
-                    var _a, _b, _c;
-                    if (((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.impression) || !((_b = _this.events.product[result.id]) === null || _b === void 0 ? void 0 : _b.render))
+                    var _a, _b, _c, _d;
+                    var responseId = result.responseId;
+                    if ((_b = (_a = _this.events[responseId]) === null || _a === void 0 ? void 0 : _a.product[result.id]) === null || _b === void 0 ? void 0 : _b.impression) {
                         return;
-                    var data = getRecommendationsSchemaData({ store: _this.store, results: [result] });
+                    }
+                    var item = {
+                        type: result.type,
+                        uid: result.id,
+                        parentId: result.id,
+                        sku: (_c = result.mappings.core) === null || _c === void 0 ? void 0 : _c.sku,
+                    };
+                    var data = {
+                        tag: _this.store.profile.tag,
+                        responseId: responseId,
+                        results: [item],
+                        banners: [],
+                    };
                     _this.eventManager.fire('track.product.impression', { controller: _this, product: result, trackEvent: data });
-                    _this.tracker.events.recommendations.impression({ data: data, siteId: (_c = _this.config.globals) === null || _c === void 0 ? void 0 : _c.siteId });
-                    _this.events.product[result.id] = _this.events.product[result.id] || {};
-                    _this.events.product[result.id].impression = true;
-                    return data;
-                },
-                render: function (result) {
-                    var _a, _b;
-                    if ((_a = _this.events.product[result.id]) === null || _a === void 0 ? void 0 : _a.render)
-                        return;
-                    var data = getRecommendationsSchemaData({ store: _this.store, results: [result] });
-                    _this.eventManager.fire('track.product.render', { controller: _this, product: result, trackEvent: data });
-                    _this.tracker.events.recommendations.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;
-                    return data;
+                    _this.tracker.events.recommendations.impression({ data: data, siteId: (_d = _this.config.globals) === null || _d === void 0 ? void 0 : _d.siteId });
+                    _this.events[responseId].product[result.id] = _this.events[responseId].product[result.id] || {};
+                    _this.events[responseId].product[result.id].impression = true;
                 },
                 addToCart: function (result) {
-                    var _a;
-                    var data = getRecommendationsAddtocartSchemaData({ store: _this.store, results: [result] });
+                    var _a, _b, _c;
+                    var responseId = result.responseId;
+                    var product = {
+                        parentId: result.id,
+                        uid: result.id,
+                        sku: (_a = result.mappings.core) === null || _a === void 0 ? void 0 : _a.sku,
+                        qty: result.quantity || 1,
+                        price: Number((_b = result.mappings.core) === null || _b === void 0 ? void 0 : _b.price),
+                    };
+                    var data = {
+                        responseId: responseId,
+                        tag: _this.store.profile.tag,
+                        results: [product],
+                    };
                     _this.eventManager.fire('track.product.addToCart', { controller: _this, product: result, trackEvent: data });
-                    _this.tracker.events.recommendations.addToCart({ data: data, siteId: (_a = _this.config.globals) === null || _a === void 0 ? void 0 : _a.siteId });
-                    return data;
+                    _this.tracker.events.recommendations.addToCart({ data: data, siteId: (_c = _this.config.globals) === null || _c === void 0 ? void 0 : _c.siteId });
                 },
             },
         };
         _this.search = function () { return __awaiter(_this, void 0, void 0, function () {
-            var params, err_1, searchProfile, response, afterSearchProfile, err_2, afterStoreProfile, err_3, err_4;
+            var params, err_1, searchProfile, response, responseId, afterSearchProfile, err_2, afterStoreProfile, err_3, err_4;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -160,8 +191,6 @@ var RecommendationController = /** @class */ (function (_super) {
                         _a.label = 2;
                     case 2:
                         params = this.params;
-                        // reset events for new search
-                        this.events = { product: {} };
                         this.store.loading = true;
                         _a.label = 3;
                     case 3:
@@ -191,6 +220,8 @@ var RecommendationController = /** @class */ (function (_super) {
                         response = _a.sent();
                         searchProfile.stop();
                         this.log.profile(searchProfile);
+                        responseId = response.responseId;
+                        this.events[responseId] = this.events[responseId] || { product: {} };
                         afterSearchProfile = this.profiler.create({ type: 'event', name: 'afterSearch', context: params }).start();
                         _a.label = 8;
                     case 8:
@@ -327,8 +358,7 @@ var RecommendationController = /** @class */ (function (_super) {
         _this.config = (0, deepmerge_1.default)(defaultConfig, _this.config);
         _this.store.setConfig(_this.config);
         _this.eventManager.on('afterStore', function (search, next) { return __awaiter(_this, void 0, void 0, function () {
-            var controller, products, data;
-            var _this = this;
+            var controller, responseId, data;
             var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
@@ -336,22 +366,12 @@ var RecommendationController = /** @class */ (function (_super) {
                     case 1:
                         _b.sent();
                         controller = search.controller;
+                        responseId = search.response.responseId;
                         if (controller.store.loaded && !controller.store.error) {
-                            products = controller.store.results.filter(function (result) { return result.type === 'product'; });
-                            if (products.length === 0 && !search.response._cached) {
-                                data = getRecommendationsSchemaData({ store: this.store });
-                                this.eventManager.fire('track.product.render', { controller: this, trackEvent: data });
+                            if (!search.response._cached) {
+                                data = { responseId: responseId, tag: controller.store.profile.tag };
                                 this.tracker.events.recommendations.render({ data: data, siteId: (_a = this.config.globals) === null || _a === void 0 ? void 0 : _a.siteId });
                             }
-                            products.forEach(function (result) {
-                                if (!search.response._cached) {
-                                    _this.track.product.render(result);
-                                }
-                                else {
-                                    _this.events.product[result.id] = _this.events.product[result.id] || {};
-                                    _this.events.product[result.id].render = true;
-                                }
-                            });
                         }
                         return [2 /*return*/];
                 }
@@ -397,34 +417,3 @@ var RecommendationController = /** @class */ (function (_super) {
     return RecommendationController;
 }(AbstractController_1.AbstractController));
 exports.RecommendationController = RecommendationController;
-function getRecommendationsAddtocartSchemaData(_a) {
-    var store = _a.store, results = _a.results;
-    return {
-        tag: store.profile.tag,
-        results: (results === null || results === void 0 ? void 0 : results.map(function (result) {
-            var core = result.mappings.core;
-            return {
-                uid: (core === null || core === void 0 ? void 0 : core.uid) || '',
-                sku: core === null || core === void 0 ? void 0 : core.sku,
-                price: Number(core === null || core === void 0 ? void 0 : core.price),
-                qty: result.quantity || 1,
-            };
-        })) || [],
-    };
-}
-function getRecommendationsSchemaData(_a) {
-    var store = _a.store, results = _a.results;
-    return {
-        tag: store.profile.tag,
-        results: (results === null || results === void 0 ? void 0 : results.map(function (result) {
-            var core = result.mappings.core;
-            var position = result.position;
-            return {
-                type: beacon_1.ItemTypeEnum.Product,
-                position: position,
-                uid: core.uid || '',
-                sku: core.sku,
-            };
-        })) || [],
-    };
-}

package/dist/cjs/Search/SearchController.d.ts

@@ -1,18 +1,25 @@
 import { AbstractController } from '../Abstract/AbstractController';
-import { StorageStore } from '@searchspring/snap-store-mobx';
+import { StorageStore, MerchandisingContentBanner } from '@searchspring/snap-store-mobx';
 import { ControllerTypes } from '../types';
 import type { Product, Banner, SearchStore } from '@searchspring/snap-store-mobx';
 import type { SearchControllerConfig, ControllerServices, ContextVariables } from '../types';
 import { type SearchRequestModel } from '@searchspring/snapi-types';
 type SearchTrackMethods = {
+    banner: {
+        click: (e: MouseEvent, merchandisingBanner: MerchandisingContentBanner) => void;
+        clickThrough: (e: MouseEvent, merchandisingBanner: MerchandisingContentBanner) => void;
+        impression: (merchandisingBanner: MerchandisingContentBanner) => void;
+    };
     product: {
-        clickThrough: (e: MouseEvent, result: Product) => void;
+        clickThrough: (e: MouseEvent, result: Product | Banner) => void;
         click: (e: MouseEvent, result: Product | Banner) => void;
-        render: (result: Product) => void;
-        impression: (result: Product) => void;
+        impression: (result: Product | Banner) => void;
         addToCart: (results: Product) => void;
     };
-    redirect: (redirectURL: string) => void;
+    redirect: ({ redirectURL, responseId }: {
+        redirectURL: string;
+        responseId: string;
+    }) => void;
 };
 export declare class SearchController extends AbstractController {
     type: ControllerTypes;

package/dist/cjs/Search/SearchController.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SearchController.d.ts","sourceRoot":"","sources":["../../../src/Search/SearchController.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAa,MAAM,+BAA+B,CAAC;AAExE,OAAO,EAAE,eAAe,EAAuB,MAAM,UAAU,CAAC;AAEhE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAc,MAAM,+BAA+B,CAAC;AAC9F,OAAO,KAAK,EACX,sBAAsB,EAGtB,kBAAkB,EAClB,gBAAgB,EAIhB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,KAAK,kBAAkB,EAYvB,MAAM,2BAA2B,CAAC;AAmCnC,KAAK,kBAAkB,GAAG;IACzB,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;AAGF,qBAAa,gBAAiB,SAAQ,kBAAkB;IAChD,IAAI,kBAA0B;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;IACvC,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,eAAe,CAAwC;IAC/D,OAAO,CAAC,IAAI,CAEV;IACF,OAAO,CAAC,MAAM,CAUM;gBAGnB,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;IAmQ3B,KAAK,EAAE,kBAAkB,CA+FvB;IAEF,IAAI,MAAM,IAAI,kBAAkB,CA8C/B;IAED,MAAM,QAAa,QAAQ,IAAI,CAAC,CAyN9B;IAEF,SAAS,cAAqB,OAAO,EAAE,GAAG,OAAO,KAAG,QAAQ,IAAI,CAAC,CAQ/D;CACF;AAwBD,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,GAAG,kBAAkB,CAiBxF;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,GAAG,SAAS,CAgCvG"}
+{"version":3,"file":"SearchController.d.ts","sourceRoot":"","sources":["../../../src/Search/SearchController.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAa,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAEpG,OAAO,EAAE,eAAe,EAAuB,MAAM,UAAU,CAAC;AAEhE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAc,MAAM,+BAA+B,CAAC;AAC9F,OAAO,KAAK,EACX,sBAAsB,EAGtB,kBAAkB,EAClB,gBAAgB,EAIhB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,KAAK,kBAAkB,EAYvB,MAAM,2BAA2B,CAAC;AAsCnC,KAAK,kBAAkB,GAAG;IACzB,MAAM,EAAE;QACP,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,0BAA0B,KAAK,IAAI,CAAC;QAChF,YAAY,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,0BAA0B,KAAK,IAAI,CAAC;QACvF,UAAU,EAAE,CAAC,mBAAmB,EAAE,0BAA0B,KAAK,IAAI,CAAC;KACtE,CAAC;IACF,OAAO,EAAE;QACR,YAAY,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC;QAChE,KAAK,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC;QACzD,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,KAAK,IAAI,CAAC;QAC/C,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;KACtC,CAAC;IACF,QAAQ,EAAE,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,EAAE;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CAC7F,CAAC;AAEF,qBAAa,gBAAiB,SAAQ,kBAAkB;IAChD,IAAI,kBAA0B;IAC7B,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;IACvC,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,eAAe,CAAwC;IAC/D,OAAO,CAAC,IAAI,CAEV;IACF,OAAO,CAAC,MAAM,CAgBP;gBAGN,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;IAsP3B,KAAK,EAAE,kBAAkB,CAqKvB;IAEF,IAAI,MAAM,IAAI,kBAAkB,CA8C/B;IAED,MAAM,QAAa,QAAQ,IAAI,CAAC,CA0N9B;IAEF,SAAS,cAAqB,OAAO,EAAE,GAAG,OAAO,KAAG,QAAQ,IAAI,CAAC,CAQ/D;CACF;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,kBAAkB,GAAG,kBAAkB,CAiBxF;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAI,GAAG,MAAM,GAAG,SAAS,CAgCvG"}