From 79f7b661db7ede9b127eb71b606202abc6db69b9 Mon Sep 17 00:00:00 2001 From: searchspring-machine Date: Thu, 12 Sep 2024 17:18:05 +0000 Subject: [PATCH] chore(docs): generation --- docs/snap-docs.json | 4 +- .../snap-client/docs/assets/navigation.js | 2 +- packages/snap-client/docs/assets/search.js | 2 +- packages/snap-client/docs/classes/Client.html | 4 +- packages/snap-client/docs/index.html | 2 +- packages/snap-client/docs/modules.html | 3 +- .../snap-client/docs/types/ClientConfig.html | 2 +- .../snap-client/docs/types/ClientGlobals.html | 2 +- .../types/RecommendCombinedResponseModel.html | 2 +- .../docs/types/RecommendRequestModel.html | 2 +- .../RecommendationRequestFilterModel.html | 1 + .../docs/types/TrendingResponseModel.html | 2 +- .../docs/classes/AbstractController.html | 4 +- .../docs/classes/AutocompleteController.html | 4 +- .../docs/classes/FinderController.html | 4 +- .../classes/RecommendationController.html | 4 +- .../docs/classes/SearchController.html | 4 +- .../docs/enums/ControllerTypes.html | 4 +- .../docs/types/AfterSearchObj.html | 2 +- .../docs/types/AfterStoreObj.html | 2 +- .../docs/types/Attachments.html | 2 +- .../types/AutocompleteControllerConfig.html | 2 +- .../docs/types/BeforeSearchObj.html | 2 +- .../docs/types/ContextVariables.html | 2 +- .../docs/types/ControllerConfig.html | 2 +- .../docs/types/ControllerConfigs.html | 2 +- .../docs/types/ControllerServices.html | 2 +- .../docs/types/Controllers.html | 2 +- .../docs/types/ElementPositionObj.html | 2 +- .../docs/types/FinderControllerConfig.html | 2 +- .../docs/types/PluginFunction.html | 2 +- .../docs/types/PluginGrouping.html | 2 +- .../types/RecommendationControllerConfig.html | 2 +- .../docs/types/RestorePositionObj.html | 2 +- .../docs/types/SearchControllerConfig.html | 2 +- .../docs/variables/INPUT_DELAY.html | 2 +- .../docs/classes/EventManager.html | 4 +- .../docs/types/Callback.html | 2 +- .../docs/types/Middleware.html | 2 +- .../snap-event-manager/docs/types/Next.html | 2 +- packages/snap-logger/docs/classes/Logger.html | 4 +- .../snap-logger/docs/types/LoggerConfig.html | 2 +- .../snap-logger/docs/variables/colors.html | 2 +- .../snap-logger/docs/variables/emoji.html | 2 +- .../snap-preact-components/docs/iframe.html | 2 +- ...ndle.js => main.3b5e8bd6.iframe.bundle.js} | 238 +++++++++++------- ...ain.3b5e8bd6.iframe.bundle.js.LICENSE.txt} | 0 packages/snap-preact/docs/classes/Snap.html | 4 +- .../createAutocompleteController.html | 2 +- .../functions/createFinderController.html | 2 +- .../createRecommendationController.html | 2 +- .../functions/createSearchController.html | 2 +- .../snap-preact/docs/types/SnapConfig.html | 2 +- .../snap-preact/docs/variables/polyfills.html | 2 +- .../snap-profiler/docs/classes/Profiler.html | 4 +- .../docs/classes/AbstractStore.html | 4 +- .../docs/classes/AutocompleteStore.html | 4 +- .../snap-store-mobx/docs/classes/Banner.html | 4 +- .../docs/classes/CartStore.html | 4 +- .../docs/classes/FacetHierarchyValue.html | 4 +- .../docs/classes/FacetRangeValue.html | 4 +- .../docs/classes/FacetValue.html | 4 +- .../snap-store-mobx/docs/classes/Filter.html | 4 +- .../docs/classes/FinderStore.html | 4 +- .../docs/classes/MetaStore.html | 4 +- .../snap-store-mobx/docs/classes/Product.html | 4 +- .../docs/classes/RangeFacet.html | 4 +- .../docs/classes/RecommendationStore.html | 4 +- .../docs/classes/SearchFacetStore.html | 6 +- .../docs/classes/SearchFilterStore.html | 6 +- .../docs/classes/SearchHistoryStore.html | 4 +- .../classes/SearchMerchandisingStore.html | 4 +- .../docs/classes/SearchPaginationStore.html | 4 +- .../docs/classes/SearchQueryStore.html | 4 +- .../docs/classes/SearchResultStore.html | 6 +- .../docs/classes/SearchSortingStore.html | 4 +- .../docs/classes/SearchStore.html | 4 +- .../docs/classes/StorageStore.html | 4 +- .../docs/classes/ValueFacet.html | 4 +- .../docs/classes/VariantSelection.html | 4 +- .../docs/enums/ContentType.html | 4 +- .../snap-store-mobx/docs/enums/ErrorType.html | 4 +- .../docs/enums/StorageType.html | 4 +- .../docs/types/AutocompleteStoreConfig.html | 2 +- .../AutocompleteStoreConfigSettings.html | 2 +- .../docs/types/BannerContent.html | 2 +- .../docs/types/FacetStoreConfig.html | 2 +- .../docs/types/FinderFieldConfig.html | 2 +- .../docs/types/FinderStoreConfig.html | 2 +- .../docs/types/FinderStoreState.html | 2 +- .../docs/types/RecommendationStoreConfig.html | 2 +- .../docs/types/ResultBadge.html | 2 +- .../docs/types/SearchStoreConfig.html | 2 +- .../docs/types/SelectedSelection.html | 2 +- .../docs/types/StorageConfig.html | 2 +- .../docs/types/StoreConfig.html | 2 +- .../docs/types/StoreConfigs.html | 2 +- .../docs/types/StoreServices.html | 2 +- .../docs/types/VariantConfig.html | 2 +- .../docs/types/VariantConfigFilterTypes.html | 2 +- .../docs/types/VariantOptionConfig.html | 2 +- .../types/VariantOptionConfigMappings.html | 2 +- .../docs/types/VariantSelectionValue.html | 2 +- .../docs/classes/DomTargeter.html | 4 +- packages/snap-toolbox/docs/enums/AppMode.html | 4 +- .../docs/functions/charsParams.html | 2 +- .../docs/functions/filters.currency.html | 2 +- .../docs/functions/filters.formatNumber.html | 2 +- .../docs/functions/filters.handleize.html | 2 +- .../docs/functions/filters.stripHTML.html | 2 +- .../docs/functions/filters.truncate.html | 2 +- .../docs/functions/getContext.html | 2 +- .../snap-toolbox/docs/functions/getFlags.html | 2 +- .../snap-toolbox/docs/functions/until.html | 2 +- packages/snap-toolbox/docs/functions/url.html | 2 +- .../docs/interfaces/URLParserResponse.html | 4 +- .../snap-toolbox/docs/modules/filters.html | 2 +- .../snap-toolbox/docs/types/OnTarget.html | 2 +- .../docs/types/ParameterObject.html | 2 +- packages/snap-toolbox/docs/types/Target.html | 2 +- .../snap-toolbox/docs/types/UntilOptions.html | 2 +- .../snap-toolbox/docs/variables/cookies.html | 2 +- .../docs/variables/featureFlags.html | 2 +- .../snap-toolbox/docs/variables/version.html | 2 +- .../docs/classes/BeaconEvent.html | 4 +- .../snap-tracker/docs/classes/Tracker.html | 4 +- .../docs/enums/BeaconCategory.html | 4 +- .../snap-tracker/docs/enums/BeaconType.html | 8 +- .../docs/enums/ProfilePlacement.html | 4 +- .../docs/interfaces/BeaconContext.html | 4 +- .../docs/interfaces/BeaconMeta.html | 4 +- .../docs/interfaces/CartViewEvent.html | 4 +- .../docs/interfaces/CustomBeaconEvent.html | 2 +- .../docs/interfaces/OrderTransactionData.html | 4 +- .../interfaces/OrderTransactionEvent.html | 4 +- .../docs/interfaces/ProductClickEvent.html | 4 +- .../docs/interfaces/ProductData.html | 4 +- .../docs/interfaces/ProductViewEvent.html | 4 +- .../docs/interfaces/RecommendationsEvent.html | 4 +- .../docs/interfaces/ShopperLoginEvent.html | 4 +- .../docs/interfaces/TrackErrorEvent.html | 4 +- .../docs/interfaces/TrackMethods.html | 4 +- .../docs/types/BeaconPayload.html | 2 +- .../docs/types/CurrencyContext.html | 2 +- .../docs/types/DoNotTrackEntry.html | 2 +- .../docs/types/PreflightRequestModel.html | 2 +- .../docs/types/TrackerConfig.html | 2 +- .../docs/types/TrackerGlobals.html | 2 +- .../docs/classes/NoopTranslator.html | 4 +- .../docs/classes/QueryStringTranslator.html | 4 +- .../docs/classes/UrlManager.html | 4 +- .../docs/classes/UrlTranslator.html | 4 +- .../docs/functions/reactLinker.html | 2 +- .../docs/interfaces/Translator.html | 4 +- .../snap-url-manager/docs/types/CoreMap.html | 2 +- .../docs/types/ImmutableUrlState.html | 2 +- .../types/QueryStringTranslatorConfig.html | 2 +- .../snap-url-manager/docs/types/UrlState.html | 2 +- .../docs/types/UrlTranslatorConfig.html | 2 +- .../types/UrlTranslatorParametersConfig.html | 2 +- .../types/UrlTranslatorSettingsConfig.html | 2 +- 161 files changed, 376 insertions(+), 320 deletions(-) create mode 100644 packages/snap-client/docs/types/RecommendationRequestFilterModel.html rename packages/snap-preact-components/docs/{main.65aede7a.iframe.bundle.js => main.3b5e8bd6.iframe.bundle.js} (99%) rename packages/snap-preact-components/docs/{main.65aede7a.iframe.bundle.js.LICENSE.txt => main.3b5e8bd6.iframe.bundle.js.LICENSE.txt} (100%) diff --git a/docs/snap-docs.json b/docs/snap-docs.json index 69546bfb6..b0f5318a6 100644 --- a/docs/snap-docs.json +++ b/docs/snap-docs.json @@ -18,8 +18,8 @@ {"name":"Context Variables","route":"/integration-context","price":0,"description":"## Context Variables\n\nContext variables are conditionally rendered within the `bundle.js` script's innerHTML via server side code or template logic. They provide various context variables that can be utilized by the Snap integration. Typically these variables are used to specify category page details (for [background filtering](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_BACKGROUND_FILTERS.md)), shopper details (for personalization), merchandising segmentation, or any other custom variables needed for the integration.\n\nThe innerHTML of the script MUST only contain variable assignments without `var`, `let`, or `const`. Each declaration should end with a semi-colon to ensure minification does not impact the functions ability to parse the innerHTML. These variables are retrieved using the [getContext](https://github.com/searchspring/snap/tree/main/packages/snap-toolbox/src/getContext) function at run time.\n\nThere are a few core context variables utilized by Snap, `shopper`, `merchandising` and `config` - these are reserved context variable names and should not be utilized for custom context functionality.\n\n| Option | Value | Page | Description |\n|---|---|:---:|---|\n| shopper.id | logged in user unique identifier | all | required for personalization functionallity |\n| shopper.cart | array of cart objects, each object in the array can contain `sku` and/or `childSku` | all | current cart contents, required if checkout process does not contain a dedicated cart page (ie. slideout cart) |\n| currency.code | currency code string, ie. 'EUR' (ISO 4217) | all | currency code of the shopper's cart contents or order confirmation. Used for beacon events containing pricing data |\n| merchandising.segments | array of strings used for merchandising | any | segmented merchandising allows for custom control over products returned on search requests and must also be setup within the Searchspring Management Console (SMC) |\n| config | object containing Snap configurations | any | advanced usage of Snap (not recommended for standard integrations) |\n\n## Examples\n\nThe custom variable example below shows a custom context being added for 'page'. The value would typically be assigned server side using template logic. This would be used to possibly toggle the siteId utilized by the client (to fetch different catalog data) or to modify text or currency displays.\n\n```html\n\n```\n\nWhen used, shopper context should always include at least an `id`; the `cart` contents can optionally be provided to ensure personalization is applied on every page. Standard Snap integrations will automatically take this context data and apply it for personalization.\n\n```html\n\n```\n\nMerchandising segmentation will automatically be applied if passed in via a script context variable. Standard Snap integrations will automatically take this context data and apply it for merchandising.\n\n```html\n\n```\n\nExample using multiple context variables together.\n\n```html\n\n```","image":"","sku":"sku/integration-context","id":"/integration-context","categoryHierarchy":"Getting Started > Integration > Context Variables"} {"name":"Background Filters","route":"/integration-backgroundFilters","price":0,"description":"## Background Filters\nBackground filters allow a page to be refined without displaying the active filter to the end-user. This is primarily used for category pages, although can also be used for custom functionality such as restricting visibility of products to user groups. The filter value is commonly retrieved from a context variable and applied as a background filter within the Snap config object.\n\nIn this example, we'll retrieve the `collection` object from the context and apply it as a category background filter for our search controller.\n\n\n```html\n\n```\n\n```typescript\nimport { getContext } from '@searchspring/snap-toolbox';\n\nconst context = getContext(['collection']);\nconst backgroundFilters = [];\n\nif (context.collection?.handle) {\n\t// set background filter\n\tif (context.collection.handle != 'all') {\n\t\tbackgroundFilters.push({\n\t\t\tfield: 'collection_handle',\n\t\t\tvalue: context.collection.handle,\n\t\t\ttype: 'value',\n\t\t\tbackground: true,\n\t\t});\n\t}\n}\n\nconst config = {\n\tclient: {\n\t\tglobals: {\n\t\t\tsiteId: 'abc123',\n\t\t},\n\t},\n\tcontrollers: {\n\t\tsearch: [\n\t\t\t{\n\t\t\t\tconfig: {\n\t\t\t\t\tid: 'search',\n\t\t\t\t\tglobals: {\n\t\t\t\t\t\tfilters: backgroundFilters,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t],\n\t},\n};\n\nconst snap = new Snap(config);\n```\n\nBackground filters could also be applied to all services by setting `client.globals.filters` in the Snap config instead of on a per-controller basis.","image":"","sku":"sku/integration-backgroundFilters","id":"/integration-backgroundFilters","categoryHierarchy":"Getting Started > Integration > Background Filters"} {"name":"Foreground Filters","route":"/integration-foregroundFilters","price":0,"description":"## Foreground Filters\n***Note:*** **Foreground filters are only usable with a SearchController.**\n\nForeground filters provide a way for pre-applying a filter on page load. The applied filter will be applied to the URL and can be removed as any other applied filter would. Foreground filtering is accomplished by setting the inital UrlManager state; this can be used for setting various states, but only filtering will be covered in this document.\n\nIn the simplified example below, a foreground filter is used to pre-apply a filter for the `on_sale` field. \n\n```typescript\nconst config = {\n\tclient: {\n\t\tglobals: {\n\t\t\tsiteId: 'abc123',\n\t\t},\n\t},\n\tcontrollers: {\n\t\tsearch: [\n\t\t\t{\n\t\t\t\turl: {\n\t\t\t\t\tinitial: {\n\t\t\t\t\t\tparameters: {\n\t\t\t\t\t\t\tfilter: {\n\t\t\t\t\t\t\t\tstate: {\n\t\t\t\t\t\t\t\t\ton_sale: ['yes'],\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\tconfig: {\n\t\t\t\t\tid: 'search',\n\t\t\t\t},\n\t\t\t},\n\t\t],\n\t},\n};\n\nconst snap = new Snap(config);\n```\n\n\nThe `initial.parameters` object is keyed by `UrlManager` state parameters - such as filter, sort, page, and pageSize. Any valid `UrlManager` state parameters are available for usage here, even custom parameters; however, filter is the most likely to be used here.\n\nThere is also an optional `ignoreParameter` param you can set on the `initial.settings` object, this allows for specifying additional UrlManager state parameters to be added to the ignore list. See example where the `initial.state` filter `on_sale:yes` will be set even if there are other `filter` params present in the UrlManager state. The default values in the `ignoreParameter` are `query`, `tag`, `oq` and `fallbackQuery`. This list is used to determine wether or not to apply the initial state provided - if the UrlManager state contains any states that are not being ignored, the initial state will not be applied.\n\n```typescript\nconst config = {\n\tclient: {\n\t\tglobals: {\n\t\t\tsiteId: 'abc123',\n\t\t},\n\t},\n\tcontrollers: {\n\t\tsearch: [\n\t\t\t{\n\t\t\t\turl: {\n\t\t\t\t\tinitial: {\n\t\t\t\t\t\tsettings: {\n\t\t\t\t\t\t\tignoreParameters: ['filter'],\n\t\t\t\t\t\t},\n\t\t\t\t\t\tparameters: {\n\t\t\t\t\t\t\tfilter: {\n\t\t\t\t\t\t\t\tstate: {\n\t\t\t\t\t\t\t\t\ton_sale: ['yes'],\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\tconfig: {\n\t\t\t\t\tid: 'search',\n\t\t\t\t},\n\t\t\t},\n\t\t],\n\t},\n};\n\nconst snap = new Snap(config);\n```\n\n## Advanced Configuration\nAdditional advanced configuration is available for special use cases. If you do not wish to use the default `ignoreParameters` you can specify as much using `initial.settings.useDefaultIgnoreParameters`, and setting it to `false`.\n\nMore configuration can be made within each `initial.parameter` object. It is possible to specify individual `ignoreParameters` here, which allows for more control for when to apply each individual initial state. Within the parameter configuration it is also possible to opt out of the 'global' `ignoreParameter` settings specified in `initial.settings` by using the `useGlobalIgnoreParameters` configuration. Lastly, there may be cases where it is necessary to replace existing state values instead of merging them (the default action). This is specified in each individual parameter configuration via the `action` configuration; this supports a `merge` or `set` value.\n\nExample using advanced configurations shown below:\n\n```typescript\nconst config = {\n\tclient: {\n\t\tglobals: {\n\t\t\tsiteId: 'abc123',\n\t\t},\n\t},\n\tcontrollers: {\n\t\tsearch: [\n\t\t\t{\n\t\t\t\turl: {\n\t\t\t\t\tinitial: {\n\t\t\t\t\t\tsettings: {\n\t\t\t\t\t\t\tignoreParameters: ['query', 'tag', 'filter'],\n\t\t\t\t\t\t\tuseDefaultIgnoreParameters: false,\n\t\t\t\t\t\t},\n\t\t\t\t\t\tparameters: {\n\t\t\t\t\t\t\tfilter: {\n\t\t\t\t\t\t\t\tuseGlobalIgnoreParameters: true,\n\t\t\t\t\t\t\t\taction: 'set',\n\t\t\t\t\t\t\t\tstate: {\n\t\t\t\t\t\t\t\t\ton_sale: ['yes'],\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t},\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\tconfig: {\n\t\t\t\t\tid: 'search',\n\t\t\t\t},\n\t\t\t},\n\t\t],\n\t},\n};\n\nconst snap = new Snap(config);\n```","image":"","sku":"sku/integration-foregroundFilters","id":"/integration-foregroundFilters","categoryHierarchy":"Getting Started > Integration > Foreground Filters"} -{"name":"Recommendations","route":"/integration-recommendations","price":0,"description":"## Recommendations Integration\n\nChanges to the recommendation integration scripts were made in Snap `v0.60.0`. Legacy Recommmendation Integrations docs can still be found [`here`](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_LEGACY_RECOMMENDATIONS.md)\n\nIt is recommended to utilize the [`RecommendationInstantiator`](https://github.com/searchspring/snap/blob/main/packages/snap-preact/src/Instantiators/README.md) for integration of product recommendations. This method allows recommendations to be placed anywhere on the page with a single script block (requires the `bundle.js` script also).\n\n```html\n\n```\n\nThe `RecommendationInstantiator` will look for these elements on the page and attempt to inject components based on the `profiles` specified. In the example above, the profile specified is the `recently-viewed` profile, and is set to render inside the target `.ss__recs__recently-viewed`, this profile would typically be setup to display the last products viewed by the shopper. These profiles must be setup in the Searchspring Management Console (SMC) and have associated Snap templates selected.\n\n\n## Recommendation Context Variables\nContext variables are applied to individual recommendation profiles similar to how they are done on the integration script tag. Variables here may be required depending on the profile placement, and can be used to alter the results displayed by our recommendations.\n\n### Globals Variables\n| Option | Value | Placement | Description | Required\n|---|---|:---:|---|:---:|\n| products | array of SKU strings | product detail page | SKU value(s) to identify the current product(s) being viewed | ✔️ |\n| blockedItems | array of strings | all | SKU values to identify which products to exclude from the response | |\n| cart | array (or function that returns an array) of current cart skus | all | optional method of setting cart contents | |\n| shopper.id | logged in user unique identifier | all | required for personalization functionallity if not provided to the bundle (global) context | |\n\n\n### Profile Specific Variables\n| Option | Value | Placement | Description | Required\n|---|---|:---:|---|:---:|\n| profile | string | all | profile name to use | ✔️ |\n| target | string | all | CSS selector to render component inside | ✔️ |\n| options.siteId | global siteId overwrite | all | optional global siteId overwrite | |\n| options.categories | array of category path strings | all | optional category identifiers used in category trending recommendation profiles | |\n| options.brands | array of brand strings | all | optional brand identifiers used in brand trending recommendation profiles | |\n| options.branch | template branch overwrite | all | optional branch overwrite for recommendations template (advanced usage) | |\n| options.dedupe | boolean (default: `true`) | all | dedupe products across all profiles in the batch | |\n| options.query | string | dynamic custom | query to search | |\n| options.filters | array of filters | all | optional recommendation filters | |\n| options.realtime | boolean | all | optional update recommendations if cart contents change (requires [cart attribute tracking](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_TRACKING.md)) | |\n| options.limit | number (default: 20, max: 20) | all | optional maximum number of results to display, can also be set globally [via config globals](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) | |\n\n\n## Batching and Ordering\nEach \"searchspring/recommendations\" script block groups multiple recommendation profiles into a single API request, known as a batch. By default, the script tag fetches recommendations for all profiles with a matching target in one batched request. The order of profiles in the array determines their priority within the batch.\n\nWhile batching all profiles together is generally the most efficient approach, there may be cases where separate batching is preferred. For instance, recommendations for a mini cart (side cart) might not require de-duplication with other recommendations. You can disable de-duplication for a specific profile by setting `dedupe: false` in its options, or create a separate batch by using an additional script tag.\n\n## Deduping\n\nDeduping is a process that prevents the same product from appearing in multiple recommendation profiles within a single batch. This is particularly useful when you have several recommendation profiles on a page and want to ensure a diverse range of products is shown to the user.\n\nHere's how deduping works:\n\n1. By default, deduping is enabled for all profiles in a batch (`options.dedupe: true`).\n2. The order of profiles in the array determines their priority for deduping.\n3. When a product is returned for a higher-priority profile, it becomes unavailable for lower-priority profiles in the same batch.\n\nFor example, if you have three profiles in this order: \"Customers Also Bought\", \"Similar Products\", and \"You May Also Like\", and a product is returned for \"Customers Also Bought\", it won't appear in \"Similar Products\" or \"You May Also Like\".\n\nYou can disable deduping for specific profiles by setting `options.dedupe: false`. This is useful for profiles where you want to ensure certain products always appear, regardless of their presence in other recommendations.\n\nHere's an example that demonstrates deduping:\n\n```html\n\n```\n\n## Additional Examples\n\nThe examples below assume that the `similar` profile has been setup in the Searchspring Management Console (SMC), and that a Snap `bundle.js` script exists on the page and has been configured with a `RecommendationInstantiator`.\n\nA typical \"similar\" profile that would display products similar to the product passed in via the `products` global context variable.\n\n```html\n\n```\n\nIf tracking scripts are not in place, \"crosssell\" profiles may require the cart contents to be provided.\n\n```html\n\n```\n\nIf the shopper identifier is not beeing captured by the `bundle.js` context, it must be provided for proper personalization.\n\n```html\n\n```\n\n### Filters\nThe example shown below will filter the recommendations for products matching field `color` with a value `blue` and `red`, as well as a field `price` with a range from `0` to `20`.\n\n```html\n\n```","image":"","sku":"sku/integration-recommendations","id":"/integration-recommendations","categoryHierarchy":"Getting Started > Integration > Recommendations"} -{"name":"Recommendations (legacy)","route":"/integration-legacy-recommendations","price":0,"description":"## Recommendations Integration (Legacy)\n\nFor integrations using Snap `v0.60.0` and newer, please reference the updated [`integration docs`](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_RECOMMENDATIONS.md).\n\n\nIt is recommended to utilize the [`RecommendationInstantiator`](https://github.com/searchspring/snap/blob/main/packages/snap-preact/src/Instantiators/README.md) for integration of product recommendations. This method allows recommendations to be placed anywhere on the site with a single script block (requires the `bundle.js` script also).\n\n```html\n\n```\n\nThe `RecommendationInstantiator` will look for these elements on the page and attempt to inject components based on the `profile` specified. In the example above, the profile specified is the `recently-viewed` profile, and would typically be setup to display the last products viewed by the shopper. These profiles must be setup in the Searchspring Management Console (SMC) and have associated Snap templates selected.\n\n\n## Recommendation Context Variables\nContext variables may be applied to individual recommendation profiles similar to how they are done on the integration script tag. Variables here may be required depending on the profile type utilized, and can be used to alter the results displayed by our recommendations.\n\n| Option | Value | Page | Description |\n|---|---|:---:|---|\n| products | array of SKU strings | product detail page | SKU value(s) to identify the current product(s) being viewed |\n| cart | array (or function that returns an array) of current cart skus | all | optional method of setting cart contents |\n| options.siteId | global siteId overwrite | all | optional global siteId overwrite |\n| options.categories | array of category path strings | all | optional category identifiers used in category trending recommendation profiles |\n| options.brands | array of brand strings | all | optional brand identifiers used in brand trending recommendation profiles |\n| options.branch | template branch overwrite | all | optional branch overwrite for recommendations template (advanced usage) |\n| options.filters | array of filters | all | optional recommendation filters |\n| options.query | string | all | query to search |\n| options.realtime | boolean | all | optional update recommendations if cart contents change (requires [cart attribute tracking](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_TRACKING.md)) |\n| options.blockedItems | array of strings | all | SKU values to identify which products to exclude from the response |\n| options.batched | boolean (default: `true`)| all | only applies to recommendation context, optional disable profile from being batched in a single request, can also be set globally [via config](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) | \n| options.order | number | all | optional order number for recommendation params to be added to the batched request. Profiles that do not specify an order will be placed at the end, in the occurrence they appear in the DOM.\n| options.limit | number (default: 20, max: 20) | all | optional maximum number of results to display, can also be set globally [via config globals](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) |\n| shopper.id | logged in user unique identifier | all | required for personalization functionallity if not provided to the bundle (global) context |\n\n## Batching and Ordering\nBy default, recommendation profile results are fetched in the same API request (batch), this is done in an effort to prevent the display of duplicate products across multiple profiles. The order of the profiles in the DOM determines the priority of results for de-duplication (best recommendations). If you wish to change the order, an `order` value can be provided (lowest value has highest priority). For some profiles (like product bundles) it is important that they receive the best suggested products prior to de-duplication, for these, the `order` would be set manually so that de-duplication does not occur.\n\nIn most cases batching is the best practice, however for profiles like a mini cart (side cart) de-duplication may not be desired. Batching can be turned off per profile with a `batched: false` value.\n\nThe example below shows how to manually specify the order and batching of specific profiles.\n\n```html\n\n\n\n\n\n\n\n```\n\n## Additional Examples\n\nThe examples below assume that the `similar` profile has been setup in the Searchspring Management Console (SMC), and that a Snap `bundle.js` script exists on the page and has been configured with a `RecommendationInstantiator`.\n\nA typical \"similar\" profile that would display products similar to the product passed in via the `product` context variable.\n\n```html\n\n```\n\nIf tracking scripts are not in place, \"also bought\" profiles may require the cart contents to be provided.\n\n```html\n\n```\n\nIf the shopper identifier is not beeing captured by the `bundle.js` context, it must be provided for proper personalization.\n\n```html\n\n```\n\nHaving multiple scripts batched using the order context variable\n\n```html\n\n\n\n```\n\n### Filters\nThe example shown below will filter the recommendations for products matching color: blue, & red, and price range 0 - 20.\n\n```html\n\n```","image":"","sku":"sku/integration-legacy-recommendations","id":"/integration-legacy-recommendations","categoryHierarchy":"Getting Started > Integration > Recommendations (legacy)"} +{"name":"Recommendations","route":"/integration-recommendations","price":0,"description":"## Recommendations Integration\n\nChanges to the recommendation integration scripts were made in Snap `v0.60.0`. Legacy Recommmendation Integrations docs can still be found [`here`](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_LEGACY_RECOMMENDATIONS.md)\n\nIt is recommended to utilize the [`RecommendationInstantiator`](https://github.com/searchspring/snap/blob/main/packages/snap-preact/src/Instantiators/README.md) for integration of product recommendations. This method allows recommendations to be placed anywhere on the page with a single script block (requires the `bundle.js` script also).\n\n```html\n\n```\n\nThe `RecommendationInstantiator` will look for these elements on the page and attempt to inject components based on the `profiles` specified. In the example above, the profile specified is the `recently-viewed` profile, and is set to render inside the selector `.ss__recs__recently-viewed`, this profile would typically be setup to display the last products viewed by the shopper. These profiles must be setup in the Searchspring Management Console (SMC) and have associated Snap templates selected.\n\n\n## Recommendation Context Variables\nContext variables are applied to individual recommendation profiles similar to how they are done on the integration script tag. Variables here may be required depending on the profile placement, and can be used to alter the results displayed by our recommendations.\n\n### Globals Variables\n| Option | Value | Placement | Description | Required\n|---|---|:---:|---|:---:|\n| products | array of SKU strings | product detail page | SKU value(s) to identify the current product(s) being viewed | ✔️ |\n| blockedItems | array of strings | all | SKU values to identify which products to exclude from the response | |\n| filters | array of filters | all | optional recommendation filters to apply to ALL profiles in the batch | |\n| cart | array (or function that returns an array) of current cart skus | all | optional method of setting cart contents | |\n| shopper.id | logged in user unique identifier | all | required for personalization functionallity if not provided to the bundle (global) context | |\n\n\n### Profile Specific Variables\n| Option | Value | Placement | Description | Required\n|---|---|:---:|---|:---:|\n| profile | string | all | profile name to use | ✔️ |\n| selector | string | all | CSS selector to render component inside | ✔️ |\n| options.siteId | global siteId overwrite | all | optional global siteId overwrite | |\n| options.categories | array of category path strings | all | optional category identifiers used in category trending recommendation profiles | |\n| options.brands | array of brand strings | all | optional brand identifiers used in brand trending recommendation profiles | |\n| options.branch | template branch overwrite | all | optional branch overwrite for recommendations template (advanced usage) | |\n| options.dedupe | boolean (default: `true`) | all | dedupe products across all profiles in the batch | |\n| options.query | string | dynamic custom | query to search | |\n| options.filters | array of filters | all | optional recommendation filters | |\n| options.realtime | boolean | all | optional update recommendations if cart contents change (requires [cart attribute tracking](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_TRACKING.md)) | |\n| options.limit | number (default: 20, max: 20) | all | optional maximum number of results to display, can also be set globally [via config globals](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) | |\n\n\n## Batching and Ordering\nEach \"searchspring/recommendations\" script block groups multiple recommendation profiles into a single API request, known as a batch. By default, the script tag fetches recommendations for all profiles with a matching selector in one batched request. The order of profiles in the array determines their priority within the batch.\n\nWhile batching all profiles together is generally the most efficient approach, there may be cases where separate batching is preferred. For instance, recommendations for a mini cart (side cart) might not require de-duplication with other recommendations. You can disable de-duplication for a specific profile by setting `dedupe: false` in its options, or create a separate batch by using an additional script tag.\n\n## Deduping\n\nDeduping is a process that prevents the same product from appearing in multiple recommendation profiles within a single batch. This is particularly useful when you have several recommendation profiles on a page and want to ensure a diverse range of products is shown to the user.\n\nHere's how deduping works:\n\n1. By default, deduping is enabled for all profiles in a batch (`options.dedupe: true`).\n2. The order of profiles in the array determines their priority for deduping.\n3. When a product is returned for a higher-priority profile, it becomes unavailable for lower-priority profiles in the same batch.\n\nFor example, if you have three profiles in this order: \"Customers Also Bought\", \"Similar Products\", and \"You May Also Like\", and a product is returned for \"Customers Also Bought\", it won't appear in \"Similar Products\" or \"You May Also Like\".\n\nYou can disable deduping for specific profiles by setting `options.dedupe: false`. This is useful for profiles where you want to ensure certain products always appear, regardless of their presence in other recommendations.\n\nHere's an example that demonstrates deduping:\n\n```html\n\n```\n\n## Additional Examples\n\nThe examples below assume that the `similar` profile has been setup in the Searchspring Management Console (SMC), and that a Snap `bundle.js` script exists on the page and has been configured with a `RecommendationInstantiator`.\n\nA typical \"similar\" profile that would display products similar to the product passed in via the `products` global context variable.\n\n```html\n\n```\n\nIf tracking scripts are not in place, \"crosssell\" profiles may require the cart contents to be provided.\n\n```html\n\n```\n\nIf the shopper identifier is not beeing captured by the `bundle.js` context, it must be provided for proper personalization.\n\n```html\n\n```\n\n### Filters\nThe example shown below will filter the recommendations for products matching field `color` with a value `blue` and `red`, as well as a field `price` with a range from `0` to `20`.\n\n```html\n\n```","image":"","sku":"sku/integration-recommendations","id":"/integration-recommendations","categoryHierarchy":"Getting Started > Integration > Recommendations"} +{"name":"Recommendations (legacy)","route":"/integration-legacy-recommendations","price":0,"description":"## Recommendations Integration (Legacy)\n\nFor integrations using Snap `v0.60.0` and newer, please reference the updated [`integration docs`](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_RECOMMENDATIONS.md).\n\n\nIt is recommended to utilize the [`RecommendationInstantiator`](https://github.com/searchspring/snap/blob/main/packages/snap-preact/src/Instantiators/README.md) for integration of product recommendations. This method allows recommendations to be placed anywhere on the site with a single script block (requires the `bundle.js` script also).\n\n```html\n\n```\n\nThe `RecommendationInstantiator` will look for these elements on the page and attempt to inject components based on the `profile` specified in the script attribute. In the example above, the profile specified is the `recently-viewed` profile, and would typically be setup to display the last products viewed by the shopper. These profiles must be setup in the Searchspring Management Console (SMC).\n\n\n## Recommendation Context Variables\nProfile configurations are applied to recommendation via script context variables. The variables here may be required depending on the profile type utilized, and can be used to alter the results displayed by our recommendations. When multiple recommendation integration script blocks are found, a batch will be created by default, and any profile configurations NOT in the `options` variable are applied globally to all profiles.\n\n| Option | Value | Page | Description |\n|---|---|:---:|---|\n| products | array of SKU strings | product detail page | SKU value(s) to identify the current product(s) being viewed (global) |\n| cart | array (or function that returns an array) of current cart skus | all | optional method of setting cart contents (global) |\n| blockedItems | array of strings | all | SKU values to identify which products to exclude from the response (global) |\n| filters | array of filters | all | optional recommendation filters (global) |\n| shopper.id | logged in user unique identifier | all | required for personalization functionallity if not provided to the bundle context (global) |\n| options.siteId | siteId overwrite | all | optional siteId overwrite (will force a new batch) |\n| options.categories | array of category path strings | all | optional category identifiers used in category trending recommendation profiles |\n| options.brands | array of brand strings | all | optional brand identifiers used in brand trending recommendation profiles |\n| options.branch | template branch overwrite | all | optional branch overwrite for recommendations template (advanced usage) |\n| options.filters | array of filters | all | optional recommendation filters |\n| options.query | string | all | query to search |\n| options.realtime | boolean | all | optional update recommendations if cart contents change (requires [cart attribute tracking](https://github.com/searchspring/snap/blob/main/docs/INTEGRATION_TRACKING.md)) |\n| options.blockedItems | array of strings | all | SKU values to identify which products to exclude from the response |\n| options.batched | boolean (default: `true`)| all | only applies to recommendation context, optional disable profile from being batched in a single request, can also be set globally [via config](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) | \n| options.dedupe | boolean (default: `true`) | all | specify wether or not the profile should deduplicate products when in a batch |\n| options.order | number | all | optional order number for recommendation params to be added to the batched request. Profiles that do not specify an order will be placed at the end, in the occurrence they appear in the DOM.\n| options.limit | number (default: 20, max: 20) | all | optional maximum number of results to display, can also be set globally [via config globals](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation) |\n\n## Batching and Ordering\nBy default, recommendation profile results are fetched in the same API request (batch), this is done in an effort to prevent the display of duplicate products across multiple profiles. The order of the profiles in the DOM determines the priority of results for de-duplication (best recommendations). If you wish to change the order, an `order` value can be provided (lowest value has highest priority). For some profiles (like product bundles) it is important that they receive the best suggested products prior to de-duplication, for these, the `order` should be set manually so that de-duplication does not occur.\n\nIn most cases batching is the best practice, however for profiles like a mini cart (side cart) de-duplication may not be desired. Using `dedupe` would allow for opting out of deduplication for that profile in the batch. \n\nThe example below shows how to manually specify the order of the profiles and how to dedupe them. In the example the 'bundle' profile in the batch receives the best suggestions because it has the lowest order, and the 'quick-cart' profile is not deduplicating products at all.\n\n```html\n\n\n\n\n\n\n\n```\n\nAlternatively, a profile can be placed in it's own batch via the `batched: false` value. The example below shows how to place the 'quick-cart' profile into it's own batch.\n\n```html\n\n\n\n```\n\n## Additional Examples\n\nThe examples below assume that profiles used have been setup in the Searchspring Management Console (SMC), and that a Snap `bundle.js` script exists on the page and has been configured with a `RecommendationInstantiator`.\n\nA typical \"similar\" profile that would display products similar to the product passed in via the `product` context variable.\n\n```html\n\n```\n\nIf tracking scripts are not in place, \"also bought\" profiles may require the cart contents to be provided.\n\n```html\n\n```\n\nIf the shopper identifier is not beeing captured by the `bundle.js` context, it must be provided for proper personalization.\n\n```html\n\n```\n\nHaving multiple scripts batched using the order context variable\n\n```html\n\n\n\n```\n\n### Filters\nThe example shown below will filter the recommendations for products matching field `color` with a value `blue` and `red`, as well as a field `price` with a range from `0` to `20`.\n\n```html\n\n```\n\nThe next example shows a global filter being used, this will filter all of the profiles in the batch for products matching the field `onSale` with a value `true`; the 'similar' profile will additionally apply a filter using the field `price` with a range from `0` to `20`.\n\n```html\n\n\n\n```","image":"","sku":"sku/integration-legacy-recommendations","id":"/integration-legacy-recommendations","categoryHierarchy":"Getting Started > Integration > Recommendations (legacy)"} {"name":"Tracking","route":"/integration-tracking","price":0,"description":"## Tracking\nCertain reports depend on beacon data being tracked. These are events tracked outside of the integration code and should be added to various pages. These tracking methods require that our `bundle.js` script exist on the pages where utilized.\n\n### Shopper Login\nIdentifies the logged-in user. Should be invoked if a user is logged into their account. The value should contain any unique identifier (ie. user ID, email, hash)\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the global `searchspring.tracker.track.shopper.login` methods.\n\n```typescript\nsearchspring.tracker.track.shopper.login({\n\tid: 'snapdev'\n});\n```\n\n### Product View\nTracks product page views. Should only be installed on product detail pages. A `uid` and/or `sku` and/or `childSku` and/or `childUid` are required (provide as many of these product identifiers that are available).\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.track.product.view` method\n\n```typescript\nsearchspring.tracker.track.product.view({\n\tuid: '123',\n\tsku: 'product123',\n\tchildUid: '123_a',\n\tchildSku: 'product123_a'\n});\n```\n\n\n### Cart View \nTracks cart contents. Should only be installed on a cart page. If the checkout process does not contain a dedicated cart page (ie. slideout cart) then this method should be invoked when the cart comes into view. \n\nEach item object must contain a `qty`, `price`, (`uid` and/or `sku` and/or `childSku` and/or `childUid` - provide as many of these product identifiers that are available).\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.track.cart.view` method.\n\n```typescript\nsearchspring.tracker.track.cart.view({\n\titems: [\n\t\t{\n\t\t\tuid: '123',\n\t\t\tsku: 'product123',\n\t\t\tchildUid: '123_a',\n\t\t\tchildSku: 'product123_a',\n\t\t\tqty: '1',\n\t\t\tprice: '9.99',\n\t\t},\n\t\t{\n\t\t\tuid: '456',\n\t\t\tsku: 'product456',\n\t\t\tchildUid: '456_a',\n\t\t\tchildSku: 'product456_a',\n\t\t\tqty: '2',\n\t\t\tprice: '10.99',\n\t\t},\n\t]\n});\n```\n\n\n### Order Transaction\nTracks order transaction. Should be invoked from an order confirmation page. Expects an object with the following:\n\n`order` - (optional) object containing the following\n\n`order.id` - (optional) order id\n\n`order.total` - (optional) transaction total of all items after tax and shipping\n\n`order.transactionTotal` - (optional) transaction total of all items before tax and shipping\n\n`order.city` - (optional) city name\n\n`order.state` - (optional) 2 digit state abbreviation (US only)\n\n`order.country` - (optional) 2 digit country abbreviation\t(ie. 'US', 'CA', 'MX', 'PL', 'JP')\n\n`order.items` - required array of items - same object provided to `track.cart.view` event\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.track.order.transaction` method\n\n```typescript\nsearchspring.tracker.track.order.transaction({\n\torder: {\n\t\tid: '123456',\n\t\ttotal: '34.29',\n\t\ttransactionTotal: '31.97',\n\t\tcity: 'Los Angeles',\n\t\tstate: 'CA',\n\t\tcountry: 'US',\n\t},\n\titems: [\n\t\t{\n\t\t\tuid: '123',\n\t\t\tsku: 'product123',\n\t\t\tchildUid: '123_a',\n\t\t\tchildSku: 'product123_a',\n\t\t\tqty: '1',\n\t\t\tprice: '9.99'\n\t\t},\n\t\t{\n\t\t\tuid: '456',\n\t\t\tsku: 'product456',\n\t\t\tchildUid: '456_a',\n\t\t\tchildSku: 'product456_a',\n\t\t\tqty: '2',\n\t\t\tprice: '10.99'\n\t\t},\n\t]\n});\n```\n\n\n### Product Click\nTracks product click events. This event can be included within the Snap integration. It is reccomended to invoke on each product `onmousedown` event via the `result.track.click()` method. \n\n```jsx\nsearchController.store.results.map(result)=>{(\n\t{searchController.track.product.click(e, result)}}>\n)}\n```\n\nAlternatively, this can also be integrated using the `ss-track-intellisuggest` and `ss-track-intellisuggest-signature` attributes.\n\n```jsx\nsearchController.store.results.map(result)=>{(\n\t\n)}\n```\n\n\nAlternatively, this can also be integrated using the `searchspring.tracker.track.product.click` method. \n\nThe `intellisuggestData` and `intellisuggestSignature` values are returned from SearchSpring's Search API on each `result.attributes` object. An optional `href` value can also be provided. \n\n```typescript\nsearchspring.tracker.track.product.click({\n\tintellisuggestData: '37d5578e1d1646ac97701a063ba84777',\n\tintellisuggestSignature: '5739a2596d3b4161b041ce1764ffa04d',\n\thref: '/product123',\n});\n```\n\n\n## Cart Attribute Tracking\n\nThis is not required if the above `Cart View` and `Order Transaction` tracking has not been implemented OR you are not using the `realtime` recommendations configuration. \n\nAdding the following attributes to clickable cart elements allows for real-time updates to any recommendations (disabled by default) when the cart changes. If the click event occurs on a nested element, the attribute data will attempt to be retrieved from up to 3 parent nodes.\n\nIf you are using multiple custom Tracker instances with a different tracker `config.id`, attributes are namespaced by the trackers `id` (Default: `'track'`, Example: `ss-track-cart-add`)\n\n### Add to cart\nAdds product `uid` or `sku` (or `childSku`/`childUid`) to `ssCartProducts` cookie. It is preferable to use the more specific variant `childSku` or `childUid` if available. Supports multiple products using a comma delimiter.\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.cookies.cart.add` method\n\n```typescript\nsearchspring.tracker.cookies.cart.add(['product123'])\n```\n\n\n### Remove from cart\nRemoves product `uid` or `sku` (or `childSku`/`childUid`) to `ssCartProducts` cookie. It is preferable to use the more specific variant `childSku` or `childUid` if available. Supports multiple products using a comma delimiter.\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.cookies.cart.remove` method\n\n```typescript\nsearchspring.tracker.cookies.cart.remove(['product123'])\n```\n\n\n### Clear cart\nClears all products currently stored in the `ssCartProducts` cookie.\n\n```html\n\n```\n\nAlternatively, this can also be integrated using the `searchspring.tracker.cookies.cart.remove` method\n\n```typescript\nsearchspring.tracker.cookies.cart.clear()\n```\n\n### View cart\nAllows for real-time updates to any recommendations when an element with this attribute is clicked.\n\n```html\n\n```\n","image":"","sku":"sku/integration-tracking","id":"/integration-tracking","categoryHierarchy":"Getting Started > Integration > Tracking"} {"name":"Debugging","route":"/integration-debugging","price":0,"description":"## Debugging\n\n## Branch Overrides \n\nThis functionality is only currently possible with Searchspring managed Snap repositories (https://github.com/searchspring-implementations).\n\nWhile browsing a page that contains a Snap integration, appending the `?branch=[branchname]` query parameter to the URL will stop the execution of the existing script, and load the build from the `[branchname]` branch `https://snapui.searchspring.io/[siteid]/[branchname]/bundle.js`\n\nYou will see an interface overlay on the bottom right of the viewport indicating if successful and details of the build.\n\n\n\nThis will also be persisted across page navigation. To stop previewing a branch build, you must click the `Stop Preview` button in the interface or clear the `ssBranch` cookie. The interface can also be minimized. \n\n\n## Development Mode\n\nWhile browsing a page that contains a Snap integration, appending the `?dev` query parameter to the URL will set the controller's `environment` property to `development`. \n\nThis is commonly used to enable visibility of development logs in the console. \n\nSee [AbstractController](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Abstract) and [@searchspring/snap-logger](https://github.com/searchspring/snap/tree/main/packages/snap-logger)\n\n","image":"","sku":"sku/integration-debugging","id":"/integration-debugging","categoryHierarchy":"Getting Started > Integration > Debugging"} {"name":"Troubleshooting","route":"/troubleshooting","price":0,"description":"## Troubleshooting\n\nHere are a few common gotchas. If you do not find what you're looking for here or have a question, we invite you to start a [discussion](https://github.com/searchspring/snap/discussions) or [report an issue](https://github.com/searchspring/snap/issues)\n\n### Target element is not present prior to Snap instantiation.\nIf you attempt to render a snap component using a DomTargeter before the target element exists on the page, the target will not be found and the rendering inside of the `onTarget` callback will not occur. Re-targetting can be manually invoked in these cases. \n\n```typescript\nsearchPageTargeter.retarget();\n```\n\n### Some middleware isn't executing at all\nMost likely middleware that was attached prior to the one failing to execute failed to call the `await next()` function. This is required to allow other middleware to process the event data.","image":"","sku":"sku/troubleshooting","id":"/troubleshooting","categoryHierarchy":"Getting Started > Troubleshooting"} diff --git a/packages/snap-client/docs/assets/navigation.js b/packages/snap-client/docs/assets/navigation.js index 717cc3bd6..321093fc4 100644 --- a/packages/snap-client/docs/assets/navigation.js +++ b/packages/snap-client/docs/assets/navigation.js @@ -1,2 +1,2 @@ window.navigationData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAA42Ouw6CQBBF/2VqokJiVFoKKxtiZywWdoSNu7OLMyYa479bYHwgAdu595w7uxsIXgRSyKxBEoggKKkhhdIqZuRpe5/U4ixEcDSkIY2T5T3qkJmng6nevFzDi26zb0cyWy3iefLjWVtfKMv9omc4Zsqx9M4h6cy7whDqHDl4Ytx4jbarHm7/vZVjc0aW4YnP0ph5e0LShqrB53tL/eb9AyqLzlLtAQAA'; + 'data:application/octet-stream;base64,H4sIAAAAAAAAA42Qyw6CMBBF/2XWRIXEqGxJdOWGuDMuCh2hsZ0iHRON8d9dQHwgFrZz7zk3mf0dGK8MMSRaITEEUAkuIYZcC+fQTZv7pGSjIYCTIglxGC0fQYdMLB1V8eb5Vr3oJvt2RLPVIpxHP56NtpnQrl/UhkOmFHNrDJJMrMkUoUzRVZYcbq1E3VX726O3Ujxf0LF/4rM02ixYWWrJtdKMtX/kT39ob1cjSUWF91m9pX7z4QmuxrVrXQIAAA=='; diff --git a/packages/snap-client/docs/assets/search.js b/packages/snap-client/docs/assets/search.js index 74a4ebe3c..d1c056a7d 100644 --- a/packages/snap-client/docs/assets/search.js +++ b/packages/snap-client/docs/assets/search.js @@ -1,2 +1,2 @@ window.searchData = - 'data:application/octet-stream;base64,H4sIAAAAAAAAA61aS4+bSBD+L50rIe6XX7dVDqsc9hKtckGjyDE9Myg2OMBMNhrNf181NFCFu3Db5oRmXF/V1/VVP6jmjZXF74ptkzf2M8tTthWLzYprEbF8dzRsyz4fMpPXfx+KH7tDxSL2Uh7YltV/Tqb6hH6Ln+vjgUVsf9hVlanYlrH3aNrr5yJ/zJ68TtufJn0utZbL3uP37xZ+ydeH3gy4jNhpV5q8HvMaQvGFUH2kY5GGxomd7eVgsSNGxHw09f75r1MWGhfY3x37aOpd8Hhb27tjVmZX7p9Do/bWd8fdvdTFvjieDqYO1niEuV/rLE9NGax0Z3133NLsi+PR5GloaAi4X/GXpydT1cGS9+a3RB4vR/+WJk+z/OmrqU5FXpl/itQcRlS8NvcuULTTSyuVnzKR3NoZXxs9BsAraJwnfI5U9GSc+4/8JlbDmIhk/XoxZWbGe90N9OLB0x00L1fv124efjW/XkxV+6rXa3Nv9dJOL1WvnzJVvbtx4V4MHLeYK4JfWp6y2nwZr4yXafSw+ZicyiJ92Y8XystUBtzsXMZzJZgMPTVu0ui5OJ3Ods4AkXrcfFz2u9o8FZ515DIdBJ2P0Y9yl6fXs+lhc+amvL58HWg+FoddVX/LzG9z/axG0PkY1efnn4CFbuoUdGudnB29w+pk4gx+C5PH7FCb8vqSHXAzZuVQ7H+a9EttjjfMIQyekdWu3j/fUMADbsb5lB2z68u3Q83HoyjP354u8+hQM2tzw5FhwM3HxR5E/1zNpEPNxyM16cv1p8i4h93FhDw2fy6OP7LcpFNvf9PGkwdpLtajvlfv29m719xJL5oPzPdFXtXly74uyilXH7Dd1ItyUK/LF+KswVVX6ces+ngqs9dd0w8JjPQ06jD6gg0298fb494jkb7W5P5oZVuZcDfzRURmN0WdfGubDhn31lOVEgOO1zTRgmJf00uLz5mHNDDDeAT0McPjj5qZYQyCeprhHM6be2E0Qnt8V2Rj1OgLTEdQvy+cxajJGkYiqNc6yUEs1Dq8Lq3BRJfrbPIj78GzEBreHC2gxluTmyMEKNaa3BzhrEvqi3GxIzodI3QeOquAsTxEzA77P7Z9Y6+mrLIiZ1smYhlvWMQeM3NI7f1eSyBireOaPbjfvhl7PLAWrcmnBYuSRSSXsdYPD1HSAZr/N/9orDiLEu6x4shKsCgRkZCx1itkJpCZZFEiI8ljpQQyk8hMsShRnpgKWWkWJToS63ixwjE1MluyKFn6zJbIbMWiZOUzWyGzNYuStc9sjcw2LEo2PrMNTq7NNV/4MsJHMjQ6eIXASnBSCo614DbnXHhjYzm4Il1iRbjNPJc+klgTbnPPfRJzrApfkaGxLtzmn2ufR6wMtwrwpc8QayMabVYeQ4GlEY00a5/haJJYAfjGZ4ilETb/wjc3BVZGNMr4qkJgZYTNvxA+Q6yMsPkXPgkFVkY0yvgkFFgZYfMvfMoIrIyw+Rc+ZQRWRtr8C58yEisjbf6FTxmJlZHNpPEpI0cLWLOC+ZSRWBlp8y99ykisjLT5lz5lJFZG2vxLnzISKyNt/qVPGYmVkTb/0qeMxMpIm3/pU0ZiZdSCWuAVVkbZ/EufhAoro2z+pU9ChZVRjTI+CdVocyFXM4WVUZraEhRWRi2pnUhhZdSK2osUVkatqf1DYWXUhtxAFJZGL6idS2NpNCf3VSyNFlR+NJZGS2rYGkujFclxtPVrcu/SWBu9pDKpW22aU9WrKWuTfmlPV0nSv06/se/uyNX3ZN6YYNu394jx7qncc9U+VfP3+3AAs3/ZwPicPrheDa47F7p9akG46tu6gOB6cCP5FC5DOMkBjqLu+tpZ29cGQQF3uaDA7sIAwDTI5noCluJogKqgqLbXRwAEldMkaLiJA9AFgEoK6hp9IKNgdJIaXQvrGk8DGAyRErGF9i2yAQvoUlqcB5SgbhRVb6i/CLBLMNINge16ugAmAWxJwJoP23b2w7YBqABVCtZdCQEZAUtBsexeOgcYyMvaTceFe1LBPZpIMEMUpai9Znx114yAN0iToNLkrlUAagOSS+nZNiQGEKhYt/SopRsrxbntB4OBgrDOBVWE7goGYEHlSmqi9Z81gMkCkiuoaMMXCAAIxBXUCPuPegAOjJJTi4m7TQHDA0uQpFCgXzAggZYbl9SuFqmC6P3s3f1F6e4vju1lB6AFppNcXXLnml1nXjjwwmlSQ7sbEADDU5TsXb9pgIHp7IpUuX1Tk066Dz8AbxBcUPPEftWDt0sOonNqMel7mAAHSpy7dURR+OabJoAF05NTG0o9CiiALoJSd+hxgWigWrmbypqq2s4BWWQcbmjemfYQsVN2MocsN2ybPLy//w8y9mYuqi4AAA=='; + 'data:application/octet-stream;base64,H4sIAAAAAAAAA61YTW/jNhD9L7NXRush9WXfFgFa9NBLUPQiGAuvzSRCZckryWkLI/+9kESLHJmUabsnIfGb94bzONKQJ6irvxtYZSf4Ky93sOKLZYIRZ1Bu9hJW8Fzksmx/Laofm6IBBse6gBW0/x5k85X8Fry3+wIYbItN08gGVgCfbJ71uSpf8zcr6fDTLGccRSIeGb9/78KvcX0ZYQYlg8OmlmU7zUtL4YKHo9K+2vnqBAp7XSxQiTk0X2W7ff92yH11DfzD2nvZbrzXO2Af1mzkpt6++6qO6Id1N8e22lb7QyFbb48nMY97nZc7WXs7fUY/rFvLbbXfy3LnK20GPO748e1NNq235SP8HuXp6+iPWpa7vHx7kc2hKhv5e7WTxSQVK+bRF5Sb9Nqbyp6yo7itAt+qHhiBN6RxWfD/oxRjMor+Ce/KSq/JUayfR1nncvqtuyO9QDM9kOb13fty7sMX+fMom9a2e62Ymz7ZI8OmzatS0fySF62sZwUd8Pu0n6v9j7yUu7lGnQfP6iJPJyPKyK3w6o00yxKhznxblU1bH7dtVc9RfaG4uXea11hik7iYRdpm95Q3T4c6/9j0ny5PpbfJMGgT05jH9bZ0THSUb4A8rlYPW1XW8wsksLtUZ9+J85KB1xgbGDneMu94ad8y9gSXmfvMmn55eIyc/vqTudMvA6/x0z+HyznMLw3fceyGakxmMs9yeI1m/llM5mG/JLzG4tkc+CJM/fdlB5gZSC6an7B7d6EJvFvNY48PkLsVPBwbIHcrXAy0No2rw+u8hm8fKpTHWtYMumX/A6sTfMi6yasSVsADESyBwWsui113FTMkwGAgbmGtfvtTduNBhxggXxfAsgUTPIhSXK9Zdo7of+j/0cMQWIY2GBIYB5ZxxjGIlhGBcQITwDLBeBKEiSAwQWAhsCy0iYYEFgHLIsbDABcpgUUEFgPLYhssJrAEWJbYYAmBpcCy1AZLCWwJLFvaYEta3q7auLCVBCdG9E7YraBeoNMMpG5gV3XkVnFqCIZOSmoJdqVHYc2SuoJd9dHqMlJjsDMAIyuSeoOdBxhbkdQe7GzAxIqkDvHeodSG5NQhjq7dzSfN0tmASysldYh3NnBrm3LqEO8dsm4PTi3ikbNXqUM8dnUEpwbxxNWInPrDU1crcmoPd7YPp+4Id/8I6o5AV+MK6o7grtWIyctMuOojqDcidC1bUGtE5MyRWiNiZ+cK6o1IXJUUgzf9d+VD1q3c/TZ8X7JsPFCc4Lv66Iyn0hNwWJ0+GeD5GQ5PHnXPT/3p6f7qBOmEoikTTZkoinh4CuGg2qpztSZBgwWXs2Hnc54RbMTOho4nUh270LELV+yFIDeiuHOR5nHeSDY1Yl2S/d39pru714GhjgtdYWro0kGGWKpMQfV0+WwpEi6NnLkjbpiPdVCkYyK1L9T+EE6K/npCUwhNIRSFy+Dxns3I2ghH12qNCU9HGstdKl31FMk1nv6uSx0qXvu7rv1wQWUkZpQGrxJu1RVWra6wLuligy69RqdSu2Qx9hfGThZ942G0g9GA3LU3z0cOHWakrV4Y/LxHnSTnc6WRt9GLuFDxrr7SxwGDwHgnotpmwlWAM4HbDPNlZN2sawaH/CCLvJSwytafn/8BRB/EjoAdAAA='; diff --git a/packages/snap-client/docs/classes/Client.html b/packages/snap-client/docs/classes/Client.html index 011836901..16d299475 100644 --- a/packages/snap-client/docs/classes/Client.html +++ b/packages/snap-client/docs/classes/Client.html @@ -1,4 +1,4 @@ -Client | @searchspring/snap-client

