@searchspring/snap-controller 0.20.0

package/dist/cjs/Search/SearchController.js

@@ -0,0 +1,429 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchController = void 0;
+var deepmerge_1 = __importDefault(require("deepmerge"));
+var AbstractController_1 = require("../Abstract/AbstractController");
+var snap_store_mobx_1 = require("@searchspring/snap-store-mobx");
+var getParams_1 = require("../utils/getParams");
+var HEIGHT_CHECK_INTERVAL = 50;
+var defaultConfig = {
+    id: 'search',
+    globals: {},
+    settings: {
+        redirects: {
+            merchandising: true,
+            singleResult: true,
+        },
+        facets: {
+            trim: true,
+            pinFiltered: true,
+        },
+    },
+};
+var SearchController = /** @class */ (function (_super) {
+    __extends(SearchController, _super);
+    function SearchController(config, _a) {
+        var client = _a.client, store = _a.store, urlManager = _a.urlManager, eventManager = _a.eventManager, profiler = _a.profiler, logger = _a.logger, tracker = _a.tracker;
+        var _this = _super.call(this, config, { client: client, store: store, urlManager: urlManager, eventManager: eventManager, profiler: profiler, logger: logger, tracker: tracker }) || this;
+        _this.type = 'search';
+        _this.track = {
+            product: {
+                click: function (e, result) {
+                    var _a;
+                    // store scroll position
+                    if (_this.config.settings.infinite) {
+                        var stringyParams = _this.storage.get('lastStringyParams');
+                        var scrollMap = {};
+                        scrollMap[stringyParams] = window.scrollY;
+                        _this.storage.set('scrollMap', scrollMap);
+                    }
+                    // track
+                    var _b = result.attributes, intellisuggestData = _b.intellisuggestData, intellisuggestSignature = _b.intellisuggestSignature;
+                    var target = e.target;
+                    var href = (target === null || target === void 0 ? void 0 : target.href) || ((_a = result.mappings.core) === null || _a === void 0 ? void 0 : _a.url) || undefined;
+                    var event = _this.tracker.track.product.click({
+                        intellisuggestData: intellisuggestData,
+                        intellisuggestSignature: intellisuggestSignature,
+                        href: href,
+                    });
+                    _this.eventManager.fire('track.product.click', { controller: _this, event: e, result: result, trackEvent: event });
+                    return event;
+                },
+            },
+        };
+        _this.search = function () { return __awaiter(_this, void 0, void 0, function () {
+            var params, stringyParams, prevStringyParams, err_1, preventBackfill, dontBackfill, searchProfile, _a, meta, response, previousResults_1, backfills, page, backfillParams, backfillResponses, afterSearchProfile, err_2, afterStoreProfile, err_3, err_4;
+            var _b, _c, _d, _e, _f, _g, _h;
+            return __generator(this, function (_j) {
+                switch (_j.label) {
+                    case 0:
+                        if (!!this.initialized) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.init()];
+                    case 1:
+                        _j.sent();
+                        _j.label = 2;
+                    case 2:
+                        params = this.params;
+                        _j.label = 3;
+                    case 3:
+                        _j.trys.push([3, 20, , 21]);
+                        stringyParams = JSON.stringify(params);
+                        prevStringyParams = this.storage.get('lastStringyParams');
+                        if (stringyParams == prevStringyParams) {
+                            // no param change - not searching
+                            return [2 /*return*/];
+                        }
+                        _j.label = 4;
+                    case 4:
+                        _j.trys.push([4, 6, , 7]);
+                        return [4 /*yield*/, this.eventManager.fire('beforeSearch', {
+                                controller: this,
+                                request: params,
+                            })];
+                    case 5:
+                        _j.sent();
+                        return [3 /*break*/, 7];
+                    case 6:
+                        err_1 = _j.sent();
+                        if ((err_1 === null || err_1 === void 0 ? void 0 : err_1.message) == 'cancelled') {
+                            this.log.warn("'beforeSearch' middleware cancelled");
+                            return [2 /*return*/];
+                        }
+                        else {
+                            this.log.error("error in 'beforeSearch' middleware");
+                            throw err_1;
+                        }
+                        return [3 /*break*/, 7];
+                    case 7:
+                        if (this.config.settings.infinite) {
+                            preventBackfill = ((_b = this.config.settings.infinite) === null || _b === void 0 ? void 0 : _b.backfill) && !this.store.results.length && ((_c = params.pagination) === null || _c === void 0 ? void 0 : _c.page) > this.config.settings.infinite.backfill;
+                            dontBackfill = !((_d = this.config.settings.infinite) === null || _d === void 0 ? void 0 : _d.backfill) && !this.store.results.length && ((_e = params.pagination) === null || _e === void 0 ? void 0 : _e.page) > 1;
+                            if (preventBackfill || dontBackfill) {
+                                this.storage.set('scrollMap', {});
+                                this.urlManager.set('page', 1).go();
+                                return [2 /*return*/];
+                            }
+                        }
+                        searchProfile = this.profiler.create({ type: 'event', name: 'search', context: params }).start();
+                        return [4 /*yield*/, this.client.search(params)];
+                    case 8:
+                        _a = _j.sent(), meta = _a[0], response = _a[1];
+                        if (!response.meta) {
+                            /**
+                             * MockClient will overwrite the client search() method and use
+                             * SearchData to return mock data which already contains meta data
+                             */
+                            response.meta = meta;
+                        }
+                        if (!(this.config.settings.infinite && ((_f = params.pagination) === null || _f === void 0 ? void 0 : _f.page) > 1)) return [3 /*break*/, 11];
+                        previousResults_1 = ((_g = this.store.data) === null || _g === void 0 ? void 0 : _g.results) || [];
+                        if (!(((_h = this.config.settings) === null || _h === void 0 ? void 0 : _h.infinite.backfill) && !previousResults_1.length)) return [3 /*break*/, 10];
+                        backfills = [];
+                        for (page = 1; page < params.pagination.page; page++) {
+                            backfillParams = (0, deepmerge_1.default)(__assign({}, params), { pagination: { page: page } });
+                            backfills.push(this.client.search(backfillParams));
+                        }
+                        return [4 /*yield*/, Promise.all(backfills)];
+                    case 9:
+                        backfillResponses = _j.sent();
+                        backfillResponses.map(function (_a) {
+                            var meta = _a[0], data = _a[1];
+                            previousResults_1 = previousResults_1.concat(data.results);
+                        });
+                        _j.label = 10;
+                    case 10:
+                        response.results = __spreadArray(__spreadArray([], previousResults_1, true), (response.results || []), true);
+                        _j.label = 11;
+                    case 11:
+                        searchProfile.stop();
+                        this.log.profile(searchProfile);
+                        afterSearchProfile = this.profiler.create({ type: 'event', name: 'afterSearch', context: params }).start();
+                        _j.label = 12;
+                    case 12:
+                        _j.trys.push([12, 14, , 15]);
+                        return [4 /*yield*/, this.eventManager.fire('afterSearch', {
+                                controller: this,
+                                request: params,
+                                response: response,
+                            })];
+                    case 13:
+                        _j.sent();
+                        return [3 /*break*/, 15];
+                    case 14:
+                        err_2 = _j.sent();
+                        if ((err_2 === null || err_2 === void 0 ? void 0 : err_2.message) == 'cancelled') {
+                            this.log.warn("'afterSearch' middleware cancelled");
+                            afterSearchProfile.stop();
+                            return [2 /*return*/];
+                        }
+                        else {
+                            this.log.error("error in 'afterSearch' middleware");
+                            throw err_2;
+                        }
+                        return [3 /*break*/, 15];
+                    case 15:
+                        afterSearchProfile.stop();
+                        this.log.profile(afterSearchProfile);
+                        // update the store
+                        this.store.update(response);
+                        afterStoreProfile = this.profiler.create({ type: 'event', name: 'afterStore', context: params }).start();
+                        _j.label = 16;
+                    case 16:
+                        _j.trys.push([16, 18, , 19]);
+                        return [4 /*yield*/, this.eventManager.fire('afterStore', {
+                                controller: this,
+                                request: params,
+                                response: response,
+                            })];
+                    case 17:
+                        _j.sent();
+                        return [3 /*break*/, 19];
+                    case 18:
+                        err_3 = _j.sent();
+                        if ((err_3 === null || err_3 === void 0 ? void 0 : err_3.message) == 'cancelled') {
+                            this.log.warn("'afterStore' middleware cancelled");
+                            afterStoreProfile.stop();
+                            return [2 /*return*/];
+                        }
+                        else {
+                            this.log.error("error in 'afterStore' middleware");
+                            throw err_3;
+                        }
+                        return [3 /*break*/, 19];
+                    case 19:
+                        afterStoreProfile.stop();
+                        this.log.profile(afterStoreProfile);
+                        return [3 /*break*/, 21];
+                    case 20:
+                        err_4 = _j.sent();
+                        if (err_4) {
+                            switch (err_4) {
+                                case 429:
+                                    this.store.error = {
+                                        code: 429,
+                                        type: snap_store_mobx_1.ErrorType.WARNING,
+                                        message: 'Too many requests try again later',
+                                    };
+                                    this.log.warn(this.store.error);
+                                    break;
+                                case 500:
+                                    this.store.error = {
+                                        code: 500,
+                                        type: snap_store_mobx_1.ErrorType.ERROR,
+                                        message: 'Invalid Search Request or Service Unavailable',
+                                    };
+                                    this.log.error(this.store.error);
+                                    break;
+                                default:
+                                    this.log.error(err_4);
+                                    break;
+                            }
+                            this.store.loading = false;
+                        }
+                        return [3 /*break*/, 21];
+                    case 21: return [2 /*return*/];
+                }
+            });
+        }); };
+        // deep merge config with defaults
+        _this.config = (0, deepmerge_1.default)(defaultConfig, _this.config);
+        _this.store.setConfig(_this.config);
+        _this.storage = new snap_store_mobx_1.StorageStore({
+            type: snap_store_mobx_1.StorageType.SESSION,
+            key: "ss-controller-".concat(_this.config.id),
+        });
+        // set last params to undefined for compare in search
+        _this.storage.set('lastStringyParams', undefined);
+        // add 'beforeSearch' middleware
+        _this.eventManager.on('beforeSearch', function (search, next) { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        search.controller.store.loading = true;
+                        return [4 /*yield*/, next()];
+                    case 1:
+                        _a.sent();
+                        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;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+            return __generator(this, function (_q) {
+                switch (_q.label) {
+                    case 0:
+                        config = search.controller.config;
+                        redirectURL = (_b = (_a = search.response) === null || _a === void 0 ? void 0 : _a.merchandising) === null || _b === void 0 ? void 0 : _b.redirect;
+                        searchStore = search.controller.store;
+                        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) {
+                            window.location.replace(redirectURL);
+                            return [2 /*return*/, false];
+                        }
+                        if (((_h = (_g = config === null || config === void 0 ? void 0 : config.settings) === null || _g === void 0 ? void 0 : _g.redirects) === null || _h === void 0 ? void 0 : _h.singleResult) &&
+                            ((_k = (_j = search === null || search === void 0 ? void 0 : search.response) === null || _j === void 0 ? void 0 : _j.search) === null || _k === void 0 ? void 0 : _k.query) &&
+                            ((_m = (_l = search === null || search === void 0 ? void 0 : search.response) === null || _l === void 0 ? void 0 : _l.pagination) === null || _m === void 0 ? void 0 : _m.totalResults) === 1 &&
+                            !((_p = (_o = search === null || search === void 0 ? void 0 : search.response) === null || _o === void 0 ? void 0 : _o.filters) === null || _p === void 0 ? void 0 : _p.length)) {
+                            window.location.replace(search === null || search === void 0 ? void 0 : search.response.results[0].mappings.core.url);
+                            return [2 /*return*/, false];
+                        }
+                        return [4 /*yield*/, next()];
+                    case 1:
+                        _q.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        _this.eventManager.on('afterStore', function (search, next) { return __awaiter(_this, void 0, void 0, function () {
+            var stringyParams, scrollMap_1, scrollToPosition_1, checkCount_1, heightCheck_1;
+            var _this = this;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, next()];
+                    case 1:
+                        _b.sent();
+                        search.controller.store.loading = false;
+                        stringyParams = JSON.stringify(search.request);
+                        this.storage.set('lastStringyParams', stringyParams);
+                        if (((_a = this.config.settings) === null || _a === void 0 ? void 0 : _a.infinite) && window.scrollY === 0) {
+                            scrollMap_1 = this.storage.get('scrollMap') || {};
+                            scrollToPosition_1 = scrollMap_1[stringyParams];
+                            if (scrollToPosition_1) {
+                                checkCount_1 = 0;
+                                heightCheck_1 = window.setInterval(function () {
+                                    if (document.documentElement.scrollHeight >= scrollToPosition_1) {
+                                        window.scrollTo(0, scrollToPosition_1);
+                                        _this.log.debug('scrolling to: ', scrollMap_1[stringyParams]);
+                                        window.clearInterval(heightCheck_1);
+                                    }
+                                    if (checkCount_1 > 2000 / HEIGHT_CHECK_INTERVAL) {
+                                        window.clearInterval(heightCheck_1);
+                                    }
+                                    checkCount_1++;
+                                }, HEIGHT_CHECK_INTERVAL);
+                            }
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        // attach config plugins and event middleware
+        _this.use(_this.config);
+        return _this;
+    }
+    Object.defineProperty(SearchController.prototype, "params", {
+        get: function () {
+            var _a, _b, _c, _d;
+            var params = (0, deepmerge_1.default)(__assign({}, (0, getParams_1.getSearchParams)(this.urlManager.state)), this.config.globals);
+            // redirect setting
+            if (!((_b = (_a = this.config.settings) === null || _a === void 0 ? void 0 : _a.redirects) === null || _b === void 0 ? void 0 : _b.merchandising) || this.store.loaded) {
+                params.search = params.search || {};
+                params.search.redirectResponse = 'full';
+            }
+            params.tracking = params.tracking || {};
+            params.tracking.domain = window.location.href;
+            var userId = this.tracker.getUserId();
+            if (userId) {
+                params.tracking.userId = userId;
+            }
+            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();
+                if (cartItems.length) {
+                    params.personalization = params.personalization || {};
+                    params.personalization.cart = cartItems.join(',');
+                }
+                var lastViewedItems = this.tracker.cookies.viewed.get();
+                if (lastViewedItems.length) {
+                    params.personalization = params.personalization || {};
+                    params.personalization.lastViewed = lastViewedItems.join(',');
+                }
+                var shopperId = this.tracker.getShopperId();
+                if (shopperId) {
+                    params.personalization = params.personalization || {};
+                    params.personalization.shopper = shopperId;
+                }
+            }
+            return params;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return SearchController;
+}(AbstractController_1.AbstractController));
+exports.SearchController = SearchController;

package/dist/cjs/index.d.ts

@@ -0,0 +1,7 @@
+export { FinderController } from './Finder/FinderController';
+export { SearchController } from './Search/SearchController';
+export { AutocompleteController } from './Autocomplete/AutocompleteController';
+export { RecommendationController } from './Recommendation/RecommendationController';
+export { AbstractController } from './Abstract/AbstractController';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,2CAA2C,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAEnE,cAAc,SAAS,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractController = exports.RecommendationController = exports.AutocompleteController = exports.SearchController = exports.FinderController = void 0;
+var FinderController_1 = require("./Finder/FinderController");
+Object.defineProperty(exports, "FinderController", { enumerable: true, get: function () { return FinderController_1.FinderController; } });
+var SearchController_1 = require("./Search/SearchController");
+Object.defineProperty(exports, "SearchController", { enumerable: true, get: function () { return SearchController_1.SearchController; } });
+var AutocompleteController_1 = require("./Autocomplete/AutocompleteController");
+Object.defineProperty(exports, "AutocompleteController", { enumerable: true, get: function () { return AutocompleteController_1.AutocompleteController; } });
+var RecommendationController_1 = require("./Recommendation/RecommendationController");
+Object.defineProperty(exports, "RecommendationController", { enumerable: true, get: function () { return RecommendationController_1.RecommendationController; } });
+var AbstractController_1 = require("./Abstract/AbstractController");
+Object.defineProperty(exports, "AbstractController", { enumerable: true, get: function () { return AbstractController_1.AbstractController; } });
+__exportStar(require("./types"), exports);

package/dist/cjs/types.d.ts

@@ -0,0 +1,52 @@
+import type { AbstractController } from './Abstract/AbstractController';
+import type { EventManager, Middleware, Next } from '@searchspring/snap-event-manager';
+import type { Client } from '@searchspring/snap-client';
+import type { AbstractStore, StoreConfig, SearchStoreConfig, FinderStoreConfig, AutocompleteStoreConfig, RecommendationStoreConfig } from '@searchspring/snap-store-mobx';
+import type { Tracker } from '@searchspring/snap-tracker';
+import type { Profiler } from '@searchspring/snap-profiler';
+import type { UrlManager } from '@searchspring/snap-url-manager';
+import type { Logger } from '@searchspring/snap-logger';
+declare global {
+    interface Window {
+        searchspring?: any;
+    }
+}
+export declare type NextEvent = Next;
+export declare type PluginFunction = (cntrlr: AbstractController, ...args: any[]) => Promise<void>;
+export declare type PluginGrouping = [func: PluginFunction, ...args: unknown[]];
+export declare type BeforeSearchObj = {
+    controller: AbstractController;
+    request: any;
+};
+export declare type AfterSearchObj = {
+    controller: AbstractController;
+    response: any;
+};
+export declare type AfterStoreObj = {
+    controller: AbstractController;
+    request: any;
+    response: any;
+};
+export declare type ControllerServices = {
+    client: Client;
+    store: AbstractStore;
+    urlManager: UrlManager;
+    eventManager: EventManager;
+    profiler: Profiler;
+    logger: Logger;
+    tracker: Tracker;
+};
+export declare type Attachments = {
+    middleware?: {
+        [eventName: string]: Middleware<unknown> | Middleware<unknown>[];
+    };
+    plugins?: PluginGrouping[];
+    [any: string]: unknown;
+};
+export declare type ControllerConfig = StoreConfig & Attachments;
+export declare type SearchControllerConfig = ControllerConfig & SearchStoreConfig;
+export declare type FinderControllerConfig = ControllerConfig & FinderStoreConfig;
+export declare type AutocompleteControllerConfig = ControllerConfig & AutocompleteStoreConfig;
+export declare type RecommendationControllerConfig = ControllerConfig & RecommendationStoreConfig;
+export declare type ControllerConfigs = SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig;
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAEvF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EACX,aAAa,EACb,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AAGxD,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,YAAY,CAAC,EAAE,GAAG,CAAC;KACnB;CACD;AAID,oBAAY,SAAS,GAAG,IAAI,CAAC;AAE7B,oBAAY,cAAc,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AACpF,oBAAY,cAAc,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;AAExE,oBAAY,eAAe,GAAG;IAC7B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC5B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC3B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACd,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACzB,UAAU,CAAC,EAAE;QACZ,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;KACjE,CAAC;IACF,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB,CAAC;AAEF,oBAAY,gBAAgB,GAAG,WAAW,GAAG,WAAW,CAAC;AAGzD,oBAAY,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,oBAAY,sBAAsB,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1E,oBAAY,4BAA4B,GAAG,gBAAgB,GAAG,uBAAuB,CAAC;AAEtF,oBAAY,8BAA8B,GAAG,gBAAgB,GAAG,yBAAyB,CAAC;AAE1F,oBAAY,iBAAiB,GAAG,sBAAsB,GAAG,4BAA4B,GAAG,sBAAsB,GAAG,8BAA8B,CAAC"}

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/utils/getParams.d.ts

@@ -0,0 +1,2 @@
+export declare function getSearchParams(state: any): Record<string, any>;
+//# sourceMappingURL=getParams.d.ts.map

package/dist/cjs/utils/getParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getParams.d.ts","sourceRoot":"","sources":["../../../src/utils/getParams.ts"],"names":[],"mappings":"AAkCA,wBAAgB,eAAe,CAAC,KAAK,KAAA,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAgF1D"}

package/dist/cjs/utils/getParams.js

@@ -0,0 +1,72 @@
+"use strict";
+// translate state to snAPI params
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSearchParams = void 0;
+function getSearchParams(state) {
+    var params = {};
+    if (state.tag) {
+        params.merchandising = params.merchandising || {};
+        params.merchandising.landingPage = state.tag;
+    }
+    if (state.query) {
+        params.search = params.search || {};
+        params.search.query = params.search.query || {};
+        params.search.query.string = state.query;
+    }
+    if (state.rq) {
+        params.search = params.search || {};
+        params.search.subQuery = state.rq;
+    }
+    if (state.oq) {
+        params.search = params.search || {};
+        params.search.originalQuery = state.oq;
+    }
+    if (state.page) {
+        params.pagination = params.pagination || {};
+        params.pagination.page = state.page;
+    }
+    if (state.pageSize) {
+        params.pagination = params.pagination || {};
+        params.pagination.pageSize = state.pageSize;
+    }
+    if (state.sort) {
+        params.sorts = params.sorts || [];
+        var sorts = Array.isArray(state.sort) ? state.sort : [state.sort];
+        var sort = sorts[0];
+        if (sort && sort.field && sort.direction) {
+            params.sorts.push({
+                field: sort.field,
+                direction: sort.direction,
+            });
+        }
+    }
+    if (state.filter) {
+        params.filters = params.filters || [];
+        Object.keys(state.filter).forEach(function (field) {
+            if (typeof field != 'string') {
+                return;
+            }
+            var filter = state.filter[field];
+            // ensure values are an array
+            var values = Array.isArray(filter) ? filter : [filter];
+            values.forEach(function (value) {
+                if (typeof value != 'object') {
+                    params.filters.push({
+                        type: 'value',
+                        field: field,
+                        value: value,
+                    });
+                }
+                else if (typeof value.low != 'undefined' && typeof value.high != 'undefined') {
+                    params.filters.push({
+                        type: 'range',
+                        field: field,
+                        value: value,
+                    });
+                }
+            });
+        });
+    }
+    return params;
+}
+exports.getSearchParams = getSearchParams;

package/dist/esm/Abstract/AbstractController.d.ts

@@ -0,0 +1,40 @@
+import { LogMode } from '@searchspring/snap-logger';
+import { DomTargeter } from '@searchspring/snap-toolbox';
+import type { AbstractStore } from '@searchspring/snap-store-mobx';
+import type { UrlManager } from '@searchspring/snap-url-manager';
+import type { EventManager, Middleware } from '@searchspring/snap-event-manager';
+import type { Profiler } from '@searchspring/snap-profiler';
+import type { Logger } from '@searchspring/snap-logger';
+import type { Tracker } from '@searchspring/snap-tracker';
+import type { Target, OnTarget } from '@searchspring/snap-toolbox';
+import type { ControllerServices, ControllerConfig, Attachments } from '../types';
+export declare abstract class AbstractController {
+    id: string;
+    type: string;
+    config: ControllerConfig;
+    client: any;
+    store: AbstractStore;
+    urlManager: UrlManager;
+    eventManager: EventManager;
+    profiler: Profiler;
+    log: Logger;
+    tracker: Tracker;
+    targeters: {
+        [key: string]: DomTargeter;
+    };
+    private _initialized;
+    private _environment;
+    get initialized(): boolean;
+    constructor(config: ControllerConfig, { client, store, urlManager, eventManager, profiler, logger, tracker }: ControllerServices);
+    createTargeter(target: Target, onTarget: OnTarget, document?: Document): DomTargeter;
+    addTargeter(target: DomTargeter): DomTargeter;
+    set environment(env: LogMode);
+    get environment(): LogMode;
+    init(): Promise<void>;
+    retarget(): void;
+    abstract search(): Promise<void>;
+    plugin(func: (cntrlr: AbstractController, ...args: any[]) => Promise<void>, ...args: unknown[]): Promise<void>;
+    on<T>(event: string, ...func: Middleware<T>[]): void;
+    use(attachments: Attachments): void;
+}
+//# sourceMappingURL=AbstractController.d.ts.map

package/dist/esm/Abstract/AbstractController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractController.d.ts","sourceRoot":"","sources":["../../../src/Abstract/AbstractController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,WAAW,EAAgB,MAAM,4BAA4B,CAAC;AAGvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGlF,8BAAsB,kBAAkB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,SAAc;IAClB,MAAM,EAAE,gBAAgB,CAAC;IACzB,MAAM,MAAC;IACP,KAAK,EAAE,aAAa,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE;QACjB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;KAC3B,CAAM;IAEP,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAAsB;IAE1C,IAAI,WAAW,IAAI,OAAO,CAEzB;gBAEW,MAAM,EAAE,gBAAgB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,kBAAkB;IAyEzH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,WAAW;IAIpF,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW;IASpD,IAAW,WAAW,CAAC,GAAG,EAAE,OAAO,EAKlC;IAED,IAAW,WAAW,IAAI,OAAO,CAEhC;IAEY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA+C3B,QAAQ,IAAI,IAAI;aAMP,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAE1B,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,GAAG,IAAI,OAAA,KAAK,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7G,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAIpD,GAAG,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;CAoC1C"}