@searchspring/snap-controller 0.71.0 → 0.72.0

package/README.md

@@ -1,76 +1,16 @@
 # Snap Controller
 
-<a href="https://www.npmjs.com/package/@searchspring/snap-controller"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-controller.svg?style=flat"></a>
-
 The heart of controlling Search, Autocomplete, & Finder functionality. The Controller is responsible for tying various Snap services together.
 
+Although `@searchspring/snap-controller` is published as a standalone package, it is not intended to be used directly. Internally it is a dependency of the `@searchspring/snap-preact` package.
 
-## Dependencies
-
-Snap Controller is a top-level package that requires the following dependencies as services:
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-client"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-client.svg?style=flat"></a> [@searchspring/snap-client](https://github.com/searchspring/snap/tree/main/packages/snap-client)
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-store-mobx"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-store-mobx.svg?style=flat"></a> [@searchspring/snap-store-mobx](https://github.com/searchspring/snap/tree/main/packages/snap-store-mobx)
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-url-manager"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-url-manager.svg?style=flat"></a> [@searchspring/snap-url-manager](https://github.com/searchspring/snap/tree/main/packages/snap-url-manager)
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-event-manager"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-event-manager.svg?style=flat"></a> [@searchspring/snap-event-manager](https://github.com/searchspring/snap/tree/main/packages/snap-event-manager)
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-profiler"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-profiler.svg?style=flat"></a> [@searchspring/snap-profiler](https://github.com/searchspring/snap/tree/main/packages/snap-profiler)
-
-<a href="https://www.npmjs.com/package/@searchspring/snap-logger"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-logger.svg?style=flat"></a> [@searchspring/snap-logger](https://github.com/searchspring/snap/tree/main/packages/snap-logger)
-
-## Installation
-
-To install the `snap-controller` package and it's services:
-
-```bash
-npm install --save @searchspring/snap-controller @searchspring/snap-client @searchspring/snap-store-mobx @searchspring/snap-url-manager @searchspring/snap-event-manager @searchspring/snap-profiler @searchspring/snap-logger
-```
-
-
-## Instantiation
-Each `Controller` must be passed a configuration object as the first parameter to the constructor, and a services object (dependencies) as the second. The contents of these objects will depend on which type of `Controller` is being instantiated. For example, a `SearchController` would usually be paired with a `SearchStore` service, and would take a `SearchControllerConfig` configuration object.
-
-The complete example below shows how a `SearchController` could be instatiated, initialized and searched:
-
-```typescript
-import { Client } from '@searchspring/snap-client';
-import { SearchStore } from '@searchspring/snap-store-mobx';
-import { UrlManager, UrlTranslator } from '@searchspring/snap-url-manager';
-import { EventManager } from '@searchspring/snap-event-manager';
-import { Profiler } from '@searchspring/snap-profiler';
-import { Logger } from '@searchspring/snap-logger';
-import { Tracker } from '@searchspring/snap-tracker';
-import { SearchController } from '@searchspring/snap-controller';
-
-const configuration = {
-	id: 'search'
-};
-
-const urlManager = new UrlManager(new UrlTranslator());
-const services = {
-	client: new Client({ siteId: 'abc123' }),
-	store: new SearchStore(configuration, { urlManager }),
-	urlManager,
-	eventManager: new EventManager(),
-	profiler: new Profiler(),
-	logger: new Logger(),
-	tracker: new Tracker(),
-}
-
-const controller = new SearchController(configuration, services);
-controller.init();
-controller.search();
-```
 
 ## Configuration
 The configuration object provided during instantiation provides a way of configuring the controller for different behavior. Each controller type (`SearchController`, `AutocompleteController`, `FinderController`, etc...) has default configurations that can be modified with the instantiation configuration object. At minimum an `id` attribute is required for identifying controllers. The `id` should be unique to each *instance* of a controller.
 ## Services
 Along with a configuration, each controller is passed a collection of services during instantiation. These services are then used by the controller and made available via controller methods. Sometimes controllers might share a reference to a service (the `client` service for example), but in most cases a controller will have it's own instance of a service. Some services (like the `SearchStore`) share services with the controller (in the example above, the `UrlManager` is shared).
 
-```typescript
+```js
 { client, store, urlManager, eventManager, profiler, logger }
 ```
 ### client
@@ -94,7 +34,7 @@ The `logger` service provides logging functionality to a controller. Each contro
 Each Controller can optionally take a 3rd parameter for `Context`. This is to allow each individual controller to have its own individual context if so desired.
 
 The context is exposed as `controller.context`
-```typescript
+```js
 controller.context;
 ```
 
@@ -102,7 +42,7 @@ controller.context;
 ## Initialization
 Invoking the `init` method is required to subscribe to changes that occur in the UrlManager. It also fires the `init` event which executes attached middleware. This can be fired manually as needed; if it was not manually fired it will happen automatically on the first call to the controller `search` method.
 
-```typescript
+```js
 controller.init();
 ```
 
@@ -111,7 +51,7 @@ The `search` method of a controller will run the search that is expected by leve
 
 Most controllers will provide a means of manipulating the request and response using `beforeSearch` and `afterSearch` events respectively. Read on for details about events.
 
-```typescript
+```js
 controller.search();
 ```
 
@@ -121,7 +61,7 @@ Different controller types will utilize different Snap Stores (typically of the
 ## Events
 Each controller will fire various events. Some of the event names are shared between controllers for consistency (ex: `beforeSearch`, `afterSearch`, `afterStore`); however the attaching of middleware and execution of it must remain separate. This is why a new `EventManager` instance is created for each controller. Middleware are attached to events via the `on` method and the functions should almost always end with `await next()` unless purposefully preventing the next attached middleware from executing.
 
-```typescript
+```js
 controller.on('init', async (eventData, next) => {
 	const { controller } = eventData;
 
@@ -135,7 +75,7 @@ Note: Groups of middleware (plugins) can be attached using the `plugin` method.
 
 The data available within a middleware (first parameter) is determined by what gets passed into the `fire` method. For existing events on the controller, the `fire` method is already being called when appropriate to the event, and the `eventData` will typically be an object containing a reference to the controller and any other details that may be of importance to the particular event. Custom events can be created as needed; but keep in mind that any middleware tied to the event should be bound (using `on` or `plugin`) prior to the execution of the `fire` method.
 
-```typescript
+```js
 controller.eventManager.fire('customEventName', { thing1: 'one', thing2: 2 });
 ```
 
@@ -146,13 +86,13 @@ A controller's environment is initialized at build time, and is used to control
 ## Logging
 The logger provides a clear way of outputting details like profile data or errors to the developer console. A `production` build will supress most logs while a `development` build will show them all. The environment is automatically determined, but can be toggled during runtime by setting it to either `development` or `production`.
 
-```typescript
+```js
 controller.environment = 'development';
 ```
 
 The use of `console.log()` is discouraged. Logging should be done via controller instance to help debug and navigate the sea of console logs. Each controller will output the `id` for easily deciphering which controller made the log.
 
-```typescript
+```js
 controller.log.warn('THIS IS A WARNING!');
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snap-controller",
-	"version": "0.71.0",
+	"version": "0.72.0",
 	"description": "Snap Controllers",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
@@ -20,22 +20,22 @@
 		"test:watch": "jest --watch"
 	},
 	"dependencies": {
-		"@searchspring/snap-toolbox": "0.71.0",
+		"@searchspring/snap-toolbox": "0.72.0",
 		"css.escape": "1.5.1",
 		"deepmerge": "4.3.1"
 	},
 	"devDependencies": {
-		"@searchspring/snap-client": "0.71.0",
-		"@searchspring/snap-event-manager": "0.71.0",
-		"@searchspring/snap-logger": "0.71.0",
-		"@searchspring/snap-profiler": "0.71.0",
-		"@searchspring/snap-store-mobx": "0.71.0",
-		"@searchspring/snap-tracker": "0.71.0",
-		"@searchspring/snap-url-manager": "0.71.0"
+		"@searchspring/snap-client": "0.72.0",
+		"@searchspring/snap-event-manager": "0.72.0",
+		"@searchspring/snap-logger": "0.72.0",
+		"@searchspring/snap-profiler": "0.72.0",
+		"@searchspring/snap-store-mobx": "0.72.0",
+		"@searchspring/snap-tracker": "0.72.0",
+		"@searchspring/snap-url-manager": "0.72.0"
 	},
 	"sideEffects": false,
 	"files": [
 		"dist/**/*"
 	],
-	"gitHead": "86eb6dec8c57def5b869157dc00bbb9b6e793619"
+	"gitHead": "737d4bd308ebbb852fe3f09b2b90f4af87bbe264"
 }