@ikonintegration/ikapi 5.0.3 → 5.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikonintegration/ikapi",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/BaseEvent/Launchable/ContainerExec.ts

@@ -1,7 +1,6 @@
 import { Context } from 'aws-lambda'
 
 import { LaunchableHandlerType } from './types.js'
-import Response from '../../API/Response.js'
 
 /**
  * Represents a ContainerExecution class that handles the execution of a launchable handler.

package/src/Mailer/Mailer.ts

@@ -1,27 +1,25 @@
-import * as SES from '@aws-sdk/client-ses'
-import { defaultProvider } from '@aws-sdk/credential-provider-node'
-import Email from 'email-templates'
-import nodemailer from 'nodemailer'
-import type SESTransport from 'nodemailer/lib/ses-transport'
+import * as SES from "@aws-sdk/client-ses";
+import { defaultProvider } from "@aws-sdk/credential-provider-node";
+import Email from "email-templates";
+import nodemailer from "nodemailer";
+import type SESTransport from "nodemailer/lib/ses-transport";
 
 export default class Mailer {
   /**
    * The starting point of a range.
    * @type {string}
    */
-  private readonly from: string
+  private readonly from: string;
   /**
    * The default file template for the application.
    * @type {string}
    */
-  private readonly templateDefaultFile: string = 'html'
+  private readonly templateDefaultFile: string = "html";
   /**
    * The transporter object used for sending emails using the AWS SES service.
    * @type {ReturnType<typeof nodemailer.createTransport<SESTransport.SentMessageInfo>>}
    */
-  private readonly transporter: ReturnType<
-    typeof nodemailer.createTransport<SESTransport.SentMessageInfo>
-  >
+  private readonly transporter: ReturnType<typeof nodemailer.createTransport<SESTransport.SentMessageInfo>>;
 
   /**
    * Constructs a new instance of the EmailSender class.
@@ -30,17 +28,17 @@ export default class Mailer {
    * @returns None
    */
   constructor(defaultFrom: string, region: string) {
-    this.from = defaultFrom
+    this.from = defaultFrom;
     this.transporter = nodemailer.createTransport({
       SES: {
         ses: new SES.SESClient({
           credentials: defaultProvider(),
-          apiVersion: '2010-12-01',
+          apiVersion: "2010-12-01",
           region,
         }),
         aws: SES,
       },
-    })
+    });
   }
 
   /**
@@ -77,17 +75,17 @@ export default class Mailer {
       },
       transport: optionalTransport || this.transporter,
       send: true,
-    })
+    });
     //
-    let resp = null
+    let resp = null;
     try {
-      resp = await email.send()
-      console.debug('Mailer resp:', resp)
+      resp = await email.send();
+      console.debug("Mailer resp:", resp);
     } catch (e) {
-      console.error('Mailer error:', e)
-      throw e
+      console.error("Mailer error:", e);
+      throw e;
     }
-    return resp
+    return resp;
   }
 
   /**
@@ -99,6 +97,7 @@ export default class Mailer {
    * @param {string} [optionalFrom] - The email address to send the email from.
    * @param {string} [optionalReplyTo] - The email address to set as the reply-to address.
    * @param {any[]} [optionalAttachments] - An array
+   * @param {Record<string, string>} [optionalHeaders] - Optional headers to be added to the message. Passed in a key value object.
    */
   public async sendTemplatedEmail(
     to: string | Array<string>,
@@ -109,11 +108,13 @@ export default class Mailer {
     optionalReplyTo?: string,
     // TODO: improve attachment type -> Attachment
     optionalAttachments?: any[],
+    optionalHeaders?: Record<string, string>,
     optionalTransport?: Email.NodeMailerTransportOptions
   ) {
     //Generate emails
     const email = new Email({
       message: {
+        ...(optionalHeaders ? { headers: optionalHeaders } : {}),
         from: optionalFrom || this.from,
         to: to,
         ...(optionalAttachments ? { attachments: optionalAttachments } : {}),
@@ -122,18 +123,18 @@ export default class Mailer {
       },
       transport: optionalTransport || this.transporter,
       send: true,
-    })
+    });
     //
-    let resp = null
+    let resp = null;
     try {
-      const chosenTemplate = await this.chooseTemplate(templates, data)
-      resp = await email.send({ template: chosenTemplate, locals: data })
-      console.debug('Mailer resp:', resp)
+      const chosenTemplate = await this.chooseTemplate(templates, data);
+      resp = await email.send({ template: chosenTemplate, locals: data });
+      console.debug("Mailer resp:", resp);
     } catch (e) {
-      console.error('Mailer error:', e)
-      throw e
+      console.error("Mailer error:", e);
+      throw e;
     }
-    return resp
+    return resp;
   }
 
   /**
@@ -144,12 +145,7 @@ export default class Mailer {
    * @param {string} password - The password for authentication with the SMTP server.
    * @returns {Email.NodeMailerTransportOptions} - The SMTP transporter object.
    */
