@searchspring/snap-preact 0.27.2 → 0.27.5

package/README.md

@@ -2,300 +2,4 @@
 
 <a href="https://www.npmjs.com/package/@searchspring/snap-preact"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-preact.svg?style=flat"></a>
 
-Snap Preact is an abstraction layer that provides a config based interface for creating a Searchspring integration quickly.
-
-
-## Installation
-
-To install the `snap-preact` package and it's dependencies:
-
-```bash
-npm install --save @searchspring/snap-preact
-```
-
-## Instantiation
-
-```typescript
-import { Snap } from '@searchspring/snap-preact';
-
-const snap = new Snap(config);
-```
-
-## Configuration
-A configuration object provided to Snap will determine the services that will be created. 
-
-Full example:
-
-```typescript
-const config = {
-	context: globalContext,
-	url: {
-		parameters: {
-			core: {
-				query: { name: 'search' },
-			},
-		},
-	},
-	client: {
-		globals: {
-			siteId: 'xxxxxx',
-		},
-	},
-	controllers: {
-		search: [
-			{
-				config: {
-					id: 'search',
-					settings: {
-						redirects: {
-							merchandising: false,
-						},
-					},
-				},
-				targets: [
-					{
-						selector: '#searchspring-content',
-						component: () => Content,
-						hideTarget: true,
-					},
-					{
-						selector: '#searchspring-sidebar',
-						component: () => Sidebar,
-						hideTarget: true,
-					},
-				],
-			},
-		],
-		autocomplete: [
-			{
-				config: {
-					id: 'autocomplete',
-					selector: 'input.searchspring-ac',
-					settings: {
-						trending: {
-							limit: 5,
-						},
-					},
-				},
-				targets: [
-					{
-						selector: 'input.searchspring-ac',
-						component: () => Autocomplete,
-						hideTarget: true,
-					},
-				],
-			},
-		],
-	},
-};
-```
-
-### `config.context` - optional `Context` object to be used to set the global context. If no context is provided, a default context taken from the integration script (`shopper` variable) will be used, otherwise the provided `config.context` is merged with the script context. This context becomes the `globalContext` that is passed to all controllers that are created.
-
-### config.client
-A single client instance will be created and shared across all services using the provided config. 
-
-See [@searchspring/snap-client](https://github.com/searchspring/snap/tree/main/packages/snap-client) documentation for full client config options.
-
-```typescript
-const config = {
-	client: {
-		globals: {
-			siteId: 'xxxxxx'
-		}
-	}
-}
-```
-
-### config.instantiators
-The `instantiators` object must be defined if any Recommendation controllers have also been defined via `config.controllers.recommendation`
-
-```typescript
-const config = {
-	instantiators: {
-		recommendation: {
-			context: recommendationContext,
-			components: {
-				Standard: () => Standard
-			},
-			config: {
-				branch: BRANCHNAME,
-				batched: true
-			},
-			selector: '',
-			services: {}
-		}
-	},
-	controllers: {
-		recommendation: []
-	}
-}
-```
-
-`recommendation.components` - required mapping of recommendation components.
-
-`recommendation.context` - optional `Context` object to be used to set controller specific context. Defaults to the global context if no context prop is provided, or if one is provided, it is merged into the global context.
-
-`recommendation.config.branch` - required current git branch name. Defined via webpack during bundle build:
-
-```typescript
-const webpack = require('webpack');
-const childProcess = require('child_process');
-const branchName = childProcess.execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
-
-module.exports = {
-	plugins: [
-		new webpack.DefinePlugin({
-			BRANCHNAME: `"${branchName}"`,
-		}),
-	],
-}
-```
-
-`recommendation.config.batched` - optional boolean (default: `true`) to batch multiple recommendations into a single network request
-
-`recommendation.selector` - optional selector to target recommendation instances if using a non-standard installation. Default selector: `script[type="searchspring/recommend"]`
-
-`recommendation.services` - optional object of `ControllerServices` 
-
-
-
-### config.url
-The `url` object contains the config provided to each [`UrlTranslator`](https://github.com/searchspring/snap/tree/main/packages/snap-url-manager/src/Translators/Url) created by Snap Preact.
-
-```typescript
-const config = {
-	url: {
-		parameters: {
-			core: {
-				query: { name: 'search' },
-				page: { name: 'p' }
-			},
-		},
-	},
-}
-```
-
-### config.controllers
-The `controllers` object contains a list of controllers to create for each controller type. 
-
-Available controllers:
-
-- [SearchController](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Search) 
-- [AutocompleteController](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Autocomplete)
-- [FinderController](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Finder)
-- [RecommendationController](https://github.com/searchspring/snap/tree/main/packages/snap-controller/src/Recommendation)
-
-```typescript
-const config = {
-	controllers: {
-		search: [],
-		autocomplete: [],
-		finder: [],
-		recommendation: [],
-	}
-}
-```
-
-Each array entry contains an object with the following properties:
-
-`config` - required controller config for the corresponding controller. See Controller specific documentation for all available configuration options.
-
-`targets` - optional array of Target objects. Targets thats have been found will have the corresponding controller provided to the target component `controller` prop and the controller's `search` method invoked.
-
-```typescript
-type ExtendedTarget = {
-	selector: string;
-	inject?: {
-		action: 'before' | 'after' | 'append' | 'prepend' | 'replace';
-		element: Element | ((target: Target, element: Element) => Element);
-	};
-	hideTarget?: boolean;
-	emptyTarget?: boolean;
-	name?: string;
-	component?: () => Promise<RootComponent> | RootComponent;
-	props?: unknown;  // additional props to pass to the component
-	onTarget?: OnTarget;  // additional scripts to execute when target is found
-	prefetch?: boolean;  // run controller search before finding targets
-}
-```
-
-`services` - optional object of `ControllerServices` to be used for this controller in place of the default services
-
-`url` - optional `UrlTranslator` config object to be used with the `UrlManager` for this controller
-
-`context` - optional `Context` object to be used to set controller specific context. Defaults to the global context if no context prop is provided, or if one is provided, it is merged into the global context.
-
-An example creating a SearchController:
-
-```typescript
-const config = {
-	controllers: {
-		search: [
-			{
-				context: searchContext,
-				config: {
-					id: 'search',
-				},
-				targets: [
-					{
-						selector: '#searchspring-content',
-						component: () => Content,
-						hideTarget: true,
-					},
-					{
-						selector: '#searchspring-sidebar',
-						component: () => Sidebar,
-						hideTarget: true,
-					},
-				],
-				services: {}
-			}
-		]
-	}
-}
-```
-The controller config `id` will be the name of the controller that you will then interface from the return of creating the `new Snap()` instance via the `controllers` object. 
-
-For example, if using the `config` example above:
-
-```typescript
-const snap = new Snap(config);
-const { search } = snap.controllers;
-```
-
-## properties
-
-After instantiating an instance of Snap, the following properties can be accessed. 
-
-### config
-A reference to the config that was provided.
-
-### logger
-A reference to the shared [@searchspring/snap-logger](https://github.com/searchspring/snap/tree/main/packages/snap-logger) instance used by each controller.
-
-### client
-A reference to the shared [@searchspring/snap-client](https://github.com/searchspring/snap/tree/main/packages/snap-client) instance used by each controller.
-
-### tracker
-A reference to the shared [@searchspring/snap-tracker](https://github.com/searchspring/snap/tree/main/packages/snap-tracker) instance used by each controller.
-
-### controllers
-An object containing all controllers that have been created. 
-
-
-### recommendations
-A reference to `RecommendationInstantiator` instance if creating recommendation instances.
-
-
-## polyfills
-
-Snap Preact provides various polyfills to ensure legacy browser support.
-
-```typescript
-import { polyfills } from '@searchspring/snap-preact';
-
-polyfills.then(() => {
-	import('./index');
-})
-```
+Snap Preact is an abstraction layer that provides a config based interface for creating a Searchspring integration quickly.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snap-preact",
-	"version": "0.27.2",
+	"version": "0.27.5",
 	"description": "Snap Preact",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
@@ -20,16 +20,16 @@
 		"test:watch": "jest --watch"
 	},
 	"dependencies": {
-		"@searchspring/snap-client": "^0.27.2",
-		"@searchspring/snap-controller": "^0.27.2",
-		"@searchspring/snap-event-manager": "^0.27.2",
-		"@searchspring/snap-logger": "^0.27.2",
-		"@searchspring/snap-preact-components": "^0.27.2",
-		"@searchspring/snap-profiler": "^0.27.2",
-		"@searchspring/snap-store-mobx": "^0.27.2",
-		"@searchspring/snap-toolbox": "^0.27.2",
-		"@searchspring/snap-tracker": "^0.27.2",
-		"@searchspring/snap-url-manager": "^0.27.2",
+		"@searchspring/snap-client": "^0.27.5",
+		"@searchspring/snap-controller": "^0.27.5",
+		"@searchspring/snap-event-manager": "^0.27.5",
+		"@searchspring/snap-logger": "^0.27.5",
+		"@searchspring/snap-preact-components": "^0.27.5",
+		"@searchspring/snap-profiler": "^0.27.5",
+		"@searchspring/snap-store-mobx": "^0.27.5",
+		"@searchspring/snap-toolbox": "^0.27.5",
+		"@searchspring/snap-tracker": "^0.27.5",
+		"@searchspring/snap-url-manager": "^0.27.5",
 		"deepmerge": "^4.2.2",
 		"intersection-observer": "^0.12.0",
 		"is-plain-object": "^5.0.0"
@@ -40,6 +40,5 @@
 	"sideEffects": false,
 	"files": [
 		"dist/**/*"
-	],
-	"gitHead": "4b0a534583ab1ef24fdda8c408ec23296c135ef4"
+	]
 }

package/LICENSE

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