@palmetto/nestjs-pubsub 1.0.0

package/README.md

@@ -0,0 +1,99 @@
+# @palmetto/nestjs-pubsub
+
+Provides a NestJS module to provide a PubSub Publisher and automatically discover and manage PubSub subscribers.
+
+## Installation
+
+```sh
+yarn add @palmetto/pubsub @palmetto/nestjs-pubsub zod
+```
+
+Next, add in the PubSub transports you want to use:
+
+RabbitMQ:
+
+```sh
+yarn add amqp-connection-manager amqplib
+```
+
+BullMQ:
+
+```sh
+yarn add bullmq
+```
+
+## Usage
+
+### Add to your `AppModule` imports
+
+```ts
+// MyModel* objects define the model you are publishing or subscribing using RabbitMq
+const MyModelSchema = IdMetaSchema.extend({
+  message: z4.string(),
+  value: z4.int(),
+});
+type MyModel = z4.infer<typeof MyModelSchema>;
+const MyModelConfig: RabbitQueueExchangeConfiguration = {
+  name: "my-model",
+  schema: MyModelSchema,
+  transport: RABBITMQ_TRANSPORT,
+  type: "direct",
+};
+
+// MyOtherModel* objects define another model you are publishing or subscribing, this time using BullMq
+const MyOtherModelSchema = IdMetaSchema.extend({
+  message: z4.string(),
+  values: z4.int().array(),
+});
+type MyOtherModel = z4.infer<typeof MyOtherModelSchema>;
+const MyOtherModelConfig: RabbitQueueExchangeConfiguration = {
+  name: "my-other-model",
+  schema: MyOtherModelSchema,
+  transport: BULLMQ_TRANSPORT,
+};
+
+// MyModelHandler demonstrates a subscriber to the MyModel event over RabbitMq
+@Injectable()
+class MyModelHandler {
+  constructor(private readonly publisher: Publisher) {}
+
+  @EventSubscriber(MyModelConfig)
+  async handler(message: MyModel) {
+    // here, we're publishing a new message to bullmq based on the message we received
+    const newMessage: MyOtherModel = {
+      message: message.message,
+      values: [message.value, message.value + 1, message.value + 2],
+    };
+
+    await publisher.publish(MyOtherModelConfig, newMessage);
+  }
+}
+@Module({
+  imports: [
+    AppConfigModule,
+    PubSubModule,
+    PubSubRabbitMqModule.registerAsync({
+      imports: [AppConfigModule],
+      inject: [AppConfig],
+      useFactory(appConfig: AppConfig) {
+        return {
+          host: appConfig.get("rabbit.url"),
+        };
+      },
+    }),
+    PubSubBullMqModule.registerAsync({
+      imports: [AppConfigModule],
+      inject: [AppConfig],
+      useFactory(appConfig: AppConfig) {
+        return {
+          host: appConfig.get("redis.host"),
+          username: appConfig.get("bullmq.username"),
+          password: appConfig.get("bullmq.password"),
+        };
+      },
+    }),
+  ],
+  providers: [MyModelHandler],
+})
+export class AppModule {}
+```

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export * from "./pubsub-module.js";
+export * from "./pubsub-bullmq-module.js";
+export * from "./pubsub-rabbitmq-module.js";
+export { EventSubcriber } from "./subscriber.js";

package/dist/main.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSubcriber = void 0;
+__exportStar(require("./pubsub-module.js"), exports);
+__exportStar(require("./pubsub-bullmq-module.js"), exports);
+__exportStar(require("./pubsub-rabbitmq-module.js"), exports);
+var subscriber_js_1 = require("./subscriber.js");
+Object.defineProperty(exports, "EventSubcriber", { enumerable: true, get: function () { return subscriber_js_1.EventSubcriber; } });

package/dist/pubsub-bullmq-module.d.ts

@@ -0,0 +1,8 @@
+import { ConnectionOptions } from "@palmetto/pubsub";
+declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<ConnectionOptions, "register", "create", {}>;
+/**
+ * Module requires @palmetto/pubsub
+ */
+export declare class PubSubBullMqModule extends ConfigurableModuleClass {
+}
+export {};