-  public newSMTPTransporter(
-    host: string,
-    portNumber: number,
-    user: string,
-    password: string
-  ): Email.NodeMailerTransportOptions {
+  public newSMTPTransporter(host: string, portNumber: number, user: string, password: string): Email.NodeMailerTransportOptions {
     const smtpTransporter = nodemailer.createTransport({
       host: host,
       port: portNumber,
@@ -158,8 +154,8 @@ export default class Mailer {
         user: user,
         pass: password,
       },
-    })
-    return smtpTransporter
+    });
+    return smtpTransporter;
   }
 
   /**
@@ -173,15 +169,12 @@ export default class Mailer {
     if (Array.isArray(templates)) {
       //For each template check if can render it
       for (const template of templates) {
-        if (await this.canRenderTemplate(template, data)) return template
+        if (await this.canRenderTemplate(template, data)) return template;
       }
     } else if (templates) {
-      if (await this.canRenderTemplate(templates, data)) return templates
+      if (await this.canRenderTemplate(templates, data)) return templates;
     }
-    throw new Error(
-      `Could not render email with template ${templates} and following data. Please, check logs above! ` +
-        JSON.stringify(data, null, 2)
-    )
+    throw new Error(`Could not render email with template ${templates} and following data. Please, check logs above! ` + JSON.stringify(data, null, 2));
   }
 
   /**
@@ -191,11 +184,8 @@ export default class Mailer {
    * @returns {Promise<boolean>} - A promise that resolves to true if the template can be rendered, false otherwise.
    */
   private async canRenderTemplate(template: string, data: object): Promise<boolean> {
-    const validRenderResp = await Mailer.renderTemplate(
-      `${template}/${this.templateDefaultFile}`,
-      data
-    )
-    return validRenderResp != null
+    const validRenderResp = await Mailer.renderTemplate(`${template}/${this.templateDefaultFile}`, data);
+    return validRenderResp != null;
   }
 
   /**
@@ -205,13 +195,13 @@ export default class Mailer {
    * @returns {Promise<boolean>} - A promise that resolves to true if the template was rendered successfully, false otherwise.
    */
   public static async renderTemplate(template: string, data: object): Promise<any> {
-    let validRenderResp: string | null = null
+    let validRenderResp: string | null = null;
     try {
-      const email = new Email()
-      validRenderResp = await email.render(`${template}`, data)
+      const email = new Email();
+      validRenderResp = await email.render(`${template}`, data);
     } catch (e) {
-      console.log(`Error while checking renderability of email template ${template}`, e)
+      console.log(`Error while checking renderability of email template ${template}`, e);
     }
-    return validRenderResp
+    return validRenderResp;
   }
 }

package/dist/index.d.ts

