@athoscommerce/snap-platforms 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Athos Commerce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,12 @@
+# Snap Platforms
+
+
+Snap Platforms contains functionality that makes working with various shopping platforms easier. Several platforms have standardized APIs that can be leveraged for things like adding products to the cart. The most commonly used platforms are currently supported with a standard `addToCart` function. This function can be used within Snap projects. Each platform may also support other functionality, checkout the documentation for each platform to find out more.
+
+[Common](https://github.com/athoscommerce/snap/tree/main/packages/snap-platforms/common)
+
+[Shopify](https://athoscommerce.github.io/snap/reference-platforms-shopify)
+
+[BigCommerce](https://athoscommerce.github.io/snap/reference-platforms-bigcommerce)
+
+[Magento2](https://athoscommerce.github.io/snap/reference-platforms-magento2)

package/dist/cjs/bigcommerce/src/addToCart.d.ts

@@ -0,0 +1,7 @@
+import type { Product } from '@athoscommerce/snap-store-mobx';
+export type BigCommerceAddToCartConfig = {
+    redirect?: boolean | string;
+    idFieldName?: string;
+};
+export declare const addToCart: (items: Product[], config?: BigCommerceAddToCartConfig) => Promise<any>;
+//# sourceMappingURL=addToCart.d.ts.map

package/dist/cjs/bigcommerce/src/addToCart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addToCart.d.ts","sourceRoot":"","sources":["../../../../bigcommerce/src/addToCart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAE9D,MAAM,MAAM,0BAA0B,GAAG;IACxC,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAQF,eAAO,MAAM,SAAS,UAAiB,OAAO,EAAE,WAAW,0BAA0B,iBA+DpF,CAAC"}

package/dist/cjs/bigcommerce/src/addToCart.js

@@ -0,0 +1,181 @@
+"use strict";
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addToCart = void 0;
+var addToCart = function (items, config) { return __awaiter(void 0, void 0, void 0, function () {
+    var lineItems, addToCartResponse;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (!items) {
+                    console.error('bigcommerce/addToCart: No products to add!');
+                    return [2 /*return*/];
+                }
+                lineItems = [];
+                items.map(function (item) {
+                    var _a, _b, _c, _d, _e;
+                    var id = (_c = (_b = (_a = item === null || item === void 0 ? void 0 : item.display) === null || _a === void 0 ? void 0 : _a.mappings) === null || _b === void 0 ? void 0 : _b.core) === null || _c === void 0 ? void 0 : _c.uid;
+                    // try to find custom field in data
+                    if (config === null || config === void 0 ? void 0 : config.idFieldName) {
+                        var level_1 = item;
+                        config.idFieldName.split('.').map(function (field) {
+                            if (level_1 && level_1[field]) {
+                                level_1 = level_1[field];
+                            }
+                            else {
+                                console.error("bigcommerce/addToCart: Could not find column in item data. Please verify 'idFieldName' in the config.");
+                                level_1 = undefined;
+                                id = undefined;
+                                return;
+                            }
+                        });
+                        if (level_1 && level_1 !== item) {
+                            id = level_1;
+                        }
+                    }
+                    if (id && item.quantity) {
+                        var productDetails_1 = {
+                            product_id: id,
+                            quantity: item.quantity,
+                        };
+                        var options_1 = (_e = (_d = item.variants) === null || _d === void 0 ? void 0 : _d.active) === null || _e === void 0 ? void 0 : _e.options;
+                        if (options_1) {
+                            productDetails_1.optionSelections = [];
+                            Object.keys(options_1).forEach(function (option) {
+                                var _a;
+                                var optionId = options_1[option].optionId;
+                                var optionValue = options_1[option].optionValue;
+                                if (optionId && optionValue) {
+                                    (_a = productDetails_1.optionSelections) === null || _a === void 0 ? void 0 : _a.push({ optionId: optionId, optionValue: optionValue });
+                                }
+                            });
+                        }
+                        lineItems.push(productDetails_1);
+                    }
+                });
+                if (!lineItems.length) return [3 /*break*/, 2];
+                return [4 /*yield*/, addLineItemsToCart(lineItems)];
+            case 1:
+                addToCartResponse = _a.sent();
+                // do redirect (or not)
+                if ((config === null || config === void 0 ? void 0 : config.redirect) !== false) {
+                    setTimeout(function () { return (window.location.href = typeof (config === null || config === void 0 ? void 0 : config.redirect) == 'string' ? config === null || config === void 0 ? void 0 : config.redirect : '/cart.php'); });
+                }
+                return [2 /*return*/, addToCartResponse];
+            case 2: return [2 /*return*/];
+        }
+    });
+}); };
+exports.addToCart = addToCart;
+function addLineItemsToCart(lineItems) {
+    return __awaiter(this, void 0, void 0, function () {
+        var cartId, addToCartUrl, body, response, responseData, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 4, , 5]);
+                    return [4 /*yield*/, getExistingCartId()];
+                case 1:
+                    cartId = _a.sent();
+                    addToCartUrl = '/api/storefront/carts';
+                    if (cartId) {
+                        addToCartUrl = "/api/storefront/carts/".concat(cartId, "/items");
+                    }
+                    body = JSON.stringify({ lineItems: lineItems });
+                    return [4 /*yield*/, fetch(addToCartUrl, {
+                            method: 'POST',
+                            headers: {
+                                Accept: 'application/json',
+                                'Content-Type': 'application/json',
+                            },
+                            body: body,
+                        })];
+                case 2:
+                    response = _a.sent();
+                    if (response.status !== 200) {
+                        throw new Error("API rejected addToCart: ".concat(response.status));
+                    }
+                    return [4 /*yield*/, response.json()];
+                case 3:
+                    responseData = _a.sent();
+                    if (responseData === null || responseData === void 0 ? void 0 : responseData.id) {
+                        // cart Id should exist now.
+                        return [2 /*return*/, responseData];
+                    }
+                    return [3 /*break*/, 5];
+                case 4:
+                    err_1 = _a.sent();
+                    console.error('bigcommerce/addToCart: Encountered an error!');
+                    console.error(err_1);
+                    return [3 /*break*/, 5];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+}
+function getExistingCartId() {
+    return __awaiter(this, void 0, void 0, function () {
+        var response, responseData, err_2;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 3, , 4]);
+                    return [4 /*yield*/, fetch('/api/storefront/carts', {
+                            method: 'GET',
+                            headers: {
+                                Accept: 'application/json',
+                                'Content-Type': 'application/json',
+                            },
+                        })];
+                case 1:
+                    response = _a.sent();
+                    return [4 /*yield*/, response.json()];
+                case 2:
+                    responseData = _a.sent();
+                    if (Array.isArray(responseData) && responseData.length) {
+                        return [2 /*return*/, responseData[0].id];
+                    }
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_2 = _a.sent();
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    });
+}

