@geekmidas/events 9.5.0 → 9.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/dist/{BasicConnection-hl-Ogz3a.mjs → BasicConnection-CVyEy5R6.mjs} +1 -1
  3. package/dist/{BasicConnection-hl-Ogz3a.mjs.map → BasicConnection-CVyEy5R6.mjs.map} +1 -1
  4. package/dist/{BasicConnection-CxfNEvlb.cjs → BasicConnection-DyGmgDSX.cjs} +1 -1
  5. package/dist/{BasicConnection-CxfNEvlb.cjs.map → BasicConnection-DyGmgDSX.cjs.map} +1 -1
  6. package/dist/{BasicPublisher-DogbeHAH.mjs → BasicPublisher-7rE-7TTf.mjs} +1 -1
  7. package/dist/{BasicPublisher-DogbeHAH.mjs.map → BasicPublisher-7rE-7TTf.mjs.map} +1 -1
  8. package/dist/{BasicPublisher-CXAVKxgq.cjs → BasicPublisher-Bv4TTrtI.cjs} +1 -1
  9. package/dist/{BasicPublisher-CXAVKxgq.cjs.map → BasicPublisher-Bv4TTrtI.cjs.map} +1 -1
  10. package/dist/{BasicSubscriber-mVJRMXhZ.cjs → BasicSubscriber-BYemML6q.cjs} +1 -1
  11. package/dist/{BasicSubscriber-mVJRMXhZ.cjs.map → BasicSubscriber-BYemML6q.cjs.map} +1 -1
  12. package/dist/{BasicSubscriber-BJSZN22M.mjs → BasicSubscriber-Cm4qZZf4.mjs} +1 -1
  13. package/dist/{BasicSubscriber-BJSZN22M.mjs.map → BasicSubscriber-Cm4qZZf4.mjs.map} +1 -1
  14. package/dist/{Publisher-DDee6xau.d.cts → Publisher-BRD9Asio.d.cts} +8 -3
  15. package/dist/Publisher-BRD9Asio.d.cts.map +1 -0
  16. package/dist/{Publisher-ChLTrUeP.mjs → Publisher-DpRC2iZf.mjs} +3 -3
  17. package/dist/Publisher-DpRC2iZf.mjs.map +1 -0
  18. package/dist/{Publisher-CKloIGh6.cjs → Publisher-QwLaFS2C.cjs} +3 -3
  19. package/dist/Publisher-QwLaFS2C.cjs.map +1 -0
  20. package/dist/{Publisher-VHumMkrP.d.mts → Publisher-s3Oj6vUG.d.mts} +8 -3
  21. package/dist/Publisher-s3Oj6vUG.d.mts.map +1 -0
  22. package/dist/Publisher.cjs +1 -1
  23. package/dist/Publisher.d.cts +2 -2
  24. package/dist/Publisher.d.mts +2 -2
  25. package/dist/Publisher.mjs +1 -1
  26. package/dist/{RabbitMQConnection-Cg7mp8u-.mjs → RabbitMQConnection-CniiDhWq.mjs} +1 -1
  27. package/dist/{RabbitMQConnection-Cg7mp8u-.mjs.map → RabbitMQConnection-CniiDhWq.mjs.map} +1 -1
  28. package/dist/{RabbitMQConnection-DddqvI3I.cjs → RabbitMQConnection-Dw-HpHyE.cjs} +1 -1
  29. package/dist/{RabbitMQConnection-DddqvI3I.cjs.map → RabbitMQConnection-Dw-HpHyE.cjs.map} +1 -1
  30. package/dist/{RabbitMQPublisher-Cxm1zSkD.mjs → RabbitMQPublisher-BZX0edgL.mjs} +1 -1
  31. package/dist/{RabbitMQPublisher-Cxm1zSkD.mjs.map → RabbitMQPublisher-BZX0edgL.mjs.map} +1 -1
  32. package/dist/{RabbitMQPublisher-BfTRUnpy.cjs → RabbitMQPublisher-CSCn6gMA.cjs} +1 -1
  33. package/dist/{RabbitMQPublisher-BfTRUnpy.cjs.map → RabbitMQPublisher-CSCn6gMA.cjs.map} +1 -1
  34. package/dist/{RabbitMQSubscriber-fP8G9OlK.mjs → RabbitMQSubscriber-CiCsdiOM.mjs} +1 -1
  35. package/dist/{RabbitMQSubscriber-fP8G9OlK.mjs.map → RabbitMQSubscriber-CiCsdiOM.mjs.map} +1 -1
  36. package/dist/{RabbitMQSubscriber-CWDdmt1M.cjs → RabbitMQSubscriber-fUmIyY0t.cjs} +1 -1
  37. package/dist/{RabbitMQSubscriber-CWDdmt1M.cjs.map → RabbitMQSubscriber-fUmIyY0t.cjs.map} +1 -1
  38. package/dist/{SQSPublisher-DG9o4ME3.mjs → SQSPublisher-Bn1lwlln.mjs} +12 -5
  39. package/dist/SQSPublisher-Bn1lwlln.mjs.map +1 -0
  40. package/dist/{SQSPublisher-Dq5353oZ.cjs → SQSPublisher-CT0VFeeh.cjs} +12 -5
  41. package/dist/SQSPublisher-CT0VFeeh.cjs.map +1 -0
  42. package/dist/{SQSPublisher-qDE5Fp-N.d.mts → SQSPublisher-D7grG35F.d.mts} +12 -5
  43. package/dist/SQSPublisher-D7grG35F.d.mts.map +1 -0
  44. package/dist/{SQSPublisher-kyl5HW3N.d.cts → SQSPublisher-D9MHsTne.d.cts} +12 -5
  45. package/dist/SQSPublisher-D9MHsTne.d.cts.map +1 -0
  46. package/dist/basic/BasicConnection.cjs +1 -1
  47. package/dist/basic/BasicConnection.mjs +1 -1
  48. package/dist/basic/BasicPublisher.cjs +1 -1
  49. package/dist/basic/BasicPublisher.mjs +1 -1
  50. package/dist/basic/BasicSubscriber.cjs +1 -1
  51. package/dist/basic/BasicSubscriber.mjs +1 -1
  52. package/dist/basic/index.cjs +3 -3
  53. package/dist/basic/index.mjs +3 -3
  54. package/dist/index.cjs +1 -1
  55. package/dist/index.d.cts +2 -2
  56. package/dist/index.d.mts +2 -2
  57. package/dist/index.mjs +1 -1
  58. package/dist/rabbitmq/RabbitMQConnection.cjs +1 -1
  59. package/dist/rabbitmq/RabbitMQConnection.mjs +1 -1
  60. package/dist/rabbitmq/RabbitMQPublisher.cjs +1 -1
  61. package/dist/rabbitmq/RabbitMQPublisher.mjs +1 -1
  62. package/dist/rabbitmq/RabbitMQSubscriber.cjs +1 -1
  63. package/dist/rabbitmq/RabbitMQSubscriber.mjs +1 -1
  64. package/dist/rabbitmq/index.cjs +3 -3
  65. package/dist/rabbitmq/index.mjs +3 -3
  66. package/dist/sqs/SQSPublisher.cjs +1 -1
  67. package/dist/sqs/SQSPublisher.d.cts +1 -1
  68. package/dist/sqs/SQSPublisher.d.mts +1 -1
  69. package/dist/sqs/SQSPublisher.mjs +1 -1
  70. package/dist/sqs/index.cjs +1 -1
  71. package/dist/sqs/index.d.cts +1 -1
  72. package/dist/sqs/index.d.mts +1 -1
  73. package/dist/sqs/index.mjs +1 -1
  74. package/package.json +3 -3
  75. package/src/Publisher.ts +12 -1
  76. package/src/index.ts +4 -1
  77. package/src/sqs/SQSPublisher.ts +26 -5
  78. package/src/sqs/__tests__/SQSPublisher.fifo.spec.ts +63 -0
  79. package/dist/Publisher-CKloIGh6.cjs.map +0 -1
  80. package/dist/Publisher-ChLTrUeP.mjs.map +0 -1
  81. package/dist/Publisher-DDee6xau.d.cts.map +0 -1
  82. package/dist/Publisher-VHumMkrP.d.mts.map +0 -1
  83. package/dist/SQSPublisher-DG9o4ME3.mjs.map +0 -1
  84. package/dist/SQSPublisher-Dq5353oZ.cjs.map +0 -1
  85. package/dist/SQSPublisher-kyl5HW3N.d.cts.map +0 -1
  86. package/dist/SQSPublisher-qDE5Fp-N.d.mts.map +0 -1
