@searchspring/snap-event-manager 0.70.1 → 0.72.0

package/README.md

@@ -1,26 +1,9 @@
 # Snap Event 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>
 
-The Snap Event Manager is used to create events and attach middleware to them.
+The Snap Event Manager is available on each controller via `controller.eventManager` and is used to create events and attach middleware to them. Events are recommended to be configured via [Configuration Middleware](https://github.com/searchspring/snap/tree/main/docs/REFERENCE_CONFIGURATION_MIDDLEWARE.md) to hook into controller events at critical times in the life cycle. It also allows for custom events to be used throughout your implementation.
 
-When used as a service of a controller it allows you to hook into controller events at critical times in the life cycle. It also allows for custom events to be used throughout your implementation.
 
-
-## Dependency
-
-Snap Event Manager is a dependency of [@searchspring/snap-controller](https://github.com/searchspring/snap/tree/main/packages/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>
-
-## Installation
-
-```bash
-npm install --save @searchspring/snap-event-manager
-```
-
-## Import
-```typescript
-import { EventManager } from '@searchspring/snap-event-manager';
-```
 ## Controller usage
 Snap Event Manager is a dependency of Snap Controller and it is recommended to use methods of the controller to attach events to the EventManager. Additionally, different events exist for the different controllers - see the Controller documentation for more details.
 
@@ -28,10 +11,8 @@ Snap Event Manager is a dependency of Snap Controller and it is recommended to u
 ### `on` method
 Used to attach middleware to an event. If the event name previously had middleware attached, it will add to the middleware stack.
 
-```typescript
-const eventManager = new EventManager();
-
-eventManager.on('interestingEvent', async (eventData, next) => {
+```js
+controller.eventManager.on('interestingEvent', async (eventData, next) => {
 	// do something with the eventData
 
 	// pass control to the next middleware attached to the event
@@ -46,8 +27,8 @@ If a middleware returns `false` the entire middleware flow is interrupted and an
 ### `fire` method
 Invoke custom event. Data passed into the second parameter gets handed off to the middleware attached with the `on` method.
 
-```typescript
-eventManager.fire('interestingEvent', { data: { some: 'string' } });
+```js
+controller.eventManager.fire('interestingEvent', { data: { some: 'string' } });
 ```
 
 ## Middleware
@@ -58,26 +39,26 @@ The first middleware attached with the `on` method is the first to execute. When
 
 ### Order Flow Example
 
-```typescript
-eventManager.on('interestingEvent', async (data, next) => {
+```js
+controller.eventManager.on('interestingEvent', async (data, next) => {
 	console.log('first middleware start');
 	await next();
 	console.log('first middleware end');
 });
 
-eventManager.on('interestingEvent', async (data, next) => {
+controller.eventManager.on('interestingEvent', async (data, next) => {
 	console.log('second middleware start');
 	await next();
 	console.log('second middleware end');
 });
 
-eventManager.on('interestingEvent', async (data, next) => {
+controller.eventManager.on('interestingEvent', async (data, next) => {
 	console.log('third middleware start');
 	await next();
 	console.log('third middleware end');
 });
 
-eventManager.fire('interestingEvent', { data: { some: 'string' } } );
+controller.eventManager.fire('interestingEvent', { data: { some: 'string' } } );
 
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@searchspring/snap-event-manager",
-	"version": "0.70.1",
+	"version": "0.72.0",
 	"description": "Snap Event Manager",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
@@ -23,5 +23,5 @@
 	"files": [
 		"dist/**/*"
 	],
-	"gitHead": "91ca0ec407be1edb997da1256242d167aa7da79f"
+	"gitHead": "737d4bd308ebbb852fe3f09b2b90f4af87bbe264"
 }