@@ -1,17 +0,0 @@
-import { HttpMethod } from './src/API/Request.js';
-import Response, { ResponseErrorType } from './src/API/Response.js';
-import DynamoTransaction from './src/BaseEvent/DynamoTransaction.js';
-import EventProcessor from './src/BaseEvent/EventProcessor.js';
-import Launchable from './src/BaseEvent/Launchable/index.js';
-import Process from './src/BaseEvent/Process.js';
-import StepTransaction from './src/BaseEvent/StepTransaction.js';
-import Transaction, { TransactionConfig } from './src/BaseEvent/Transaction.js';
-import Redis from './src/Cache/Redis.js';
-import Configuration from './src/Config/Configuration.js';
-import Crypto from './src/Crypto/Crypto.js';
-import * as Database from './src/Database/index.js';
-import Mailer from './src/Mailer/Mailer.js';
-import Router, { Route } from './src/Server/Router.js';
-import AsyncSingleton from './src/Util/AsyncSingleton.js';
-import Utils from './src/Util/Utils.js';
-export { Transaction, Process, EventProcessor, DynamoTransaction, StepTransaction, Launchable, Router, Route, HttpMethod, Mailer, Crypto, Configuration, Redis, Database, Response, ResponseErrorType, Utils, AsyncSingleton, TransactionConfig, };

package/dist/index.js

@@ -1,28 +0,0 @@
-import { HttpMethod } from './src/API/Request.js';
-import Response from './src/API/Response.js';
-import DynamoTransaction from './src/BaseEvent/DynamoTransaction.js';
-import EventProcessor from './src/BaseEvent/EventProcessor.js';
-import Launchable from './src/BaseEvent/Launchable/index.js';
-import Process from './src/BaseEvent/Process.js';
-import StepTransaction from './src/BaseEvent/StepTransaction.js';
-import Transaction from './src/BaseEvent/Transaction.js';
-import Redis from './src/Cache/Redis.js';
-import Configuration from './src/Config/Configuration.js';
-import Crypto from './src/Crypto/Crypto.js';
-import * as Database from './src/Database/index.js';
-import Mailer from './src/Mailer/Mailer.js';
-import Router from './src/Server/Router.js';
-import AsyncSingleton from './src/Util/AsyncSingleton.js';
-import Utils from './src/Util/Utils.js';
-export { 
-// Base Events
-Transaction, Process, EventProcessor, DynamoTransaction, StepTransaction, Launchable, 
-// Http
-Router, HttpMethod, 
-// Modules
-Mailer, Crypto, Configuration, Redis, Database, 
-// API
-Response, 
-// Helpers
-Utils, AsyncSingleton, };
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,QAA+B,MAAM,uBAAuB,CAAA;AACnE,OAAO,iBAAiB,MAAM,sCAAsC,CAAA;AACpE,OAAO,cAAc,MAAM,mCAAmC,CAAA;AAC9D,OAAO,UAAU,MAAM,qCAAqC,CAAA;AAC5D,OAAO,OAAO,MAAM,4BAA4B,CAAA;AAChD,OAAO,eAAe,MAAM,oCAAoC,CAAA;AAChE,OAAO,WAAkC,MAAM,gCAAgC,CAAA;AAC/E,OAAO,KAAK,MAAM,sBAAsB,CAAA;AACxC,OAAO,aAAa,MAAM,+BAA+B,CAAA;AACzD,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAC3C,OAAO,KAAK,QAAQ,MAAM,yBAAyB,CAAA;AACnD,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAC3C,OAAO,MAAiB,MAAM,wBAAwB,CAAA;AACtD,OAAO,cAAc,MAAM,8BAA8B,CAAA;AACzD,OAAO,KAAK,MAAM,qBAAqB,CAAA;AAEvC,OAAO;AACL,cAAc;AACd,WAAW,EACX,OAAO,EACP,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,UAAU;AACV,OAAO;AACP,MAAM,EAEN,UAAU;AACV,UAAU;AACV,MAAM,EACN,MAAM,EACN,aAAa,EACb,KAAK,EACL,QAAQ;AACR,MAAM;AACN,QAAQ;AAER,UAAU;AACV,KAAK,EACL,cAAc,GAEf,CAAA"}