@@ -7,18 +7,24 @@ var SQSPublisher = class SQSPublisher {
7
7
  options;
8
8
  constructor(connection, options = {}) {
9
9
  this.connection = connection;
10
- this.options = { maxBatchSize: options.maxBatchSize ?? 10 };
10
+ this.options = {
11
+ maxBatchSize: options.maxBatchSize ?? 10,
12
+ groupId: options.groupId
13
+ };
11
14
  }
12
15
  /**
13
16
  * Create an SQSPublisher from a connection string
14
17
  * Format: sqs://?queueUrl=https://sqs.region.amazonaws.com/accountId/queueName&region=us-east-1&endpoint=http://localhost:4566&maxBatchSize=10
15
18
  */
16
- static async fromConnectionString(connectionString) {
19
+ static async fromConnectionString(connectionString, publisherOptions = {}) {
17
20
  const url = new URL(connectionString);
18
21
  const params = url.searchParams;
19
22
  const { SQSConnection } = await Promise.resolve().then(() => require("./sqs/SQSConnection.cjs"));
20
23
  const connection = await SQSConnection.fromConnectionString(connectionString);
21
- const options = { maxBatchSize: params.get("maxBatchSize") ? Number.parseInt(params.get("maxBatchSize"), 10) : void 0 };
24
+ const options = {
25
+ maxBatchSize: params.get("maxBatchSize") ? Number.parseInt(params.get("maxBatchSize"), 10) : void 0,
26
+ groupId: publisherOptions.groupId
27
+ };
22
28
  return new SQSPublisher(connection, options);
23
29
  }
24
30
  async publish(messages) {
@@ -37,7 +43,8 @@ var SQSPublisher = class SQSPublisher {
37
43
  MessageAttributes: { type: {
38
44
  DataType: "String",
39
45
  StringValue: message.type
40
- } }
46
+ } },
47
+ ...this.options.groupId && { MessageGroupId: this.options.groupId(message) }
41
48
  }));
42
49
  const input = {
43
50
  QueueUrl: this.connection.queueUrl,
@@ -60,4 +67,4 @@ Object.defineProperty(exports, 'SQSPublisher', {
60
67
  return SQSPublisher;
61
68
  }
62
69
  });
63
- //# sourceMappingURL=SQSPublisher-Dq5353oZ.cjs.map
70
+ //# sourceMappingURL=SQSPublisher-CT0VFeeh.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SQSPublisher-CT0VFeeh.cjs","names":["connection: SQSConnection","options: SQSPublisherOptions<TMessage>","connectionString: string","publisherOptions: Pick<SQSPublisherOptions<TMessage>, 'groupId'>","messages: TMessage[]","entries: SendMessageBatchRequestEntry[]","input: SendMessageBatchCommandInput","SendMessageBatchCommand"],"sources":["../src/sqs/SQSPublisher.ts"],"sourcesContent":["import {\n\tSendMessageBatchCommand,\n\ttype SendMessageBatchCommandInput,\n\ttype SendMessageBatchRequestEntry,\n} from '@aws-sdk/client-sqs';\nimport chunk from 'lodash.chunk';\nimport type { EventPublisher, PublishableMessage } from '../types';\nimport type { SQSConnection } from './SQSConnection';\n\nexport interface SQSPublisherOptions<\n\tTMessage extends PublishableMessage<string, any> = PublishableMessage<\n\t\tstring,\n\t\tany\n\t>,\n> {\n\tmaxBatchSize?: number; // Default: 10 (SQS limit)\n\t/**\n\t * The FIFO message group for each message. Required to publish to a FIFO\n\t * queue, which refuses a message without one. Messages in one group are\n\t * delivered in order; different groups are processed in parallel. The queue\n\t * must use content-based deduplication, as no deduplication id is sent.\n\t */\n\tgroupId?: (message: TMessage) => string;\n}\n\nexport class SQSPublisher<TMessage extends PublishableMessage<string, any>>\n\timplements EventPublisher<TMessage>\n{\n\treadonly options: Required<Omit<SQSPublisherOptions<TMessage>, 'groupId'>> &\n\t\tPick<SQSPublisherOptions<TMessage>, 'groupId'>;\n\n\tconstructor(\n\t\treadonly connection: SQSConnection,\n\t\toptions: SQSPublisherOptions<TMessage> = {},\n\t) {\n\t\tthis.options = {\n\t\t\tmaxBatchSize: options.maxBatchSize ?? 10, // SQS limit\n\t\t\tgroupId: options.groupId,\n\t\t};\n\t}\n\n\t/**\n\t * Create an SQSPublisher from a connection string\n\t * Format: sqs://?queueUrl=https://sqs.region.amazonaws.com/accountId/queueName&region=us-east-1&endpoint=http://localhost:4566&maxBatchSize=10\n\t */\n\tstatic async fromConnectionString<\n\t\tTMessage extends PublishableMessage<string, any>,\n\t>(\n\t\tconnectionString: string,\n\t\tpublisherOptions: Pick<SQSPublisherOptions<TMessage>, 'groupId'> = {},\n\t): Promise<SQSPublisher<TMessage>> {\n\t\tconst url = new URL(connectionString);\n\t\tconst params = url.searchParams;\n\n\t\tconst { SQSConnection } = await import('./SQSConnection');\n\t\tconst connection =\n\t\t\tawait SQSConnection.fromConnectionString(connectionString);\n\n\t\tconst options: SQSPublisherOptions<TMessage> = {\n\t\t\tmaxBatchSize: params.get('maxBatchSize')\n\t\t\t\t? Number.parseInt(params.get('maxBatchSize')!, 10)\n\t\t\t\t: undefined,\n\t\t\tgroupId: publisherOptions.groupId,\n\t\t};\n\n\t\treturn new SQSPublisher<TMessage>(connection, options);\n\t}\n\n\tasync publish(messages: TMessage[]): Promise<void> {\n\t\tif (messages.length === 0) return;\n\n\t\tif (!this.connection.isConnected()) {\n\t\t\tawait this.connection.connect();\n\t\t}\n\n\t\t// Split messages into batches (SQS limit is 10 messages per batch)\n\t\tconst batches = chunk(messages, this.options.maxBatchSize);\n\n\t\t// Send all batches\n\t\tawait Promise.all(batches.map((batch) => this.sendBatch(batch)));\n\t}\n\n\tprivate async sendBatch(messages: TMessage[]): Promise<void> {\n\t\tconst entries: SendMessageBatchRequestEntry[] = messages.map(\n\t\t\t(message, index) => ({\n\t\t\t\tId: `${index}`,\n\t\t\t\tMessageBody: JSON.stringify({\n\t\t\t\t\ttype: message.type,\n\t\t\t\t\tpayload: message.payload,\n\t\t\t\t}),\n\t\t\t\tMessageAttributes: {\n\t\t\t\t\ttype: {\n\t\t\t\t\t\tDataType: 'String',\n\t\t\t\t\t\tStringValue: message.type,\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t\t...(this.options.groupId && {\n\t\t\t\t\tMessageGroupId: this.options.groupId(message),\n\t\t\t\t}),\n\t\t\t}),\n\t\t);\n\n\t\tconst input: SendMessageBatchCommandInput = {\n\t\t\tQueueUrl: this.connection.queueUrl,\n\t\t\tEntries: entries,\n\t\t};\n\n\t\tconst command = new SendMessageBatchCommand(input);\n\t\tconst response = await this.connection.sqsClient.send(command);\n\n\t\t// Check for failures\n\t\tif (response.Failed && response.Failed.length > 0) {\n\t\t\tconst errors = response.Failed.map(\n\t\t\t\t(f) => `${f.Id}: ${f.Code} - ${f.Message}`,\n\t\t\t).join(', ');\n\t\t\tthrow new Error(\n\t\t\t\t`Failed to send ${response.Failed.length} messages: ${errors}`,\n\t\t\t);\n\t\t}\n\t}\n\n\tasync close(): Promise<void> {\n\t\t// Publisher doesn't own the connection\n\t\t// Connection should be closed by whoever created it\n\t}\n}\n"],"mappings":";;;;;AAyBA,IAAa,eAAb,MAAa,aAEb;CACC,AAAS;CAGT,YACUA,YACTC,UAAyC,CAAE,GAC1C;EAFQ;AAGT,OAAK,UAAU;GACd,cAAc,QAAQ,gBAAgB;GACtC,SAAS,QAAQ;EACjB;CACD;;;;;CAMD,aAAa,qBAGZC,kBACAC,mBAAmE,CAAE,GACnC;EAClC,MAAM,MAAM,IAAI,IAAI;EACpB,MAAM,SAAS,IAAI;EAEnB,MAAM,EAAE,eAAe,GAAG,2CAAM;EAChC,MAAM,aACL,MAAM,cAAc,qBAAqB,iBAAiB;EAE3D,MAAMF,UAAyC;GAC9C,cAAc,OAAO,IAAI,eAAe,GACrC,OAAO,SAAS,OAAO,IAAI,eAAe,EAAG,GAAG;GAEnD,SAAS,iBAAiB;EAC1B;AAED,SAAO,IAAI,aAAuB,YAAY;CAC9C;CAED,MAAM,QAAQG,UAAqC;AAClD,MAAI,SAAS,WAAW,EAAG;AAE3B,OAAK,KAAK,WAAW,aAAa,CACjC,OAAM,KAAK,WAAW,SAAS;EAIhC,MAAM,UAAU,0BAAM,UAAU,KAAK,QAAQ,aAAa;AAG1D,QAAM,QAAQ,IAAI,QAAQ,IAAI,CAAC,UAAU,KAAK,UAAU,MAAM,CAAC,CAAC;CAChE;CAED,MAAc,UAAUA,UAAqC;EAC5D,MAAMC,UAA0C,SAAS,IACxD,CAAC,SAAS,WAAW;GACpB,KAAK,EAAE,MAAM;GACb,aAAa,KAAK,UAAU;IAC3B,MAAM,QAAQ;IACd,SAAS,QAAQ;GACjB,EAAC;GACF,mBAAmB,EAClB,MAAM;IACL,UAAU;IACV,aAAa,QAAQ;GACrB,EACD;GACD,GAAI,KAAK,QAAQ,WAAW,EAC3B,gBAAgB,KAAK,QAAQ,QAAQ,QAAQ,CAC7C;EACD,GACD;EAED,MAAMC,QAAsC;GAC3C,UAAU,KAAK,WAAW;GAC1B,SAAS;EACT;EAED,MAAM,UAAU,IAAIC,6CAAwB;EAC5C,MAAM,WAAW,MAAM,KAAK,WAAW,UAAU,KAAK,QAAQ;AAG9D,MAAI,SAAS,UAAU,SAAS,OAAO,SAAS,GAAG;GAClD,MAAM,SAAS,SAAS,OAAO,IAC9B,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,EAAE,QAAQ,EACzC,CAAC,KAAK,KAAK;AACZ,SAAM,IAAI,OACR,iBAAiB,SAAS,OAAO,OAAO,aAAa,OAAO;EAE9D;CACD;CAED,MAAM,QAAuB,CAG5B;AACD"}
@@ -2,18 +2,25 @@ import { EventPublisher, PublishableMessage } from "./types-Dh9Jyinx.mjs";
2
2
  import { SQSConnection } from "./SQSConnection-DVy43GCV.mjs";