Class Client

Constructors

constructor +Client | @searchspring/snap-client

Class Client

Constructors

constructor

Properties

config globals mode @@ -9,4 +9,4 @@ recommend search trending -

Constructors

constructor

Properties

Private config

config: ClientConfig

Private globals

globals: ClientGlobals

Private mode

mode: AppMode = AppMode.production

Private requesters

requesters: {
    autocomplete: HybridAPI;
    finder: HybridAPI;
    meta: HybridAPI;
    recommend: RecommendAPI;
    search: HybridAPI;
    suggest: SuggestAPI;
}

Type declaration

  • autocomplete: HybridAPI
  • finder: HybridAPI
  • meta: HybridAPI
  • recommend: RecommendAPI
  • search: HybridAPI
  • suggest: SuggestAPI

Methods

autocomplete

  • autocomplete(params?): Promise<[MetaResponseModel, AutocompleteResponseModel]>

  • Parameters

    • params: AutocompleteRequestModel = {}

    Returns Promise<[MetaResponseModel, AutocompleteResponseModel]>

finder

  • finder(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

meta

  • meta(params?): Promise<MetaResponseModel>

  • Parameters

    • Optional params: MetaRequestModel

    Returns Promise<MetaResponseModel>

recommend

search

  • search(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

trending

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private config

config: ClientConfig

Private globals

globals: ClientGlobals

Private mode

mode: AppMode = AppMode.production

Private requesters

requesters: {
    autocomplete: HybridAPI;
    finder: HybridAPI;
    meta: HybridAPI;
    recommend: RecommendAPI;
    search: HybridAPI;
    suggest: SuggestAPI;
}

Type declaration

  • autocomplete: HybridAPI
  • finder: HybridAPI
  • meta: HybridAPI
  • recommend: RecommendAPI
  • search: HybridAPI
  • suggest: SuggestAPI

Methods

autocomplete

  • autocomplete(params?): Promise<[MetaResponseModel, AutocompleteResponseModel]>

  • Parameters

    • params: AutocompleteRequestModel = {}

    Returns Promise<[MetaResponseModel, AutocompleteResponseModel]>

finder

  • finder(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

meta

  • meta(params?): Promise<MetaResponseModel>

  • Parameters

    • Optional params: MetaRequestModel

    Returns Promise<MetaResponseModel>

recommend

search

  • search(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

trending

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/index.html b/packages/snap-client/docs/index.html index 544c9c027..f3006b46f 100644 --- a/packages/snap-client/docs/index.html +++ b/packages/snap-client/docs/index.html @@ -47,4 +47,4 @@

recommend method

Makes a request to the Searchspring Recommend API and returns a promise.

const client = new Client(globals, clientConfig);
const results = await client.recommend({
  tag: 'similar',
  siteId: 'abc123',
  products: ['product123'],
  shopper: 'snapdev',
});
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/modules.html b/packages/snap-client/docs/modules.html index ccddc14c6..144a52895 100644 --- a/packages/snap-client/docs/modules.html +++ b/packages/snap-client/docs/modules.html @@ -3,5 +3,6 @@ ClientGlobals RecommendCombinedResponseModel RecommendRequestModel +RecommendationRequestFilterModel TrendingResponseModel -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/ClientConfig.html b/packages/snap-client/docs/types/ClientConfig.html index 84daf459a..eed482c03 100644 --- a/packages/snap-client/docs/types/ClientConfig.html +++ b/packages/snap-client/docs/types/ClientConfig.html @@ -1 +1 @@ -ClientConfig | @searchspring/snap-client

Type alias ClientConfig

ClientConfig: {
    autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    };
    fetchApi?: WindowOrWorkerGlobalScope["fetch"];
    finder?: RequesterConfig<SearchRequestModel>;
    meta?: RequesterConfig<MetaRequestModel>;
    mode?: keyof typeof AppMode | AppMode;
    recommend?: RequesterConfig<RecommendRequestModel>;
    search?: RequesterConfig<SearchRequestModel>;
    suggest?: RequesterConfig<SuggestRequestModel>;
}

Type declaration

  • Optional autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    }
  • Optional fetchApi?: WindowOrWorkerGlobalScope["fetch"]
  • Optional finder?: RequesterConfig<SearchRequestModel>
  • Optional meta?: RequesterConfig<MetaRequestModel>
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional recommend?: RequesterConfig<RecommendRequestModel>
  • Optional search?: RequesterConfig<SearchRequestModel>
  • Optional suggest?: RequesterConfig<SuggestRequestModel>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ClientConfig | @searchspring/snap-client

Type alias ClientConfig

ClientConfig: {
    autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    };
    fetchApi?: WindowOrWorkerGlobalScope["fetch"];
    finder?: RequesterConfig<SearchRequestModel>;
    meta?: RequesterConfig<MetaRequestModel>;
    mode?: keyof typeof AppMode | AppMode;
    recommend?: RequesterConfig<RecommendRequestModel>;
    search?: RequesterConfig<SearchRequestModel>;
    suggest?: RequesterConfig<SuggestRequestModel>;
}

Type declaration

  • Optional autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    }
  • Optional fetchApi?: WindowOrWorkerGlobalScope["fetch"]
  • Optional finder?: RequesterConfig<SearchRequestModel>
  • Optional meta?: RequesterConfig<MetaRequestModel>
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional recommend?: RequesterConfig<RecommendRequestModel>
  • Optional search?: RequesterConfig<SearchRequestModel>
  • Optional suggest?: RequesterConfig<SuggestRequestModel>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/ClientGlobals.html b/packages/snap-client/docs/types/ClientGlobals.html index f621e39fb..d49d966d1 100644 --- a/packages/snap-client/docs/types/ClientGlobals.html +++ b/packages/snap-client/docs/types/ClientGlobals.html @@ -1 +1 @@ -ClientGlobals | @searchspring/snap-client

