@unchainedshop/events 4.3.3 → 4.4.0

package/README.md

@@ -1,3 +1,85 @@
-# Events (Unchained Engine)
+[![npm version](https://img.shields.io/npm/v/@unchainedshop/events.svg)](https://npmjs.com/package/@unchainedshop/events)
+[![License: EUPL-1.2](https://img.shields.io/badge/License-EUPL--1.2-blue.svg)](https://opensource.org/licenses/EUPL-1.2)
 
-This package contains business logic for the event emitter abstraction layer
+# @unchainedshop/events
+
+Event emitter abstraction layer for the Unchained Engine. Provides a pluggable event system for emitting and subscribing to business events.
+
+## Installation
+
+```bash
+npm install @unchainedshop/events
+```
+
+## Usage
+
+```typescript
+import { emit, subscribe, registerEvents } from '@unchainedshop/events';
+
+// Register custom events
+registerEvents(['ORDER_CREATED', 'ORDER_PAID']);
+
+// Subscribe to events
+subscribe('ORDER_CREATED', ({ payload }) => {
+  console.log('Order created:', payload);
+});
+
+// Emit events
+await emit('ORDER_CREATED', { orderId: '123', total: 99.99 });
+```
+
+## API Overview
+
+### Event Functions
+
+| Export | Description |
+|--------|-------------|
+| `emit` | Emit an event with a payload |
+| `subscribe` | Subscribe to an event with a callback handler |
+| `registerEvents` | Register new event types |
+| `getRegisteredEvents` | Get list of all registered event types |
+
+### Adapter Management
+
+| Export | Description |
+|--------|-------------|
+| `getEmitAdapter` | Get the current emit adapter |
+| `setEmitAdapter` | Set a custom emit adapter |
+| `getEmitHistoryAdapter` | Get the current emit history adapter |
+| `setEmitHistoryAdapter` | Set a custom emit history adapter |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `EmitAdapter` | Interface for custom emit adapters |
+| `RawPayloadType` | Type for event payload data |
+
+### Built-in Events
+
+| Event | Description |
+|-------|-------------|
+| `PAGE_VIEW` | Registered by default for page view tracking |
+
+## Custom Adapters
+
+You can implement custom emit adapters for different backends (Redis, Kafka, etc.):
+
+```typescript
+import { setEmitAdapter, type EmitAdapter } from '@unchainedshop/events';
+
+const customAdapter: EmitAdapter = {
+  publish: async (eventName, payload) => {
+    // Custom publish logic
+  },
+  subscribe: (eventName, callback) => {
+    // Custom subscribe logic
+  },
+};
+
+setEmitAdapter(customAdapter);
+```
+
+## License
+
+EUPL-1.2

package/lib/EventDirector.d.ts

@@ -15,4 +15,3 @@ export declare const EventDirector: {
     emit: (eventName: string, data?: Record<string, any>) => Promise<void>;
     subscribe: <T extends Record<string, any>>(eventName: string, callback: (payload: RawPayloadType<T>) => void) => void;
 };
-//# sourceMappingURL=EventDirector.d.ts.map

package/lib/EventDirector.js

@@ -2,8 +2,8 @@ import { createLogger } from '@unchainedshop/logger';
 const logger = createLogger('unchained:events');
 const RegisteredEventsSet = new Set();
 const RegisteredCallbacksSet = new Set();
-let Adapter; // Public (customizable)
-let HistoryAdapter; // (Per default: Core-events adapter to write into DB)
+let Adapter;
+let HistoryAdapter;
 export const EventDirector = {
     registerEvents: (events) => {
         if (events.length) {
@@ -34,7 +34,7 @@ export const EventDirector = {
         logger.debug(`EventDirector -> Emitted ${eventName} with ${JSON.stringify(data)}`);
     },
     subscribe: (eventName, callback) => {
-        const currentSubscription = `${eventName}${callback?.toString()}`; // used to avaoid registering the same event handler callback
+        const currentSubscription = `${eventName}${callback?.toString()}`;
         if (!RegisteredEventsSet.has(eventName))
             throw new Error(`Event with ${eventName} is not registered`);
         if (!RegisteredCallbacksSet.has(currentSubscription)) {
@@ -44,4 +44,3 @@ export const EventDirector = {
         }
     },
 };
-//# sourceMappingURL=EventDirector.js.map

package/lib/events-index.d.ts

@@ -1,4 +1,4 @@
-import { EmitAdapter, RawPayloadType } from './EventDirector.js';
+import { type EmitAdapter, type RawPayloadType } from './EventDirector.ts';
 declare const emit: (eventName: string, data?: Record<string, any>) => Promise<void>, getEmitAdapter: () => EmitAdapter, getEmitHistoryAdapter: () => EmitAdapter, getRegisteredEvents: () => string[], registerEvents: (events: string[]) => void, setEmitAdapter: (adapter: EmitAdapter) => void, setEmitHistoryAdapter: (adapter: EmitAdapter) => void, subscribe: <T extends Record<string, any>>(eventName: string, callback: (payload: RawPayloadType<T>) => void) => void;
-export { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, EmitAdapter, RawPayloadType, };
-//# sourceMappingURL=events-index.d.ts.map
+export { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, };
+export type { EmitAdapter, RawPayloadType };

package/lib/events-index.js

@@ -1,6 +1,5 @@
-import { EventDirector } from './EventDirector.js';
+import { EventDirector } from "./EventDirector.js";
 const { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, } = EventDirector;
 const GLOBAL_EVENTS = ['PAGE_VIEW'];
 registerEvents(GLOBAL_EVENTS);
 export { emit, getEmitAdapter, getEmitHistoryAdapter, getRegisteredEvents, registerEvents, setEmitAdapter, setEmitHistoryAdapter, subscribe, };
-//# sourceMappingURL=events-index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/events",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "main": "lib/events-index.js",
   "types": "lib/events-index.d.ts",
   "type": "module",
@@ -9,8 +9,8 @@
     "build": "tsc -b",
     "prepublishOnly": "npm run clean && npm run build",
     "watch": "tsc -w",
-    "test": "tsx --test",
-    "test:watch": "tsx --test --watch"
+    "test": "node --test",
+    "test:watch": "node --test --watch"
   },
   "repository": {
     "type": "git",
@@ -22,8 +22,10 @@
     "core"
   ],
   "authors": [
-    "Joël Meiller",
-    "Pascal Kaufmann"
+    "Pascal Kaufmann",
+    "Mikael Araya",
+    "Vedran Rudelj",
+    "Joël Meiller"
   ],
   "license": "EUPL-1.2",
   "bugs": {
@@ -31,11 +33,10 @@
   },
   "homepage": "https://github.com/unchainedshop/unchained#readme",
   "dependencies": {
-    "@unchainedshop/logger": "^4.3.0"
+    "@unchainedshop/logger": "^4.4.0"
   },
   "devDependencies": {
-    "@types/node": "^24.0.13",
-    "tsx": "^4.20.3",
+    "@types/node": "^25.0.0",
     "typescript": "^5.8.3"
   }
 }

package/lib/EventDirector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventDirector.d.ts","sourceRoot":"","sources":["../src/EventDirector.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,OAAO,EAAE,CAAC,CAAC;CACZ;AACD,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;IAC5E,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;CACtG;AAQD,eAAO,MAAM,aAAa;6BACC,MAAM,EAAE,KAAG,IAAI;+BAMf,MAAM,EAAE;8BAIP,WAAW,KAAG,IAAI;0BAIxB,WAAW;qCAEE,WAAW,KAAG,IAAI;iCAIxB,WAAW;sBAEd,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,OAAO,CAAC,IAAI,CAAC;gBAiB9D,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,aAC5B,MAAM,YACP,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,KAC7C,IAAI;CAYR,CAAC"}

package/lib/EventDirector.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventDirector.js","sourceRoot":"","sources":["../src/EventDirector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,MAAM,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC;AAUhD,MAAM,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;AACtC,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAC;AAEzC,IAAI,OAAoB,CAAC,CAAC,wBAAwB;AAClD,IAAI,cAA2B,CAAC,CAAC,sDAAsD;AAEvF,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,cAAc,EAAE,CAAC,MAAgB,EAAQ,EAAE;QACzC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,mBAAmB,EAAE,GAAa,EAAE;QAClC,OAAO,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAa,CAAC;IACrD,CAAC;IAED,cAAc,EAAE,CAAC,OAAoB,EAAQ,EAAE;QAC7C,OAAO,GAAG,OAAO,CAAC;IACpB,CAAC;IAED,cAAc,EAAE,GAAgB,EAAE,CAAC,OAAO;IAE1C,qBAAqB,EAAE,CAAC,OAAoB,EAAQ,EAAE;QACpD,cAAc,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,qBAAqB,EAAE,GAAgB,EAAE,CAAC,cAAc;IAExD,IAAI,EAAE,KAAK,EAAE,SAAiB,EAAE,IAA0B,EAAiB,EAAE;QAC3E,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,oBAAoB,CAAC,CAAC;QAE/D,MAAM,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;QAE3B,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE;YAC1B,OAAO;SACR,CAAC,CAAC;QAEH,cAAc,EAAE,OAAO,CAAC,SAAS,EAAE;YACjC,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,CAAC,KAAK,CAAC,4BAA4B,SAAS,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,SAAS,EAAE,CACT,SAAiB,EACjB,QAA8C,EACxC,EAAE;QACR,MAAM,mBAAmB,GAAG,GAAG,SAAS,GAAG,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,6DAA6D;QAEhI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,cAAc,SAAS,oBAAoB,CAAC,CAAC;QAE/D,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACrD,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YACxC,cAAc,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC/C,sBAAsB,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;CACF,CAAC"}

package/lib/events-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"events-index.d.ts","sourceRoot":"","sources":["../src/events-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,WAAW,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEhF,QAAA,MACE,IAAI,oEACJ,cAAc,qBACd,qBAAqB,qBACrB,mBAAmB,kBACnB,cAAc,8BACd,cAAc,kCACd,qBAAqB,kCACrB,SAAS,4GACM,CAAC;AAKlB,OAAO,EACL,IAAI,EACJ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,SAAS,EACT,WAAW,EACX,cAAc,GACf,CAAC"}

package/lib/events-index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"events-index.js","sourceRoot":"","sources":["../src/events-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAEhF,MAAM,EACJ,IAAI,EACJ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,SAAS,GACV,GAAG,aAAa,CAAC;AAElB,MAAM,aAAa,GAAG,CAAC,WAAW,CAAC,CAAC;AACpC,cAAc,CAAC,aAAa,CAAC,CAAC;AAE9B,OAAO,EACL,IAAI,EACJ,cAAc,EACd,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,SAAS,GAGV,CAAC"}

package/src/EventDirector.ts

@@ -1,74 +0,0 @@
-import { createLogger } from '@unchainedshop/logger';
-
-const logger = createLogger('unchained:events');
-
-export interface RawPayloadType<T> {
-  payload: T;
-}
-export interface EmitAdapter {
-  publish(eventName: string, data: RawPayloadType<Record<string, any>>): void;
-  subscribe(eventName: string, callback: (payload: RawPayloadType<Record<string, any>>) => void): void;
-}
-
-const RegisteredEventsSet = new Set();
-const RegisteredCallbacksSet = new Set();
-
-let Adapter: EmitAdapter; // Public (customizable)
-let HistoryAdapter: EmitAdapter; // (Per default: Core-events adapter to write into DB)
-
-export const EventDirector = {
-  registerEvents: (events: string[]): void => {
-    if (events.length) {
-      events.forEach((e) => RegisteredEventsSet.add(e));
-    }
-  },
-
-  getRegisteredEvents: (): string[] => {
-    return Array.from(RegisteredEventsSet) as string[];
-  },
-
-  setEmitAdapter: (adapter: EmitAdapter): void => {
-    Adapter = adapter;
-  },
-
-  getEmitAdapter: (): EmitAdapter => Adapter,
-
-  setEmitHistoryAdapter: (adapter: EmitAdapter): void => {
-    HistoryAdapter = adapter;
-  },
-
-  getEmitHistoryAdapter: (): EmitAdapter => HistoryAdapter,
-
-  emit: async (eventName: string, data?: Record<string, any>): Promise<void> => {
-    if (!RegisteredEventsSet.has(eventName))
-      throw new Error(`Event with ${eventName} is not registered`);
-
-    const payload = data || {};
-
-    Adapter?.publish(eventName, {
-      payload,
-    });
-
-    HistoryAdapter?.publish(eventName, {
-      payload,
-    });
-
-    logger.debug(`EventDirector -> Emitted ${eventName} with ${JSON.stringify(data)}`);
-  },
-
-  subscribe: <T extends Record<string, any>>(
-    eventName: string,
-    callback: (payload: RawPayloadType<T>) => void,
-  ): void => {
-    const currentSubscription = `${eventName}${callback?.toString()}`; // used to avaoid registering the same event handler callback
-
-    if (!RegisteredEventsSet.has(eventName))
-      throw new Error(`Event with ${eventName} is not registered`);
-
-    if (!RegisteredCallbacksSet.has(currentSubscription)) {
-      Adapter?.subscribe(eventName, callback);
-      HistoryAdapter?.subscribe(eventName, callback);
-      RegisteredCallbacksSet.add(currentSubscription);
-    }
-  },
-};

package/src/events-index.ts

@@ -1,28 +0,0 @@
-import { EventDirector, EmitAdapter, RawPayloadType } from './EventDirector.js';
-
-const {
-  emit,
-  getEmitAdapter,
-  getEmitHistoryAdapter,
-  getRegisteredEvents,
-  registerEvents,
-  setEmitAdapter,
-  setEmitHistoryAdapter,
-  subscribe,
-} = EventDirector;
-
-const GLOBAL_EVENTS = ['PAGE_VIEW'];
-registerEvents(GLOBAL_EVENTS);
-
-export {
-  emit,
-  getEmitAdapter,
-  getEmitHistoryAdapter,
-  getRegisteredEvents,
-  registerEvents,
-  setEmitAdapter,
-  setEmitHistoryAdapter,
-  subscribe,
-  EmitAdapter,
-  RawPayloadType,
-};

package/tests/events-index.test.ts

@@ -1,8 +0,0 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert';
-
-describe('Worker', () => {
-  it('Init', () => {
-    assert(true);
-  });
-});

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../shared/base.tsconfig.json",
-  "compilerOptions": {
-    "declarationDir": "./lib",
-    "rootDir": "./src",
-    "outDir": "./lib",
-    
-  },
-  "exclude": ["**/*.test.ts", "**/*.test.js", "tests", "lib"]
-}