package/dist/pubsub-bullmq-module.js

@@ -0,0 +1,52 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubBullMqModule = void 0;
+const common_1 = require("@nestjs/common");
+const pubsub_1 = require("@palmetto/pubsub");
+const pubsub_provider_module_1 = require("./pubsub-provider-module");
+const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } = new common_1.ConfigurableModuleBuilder().build();
+let BullMqShutdown = class BullMqShutdown {
+    constructor(provider) {
+        this.provider = provider;
+    }
+    onApplicationShutdown() {
+        return this.provider.close();
+    }
+};
+BullMqShutdown = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [pubsub_1.BullMqPubSubProvider])
+], BullMqShutdown);
+/**
+ * Module requires @palmetto/pubsub
+ */
+let PubSubBullMqModule = class PubSubBullMqModule extends ConfigurableModuleClass {
+};
+exports.PubSubBullMqModule = PubSubBullMqModule;
+exports.PubSubBullMqModule = PubSubBullMqModule = __decorate([
+    (0, common_1.Module)({
+        imports: [pubsub_provider_module_1.PubSubProviderFactoryModule],
+        providers: [
+            {
+                provide: pubsub_1.BullMqPubSubProvider,
+                useFactory: (providers, config) => {
+                    const provider = new pubsub_1.BullMqPubSubProvider(config, new common_1.Logger(pubsub_1.BullMqPubSubProvider.name));
+                    providers.addProvider(provider);
+                    return provider;
+                },
+                inject: [pubsub_provider_module_1.PubSubProviderFactory, MODULE_OPTIONS_TOKEN],
+            },
+            BullMqShutdown,
+        ],
+        exports: [pubsub_1.BullMqPubSubProvider],
+    })
+], PubSubBullMqModule);

package/dist/pubsub-module.d.ts

@@ -0,0 +1,2 @@
+export declare class PubSubModule {
+}

package/dist/pubsub-module.js

@@ -0,0 +1,112 @@
+"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubModule = void 0;
+const pubsub_1 = require("@palmetto/pubsub");
+const common_1 = require("@nestjs/common");
+const nestjs_discovery_1 = require("@golevelup/nestjs-discovery");
+const subscriber_1 = require("./subscriber");
+const pubsub_provider_module_1 = require("./pubsub-provider-module");
+function isPublisherProvider(obj) {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return (obj === null || obj === void 0 ? void 0 : obj.publish) !== undefined;
+}
+function isSubscriberProvider(obj) {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    return (obj === null || obj === void 0 ? void 0 : obj.startSubscribe) !== undefined;
+}
+let PubSubManager = class PubSubManager {
+    constructor(discover, publisher, subscriber, pubSubFactory) {
+        this.discover = discover;
+        this.publisher = publisher;
+        this.subscriber = subscriber;
+        this.pubSubFactory = pubSubFactory;
+        this.logger = new common_1.Logger(PubSubModule.name);
+        this.bootstrapped = false;
+    }
+    beforeApplicationShutdown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logger.debug(`${PubSubModule.name} Stopping subscribers`);
+            yield this.subscriber.unsubscribe();
+            this.logger.debug(`${PubSubModule.name} Closing subscriber`);
+            yield this.subscriber.close();
+            this.logger.debug(`${PubSubModule.name} Closing publisher`);
+            yield this.publisher.close();
+            this.bootstrapped = false;
+            this.logger.debug(`${PubSubModule.name} shutdown`);
+        });
+    }
+    onApplicationBootstrap() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.bootstrapped) {
+                return;
+            }
+            this.bootstrapped = true;
+            {
+                for (const provider of this.pubSubFactory.providers) {
+                    if (isPublisherProvider(provider)) {
+                        this.publisher.addProvider(provider);
+                    }
+                    if (isSubscriberProvider(provider)) {
+                        this.subscriber.addProvider(provider);
+                    }
+                }
+            }
+            const handlers = (yield this.discover.providerMethodsWithMetaAtKey(subscriber_1.EVENT_HANDLER)).concat(yield this.discover.controllerMethodsWithMetaAtKey(subscriber_1.EVENT_HANDLER));
+            for (const handler of handlers) {
+                const method = handler.discoveredMethod;
+                yield this.subscriber.subscribe(handler.meta, (msg) => method.handler.call(method.parentClass.instance, msg));
+                this.logger.log(`Added subscriber method ${method.parentClass.name}.${method.methodName} for ${handler.meta.transport}:${handler.meta.name}`);
+            }
+        });
+    }
+};
+PubSubManager = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [nestjs_discovery_1.DiscoveryService,
+        pubsub_1.Publisher,
+        pubsub_1.Subscriber,
+        pubsub_provider_module_1.PubSubProviderFactory])
+], PubSubManager);
+let PubSubModule = class PubSubModule {
+};
+exports.PubSubModule = PubSubModule;
+exports.PubSubModule = PubSubModule = __decorate([
+    (0, common_1.Module)({
+        imports: [nestjs_discovery_1.DiscoveryModule, pubsub_provider_module_1.PubSubProviderFactoryModule],
+        providers: [
+            {
+                provide: pubsub_1.Publisher,
+                useFactory: () => {
+                    return new pubsub_1.Publisher(new common_1.Logger(pubsub_1.Publisher.name));
+                },
+            },
+            {
+                provide: pubsub_1.Subscriber,
+                useFactory: () => {
+                    return new pubsub_1.Subscriber(new common_1.Logger(pubsub_1.Subscriber.name));
+                },
+            },
+            PubSubManager,
+        ],
+        exports: [pubsub_1.Publisher, pubsub_1.Subscriber],
+    })
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+], PubSubModule);