3
3
 
4
4
  //#region src/sqs/SQSPublisher.d.ts
5
- interface SQSPublisherOptions {
5
+ interface SQSPublisherOptions<TMessage extends PublishableMessage<string, any> = PublishableMessage<string, any>> {
6
6
  maxBatchSize?: number;
7
+ /**
8
+ * The FIFO message group for each message. Required to publish to a FIFO
9
+ * queue, which refuses a message without one. Messages in one group are
10
+ * delivered in order; different groups are processed in parallel. The queue
11
+ * must use content-based deduplication, as no deduplication id is sent.
12
+ */
13
+ groupId?: (message: TMessage) => string;
7
14
  }
8
15
  declare class SQSPublisher<TMessage extends PublishableMessage<string, any>> implements EventPublisher<TMessage> {
9
16
  readonly connection: SQSConnection;
10
- readonly options: Required<SQSPublisherOptions>;
11
- constructor(connection: SQSConnection, options?: SQSPublisherOptions);
17
+ readonly options: Required<Omit<SQSPublisherOptions<TMessage>, 'groupId'>> & Pick<SQSPublisherOptions<TMessage>, 'groupId'>;
18
+ constructor(connection: SQSConnection, options?: SQSPublisherOptions<TMessage>);
12
19
  /**
13
20
  * Create an SQSPublisher from a connection string
14
21
  * Format: sqs://?queueUrl=https://sqs.region.amazonaws.com/accountId/queueName&region=us-east-1&endpoint=http://localhost:4566&maxBatchSize=10
15
22
  */
16
- static fromConnectionString<TMessage extends PublishableMessage<string, any>>(connectionString: string): Promise<SQSPublisher<TMessage>>;
23
+ static fromConnectionString<TMessage extends PublishableMessage<string, any>>(connectionString: string, publisherOptions?: Pick<SQSPublisherOptions<TMessage>, 'groupId'>): Promise<SQSPublisher<TMessage>>;
17
24
  publish(messages: TMessage[]): Promise<void>;
18
25
  private sendBatch;
19
26
  close(): Promise<void>;
@@ -22,4 +29,4 @@ declare class SQSPublisher<TMessage extends PublishableMessage<string, any>> imp
22
29
 
23
30
  //#endregion
24
31
  export { SQSPublisher, SQSPublisherOptions };
25
- //# sourceMappingURL=SQSPublisher-qDE5Fp-N.d.mts.map
32
+ //# sourceMappingURL=SQSPublisher-D7grG35F.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SQSPublisher-D7grG35F.d.mts","names":[],"sources":["../src/sqs/SQSPublisher.ts"],"sourcesContent":[],"mappings":";;;;UASiB,qCACC,kCAAkC;;EADnC;;;;;AAaY;EAGhB,OAAA,CAAA,EAAA,CAAA,OAAY,EAHJ,QAGI,EAAA,GAAA,MAAA;;AAAkB,cAA9B,YAA8B,CAAA,iBAAA,kBAAA,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,YAC/B,cAD+B,CAChB,QADgB,CAAA,CAAA;EAAkB,SAClC,UAAA,EAMJ,aANI;EAAQ,SAMZ,OAAA,EAJJ,QAII,CAJK,IAIL,CAJU,mBAIV,CAJ8B,QAI9B,CAAA,EAAA,SAAA,CAAA,CAAA,GAHrB,IAGqB,CAHhB,mBAGgB,CAHI,QAGJ,CAAA,EAAA,SAAA,CAAA;EAAa,WAJiB,CAAA,UAAA,EAI9B,aAJ8B,EAAA,OAAA,CAAA,EAK1C,mBAL0C,CAKtB,QALsB,CAAA;EAAQ;;;;EAC1B,OAA5B,oBAAA,CAAA,iBAiBY,kBAjBZ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,gBAAA,EAAA,MAAA,EAAA,gBAAA,CAAA,EAoBa,IApBb,CAoBkB,mBApBlB,CAoBsC,QApBtC,CAAA,EAAA,SAAA,CAAA,CAAA,EAqBH,OArBG,CAqBK,YArBL,CAqBkB,QArBlB,CAAA,CAAA;EAAmB,OAAxB,CAAA,QAAA,EAuCuB,QAvCvB,EAAA,CAAA,EAuCoC,OAvCpC,CAAA,IAAA,CAAA;EAAI,QAGiB,SAAA;EAAa,KACL,CAAA,CAAA,EAwFf,OAxFe,CAAA,IAAA,CAAA"}
@@ -2,18 +2,25 @@ import { EventPublisher, PublishableMessage } from "./types-Dj23od3e.cjs";
2
2
  import { SQSConnection } from "./SQSConnection-BtEkDha8.cjs";
3
3
 
4
4
  //#region src/sqs/SQSPublisher.d.ts
5
- interface SQSPublisherOptions {
5
+ interface SQSPublisherOptions<TMessage extends PublishableMessage<string, any> = PublishableMessage<string, any>> {
6
6
  maxBatchSize?: number;
7
+ /**
8
+ * The FIFO message group for each message. Required to publish to a FIFO
9
+ * queue, which refuses a message without one. Messages in one group are
10
+ * delivered in order; different groups are processed in parallel. The queue
11
+ * must use content-based deduplication, as no deduplication id is sent.
12
+ */
13
+ groupId?: (message: TMessage) => string;
7
14
  }
8
15
  declare class SQSPublisher<TMessage extends PublishableMessage<string, any>> implements EventPublisher<TMessage> {
9
16
  readonly connection: SQSConnection;
10
- readonly options: Required<SQSPublisherOptions>;
11
- constructor(connection: SQSConnection, options?: SQSPublisherOptions);
17
+ readonly options: Required<Omit<SQSPublisherOptions<TMessage>, 'groupId'>> & Pick<SQSPublisherOptions<TMessage>, 'groupId'>;
18
+ constructor(connection: SQSConnection, options?: SQSPublisherOptions<TMessage>);
12
19
  /**
13
20
  * Create an SQSPublisher from a connection string
14
21
  * Format: sqs://?queueUrl=https://sqs.region.amazonaws.com/accountId/queueName&region=us-east-1&endpoint=http://localhost:4566&maxBatchSize=10
15
22
  */
16
- static fromConnectionString<TMessage extends PublishableMessage<string, any>>(connectionString: string): Promise<SQSPublisher<TMessage>>;
23
+ static fromConnectionString<TMessage extends PublishableMessage<string, any>>(connectionString: string, publisherOptions?: Pick<SQSPublisherOptions<TMessage>, 'groupId'>): Promise<SQSPublisher<TMessage>>;
17
24
  publish(messages: TMessage[]): Promise<void>;
18
25
  private sendBatch;
19
26
  close(): Promise<void>;
@@ -22,4 +29,4 @@ declare class SQSPublisher<TMessage extends PublishableMessage<string, any>> imp
22
29
 
23
30
  //#endregion
24
31
  export { SQSPublisher, SQSPublisherOptions };
25
- //# sourceMappingURL=SQSPublisher-kyl5HW3N.d.cts.map
32
+ //# sourceMappingURL=SQSPublisher-D9MHsTne.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SQSPublisher-D9MHsTne.d.cts","names":[],"sources":["../src/sqs/SQSPublisher.ts"],"sourcesContent":[],"mappings":";;;;UASiB,qCACC,kCAAkC;;EADnC;;;;;AAaY;EAGhB,OAAA,CAAA,EAAA,CAAA,OAAY,EAHJ,QAGI,EAAA,GAAA,MAAA;;AAAkB,cAA9B,YAA8B,CAAA,iBAAA,kBAAA,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,YAC/B,cAD+B,CAChB,QADgB,CAAA,CAAA;EAAkB,SAClC,UAAA,EAMJ,aANI;EAAQ,SAMZ,OAAA,EAJJ,QAII,CAJK,IAIL,CAJU,mBAIV,CAJ8B,QAI9B,CAAA,EAAA,SAAA,CAAA,CAAA,GAHrB,IAGqB,CAHhB,mBAGgB,CAHI,QAGJ,CAAA,EAAA,SAAA,CAAA;EAAa,WAJiB,CAAA,UAAA,EAI9B,aAJ8B,EAAA,OAAA,CAAA,EAK1C,mBAL0C,CAKtB,QALsB,CAAA;EAAQ;;;;EAC1B,OAA5B,oBAAA,CAAA,iBAiBY,kBAjBZ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,gBAAA,EAAA,MAAA,EAAA,gBAAA,CAAA,EAoBa,IApBb,CAoBkB,mBApBlB,CAoBsC,QApBtC,CAAA,EAAA,SAAA,CAAA,CAAA,EAqBH,OArBG,CAqBK,YArBL,CAqBkB,QArBlB,CAAA,CAAA;EAAmB,OAAxB,CAAA,QAAA,EAuCuB,QAvCvB,EAAA,CAAA,EAuCoC,OAvCpC,CAAA,IAAA,CAAA;EAAI,QAGiB,SAAA;EAAa,KACL,CAAA,CAAA,EAwFf,OAxFe,CAAA,IAAA,CAAA"}
@@ -1,4 +1,4 @@
1
1
  require('../types-Byv8N9ma.cjs');
2
- const require_BasicConnection = require('../BasicConnection-CxfNEvlb.cjs');
2
+ const require_BasicConnection = require('../BasicConnection-DyGmgDSX.cjs');
3
3
 
4
4
  exports.BasicConnection = require_BasicConnection.BasicConnection;
@@ -1,4 +1,4 @@
1
1
  import "../types-BrdcSEnd.mjs";
2
- import { BasicConnection } from "../BasicConnection-hl-Ogz3a.mjs";
2
+ import { BasicConnection } from "../BasicConnection-CVyEy5R6.mjs";
3
3
 
4
4
  export { BasicConnection };
@@ -1,3 +1,3 @@
1
- const require_BasicPublisher = require('../BasicPublisher-CXAVKxgq.cjs');
1
+ const require_BasicPublisher = require('../BasicPublisher-Bv4TTrtI.cjs');
2
2
 
3
3
  exports.BasicPublisher = require_BasicPublisher.BasicPublisher;
@@ -1,3 +1,3 @@
1
- import { BasicPublisher } from "../BasicPublisher-DogbeHAH.mjs";
1
+ import { BasicPublisher } from "../BasicPublisher-7rE-7TTf.mjs";
2
2
 
3
3
  export { BasicPublisher };
@@ -1,3 +1,3 @@
1
- const require_BasicSubscriber = require('../BasicSubscriber-mVJRMXhZ.cjs');
1
+ const require_BasicSubscriber = require('../BasicSubscriber-BYemML6q.cjs');
2
2
 
3
3
  exports.BasicSubscriber = require_BasicSubscriber.BasicSubscriber;
@@ -1,3 +1,3 @@
1
- import { BasicSubscriber } from "../BasicSubscriber-BJSZN22M.mjs";
1
+ import { BasicSubscriber } from "../BasicSubscriber-Cm4qZZf4.mjs";
2
2
 
3
3
  export { BasicSubscriber };
@@ -1,7 +1,7 @@
1
1
  require('../types-Byv8N9ma.cjs');
2
- const require_BasicConnection = require('../BasicConnection-CxfNEvlb.cjs');
3
- const require_BasicPublisher = require('../BasicPublisher-CXAVKxgq.cjs');
4
- const require_BasicSubscriber = require('../BasicSubscriber-mVJRMXhZ.cjs');
2
+ const require_BasicConnection = require('../BasicConnection-DyGmgDSX.cjs');
3
+ const require_BasicPublisher = require('../BasicPublisher-Bv4TTrtI.cjs');
4
+ const require_BasicSubscriber = require('../BasicSubscriber-BYemML6q.cjs');
5
5
 
6
6
  exports.BasicConnection = require_BasicConnection.BasicConnection;
7
7
  exports.BasicPublisher = require_BasicPublisher.BasicPublisher;
@@ -1,6 +1,6 @@
1
1
  import "../types-BrdcSEnd.mjs";
2
- import { BasicConnection } from "../BasicConnection-hl-Ogz3a.mjs";
3
- import { BasicPublisher } from "../BasicPublisher-DogbeHAH.mjs";
4
- import { BasicSubscriber } from "../BasicSubscriber-BJSZN22M.mjs";
2
+ import { BasicConnection } from "../BasicConnection-CVyEy5R6.mjs";
3
+ import { BasicPublisher } from "../BasicPublisher-7rE-7TTf.mjs";
4
+ import { BasicSubscriber } from "../BasicSubscriber-Cm4qZZf4.mjs";
5
5
 
6
6
  export { BasicConnection, BasicPublisher, BasicSubscriber };
package/dist/index.cjs CHANGED
@@ -1,6 +1,6 @@
1
1
  const require_types = require('./types-Byv8N9ma.cjs');
2
2
  const require_EventConnection = require('./EventConnection-BkA9FSVL.cjs');
3
- const require_Publisher = require('./Publisher-CKloIGh6.cjs');
3
+ const require_Publisher = require('./Publisher-QwLaFS2C.cjs');
4
4
  const require_Subscriber = require('./Subscriber-CghW0A02.cjs');
5
5
 
6
6
  exports.EventConnectionFactory = require_EventConnection.EventConnectionFactory;
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { EventConnection, EventPublisher, EventPublisherType, EventSubscriber, ExtractPublisherMessage, MappedEvent, PublishableMessage } from "./types-Dj23od3e.cjs";
2
2
  import { EventConnectionFactory } from "./EventConnection-dP42P87q.cjs";
3
- import { EventPublisherConnectionString, Publisher } from "./Publisher-DDee6xau.cjs";
3
+ import { EventPublisherConnectionString, Publisher, PublisherOptions } from "./Publisher-BRD9Asio.cjs";
4
4
  import { EventSubscriberConnectionString, Subscriber } from "./Subscriber-CG_QUQZs.cjs";
5
- export { EventConnection, EventConnectionFactory, EventPublisher, EventPublisherConnectionString, EventPublisherType, EventSubscriber, EventSubscriberConnectionString, ExtractPublisherMessage, MappedEvent, PublishableMessage, Publisher, Subscriber };
5
+ export { EventConnection, EventConnectionFactory, EventPublisher, EventPublisherConnectionString, EventPublisherType, EventSubscriber, EventSubscriberConnectionString, ExtractPublisherMessage, MappedEvent, PublishableMessage, Publisher, PublisherOptions, Subscriber };
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { EventConnection, EventPublisher, EventPublisherType, EventSubscriber, ExtractPublisherMessage, MappedEvent, PublishableMessage } from "./types-Dh9Jyinx.mjs";
2
2
  import { EventConnectionFactory } from "./EventConnection-4niMI6D8.mjs";
3
- import { EventPublisherConnectionString, Publisher } from "./Publisher-VHumMkrP.mjs";
3
+ import { EventPublisherConnectionString, Publisher, PublisherOptions } from "./Publisher-s3Oj6vUG.mjs";
4
4
  import { EventSubscriberConnectionString, Subscriber } from "./Subscriber-DiYHmuF0.mjs";
5
- export { EventConnection, EventConnectionFactory, EventPublisher, EventPublisherConnectionString, EventPublisherType, EventSubscriber, EventSubscriberConnectionString, ExtractPublisherMessage, MappedEvent, PublishableMessage, Publisher, Subscriber };
5
+ export { EventConnection, EventConnectionFactory, EventPublisher, EventPublisherConnectionString, EventPublisherType, EventSubscriber, EventSubscriberConnectionString, ExtractPublisherMessage, MappedEvent, PublishableMessage, Publisher, PublisherOptions, Subscriber };
package/dist/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  import { EventPublisherType } from "./types-BrdcSEnd.mjs";
2
2
  import { EventConnectionFactory } from "./EventConnection-Kr32GAzq.mjs";
3
- import { Publisher } from "./Publisher-ChLTrUeP.mjs";
3
+ import { Publisher } from "./Publisher-DpRC2iZf.mjs";
4
4
  import { Subscriber } from "./Subscriber-bnkFtSvt.mjs";
5
5
 
6
6
  export { EventConnectionFactory, EventPublisherType, Publisher, Subscriber };
@@ -1,4 +1,4 @@
1
1
  require('../types-Byv8N9ma.cjs');
2
- const require_RabbitMQConnection = require('../RabbitMQConnection-DddqvI3I.cjs');
2
+ const require_RabbitMQConnection = require('../RabbitMQConnection-Dw-HpHyE.cjs');
3
3
 
4
4
  exports.RabbitMQConnection = require_RabbitMQConnection.RabbitMQConnection;
@@ -1,4 +1,4 @@
1
1
  import "../types-BrdcSEnd.mjs";
2
- import { RabbitMQConnection } from "../RabbitMQConnection-Cg7mp8u-.mjs";
2
+ import { RabbitMQConnection } from "../RabbitMQConnection-CniiDhWq.mjs";
3
3
 
4
4
  export { RabbitMQConnection };
@@ -1,3 +1,3 @@
1
- const require_RabbitMQPublisher = require('../RabbitMQPublisher-BfTRUnpy.cjs');
1
+ const require_RabbitMQPublisher = require('../RabbitMQPublisher-CSCn6gMA.cjs');
2
2
 
3
3
  exports.RabbitMQPublisher = require_RabbitMQPublisher.RabbitMQPublisher;
@@ -1,3 +1,3 @@
1
- import { RabbitMQPublisher } from "../RabbitMQPublisher-Cxm1zSkD.mjs";
1
+ import { RabbitMQPublisher } from "../RabbitMQPublisher-BZX0edgL.mjs";
2
2
 
3
3
  export { RabbitMQPublisher };
@@ -1,3 +1,3 @@
1
- const require_RabbitMQSubscriber = require('../RabbitMQSubscriber-CWDdmt1M.cjs');
1
+ const require_RabbitMQSubscriber = require('../RabbitMQSubscriber-fUmIyY0t.cjs');
2
2
 
3
3
  exports.RabbitMQSubscriber = require_RabbitMQSubscriber.RabbitMQSubscriber;
@@ -1,3 +1,3 @@
1
- import { RabbitMQSubscriber } from "../RabbitMQSubscriber-fP8G9OlK.mjs";
1
+ import { RabbitMQSubscriber } from "../RabbitMQSubscriber-CiCsdiOM.mjs";
2
2
 
3
3
  export { RabbitMQSubscriber };
@@ -1,7 +1,7 @@
1
1
  require('../types-Byv8N9ma.cjs');
2
- const require_RabbitMQConnection = require('../RabbitMQConnection-DddqvI3I.cjs');
3
- const require_RabbitMQPublisher = require('../RabbitMQPublisher-BfTRUnpy.cjs');
4
- const require_RabbitMQSubscriber = require('../RabbitMQSubscriber-CWDdmt1M.cjs');
2
+ const require_RabbitMQConnection = require('../RabbitMQConnection-Dw-HpHyE.cjs');
3
+ const require_RabbitMQPublisher = require('../RabbitMQPublisher-CSCn6gMA.cjs');
4
+ const require_RabbitMQSubscriber = require('../RabbitMQSubscriber-fUmIyY0t.cjs');
5
5
 
6
6
  exports.RabbitMQConnection = require_RabbitMQConnection.RabbitMQConnection;
7
7
  exports.RabbitMQPublisher = require_RabbitMQPublisher.RabbitMQPublisher;
@@ -1,6 +1,6 @@
1
1
  import "../types-BrdcSEnd.mjs";
2
- import { RabbitMQConnection } from "../RabbitMQConnection-Cg7mp8u-.mjs";
3
- import { RabbitMQPublisher } from "../RabbitMQPublisher-Cxm1zSkD.mjs";
4
- import { RabbitMQSubscriber } from "../RabbitMQSubscriber-fP8G9OlK.mjs";
2
+ import { RabbitMQConnection } from "../RabbitMQConnection-CniiDhWq.mjs";
3
+ import { RabbitMQPublisher } from "../RabbitMQPublisher-BZX0edgL.mjs";
4
+ import { RabbitMQSubscriber } from "../RabbitMQSubscriber-CiCsdiOM.mjs";
5
5
 
6
6
  export { RabbitMQConnection, RabbitMQPublisher, RabbitMQSubscriber };
@@ -1,3 +1,3 @@
1
- const require_SQSPublisher = require('../SQSPublisher-Dq5353oZ.cjs');
1
+ const require_SQSPublisher = require('../SQSPublisher-CT0VFeeh.cjs');
2
2
 
3
3
  exports.SQSPublisher = require_SQSPublisher.SQSPublisher;
@@ -1,4 +1,4 @@
1
1
  import "../types-Dj23od3e.cjs";
2
2
  import "../SQSConnection-BtEkDha8.cjs";
3
- import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-kyl5HW3N.cjs";
3
+ import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-D9MHsTne.cjs";
4
4
  export { SQSPublisher, SQSPublisherOptions };
@@ -1,4 +1,4 @@
1
1
  import "../types-Dh9Jyinx.mjs";
2
2
  import "../SQSConnection-DVy43GCV.mjs";
3
- import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-qDE5Fp-N.mjs";
3
+ import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-D7grG35F.mjs";
4
4
  export { SQSPublisher, SQSPublisherOptions };
@@ -1,3 +1,3 @@
1
- import { SQSPublisher } from "../SQSPublisher-DG9o4ME3.mjs";
1
+ import { SQSPublisher } from "../SQSPublisher-Bn1lwlln.mjs";
2
2
 
3
3
  export { SQSPublisher };
@@ -1,7 +1,7 @@
1
1
  require('../types-Byv8N9ma.cjs');
2
2
  const require_SQSConnection = require('../SQSConnection-yge9cB_f.cjs');
3
3
  const require_SQSSubscriber = require('../SQSSubscriber-B4sRXVl6.cjs');
4
- const require_SQSPublisher = require('../SQSPublisher-Dq5353oZ.cjs');
4
+ const require_SQSPublisher = require('../SQSPublisher-CT0VFeeh.cjs');
5
5
 
6
6
  exports.SQSConnection = require_SQSConnection.SQSConnection;
7
7
  exports.SQSPublisher = require_SQSPublisher.SQSPublisher;
@@ -1,5 +1,5 @@
1
1
  import "../types-Dj23od3e.cjs";
2
2
  import { SQSConnection, SQSConnectionConfig } from "../SQSConnection-BtEkDha8.cjs";
3
- import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-kyl5HW3N.cjs";
3
+ import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-D9MHsTne.cjs";
4
4
  import { SQSSubscriber, SQSSubscriberOptions } from "../SQSSubscriber-CDvaG4ij.cjs";
5
5
  export { SQSConnection, SQSConnectionConfig, SQSPublisher, SQSPublisherOptions, SQSSubscriber, SQSSubscriberOptions };
@@ -1,5 +1,5 @@
1
1
  import "../types-Dh9Jyinx.mjs";
2
2
  import { SQSConnection, SQSConnectionConfig } from "../SQSConnection-DVy43GCV.mjs";
3
- import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-qDE5Fp-N.mjs";
3
+ import { SQSPublisher, SQSPublisherOptions } from "../SQSPublisher-D7grG35F.mjs";
4
4
  import { SQSSubscriber, SQSSubscriberOptions } from "../SQSSubscriber-JfFuAAoP.mjs";
5
5
  export { SQSConnection, SQSConnectionConfig, SQSPublisher, SQSPublisherOptions, SQSSubscriber, SQSSubscriberOptions };
@@ -1,6 +1,6 @@
1
1
  import "../types-BrdcSEnd.mjs";
2
2
  import { SQSConnection } from "../SQSConnection-BqZZnAZI.mjs";
3
3
  import { SQSSubscriber } from "../SQSSubscriber-CVGhZ8Nr.mjs";
4
- import { SQSPublisher } from "../SQSPublisher-DG9o4ME3.mjs";
4
+ import { SQSPublisher } from "../SQSPublisher-Bn1lwlln.mjs";
5
5
 
6
6
  export { SQSConnection, SQSPublisher, SQSSubscriber };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geekmidas/events",
3
- "version": "9.5.0",
3
+ "version": "9.6.0",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {
@@ -80,7 +80,7 @@
80
80
  "@aws-sdk/client-sqs": "~3.908.0",
81
81
  "@aws-sdk/client-sns": "~3.908.0",
82
82
  "pg-boss": ">=12.0.0",
83
- "@geekmidas/schema": "^9.5.0"
83
+ "@geekmidas/schema": "^9.6.0"
84
84
  },
85
85
  "peerDependenciesMeta": {
86
86
  "@geekmidas/schema": {
@@ -105,6 +105,6 @@
105
105
  "@types/pg": "~8.15.6",
106
106
  "pg": "~8.20.0",
107
107
  "pg-boss": "~12.18.1",
108
- "@geekmidas/schema": "^9.5.0"
108
+ "@geekmidas/schema": "^9.6.0"
109
109
  }
110
110
  }
package/src/Publisher.ts CHANGED
@@ -5,6 +5,14 @@ import type {
5
5
  } from './types';
6
6
  import { EventPublisherType } from './types';
7
7
 
8
+ /** Options a transport uses when it supports them, ignored by the rest. */
9
+ export interface PublisherOptions<
10
+ TMessage extends PublishableMessage<string, any>,
11
+ > {
12
+ /** The FIFO message group for each message (SQS). */
13
+ groupId?: (message: TMessage) => string;
14
+ }
15
+
8
16
  export class Publisher {
9
17
  /**
10
18
  * Create a publisher from a connection string
@@ -14,6 +22,7 @@ export class Publisher {
14
22
  TMessage extends PublishableMessage<string, any>,
15
23
  >(
16
24
  connectionStr: EventPublisherConnectionString,
25
+ options: PublisherOptions<TMessage> = {},
17
26
  ): Promise<EventPublisher<TMessage>> {
18
27
  const url = new URL(connectionStr);
19
28
  switch (url.protocol.replace(':', '')) {
@@ -29,7 +38,9 @@ export class Publisher {
29
38
  }
30
39
  case EventPublisherType.SQS: {
31
40
  const { SQSPublisher } = await import('./sqs');
32
- return SQSPublisher.fromConnectionString<TMessage>(connectionStr);
41
+ return SQSPublisher.fromConnectionString<TMessage>(connectionStr, {
42
+ groupId: options.groupId,
43
+ });
33
44
  }
34
45
  case EventPublisherType.SNS: {
35
46
  const { SNSPublisher } = await import('./sns');
package/src/index.ts CHANGED
@@ -1,7 +1,10 @@
1
1
  // Generic types and interfaces
2
2
 
3
3
  export { EventConnectionFactory } from './EventConnection';
4
- export type { EventPublisherConnectionString } from './Publisher';
4
+ export type {
5
+ EventPublisherConnectionString,
6
+ PublisherOptions,
7
+ } from './Publisher';
5
8
 
6
9
  // Generic factories
7
10
  export { Publisher } from './Publisher';
@@ -7,21 +7,35 @@ import chunk from 'lodash.chunk';
7
7
  import type { EventPublisher, PublishableMessage } from '../types';
8
8
  import type { SQSConnection } from './SQSConnection';
9
9
 
10
- export interface SQSPublisherOptions {
10
+ export interface SQSPublisherOptions<
11
+ TMessage extends PublishableMessage<string, any> = PublishableMessage<
12
+ string,
13
+ any
14
+ >,
15
+ > {
11
16
  maxBatchSize?: number; // Default: 10 (SQS limit)
17
+ /**
18
+ * The FIFO message group for each message. Required to publish to a FIFO
19
+ * queue, which refuses a message without one. Messages in one group are
20
+ * delivered in order; different groups are processed in parallel. The queue
21
+ * must use content-based deduplication, as no deduplication id is sent.
22
+ */
23
+ groupId?: (message: TMessage) => string;
12
24
  }
13
25
 
14
26
  export class SQSPublisher<TMessage extends PublishableMessage<string, any>>
15
27
  implements EventPublisher<TMessage>
16
28
  {
17
- readonly options: Required<SQSPublisherOptions>;
29
+ readonly options: Required<Omit<SQSPublisherOptions<TMessage>, 'groupId'>> &
30
+ Pick<SQSPublisherOptions<TMessage>, 'groupId'>;
18
31
 
19
32
  constructor(
20
33
  readonly connection: SQSConnection,
21
- options: SQSPublisherOptions = {},
34
+ options: SQSPublisherOptions<TMessage> = {},
22
35
  ) {
23
36
  this.options = {
24
37
  maxBatchSize: options.maxBatchSize ?? 10, // SQS limit
38
+ groupId: options.groupId,
25
39
  };
26
40
  }
27
41
 
@@ -31,7 +45,10 @@ export class SQSPublisher<TMessage extends PublishableMessage<string, any>>
31
45
  */
32
46
  static async fromConnectionString<
33
47
  TMessage extends PublishableMessage<string, any>,
34
- >(connectionString: string): Promise<SQSPublisher<TMessage>> {
48
+ >(
49
+ connectionString: string,
50
+ publisherOptions: Pick<SQSPublisherOptions<TMessage>, 'groupId'> = {},
51
+ ): Promise<SQSPublisher<TMessage>> {
35
52
  const url = new URL(connectionString);
36
53
  const params = url.searchParams;
37
54
 
@@ -39,10 +56,11 @@ export class SQSPublisher<TMessage extends PublishableMessage<string, any>>
39
56
  const connection =
40
57
  await SQSConnection.fromConnectionString(connectionString);
41
58
 
42
- const options: SQSPublisherOptions = {
59
+ const options: SQSPublisherOptions<TMessage> = {
43
60
  maxBatchSize: params.get('maxBatchSize')
44
61
  ? Number.parseInt(params.get('maxBatchSize')!, 10)
45
62
  : undefined,
63
+ groupId: publisherOptions.groupId,
46
64
  };
47
65
 
48
66
  return new SQSPublisher<TMessage>(connection, options);
@@ -76,6 +94,9 @@ export class SQSPublisher<TMessage extends PublishableMessage<string, any>>
76
94
  StringValue: message.type,
77
95
  },
78
96
  },
97
+ ...(this.options.groupId && {
98
+ MessageGroupId: this.options.groupId(message),
99
+ }),
79
100
  }),
80
101
  );
81
102
 
@@ -0,0 +1,63 @@
1
+ import { randomUUID } from 'node:crypto';
2
+ import {
3
+ CreateQueueCommand,
4
+ DeleteQueueCommand,
5
+ ReceiveMessageCommand,
6
+ SQSClient,
7
+ } from '@aws-sdk/client-sqs';
8
+ import { describe, expect, it } from 'vitest';
9
+ import type { PublishableMessage } from '../../types';
10
+ import { SQSPublisher } from '../SQSPublisher';
11
+
12
+ /** LocalStack, as the repo's docker-compose runs it. */
13
+ const ENDPOINT = 'http://localhost:4566';
14
+ const REGION = 'us-east-1';
15
+
16
+ const sqs = new SQSClient({
17
+ region: REGION,
18
+ endpoint: ENDPOINT,
19
+ credentials: { accessKeyId: 'test', secretAccessKey: 'test' },
20
+ });
21
+
22
+ type ConversationMessage = PublishableMessage<
23
+ 'conversation',
24
+ { conversationId: string; text: string }
25
+ >;
26
+
27
+ describe('SQSPublisher on a FIFO queue', () => {
28
+ it('sends each message in the group its groupId gives', async () => {
29
+ const { QueueUrl } = await sqs.send(
30
+ new CreateQueueCommand({
31
+ QueueName: `publisher-${randomUUID()}.fifo`,
32
+ Attributes: { FifoQueue: 'true', ContentBasedDeduplication: 'true' },
33
+ }),
34
+ );
35
+
36
+ try {
37
+ const publisher =
38
+ await SQSPublisher.fromConnectionString<ConversationMessage>(
39
+ `sqs://?queueUrl=${encodeURIComponent(QueueUrl as string)}&region=${REGION}&endpoint=${encodeURIComponent(ENDPOINT)}&accessKeyId=test&secretAccessKey=test`,
40
+ { groupId: (message) => message.payload.conversationId },
41
+ );
42
+
43
+ await publisher.publish([
44
+ { type: 'conversation', payload: { conversationId: 'a', text: '1' } },
45
+ { type: 'conversation', payload: { conversationId: 'b', text: '2' } },
46
+ ]);
47
+
48
+ const { Messages = [] } = await sqs.send(
49
+ new ReceiveMessageCommand({
50
+ QueueUrl,
51
+ MaxNumberOfMessages: 10,
52
+ MessageSystemAttributeNames: ['MessageGroupId'],
53
+ WaitTimeSeconds: 1,
54
+ }),
55
+ );
56
+
57
+ const groups = Messages.map((m) => m.Attributes?.MessageGroupId).sort();
58
+ expect(groups).toEqual(['a', 'b']);
59
+ } finally {
60
+ await sqs.send(new DeleteQueueCommand({ QueueUrl }));
61
+ }
62
+ });
63
+ });
@@ -1 +0,0 @@
1
- {"version":3,"file":"Publisher-CKloIGh6.cjs","names":["connectionStr: EventPublisherConnectionString","EventPublisherType","connection: EventConnection"],"sources":["../src/Publisher.ts"],"sourcesContent":["import type {\n\tEventConnection,\n\tEventPublisher,\n\tPublishableMessage,\n} from './types';\nimport { EventPublisherType } from './types';\n\nexport class Publisher {\n\t/**\n\t * Create a publisher from a connection string\n\t * This creates both a connection and a publisher\n\t */\n\tstatic async fromConnectionString<\n\t\tTMessage extends PublishableMessage<string, any>,\n\t>(\n\t\tconnectionStr: EventPublisherConnectionString,\n\t): Promise<EventPublisher<TMessage>> {\n\t\tconst url = new URL(connectionStr);\n\t\tswitch (url.protocol.replace(':', '')) {\n\t\t\tcase EventPublisherType.Basic: {\n\t\t\t\tconst { BasicConnection, BasicPublisher } = await import('./basic');\n\t\t\t\tconst connection =\n\t\t\t\t\tawait BasicConnection.fromConnectionString(connectionStr);\n\t\t\t\treturn new BasicPublisher<TMessage>(connection);\n\t\t\t}\n\t\t\tcase EventPublisherType.RabbitMQ: {\n\t\t\t\tconst { RabbitMQPublisher } = await import('./rabbitmq');\n\t\t\t\treturn RabbitMQPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.SQS: {\n\t\t\t\tconst { SQSPublisher } = await import('./sqs');\n\t\t\t\treturn SQSPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.SNS: {\n\t\t\t\tconst { SNSPublisher } = await import('./sns');\n\t\t\t\treturn SNSPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.PgBoss: {\n\t\t\t\tconst { PgBossPublisher } = await import('./pgboss');\n\t\t\t\treturn PgBossPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\t// Future implementations for EventBridge, Kafka, etc.\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unsupported event publisher type: ${url.protocol}`);\n\t\t}\n\t}\n\n\t/**\n\t * Create a publisher from an existing connection\n\t * This allows sharing connections between publishers and subscribers\n\t */\n\tstatic async fromConnection<TMessage extends PublishableMessage<string, any>>(\n\t\tconnection: EventConnection,\n\t): Promise<EventPublisher<TMessage>> {\n\t\tswitch (connection.type) {\n\t\t\tcase EventPublisherType.Basic: {\n\t\t\t\tconst { BasicPublisher } = await import('./basic');\n\t\t\t\tconst { BasicConnection } = await import('./basic');\n\t\t\t\treturn new BasicPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof BasicConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.RabbitMQ: {\n\t\t\t\tconst { RabbitMQPublisher } = await import('./rabbitmq');\n\t\t\t\tconst { RabbitMQConnection } = await import('./rabbitmq');\n\t\t\t\treturn new RabbitMQPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof RabbitMQConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.SQS: {\n\t\t\t\tconst { SQSPublisher } = await import('./sqs');\n\t\t\t\tconst { SQSConnection } = await import('./sqs');\n\t\t\t\treturn new SQSPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof SQSConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.SNS: {\n\t\t\t\tconst { SNSPublisher } = await import('./sns');\n\t\t\t\tconst { SNSConnection } = await import('./sns');\n\t\t\t\treturn new SNSPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof SNSConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.PgBoss: {\n\t\t\t\tconst { PgBossPublisher } = await import('./pgboss');\n\t\t\t\tconst { PgBossConnection } = await import('./pgboss');\n\t\t\t\treturn new PgBossPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof PgBossConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unsupported connection type: ${connection.type}`);\n\t\t}\n\t}\n}\n\nexport type EventPublisherConnectionString =\n\t`${EventPublisherType}://${string}`;\n"],"mappings":";;;AAOA,IAAa,YAAb,MAAuB;;;;;CAKtB,aAAa,qBAGZA,eACoC;EACpC,MAAM,MAAM,IAAI,IAAI;AACpB,UAAQ,IAAI,SAAS,QAAQ,KAAK,GAAG,EAArC;GACC,KAAKC,iCAAmB,OAAO;IAC9B,MAAM,EAAE,iBAAiB,gBAAgB,GAAG,2CAAM;IAClD,MAAM,aACL,MAAM,gBAAgB,qBAAqB,cAAc;AAC1D,WAAO,IAAI,eAAyB;GACpC;GACD,KAAKA,iCAAmB,UAAU;IACjC,MAAM,EAAE,mBAAmB,GAAG,2CAAM;AACpC,WAAO,kBAAkB,qBAA+B,cAAc;GACtE;GACD,KAAKA,iCAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,2CAAM;AAC/B,WAAO,aAAa,qBAA+B,cAAc;GACjE;GACD,KAAKA,iCAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,2CAAM;AAC/B,WAAO,aAAa,qBAA+B,cAAc;GACjE;GACD,KAAKA,iCAAmB,QAAQ;IAC/B,MAAM,EAAE,iBAAiB,GAAG,2CAAM;AAClC,WAAO,gBAAgB,qBAA+B,cAAc;GACpE;GAED,QACC,OAAM,IAAI,OAAO,oCAAoC,IAAI,SAAS;EACnE;CACD;;;;;CAMD,aAAa,eACZC,YACoC;AACpC,UAAQ,WAAW,MAAnB;GACC,KAAKD,iCAAmB,OAAO;IAC9B,MAAM,EAAE,gBAAgB,GAAG,2CAAM;IACjC,MAAM,EAAE,iBAAiB,GAAG,2CAAM;AAClC,WAAO,IAAI,eACV;GAED;GACD,KAAKA,iCAAmB,UAAU;IACjC,MAAM,EAAE,mBAAmB,GAAG,2CAAM;IACpC,MAAM,EAAE,oBAAoB,GAAG,2CAAM;AACrC,WAAO,IAAI,kBACV;GAED;GACD,KAAKA,iCAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,2CAAM;IAC/B,MAAM,EAAE,eAAe,GAAG,2CAAM;AAChC,WAAO,IAAI,aACV;GAED;GACD,KAAKA,iCAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,2CAAM;IAC/B,MAAM,EAAE,eAAe,GAAG,2CAAM;AAChC,WAAO,IAAI,aACV;GAED;GACD,KAAKA,iCAAmB,QAAQ;IAC/B,MAAM,EAAE,iBAAiB,GAAG,2CAAM;IAClC,MAAM,EAAE,kBAAkB,GAAG,2CAAM;AACnC,WAAO,IAAI,gBACV;GAED;GACD,QACC,OAAM,IAAI,OAAO,+BAA+B,WAAW,KAAK;EACjE;CACD;AACD"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"Publisher-ChLTrUeP.mjs","names":["connectionStr: EventPublisherConnectionString","connection: EventConnection"],"sources":["../src/Publisher.ts"],"sourcesContent":["import type {\n\tEventConnection,\n\tEventPublisher,\n\tPublishableMessage,\n} from './types';\nimport { EventPublisherType } from './types';\n\nexport class Publisher {\n\t/**\n\t * Create a publisher from a connection string\n\t * This creates both a connection and a publisher\n\t */\n\tstatic async fromConnectionString<\n\t\tTMessage extends PublishableMessage<string, any>,\n\t>(\n\t\tconnectionStr: EventPublisherConnectionString,\n\t): Promise<EventPublisher<TMessage>> {\n\t\tconst url = new URL(connectionStr);\n\t\tswitch (url.protocol.replace(':', '')) {\n\t\t\tcase EventPublisherType.Basic: {\n\t\t\t\tconst { BasicConnection, BasicPublisher } = await import('./basic');\n\t\t\t\tconst connection =\n\t\t\t\t\tawait BasicConnection.fromConnectionString(connectionStr);\n\t\t\t\treturn new BasicPublisher<TMessage>(connection);\n\t\t\t}\n\t\t\tcase EventPublisherType.RabbitMQ: {\n\t\t\t\tconst { RabbitMQPublisher } = await import('./rabbitmq');\n\t\t\t\treturn RabbitMQPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.SQS: {\n\t\t\t\tconst { SQSPublisher } = await import('./sqs');\n\t\t\t\treturn SQSPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.SNS: {\n\t\t\t\tconst { SNSPublisher } = await import('./sns');\n\t\t\t\treturn SNSPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\tcase EventPublisherType.PgBoss: {\n\t\t\t\tconst { PgBossPublisher } = await import('./pgboss');\n\t\t\t\treturn PgBossPublisher.fromConnectionString<TMessage>(connectionStr);\n\t\t\t}\n\t\t\t// Future implementations for EventBridge, Kafka, etc.\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unsupported event publisher type: ${url.protocol}`);\n\t\t}\n\t}\n\n\t/**\n\t * Create a publisher from an existing connection\n\t * This allows sharing connections between publishers and subscribers\n\t */\n\tstatic async fromConnection<TMessage extends PublishableMessage<string, any>>(\n\t\tconnection: EventConnection,\n\t): Promise<EventPublisher<TMessage>> {\n\t\tswitch (connection.type) {\n\t\t\tcase EventPublisherType.Basic: {\n\t\t\t\tconst { BasicPublisher } = await import('./basic');\n\t\t\t\tconst { BasicConnection } = await import('./basic');\n\t\t\t\treturn new BasicPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof BasicConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.RabbitMQ: {\n\t\t\t\tconst { RabbitMQPublisher } = await import('./rabbitmq');\n\t\t\t\tconst { RabbitMQConnection } = await import('./rabbitmq');\n\t\t\t\treturn new RabbitMQPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof RabbitMQConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.SQS: {\n\t\t\t\tconst { SQSPublisher } = await import('./sqs');\n\t\t\t\tconst { SQSConnection } = await import('./sqs');\n\t\t\t\treturn new SQSPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof SQSConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.SNS: {\n\t\t\t\tconst { SNSPublisher } = await import('./sns');\n\t\t\t\tconst { SNSConnection } = await import('./sns');\n\t\t\t\treturn new SNSPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof SNSConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase EventPublisherType.PgBoss: {\n\t\t\t\tconst { PgBossPublisher } = await import('./pgboss');\n\t\t\t\tconst { PgBossConnection } = await import('./pgboss');\n\t\t\t\treturn new PgBossPublisher<TMessage>(\n\t\t\t\t\tconnection as InstanceType<typeof PgBossConnection>,\n\t\t\t\t);\n\t\t\t}\n\t\t\tdefault:\n\t\t\t\tthrow new Error(`Unsupported connection type: ${connection.type}`);\n\t\t}\n\t}\n}\n\nexport type EventPublisherConnectionString =\n\t`${EventPublisherType}://${string}`;\n"],"mappings":";;;AAOA,IAAa,YAAb,MAAuB;;;;;CAKtB,aAAa,qBAGZA,eACoC;EACpC,MAAM,MAAM,IAAI,IAAI;AACpB,UAAQ,IAAI,SAAS,QAAQ,KAAK,GAAG,EAArC;GACC,KAAK,mBAAmB,OAAO;IAC9B,MAAM,EAAE,iBAAiB,gBAAgB,GAAG,MAAM,OAAO;IACzD,MAAM,aACL,MAAM,gBAAgB,qBAAqB,cAAc;AAC1D,WAAO,IAAI,eAAyB;GACpC;GACD,KAAK,mBAAmB,UAAU;IACjC,MAAM,EAAE,mBAAmB,GAAG,MAAM,OAAO;AAC3C,WAAO,kBAAkB,qBAA+B,cAAc;GACtE;GACD,KAAK,mBAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,MAAM,OAAO;AACtC,WAAO,aAAa,qBAA+B,cAAc;GACjE;GACD,KAAK,mBAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,MAAM,OAAO;AACtC,WAAO,aAAa,qBAA+B,cAAc;GACjE;GACD,KAAK,mBAAmB,QAAQ;IAC/B,MAAM,EAAE,iBAAiB,GAAG,MAAM,OAAO;AACzC,WAAO,gBAAgB,qBAA+B,cAAc;GACpE;GAED,QACC,OAAM,IAAI,OAAO,oCAAoC,IAAI,SAAS;EACnE;CACD;;;;;CAMD,aAAa,eACZC,YACoC;AACpC,UAAQ,WAAW,MAAnB;GACC,KAAK,mBAAmB,OAAO;IAC9B,MAAM,EAAE,gBAAgB,GAAG,MAAM,OAAO;IACxC,MAAM,EAAE,iBAAiB,GAAG,MAAM,OAAO;AACzC,WAAO,IAAI,eACV;GAED;GACD,KAAK,mBAAmB,UAAU;IACjC,MAAM,EAAE,mBAAmB,GAAG,MAAM,OAAO;IAC3C,MAAM,EAAE,oBAAoB,GAAG,MAAM,OAAO;AAC5C,WAAO,IAAI,kBACV;GAED;GACD,KAAK,mBAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,MAAM,OAAO;IACtC,MAAM,EAAE,eAAe,GAAG,MAAM,OAAO;AACvC,WAAO,IAAI,aACV;GAED;GACD,KAAK,mBAAmB,KAAK;IAC5B,MAAM,EAAE,cAAc,GAAG,MAAM,OAAO;IACtC,MAAM,EAAE,eAAe,GAAG,MAAM,OAAO;AACvC,WAAO,IAAI,aACV;GAED;GACD,KAAK,mBAAmB,QAAQ;IAC/B,MAAM,EAAE,iBAAiB,GAAG,MAAM,OAAO;IACzC,MAAM,EAAE,kBAAkB,GAAG,MAAM,OAAO;AAC1C,WAAO,IAAI,gBACV;GAED;GACD,QACC,OAAM,IAAI,OAAO,+BAA+B,WAAW,KAAK;EACjE;CACD;AACD"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"Publisher-DDee6xau.d.cts","names":[],"sources":["../src/Publisher.ts"],"sourcesContent":[],"mappings":";;;cAOa,SAAA;EAAA;;;;EAQkC,OACpB,oBAAA,CAAA,iBAHR,kBAGQ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,aAAA,EADV,8BACU,CAAA,EAAvB,OAAuB,CAAf,cAAe,CAAA,QAAA,CAAA,CAAA;EAAQ;;;;EAoCN,OACF,cAAA,CAAA,iBAFmB,kBAEnB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,UAAA,EADb,eACa,CAAA,EAAvB,OAAuB,CAAf,cAAe,CAAA,QAAA,CAAA,CAAA;;AAAvB,KA2CQ,8BAAA,GA3CR,GA4CA,kBA5CA,MAAA,MAAA,EAAA;AAAO"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"Publisher-VHumMkrP.d.mts","names":[],"sources":["../src/Publisher.ts"],"sourcesContent":[],"mappings":";;;cAOa,SAAA;EAAA;;;;EAQkC,OACpB,oBAAA,CAAA,iBAHR,kBAGQ,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,aAAA,EADV,8BACU,CAAA,EAAvB,OAAuB,CAAf,cAAe,CAAA,QAAA,CAAA,CAAA;EAAQ;;;;EAoCN,OACF,cAAA,CAAA,iBAFmB,kBAEnB,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,CAAA,UAAA,EADb,eACa,CAAA,EAAvB,OAAuB,CAAf,cAAe,CAAA,QAAA,CAAA,CAAA;;AAAvB,KA2CQ,8BAAA,GA3CR,GA4CA,kBA5CA,MAAA,MAAA,EAAA;AAAO"}