Type alias ClientGlobals

ClientGlobals: GenericGlobals & {
    siteId: string;
}

Type declaration

  • siteId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ClientGlobals | @searchspring/snap-client

Type alias ClientGlobals

ClientGlobals: GenericGlobals & {
    siteId: string;
}

Type declaration

  • siteId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/RecommendCombinedResponseModel.html b/packages/snap-client/docs/types/RecommendCombinedResponseModel.html index 0a10c6fe0..4731a33cf 100644 --- a/packages/snap-client/docs/types/RecommendCombinedResponseModel.html +++ b/packages/snap-client/docs/types/RecommendCombinedResponseModel.html @@ -1 +1 @@ -RecommendCombinedResponseModel | @searchspring/snap-client

Type alias RecommendCombinedResponseModel

RecommendCombinedResponseModel: ProfileResponseModel & {
    results: SearchResponseModelResult[];
} & {
    meta: MetaResponseModel;
}

Type declaration

  • results: SearchResponseModelResult[]

Type declaration

  • meta: MetaResponseModel

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendCombinedResponseModel | @searchspring/snap-client

Type alias RecommendCombinedResponseModel

RecommendCombinedResponseModel: ProfileResponseModel & {
    results: SearchResponseModelResult[];
} & {
    meta: MetaResponseModel;
}