package/dist/pubsub-provider-module.d.ts

@@ -0,0 +1,7 @@
+import { PubOrSubProvider } from "@palmetto/pubsub";
+export declare class PubSubProviderFactory {
+    readonly providers: PubOrSubProvider[];
+    addProvider(provider: PubOrSubProvider): void;
+}
+export declare class PubSubProviderFactoryModule {
+}

package/dist/pubsub-provider-module.js

@@ -0,0 +1,32 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubProviderFactoryModule = exports.PubSubProviderFactory = void 0;
+const common_1 = require("@nestjs/common");
+let PubSubProviderFactory = class PubSubProviderFactory {
+    constructor() {
+        this.providers = [];
+    }
+    addProvider(provider) {
+        this.providers.push(provider);
+    }
+};
+exports.PubSubProviderFactory = PubSubProviderFactory;
+exports.PubSubProviderFactory = PubSubProviderFactory = __decorate([
+    (0, common_1.Injectable)()
+], PubSubProviderFactory);
+let PubSubProviderFactoryModule = class PubSubProviderFactoryModule {
+};
+exports.PubSubProviderFactoryModule = PubSubProviderFactoryModule;
+exports.PubSubProviderFactoryModule = PubSubProviderFactoryModule = __decorate([
+    (0, common_1.Module)({
+        providers: [PubSubProviderFactory],
+        exports: [PubSubProviderFactory],
+    })
+    // eslint-disable-next-line @typescript-eslint/no-extraneous-class
+], PubSubProviderFactoryModule);

package/dist/pubsub-rabbitmq-module.d.ts

@@ -0,0 +1,8 @@
+import { RabbitMqConnectionConfig } from "@palmetto/pubsub";
+declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<RabbitMqConnectionConfig, "register", "create", {}>;
+/**
+ * This module requires @palmetto/pubsub
+ */
+export declare class PubSubRabbitMqModule extends ConfigurableModuleClass {
+}
+export {};

package/dist/pubsub-rabbitmq-module.js

