@nestjstools/messaging-google-pubsub-extension 1.0.1 → 1.2.0

package/README.md

@@ -109,6 +109,28 @@ export class CreateUserHandler implements IMessageHandler<CreateUser>{
 * Easily configure projectId, topicName, and subscriptionName for full control over Pub/Sub setup.
 ---
 
+## 📨 Communicating Beyond a NestJS Application (Cross-Language Messaging)
+
+### To enable communication with a Handler from services written in other languages, follow these steps:
+
+1. **Publish a Message to the Topic**
+
+2. **Include the Routing Key Header**
+   Your message **must** include a header attribute named `messaging-routing-key`.
+   The value should correspond to the routing key defined in your NestJS message handler:
+
+   ```ts
+   @MessageHandler('my_app_command.create_user') // <-- Use this value as the routing key
+   ```
+
+---
+## 🔧 Send additional attributes into your message
+
+   ```ts
+    this.pubSubMessageBus.dispatch(new RoutingMessage(new CreateUser('id'), 'my_app_command.create_user', new GooglePubSubMessageOptions({YourAttribute: 'value'})));
+   ```
+---
+
 ## Configuration options
 
 ### GooglePubSubChannel

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export * from './messaging-google-pub-sub-extension.module';
 export * from './channel/google-pub-sub.channel-config';
 export * from './message-bus/google-pub-sub-message.bus';
+export * from './message/google-pub-sub-message-options';

package/lib/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./messaging-google-pub-sub-extension.module"), exports);
 __exportStar(require("./channel/google-pub-sub.channel-config"), exports);
 __exportStar(require("./message-bus/google-pub-sub-message.bus"), exports);
+__exportStar(require("./message/google-pub-sub-message-options"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8EAA2D;AAC3D,0EAAuD;AACvD,2EAAwD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8EAA2D;AAC3D,0EAAuD;AACvD,2EAAwD;AACxD,2EAAwD"}

package/lib/message/google-pub-sub-message-options.d.ts

@@ -0,0 +1,11 @@
+import { MessageOptions } from '@nestjstools/messaging';
+export declare class GooglePubSubMessageOptions implements MessageOptions {
+    readonly attributes: {
+        [key: string]: string;
+    };
+    readonly middlewares: any[];
+    readonly avoidErrorsWhenNotExistedHandler: boolean;
+    constructor(attributes?: {
+        [key: string]: string;
+    });
+}

package/lib/message/google-pub-sub-message-options.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GooglePubSubMessageOptions = void 0;
+class GooglePubSubMessageOptions {
+    attributes;
+    middlewares = [];
+    avoidErrorsWhenNotExistedHandler = false;
+    constructor(attributes = {}) {
+        this.attributes = attributes;
+    }
+}
+exports.GooglePubSubMessageOptions = GooglePubSubMessageOptions;
+//# sourceMappingURL=google-pub-sub-message-options.js.map

package/lib/message/google-pub-sub-message-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"google-pub-sub-message-options.js","sourceRoot":"","sources":["../../src/message/google-pub-sub-message-options.ts"],"names":[],"mappings":";;;AAEA,MAAa,0BAA0B;IAKnB;IAJF,WAAW,GAAU,EAAE,CAAC;IACxB,gCAAgC,GAAY,KAAK,CAAC;IAElE,YACkB,aAAwC,EAAE;QAA1C,eAAU,GAAV,UAAU,CAAgC;IAE5D,CAAC;CACF;AARD,gEAQC"}

package/lib/message-bus/google-pub-sub-message.bus.js

@@ -14,15 +14,26 @@ const common_1 = require("@nestjs/common");
 const google_pub_sub_channel_1 = require("../channel/google-pub-sub.channel");
 const buffer_1 = require("buffer");
 const const_1 = require("../const");
+const google_pub_sub_message_options_1 = require("../message/google-pub-sub-message-options");
 let GooglePubSubMessageBus = class GooglePubSubMessageBus {
     channel;
     constructor(channel) {
         this.channel = channel;
     }
     async dispatch(message) {
+        const messageOptions = message.messageOptions;
+        if (messageOptions !== undefined && !(messageOptions instanceof google_pub_sub_message_options_1.GooglePubSubMessageOptions)) {
+            throw new Error(`Message options must be a ${google_pub_sub_message_options_1.GooglePubSubMessageOptions.name} object`);
+        }
         const topic = this.channel.pubSubManager.topic(this.channel.config.topicName);
         const serializedMessage = JSON.stringify(message.message);
-        await topic.publishMessage({ data: buffer_1.Buffer.from(serializedMessage), attributes: { [const_1.ROUTING_KEY_ATTRIBUTE_NAME]: message.messageRoutingKey } });
+        const data = buffer_1.Buffer.from(serializedMessage);
+        if (messageOptions instanceof google_pub_sub_message_options_1.GooglePubSubMessageOptions) {
+            const attributes = { [const_1.ROUTING_KEY_ATTRIBUTE_NAME]: message.messageRoutingKey, ...messageOptions.attributes };
+            await topic.publishMessage({ data, attributes });
+            return;
+        }
+        await topic.publishMessage({ data, attributes: { [const_1.ROUTING_KEY_ATTRIBUTE_NAME]: message.messageRoutingKey } });
     }
 };
 exports.GooglePubSubMessageBus = GooglePubSubMessageBus;

package/lib/message-bus/google-pub-sub-message.bus.js.map

@@ -1 +1 @@
-{"version":3,"file":"google-pub-sub-message.bus.js","sourceRoot":"","sources":["../../src/message-bus/google-pub-sub-message.bus.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,2CAA4C;AAC5C,8EAAwE;AACxE,mCAAgC;AAChC,oCAAsD;AAG/C,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAEd;IADnB,YACmB,OAA4B;QAA5B,YAAO,GAAP,OAAO,CAAqB;IAE/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAuB;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9E,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,KAAK,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,eAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,UAAU,EAAE,EAAC,CAAC,kCAA0B,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAC,EAAE,CAAC,CAAC;IAC9I,CAAC;CACF,CAAA;AAXY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,mBAAU,GAAE;qCAGiB,4CAAmB;GAFpC,sBAAsB,CAWlC"}
+{"version":3,"file":"google-pub-sub-message.bus.js","sourceRoot":"","sources":["../../src/message-bus/google-pub-sub-message.bus.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,2CAA4C;AAC5C,8EAAwE;AACxE,mCAAgC;AAChC,oCAAsD;AACtD,8FAAuF;AAGhF,IAAM,sBAAsB,GAA5B,MAAM,sBAAsB;IAEd;IADnB,YACmB,OAA4B;QAA5B,YAAO,GAAP,OAAO,CAAqB;IAE/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,OAAuB;QACpC,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAE9C,IAAI,cAAc,KAAK,SAAS,IAAI,CAAC,CAAC,cAAc,YAAY,2DAA0B,CAAC,EAAE,CAAC;YAC5F,MAAM,IAAI,KAAK,CAAC,6BAA6B,2DAA0B,CAAC,IAAI,SAAS,CAAC,CAAC;QACzF,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC9E,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,eAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAE5C,IAAI,cAAc,YAAY,2DAA0B,EAAE,CAAC;YACzD,MAAM,UAAU,GAAG,EAAE,CAAC,kCAA0B,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAE,GAAG,cAAc,CAAC,UAAU,EAAE,CAAE;YAC9G,MAAM,KAAK,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;YACjD,OAAO;QACT,CAAC;QAED,MAAM,KAAK,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAC,CAAC,kCAA0B,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAC,EAAE,CAAC,CAAC;IAC9G,CAAC;CACF,CAAA;AAzBY,wDAAsB;iCAAtB,sBAAsB;IADlC,IAAA,mBAAU,GAAE;qCAGiB,4CAAmB;GAFpC,sBAAsB,CAyBlC"}