@palmetto/pubsub 3.5.0 → 3.5.1

package/dist/rabbitmq/config.d.ts

@@ -27,7 +27,14 @@ export interface RabbitQueueExchangeConfigurationBase extends PubSubConfiguratio
      */
     transport: typeof RABBITMQ_TRANSPORT;
     /**
-     * The queue name prefix
+     * The queue name prefix. This name is used to genrate the actual exchange and queu names based on the exchange type and queue type.
+     * For topic exchanges, the topicSubscriberName is also used to generate the exchange and queue names.
+     * The final exchange and queue names will be in the format of `${name}.${topicSubscriberName}.${extension}` for topic exchanges and `${name}.${extension}` for direct exchanges, where the extension is determined by the queue type (e.g. .dlx/.dlq for dead-letter queues, .rtx/.rtq for retry queues, and no extension for default queues).
+     * The name must be unique across your publishers and subscribers to avoid naming collisions.
+     *
+     * Names should be in the format of `<service>.<model pluralized>`, for example `dispatch.suppliers` or `solarflare.events`. This helps to ensure uniqueness and also provides clarity on the source and content of the queue and exchange.
+     *
+     * Overrides can be made using {@link overrides} to specify exact exchange and queue names if the generated names do not fit your needs, or you are using legacy exchanges or queues.
      */
     name: string;
     /**
@@ -35,7 +42,7 @@ export interface RabbitQueueExchangeConfigurationBase extends PubSubConfiguratio
      */
     temporary?: boolean;
     /**
-     * The queue prefetch amount for subscribers. Defaults to 5 if not set.
+     * The queue prefetch amount for subscribers. This limits concurrency when processing messages. Defaults to 5 if not set.
      */
     prefetch?: number;
     /**
@@ -59,7 +66,7 @@ export interface RabbitQueueExchangeConfigurationBase extends PubSubConfiguratio
 }
 export interface RabbitQueueExchangeConfigurationTopicExchange extends RabbitQueueExchangeConfigurationBase {
     /**
-     * For topic exchanges, the name of the subscriber is used here
+     * For topic exchanges, the name of the subscriber is used here.
      */
     topicSubscriberName: string;
     /**
@@ -73,6 +80,14 @@ export interface RabbitQueueExchangeConfigurationDirectExchange extends RabbitQu
      */
     exchangeType: "direct";
 }
+/**
+ * The configuration for a RabbitMQ queue and exchange.
+ * This is used to configure the publisher and subscriber providers for RabbitMQ.
+ * Depending on the exchangeType, different properties are required.
+ * For topic exchanges, a topicSubscriberName is required to differentiate the queues for different subscribers.
+ *
+ * For full details see {@link https://github.com/palmetto/galaxy/blob/main/packages/pubsub/src/rabbitmq/README.md#queue-and-exchange-configuration}
+ */
 export type RabbitQueueExchangeConfiguration = RabbitQueueExchangeConfigurationDirectExchange | RabbitQueueExchangeConfigurationTopicExchange;
 export declare function isRabbitQueueExchangeConfiguration(config: PubSubConfiguration): config is RabbitQueueExchangeConfiguration;
 export interface RabbitQueueExchangeNames {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palmetto/pubsub",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/palmetto/galaxy"
@@ -10,8 +10,8 @@
     "lint": "yarn run -T eslint --fix ./src",
     "format": "yarn run -T prettier --write --loglevel warn .",
     "tc": "tsc --noEmit",
-    "test": "yarn test-runner 'vitest run'",
-    "test:watch": "yarn test-runner 'vitest watch'",
+    "test": "yarn test-runner \"vitest run $@\"",
+    "test:watch": "yarn test-runner \"vitest watch $@\"",
     "build": "yarn clean && yarn ci:build",
     "clean": "rm -rf ./dist/",
     "ci:build": "tsc -p tsconfig.build.json",