core-services-sdk 1.3.2 → 1.3.3

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "core-services-sdk",
3
- "version": "1.3.2",
3
+ "version": "1.3.3",
4
4
  "main": "src/index.js",
5
5
  "type": "module",
6
6
  "scripts": {
@@ -2,9 +2,33 @@ import aws from 'aws-sdk'
2
2
  import nodemailer from 'nodemailer'
3
3
  import sgTransport from 'nodemailer-sendgrid-transport'
4
4
 
5
+ /**
6
+ * Factory for creating Nodemailer transporters based on configuration.
7
+ */
5
8
  export class TransportFactory {
6
9
  /**
7
- * @param {object} config
10
+ * Create a Nodemailer transporter
11
+ *
12
+ * @param {object} config - Transport configuration object
13
+ * @param {'smtp' | 'gmail' | 'sendgrid' | 'ses'} config.type - Type of email transport
14
+ *
15
+ * For type 'smtp':
16
+ * @param {string} config.host - SMTP server host
17
+ * @param {number} config.port - SMTP server port
18
+ * @param {boolean} config.secure - Use TLS
19
+ * @param {{ user: string, pass: string }} config.auth - SMTP auth credentials
20
+ *
21
+ * For type 'gmail':
22
+ * @param {{ user: string, pass: string }} config.auth - Gmail credentials
23
+ *
24
+ * For type 'sendgrid':
25
+ * @param {string} config.apiKey - SendGrid API key
26
+ *
27
+ * For type 'ses':
28
+ * @param {string} config.accessKeyId - AWS access key
29
+ * @param {string} config.secretAccessKey - AWS secret
30
+ * @param {string} config.region - AWS region
31
+ *
8
32
  * @returns {import('nodemailer').Transporter}
9
33
  */
10
34
  static create(config) {