@searchspring/snap-store-mobx 0.54.0 → 0.56.0

package/dist/esm/Search/Stores/SearchResultStore.js

@@ -1,14 +1,45 @@
 import { computed, makeObservable, observable } from 'mobx';
 import deepmerge from 'deepmerge';
 import { isPlainObject } from 'is-plain-object';
+const VARIANT_ATTRIBUTE = 'ss-variant-option';
+const VARIANT_ATTRIBUTE_SELECTED = 'ss-variant-option-selected';
 export class SearchResultStore extends Array {
     static get [Symbol.species]() {
         return Array;
     }
-    constructor(config, services, resultData, paginationData, merchData) {
+    constructor(config, services, metaData, resultData, paginationData, merchData, loaded) {
         let results = (resultData || []).map((result) => {
-            return new Product(services, result, config);
+            return new Product(services, result, metaData, config);
         });
+        const variantConfig = config?.settings?.variants;
+        // preselected variant options
+        if (variantConfig?.realtime?.enabled) {
+            // attach click events - ONLY happens once (known limitation)
+            if (!loaded && results.length) {
+                document.querySelectorAll(`[${VARIANT_ATTRIBUTE}]`).forEach((elem) => {
+                    if (variantConfig?.field && !variantConfig?.realtime?.enabled === false) {
+                        elem.addEventListener('click', () => variantOptionClick(elem, variantConfig, results));
+                    }
+                });
+            }
+            // check for attributes for preselection
+            if (results.length) {
+                if (variantConfig?.field && !variantConfig?.realtime?.enabled === false) {
+                    const options = {};
+                    // grab values from elements on the page to form preselected elements
+                    document.querySelectorAll(`[${VARIANT_ATTRIBUTE_SELECTED}]`).forEach((elem) => {
+                        const attr = elem.getAttribute(VARIANT_ATTRIBUTE);
+                        if (attr) {
+                            const [option, value] = attr.split(':');
+                            if (option && value) {
+                                options[option.toLowerCase()] = [value.toLowerCase()];
+                            }
+                        }
+                    });
+                    makeVariantSelections(variantConfig, options, results);
+                }
+            }
+        }
         if (merchData?.content?.inline) {
             const banners = merchData.content.inline
                 .sort(function (a, b) {
@@ -43,7 +74,7 @@ export class Banner {
     }
 }
 export class Product {
-    constructor(services, result, config) {
+    constructor(services, result, metaData, config) {
         this.type = 'product';
         this.attributes = {};
         this.mappings = {
@@ -56,12 +87,13 @@ export class Product {
         this.id = result.id;
         this.attributes = result.attributes;
         this.mappings = result.mappings;
+        this.badges = new Badges(result, metaData);
         const variantsField = config?.settings?.variants?.field;
         if (config && variantsField && this.attributes && this.attributes[variantsField]) {
             try {
                 // parse the field (JSON)
                 const parsedVariants = JSON.parse(this.attributes[variantsField]);
-                this.variants = new Variants(parsedVariants, this.mask, config.settings?.variants);
+                this.variants = new Variants(parsedVariants, this.mask, config?.settings?.variants);
             }
             catch (err) {
                 // failed to parse the variant JSON
@@ -96,6 +128,55 @@ export class Product {
         return deepmerge({ id: this.id, mappings: this.mappings, attributes: this.attributes }, this.mask.data, { isMergeableObject: isPlainObject });
     }
 }
+export class Badges {
+    constructor(result, metaData) {
+        this.all = [];
+        this.all = (result.badges || [])
+            .filter((badge) => {
+            // remove badges that are not in the meta or are disabled
+            return !!(badge?.tag && metaData?.badges?.tags && metaData?.badges?.tags[badge.tag] && metaData?.badges?.tags[badge.tag].enabled);
+        })
+            .map((badge) => {
+            // merge badge with badge meta data
+            const metaBadgeData = metaData?.badges?.tags?.[badge.tag];
+            return {
+                ...badge,
+                ...metaBadgeData,
+            };
+        })
+            .sort((a, b) => {
+            return a.priority - b.priority;
+        });
+        makeObservable(this, {
+            all: observable,
+            tags: computed,
+            locations: computed,
+        });
+    }
+    // get all the result badges that are in a specific location
+    atLocation(location) {
+        const locations = Array.isArray(location) ? location : [location];
+        return this.all.filter((badge) => {
+            // filter location
+            return locations.some((location) => badge.location.startsWith(`${location}/`) || badge.location == location);
+        });
+    }
+    get tags() {
+        return this.all.reduce((badgeMap, badge) => {
+            badgeMap[badge.tag] = badge;
+            return badgeMap;
+        }, {});
+    }
+    get locations() {
+        return this.all.reduce((locationMap, badge) => {
+            // put badge in location by path
+            const [section, tag] = badge.location.split('/');
+            locationMap[section] = locationMap[section] || {};
+            locationMap[section][tag] = (locationMap[section][tag] || []).concat(badge);
+            return locationMap;
+        }, {});
+    }
+}
 // Mask is used to power the product display for quick attribute swapping
 export class ProductMask {
     constructor() {
@@ -131,7 +212,9 @@ export class Variants {
             this.active = variant;
             mask.set({ mappings: this.active.mappings, attributes: this.active.attributes });
         };
-        this.config = config;
+        if (config) {
+            this.config = config;
+        }
         this.update(variantData, config);
     }
     update(variantData, config = this.config) {
@@ -149,12 +232,8 @@ export class Variants {
             //need to reset this.selections first
             this.selections = [];
             options.map((option) => {
-                // TODO - merge with variant config before constructing selection (for label overrides and swatch mappings)
-                const optionConfig = {
-                    field: option,
-                    label: option,
-                };
-                this.selections.push(new VariantSelection(this, optionConfig));
+                const variantOptionConfig = this.config?.options && this.config.options[option];
+                this.selections.push(new VariantSelection(this, option, variantOptionConfig));
             });
             const preselectedOptions = {};
             if (config?.options) {
@@ -174,7 +253,7 @@ export class Variants {
     }
     makeSelections(options) {
         // options = {color: 'Blue', size: 'L'};
-        if (!options) {
+        if (!options || !Object.keys(options).length) {
             // select first available for each selection
             this.selections.forEach((selection) => {
                 const firstAvailableOption = selection.values.find((value) => value.available);
@@ -189,12 +268,12 @@ export class Variants {
                 //make all options available for first selection.
                 const availableOptions = selection.values.filter((value) => (idx == 0 ? true : value.available));
                 const preferedOptions = options[selection.field];
-                let preferencedOption = availableOptions[0];
+                let preferencedOption = selection.selected || availableOptions[0];
                 // if theres a preference for that field
                 if (preferedOptions) {
                     const checkIfAvailable = (preference) => {
                         //see if that option is in the available options
-                        const availablePreferedOptions = availableOptions.find((value) => value.value.toLowerCase() == preference.toLowerCase());
+                        const availablePreferedOptions = availableOptions.find((value) => value.value.toString().toLowerCase() == preference?.toString().toLowerCase());
                         //use it
                         if (availablePreferedOptions) {
                             preferencedOption = availablePreferedOptions;
@@ -211,7 +290,7 @@ export class Variants {
                     }
                 }
                 if (preferencedOption) {
-                    selection.select(preferencedOption.value);
+                    selection.select(preferencedOption.value, true);
                 }
             });
         }
@@ -228,12 +307,12 @@ export class Variants {
         // refine selections ensuring that the selection that triggered the update refines LAST
         orderedSelections.forEach((selection) => selection.refineValues(this));
         // check to see if we have enough selections made to update the display
-        const selectedSelections = this.selections.filter((selection) => selection.selected);
+        const selectedSelections = this.selections.filter((selection) => selection.selected?.value?.length);
         if (selectedSelections.length) {
             let availableVariants = this.data;
             // loop through selectedSelections and only include available products that match current selections
             for (const selectedSelection of selectedSelections) {
-                availableVariants = availableVariants.filter((variant) => selectedSelection.selected == variant.options[selectedSelection.field].value && variant.available);
+                availableVariants = availableVariants.filter((variant) => selectedSelection.selected?.value == variant.options[selectedSelection.field].value && variant.available);
             }
             // set active variant
             if (availableVariants.length == 1) {
@@ -243,12 +322,13 @@ export class Variants {
     }
 }
 export class VariantSelection {
-    constructor(variants, selectorConfig) {
-        this.selected = ''; //ex: blue
-        this.previouslySelected = '';
+    constructor(variants, selectorField, variantConfig) {
+        this.selected = undefined;
+        this.previouslySelected = undefined;
         this.values = [];
-        this.field = selectorConfig.field;
-        this.label = selectorConfig.label;
+        this.field = selectorField;
+        this.label = variantConfig?.label || selectorField;
+        this.config = variantConfig || {};
         // needed to prevent attaching variants as class property
         this.variantsUpdate = () => variants.refineSelections(this);
         // create possible values from the data and refine them
@@ -264,20 +344,36 @@ export class VariantSelection {
         let availableVariants = variants.data;
         // loop through selectedSelections and remove products that do not match
         for (const selectedSelection of selectedSelections) {
-            availableVariants = availableVariants.filter((variant) => selectedSelection.selected == variant.options[selectedSelection.field].value && variant.available);
+            availableVariants = availableVariants.filter((variant) => selectedSelection.selected?.value == variant.options[selectedSelection.field].value && variant.available);
         }
         const newValues = variants.data
             .filter((variant) => variant.options[this.field])
             .reduce((values, variant) => {
             if (!values.some((val) => variant.options[this.field].value == val.value)) {
-                values.push({
-                    label: variant.options[this.field].value,
-                    // TODO: use configurable mappings from config
-                    // TODO: set background for swatches (via configurable mappings) from config
-                    thumbnailImageUrl: variant.mappings.core?.thumbnailImageUrl,
+                const value = variant.options[this.field].value;
+                const thumbnailImageUrl = variant.mappings.core?.thumbnailImageUrl;
+                const mappedValue = {
+                    value: value,
+                    label: value,
+                    thumbnailImageUrl: thumbnailImageUrl,
                     available: Boolean(availableVariants.some((availableVariant) => availableVariant.options[this.field].value == variant.options[this.field].value)),
-                    ...variant.options[this.field],
-                });
+                };
+                if (this.config.thumbnailBackgroundImages) {
+                    mappedValue.backgroundImageUrl = thumbnailImageUrl;
+                }
+                if (this.config.mappings && this.config.mappings && this.config.mappings[value.toString().toLowerCase()]) {
+                    const mapping = this.config.mappings[value.toString().toLowerCase()];
+                    if (mapping.label) {
+                        mappedValue.label = mapping.label;
+                    }
+                    if (mapping.background) {
+                        mappedValue.background = mapping.background;
+                    }
+                    if (mapping.backgroundImageUrl) {
+                        mappedValue.backgroundImageUrl = mapping.backgroundImageUrl;
+                    }
+                }
+                values.push(mappedValue);
             }
             // TODO: use sorting function from config
             return values;
@@ -285,19 +381,19 @@ export class VariantSelection {
         // if selection has been made
         if (this.selected) {
             // check if the selection is stil available
-            if (!newValues.some((val) => val.value == this.selected && val.available)) {
+            if (!newValues.some((val) => val.value == this.selected?.value && val.available)) {
                 // the selection is no longer available, attempt to select previous selection
                 if (this.selected !== this.previouslySelected &&
                     this.previouslySelected &&
-                    newValues.some((val) => val.value == this.previouslySelected && val.available)) {
-                    this.select(this.previouslySelected, true);
+                    newValues.some((val) => val.value == this.previouslySelected?.value && val.available)) {
+                    this.select(this.previouslySelected.value, true);
                 }
                 else {
                     // choose the first available option if previous seletions are unavailable
                     const availableValues = newValues.filter((val) => val.available);
                     if (newValues.length && availableValues.length) {
                         const nextAvailableValue = availableValues[0].value;
-                        if (this.selected !== nextAvailableValue) {
+                        if (this.selected.value !== nextAvailableValue) {
                             this.select(nextAvailableValue, true);
                         }
                     }
@@ -307,7 +403,7 @@ export class VariantSelection {
         this.values = newValues;
     }
     reset() {
-        this.selected = '';
+        this.selected = undefined;
         this.values.forEach((val) => (val.available = false));
     }
     select(value, internalSelection = false) {
@@ -316,7 +412,7 @@ export class VariantSelection {
             if (!internalSelection) {
                 this.previouslySelected = this.selected;
             }
-            this.selected = value;
+            this.selected = valueExist;
             this.variantsUpdate();
         }
     }
@@ -376,3 +472,30 @@ function addBannersToResults(config, results, banners, paginationData) {
     });
     return results;
 }
+function variantOptionClick(elem, variantConfig, results) {
+    const options = {};
+    const attr = elem.getAttribute(VARIANT_ATTRIBUTE);
+    if (attr) {
+        const [option, value] = attr.split(':');
+        options[option.toLowerCase()] = [value.toLowerCase()];
+        makeVariantSelections(variantConfig, options, results);
+    }
+}
+function makeVariantSelections(variantConfig, options, results) {
+    let filteredResults = results;
+    // filter based on config
+    variantConfig.realtime?.filters?.forEach((filter) => {
+        if (filter == 'first') {
+            filteredResults = [filteredResults[0]];
+        }
+        if (filter == 'unaltered') {
+            filteredResults = filteredResults.filter((result) => !result.variants?.selections.some((selection) => selection.previouslySelected));
+        }
+    });
+    filteredResults.forEach((result) => {
+        // no banner types
+        if (result.type == 'product') {
+            result.variants?.makeSelections(options);
+        }
+    });
+}

package/dist/esm/Search/Stores/index.d.ts

@@ -2,7 +2,7 @@ export { SearchMerchandisingStore, BannerContent, ContentType } from './SearchMe
 export { SearchFacetStore, ValueFacet, RangeFacet, FacetValue, FacetHierarchyValue, FacetRangeValue } from './SearchFacetStore';
 export { SearchFilterStore, Filter } from './SearchFilterStore';
 export { SearchPaginationStore } from './SearchPaginationStore';
-export { SearchResultStore, Product, Banner } from './SearchResultStore';
+export { SearchResultStore, Product, Banner, VariantSelection, VariantSelectionValue } from './SearchResultStore';
 export { SearchSortingStore } from './SearchSortingStore';
 export { SearchQueryStore } from './SearchQueryStore';
 export { SearchHistoryStore } from './SearchHistoryStore';

package/dist/esm/Search/Stores/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Search/Stores/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAChI,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Search/Stores/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAClG,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAChI,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAClH,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/esm/Search/Stores/index.js

@@ -2,7 +2,7 @@ export { SearchMerchandisingStore, ContentType } from './SearchMerchandisingStor
 export { SearchFacetStore, ValueFacet, RangeFacet, FacetValue, FacetHierarchyValue, FacetRangeValue } from './SearchFacetStore';
 export { SearchFilterStore, Filter } from './SearchFilterStore';
 export { SearchPaginationStore } from './SearchPaginationStore';
-export { SearchResultStore, Product, Banner } from './SearchResultStore';
+export { SearchResultStore, Product, Banner, VariantSelection } from './SearchResultStore';
 export { SearchSortingStore } from './SearchSortingStore';
 export { SearchQueryStore } from './SearchQueryStore';
 export { SearchHistoryStore } from './SearchHistoryStore';

package/dist/esm/Storage/StorageStore.d.ts

@@ -10,7 +10,7 @@ export declare class StorageStore {
     clear(): void;
 }
 export type StorageConfig = {
-    type: StorageType;
+    type: StorageType | keyof typeof StorageType;
     cookie?: {
         expiration?: number;
         sameSite?: string;
@@ -18,9 +18,9 @@ export type StorageConfig = {
     key: string;
 };
 export declare enum StorageType {
-    SESSION = "session",
-    LOCAL = "local",
-    COOKIE = "cookie",
-    MEMORY = "memory"
+    session = "session",
+    local = "local",
+    cookie = "cookie",
+    memory = "memory"
 }
 //# sourceMappingURL=StorageStore.d.ts.map

package/dist/esm/Storage/StorageStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageStore.d.ts","sourceRoot":"","sources":["../../../src/Storage/StorageStore.ts"],"names":[],"mappings":"AAMA,qBAAa,YAAY;IACxB,OAAO,CAAC,IAAI,CAA4B;IACxC,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,GAAG,CAAgB;IACpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;gBAE3B,MAAM,CAAC,EAAE,aAAa;IA8C3B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAyBnC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAiClC,KAAK,IAAI,IAAI;CAcpB;AAED,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CACjB"}
+{"version":3,"file":"StorageStore.d.ts","sourceRoot":"","sources":["../../../src/Storage/StorageStore.ts"],"names":[],"mappings":"AAMA,qBAAa,YAAY;IACxB,OAAO,CAAC,IAAI,CAA4B;IACxC,OAAO,CAAC,UAAU,CAAe;IACjC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,GAAG,CAAgB;IACpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAM;gBAE3B,MAAM,CAAC,EAAE,aAAa;IA8C3B,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAyBnC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS;IAiClC,KAAK,IAAI,IAAI;CAcpB;AAED,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,WAAW,GAAG,MAAM,OAAO,WAAW,CAAC;IAC7C,MAAM,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,oBAAY,WAAW;IACtB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,MAAM,WAAW;CACjB"}

package/dist/esm/Storage/StorageStore.js

@@ -20,7 +20,7 @@ export class StorageStore {
                 this.sameSite = config.cookie.sameSite;
             }
             switch (config.type) {
-                case StorageType.SESSION: {
+                case StorageType.session: {
                     this.type = featureFlags.storage ? config.type : null;
                     if (this.type) {
                         this.state = JSON.parse(window.sessionStorage.getItem(this.key) || '{}');
@@ -28,7 +28,7 @@ export class StorageStore {
                     }
                     break;
                 }
-                case StorageType.LOCAL: {
+                case StorageType.local: {
                     this.type = featureFlags.storage ? config.type : null;
                     if (this.type) {
                         this.state = JSON.parse(window.localStorage.getItem(this.key) || '{}');
@@ -36,7 +36,7 @@ export class StorageStore {
                     }
                     break;
                 }
-                case StorageType.COOKIE: {
+                case StorageType.cookie: {
                     if (featureFlags.cookies) {
                         this.type = config.type;
                         const data = utils.cookies.get(this.key);
@@ -47,7 +47,7 @@ export class StorageStore {
                     break;
                 }
                 default: {
-                    this.type = StorageType.MEMORY;
+                    this.type = StorageType.memory;
                 }
             }
         }
@@ -65,28 +65,28 @@ export class StorageStore {
             }
         });
         switch (this.type) {
-            case StorageType.SESSION:
+            case StorageType.session:
                 window.sessionStorage.setItem(this.key, JSON.stringify(this.state));
                 break;
-            case StorageType.LOCAL:
+            case StorageType.local:
                 window.localStorage.setItem(this.key, JSON.stringify(this.state));
                 break;
-            case StorageType.COOKIE:
+            case StorageType.cookie:
                 utils.cookies.set(this.key, JSON.stringify(this.state), this.sameSite, this.expiration);
                 break;
         }
     }
     get(path) {
         switch (this.type) {
-            case StorageType.SESSION:
+            case StorageType.session:
                 const sessionData = window.sessionStorage.getItem(this.key);
                 this.state = sessionData ? JSON.parse(sessionData) : {};
                 break;
-            case StorageType.LOCAL:
+            case StorageType.local:
                 const localData = window.localStorage.getItem(this.key);
                 this.state = localData ? JSON.parse(localData) : {};
                 break;
-            case StorageType.COOKIE:
+            case StorageType.cookie:
                 const data = utils.cookies.get(this.key);
                 if (data) {
                     this.state = JSON.parse(data) || {};
@@ -110,13 +110,13 @@ export class StorageStore {
     }
     clear() {
         switch (this.type) {
-            case StorageType.SESSION:
+            case StorageType.session:
                 window.sessionStorage.removeItem(this.key);
                 break;
-            case StorageType.LOCAL:
+            case StorageType.local:
                 window.localStorage.removeItem(this.key);
                 break;
-            case StorageType.COOKIE:
+            case StorageType.cookie:
                 utils.cookies.unset(this.key);
                 break;
         }
@@ -125,8 +125,8 @@ export class StorageStore {
 }
 export var StorageType;
 (function (StorageType) {
-    StorageType["SESSION"] = "session";
-    StorageType["LOCAL"] = "local";
-    StorageType["COOKIE"] = "cookie";
-    StorageType["MEMORY"] = "memory";
+    StorageType["session"] = "session";
+    StorageType["local"] = "local";
+    StorageType["cookie"] = "cookie";
+    StorageType["memory"] = "memory";
 })(StorageType || (StorageType = {}));

package/dist/esm/index.d.ts

@@ -6,5 +6,6 @@ export * from './Search/Stores/';
 export { RecommendationStore } from './Recommendation/RecommendationStore';
 export { CartStore } from './Cart/CartStore';
 export { StorageStore, StorageConfig, StorageType } from './Storage/StorageStore';
+export { MetaStore } from './Meta/MetaStore';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAElF,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAClF,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,cAAc,SAAS,CAAC"}

package/dist/esm/index.js

@@ -6,4 +6,5 @@ export * from './Search/Stores/';
 export { RecommendationStore } from './Recommendation/RecommendationStore';
 export { CartStore } from './Cart/CartStore';
 export { StorageStore, StorageType } from './Storage/StorageStore';
+export { MetaStore } from './Meta/MetaStore';
 export * from './types';

package/dist/esm/types.d.ts

@@ -1,20 +1,32 @@
 import type { UrlManager } from '@searchspring/snap-url-manager';
-import type { SearchResponseModelFacetValueAllOfValues, AutocompleteRequestModel, SearchRequestModel } from '@searchspring/snapi-types';
+import type { SearchResponseModelFacetValueAllOfValues, AutocompleteRequestModel, SearchRequestModel, MetaResponseModelBadgeTag, SearchResponseModelResultBadges } from '@searchspring/snapi-types';
 export type StoreConfig = {
     id: string;
     [any: string]: unknown;
 };
+export type VariantConfigFilterTypes = 'first' | 'unaltered';
 export type VariantConfig = {
     field: string;
+    realtime?: {
+        enabled: boolean;
+        filters?: VariantConfigFilterTypes[];
+    };
     options?: {
-        [field: string]: {
-            preSelected?: string[];
-        };
+        [optionField: string]: VariantOptionConfig;
     };
 };
-export type VariantSelectionOptions = {
-    field: string;
-    label: string;
+export type VariantOptionConfig = {
+    label?: string;
+    preSelected?: string[];
+    thumbnailBackgroundImages?: boolean;
+    mappings?: VariantOptionConfigMappings;
+};
+export type VariantOptionConfigMappings = {
+    [optionValue: string]: {
+        label?: string;
+        background?: string;
+        backgroundImageUrl?: string;
+    };
 };
 export type SearchStoreConfig = StoreConfig & {
     globals?: Partial<SearchRequestModel>;
@@ -106,7 +118,9 @@ export type RecommendationStoreConfig = StoreConfig & {
     realtime?: boolean;
     batched?: boolean;
     order?: number;
-    variants?: VariantConfig;
+    settings?: {
+        variants?: VariantConfig;
+    };
 };
 export type StoreConfigs = SearchStoreConfig | AutocompleteStoreConfig | FinderStoreConfig | RecommendationStoreConfig;
 export type StoreServices = {
@@ -125,4 +139,5 @@ export type SelectedSelection = {
 export type FinderStoreState = {
     persisted: boolean;
 };
+export type ResultBadge = MetaResponseModelBadgeTag & SearchResponseModelResultBadges;
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EAAE,wCAAwC,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAExI,MAAM,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE;QACT,CAAC,KAAK,EAAE,MAAM,GAAG;YAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;SACvB,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CAGd,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG;IAC7C,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE;QACV,SAAS,CAAC,EAAE;YACX,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,YAAY,CAAC,EAAE,OAAO,CAAC;SACvB,CAAC;QACF,MAAM,CAAC,EAAE,gBAAgB,GAAG;YAC3B,MAAM,CAAC,EAAE;gBACR,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;aAClC,CAAC;SACF,CAAC;QACF,QAAQ,CAAC,EAAE;YACV,QAAQ,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,eAAe,CAAC,EAAE;YACjB,OAAO,EAAE,OAAO,CAAC;YACjB,UAAU,CAAC,EAAE,OAAO,CAAC;SACrB,CAAC;QACF,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,OAAO,CAAC,EAAE;YACT,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,GAAG,CAAC,EAAE,MAAM,CAAC;SACb,CAAC;QACF,UAAU,CAAC,EAAE;YACZ,eAAe,CAAC,EAAE;gBACjB,KAAK,EAAE,MAAM,CAAC;gBACd,KAAK,EAAE,MAAM,CAAC;aACd,EAAE,CAAC;SACJ,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG;IAC7C,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC7C,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,GAAG;QAC3B,MAAM,CAAC,EAAE;YACR,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;SAClC,CAAC;KACF,CAAC;IACF,QAAQ,CAAC,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE;QACT,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,SAAS,CAAC,EAAE;QACX,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,YAAY,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACF,CAAC;AAGF,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,+BAA+B,CAAC;CAC3C,CAAC;AAGF,MAAM,MAAM,yBAAyB,GAAG,WAAW,GAAG;IACrD,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,uBAAuB,GAAG,iBAAiB,GAAG,yBAAyB,CAAC;AAEvH,MAAM,MAAM,aAAa,GAAG;IAC3B,UAAU,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,oBAAY,SAAS;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,wCAAwC,EAAE,CAAC;IACjD,KAAK,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,SAAS,EAAE,OAAO,CAAC;CACnB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,KAAK,EACX,wCAAwC,EACxC,wBAAwB,EACxB,kBAAkB,EAClB,yBAAyB,EACzB,+BAA+B,EAC/B,MAAM,2BAA2B,CAAC;AAEnC,MAAM,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,OAAO,GAAG,WAAW,CAAC;AAE7D,MAAM,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;KACrC,CAAC;IACF,OAAO,CAAC,EAAE;QACT,CAAC,WAAW,EAAE,MAAM,GAAG,mBAAmB,CAAC;KAC3C,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACzC,CAAC,WAAW,EAAE,MAAM,GAAG;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC;CACF,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG;IAC7C,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,QAAQ,CAAC,EAAE;QACV,SAAS,CAAC,EAAE;YACX,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,YAAY,CAAC,EAAE,OAAO,CAAC;SACvB,CAAC;QACF,MAAM,CAAC,EAAE,gBAAgB,GAAG;YAC3B,MAAM,CAAC,EAAE;gBACR,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;aAClC,CAAC;SACF,CAAC;QACF,QAAQ,CAAC,EAAE;YACV,QAAQ,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,eAAe,CAAC,EAAE;YACjB,OAAO,EAAE,OAAO,CAAC;YACjB,UAAU,CAAC,EAAE,OAAO,CAAC;SACrB,CAAC;QACF,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,OAAO,CAAC,EAAE;YACT,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,GAAG,CAAC,EAAE,MAAM,CAAC;SACb,CAAC;QACF,UAAU,CAAC,EAAE;YACZ,eAAe,CAAC,EAAE;gBACjB,KAAK,EAAE,MAAM,CAAC;gBACd,KAAK,EAAE,MAAM,CAAC;aACd,EAAE,CAAC;SACJ,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG;IAC7C,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC7C,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,GAAG;QAC3B,MAAM,CAAC,EAAE;YACR,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;SAClC,CAAC;KACF,CAAC;IACF,QAAQ,CAAC,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE;QACT,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF,SAAS,CAAC,EAAE;QACX,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,YAAY,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACF,CAAC;AAGF,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG;IACnD,OAAO,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,+BAA+B,CAAC;CAC3C,CAAC;AAGF,MAAM,MAAM,yBAAyB,GAAG,WAAW,GAAG;IACrD,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE;QACV,QAAQ,CAAC,EAAE,aAAa,CAAC;KACzB,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,uBAAuB,GAAG,iBAAiB,GAAG,yBAAyB,CAAC;AAEvH,MAAM,MAAM,aAAa,GAAG;IAC3B,UAAU,EAAE,UAAU,CAAC;CACvB,CAAC;AAEF,oBAAY,SAAS;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;CACf;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,wCAAwC,EAAE,CAAC;IACjD,KAAK,EAAE,GAAG,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC9B,SAAS,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,yBAAyB,GAAG,+BAA+B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snap-store-mobx",
-	"version": "0.54.0",
+	"version": "0.56.0",
 	"description": "Snap MobX Store",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
@@ -20,16 +20,16 @@
 		"test:watch": "jest --watch"
 	},
 	"dependencies": {
-		"@searchspring/snap-toolbox": "^0.54.0",
+		"@searchspring/snap-toolbox": "^0.56.0",
 		"mobx": "6.9.0"
 	},
 	"devDependencies": {
-		"@searchspring/snap-client": "^0.54.0",
-		"@searchspring/snap-url-manager": "^0.54.0"
+		"@searchspring/snap-client": "^0.56.0",
+		"@searchspring/snap-url-manager": "^0.56.0"
 	},
 	"sideEffects": false,
 	"files": [
 		"dist/**/*"
 	],
-	"gitHead": "a54d2c6579bf83500ed2faca8ff72b3e3495f063"
+	"gitHead": "3326303c739fd3bbb23e6477b275b89f7df3bb74"
 }