Type declaration

  • results: SearchResponseModelResult[]

Type declaration

  • meta: MetaResponseModel

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/RecommendRequestModel.html b/packages/snap-client/docs/types/RecommendRequestModel.html index 7cfe4e658..c729c05bd 100644 --- a/packages/snap-client/docs/types/RecommendRequestModel.html +++ b/packages/snap-client/docs/types/RecommendRequestModel.html @@ -1 +1 @@ -RecommendRequestModel | @searchspring/snap-client

Type alias RecommendRequestModel

RecommendRequestModel: {
    batchId?: number;
    batched?: boolean;
    blockedItems?: string[];
    branch?: string;
    brands?: string[];
    cart?: string[];
    categories?: string[];
    dedupe?: boolean;
    filters?: RecommendationRequestFilterModel[];
    lastViewed?: string[];
    limit?: number;
    order?: number;
    product?: string;
    products?: string[];
    query?: string;
    shopper?: string;
    siteId?: string;
    tag: string;
    test?: boolean;
}

Type declaration

  • Optional batchId?: number
  • Optional batched?: boolean
  • Optional blockedItems?: string[]
  • Optional branch?: string
  • Optional brands?: string[]
  • Optional cart?: string[]
  • Optional categories?: string[]
  • Optional dedupe?: boolean
  • Optional filters?: RecommendationRequestFilterModel[]
  • Optional lastViewed?: string[]
  • Optional limit?: number
  • Optional order?: number
  • Optional product?: string
  • Optional products?: string[]
  • Optional query?: string
  • Optional shopper?: string
  • Optional siteId?: string
  • tag: string
  • Optional test?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendRequestModel | @searchspring/snap-client

Type alias RecommendRequestModel

RecommendRequestModel: RecommendRequestGlobalsModel & RecommendRequestOptionsModel & {
    profile?: RecommendRequestOptionsModel;
    tag: string;
}

Type declaration

  • Optional profile?: RecommendRequestOptionsModel
  • tag: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/RecommendationRequestFilterModel.html b/packages/snap-client/docs/types/RecommendationRequestFilterModel.html new file mode 100644 index 000000000..8288597a6 --- /dev/null +++ b/packages/snap-client/docs/types/RecommendationRequestFilterModel.html @@ -0,0 +1 @@ +RecommendationRequestFilterModel | @searchspring/snap-client

Type alias RecommendationRequestFilterModel

RecommendationRequestFilterModel: RecommendationRequestRangeFilterModel | RecommendationRequestValueFilterModel

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/TrendingResponseModel.html b/packages/snap-client/docs/types/TrendingResponseModel.html index e98f4df9d..51c88e395 100644 --- a/packages/snap-client/docs/types/TrendingResponseModel.html +++ b/packages/snap-client/docs/types/TrendingResponseModel.html @@ -1 +1 @@ -TrendingResponseModel | @searchspring/snap-client

Type alias TrendingResponseModel

TrendingResponseModel: {
    trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    };
}

Type declaration

  • trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    }
    • queries: {
          popularity: number;
          searchQuery: string;
      }[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +TrendingResponseModel | @searchspring/snap-client

Type alias TrendingResponseModel

TrendingResponseModel: {
    trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    };
}

Type declaration

  • trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    }
    • queries: {
          popularity: number;
          searchQuery: string;
      }[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/AbstractController.html b/packages/snap-controller/docs/classes/AbstractController.html index 3f0c0143d..f6481f704 100644 --- a/packages/snap-controller/docs/classes/AbstractController.html +++ b/packages/snap-controller/docs/classes/AbstractController.html @@ -1,4 +1,4 @@ -AbstractController | @searchspring/snap-controller

Class AbstractControllerAbstract

Hierarchy (view full)

Constructors

constructor +AbstractController | @searchspring/snap-controller

Class AbstractControllerAbstract

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -22,4 +22,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: ControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: AbstractStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: string = 'abstract'

urlManager

urlManager: UrlManager

Accessors

initialized

Methods

addTargeter

createTargeter

  • createTargeter(target, onTarget, document?): undefined | DomTargeter

  • Parameters

    • target: Target
    • onTarget: OnTarget
    • Optional document: Document

    Returns undefined | DomTargeter

handleError

  • handleError(err, details?): void

  • Parameters

    • err: unknown
    • Optional details: {
          [any: string]: unknown;
      }
      • [any: string]: unknown

    Returns void

init

on

plugin

retarget

Abstract search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: ControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: AbstractStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: string = 'abstract'

urlManager

urlManager: UrlManager

Accessors

initialized

Methods

addTargeter

createTargeter

  • createTargeter(target, onTarget, document?): undefined | DomTargeter

  • Parameters

    • target: Target
    • onTarget: OnTarget
    • Optional document: Document

    Returns undefined | DomTargeter

handleError

  • handleError(err, details?): void

  • Parameters

    • err: unknown
    • Optional details: {
          [any: string]: unknown;
      }
      • [any: string]: unknown

    Returns void

init

on

plugin

retarget

Abstract search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/AutocompleteController.html b/packages/snap-controller/docs/classes/AutocompleteController.html index 648a59e10..3fe2a56dc 100644 --- a/packages/snap-controller/docs/classes/AutocompleteController.html +++ b/packages/snap-controller/docs/classes/AutocompleteController.html @@ -1,4 +1,4 @@ -AutocompleteController | @searchspring/snap-controller

Class AutocompleteController

Hierarchy (view full)

Constructors

constructor +AutocompleteController | @searchspring/snap-controller

Class AutocompleteController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -31,4 +31,4 @@ setFocused unbind use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: AutocompleteControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

handlers

handlers: {
    document: {
        click: ((e) => void);
    };
    input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    };
} = ...