package/dist/cjs/bigcommerce/src/index.d.ts

@@ -0,0 +1,4 @@
+export { addToCart, BigCommerceAddToCartConfig as AddToCartConfig } from './addToCart';
+export { pluginBigcommerceBackgroundFilters as pluginBackgroundFilters, PluginBigcommerceBackgroundFiltersConfig as PluginBackgroundFiltersConfig, } from './plugins/pluginBigcommerceBackgroundFilters';
+export { pluginBigcommerceAddToCart as pluginAddToCart, PluginBigCommerceAddToCartConfig as PluginAddToCartConfig, } from './plugins/pluginBigcommerceAddToCart';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../bigcommerce/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,0BAA0B,IAAI,eAAe,EAAE,MAAM,aAAa,CAAC;AACvF,OAAO,EACN,kCAAkC,IAAI,uBAAuB,EAC7D,wCAAwC,IAAI,6BAA6B,GACzE,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACN,0BAA0B,IAAI,eAAe,EAC7C,gCAAgC,IAAI,qBAAqB,GACzD,MAAM,sCAAsC,CAAC"}

package/dist/cjs/bigcommerce/src/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginAddToCart = exports.pluginBackgroundFilters = exports.addToCart = void 0;
+var addToCart_1 = require("./addToCart");
+Object.defineProperty(exports, "addToCart", { enumerable: true, get: function () { return addToCart_1.addToCart; } });
+var pluginBigcommerceBackgroundFilters_1 = require("./plugins/pluginBigcommerceBackgroundFilters");
+Object.defineProperty(exports, "pluginBackgroundFilters", { enumerable: true, get: function () { return pluginBigcommerceBackgroundFilters_1.pluginBigcommerceBackgroundFilters; } });
+var pluginBigcommerceAddToCart_1 = require("./plugins/pluginBigcommerceAddToCart");
+Object.defineProperty(exports, "pluginAddToCart", { enumerable: true, get: function () { return pluginBigcommerceAddToCart_1.pluginBigcommerceAddToCart; } });

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceAddToCart.d.ts

