@dudousxd/nestjs-notifications-sse 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { Sse, SseChannel, type SseChannelOptions, type SseNotification, } from './sse.channel';
 export { SseHub } from './sse.hub';
-export { SseChannelModule, type SseChannelModuleOptions } from './sse.module';
+export { SseChannelModule, type SseChannelModuleOptions, type SseChannelModuleAsyncOptions, type SseChannelAsyncConfig, } from './sse.module';
 export { SSE_OPTIONS, SSE_BACKPLANE } from './tokens';
 export { sseKey } from './sse-key';
+export { createNotificationsStreamController, type NotificationsStreamControllerOptions, } from './stream-controller';
 export type { SseBackplane, SseBackplaneMessage } from './backplane';
 export { RedisSseBackplane, type RedisSseBackplaneOptions, type RedisPubSubClient, } from './redis.backplane';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,GACvB,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EACH,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EACL,gBAAgB,EAChB,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,EACjC,KAAK,qBAAqB,GAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EACL,mCAAmC,EACnC,KAAK,oCAAoC,GAC1C,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,iBAAiB,GACvB,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RedisSseBackplane = exports.sseKey = exports.SSE_BACKPLANE = exports.SSE_OPTIONS = exports.SseChannelModule = exports.SseHub = exports.SseChannel = exports.Sse = void 0;
+exports.RedisSseBackplane = exports.createNotificationsStreamController = exports.sseKey = exports.SSE_BACKPLANE = exports.SSE_OPTIONS = exports.SseChannelModule = exports.SseHub = exports.SseChannel = exports.Sse = void 0;
 var sse_channel_1 = require("./sse.channel");
 Object.defineProperty(exports, "Sse", { enumerable: true, get: function () { return sse_channel_1.Sse; } });
 Object.defineProperty(exports, "SseChannel", { enumerable: true, get: function () { return sse_channel_1.SseChannel; } });