Type declaration

  • document: {
        click: ((e) => void);
    }
    • click: ((e) => void)
        • (e): void

        • Parameters

          • e: MouseEvent

          Returns void

  • input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    }
    • enterKey: ((e) => Promise<undefined | boolean>)
        • (e): Promise<undefined | boolean>

        • Parameters

          • e: KeyboardEvent

          Returns Promise<undefined | boolean>

    • escKey: ((e) => void)
        • (e): void

        • Parameters

          • e: KeyboardEvent

          Returns void

    • focus: ((e) => void)
        • (e): void

        • Parameters

          • e: FocusEvent

          Returns void

    • formElementChange: ((e) => void)
        • (e): void

        • Parameters

          • e: ChangeEvent<HTMLInputElement>

          Returns void

    • formSubmit: ((e) => Promise<void>)
        • (e): Promise<void>

        • Parameters

          • e: FormEvent<HTMLInputElement>

          Returns Promise<void>

    • input: ((e) => void)
        • (e): void

        • Parameters

          • e: Event

          Returns void

    • timeoutDelay: undefined | Timeout

id

id: string

log

log: Logger

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: AutocompleteStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: AutocompleteTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.autocomplete

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

bind

createTargeter

handleError

init

on

plugin

reset

retarget

search

searchTrending

setFocused

unbind

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: AutocompleteControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

handlers

handlers: {
    document: {
        click: ((e) => void);
    };
    input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    };
} = ...

Type declaration

  • document: {
        click: ((e) => void);
    }
    • click: ((e) => void)
        • (e): void

        • Parameters

          • e: MouseEvent

          Returns void

  • input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    }
    • enterKey: ((e) => Promise<undefined | boolean>)
        • (e): Promise<undefined | boolean>

        • Parameters

          • e: KeyboardEvent

          Returns Promise<undefined | boolean>

    • escKey: ((e) => void)
        • (e): void

        • Parameters

          • e: KeyboardEvent

          Returns void

    • focus: ((e) => void)
        • (e): void

        • Parameters

          • e: FocusEvent

          Returns void

    • formElementChange: ((e) => void)
        • (e): void

        • Parameters

          • e: ChangeEvent<HTMLInputElement>

          Returns void

    • formSubmit: ((e) => Promise<void>)
        • (e): Promise<void>

        • Parameters

          • e: FormEvent<HTMLInputElement>

          Returns Promise<void>

    • input: ((e) => void)
        • (e): void

        • Parameters

          • e: Event

          Returns void

    • timeoutDelay: undefined | Timeout

id

id: string

log

log: Logger

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: AutocompleteStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: AutocompleteTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.autocomplete

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

bind

createTargeter

handleError

init

on

plugin

reset

retarget

search

searchTrending

setFocused

unbind

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/FinderController.html b/packages/snap-controller/docs/classes/FinderController.html index 8bc2d4d4e..fdd9020a0 100644 --- a/packages/snap-controller/docs/classes/FinderController.html +++ b/packages/snap-controller/docs/classes/FinderController.html @@ -1,4 +1,4 @@ -FinderController | @searchspring/snap-controller

Class FinderController

Hierarchy (view full)

Constructors

constructor +FinderController | @searchspring/snap-controller

Class FinderController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -25,4 +25,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: FinderControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: FinderStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.finder

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

find

handleError

init

on

plugin

reset

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: FinderControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: FinderStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.finder

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

find

handleError

init

on

plugin

reset

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/RecommendationController.html b/packages/snap-controller/docs/classes/RecommendationController.html index c1297c499..2d09ed95c 100644 --- a/packages/snap-controller/docs/classes/RecommendationController.html +++ b/packages/snap-controller/docs/classes/RecommendationController.html @@ -1,4 +1,4 @@ -RecommendationController | @searchspring/snap-controller

Class RecommendationController

Hierarchy (view full)

Constructors

constructor +RecommendationController | @searchspring/snap-controller

Class RecommendationController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -25,4 +25,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: RecommendationControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

events

events: {
    click?: BeaconEvent;
    impression?: BeaconEvent;
    product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>;
    render?: BeaconEvent;
} = ...

Type declaration

  • Optional click?: BeaconEvent
  • Optional impression?: BeaconEvent
  • Optional product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>
  • Optional render?: BeaconEvent

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: RecommendationStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: RecommendationTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.recommendation

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: RecommendationControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

events

events: {
    click?: BeaconEvent;
    impression?: BeaconEvent;
    product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>;
    render?: BeaconEvent;
} = ...

Type declaration

  • Optional click?: BeaconEvent
  • Optional impression?: BeaconEvent
  • Optional product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>
  • Optional render?: BeaconEvent

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: RecommendationStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: RecommendationTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.recommendation

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/SearchController.html b/packages/snap-controller/docs/classes/SearchController.html index 2ab8ca90c..6d9566d9a 100644 --- a/packages/snap-controller/docs/classes/SearchController.html +++ b/packages/snap-controller/docs/classes/SearchController.html @@ -1,4 +1,4 @@ -SearchController | @searchspring/snap-controller

Class SearchController

Hierarchy (view full)

Constructors

constructor +SearchController | @searchspring/snap-controller

Class SearchController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -26,4 +26,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: SearchControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

Private previousResults

previousResults: SearchResponseModelResult[] = []

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: SearchStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: SearchTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.search

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: SearchControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

Private previousResults

previousResults: SearchResponseModelResult[] = []

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: SearchStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: SearchTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.search

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/enums/ControllerTypes.html b/packages/snap-controller/docs/enums/ControllerTypes.html index befed4abb..51f181e3b 100644 --- a/packages/snap-controller/docs/enums/ControllerTypes.html +++ b/packages/snap-controller/docs/enums/ControllerTypes.html @@ -1,5 +1,5 @@ -ControllerTypes | @searchspring/snap-controller

Enumeration ControllerTypes

Enumeration Members

autocomplete +ControllerTypes | @searchspring/snap-controller

Enumeration ControllerTypes

Enumeration Members

autocomplete finder recommendation search -

Enumeration Members

autocomplete

autocomplete: "autocomplete"

finder

finder: "finder"

recommendation

recommendation: "recommendation"

search

search: "search"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

autocomplete

autocomplete: "autocomplete"

finder

finder: "finder"

recommendation

recommendation: "recommendation"

search

search: "search"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AfterSearchObj.html b/packages/snap-controller/docs/types/AfterSearchObj.html index 9d31822cb..f60d82ec7 100644 --- a/packages/snap-controller/docs/types/AfterSearchObj.html +++ b/packages/snap-controller/docs/types/AfterSearchObj.html @@ -1 +1 @@ -AfterSearchObj | @searchspring/snap-controller

Type alias AfterSearchObj

AfterSearchObj: {
    controller: AbstractController;
    request: SearchRequestModel;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AfterSearchObj | @searchspring/snap-controller

Type alias AfterSearchObj

AfterSearchObj: {
    controller: AbstractController;
    request: SearchRequestModel;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AfterStoreObj.html b/packages/snap-controller/docs/types/AfterStoreObj.html index ec42c3020..3adf0f47f 100644 --- a/packages/snap-controller/docs/types/AfterStoreObj.html +++ b/packages/snap-controller/docs/types/AfterStoreObj.html @@ -1 +1 @@ -AfterStoreObj | @searchspring/snap-controller

Type alias AfterStoreObj

AfterStoreObj: {
    controller: AbstractController;
    request: any;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AfterStoreObj | @searchspring/snap-controller

Type alias AfterStoreObj

AfterStoreObj: {
    controller: AbstractController;
    request: any;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/Attachments.html b/packages/snap-controller/docs/types/Attachments.html index bb3b432a8..2850084f3 100644 --- a/packages/snap-controller/docs/types/Attachments.html +++ b/packages/snap-controller/docs/types/Attachments.html @@ -1 +1 @@ -Attachments | @searchspring/snap-controller

Type alias Attachments

Attachments: {
    middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    };
    plugins?: PluginGrouping[];
    [any: string]: unknown;
}

Type declaration

  • [any: string]: unknown
  • Optional middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    }
    • [eventName: string]: Middleware<any> | Middleware<any>[]
  • Optional plugins?: PluginGrouping[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Attachments | @searchspring/snap-controller

Type alias Attachments

Attachments: {
    middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    };
    plugins?: PluginGrouping[];
    [any: string]: unknown;
}

Type declaration

  • [any: string]: unknown
  • Optional middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    }
    • [eventName: string]: Middleware<any> | Middleware<any>[]
  • Optional plugins?: PluginGrouping[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AutocompleteControllerConfig.html b/packages/snap-controller/docs/types/AutocompleteControllerConfig.html index 240f4f089..cfabfce6b 100644 --- a/packages/snap-controller/docs/types/AutocompleteControllerConfig.html +++ b/packages/snap-controller/docs/types/AutocompleteControllerConfig.html @@ -1 +1 @@ -AutocompleteControllerConfig | @searchspring/snap-controller

Type alias AutocompleteControllerConfig

AutocompleteControllerConfig: ControllerConfig & AutocompleteStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AutocompleteControllerConfig | @searchspring/snap-controller

Type alias AutocompleteControllerConfig

AutocompleteControllerConfig: ControllerConfig & AutocompleteStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/BeforeSearchObj.html b/packages/snap-controller/docs/types/BeforeSearchObj.html index 28d7f22d5..f5f23fd0e 100644 --- a/packages/snap-controller/docs/types/BeforeSearchObj.html +++ b/packages/snap-controller/docs/types/BeforeSearchObj.html @@ -1 +1 @@ -BeforeSearchObj | @searchspring/snap-controller

Type alias BeforeSearchObj

BeforeSearchObj: {
    controller: AbstractController;
    request: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BeforeSearchObj | @searchspring/snap-controller

Type alias BeforeSearchObj

BeforeSearchObj: {
    controller: AbstractController;
    request: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ContextVariables.html b/packages/snap-controller/docs/types/ContextVariables.html index 44c11cc77..6d1acdebb 100644 --- a/packages/snap-controller/docs/types/ContextVariables.html +++ b/packages/snap-controller/docs/types/ContextVariables.html @@ -1 +1 @@ -ContextVariables | @searchspring/snap-controller

Type alias ContextVariables

ContextVariables: {
    shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    };
    [variable: string]: any;
}

Type declaration

  • [variable: string]: any
  • Optional shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    }
    • [variable: string]: any
    • Optional cart?: ProductViewEvent[]
    • id: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContextVariables | @searchspring/snap-controller

Type alias ContextVariables

ContextVariables: {
    shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    };
    [variable: string]: any;
}

Type declaration

  • [variable: string]: any
  • Optional shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    }
    • [variable: string]: any
    • Optional cart?: ProductViewEvent[]
    • id: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerConfig.html b/packages/snap-controller/docs/types/ControllerConfig.html index f167f9b97..d399908b3 100644 --- a/packages/snap-controller/docs/types/ControllerConfig.html +++ b/packages/snap-controller/docs/types/ControllerConfig.html @@ -1 +1 @@ -ControllerConfig | @searchspring/snap-controller

Type alias ControllerConfig

ControllerConfig: StoreConfig & Attachments

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerConfig | @searchspring/snap-controller

Type alias ControllerConfig

ControllerConfig: StoreConfig & Attachments

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerConfigs.html b/packages/snap-controller/docs/types/ControllerConfigs.html index 7118dbcee..d5087fade 100644 --- a/packages/snap-controller/docs/types/ControllerConfigs.html +++ b/packages/snap-controller/docs/types/ControllerConfigs.html @@ -1 +1 @@ -ControllerConfigs | @searchspring/snap-controller

Type alias ControllerConfigs

ControllerConfigs: SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerConfigs | @searchspring/snap-controller

Type alias ControllerConfigs

ControllerConfigs: SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerServices.html b/packages/snap-controller/docs/types/ControllerServices.html index dc09600b4..471a4a514 100644 --- a/packages/snap-controller/docs/types/ControllerServices.html +++ b/packages/snap-controller/docs/types/ControllerServices.html @@ -1 +1 @@ -ControllerServices | @searchspring/snap-controller

Type alias ControllerServices

ControllerServices: {
    client: Client;
    eventManager: EventManager;
    logger: Logger;
    profiler: Profiler;
    store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore;
    tracker: Tracker;
    urlManager: UrlManager;
}

Type declaration

  • client: Client
  • eventManager: EventManager
  • logger: Logger
  • profiler: Profiler
  • store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore
  • tracker: Tracker
  • urlManager: UrlManager

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerServices | @searchspring/snap-controller

Type alias ControllerServices

ControllerServices: {
    client: Client;
    eventManager: EventManager;
    logger: Logger;
    profiler: Profiler;
    store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore;
    tracker: Tracker;
    urlManager: UrlManager;
}

Type declaration

  • client: Client
  • eventManager: EventManager
  • logger: Logger
  • profiler: Profiler
  • store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore
  • tracker: Tracker
  • urlManager: UrlManager

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/Controllers.html b/packages/snap-controller/docs/types/Controllers.html index e94ac695e..154e25cca 100644 --- a/packages/snap-controller/docs/types/Controllers.html +++ b/packages/snap-controller/docs/types/Controllers.html @@ -1 +1 @@ -Controllers | @searchspring/snap-controller

Type alias Controllers

Controllers: SearchController | AutocompleteController | FinderController | RecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Controllers | @searchspring/snap-controller

Type alias Controllers

Controllers: SearchController | AutocompleteController | FinderController | RecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ElementPositionObj.html b/packages/snap-controller/docs/types/ElementPositionObj.html index 2fda69287..a3dd584af 100644 --- a/packages/snap-controller/docs/types/ElementPositionObj.html +++ b/packages/snap-controller/docs/types/ElementPositionObj.html @@ -1 +1 @@ -ElementPositionObj | @searchspring/snap-controller

Type alias ElementPositionObj

ElementPositionObj: {
    domRect?: DOMRect;
    href?: string;
    selector?: string;
}

Type declaration

  • Optional domRect?: DOMRect
  • Optional href?: string
  • Optional selector?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ElementPositionObj | @searchspring/snap-controller

Type alias ElementPositionObj

ElementPositionObj: {
    domRect?: DOMRect;
    href?: string;
    selector?: string;
}

Type declaration

  • Optional domRect?: DOMRect
  • Optional href?: string
  • Optional selector?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/FinderControllerConfig.html b/packages/snap-controller/docs/types/FinderControllerConfig.html index 5e1c1f39f..5ab3cb54d 100644 --- a/packages/snap-controller/docs/types/FinderControllerConfig.html +++ b/packages/snap-controller/docs/types/FinderControllerConfig.html @@ -1 +1 @@ -FinderControllerConfig | @searchspring/snap-controller

Type alias FinderControllerConfig

FinderControllerConfig: ControllerConfig & FinderStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +FinderControllerConfig | @searchspring/snap-controller

Type alias FinderControllerConfig

FinderControllerConfig: ControllerConfig & FinderStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/PluginFunction.html b/packages/snap-controller/docs/types/PluginFunction.html index 439f8a2f9..dd17ba0d3 100644 --- a/packages/snap-controller/docs/types/PluginFunction.html +++ b/packages/snap-controller/docs/types/PluginFunction.html @@ -1 +1 @@ -PluginFunction | @searchspring/snap-controller

Type alias PluginFunction

PluginFunction: ((cntrlr, ...args) => Promise<void> | void)

Type declaration

    • (cntrlr, ...args): Promise<void> | void

    • Parameters

      Returns Promise<void> | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PluginFunction | @searchspring/snap-controller

Type alias PluginFunction

PluginFunction: ((cntrlr, ...args) => Promise<void> | void)

Type declaration

    • (cntrlr, ...args): Promise<void> | void

    • Parameters

      Returns Promise<void> | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/PluginGrouping.html b/packages/snap-controller/docs/types/PluginGrouping.html index 742202275..63390b229 100644 --- a/packages/snap-controller/docs/types/PluginGrouping.html +++ b/packages/snap-controller/docs/types/PluginGrouping.html @@ -1 +1 @@ -PluginGrouping | @searchspring/snap-controller

Type alias PluginGrouping

PluginGrouping: [func: PluginFunction, args: unknown[]]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PluginGrouping | @searchspring/snap-controller

Type alias PluginGrouping

PluginGrouping: [func: PluginFunction, args: unknown[]]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/RecommendationControllerConfig.html b/packages/snap-controller/docs/types/RecommendationControllerConfig.html index fd511b438..30decf344 100644 --- a/packages/snap-controller/docs/types/RecommendationControllerConfig.html +++ b/packages/snap-controller/docs/types/RecommendationControllerConfig.html @@ -1 +1 @@ -RecommendationControllerConfig | @searchspring/snap-controller

Type alias RecommendationControllerConfig

RecommendationControllerConfig: ControllerConfig & RecommendationStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendationControllerConfig | @searchspring/snap-controller

Type alias RecommendationControllerConfig

RecommendationControllerConfig: ControllerConfig & RecommendationStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/RestorePositionObj.html b/packages/snap-controller/docs/types/RestorePositionObj.html index 7b6d17855..41c0ece89 100644 --- a/packages/snap-controller/docs/types/RestorePositionObj.html +++ b/packages/snap-controller/docs/types/RestorePositionObj.html @@ -1 +1 @@ -RestorePositionObj | @searchspring/snap-controller

Type alias RestorePositionObj

