@boostkit/events 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 BoostKit
+
+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.

package/README.md

@@ -0,0 +1,43 @@
+# @boostkit/events
+
+Event dispatcher, listener contract, and provider factory for listener registration.
+
+## Installation
+
+```bash
+pnpm add @boostkit/events
+```
+
+## Usage
+
+```ts
+// bootstrap/providers.ts
+import { events } from '@boostkit/events'
+
+class UserRegistered {}
+class SendWelcome {
+  async handle(_event: UserRegistered) {}
+}
+
+export default [
+  events({ [UserRegistered.name]: [SendWelcome] }),
+]
+```
+
+## API Reference
+
+- `Listener<T>`
+- `EventDispatcher`
+- `dispatcher` (global dispatcher)
+- `dispatch(event)`
+- `ListenMap`
+- `events(listenMap)`
+
+## Configuration
+
+This package has no runtime config object.
+
+## Notes
+
+- `EventDispatcher.dispatch()` resolves listeners by `event.constructor.name`.
+- Listener handlers are awaited in registration order.

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { ServiceProvider, type Application } from '@boostkit/core';
+export interface Listener<T = unknown> {
+    handle(event: T): void | Promise<void>;
+}
+export declare class EventDispatcher {
+    private readonly map;
+    /** Register one or more listeners for an event class name */
+    register(eventName: string, ...listeners: Listener<unknown>[]): void;
+    /** Dispatch an event to all registered listeners (in order, awaited) */
+    dispatch<T extends object>(event: T): Promise<void>;
+    /** Check how many listeners are registered for an event */
+    count(eventName: string): number;
+}
+export declare const dispatcher: EventDispatcher;
+/** Dispatch an event through the global dispatcher */
+export declare function dispatch<T extends object>(event: T): Promise<void>;
+/** Maps event class names to arrays of Listener classes */
+export type ListenMap = Record<string, (new () => Listener<never>)[]>;
+/**
+ * Returns an EventServiceProvider class that registers the given listener map
+ * into the global EventDispatcher on boot.
+ *
+ * Usage in bootstrap/providers.ts:
+ *   import { events } from '@boostkit/events'
+ *   import { UserRegistered } from '../app/Events/UserRegistered.js'
+ *   import { SendWelcomeEmailListener } from '../app/Listeners/SendWelcomeEmailListener.js'
+ *
+ *   events({
+ *     [UserRegistered.name]: [SendWelcomeEmailListener],
+ *   })
+ */
+export declare function events(listen: ListenMap): new (app: Application) => ServiceProvider;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAIlE,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,OAAO;IACnC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAID,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAyC;IAE7D,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI;IAKpE,wEAAwE;IAClE,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzD,2DAA2D;IAC3D,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;CAGjC;AAID,eAAO,MAAM,UAAU,iBAAwB,CAAA;AAE/C,sDAAsD;AACtD,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAElE;AAID,2DAA2D;AAC3D,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,UAAU,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;AAIrE;;;;;;;;;;;;GAYG;AACH,wBAAgB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,KAAK,GAAG,EAAE,WAAW,KAAK,eAAe,CAkBnF"}

package/dist/index.js

@@ -0,0 +1,58 @@
+import { ServiceProvider } from '@boostkit/core';
+// ─── Event Dispatcher ──────────────────────────────────────
+export class EventDispatcher {
+    map = new Map();
+    /** Register one or more listeners for an event class name */
+    register(eventName, ...listeners) {
+        const existing = this.map.get(eventName) ?? [];
+        this.map.set(eventName, [...existing, ...listeners]);
+    }
+    /** Dispatch an event to all registered listeners (in order, awaited) */
+    async dispatch(event) {
+        const name = event.constructor.name;
+        const listeners = this.map.get(name) ?? [];
+        for (const listener of listeners) {
+            await listener.handle(event);
+        }
+    }
+    /** Check how many listeners are registered for an event */
+    count(eventName) {
+        return this.map.get(eventName)?.length ?? 0;
+    }
+}
+// ─── Global Dispatcher Singleton ───────────────────────────
+export const dispatcher = new EventDispatcher();
+/** Dispatch an event through the global dispatcher */
+export function dispatch(event) {
+    return dispatcher.dispatch(event);
+}
+// ─── Service Provider Factory ──────────────────────────────
+/**
+ * Returns an EventServiceProvider class that registers the given listener map
+ * into the global EventDispatcher on boot.
+ *
+ * Usage in bootstrap/providers.ts:
+ *   import { events } from '@boostkit/events'
+ *   import { UserRegistered } from '../app/Events/UserRegistered.js'
+ *   import { SendWelcomeEmailListener } from '../app/Listeners/SendWelcomeEmailListener.js'
+ *
+ *   events({
+ *     [UserRegistered.name]: [SendWelcomeEmailListener],
+ *   })
+ */
+export function events(listen) {
+    class EventServiceProvider extends ServiceProvider {
+        register() { }
+        boot() {
+            let total = 0;
+            for (const [eventName, listenerClasses] of Object.entries(listen)) {
+                const instances = listenerClasses.map((LC) => new LC());
+                dispatcher.register(eventName, ...instances);
+                total += listenerClasses.length;
+            }
+            console.log(`[EventServiceProvider] booted — ${Object.keys(listen).length} events, ${total} listeners`);
+        }
+    }
+    return EventServiceProvider;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAoB,MAAM,gBAAgB,CAAA;AAQlE,8DAA8D;AAE9D,MAAM,OAAO,eAAe;IACT,GAAG,GAAG,IAAI,GAAG,EAA+B,CAAA;IAE7D,6DAA6D;IAC7D,QAAQ,CAAC,SAAiB,EAAE,GAAG,SAA8B;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAA;QAC9C,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,GAAG,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAC,CAAA;IACtD,CAAC;IAED,wEAAwE;IACxE,KAAK,CAAC,QAAQ,CAAmB,KAAQ;QACvC,MAAM,IAAI,GAAQ,KAAK,CAAC,WAAW,CAAC,IAAI,CAAA;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC9B,CAAC;IACH,CAAC;IAED,2DAA2D;IAC3D,KAAK,CAAC,SAAiB;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,CAAA;IAC7C,CAAC;CACF;AAED,8DAA8D;AAE9D,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;AAE/C,sDAAsD;AACtD,MAAM,UAAU,QAAQ,CAAmB,KAAQ;IACjD,OAAO,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACnC,CAAC;AAOD,8DAA8D;AAE9D;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,MAAM,CAAC,MAAiB;IACtC,MAAM,oBAAqB,SAAQ,eAAe;QAChD,QAAQ,KAAU,CAAC;QAEnB,IAAI;YACF,IAAI,KAAK,GAAG,CAAC,CAAA;YACb,KAAK,MAAM,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAClE,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAwB,CAAA;gBAC9E,UAAU,CAAC,QAAQ,CAAC,SAAS,EAAE,GAAG,SAAS,CAAC,CAAA;gBAC5C,KAAK,IAAI,eAAe,CAAC,MAAM,CAAA;YACjC,CAAC;YACD,OAAO,CAAC,GAAG,CACT,mCAAmC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,YAAY,KAAK,YAAY,CAC3F,CAAA;QACH,CAAC;KACF;IAED,OAAO,oBAAoB,CAAA;AAC7B,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@boostkit/events",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/boostkitjs/boostkit",
+    "directory": "packages/events"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@boostkit/core": "0.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.4.0",
+    "tsx": "^4.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "tsc -p tsconfig.test.json && node --test dist-test/index.test.js; rm -rf dist-test"
+  }
+}