core-services-sdk 1.3.1 → 1.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "main": "src/index.js",
   "type": "module",
   "scripts": {

package/src/mailer/transport.factory.js

@@ -2,9 +2,33 @@ import aws from 'aws-sdk'
 import nodemailer from 'nodemailer'
 import sgTransport from 'nodemailer-sendgrid-transport'
 
+/**
+ * Factory for creating Nodemailer transporters based on configuration.
+ */
 export class TransportFactory {
   /**
-   * @param {object} config
+   * Create a Nodemailer transporter
+   *
+   * @param {object} config - Transport configuration object
+   * @param {'smtp' | 'gmail' | 'sendgrid' | 'ses'} config.type - Type of email transport
+   *
+   * For type 'smtp':
+   * @param {string} config.host - SMTP server host
+   * @param {number} config.port - SMTP server port
+   * @param {boolean} config.secure - Use TLS
+   * @param {{ user: string, pass: string }} config.auth - SMTP auth credentials
+   *
+   * For type 'gmail':
+   * @param {{ user: string, pass: string }} config.auth - Gmail credentials
+   *
+   * For type 'sendgrid':
+   * @param {string} config.apiKey - SendGrid API key
+   *
+   * For type 'ses':
+   * @param {string} config.accessKeyId - AWS access key
+   * @param {string} config.secretAccessKey - AWS secret
+   * @param {string} config.region - AWS region
+   *
    * @returns {import('nodemailer').Transporter}
    */
   static create(config) {

package/src/rabbit-mq/index.js

@@ -47,25 +47,30 @@ const parseMessage = (msgInfo) => {
 
 /**
  * Subscribes to a queue to receive messages.
- * @param {{
- *   channel: amqp.Channel,
- *   queue: string,
- *   onReceive: (data: any) => Promise<void>,
- *   log: Log,
- *   nackOnError?: boolean
- * }} options
+ *
+ * @param {Object} options
+ * @param {import('amqplib').Channel} options.channel - RabbitMQ channel
+ * @param {string} options.queue - Queue name to subscribe to
+ * @param {(data: any) => Promise<void>} options.onReceive - Async handler for incoming message
+ * @param {Log} options.log - Logging utility
+ * @param {boolean} [options.nackOnError=false] - Whether to nack the message on error (default: false)
+ * @param {number} [options.prefetch=1] - Max unacked messages per consumer (default: 1)
+ *
  * @returns {Promise<void>}
  */
 export const subscribeToQueue = async ({
   log,
   queue,
   channel,
+  prefetch = 1,
   onReceive,
   nackOnError = false,
 }) => {
   try {
     await channel.assertQueue(queue, { durable: true })
 
+    !!prefetch && (await channel.prefetch(prefetch))
+
     channel.consume(queue, async (msgInfo) => {
       if (!msgInfo) return
 

package/tests/transport.factory.unit.test.js

@@ -4,29 +4,36 @@ import { describe, it, expect, vi } from 'vitest'
 import sgTransport from 'nodemailer-sendgrid-transport'
 
 vi.mock('nodemailer', () => {
+  const createTransport = vi.fn((options) => ({
+    type: 'mock-transport',
+    options,
+  }))
   return {
+    __esModule: true,
+    default: { createTransport },
+    createTransport,
+  }
+})
+
+vi.mock('aws-sdk', () => {
+  return {
+    __esModule: true,
     default: {
-      createTransport: vi.fn(() => ({ type: 'mock-transport' })),
+      SES: vi.fn(() => 'mocked-ses'),
     },
   }
 })
 
-vi.mock('aws-sdk', async () => {
-  const actual = await vi.importActual('aws-sdk')
+vi.mock('nodemailer-sendgrid-transport', () => {
   return {
-    ...actual,
-    SES: vi.fn().mockImplementation(() => 'mocked-ses'),
+    __esModule: true,
+    default: vi.fn((opts) => ({
+      sendgrid: true,
+      options: opts,
+    })),
   }
 })
 
-vi.mock('nodemailer-sendgrid-transport', () => ({
-  __esModule: true,
-  default: vi.fn().mockImplementation((opts) => {
-    const transport = { sendgrid: true, options: opts }
-    return transport
-  }),
-}))
-
 import { TransportFactory } from '../src/mailer/transport.factory.js'
 describe('TransportFactory', () => {
   it('should create smtp transport', () => {
@@ -69,8 +76,27 @@ describe('TransportFactory', () => {
     }
 
     const transport = TransportFactory.create(config)
-    expect(transport.sendgrid).toBe(true)
-    expect(transport.options.auth.api_key).toBe(config.apiKey)
+
+    expect(nodemailer.createTransport).toHaveBeenCalled()
+
+    const args = nodemailer.createTransport.mock.calls[0][0]
+
+    expect(args).toEqual({
+      sendgrid: true,
+      options: {
+        auth: { api_key: config.apiKey },
+      },
+    })
+
+    expect(transport).toEqual({
+      type: 'mock-transport',
+      options: {
+        sendgrid: true,
+        options: {
+          auth: { api_key: config.apiKey },
+        },
+      },
+    })
   })
 
   it('should create ses transport', () => {
@@ -81,12 +107,17 @@ describe('TransportFactory', () => {
       region: 'us-west-2',
     }
 
-    const transport = TransportFactory.create(config)
+    TransportFactory.create(config)
+
     expect(nodemailer.createTransport).toHaveBeenCalled()
+    const args = nodemailer.createTransport.mock.calls[0][0]
 
-    expect(nodemailer.createTransport.mock.calls[0][0]).toHaveProperty(
-      'SES.ses',
-    )
+    expect(args).toEqual({
+      SES: {
+        ses: 'mocked-ses',
+        aws: expect.anything(),
+      },
+    })
   })
 
   it('should throw error for unsupported type', () => {