RestorePositionObj: {
    controller: AbstractController;
    element?: ElementPositionObj;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RestorePositionObj | @searchspring/snap-controller

Type alias RestorePositionObj

RestorePositionObj: {
    controller: AbstractController;
    element?: ElementPositionObj;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/SearchControllerConfig.html b/packages/snap-controller/docs/types/SearchControllerConfig.html index 05fd101ad..d3f88c003 100644 --- a/packages/snap-controller/docs/types/SearchControllerConfig.html +++ b/packages/snap-controller/docs/types/SearchControllerConfig.html @@ -1 +1 @@ -SearchControllerConfig | @searchspring/snap-controller

Type alias SearchControllerConfig

SearchControllerConfig: ControllerConfig & SearchStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SearchControllerConfig | @searchspring/snap-controller

Type alias SearchControllerConfig

SearchControllerConfig: ControllerConfig & SearchStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/variables/INPUT_DELAY.html b/packages/snap-controller/docs/variables/INPUT_DELAY.html index 34a8d4d8b..771843eeb 100644 --- a/packages/snap-controller/docs/variables/INPUT_DELAY.html +++ b/packages/snap-controller/docs/variables/INPUT_DELAY.html @@ -1 +1 @@ -INPUT_DELAY | @searchspring/snap-controller

Variable INPUT_DELAYConst

INPUT_DELAY: 200 = 200

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +INPUT_DELAY | @searchspring/snap-controller

Variable INPUT_DELAYConst

INPUT_DELAY: 200 = 200

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/classes/EventManager.html b/packages/snap-event-manager/docs/classes/EventManager.html index b79e2c3f0..ddf32d98b 100644 --- a/packages/snap-event-manager/docs/classes/EventManager.html +++ b/packages/snap-event-manager/docs/classes/EventManager.html @@ -1,5 +1,5 @@ -EventManager | @searchspring/snap-event-manager

Class EventManager

Constructors

constructor +EventManager | @searchspring/snap-event-manager

Class EventManager

Constructors

constructor

Properties

events

Methods

fire on -

Constructors

constructor

Properties

events

events: Record<string, MiddlewareManager<any>> = {}

Methods

fire

  • fire<T>(event, context?): Promise<void>

  • Type Parameters

    • T

    Parameters

    • event: string
    • Optional context: T

    Returns Promise<void>

on

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

events

events: Record<string, MiddlewareManager<any>> = {}

Methods

fire

  • fire<T>(event, context?): Promise<void>

  • Type Parameters

    • T

    Parameters

    • event: string
    • Optional context: T

    Returns Promise<void>

on

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Callback.html b/packages/snap-event-manager/docs/types/Callback.html index 6c30b827c..be4837593 100644 --- a/packages/snap-event-manager/docs/types/Callback.html +++ b/packages/snap-event-manager/docs/types/Callback.html @@ -1 +1 @@ -Callback | @searchspring/snap-event-manager

Type alias Callback

Callback: ((cancel) => void)

Type declaration

    • (cancel): void

    • Parameters

      • cancel: boolean | void

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Callback | @searchspring/snap-event-manager

Type alias Callback

Callback: ((cancel) => void)

Type declaration

    • (cancel): void

    • Parameters

      • cancel: boolean | void

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Middleware.html b/packages/snap-event-manager/docs/types/Middleware.html index 2d2ef4513..167b5752d 100644 --- a/packages/snap-event-manager/docs/types/Middleware.html +++ b/packages/snap-event-manager/docs/types/Middleware.html @@ -1 +1 @@ -Middleware | @searchspring/snap-event-manager

Type alias Middleware<T>

Middleware<T>: ((context, next) => Promise<boolean | void> | boolean | void)

Type Parameters

  • T

Type declaration

    • (context, next): Promise<boolean | void> | boolean | void

    • Parameters

      Returns Promise<boolean | void> | boolean | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Middleware | @searchspring/snap-event-manager

Type alias Middleware<T>

Middleware<T>: ((context, next) => Promise<boolean | void> | boolean | void)

Type Parameters

  • T

Type declaration

    • (context, next): Promise<boolean | void> | boolean | void

    • Parameters

      Returns Promise<boolean | void> | boolean | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Next.html b/packages/snap-event-manager/docs/types/Next.html index aeaaa06a9..b233ad67f 100644 --- a/packages/snap-event-manager/docs/types/Next.html +++ b/packages/snap-event-manager/docs/types/Next.html @@ -1 +1 @@ -Next | @searchspring/snap-event-manager

Type alias Next

Next: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Next | @searchspring/snap-event-manager

Type alias Next

Next: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/classes/Logger.html b/packages/snap-logger/docs/classes/Logger.html index dc7922680..da9c87d30 100644 --- a/packages/snap-logger/docs/classes/Logger.html +++ b/packages/snap-logger/docs/classes/Logger.html @@ -1,4 +1,4 @@ -Logger | @searchspring/snap-logger

Class Logger

Constructors

constructor +Logger | @searchspring/snap-logger

Class Logger

Constructors

constructor

Properties

colors emoji mode @@ -11,4 +11,4 @@ profile setNamespace warn -

Constructors

constructor

Properties

colors

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = colors

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

emoji

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = emoji

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Private mode

mode: AppMode = AppMode.production

Private prefix

prefix: string = ''

Methods

debug

  • debug(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

dev

  • dev(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

error

  • error(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

image

  • image(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          height: string | number;
          url: string;
          width: string | number;
      }
      • height: string | number
      • url: string
      • width: string | number
    • Rest ...params: any[]

    Returns void

imageText

  • imageText(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          style: string;
          text: string;
          url: string;
      }
      • style: string
      • text: string
      • url: string
    • Rest ...params: any[]

    Returns void

profile

  • profile(profile, ...params): void

  • Parameters

    • profile: any
    • Rest ...params: any[]

    Returns void

setNamespace

  • setNamespace(group): void

  • Parameters

    • group: string

    Returns void

warn

  • warn(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

colors

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = colors

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

emoji

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = emoji

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Private mode

mode: AppMode = AppMode.production

Private prefix

prefix: string = ''

Methods

debug

  • debug(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

dev

  • dev(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

error

  • error(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

image

  • image(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          height: string | number;
          url: string;
          width: string | number;
      }
      • height: string | number
      • url: string
      • width: string | number
    • Rest ...params: any[]

    Returns void

imageText

  • imageText(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          style: string;
          text: string;
          url: string;
      }
      • style: string
      • text: string
      • url: string
    • Rest ...params: any[]

    Returns void

profile

  • profile(profile, ...params): void

  • Parameters

    • profile: any
    • Rest ...params: any[]

    Returns void

setNamespace

  • setNamespace(group): void

  • Parameters

    • group: string

    Returns void

warn

  • warn(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/types/LoggerConfig.html b/packages/snap-logger/docs/types/LoggerConfig.html index a78590c47..577a9ae0c 100644 --- a/packages/snap-logger/docs/types/LoggerConfig.html +++ b/packages/snap-logger/docs/types/LoggerConfig.html @@ -1 +1 @@ -LoggerConfig | @searchspring/snap-logger

Type alias LoggerConfig

LoggerConfig: {
    mode?: keyof typeof AppMode | AppMode;
    prefix?: string;
}

Type declaration

  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional prefix?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +LoggerConfig | @searchspring/snap-logger

Type alias LoggerConfig

LoggerConfig: {
    mode?: keyof typeof AppMode | AppMode;
    prefix?: string;
}

Type declaration

  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional prefix?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/variables/colors.html b/packages/snap-logger/docs/variables/colors.html index d022553fe..f6233b977 100644 --- a/packages/snap-logger/docs/variables/colors.html +++ b/packages/snap-logger/docs/variables/colors.html @@ -1 +1 @@ -colors | @searchspring/snap-logger

Variable colorsConst

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = ...

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +colors | @searchspring/snap-logger

Variable colorsConst

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = ...

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/variables/emoji.html b/packages/snap-logger/docs/variables/emoji.html index eb945bfef..f6d8113c0 100644 --- a/packages/snap-logger/docs/variables/emoji.html +++ b/packages/snap-logger/docs/variables/emoji.html @@ -1 +1 @@ -emoji | @searchspring/snap-logger

Variable emojiConst

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = ...

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +emoji | @searchspring/snap-logger

Variable emojiConst

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = ...

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact-components/docs/iframe.html b/packages/snap-preact-components/docs/iframe.html index 4308256ec..e6188351d 100644 --- a/packages/snap-preact-components/docs/iframe.html +++ b/packages/snap-preact-components/docs/iframe.html @@ -348,4 +348,4 @@ - window['STORIES'] = [{"titlePrefix":"","directory":"./src","files":"**/*.stories.mdx","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.mdx)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.@(js|jsx|ts|tsx)","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|jsx|ts|tsx))$"}]; \ No newline at end of file + window['STORIES'] = [{"titlePrefix":"","directory":"./src","files":"**/*.stories.mdx","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.mdx)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.@(js|jsx|ts|tsx)","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|jsx|ts|tsx))$"}]; \ No newline at end of file diff --git a/packages/snap-preact-components/docs/main.65aede7a.iframe.bundle.js b/packages/snap-preact-components/docs/main.3b5e8bd6.iframe.bundle.js similarity index 99% rename from packages/snap-preact-components/docs/main.65aede7a.iframe.bundle.js rename to packages/snap-preact-components/docs/main.3b5e8bd6.iframe.bundle.js index d826e0260..c89507568 100644 --- a/packages/snap-preact-components/docs/main.65aede7a.iframe.bundle.js +++ b/packages/snap-preact-components/docs/main.3b5e8bd6.iframe.bundle.js @@ -1,4 +1,4 @@ -/*! For license information please see main.65aede7a.iframe.bundle.js.LICENSE.txt */ +/*! For license information please see main.3b5e8bd6.iframe.bundle.js.LICENSE.txt */ (self.webpackChunk_searchspring_snap_preact_components = self.webpackChunk_searchspring_snap_preact_components || []).push([ [792], { @@ -26921,7 +26921,7 @@ !mergedlazyRender.enabled || (0, useIntersection.v)(recsRef, mergedlazyRender.offset + ' 0px ' + mergedlazyRender.offset + ' 0px', !0)) && setIsVisible(!0), - children || (null != resultsToRender && resultsToRender.length) + (Array.isArray(children) && children.length) || (null != resultsToRender && resultsToRender.length) ? (0, emotion_react_browser_esm.Y)( cache._, null, @@ -36631,20 +36631,11 @@ { key: 'params', get: function get() { - var _this$context, - _this$context$options, - params = Object.assign( + var params = Object.assign( { tag: this.config.tag, batched: this.config.batched, branch: this.config.branch || 'production', - order: - null === (_this$context = this.context) || - void 0 === _this$context || - null === (_this$context$options = _this$context.options) || - void 0 === _this$context$options - ? void 0 - : _this$context$options.order, batchId: this.config.batchId, }, this.config.globals @@ -41444,37 +41435,39 @@ transformRecommendationFiltersPost = (__webpack_require__('../../node_modules/core-js/modules/es.array.find-index.js'), function transformRecommendationFiltersPost(filters) { - var filterArray = []; - return ( - filters.map(function (filter) { - if ('value' == filter.type) { - var i = filterArray.findIndex(function (_filter) { - return _filter.field == filter.field; - }); - if (i > -1) filterArray[i].values.push(filter.value); - else { - var val = { field: filter.field, type: '=', values: [filter.value] }; - filterArray.push(val); - } - } else if ('range' == filter.type) { - if ('number' == typeof filter.value.low) { - var low = { field: filter.field, type: '>=', values: [filter.value.low] }, - _i = filterArray.findIndex(function (_filter) { - return _filter.field == filter.field && '>=' == _filter.type; - }); - _i > -1 ? (filterArray[_i] = low) : filterArray.push(low); - } - if ('number' == typeof filter.value.high) { - var high = { field: filter.field, type: '<=', values: [filter.value.high] }, - _i2 = filterArray.findIndex(function (_filter) { - return _filter.field == filter.field && '<=' == _filter.type; - }); - _i2 > -1 ? (filterArray[_i2] = high) : filterArray.push(high); + if (filters) { + var filterArray = []; + return ( + filters.map(function (filter) { + if ('value' == filter.type) { + var i = filterArray.findIndex(function (_filter) { + return _filter.field == filter.field; + }); + if (i > -1) filterArray[i].values.push(filter.value); + else { + var val = { field: filter.field, type: '=', values: [filter.value] }; + filterArray.push(val); + } + } else if ('range' == filter.type) { + if ('number' == typeof filter.value.low) { + var low = { field: filter.field, type: '>=', values: [filter.value.low] }, + _i = filterArray.findIndex(function (_filter) { + return _filter.field == filter.field && '>=' == _filter.type; + }); + _i > -1 ? (filterArray[_i] = low) : filterArray.push(low); + } + if ('number' == typeof filter.value.high) { + var high = { field: filter.field, type: '<=', values: [filter.value.high] }, + _i2 = filterArray.findIndex(function (_filter) { + return _filter.field == filter.field && '<=' == _filter.type; + }); + _i2 > -1 ? (filterArray[_i2] = high) : filterArray.push(high); + } } - } - }), - filterArray - ); + }), + filterArray + ); + } }); function Recommend_regeneratorRuntime() { Recommend_regeneratorRuntime = function _regeneratorRuntime() { @@ -41982,7 +41975,8 @@ value: ((_batchRecommendations = Recommend_asyncToGenerator( Recommend_regeneratorRuntime().mark(function _callee3(parameters) { - var batchId, + var _parameters$profile, + batchId, key, batch, deferred, @@ -41996,7 +41990,13 @@ case 0: return ( (batchId = parameters.batchId || 1), - (key = parameters.batched ? parameters.siteId + ':' + batchId : Math.random() + ':' + batchId), + (key = parameters.batched + ? ((null === (_parameters$profile = parameters.profile) || void 0 === _parameters$profile + ? void 0 + : _parameters$profile.siteId) || parameters.siteId) + + ':' + + batchId + : Math.random() + ':' + batchId), (batch = this.batches[key] = this.batches[key] || { timeout: null, request: { profiles: [] }, entries: [] }), (deferred = new Deferred()), batch.entries.push({ request: parameters, deferred }), @@ -42016,76 +42016,121 @@ delete _this3.batches[key], batch.entries.sort(sortBatchEntries), batch.entries.map(function (entry) { - var _batch$request$profil, - transformedFilters, - _entry$request = entry.request, - tag = _entry$request.tag, - categories = _entry$request.categories, - brands = _entry$request.brands, - query = _entry$request.query, - filters = _entry$request.filters, - dedupe = _entry$request.dedupe; - filters && (transformedFilters = transformRecommendationFiltersPost(filters)); - var profile = { - tag, - categories, - brands, - limit: entry.request.limit || 20, - searchTerm: query, - filters: transformedFilters, - dedupe, - }; - null === (_batch$request$profil = batch.request.profiles) || - void 0 === _batch$request$profil || - _batch$request$profil.push(profile), - (batch.request = Object.assign({}, batch.request, { - siteId: parameters.siteId, - product: parameters.product, - products: parameters.products, - blockedItems: parameters.blockedItems, - test: parameters.test, - cart: parameters.cart, - lastViewed: parameters.lastViewed, - shopper: parameters.shopper, - })), - batch.request.product && - (Array.isArray(batch.request.products) && - -1 == batch.request.products.indexOf(batch.request.product) - ? (batch.request.products = batch.request.products.concat(batch.request.product)) - : (batch.request.products = [batch.request.product]), - delete batch.request.product); + var _entry$request$profil2; + if ( + (entry.request.product && + (Array.isArray(entry.request.products) && + -1 == entry.request.products.indexOf(entry.request.product) + ? (entry.request.products = entry.request.products.concat(entry.request.product)) + : (entry.request.products = [entry.request.product])), + entry.request.profile) + ) { + var _batch$request$profil, + _entry$request = entry.request, + tag = _entry$request.tag, + _entry$request$profil = _entry$request.profile, + categories = _entry$request$profil.categories, + brands = _entry$request$profil.brands, + _blockedItems = _entry$request$profil.blockedItems, + limit = _entry$request$profil.limit, + query = _entry$request$profil.query, + _filters = _entry$request$profil.filters, + dedupe = _entry$request$profil.dedupe, + profile = Object.assign( + { tag }, + defined({ + categories, + brands, + blockedItems: _blockedItems, + limit, + searchTerm: query, + filters: transformRecommendationFiltersPost(_filters), + dedupe, + }) + ); + null === (_batch$request$profil = batch.request.profiles) || + void 0 === _batch$request$profil || + _batch$request$profil.push(profile); + } else { + var _batch$request$profil2, + _entry$request2 = entry.request, + _tag = _entry$request2.tag, + _categories = _entry$request2.categories, + _brands = _entry$request2.brands, + _limit = _entry$request2.limit, + _query = _entry$request2.query, + _dedupe = _entry$request2.dedupe, + _profile = Object.assign( + { tag: _tag }, + defined({ + categories: _categories, + brands: _brands, + limit: _limit, + searchTerm: _query, + dedupe: _dedupe, + }) + ); + null === (_batch$request$profil2 = batch.request.profiles) || + void 0 === _batch$request$profil2 || + _batch$request$profil2.push(_profile); + } + var _entry$request3 = entry.request, + products = _entry$request3.products, + blockedItems = _entry$request3.blockedItems, + filters = _entry$request3.filters, + test = _entry$request3.test, + cart = _entry$request3.cart, + lastViewed = _entry$request3.lastViewed, + shopper = _entry$request3.shopper; + batch.request = Object.assign( + {}, + batch.request, + defined({ + siteId: + (null === (_entry$request$profil2 = entry.request.profile) || + void 0 === _entry$request$profil2 + ? void 0 + : _entry$request$profil2.siteId) || entry.request.siteId, + products, + blockedItems, + filters: transformRecommendationFiltersPost(filters), + test, + cart, + lastViewed, + shopper, + }) + ); }), (_context2.prev = 3), _this3.configuration.mode == AppMode.development && (batch.request.test = !0), - batch.request.product && (batch.request.product = batch.request.product.toString()), - (_context2.next = 8), + (_context2.next = 7), _this3.postRecommendations(batch.request) ); - case 8: + case 7: (response = _context2.sent), null === (_batch$entries = batch.entries) || void 0 === _batch$entries || _batch$entries.forEach(function (entry, index) { entry.deferred.resolve([response[index]]); }), - (_context2.next = 15); + (_context2.next = 14); break; - case 12: - (_context2.prev = 12), + case 11: + (_context2.prev = 11), (_context2.t0 = _context2.catch(3)), null === (_batch$entries2 = batch.entries) || void 0 === _batch$entries2 || _batch$entries2.forEach(function (entry) { entry.deferred.reject(_context2.t0); }); - case 15: + case 14: case 'end': return _context2.stop(); } }, _callee2, null, - [[3, 12]] + [[3, 11]] ); }) ), @@ -42161,6 +42206,15 @@ ? 1 : 0; } + function defined(properties) { + var definedProps = {}; + return ( + Object.keys(properties).map(function (key) { + void 0 !== properties[key] && (definedProps[key] = properties[key]); + }), + definedProps + ); + } var _excluded = ['tag']; function Client_slicedToArray(arr, i) { return ( @@ -49633,7 +49687,7 @@ (this.event = payload.event), (this.id = payload.id), (this.pid = payload.pid), - (this.meta = { initiator: { lib: 'searchspring/snap', 'lib.version': '0.60.0', 'lib.framework': config.framework } }), + (this.meta = { initiator: { lib: 'searchspring/snap', 'lib.version': '0.60.1', 'lib.framework': config.framework } }), (this.id = (0, v4.A)()); }); function Tracker_toConsumableArray(arr) { @@ -50189,7 +50243,7 @@ _this$globals$currenc.code && (this.context.currency = this.globals.currency), (null !== (_window$searchspring = window.searchspring) && void 0 !== _window$searchspring && _window$searchspring.tracker) || - ((window.searchspring = window.searchspring || {}), (window.searchspring.tracker = this), (window.searchspring.version = '0.60.0')), + ((window.searchspring = window.searchspring || {}), (window.searchspring.tracker = this), (window.searchspring.version = '0.60.1')), setTimeout(function () { _this.targeters.push( new DomTargeter([{ selector: 'script[type^="searchspring/track/"]', emptyTarget: !1 }], function (target, elem) { diff --git a/packages/snap-preact-components/docs/main.65aede7a.iframe.bundle.js.LICENSE.txt b/packages/snap-preact-components/docs/main.3b5e8bd6.iframe.bundle.js.LICENSE.txt similarity index 100% rename from packages/snap-preact-components/docs/main.65aede7a.iframe.bundle.js.LICENSE.txt rename to packages/snap-preact-components/docs/main.3b5e8bd6.iframe.bundle.js.LICENSE.txt diff --git a/packages/snap-preact/docs/classes/Snap.html b/packages/snap-preact/docs/classes/Snap.html index 5e8a90b6f..9b4af62eb 100644 --- a/packages/snap-preact/docs/classes/Snap.html +++ b/packages/snap-preact/docs/classes/Snap.html @@ -1,4 +1,4 @@ -Snap | @searchspring/snap-preact

Class Snap

Constructors

constructor +Snap | @searchspring/snap-preact

Class Snap

Constructors

constructor

Properties

_controllerPromises _instantiatorPromises client @@ -15,4 +15,4 @@ getController getControllers getInstantiator -

Constructors

constructor

Properties

Private _controllerPromises

_controllerPromises: {
    [controllerConfigId: string]: Promise<Controllers>;
} = {}

Type declaration

  • [controllerConfigId: string]: Promise<Controllers>

Private _instantiatorPromises

_instantiatorPromises: {
    [instantiatorId: string]: Promise<RecommendationInstantiator>;
} = {}

Type declaration

  • [instantiatorId: string]: Promise<RecommendationInstantiator>

client

client: Client

Private config

config: SnapConfig

context

context: ContextVariables

controllers

controllers: {
    [controllerConfigId: string]: Controllers;
} = {}

Type declaration

  • [controllerConfigId: string]: Controllers

eventManager

eventManager: EventManager

handlers

handlers: {
    error: ((event) => void);
} = ...

Type declaration

  • error: ((event) => void)
      • (event): void

      • Parameters

        • event: ErrorEvent

        Returns void

logger

logger: Logger

Private mode

mode: AppMode = AppMode.production

tracker

tracker: Tracker

Methods

Private _createController

  • _createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((cntrlr) => void | Promise<void>)
        • (cntrlr): void | Promise<void>

        • Parameters

          • cntrlr: Controllers

          Returns void | Promise<void>

    Returns Promise<Controllers>

createController

  • createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((value?) => void | Promise<void>)
        • (value?): void | Promise<void>

        • Parameters

          • Optional value: Controllers | PromiseLike<Controllers>

          Returns void | Promise<void>

    Returns Promise<Controllers>

getController

getControllers

  • getControllers(...controllerIds): Promise<Controllers[]>

  • Parameters

    • Rest ...controllerIds: string[]

    Returns Promise<Controllers[]>

getInstantiator

  • getInstantiator(id): Promise<RecommendationInstantiator>

  • Parameters

    • id: string

    Returns Promise<RecommendationInstantiator>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private _controllerPromises

_controllerPromises: {
    [controllerConfigId: string]: Promise<Controllers>;
} = {}

Type declaration

  • [controllerConfigId: string]: Promise<Controllers>

Private _instantiatorPromises

_instantiatorPromises: {
    [instantiatorId: string]: Promise<RecommendationInstantiator>;
} = {}

Type declaration

  • [instantiatorId: string]: Promise<RecommendationInstantiator>

client

client: Client

Private config

config: SnapConfig

context

context: ContextVariables

controllers

controllers: {
    [controllerConfigId: string]: Controllers;
} = {}

Type declaration

  • [controllerConfigId: string]: Controllers

eventManager

eventManager: EventManager

handlers

handlers: {
    error: ((event) => void);
} = ...

Type declaration

  • error: ((event) => void)
      • (event): void

      • Parameters

        • event: ErrorEvent

        Returns void

logger

logger: Logger

Private mode

mode: AppMode = AppMode.production

tracker

tracker: Tracker

Methods

Private _createController

  • _createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((cntrlr) => void | Promise<void>)
        • (cntrlr): void | Promise<void>

        • Parameters

          • cntrlr: Controllers

          Returns void | Promise<void>

    Returns Promise<Controllers>

createController

  • createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((value?) => void | Promise<void>)
        • (value?): void | Promise<void>

        • Parameters

          • Optional value: Controllers | PromiseLike<Controllers>

          Returns void | Promise<void>

    Returns Promise<Controllers>

getController

getControllers

  • getControllers(...controllerIds): Promise<Controllers[]>

  • Parameters

    • Rest ...controllerIds: string[]

    Returns Promise<Controllers[]>

getInstantiator

  • getInstantiator(id): Promise<RecommendationInstantiator>

  • Parameters

    • id: string

    Returns Promise<RecommendationInstantiator>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createAutocompleteController.html b/packages/snap-preact/docs/functions/createAutocompleteController.html index 375fa22f4..8599cb22f 100644 --- a/packages/snap-preact/docs/functions/createAutocompleteController.html +++ b/packages/snap-preact/docs/functions/createAutocompleteController.html @@ -1 +1 @@ -createAutocompleteController | @searchspring/snap-preact

Function createAutocompleteController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createAutocompleteController | @searchspring/snap-preact

Function createAutocompleteController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createFinderController.html b/packages/snap-preact/docs/functions/createFinderController.html index 693922e5d..636ec20b9 100644 --- a/packages/snap-preact/docs/functions/createFinderController.html +++ b/packages/snap-preact/docs/functions/createFinderController.html @@ -1 +1 @@ -createFinderController | @searchspring/snap-preact

Function createFinderController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createFinderController | @searchspring/snap-preact

Function createFinderController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createRecommendationController.html b/packages/snap-preact/docs/functions/createRecommendationController.html index 4b7e07f89..247849f53 100644 --- a/packages/snap-preact/docs/functions/createRecommendationController.html +++ b/packages/snap-preact/docs/functions/createRecommendationController.html @@ -1 +1 @@ -createRecommendationController | @searchspring/snap-preact

Function createRecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createRecommendationController | @searchspring/snap-preact

Function createRecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createSearchController.html b/packages/snap-preact/docs/functions/createSearchController.html index d84fd6e75..740b0afaf 100644 --- a/packages/snap-preact/docs/functions/createSearchController.html +++ b/packages/snap-preact/docs/functions/createSearchController.html @@ -1 +1 @@ -createSearchController | @searchspring/snap-preact

Function createSearchController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createSearchController | @searchspring/snap-preact

Function createSearchController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/types/SnapConfig.html b/packages/snap-preact/docs/types/SnapConfig.html index 02d10490c..ed5f13b4a 100644 --- a/packages/snap-preact/docs/types/SnapConfig.html +++ b/packages/snap-preact/docs/types/SnapConfig.html @@ -1 +1 @@ -SnapConfig | @searchspring/snap-preact

Type alias SnapConfig

SnapConfig: {
    client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    };
    context?: ContextVariables;
    controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    };
    features?: SnapFeatures;
    instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    };
    mode?: keyof typeof AppMode | AppMode;
    tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    };
    url?: UrlTranslatorConfig;
}

Type declaration

  • Optional client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    }
    • Optional config?: ClientConfig
    • Optional globals?: Partial<ClientGlobals>
  • Optional context?: ContextVariables
  • Optional controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    }
    • Optional autocomplete?: {
          config: AutocompleteControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional finder?: {
          config: FinderControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional recommendation?: {
          config: RecommendationControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional search?: {
          config: SearchControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig & {
              initial?: InitialUrlConfig;
          };
      }[]
  • Optional features?: SnapFeatures
  • Optional instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    }
    • Optional recommendation?: RecommendationInstantiatorConfig
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    }
    • Optional config?: TrackerConfig
    • Optional globals?: TrackerGlobals
  • Optional url?: UrlTranslatorConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SnapConfig | @searchspring/snap-preact

Type alias SnapConfig

SnapConfig: {
    client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    };
    context?: ContextVariables;
    controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    };
    features?: SnapFeatures;
    instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    };
    mode?: keyof typeof AppMode | AppMode;
    tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    };
    url?: UrlTranslatorConfig;
}

Type declaration

  • Optional client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    }
    • Optional config?: ClientConfig
    • Optional globals?: Partial<ClientGlobals>
  • Optional context?: ContextVariables
  • Optional controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    }
    • Optional autocomplete?: {
          config: AutocompleteControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional finder?: {
          config: FinderControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional recommendation?: {
          config: RecommendationControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional search?: {
          config: SearchControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig & {
              initial?: InitialUrlConfig;
          };
      }[]
  • Optional features?: SnapFeatures
  • Optional instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    }
    • Optional recommendation?: RecommendationInstantiatorConfig
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    }
    • Optional config?: TrackerConfig
    • Optional globals?: TrackerGlobals
  • Optional url?: UrlTranslatorConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/variables/polyfills.html b/packages/snap-preact/docs/variables/polyfills.html index 319ff52b8..c3d68c180 100644 --- a/packages/snap-preact/docs/variables/polyfills.html +++ b/packages/snap-preact/docs/variables/polyfills.html @@ -1 +1 @@ -polyfills | @searchspring/snap-preact

Variable polyfillsConst

polyfills: Promise<void> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +polyfills | @searchspring/snap-preact

Variable polyfillsConst

polyfills: Promise<void> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-profiler/docs/classes/Profiler.html b/packages/snap-profiler/docs/classes/Profiler.html index 37510cb47..0c5b69deb 100644 --- a/packages/snap-profiler/docs/classes/Profiler.html +++ b/packages/snap-profiler/docs/classes/Profiler.html @@ -1,6 +1,6 @@ -Profiler | @searchspring/snap-profiler

Class Profiler

Constructors

constructor +Profiler | @searchspring/snap-profiler

Class Profiler

Constructors

constructor

Properties

namespace profiles

Methods

create setNamespace -

Constructors

constructor

Properties

namespace

namespace: string

profiles

profiles: Profile<any>[]

Methods

create

  • create<T>(__namedParameters): Profile<T>

  • Type Parameters

    • T

    Parameters

    • __namedParameters: ProfileDetails<T>

    Returns Profile<T>

setNamespace

  • setNamespace(namespace): void

  • Parameters

    • namespace: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

namespace

namespace: string

profiles

profiles: Profile<any>[]

Methods

create

  • create<T>(__namedParameters): Profile<T>

  • Type Parameters

    • T

    Parameters

    • __namedParameters: ProfileDetails<T>

    Returns Profile<T>

setNamespace

  • setNamespace(namespace): void

  • Parameters

    • namespace: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/AbstractStore.html b/packages/snap-store-mobx/docs/classes/AbstractStore.html index 32aac79dd..b8ef8fc37 100644 --- a/packages/snap-store-mobx/docs/classes/AbstractStore.html +++ b/packages/snap-store-mobx/docs/classes/AbstractStore.html @@ -1,4 +1,4 @@ -AbstractStore | @searchspring/snap-store-mobx

Class AbstractStoreAbstract

Hierarchy (view full)

Constructors

constructor +AbstractStore | @searchspring/snap-store-mobx

Class AbstractStoreAbstract

Hierarchy (view full)

Constructors

constructor

Properties

config custom error @@ -7,4 +7,4 @@

Methods

setConfig toJSON update -

Constructors

constructor

Properties

config

config: StoreConfigs

custom

custom: {} = {}

Type declaration

    error

    error: undefined | {
        code?: number;
        message?: string;
        type?: ErrorType;
    }

    Type declaration

    • Optional code?: number
    • Optional message?: string
    • Optional type?: ErrorType

    loaded

    loaded: boolean = false

    loading

    loading: boolean = false

    Methods

    setConfig

    toJSON

    Abstract update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    config

    config: StoreConfigs

    custom

    custom: {} = {}

    Type declaration

      error

      error: undefined | {
          code?: number;
          message?: string;
          type?: ErrorType;
      }

      Type declaration

      • Optional code?: number
      • Optional message?: string
      • Optional type?: ErrorType

      loaded

      loaded: boolean = false

      loading

      loading: boolean = false

      Methods

      setConfig

      toJSON

      Abstract update

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/AutocompleteStore.html b/packages/snap-store-mobx/docs/classes/AutocompleteStore.html index a69e598b2..f55cd3999 100644 --- a/packages/snap-store-mobx/docs/classes/AutocompleteStore.html +++ b/packages/snap-store-mobx/docs/classes/AutocompleteStore.html @@ -1,4 +1,4 @@ -AutocompleteStore | @searchspring/snap-store-mobx

      Class AutocompleteStore

      Hierarchy (view full)

      Constructors

      constructor +AutocompleteStore | @searchspring/snap-store-mobx

      Class AutocompleteStore

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      config custom error @@ -29,4 +29,4 @@ toJSON update updateTrendingTerms -

      Constructors

      constructor

      Properties

      config

      config: StoreConfigs

      custom

      custom: {} = {}

      Type declaration

        error

        error: undefined | {
            code?: number;
            message?: string;
            type?: ErrorType;
        }

        Type declaration

        • Optional code?: number
        • Optional message?: string
        • Optional type?: ErrorType

        facets

        facets: AutocompleteFacetStore

        filters

        filters: SearchFilterStore

        history

        history: AutocompleteHistoryStore

        loaded

        loaded: boolean = false

        loading

        loading: boolean = false

        merchandising

        merchandising: SearchMerchandisingStore

        meta

        meta: MetaStore

        pagination

        pagination: SearchPaginationStore

        results

        results: SearchResultStore

        search

        search: AutocompleteQueryStore

        services

        services: StoreServices

        sorting

        sorting: SearchSortingStore

        state

        state: AutocompleteStateStore

        storage

        storage: StorageStore

        terms

        terms: AutocompleteTermStore

        trending

        trending: AutocompleteTrendingStore

        Methods

        initHistory

        reset

        resetHistory

        resetSuggestions

        resetTerms

        resetTrending

        setConfig

        setService

        toJSON

        update

        updateTrendingTerms

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        constructor

        Properties

        config

        config: StoreConfigs

        custom

        custom: {} = {}

        Type declaration

          error

          error: undefined | {
              code?: number;
              message?: string;
              type?: ErrorType;
          }

          Type declaration

          • Optional code?: number
          • Optional message?: string
          • Optional type?: ErrorType

          facets

          facets: AutocompleteFacetStore

          filters

          filters: SearchFilterStore

          history

          history: AutocompleteHistoryStore

          loaded

          loaded: boolean = false

          loading

          loading: boolean = false

          merchandising

          merchandising: SearchMerchandisingStore

          meta

          meta: MetaStore

          pagination

          pagination: SearchPaginationStore

          results

          results: SearchResultStore

          search

          search: AutocompleteQueryStore

          services

          services: StoreServices

          sorting

          sorting: SearchSortingStore

          state

          state: AutocompleteStateStore

          storage

          storage: StorageStore

          terms

          terms: AutocompleteTermStore

          trending

          trending: AutocompleteTrendingStore

          Methods

          initHistory

          reset

          resetHistory

          resetSuggestions

          resetTerms

          resetTrending

          setConfig

          setService

          toJSON

          update

          updateTrendingTerms

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Banner.html b/packages/snap-store-mobx/docs/classes/Banner.html index 75edf5b4b..9a4950f5b 100644 --- a/packages/snap-store-mobx/docs/classes/Banner.html +++ b/packages/snap-store-mobx/docs/classes/Banner.html @@ -1,4 +1,4 @@ -Banner | @searchspring/snap-store-mobx

          Class Banner

          Constructors

          constructor +Banner | @searchspring/snap-store-mobx

          Class Banner

          Constructors

          constructor

          Properties

          attributes config custom @@ -6,4 +6,4 @@ mappings type value -

          Constructors

          constructor

          Properties

          attributes

          attributes: Record<string, unknown> = {}

          config

          config: SearchResponseModelMerchandisingContentConfig

          custom

          custom: {} = {}

          Type declaration

            id

            id: string

            mappings

            mappings: SearchResponseModelResultMappings = ...

            type

            type: string = 'banner'

            value

            value: string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            constructor

            Properties

            attributes

            attributes: Record<string, unknown> = {}

            config

            config: SearchResponseModelMerchandisingContentConfig

            custom

            custom: {} = {}

            Type declaration

              id

              id: string

              mappings

              mappings: SearchResponseModelResultMappings = ...

              type

              type: string = 'banner'

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/CartStore.html b/packages/snap-store-mobx/docs/classes/CartStore.html index 1d555676b..8c0fafe07 100644 --- a/packages/snap-store-mobx/docs/classes/CartStore.html +++ b/packages/snap-store-mobx/docs/classes/CartStore.html @@ -1,4 +1,4 @@ -CartStore | @searchspring/snap-store-mobx

              Class CartStore

              Constructors

              constructor +CartStore | @searchspring/snap-store-mobx

              Class CartStore

              Constructors

              constructor

              Properties

              eventManager items

              Accessors

              count @@ -8,4 +8,4 @@ on removeItems reset -

              Constructors

              constructor

              Properties

              Private eventManager

              eventManager: EventManager

              items

              items: Product[] = []

              Accessors

              count

              msrp

              price

              Methods

              addItems

              on

              removeItems

              reset

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              Private eventManager

              eventManager: EventManager

              items

              items: Product[] = []

              Accessors

              count

              msrp

              price

              Methods

              addItems

              on

              removeItems

              reset

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html b/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html index 61e36db54..8994a3bd6 100644 --- a/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html @@ -1,4 +1,4 @@ -FacetHierarchyValue | @searchspring/snap-store-mobx

              Class FacetHierarchyValue

              Hierarchy (view full)

              Constructors

              constructor +FacetHierarchyValue | @searchspring/snap-store-mobx

              Class FacetHierarchyValue

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              count custom filtered @@ -8,4 +8,4 @@ preview? url value -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              history

              history: boolean = false

              label

              label: string

              level

              level: number = 0

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              history

              history: boolean = false

              label

              label: string

              level

              level: number = 0

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetRangeValue.html b/packages/snap-store-mobx/docs/classes/FacetRangeValue.html index aede21822..e8b410193 100644 --- a/packages/snap-store-mobx/docs/classes/FacetRangeValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetRangeValue.html @@ -1,4 +1,4 @@ -FacetRangeValue | @searchspring/snap-store-mobx

              Class FacetRangeValue

              Constructors

              constructor +FacetRangeValue | @searchspring/snap-store-mobx

              Class FacetRangeValue

              Constructors

              constructor

              Properties

              count custom filtered @@ -6,4 +6,4 @@ label low url -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              high

              high: number

              label

              label: string

              low

              low: number

              url

              url: UrlManager

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              high

              high: number

              label

              label: string

              low

              low: number

              url

              url: UrlManager

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetValue.html b/packages/snap-store-mobx/docs/classes/FacetValue.html index cb5a9ac79..c66f3fca3 100644 --- a/packages/snap-store-mobx/docs/classes/FacetValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetValue.html @@ -1,4 +1,4 @@ -FacetValue | @searchspring/snap-store-mobx

              Class FacetValue

              Hierarchy (view full)

              Constructors

              constructor +FacetValue | @searchspring/snap-store-mobx

              Class FacetValue

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              count custom filtered @@ -6,4 +6,4 @@ preview? url value -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              label

              label: string

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              label

              label: string

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Filter.html b/packages/snap-store-mobx/docs/classes/Filter.html index 48fe58838..b21911e56 100644 --- a/packages/snap-store-mobx/docs/classes/Filter.html +++ b/packages/snap-store-mobx/docs/classes/Filter.html @@ -1,6 +1,6 @@ -Filter | @searchspring/snap-store-mobx

              Class Filter

              Constructors

              constructor +Filter | @searchspring/snap-store-mobx

              Class Filter

              Constructors

              constructor

              Properties

              facet label url value -

              Constructors

              constructor

              Properties

              facet

              facet: {
                  field?: string;
                  label?: string;
              }

              Type declaration

              • Optional field?: string
              • Optional label?: string

              label

              label: string

              url

              url: UrlManager

              value

              value: {
                  label?: string;
                  value?: string;
              }

              Type declaration

              • Optional label?: string
              • Optional value?: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              facet

              facet: {
                  field?: string;
                  label?: string;
              }

              Type declaration

              • Optional field?: string
              • Optional label?: string

              label

              label: string

              url

              url: UrlManager

              value

              value: {
                  label?: string;
                  value?: string;
              }

              Type declaration

              • Optional label?: string
              • Optional value?: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FinderStore.html b/packages/snap-store-mobx/docs/classes/FinderStore.html index 63de56d6c..5b8cb7f95 100644 --- a/packages/snap-store-mobx/docs/classes/FinderStore.html +++ b/packages/snap-store-mobx/docs/classes/FinderStore.html @@ -1,4 +1,4 @@ -FinderStore | @searchspring/snap-store-mobx

              Class FinderStore

              Hierarchy (view full)

              Constructors

              constructor +FinderStore | @searchspring/snap-store-mobx

              Class FinderStore

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              config custom error @@ -18,4 +18,4 @@ setService toJSON update -

              Constructors

              constructor

              Properties

              config

              config: FinderStoreConfig

              custom

              custom: {} = {}

              Type declaration

                error

                error: undefined | {
                    code?: number;
                    message?: string;
                    type?: ErrorType;
                }

                Type declaration

                • Optional code?: number
                • Optional message?: string
                • Optional type?: ErrorType

                loaded

                loaded: boolean = false

                loading

                loading: boolean = false

                meta

                meta: MetaStore

                pagination

                pagination: SearchPaginationStore

                persistedStorage

                persistedStorage: StorageStore

                save

                save: (() => void) = ...

                Type declaration

                  • (): void

                  • Returns void

                selections

                selections: FinderSelectionStore

                services

                services: StoreServices

                state

                state: FinderStoreState = ...

                storage

                storage: StorageStore

                Methods

                loadPersisted

                reset

                setConfig

                setService

                toJSON

                update

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Constructors

                constructor

                Properties

                config

                config: FinderStoreConfig

                custom

                custom: {} = {}

                Type declaration

                  error

                  error: undefined | {
                      code?: number;
                      message?: string;
                      type?: ErrorType;
                  }

                  Type declaration

                  • Optional code?: number
                  • Optional message?: string
                  • Optional type?: ErrorType

                  loaded

                  loaded: boolean = false

                  loading

                  loading: boolean = false

                  meta

                  meta: MetaStore

                  pagination

                  pagination: SearchPaginationStore

                  persistedStorage

                  persistedStorage: StorageStore

                  save

                  save: (() => void) = ...

                  Type declaration

                    • (): void

                    • Returns void

                  selections

                  selections: FinderSelectionStore

                  services

                  services: StoreServices

                  state

                  state: FinderStoreState = ...

                  storage

                  storage: StorageStore

                  Methods

                  loadPersisted

                  reset

                  setConfig

                  setService

                  toJSON

                  update

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/MetaStore.html b/packages/snap-store-mobx/docs/classes/MetaStore.html index 04b3c8cdf..611ac1074 100644 --- a/packages/snap-store-mobx/docs/classes/MetaStore.html +++ b/packages/snap-store-mobx/docs/classes/MetaStore.html @@ -1,4 +1,4 @@ -MetaStore | @searchspring/snap-store-mobx

                  Class MetaStore

                  Constructors

                  constructor +MetaStore | @searchspring/snap-store-mobx

                  Class MetaStore

                  Constructors

                  constructor

                  Properties

                  badges data -

                  Constructors

                  constructor

                  Properties

                  badges

                  badges: MetaBadges

                  data

                  data: MetaResponseModel

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file +

                  Constructors

                  constructor

                  Properties

                  badges

                  badges: MetaBadges

                  data

                  data: MetaResponseModel

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Product.html b/packages/snap-store-mobx/docs/classes/Product.html index 06f2bd4d5..0f56fb6e0 100644 --- a/packages/snap-store-mobx/docs/classes/Product.html +++ b/packages/snap-store-mobx/docs/classes/Product.html @@ -1,4 +1,4 @@ -Product | @searchspring/snap-store-mobx

                  Class Product

                  Constructors

                  constructor +Product | @searchspring/snap-store-mobx

                  Class Product

                  Constructors

                  constructor

                  Properties

                  attributes badges children? @@ -10,4 +10,4 @@ type variants?

                  Accessors

                  display -

                  Constructors

                  constructor

                  Properties

                  attributes

                  attributes: Record<string, unknown> = {}

                  badges

                  badges: Badges

                  Optional children

                  children?: Child[] = []

                  custom

                  custom: {} = {}

                  Type declaration

                    id

                    id: string

                    mappings

                    mappings: SearchResponseModelResultMappings = ...

                    mask

                    mask: ProductMask = ...

                    quantity

                    quantity: number = 1

                    type

                    type: string = 'product'

                    Optional variants

                    variants?: Variants

                    Accessors

                    display

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    Generated using TypeDoc

                    \ No newline at end of file +

                    Constructors

                    constructor

                    Properties

                    attributes

                    attributes: Record<string, unknown> = {}

                    badges

                    badges: Badges

                    Optional children

                    children?: Child[] = []

                    custom

                    custom: {} = {}

                    Type declaration

                      id

                      id: string

                      mappings

                      mappings: SearchResponseModelResultMappings = ...

                      mask

                      mask: ProductMask = ...

                      quantity

                      quantity: number = 1

                      type

                      type: string = 'product'

                      Optional variants

                      variants?: Variants

                      Accessors

                      display

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      Generated using TypeDoc

                      \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/RangeFacet.html b/packages/snap-store-mobx/docs/classes/RangeFacet.html index 90849b512..5a3b097cd 100644 --- a/packages/snap-store-mobx/docs/classes/RangeFacet.html +++ b/packages/snap-store-mobx/docs/classes/RangeFacet.html @@ -1,4 +1,4 @@ -RangeFacet | @searchspring/snap-store-mobx

                      Class RangeFacet

                      Hierarchy

                      • Facet
                        • RangeFacet

                      Constructors

                      constructor +RangeFacet | @searchspring/snap-store-mobx

                      Class RangeFacet

                      Hierarchy

                      • Facet
                        • RangeFacet

                      Constructors

                      constructor

                      Properties

                      active? collapsed custom @@ -16,4 +16,4 @@

                      Accessors

                      clear filteredCount

                      Methods

                      toggleCollapse -

                      Constructors

                      constructor

                      Properties

                      Optional active

                      active?: SearchRequestModelFilterRangeAllOfValue = ...

                      collapsed

                      collapsed: boolean = false

                      custom

                      custom: {} = {}

                      Type declaration

                        display

                        display: string = ''

                        field

                        field: string

                        filtered

                        filtered: boolean = false

                        formatSeparator

                        formatSeparator: string

                        formatValue

                        formatValue: string

                        label

                        label: string = ''

                        Optional range

                        range?: SearchRequestModelFilterRangeAllOfValue = ...

                        services

                        services: StoreServices

                        Optional step

                        step?: number

                        storage

                        storage: StorageStore

                        type

                        type: string

                        Accessors

                        clear

                        filteredCount

                        Methods

                        toggleCollapse

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        Generated using TypeDoc

                        \ No newline at end of file +

                        Constructors

                        constructor

                        Properties

                        Optional active

                        active?: SearchRequestModelFilterRangeAllOfValue = ...

                        collapsed

                        collapsed: boolean = false

                        custom

                        custom: {} = {}

                        Type declaration

                          display

                          display: string = ''

                          field

                          field: string

                          filtered

                          filtered: boolean = false

                          formatSeparator

                          formatSeparator: string

                          formatValue

                          formatValue: string

                          label

                          label: string = ''

                          Optional range

                          range?: SearchRequestModelFilterRangeAllOfValue = ...

                          services

                          services: StoreServices

                          Optional step

                          step?: number

                          storage

                          storage: StorageStore

                          type

                          type: string

                          Accessors

                          clear

                          filteredCount

                          Methods

                          toggleCollapse

                          Settings

                          Member Visibility

                          Theme

                          On This Page

                          Generated using TypeDoc

                          \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/RecommendationStore.html b/packages/snap-store-mobx/docs/classes/RecommendationStore.html index 131f7b24c..8d535f965 100644 --- a/packages/snap-store-mobx/docs/classes/RecommendationStore.html +++ b/packages/snap-store-mobx/docs/classes/RecommendationStore.html @@ -1,4 +1,4 @@ -RecommendationStore | @searchspring/snap-store-mobx

                          Class RecommendationStore

                          Hierarchy (view full)

                          Constructors

                          constructor +RecommendationStore | @searchspring/snap-store-mobx

                          Class RecommendationStore

                          Hierarchy (view full)

                          Constructors

                          constructor

                          Properties

                          cart config custom @@ -13,4 +13,4 @@ setConfig toJSON update -

                          Constructors

                          constructor

                          Properties

                          cart

                          cart: CartStore

                          config

                          config: StoreConfigs

                          custom

                          custom: {} = {}

                          Type declaration

                            error

                            error: undefined | {
                                code?: number;
                                message?: string;
                                type?: ErrorType;
                            }

                            Type declaration

                            • Optional code?: number
                            • Optional message?: string
                            • Optional type?: ErrorType

                            loaded

                            loaded: boolean = false

                            loading

                            loading: boolean = false

                            meta

                            meta: MetaStore

                            profile

                            profile: RecommendationProfileStore

                            results

                            results: Product[]

                            services

                            services: StoreServices

                            Methods

                            reset

                            setConfig

                            toJSON

                            update

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            Generated using TypeDoc

                            \ No newline at end of file +

                            Constructors

                            constructor

                            Properties

                            cart

                            cart: CartStore

                            config

                            config: StoreConfigs

                            custom

                            custom: {} = {}

                            Type declaration

                              error

                              error: undefined | {
                                  code?: number;
                                  message?: string;
                                  type?: ErrorType;
                              }

                              Type declaration

                              • Optional code?: number
                              • Optional message?: string
                              • Optional type?: ErrorType

                              loaded

                              loaded: boolean = false

                              loading

                              loading: boolean = false

                              meta

                              meta: MetaStore

                              profile

                              profile: RecommendationProfileStore

                              results

                              results: Product[]

                              services

                              services: StoreServices

                              Methods

                              reset

                              setConfig

                              toJSON

                              update

                              Settings

                              Member Visibility

                              Theme

                              On This Page

                              Generated using TypeDoc

                              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/SearchFacetStore.html b/packages/snap-store-mobx/docs/classes/SearchFacetStore.html index 129626033..18dd9e675 100644 --- a/packages/snap-store-mobx/docs/classes/SearchFacetStore.html +++ b/packages/snap-store-mobx/docs/classes/SearchFacetStore.html @@ -1,4 +1,4 @@ -SearchFacetStore | @searchspring/snap-store-mobx

                              Class SearchFacetStore

                              Hierarchy

                              • Array
                                • SearchFacetStore

                              Constructors

                              constructor +SearchFacetStore | @searchspring/snap-store-mobx

                              Class SearchFacetStore

                              Hierarchy

                              • Array
                                • SearchFacetStore

                              Constructors

                              constructor

                              Properties

                              [unscopables] length

                              Accessors

                              [species] @@ -38,13 +38,13 @@ from isArray of -

                              Constructors

                              constructor

                              Properties

                              Readonly [unscopables]

                              [unscopables]: {
                                  [unscopables]?: boolean;
                                  length?: boolean;
                                  [iterator]?: any;
                                  at?: any;
                                  concat?: any;
                                  copyWithin?: any;
                                  entries?: any;
                                  every?: any;
                                  fill?: any;
                                  filter?: any;
                                  find?: any;
                                  findIndex?: any;
                                  flat?: any;
                                  flatMap?: any;
                                  forEach?: any;
                                  includes?: any;
                                  indexOf?: any;
                                  join?: any;
                                  keys?: any;
                                  lastIndexOf?: any;
                                  map?: any;
                                  pop?: any;
                                  push?: any;
                                  reduce?: any;
                                  reduceRight?: any;
                                  reverse?: any;
                                  shift?: any;
                                  slice?: any;
                                  some?: any;
                                  sort?: any;
                                  splice?: any;
                                  toLocaleString?: any;
                                  toString?: any;
                                  unshift?: any;
                                  values?: any;
                              }

                              Is an object whose properties have the value 'true' +

                              Constructors

                              constructor

                              Properties

                              Readonly [unscopables]

                              [unscopables]: {
                                  [unscopables]?: boolean;
                                  length?: boolean;
                                  [iterator]?: any;
                                  at?: any;
                                  concat?: any;
                                  copyWithin?: any;
                                  entries?: any;
                                  every?: any;
                                  fill?: any;
                                  filter?: any;
                                  find?: any;
                                  findIndex?: any;
                                  flat?: any;
                                  flatMap?: any;
                                  forEach?: any;
                                  includes?: any;
                                  indexOf?: any;
                                  join?: any;
                                  keys?: any;
                                  lastIndexOf?: any;
                                  map?: any;
                                  pop?: any;
                                  push?: any;
                                  reduce?: any;
                                  reduceRight?: any;
                                  reverse?: any;
                                  shift?: any;
                                  slice?: any;
                                  some?: any;
                                  sort?: any;
                                  splice?: any;
                                  toLocaleString?: any;
                                  toString?: any;
                                  unshift?: any;
                                  values?: any;
                              }

                              Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

                              Type declaration

                              • Optional Readonly [unscopables]?: boolean

                                Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

                              • Optional length?: boolean

                                Gets or sets the length of the array. This is a number one higher than the highest index in the array.

                              length

                              length: number

                              Gets or sets the length of the array. This is a number one higher than the highest index in the array.

                              -

                              Accessors

                              Static [species]

                              Methods

                              [iterator]

                              • [iterator](): IterableIterator<any>

                              • Iterator

                                +

                              Accessors

                              Static [species]

                              Methods

                              [iterator]

                              • [iterator](): IterableIterator<any>

                              • Iterator

                                Returns IterableIterator<any>

                              at