@@ -13,6 +13,8 @@ Object.defineProperty(exports, "SSE_OPTIONS", { enumerable: true, get: function
 Object.defineProperty(exports, "SSE_BACKPLANE", { enumerable: true, get: function () { return tokens_1.SSE_BACKPLANE; } });
 var sse_key_1 = require("./sse-key");
 Object.defineProperty(exports, "sseKey", { enumerable: true, get: function () { return sse_key_1.sseKey; } });
+var stream_controller_1 = require("./stream-controller");
+Object.defineProperty(exports, "createNotificationsStreamController", { enumerable: true, get: function () { return stream_controller_1.createNotificationsStreamController; } });
 var redis_backplane_1 = require("./redis.backplane");
 Object.defineProperty(exports, "RedisSseBackplane", { enumerable: true, get: function () { return redis_backplane_1.RedisSseBackplane; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAKuB;AAJrB,kGAAA,GAAG,OAAA;AACH,yGAAA,UAAU,OAAA;AAIZ,qCAAmC;AAA1B,iGAAA,MAAM,OAAA;AACf,2CAA8E;AAArE,8GAAA,gBAAgB,OAAA;AACzB,mCAAsD;AAA7C,qGAAA,WAAW,OAAA;AAAE,uGAAA,aAAa,OAAA;AACnC,qCAAmC;AAA1B,iGAAA,MAAM,OAAA;AAEf,qDAI2B;AAHzB,oHAAA,iBAAiB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6CAKuB;AAJrB,kGAAA,GAAG,OAAA;AACH,yGAAA,UAAU,OAAA;AAIZ,qCAAmC;AAA1B,iGAAA,MAAM,OAAA;AACf,2CAKsB;AAJpB,8GAAA,gBAAgB,OAAA;AAKlB,mCAAsD;AAA7C,qGAAA,WAAW,OAAA;AAAE,uGAAA,aAAa,OAAA;AACnC,qCAAmC;AAA1B,iGAAA,MAAM,OAAA;AACf,yDAG6B;AAF3B,wIAAA,mCAAmC,OAAA;AAIrC,qDAI2B;AAHzB,oHAAA,iBAAiB,OAAA"}

package/dist/sse.module.d.ts

@@ -1,4 +1,4 @@
-import { type DynamicModule } from '@nestjs/common';
+import { type DynamicModule, type FactoryProvider, type ModuleMetadata } from '@nestjs/common';
 import type { SseBackplane } from './backplane';
 export interface SseChannelModuleOptions {
     /** SSE event name (`type`) emitted to clients. Defaults to `'notification'`. */
@@ -12,19 +12,39 @@ export interface SseChannelModuleOptions {
     /** Register globally so the channel is discoverable app-wide. Default true. */
     global?: boolean;
 }
+/** The slice of {@link SseChannelModuleOptions} a {@link SseChannelModuleAsyncOptions} factory returns. */
+export interface SseChannelAsyncConfig {
+    event?: string;
+    backplane?: SseBackplane;
+}
+/** Async registration for {@link SseChannelModule.forRootAsync} — build options (e.g. the backplane) from DI. */
+export interface SseChannelModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
+    useFactory: (...args: never[]) => SseChannelAsyncConfig | Promise<SseChannelAsyncConfig>;
+    inject?: FactoryProvider['inject'];
+    /** Register globally so the channel is discoverable app-wide. Default true. */
+    global?: boolean;
+}
 /**
  * Registers the SSE channel and its {@link SseHub}.
  *
- * The streaming endpoint itself is mounted by the consumer in their own
- * controller via NestJS's native `@Sse()` decorator — this module only provides
- * the hub (to read from) and the channel (to push into). See {@link SseChannel}
- * for the controller example.
+ * The streaming endpoint itself is mounted by the consumer in their own controller via NestJS's
+ * native `@Sse()` decorator — this module only provides the hub (to read from) and the channel (to
+ * push into). See {@link SseChannel} for the controller example.
  *
  * ```ts
  * SseChannelModule.forRoot({ event: 'notification' });
+ *
+ * // Build the backplane from DI (e.g. a Redis config service):
+ * SseChannelModule.forRootAsync({
+ *   inject: [AppConfig],
+ *   useFactory: (cfg: AppConfig) => ({
+ *     backplane: new RedisSseBackplane({ publisher: new Redis(cfg.redis), subscriber: new Redis(cfg.redis) }),
+ *   }),
+ * });
  * ```
  */
 export declare class SseChannelModule {
     static forRoot(options?: SseChannelModuleOptions): DynamicModule;
+    static forRootAsync(options: SseChannelModuleAsyncOptions): DynamicModule;
 }
 //# sourceMappingURL=sse.module.d.ts.map

package/dist/sse.module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sse.module.d.ts","sourceRoot":"","sources":["../src/sse.module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAyB,MAAM,gBAAgB,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAKhD,MAAM,WAAW,uBAAuB;IACtC,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,qBACa,gBAAgB;IAC3B,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,uBAA4B,GAAG,aAAa;CAmBrE"}
+{"version":3,"file":"sse.module.d.ts","sourceRoot":"","sources":["../src/sse.module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,eAAe,EAEpB,KAAK,cAAc,EAEpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAKhD,MAAM,WAAW,uBAAuB;IACtC,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB,+EAA+E;IAC/E,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,2GAA2G;AAC3G,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED,iHAAiH;AACjH,MAAM,WAAW,4BAA6B,SAAQ,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC;IACnF,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACzF,MAAM,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAC;IACnC,+EAA+E;IAC/E,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAKD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBACa,gBAAgB;IAC3B,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,uBAA4B,GAAG,aAAa;IAgBpE,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,4BAA4B,GAAG,aAAa;CAgC1E"}

package/dist/sse.module.js

@@ -12,32 +12,68 @@ const common_1 = require("@nestjs/common");
 const sse_channel_1 = require("./sse.channel");
 const sse_hub_1 = require("./sse.hub");
 const tokens_1 = require("./tokens");
+/** Internal token holding the resolved async config. */
+const SSE_RESOLVED_CONFIG = Symbol('SSE_RESOLVED_CONFIG');
 /**
  * Registers the SSE channel and its {@link SseHub}.
  *
- * The streaming endpoint itself is mounted by the consumer in their own
- * controller via NestJS's native `@Sse()` decorator — this module only provides
- * the hub (to read from) and the channel (to push into). See {@link SseChannel}
- * for the controller example.
+ * The streaming endpoint itself is mounted by the consumer in their own controller via NestJS's
+ * native `@Sse()` decorator — this module only provides the hub (to read from) and the channel (to
+ * push into). See {@link SseChannel} for the controller example.
  *
  * ```ts
  * SseChannelModule.forRoot({ event: 'notification' });
+ *
+ * // Build the backplane from DI (e.g. a Redis config service):
+ * SseChannelModule.forRootAsync({
+ *   inject: [AppConfig],
+ *   useFactory: (cfg: AppConfig) => ({
+ *     backplane: new RedisSseBackplane({ publisher: new Redis(cfg.redis), subscriber: new Redis(cfg.redis) }),
+ *   }),
+ * });
  * ```
  */
 let SseChannelModule = SseChannelModule_1 = class SseChannelModule {
     static forRoot(options = {}) {
-        const channelOptions = {
-            event: options.event ?? 'notification',
+        const channelOptions = { event: options.event ?? 'notification' };
+        return {
+            module: SseChannelModule_1,
+            global: options.global ?? true,
+            providers: [
+                { provide: tokens_1.SSE_OPTIONS, useValue: channelOptions },
+                { provide: tokens_1.SSE_BACKPLANE, useValue: options.backplane ?? null },
+                sse_hub_1.SseHub,
+                sse_channel_1.SseChannel,
+            ],
+            exports: [sse_hub_1.SseHub, sse_channel_1.SseChannel],
         };
+    }
+    static forRootAsync(options) {
         const providers = [
-            { provide: tokens_1.SSE_OPTIONS, useValue: channelOptions },
-            { provide: tokens_1.SSE_BACKPLANE, useValue: options.backplane ?? null },
+            {
+                provide: SSE_RESOLVED_CONFIG,
+                useFactory: options.useFactory,
+                inject: options.inject ?? [],
+            },
+            {
+                provide: tokens_1.SSE_OPTIONS,
+                useFactory: (config) => ({
+                    event: config.event ?? 'notification',
+                }),
+                inject: [SSE_RESOLVED_CONFIG],
+            },
+            {
+                provide: tokens_1.SSE_BACKPLANE,
+                useFactory: (config) => config.backplane ?? null,
+                inject: [SSE_RESOLVED_CONFIG],
+            },
             sse_hub_1.SseHub,
             sse_channel_1.SseChannel,
         ];
         return {
             module: SseChannelModule_1,
             global: options.global ?? true,
+            imports: options.imports ?? [],
             providers,
             exports: [sse_hub_1.SseHub, sse_channel_1.SseChannel],
         };

package/dist/sse.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"sse.module.js","sourceRoot":"","sources":["../src/sse.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAA2E;AAE3E,+CAAmE;AACnE,uCAAmC;AACnC,qCAAsD;AAetD;;;;;;;;;;;GAWG;AAEI,IAAM,gBAAgB,wBAAtB,MAAM,gBAAgB;IAC3B,MAAM,CAAC,OAAO,CAAC,UAAmC,EAAE;QAClD,MAAM,cAAc,GAAsB;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,cAAc;SACvC,CAAC;QAEF,MAAM,SAAS,GAAe;YAC5B,EAAE,OAAO,EAAE,oBAAW,EAAE,QAAQ,EAAE,cAAc,EAAE;YAClD,EAAE,OAAO,EAAE,sBAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;YAC/D,gBAAM;YACN,wBAAU;SACX,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,kBAAgB;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;YAC9B,SAAS;YACT,OAAO,EAAE,CAAC,gBAAM,EAAE,wBAAU,CAAC;SAC9B,CAAC;IACJ,CAAC;CACF,CAAA;AApBY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,gBAAgB,CAoB5B"}
+{"version":3,"file":"sse.module.js","sourceRoot":"","sources":["../src/sse.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAMwB;AAExB,+CAAmE;AACnE,uCAAmC;AACnC,qCAAsD;AA6BtD,wDAAwD;AACxD,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;GAkBG;AAEI,IAAM,gBAAgB,wBAAtB,MAAM,gBAAgB;IAC3B,MAAM,CAAC,OAAO,CAAC,UAAmC,EAAE;QAClD,MAAM,cAAc,GAAsB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,cAAc,EAAE,CAAC;QAErF,OAAO;YACL,MAAM,EAAE,kBAAgB;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;YAC9B,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,oBAAW,EAAE,QAAQ,EAAE,cAAc,EAAE;gBAClD,EAAE,OAAO,EAAE,sBAAa,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;gBAC/D,gBAAM;gBACN,wBAAU;aACX;YACD,OAAO,EAAE,CAAC,gBAAM,EAAE,wBAAU,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,YAAY,CAAC,OAAqC;QACvD,MAAM,SAAS,GAAe;YAC5B;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,UAAU,EAAE,OAAO,CAAC,UAAU;gBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,EAAE;aAC7B;YACD;gBACE,OAAO,EAAE,oBAAW;gBACpB,UAAU,EAAE,CAAC,MAA6B,EAAqB,EAAE,CAAC,CAAC;oBACjE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,cAAc;iBACtC,CAAC;gBACF,MAAM,EAAE,CAAC,mBAAmB,CAAC;aAC9B;YACD;gBACE,OAAO,EAAE,sBAAa;gBACtB,UAAU,EAAE,CAAC,MAA6B,EAAuB,EAAE,CACjE,MAAM,CAAC,SAAS,IAAI,IAAI;gBAC1B,MAAM,EAAE,CAAC,mBAAmB,CAAC;aAC9B;YACD,gBAAM;YACN,wBAAU;SACX,CAAC;QAEF,OAAO;YACL,MAAM,EAAE,kBAAgB;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI;YAC9B,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE;YAC9B,SAAS;YACT,OAAO,EAAE,CAAC,gBAAM,EAAE,wBAAU,CAAC;SAC9B,CAAC;IACJ,CAAC;CACF,CAAA;AAjDY,4CAAgB;2BAAhB,gBAAgB;IAD5B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,gBAAgB,CAiD5B"}

package/dist/stream-controller.d.ts

@@ -0,0 +1,45 @@
+import { type CanActivate, type Type } from '@nestjs/common';
+/** Options for {@link createNotificationsStreamController}. */
+export interface NotificationsStreamControllerOptions {
+    /**
+     * Resolve the SSE route value from the request — must match what the notifiable returns from
+     * `routeNotificationFor('sse')` (typically the user id). E.g. `(req) => req.user.id`.
+     */
+    resolveRoute: (req: any) => string | Promise<string>;
+    /**
+     * Optional tenant resolver — must match the tenant the notification was sent under, so the stream
+     * key lines up with what the SSE channel published to.
+     */
+    resolveTenant?: (req: any) => string | undefined | Promise<string | undefined>;
+    /** Controller base path. Default `'notifications'`. */
+    path?: string;
+    /** Sub-path for the `@Sse()` endpoint. Default `'stream'` → `GET {path}/stream`. */
+    streamPath?: string;
+    /** Guards to protect the stream with (e.g. your auth guard). Applied via `@UseGuards`. */
+    guards?: Array<Type<CanActivate> | CanActivate>;
+    /**
+     * Keep-alive interval (ms) emitting a `{ type: 'heartbeat' }` event so idle connections survive
+     * proxy/load-balancer timeouts. Default `25000`; set `0` to disable.
+     */
+    heartbeatMs?: number;
+}
+/**
+ * Builds a `@Controller` exposing the Server-Sent Events stream endpoint for in-app notifications —
+ * the consumer-side counterpart the SSE channel publishes to. Mounts a native `@Sse()` route that
+ * subscribes to {@link SseHub} under the same key the channel uses (`sseKey(tenant, routeValue)`),
+ * so apps don't hand-write the streaming endpoint.
+ *
+ * ```ts
+ * const NotificationsStreamController = createNotificationsStreamController({
+ *   resolveRoute: (req) => String(req.user.id),
+ * });
+ *
+ * @Module({ controllers: [NotificationsStreamController] })
+ * export class InboxModule {}
+ * ```
+ *
+ * Requires `SseChannelModule` (which provides {@link SseHub}) in scope. Pair with a cross-pod
+ * `backplane` so a publish on any node reaches connections held by another.
+ */
+export declare function createNotificationsStreamController(options: NotificationsStreamControllerOptions): Type<unknown>;
+//# sourceMappingURL=stream-controller.d.ts.map

package/dist/stream-controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-controller.d.ts","sourceRoot":"","sources":["../src/stream-controller.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,WAAW,EAKhB,KAAK,IAAI,EAEV,MAAM,gBAAgB,CAAC;AAKxB,+DAA+D;AAC/D,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD;;;OAGG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/E,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0FAA0F;IAC1F,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,CAAC;IAChD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,mCAAmC,CACjD,OAAO,EAAE,oCAAoC,GAC5C,IAAI,CAAC,OAAO,CAAC,CA8Bf"}

package/dist/stream-controller.js

@@ -0,0 +1,74 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNotificationsStreamController = createNotificationsStreamController;
+const common_1 = require("@nestjs/common");
+const rxjs_1 = require("rxjs");
+const sse_key_1 = require("./sse-key");
+const sse_hub_1 = require("./sse.hub");
+/**
+ * Builds a `@Controller` exposing the Server-Sent Events stream endpoint for in-app notifications —
+ * the consumer-side counterpart the SSE channel publishes to. Mounts a native `@Sse()` route that
+ * subscribes to {@link SseHub} under the same key the channel uses (`sseKey(tenant, routeValue)`),
+ * so apps don't hand-write the streaming endpoint.
+ *
+ * ```ts
+ * const NotificationsStreamController = createNotificationsStreamController({
+ *   resolveRoute: (req) => String(req.user.id),
+ * });
+ *
+ * @Module({ controllers: [NotificationsStreamController] })
+ * export class InboxModule {}
+ * ```
+ *
+ * Requires `SseChannelModule` (which provides {@link SseHub}) in scope. Pair with a cross-pod
+ * `backplane` so a publish on any node reaches connections held by another.
+ */
+function createNotificationsStreamController(options) {
+    const heartbeatMs = options.heartbeatMs ?? 25_000;
+    let NotificationsStreamController = class NotificationsStreamController {
+        hub;
+        constructor(hub) {
+            this.hub = hub;
+        }
+        stream(req) {
+            const key$ = (0, rxjs_1.from)((async () => {
+                const route = await options.resolveRoute(req);
+                const tenant = options.resolveTenant ? await options.resolveTenant(req) : undefined;
+                return (0, sse_key_1.sseKey)(tenant, route);
+            })());
+            const events$ = key$.pipe((0, rxjs_1.switchMap)((key) => this.hub.stream(key)));
+            if (!heartbeatMs)
+                return events$;
+            const heartbeat$ = (0, rxjs_1.interval)(heartbeatMs).pipe((0, rxjs_1.map)(() => ({ data: '', type: 'heartbeat' })));
+            return (0, rxjs_1.merge)(events$, heartbeat$);
+        }
+    };
+    __decorate([
+        (0, common_1.Sse)(options.streamPath ?? 'stream'),
+        __param(0, (0, common_1.Req)()),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", [Object]),
+        __metadata("design:returntype", Function)
+    ], NotificationsStreamController.prototype, "stream", null);
+    NotificationsStreamController = __decorate([
+        (0, common_1.Controller)(options.path ?? 'notifications'),
+        __metadata("design:paramtypes", [sse_hub_1.SseHub])
+    ], NotificationsStreamController);
+    if (options.guards && options.guards.length > 0) {
+        (0, common_1.UseGuards)(...options.guards)(NotificationsStreamController);
+    }
+    return NotificationsStreamController;
+}
+//# sourceMappingURL=stream-controller.js.map

package/dist/stream-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-controller.js","sourceRoot":"","sources":["../src/stream-controller.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAwDA,kFAgCC;AAxFD,2CAQwB;AACxB,+BAA8E;AAC9E,uCAAmC;AACnC,uCAAmC;AA2BnC;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,mCAAmC,CACjD,OAA6C;IAE7C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,MAAM,CAAC;IAElD,IACM,6BAA6B,GADnC,MACM,6BAA6B;QACJ;QAA7B,YAA6B,GAAW;YAAX,QAAG,GAAH,GAAG,CAAQ;QAAG,CAAC;QAG5C,MAAM,CAAQ,GAAY;YACxB,MAAM,IAAI,GAAG,IAAA,WAAI,EACf,CAAC,KAAK,IAAI,EAAE;gBACV,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC9C,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACpF,OAAO,IAAA,gBAAM,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC/B,CAAC,CAAC,EAAE,CACL,CAAC;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW;gBAAE,OAAO,OAAO,CAAC;YACjC,MAAM,UAAU,GAAG,IAAA,eAAQ,EAAC,WAAW,CAAC,CAAC,IAAI,CAC3C,IAAA,UAAG,EAAC,GAAiB,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAC3D,CAAC;YACF,OAAO,IAAA,YAAK,EAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACpC,CAAC;KACF,CAAA;IAfC;QADC,IAAA,YAAG,EAAC,OAAO,CAAC,UAAU,IAAI,QAAQ,CAAC;QAC5B,WAAA,IAAA,YAAG,GAAE,CAAA;;;;+DAcZ;IAlBG,6BAA6B;QADlC,IAAA,mBAAU,EAAC,OAAO,CAAC,IAAI,IAAI,eAAe,CAAC;yCAER,gBAAM;OADpC,6BAA6B,CAmBlC;IAED,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,IAAA,kBAAS,EAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,6BAA6B,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,6BAA6B,CAAC;AACvC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dudousxd/nestjs-notifications-sse",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Server-Sent Events channel for nestjs-notifications — push real-time notifications over native NestJS SSE",
   "license": "MIT",
   "author": "Davide Carvalho",