@palmetto/pubsub 3.0.0 → 3.0.2

package/dist/bullmq/publisher.d.ts

@@ -1,5 +1,5 @@
 import type * as bullmq from "bullmq";
-import { Logger, PublisherProvider } from "../interfaces.js";
+import { Logger, PublisherProvider, PublishMessageOptions } from "../interfaces.js";
 import { BullMqQueueConfiguration } from "./config.js";
 export declare class BullMqPublisher implements PublisherProvider {
     private readonly connection;
@@ -8,7 +8,7 @@ export declare class BullMqPublisher implements PublisherProvider {
     constructor(connection: bullmq.ConnectionOptions, logger: Logger);
     readonly transport: string;
     private getQueue;
-    publish(config: BullMqQueueConfiguration, messages: string[]): Promise<void>;
+    publish(config: BullMqQueueConfiguration, messages: string[], options?: PublishMessageOptions): Promise<void>;
     init(config: BullMqQueueConfiguration): Promise<void>;
     close(): Promise<void>;
     enrichPublishedMesssageLog(config: BullMqQueueConfiguration): Record<string, unknown>;

package/dist/bullmq/publisher.js

@@ -36,7 +36,7 @@ class BullMqPublisher {
             return queue;
         });
     }
-    publish(config, messages) {
+    publish(config, messages, options) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const queue = yield this.getQueue(config);
@@ -44,6 +44,9 @@ class BullMqPublisher {
             const job = {
                 name: config.job || connection_js_1.BULLMQ_DEFAULTJOB,
                 opts: {
+                    delay: (options === null || options === void 0 ? void 0 : options.scheduledAt)
+                        ? Math.max(0, options.scheduledAt.getTime() - Date.now())
+                        : undefined,
                     attempts: config.retries,
                     backoff: {
                         type: "fixed",

package/dist/bullmq/pubsub.d.ts

@@ -1,4 +1,4 @@
-import { Logger, MessageContext, MessageResult, PubSubProvider, StopSubscribe } from "../interfaces.js";
+import { Logger, MessageContext, MessageResult, PublishMessageOptions, PubSubProvider, StopSubscribe } from "../interfaces.js";
 import { BullMqQueueConfiguration } from "./config.js";
 import type { ConnectionOptions } from "bullmq";
 export declare class BullMqPubSubProvider implements PubSubProvider {
@@ -6,7 +6,7 @@ export declare class BullMqPubSubProvider implements PubSubProvider {
     private readonly subscriber;
     constructor(connection: ConnectionOptions, logger: Logger);
     readonly transport: string;
-    publish(config: BullMqQueueConfiguration, messages: string[]): Promise<void>;
+    publish(config: BullMqQueueConfiguration, messages: string[], options?: PublishMessageOptions): Promise<void>;
     startSubscribe(config: BullMqQueueConfiguration, onMessage: (s: string, context: MessageContext) => Promise<MessageResult> | MessageResult): Promise<StopSubscribe>;
     close(): Promise<void>;
     init(config: BullMqQueueConfiguration): Promise<void>;

package/dist/bullmq/pubsub.js

@@ -19,8 +19,8 @@ class BullMqPubSubProvider {
         this.publisher = new publisher_js_1.BullMqPublisher(connection, logger);
         this.subscriber = new subscriber_js_1.BullMqSubscriber(connection, logger);
     }
-    publish(config, messages) {
-        return this.publisher.publish(config, messages);
+    publish(config, messages, options) {
+        return this.publisher.publish(config, messages, options);
     }
     startSubscribe(config, onMessage) {
         return this.subscriber.startSubscribe(config, onMessage);

package/dist/interfaces.d.ts

@@ -17,13 +17,20 @@ export type Meta = z.infer<typeof MetaSchema>;
  * All messages should be based on this schema
  */
 export type BaseMessage = z.infer<typeof IdMetaSchema>;
+export interface PublishMessageOptions {
+    /**
+     * The date and time at which the message should be published. Only supported by BullMq at this time.
+     * If the date is in the past, the message will be sent immediately.
+     */
+    scheduledAt?: Date;
+}
 /**
  * All pubsub publishers must implement this interface
  */
 export interface PublisherProvider {
     transport: string;
     init(config: PubSubConfiguration): Promise<void> | void;
-    publish(config: PubSubConfiguration, messages: string[]): Promise<void> | void;
+    publish(config: PubSubConfiguration, messages: string[], options?: PublishMessageOptions): Promise<void> | void;
     close(): Promise<void> | void;
     enrichPublishedMesssageLog(config: PubSubConfiguration): Record<string, unknown>;
 }

package/dist/publisher.d.ts

@@ -1,4 +1,4 @@
-import { BaseMessage, Logger, PublisherProvider, PubSubConfiguration } from "./interfaces.js";
+import { BaseMessage, Logger, PublisherProvider, PublishMessageOptions, PubSubConfiguration } from "./interfaces.js";
 export declare class Publisher {
     private readonly logger;
     private readonly hashes;
@@ -7,7 +7,7 @@ export declare class Publisher {
     addProvider(provider: PublisherProvider): void;
     removeProvider(providerOrTransport: PublisherProvider | string): boolean;
     init(config: PubSubConfiguration): Promise<void>;
-    publish(config: PubSubConfiguration, message: BaseMessage | BaseMessage[]): Promise<void>;
+    publish(config: PubSubConfiguration, message: BaseMessage | BaseMessage[], options?: PublishMessageOptions): Promise<void>;
     private publishImpl;
     close(): Promise<void>;
     private getProvider;

package/dist/publisher.js

@@ -52,7 +52,7 @@ class Publisher {
             this.assertSchema(config);
         });
     }
-    publish(config, message) {
+    publish(config, message, options) {
         const messages = Array.isArray(message) ? message : [message];
         if (messages.length === 0) {
             return Promise.resolve();
@@ -60,10 +60,10 @@ class Publisher {
         return (0, trace_1.getTracer)().trace("pubsub.publish", {
             resource: `publish ${config.transport} ${config.name}`,
         }, (span) => {
-            return this.publishImpl(config, messages, span);
+            return this.publishImpl(config, messages, options, span);
         });
     }
-    publishImpl(config, messages, span) {
+    publishImpl(config, messages, options, span) {
         return __awaiter(this, void 0, void 0, function* () {
             const provider = this.getProvider(config);
             const { schema, schemaId } = this.assertSchema(config);
@@ -102,7 +102,7 @@ class Publisher {
             }
             const jsons = mappedMessages.filter((j) => j.data).map((j) => j.json);
             const start = (0, message_logger_js_1.startTiming)();
-            yield provider.publish(config, jsons);
+            yield provider.publish(config, jsons, options);
             const duration = (0, message_logger_js_1.getDuration)(start);
             mappedMessages.forEach((msg) => {
                 (0, message_logger_js_1.logMessage)({

package/dist/rabbitmq/publisher.d.ts

@@ -1,4 +1,4 @@
-import { Logger, PublisherProvider } from "../interfaces.js";
+import { Logger, PublisherProvider, PublishMessageOptions } from "../interfaces.js";
 import { RabbitMqConnection } from "./connection.js";
 import { RabbitQueueExchangeConfiguration } from "./config.js";
 export declare class RabbitMqPublisher implements PublisherProvider {
@@ -24,7 +24,7 @@ export declare class RabbitMqPublisher implements PublisherProvider {
      * @param message The JSON message to send
      * @returns A promise that is completed when the message is published
      */
-    publish(config: RabbitQueueExchangeConfiguration, messages: string[]): Promise<void>;
+    publish(config: RabbitQueueExchangeConfiguration, messages: string[], options?: PublishMessageOptions): Promise<void>;
     enrichPublishedMesssageLog(config: RabbitQueueExchangeConfiguration): Record<string, unknown>;
     private publishToExchange;
     private publishToQueue;

package/dist/rabbitmq/publisher.js

@@ -78,8 +78,11 @@ class RabbitMqPublisher {
      * @param message The JSON message to send
      * @returns A promise that is completed when the message is published
      */
-    publish(config, messages) {
+    publish(config, messages, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (options === null || options === void 0 ? void 0 : options.scheduledAt) {
+                throw new errors_js_1.PublishError("Scheduled publishing is not supported for RabbitMQ", messages);
+            }
             const channel = yield this.getChannel(config);
             if (config.publishToSpecificQueue) {
                 yield this.publishToQueue(channel, config.publishToSpecificQueue, messages);

package/dist/rabbitmq/pubsub.d.ts

@@ -1,4 +1,4 @@
-import { Logger, MessageContext, MessageResult, PubSubProvider, StopSubscribe } from "../interfaces.js";
+import { Logger, MessageContext, MessageResult, PublishMessageOptions, PubSubProvider, StopSubscribe } from "../interfaces.js";
 import { RabbitQueueExchangeConfiguration } from "./config.js";
 import { RabbitMqConnection } from "./connection.js";
 /**
@@ -9,7 +9,7 @@ export declare class RabbitMqPubSubProvider implements PubSubProvider {
     private readonly subscriber;
     constructor(connection: RabbitMqConnection, logger: Logger);
     readonly transport: string;
-    publish(config: RabbitQueueExchangeConfiguration, messages: string[]): Promise<void>;
+    publish(config: RabbitQueueExchangeConfiguration, messages: string[], options?: PublishMessageOptions): Promise<void>;
     startSubscribe(config: RabbitQueueExchangeConfiguration, onMessage: (s: string, context: MessageContext) => Promise<MessageResult> | MessageResult): StopSubscribe;
     close(): Promise<void>;
     init(config: RabbitQueueExchangeConfiguration): Promise<void>;

package/dist/rabbitmq/pubsub.js

@@ -22,8 +22,8 @@ class RabbitMqPubSubProvider {
         this.publisher = new publisher_js_1.RabbitMqPublisher(connection, logger);
         this.subscriber = new subscriber_js_1.RabbitMqSubscriber(connection, logger);
     }
-    publish(config, messages) {
-        return this.publisher.publish(config, messages);
+    publish(config, messages, options) {
+        return this.publisher.publish(config, messages, options);
     }
     startSubscribe(config, onMessage) {
         return this.subscriber.startSubscribe(config, onMessage);

package/dist/rabbitmq/subscriber.js

@@ -136,7 +136,7 @@ class RabbitMqSubscriber {
                             message: "Unexpected error handling RabbitMq message",
                             error: (0, create_log_error_payload_js_1.createLogErrorPayload)(err),
                         });
-                        span.setTag("error", err);
+                        span === null || span === void 0 ? void 0 : span.setTag("error", err);
                         try {
                             channel.nack(msg, undefined, true);
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "main": "./dist/main.js",
   "scripts": {
     "lint": "yarn run -T eslint --fix ./src",
@@ -20,7 +20,7 @@
     "test:watch": "yarn run test-runner vitest watch"
   },
   "devDependencies": {
-    "@palmetto/trace": "^0.0.1",
+    "@palmetto/trace": "^0.1.0",
     "@types/amqplib": "^0",
     "@types/node": "^24.2.1",
     "amqp-connection-manager": "^4.1.14",
@@ -45,7 +45,7 @@
     "uuid": "^11.1.0"
   },
   "peerDependencies": {
-    "@palmetto/trace": "^0.0.1",
+    "@palmetto/trace": "^0.1.0",
     "amqp-connection-manager": "^4.1.14",
     "amqplib": "^0.10.8",
     "bullmq": "^5.58.0",

package/src/bullmq/README.md

@@ -52,6 +52,15 @@ yarn add @palmetto/pubsub bullmq zod
    await publisher.publish(config, message);
    ```
 
+   Scheduled messages are supported:
+
+   ```ts
+   const message: MyModel = {... };
+
+   // send the message in 5 minutes
+   await publisher.publish(config, message, { scheduledAt: new Date(Date.now() + 5 * 60 * 1000) });
+   ```
+
 6. Subscribe to a queue
 
    ```ts

package/src/rabbitmq/README.md

@@ -171,6 +171,8 @@ const config: RabbitQueueExchangeConfiguration = {
 
 This configuration would create a main queue called `my.queue.my-api-name`
 
+Note: `topicSubscriberName` is a required property on the type, but it is not used for publishing to the exchange. The property is only used for subscribers.
+
 ### Custom names
 
 You can override all the queue, exchange names and routing keys for each `queueType`