@@ -0,0 +1,6 @@
+import type { AbstractController } from '@athoscommerce/snap-controller';
+import { BigCommerceAddToCartConfig } from '../addToCart';
+import type { AbstractPluginConfig } from '../../../common/src/types';
+export type PluginBigCommerceAddToCartConfig = AbstractPluginConfig & BigCommerceAddToCartConfig;
+export declare const pluginBigcommerceAddToCart: (cntrlr: AbstractController, config?: PluginBigCommerceAddToCartConfig) => void;
+//# sourceMappingURL=pluginBigcommerceAddToCart.d.ts.map

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceAddToCart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginBigcommerceAddToCart.d.ts","sourceRoot":"","sources":["../../../../../bigcommerce/src/plugins/pluginBigcommerceAddToCart.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,MAAM,MAAM,gCAAgC,GAAG,oBAAoB,GAAG,0BAA0B,CAAC;AAEjG,eAAO,MAAM,0BAA0B,WAAY,kBAAkB,WAAW,gCAAgC,SAU/G,CAAC"}

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceAddToCart.js

@@ -0,0 +1,61 @@
+"use strict";
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginBigcommerceAddToCart = void 0;
+var addToCart_1 = require("../addToCart");
+var pluginBigcommerceAddToCart = function (cntrlr, config) {
+    // do nothing if plugin is disabled
+    if ((config === null || config === void 0 ? void 0 : config.enabled) === false)
+        return;
+    var addToCartBigcommerceEvent = function (_a, next_1) { return __awaiter(void 0, [_a, next_1], void 0, function (_b, next) {
+        var products = _b.products;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0: return [4 /*yield*/, (0, addToCart_1.addToCart)(products, config)];
+                case 1:
+                    _c.sent();
+                    return [4 /*yield*/, next()];
+                case 2:
+                    _c.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    cntrlr.on('addToCart', addToCartBigcommerceEvent);
+};
+exports.pluginBigcommerceAddToCart = pluginBigcommerceAddToCart;

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceBackgroundFilters.d.ts

@@ -0,0 +1,10 @@
+import type { AbstractController } from '@athoscommerce/snap-controller';
+import type { AbstractPluginConfig } from '../../../common/src/types';
+export type PluginBigcommerceBackgroundFiltersConfig = AbstractPluginConfig & {
+    fieldNames?: {
+        brand?: string;
+        category?: string;
+    };
+};
+export declare const pluginBigcommerceBackgroundFilters: (cntrlr: AbstractController, config?: PluginBigcommerceBackgroundFiltersConfig) => void;
+//# sourceMappingURL=pluginBigcommerceBackgroundFilters.d.ts.map

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceBackgroundFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginBigcommerceBackgroundFilters.d.ts","sourceRoot":"","sources":["../../../../../bigcommerce/src/plugins/pluginBigcommerceBackgroundFilters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEzE,OAAO,KAAK,EAAE,oBAAoB,EAAgC,MAAM,2BAA2B,CAAC;AAEpG,MAAM,MAAM,wCAAwC,GAAG,oBAAoB,GAAG;IAC7E,UAAU,CAAC,EAAE;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACF,CAAC;AAEF,eAAO,MAAM,kCAAkC,WAAY,kBAAkB,WAAW,wCAAwC,SAwC/H,CAAC"}

package/dist/cjs/bigcommerce/src/plugins/pluginBigcommerceBackgroundFilters.js

@@ -0,0 +1,103 @@
+"use strict";
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginBigcommerceBackgroundFilters = void 0;
+var pluginBigcommerceBackgroundFilters = function (cntrlr, config) {
+    var _a, _b, _c, _d, _e, _f;
+    // do nothing if plugin is disabled
+    if ((config === null || config === void 0 ? void 0 : config.enabled) === false)
+        return;
+    // only applies to search controllers
+    if (cntrlr.type != 'search')
+        return;
+    var backgroundFilters = [];
+    if ((_b = (_a = cntrlr.context) === null || _a === void 0 ? void 0 : _a.category) === null || _b === void 0 ? void 0 : _b.path) {
+        var categoryPath = replaceCharacters(cntrlr.context.category.path);
+        backgroundFilters.push({
+            type: 'value',
+            field: ((_c = config === null || config === void 0 ? void 0 : config.fieldNames) === null || _c === void 0 ? void 0 : _c.category) || 'categories_hierarchy',
+            value: categoryPath,
+            background: true,
+        });
+    }
+    else if ((_e = (_d = cntrlr.context) === null || _d === void 0 ? void 0 : _d.brand) === null || _e === void 0 ? void 0 : _e.name) {
+        var brandName = replaceCharacters(cntrlr.context.brand.name);
+        backgroundFilters.push({
+            type: 'value',
+            field: ((_f = config === null || config === void 0 ? void 0 : config.fieldNames) === null || _f === void 0 ? void 0 : _f.brand) || 'brand',
+            value: brandName,
+            background: true,
+        });
+    }
+    // don't do anything if there are no background filters found
+    if (!backgroundFilters.length) {
+        return;
+    }
+    cntrlr.on('init', function (_a, next_1) { return __awaiter(void 0, [_a, next_1], void 0, function (_b, next) {
+        var controller = _b.controller;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    controller.config = controller.config || {};
+                    controller.config.globals = controller.config.globals || {};
+                    controller.config.globals.filters = controller.config.globals.filters || [];
+                    controller.config.globals.filters = controller.config.globals.filters.concat(backgroundFilters);
+                    return [4 /*yield*/, next()];
+                case 1:
+                    _c.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+};
+exports.pluginBigcommerceBackgroundFilters = pluginBigcommerceBackgroundFilters;
+function replaceCharacters(value) {
+    if (value) {
+        return value
+            .replace(/\&amp\;/g, '&')
+            .replace(/\&lt\;/g, '<')
+            .replace(/\&gt\;/g, '>')
+            .replace(/\&quot\;/g, '"')
+            .replace(/\&#039\;/g, "'")
+            .replace(/\&#x27\;/g, "'")
+            .trim();
+    }
+    else {
+        return '';
+    }
+}

package/dist/cjs/common/src/index.d.ts

@@ -0,0 +1,5 @@
+export { pluginBackgroundFilters, PluginBackgroundFiltersConfig } from './plugins/pluginBackgroundFilters';
+export { pluginScrollToTop, PluginScrollToTopConfig } from './plugins/pluginScrollToTop';
+export { pluginLogger, PluginLoggerConfig } from './plugins/pluginLogger';
+export { pluginAddToCart, PluginAddToCartConfig } from './plugins/pluginAddToCart';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../common/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,mCAAmC,CAAC;AAC3G,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACzF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/cjs/common/src/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginAddToCart = exports.pluginLogger = exports.pluginScrollToTop = exports.pluginBackgroundFilters = void 0;
+var pluginBackgroundFilters_1 = require("./plugins/pluginBackgroundFilters");
+Object.defineProperty(exports, "pluginBackgroundFilters", { enumerable: true, get: function () { return pluginBackgroundFilters_1.pluginBackgroundFilters; } });
+var pluginScrollToTop_1 = require("./plugins/pluginScrollToTop");
+Object.defineProperty(exports, "pluginScrollToTop", { enumerable: true, get: function () { return pluginScrollToTop_1.pluginScrollToTop; } });
+var pluginLogger_1 = require("./plugins/pluginLogger");
+Object.defineProperty(exports, "pluginLogger", { enumerable: true, get: function () { return pluginLogger_1.pluginLogger; } });
+var pluginAddToCart_1 = require("./plugins/pluginAddToCart");
+Object.defineProperty(exports, "pluginAddToCart", { enumerable: true, get: function () { return pluginAddToCart_1.pluginAddToCart; } });

package/dist/cjs/common/src/plugins/pluginAddToCart.d.ts

@@ -0,0 +1,8 @@
+import type { Product } from '@athoscommerce/snap-store-mobx';
+import { AbstractController } from '@athoscommerce/snap-controller';
+import type { AbstractPluginConfig } from '../../../common/src/types';
+export type PluginAddToCartConfig = AbstractPluginConfig & {
+    function?: (products: Product[], controller?: AbstractController) => void | Promise<void>;
+};
+export declare const pluginAddToCart: (cntrlr: AbstractController, config?: PluginAddToCartConfig) => void;
+//# sourceMappingURL=pluginAddToCart.d.ts.map

package/dist/cjs/common/src/plugins/pluginAddToCart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginAddToCart.d.ts","sourceRoot":"","sources":["../../../../../common/src/plugins/pluginAddToCart.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,GAAG;IAC1D,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,UAAU,CAAC,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1F,CAAC;AAEF,eAAO,MAAM,eAAe,WAAY,kBAAkB,WAAW,qBAAqB,SAczF,CAAC"}

package/dist/cjs/common/src/plugins/pluginAddToCart.js

@@ -0,0 +1,66 @@
+"use strict";
+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 = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginAddToCart = void 0;
+var pluginAddToCart = function (cntrlr, config) {
+    // do nothing if plugin is disabled
+    if ((config === null || config === void 0 ? void 0 : config.enabled) === false)
+        return;
+    var addToCartEvent = function (_a, next_1) { return __awaiter(void 0, [_a, next_1], void 0, function (_b, next) {
+        var controller = _b.controller, products = _b.products;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    if (!(config === null || config === void 0 ? void 0 : config.function)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, ((config === null || config === void 0 ? void 0 : config.function) && config.function(products, controller))];
+                case 1:
+                    _c.sent();
+                    return [3 /*break*/, 3];
+                case 2:
+                    cntrlr.log.error('common/addToCart: Error - No function provided in config!');
+                    _c.label = 3;
+                case 3: return [4 /*yield*/, next()];
+                case 4:
+                    _c.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+    cntrlr.on('addToCart', addToCartEvent);
+};
+exports.pluginAddToCart = pluginAddToCart;

package/dist/cjs/common/src/plugins/pluginBackgroundFilters.d.ts

@@ -0,0 +1,7 @@
+import type { AbstractController } from '@athoscommerce/snap-controller';
+import type { AbstractPluginConfig, PluginBackgroundFilter, PluginControl } from '../types';
+export type PluginBackgroundFiltersConfig = AbstractPluginConfig & {
+    filters?: (PluginBackgroundFilter & PluginControl)[];
+};
+export declare const pluginBackgroundFilters: (cntrlr: AbstractController, config?: PluginBackgroundFiltersConfig) => void;
+//# sourceMappingURL=pluginBackgroundFilters.d.ts.map

package/dist/cjs/common/src/plugins/pluginBackgroundFilters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pluginBackgroundFilters.d.ts","sourceRoot":"","sources":["../../../../../common/src/plugins/pluginBackgroundFilters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAgC,aAAa,EAAE,MAAM,UAAU,CAAC;AAE1H,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,GAAG;IAClE,OAAO,CAAC,EAAE,CAAC,sBAAsB,GAAG,aAAa,CAAC,EAAE,CAAC;CACrD,CAAC;AAEF,eAAO,MAAM,uBAAuB,WAAY,kBAAkB,WAAW,6BAA6B,SA8DzG,CAAC"}