@@ -0,0 +1,57 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PubSubRabbitMqModule = void 0;
+const common_1 = require("@nestjs/common");
+const pubsub_1 = require("@palmetto/pubsub");
+const pubsub_provider_module_1 = require("./pubsub-provider-module");
+const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } = new common_1.ConfigurableModuleBuilder().build();
+let RabbitMqConnectionShutdown = class RabbitMqConnectionShutdown {
+    constructor(connection) {
+        this.connection = connection;
+    }
+    onApplicationShutdown() {
+        return this.connection.close();
+    }
+};
+RabbitMqConnectionShutdown = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [pubsub_1.RabbitMqConnection])
+], RabbitMqConnectionShutdown);
+/**
+ * This module requires @palmetto/pubsub
+ */
+let PubSubRabbitMqModule = class PubSubRabbitMqModule extends ConfigurableModuleClass {
+};
+exports.PubSubRabbitMqModule = PubSubRabbitMqModule;
+exports.PubSubRabbitMqModule = PubSubRabbitMqModule = __decorate([
+    (0, common_1.Module)({
+        imports: [pubsub_provider_module_1.PubSubProviderFactoryModule],
+        providers: [
+            {
+                provide: pubsub_1.RabbitMqConnection,
+                useFactory: (config) => pubsub_1.RabbitMqConnection.create(config, new common_1.Logger(pubsub_1.RabbitMqConnection.name)),
+                inject: [MODULE_OPTIONS_TOKEN],
+            },
+            {
+                provide: pubsub_1.RabbitMqPubSubProvider,
+                useFactory: (providers, connection) => {
+                    const provider = new pubsub_1.RabbitMqPubSubProvider(connection, new common_1.Logger(pubsub_1.RabbitMqPubSubProvider.name));
+                    providers.addProvider(provider);
+                    return provider;
+                },
+                inject: [pubsub_provider_module_1.PubSubProviderFactory, pubsub_1.RabbitMqConnection],
+            },
+            RabbitMqConnectionShutdown,
+        ],
+        exports: [pubsub_1.RabbitMqConnection, pubsub_1.RabbitMqPubSubProvider],
+    })
+], PubSubRabbitMqModule);

package/dist/subscriber.d.ts

@@ -0,0 +1,3 @@
+import { PubSubConfiguration } from "@palmetto/pubsub";
+export declare const EVENT_HANDLER: unique symbol;
+export declare const EventSubcriber: (config: PubSubConfiguration) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/dist/subscriber.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSubcriber = exports.EVENT_HANDLER = void 0;
+const common_1 = require("@nestjs/common");
+exports.EVENT_HANDLER = Symbol("EVENT_HANDLER");
+const makePubSubDecorator = () => (config) => (0, common_1.applyDecorators)((0, common_1.SetMetadata)(exports.EVENT_HANDLER, Object.assign({}, config)));
+exports.EventSubcriber = makePubSubDecorator();

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@palmetto/nestjs-pubsub",
+  "version": "1.0.0",
+  "main": "./dist/main.js",
+  "scripts": {
+    "lint": "yarn run -T eslint --fix ./src",
+    "format": "yarn run -T prettier --write --loglevel warn .",
+    "tc": "tsc --noEmit",
+    "build": "yarn clean && tsc -p tsconfig.build.json",
+    "clean": "rm -rf ./dist/",
+    "ci:build": "tsc -p tsconfig.build.json",
+    "ci:lint": "yarn run -T eslint . && yarn run -T prettier --check --loglevel warn .",
+    "ci:tc": "yarn tc",
+    "hook:lint": "eslint --cache --fix",
+    "hook:format": "prettier --write --loglevel warn",
+    "hook:tc": "yarn tc",
+    "prepublishOnly": "yarn build",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.1.3",
+    "@nestjs/core": "^11.1.3",
+    "@nestjs/testing": "^11.1.5",
+    "@swc/core": "^1.13.3",
+    "@types/node": "^24.2.1",
+    "@vitest/coverage-v8": "^3.2.4",
+    "typescript": "5.7.3",
+    "unplugin-swc": "^1.5.6",
+    "vitest": "^3.2.4",
+    "zod": "^4.0.5"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@golevelup/nestjs-discovery": "^5.0.0",
+    "@palmetto/nestjs-errors": "^2.1.1",
+    "@palmetto/pubsub": "^1.0.0",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
+    "@nestjs/core": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
+    "zod": "^3.25.0 || ^4.0.0"
+  }
+}