@ikonintegration/ikapi 4.0.0-alpha8 → 5.0.0-alpha1

package/dist/src/Mailer/Mailer.js

@@ -0,0 +1,182 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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';
+export default class Mailer {
+    /**
+     * Constructs a new instance of the EmailSender class.
+     * @param {string} defaultFrom - The default "from" email address.
+     * @param {string} region - The AWS region to use for sending emails.
+     * @returns None
+     */
+    constructor(defaultFrom, region) {
+        /**
+         * The default file template for the application.
+         * @type {string}
+         */
+        this.templateDefaultFile = 'html';
+        this.from = defaultFrom;
+        this.transporter = nodemailer.createTransport({
+            SES: {
+                ses: new SES.SESClient({
+                    credentials: defaultProvider(),
+                    apiVersion: '2010-12-01',
+                    region,
+                }),
+                aws: SES,
+            },
+        });
+    }
+    /**
+     * Sends a raw email with the specified parameters.
+     * @param {string | Array<string>} to - The recipient(s) of the email.
+     * @param {string} htmlMessage - The HTML content of the email.
+     * @param {string} subject - The subject of the email.
+     * @param {string | Array<string>} [optionalCC] - The optional CC recipient(s) of the email.
+     * @param {string} [optionalFrom] - The optional sender of the email. If not provided, the default sender will be used.
+     * @param {string} [optionalReplyTo] - The optional reply-to address for the email.
+     * @param {any[]} [optionalAttachments] - The optional attachments to include
+     */
+    sendRawEmail(to, htmlMessage, subject, optionalCC, optionalFrom, optionalReplyTo, 
+    // TODO: improve attachment type -> Attachment
+    optionalAttachments, optionalTransport) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //Generate emails
+            const email = new Email({
+                message: Object.assign(Object.assign(Object.assign({ from: optionalFrom || this.from, to: to, html: htmlMessage, subject }, (optionalAttachments ? { attachments: optionalAttachments } : {})), (optionalCC ? { cc: optionalCC } : {})), (optionalReplyTo ? { replyTo: optionalReplyTo } : {})),
+                transport: optionalTransport || this.transporter,
+                send: true,
+            });
+            //
+            let resp = null;
+            try {
+                resp = yield email.send();
+                console.debug('Mailer resp:', resp);
+            }
+            catch (e) {
+                console.error('Mailer error:', e);
+                throw e;
+            }
+            return resp;
+        });
+    }
+    /**
+     * Sends a templated email to the specified recipients.
+     * @param {string | Array<string>} to - The email address(es) of the recipient(s).
+     * @param {string | Array<string>} templates - The template(s) to use for the email.
+     * @param {object} data - The data to be used in the email template.
+     * @param {string | Array<string>} [optionalCC] - The email address(es) to CC.
+     * @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
+     */
+    sendTemplatedEmail(to, templates, data, optionalCC, optionalFrom, optionalReplyTo, 
+    // TODO: improve attachment type -> Attachment
+    optionalAttachments, optionalTransport) {
+        return __awaiter(this, void 0, void 0, function* () {
+            //Generate emails
+            const email = new Email({
+                message: Object.assign(Object.assign(Object.assign({ from: optionalFrom || this.from, to: to }, (optionalAttachments ? { attachments: optionalAttachments } : {})), (optionalCC ? { cc: optionalCC } : {})), (optionalReplyTo ? { replyTo: optionalReplyTo } : {})),
+                transport: optionalTransport || this.transporter,
+                send: true,
+            });
+            //
+            let resp = null;
+            try {
+                const chosenTemplate = yield this.chooseTemplate(templates, data);
+                resp = yield email.send({ template: chosenTemplate, locals: data });
+                console.debug('Mailer resp:', resp);
+            }
+            catch (e) {
+                console.error('Mailer error:', e);
+                throw e;
+            }
+            return resp;
+        });
+    }
+    /**
+     * Creates a new SMTP transporter for sending emails using NodeMailer.
+     * @param {string} host - The SMTP server host.
+     * @param {number} portNumber - The port number to connect to the SMTP server.
+     * @param {string} user - The username for authentication with the SMTP server.
+     * @param {string} password - The password for authentication with the SMTP server.
+     * @returns {Email.NodeMailerTransportOptions} - The SMTP transporter object.
+     */
+    newSMTPTransporter(host, portNumber, user, password) {
+        const smtpTransporter = nodemailer.createTransport({
+            host: host,
+            port: portNumber,
+            connectionTimeout: 2000,
+            auth: {
+                user: user,
+                pass: password,
+            },
+        });
+        return smtpTransporter;
+    }
+    /**
+     * Chooses a template from the given array of templates or a single template string based on whether it can be rendered with the provided data.
+     * @param {string | Array<string>} templates - The template(s) to choose from.
+     * @param {object} data - The data to be used for rendering the template.
+     * @returns {Promise<string>} - The chosen template.
+     * @throws {Error} - If no template can be rendered with the provided data.
+     */
+    chooseTemplate(templates, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (Array.isArray(templates)) {
+                //For each template check if can render it
+                for (const template of templates) {
+                    if (yield this.canRenderTemplate(template, data))
+                        return template;
+                }
+            }
+            else if (templates) {
+                if (yield 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));
+        });
+    }
+    /**
+     * Checks if a given email template can be rendered with the provided data.
+     * @param {string} template - The name of the email template.
+     * @param {object} data - The data to be used for rendering the template.
+     * @returns {Promise<boolean>} - A promise that resolves to true if the template can be rendered, false otherwise.
+     */
+    canRenderTemplate(template, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const validRenderResp = yield Mailer.renderTemplate(`${template}/${this.templateDefaultFile}`, data);
+            return validRenderResp != null;
+        });
+    }
+    /**
+     * Renders the given template with the provided data using the Email class.
+     * @param {string} template - The name or path of the template to render.
+     * @param {object} data - The data object to pass to the template.
+     * @returns {Promise<boolean>} - A promise that resolves to true if the template was rendered successfully, false otherwise.
+     */
+    static renderTemplate(template, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let validRenderResp = null;
+            try {
+                const email = new Email();
+                validRenderResp = yield email.render(`${template}`, data);
+            }
+            catch (e) {
+                console.log(`Error while checking renderability of email template ${template}`, e);
+            }
+            return validRenderResp;
+        });
+    }
+}
+//# sourceMappingURL=Mailer.js.map

package/dist/src/Mailer/Mailer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Mailer.js","sourceRoot":"","sources":["../../../src/Mailer/Mailer.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,KAAK,MAAM,iBAAiB,CAAA;AACnC,OAAO,UAAU,MAAM,YAAY,CAAA;AAGnC,MAAM,CAAC,OAAO,OAAO,MAAM;IAmBzB;;;;;OAKG;IACH,YAAY,WAAmB,EAAE,MAAc;QAnB/C;;;WAGG;QACc,wBAAmB,GAAW,MAAM,CAAA;QAgBnD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,eAAe,CAAC;YAC5C,GAAG,EAAE;gBACH,GAAG,EAAE,IAAI,GAAG,CAAC,SAAS,CAAC;oBACrB,WAAW,EAAE,eAAe,EAAE;oBAC9B,UAAU,EAAE,YAAY;oBACxB,MAAM;iBACP,CAAC;gBACF,GAAG,EAAE,GAAG;aACT;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;OASG;IACU,YAAY,CACvB,EAA0B,EAC1B,WAAmB,EACnB,OAAe,EACf,UAAmC,EACnC,YAAqB,EACrB,eAAwB;IACxB,8CAA8C;IAC9C,mBAA2B,EAC3B,iBAAoD;;YAEpD,iBAAiB;YACjB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC;gBACtB,OAAO,8CACL,IAAI,EAAE,YAAY,IAAI,IAAI,CAAC,IAAI,EAC/B,EAAE,EAAE,EAAE,EACN,IAAI,EAAE,WAAW,EACjB,OAAO,IACJ,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACjE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACtC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACzD;gBACD,SAAS,EAAE,iBAAiB,IAAI,IAAI,CAAC,WAAW;gBAChD,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;YACF,EAAE;YACF,IAAI,IAAI,GAAG,IAAI,CAAA;YACf,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;gBACzB,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;gBACjC,MAAM,CAAC,CAAA;YACT,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,kBAAkB,CAC7B,EAA0B,EAC1B,SAAiC,EACjC,IAAY,EACZ,UAAmC,EACnC,YAAqB,EACrB,eAAwB;IACxB,8CAA8C;IAC9C,mBAA2B,EAC3B,iBAAoD;;YAEpD,iBAAiB;YACjB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC;gBACtB,OAAO,8CACL,IAAI,EAAE,YAAY,IAAI,IAAI,CAAC,IAAI,EAC/B,EAAE,EAAE,EAAE,IACH,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACjE,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GACtC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACzD;gBACD,SAAS,EAAE,iBAAiB,IAAI,IAAI,CAAC,WAAW;gBAChD,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;YACF,EAAE;YACF,IAAI,IAAI,GAAG,IAAI,CAAA;YACf,IAAI,CAAC;gBACH,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;gBACjE,IAAI,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;gBACnE,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAA;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC,CAAC,CAAA;gBACjC,MAAM,CAAC,CAAA;YACT,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAED;;;;;;;OAOG;IACI,kBAAkB,CACvB,IAAY,EACZ,UAAkB,EAClB,IAAY,EACZ,QAAgB;QAEhB,MAAM,eAAe,GAAG,UAAU,CAAC,eAAe,CAAC;YACjD,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,UAAU;YAChB,iBAAiB,EAAE,IAAI;YACvB,IAAI,EAAE;gBACJ,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,QAAQ;aACf;SACF,CAAC,CAAA;QACF,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;OAMG;IACW,cAAc,CAAC,SAAiC,EAAE,IAAY;;YAC1E,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,0CAA0C;gBAC1C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBACjC,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,IAAI,CAAC;wBAAE,OAAO,QAAQ,CAAA;gBACnE,CAAC;YACH,CAAC;iBAAM,IAAI,SAAS,EAAE,CAAC;gBACrB,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,CAAC;oBAAE,OAAO,SAAS,CAAA;YACrE,CAAC;YACD,MAAM,IAAI,KAAK,CACb,wCAAwC,SAAS,iDAAiD;gBAChG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAChC,CAAA;QACH,CAAC;KAAA;IAED;;;;;OAKG;IACW,iBAAiB,CAAC,QAAgB,EAAE,IAAY;;YAC5D,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,cAAc,CACjD,GAAG,QAAQ,IAAI,IAAI,CAAC,mBAAmB,EAAE,EACzC,IAAI,CACL,CAAA;YACD,OAAO,eAAe,IAAI,IAAI,CAAA;QAChC,CAAC;KAAA;IAED;;;;;OAKG;IACI,MAAM,CAAO,cAAc,CAAC,QAAgB,EAAE,IAAY;;YAC/D,IAAI,eAAe,GAAkB,IAAI,CAAA;YACzC,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAA;gBACzB,eAAe,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAA;YAC3D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,GAAG,CAAC,wDAAwD,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAA;YACpF,CAAC;YACD,OAAO,eAAe,CAAA;QACxB,CAAC;KAAA;CACF"}

package/dist/src/Publisher/Publisher.d.ts

@@ -0,0 +1,39 @@
+import { PublishCommandOutput } from '@aws-sdk/client-sns';
+/**
+ * Represents the configuration options for a publisher.
+ * @typedef {Object} PublisherConfig
+ * @property {string} [region] - The region where the publisher is located.
+ */
+export type PublisherConfig = {
+    region?: string;
+};
+/**
+ * Represents a publisher that can publish messages to an SNS topic.
+ */
+export default class Publisher {
+    /**
+     * The region of the object or entity.
+     * @private
+     * @type {string}
+     */
+    private region;
+    /**
+     * Constructs a new instance of the Publisher class.
+     * @param {PublisherConfig} [config] - The configuration object for the Publisher.
+     * @returns None
+     */
+    constructor(config?: PublisherConfig);
+    /**
+     * Publishes a message on a specified topic.
+     * @param {any} messageObject - The message object to be published.
+     * @param {string} topic - The ARN of the topic to publish the message to.
+     * @param {object} [additionalProps] - Additional properties to include in the publish command.
+     * @returns {Promise<PublishCommandOutput>} - A promise that resolves to the response from the publish command.
+     */
+    publishOnTopic(messageObject: any, topic: string, additionalProps?: object): Promise<PublishCommandOutput | undefined>;
+    /**
+     * Establishes a connection to the SNS client if it does not already exist or if the region has changed.
+     * @returns None
+     */
+    private connect;
+}

package/dist/src/Publisher/Publisher.js

@@ -0,0 +1,77 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { SNSClient, PublishCommand, } from '@aws-sdk/client-sns';
+import sha1 from 'sha1';
+//reusable client
+/**
+ * A variable that holds the connection to the SNS client for publishing messages.
+ * @type {SNSClient | null}
+ */
+// eslint-disable-next-line no-var
+let PUBLISHER_CONN = null;
+/**
+ * The connection hash for the publisher. It is initially set to null.
+ * @type {string | null}
+ */
+// eslint-disable-next-line no-var
+let PUBLISHER_CONN_HASH = null;
+/**
+ * Represents a publisher that can publish messages to an SNS topic.
+ */
+export default class Publisher {
+    /**
+     * Constructs a new instance of the Publisher class.
+     * @param {PublisherConfig} [config] - The configuration object for the Publisher.
+     * @returns None
+     */
+    constructor(config) {
+        if (config && config.region) {
+            this.region = config.region;
+            // console.debug(`Using region: ${this.region}`);
+        }
+    }
+    /**
+     * Publishes a message on a specified topic.
+     * @param {any} messageObject - The message object to be published.
+     * @param {string} topic - The ARN of the topic to publish the message to.
+     * @param {object} [additionalProps] - Additional properties to include in the publish command.
+     * @returns {Promise<PublishCommandOutput>} - A promise that resolves to the response from the publish command.
+     */
+    publishOnTopic(messageObject, topic, additionalProps) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let resp = undefined;
+            try {
+                this.connect();
+                //Send to SNS
+                const params = Object.assign({ Message: JSON.stringify(messageObject), TopicArn: topic }, (additionalProps ? additionalProps : {}));
+                resp = yield PUBLISHER_CONN.send(new PublishCommand(params));
+            }
+            catch (e) {
+                console.error(`Error while publishing into topic ${topic} with error: ${e}`);
+            }
+            console.debug('Publisher resp', resp);
+            return resp;
+        });
+    }
+    /**
+     * Establishes a connection to the SNS client if it does not already exist or if the region has changed.
+     * @returns None
+     */
+    connect() {
+        if ((!PUBLISHER_CONN && !PUBLISHER_CONN_HASH) || PUBLISHER_CONN_HASH != sha1(this.region)) {
+            PUBLISHER_CONN = new SNSClient({
+                apiVersion: '2010-03-31',
+                region: this.region,
+            });
+            PUBLISHER_CONN_HASH = sha1(this.region).toString();
+        }
+    }
+}
+//# sourceMappingURL=Publisher.js.map

package/dist/src/Publisher/Publisher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Publisher.js","sourceRoot":"","sources":["../../../src/Publisher/Publisher.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,cAAc,GAGf,MAAM,qBAAqB,CAAA;AAC5B,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,iBAAiB;AACjB;;;GAGG;AACH,kCAAkC;AAClC,IAAI,cAAc,GAAqB,IAAI,CAAA;AAC3C;;;GAGG;AACH,kCAAkC;AAClC,IAAI,mBAAmB,GAAkB,IAAI,CAAA;AAW7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAQ5B;;;;OAIG;IACH,YAAY,MAAwB;QAClC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAC3B,iDAAiD;QACnD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACU,cAAc,CACzB,aAAkB,EAClB,KAAa,EACb,eAAwB;;YAExB,IAAI,IAAI,GAAqC,SAAS,CAAA;YACtD,IAAI,CAAC;gBACH,IAAI,CAAC,OAAO,EAAE,CAAA;gBACd,aAAa;gBACb,MAAM,MAAM,mBACV,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EACtC,QAAQ,EAAE,KAAK,IACZ,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5C,CAAA;gBACD,IAAI,GAAG,MAAM,cAAe,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;YAC/D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,qCAAqC,KAAK,gBAAgB,CAAC,EAAE,CAAC,CAAA;YAC9E,CAAC;YACD,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;YACrC,OAAO,IAAI,CAAA;QACb,CAAC;KAAA;IAED;;;OAGG;IACK,OAAO;QACb,IAAI,CAAC,CAAC,cAAc,IAAI,CAAC,mBAAmB,CAAC,IAAI,mBAAmB,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1F,cAAc,GAAG,IAAI,SAAS,CAAC;gBAC7B,UAAU,EAAE,YAAY;gBACxB,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAA;YACF,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAA;QACpD,CAAC;IACH,CAAC;CACF"}

package/dist/src/Server/RouteResolver.d.ts

@@ -0,0 +1,33 @@
+import { AnyRoute, RouterConfig } from './Router.js';
+import { HttpMethod } from '../API/Request.js';
+/**
+ * A class that resolves routes based on the provided configuration.
+ * @class RouteResolver
+ */
+export default class RouteResolver {
+    /**
+     * An object that maps HTTP methods to their corresponding routes.
+     * @property {object} routes - The routes object.
+     * @property {Routes} routes.method - The routes for the specified HTTP method.
+     */
+    private routes;
+    /**
+     * Constructs a new instance of the Router class with the given configuration.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config: RouterConfig);
+    /**
+     * Resolves a route based on the given HTTP method and path.
+     * @param {string} method - The HTTP method of the request.
+     * @param {string} path - The path of the request.
+     * @returns {Route | undefined} - The resolved route or undefined if no route is found.
+     */
+    resolveRoute(method: HttpMethod, path: string): AnyRoute | undefined;
+    /**
+     * Builds the routes for the router based on the given configuration.
+     * @param {RouterConfig} config - The router configuration object.
+     * @returns None
+     */
+    private buildRoutes;
+}

package/dist/src/Server/RouteResolver.js

@@ -0,0 +1,100 @@
+/**
+ * Represents a collection of routes that can be added and resolved.
+ */
+class Routes {
+    /**
+     * Initializes a new instance of the class.
+     * @constructor
+     */
+    constructor() {
+        this.next = {};
+    }
+    /**
+     * Adds a route to the routing system.
+     * @param {Route} route - The route to add.
+     * @param {string[]} parts - The parts of the route path.
+     * @returns None
+     * @throws {Error} If a duplicate route is detected.
+     */
+    addRoute(route, parts) {
+        const first = parts.shift();
+        if (first) {
+            if (first.startsWith(':')) {
+                this.variable = this.variable || new Routes();
+                this.variable.addRoute(route, parts);
+            }
+            else {
+                this.next[first] = this.next[first] || new Routes();
+                this.next[first].addRoute(route, parts);
+            }
+        }
+        else {
+            if (this.current)
+                throw new Error(`Duplicate route: ${route.method}: ${route.path}`);
+            this.current = route;
+        }
+    }
+    /**
+     * Resolves a route based on the given parts.
+     * @param {string[]} parts - An array of route parts.
+     * @returns {Route} The resolved route.
+     */
+    resolveRoute(parts) {
+        var _a;
+        const first = parts.shift();
+        if (first) {
+            if (first in this.next) {
+                return this.next[first].resolveRoute(parts);
+            }
+            return (_a = this.variable) === null || _a === void 0 ? void 0 : _a.resolveRoute(parts);
+        }
+        return this.current;
+    }
+}
+/**
+ * A class that resolves routes based on the provided configuration.
+ * @class RouteResolver
+ */
+export default class RouteResolver {
+    /**
+     * Constructs a new instance of the Router class with the given configuration.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config) {
+        this.routes = {};
+        this.buildRoutes(config);
+    }
+    /**
+     * Resolves a route based on the given HTTP method and path.
+     * @param {string} method - The HTTP method of the request.
+     * @param {string} path - The path of the request.
+     * @returns {Route | undefined} - The resolved route or undefined if no route is found.
+     */
+    resolveRoute(method, path) {
+        var _a;
+        const parts = path.split('/').filter(p => p.length);
+        return (_a = this.routes[method]) === null || _a === void 0 ? void 0 : _a.resolveRoute(parts);
+    }
+    /**
+     * Builds the routes for the router based on the given configuration.
+     * @param {RouterConfig} config - The router configuration object.
+     * @returns None
+     */
+    buildRoutes(config) {
+        const addRoute = (path, route) => {
+            const parts = path.split('/').filter(p => p.length);
+            this.routes[route.method] = this.routes[route.method] || new Routes();
+            this.routes[route.method].addRoute(route, parts);
+        };
+        for (const route of config.routes) {
+            if (Array.isArray(route.path)) {
+                for (const path of route.path)
+                    addRoute(path, route);
+            }
+            else
+                addRoute(route.path, route);
+        }
+    }
+}
+//# sourceMappingURL=RouteResolver.js.map

package/dist/src/Server/RouteResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RouteResolver.js","sourceRoot":"","sources":["../../../src/Server/RouteResolver.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,MAAM;IAkBV;;;OAGG;IACH;QACE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;IAChB,CAAC;IAED;;;;;;OAMG;IACI,QAAQ,CAAC,KAAe,EAAE,KAAe;QAC9C,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;QAC3B,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,MAAM,EAAE,CAAA;gBAC7C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACtC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,MAAM,EAAE,CAAA;gBACnD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;YAEpF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACtB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,KAAe;;QACjC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;QAC3B,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YAC7C,CAAC;YACD,OAAO,MAAA,IAAI,CAAC,QAAQ,0CAAE,YAAY,CAAC,KAAK,CAAC,CAAA;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAQhC;;;;OAIG;IACH,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAChB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,MAAkB,EAAE,IAAY;;QAClD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;QACnD,OAAO,MAAA,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,0CAAE,YAAY,CAAC,KAAK,CAAC,CAAA;IACjD,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,MAAoB;QACtC,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,KAAe,EAAE,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YACnD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,EAAE,CAAA;YACrE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;QACnD,CAAC,CAAA;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI;oBAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YACtD,CAAC;;gBAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;IACH,CAAC;CACF"}

package/dist/src/Server/Router.d.ts

@@ -0,0 +1,157 @@
+import { Server as HTTPServer } from 'http';
+import express from 'express';
+import { z } from 'zod';
+import { HttpMethod } from '../API/Request.js';
+import { ResponseErrorType } from '../API/Response.js';
+import Transaction, { TransactionConfig, TransactionExecution, StringMap } from '../BaseEvent/Transaction.js';
+/**
+ * Represents a route in an API.
+ * @template InputType - The type of the input data for the route.
+ * @template OutputType - The type of the output data for the route.
+ * @property {string} path - The path of the route.
+ * @property {string} method - The HTTP method of the route.
+ * @property {TransactionExecution<Transaction<InputType, OutputType | ResponseErrorType>, OutputType | ResponseErrorType>} handler - The handler function for the route.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[inputSchema] - The input schema for validating the input data.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[pathSchema] - The path schema for validating the path data.
+ * @property {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}[querySchema] - The query schema for validating the query data.
+ */
+export interface Route<InputType = never, OutputType = never, PathParamsType = StringMap, QueryParamsType = StringMap> {
+    /**
+     * Represents a file path as a string.
+     * @param {string} path - The file path.
+     * @returns None
+     */
+    path: string | string[];
+    /**
+     * Represents the method used in an API request.
+     * @type {string}
+     */
+    method: HttpMethod;
+    /**
+     * Represents a handler for executing a transaction with the given input type and output type.
+     * @param {Transaction<InputType, OutputType | ResponseErrorType, PathParamsType, QueryParamsType>} transaction - The transaction to execute.
+     * @param {OutputType | ResponseErrorType} - The output type or response error type of the transaction.
+     */
+    handler: TransactionExecution<Transaction<InputType, OutputType | ResponseErrorType, never, PathParamsType, QueryParamsType>, OutputType | ResponseErrorType>;
+    /**
+     * An optional input schema for validating the structure of the input data.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    inputSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional input schema for validating the structure of the path params.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    pathSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional input schema for validating the structure of the query params.
+     *
+     * @type {?z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>}
+     */
+    querySchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any>;
+    /**
+     * An optional openApi object with extra metadata for docs generation.
+     */
+    openApi?: {
+        summary: string;
+        description: string;
+        tags?: string[];
+        outputSchema?: z.ZodObject<any> | z.ZodUnion<any> | z.ZodIntersection<any, any> | z.ZodType<any>;
+        successCode?: number;
+        security?: {
+            [key: string]: string[] | never[];
+        }[];
+    };
+}
+/**
+ * Represents a route that can accept any type for its parameters and return values.
+ */
+export type AnyRoute = Route<any | never, any | never, any | never, any | never>;
+/**
+ * Represents the configuration options for a router.
+ * @typedef {TransactionConfig & {
+ *   routes: Route[]
+ *   port?: number
+ *   timeout?: number
+ *   cors?: {
+ *     origin?: string | string[]
+ *     headers?: string[]
+ *     allowCredentials?: boolean
+ *   }
+ *   healthCheckRoute?: string
+ * }} RouterConfig
+ * @property {Route[]} routes - The routes to be configured in the router.
+ * @property {number} [port] - The port number to listen on. If not specified, a default port will be used.
+ * @property {number} [timeout] - The timeout duration for requests in milliseconds. If not specified, a default timeout will be
+ */
+export type RouterConfig = TransactionConfig & {
+    /**
+     * An array of route objects representing the available routes in the application.
+     * @type {Route[]}
+     */
+    routes: AnyRoute[];
+    /**
+     * The port number for the server to listen on.
+     * @type {number | undefined}
+     */
+    port?: number;
+    /**
+     * Optional timeout value in milliseconds.
+     * @type {number | undefined}
+     */
+    timeout?: number;
+    /**
+     * Configuration options for Cross-Origin Resource Sharing (CORS).
+     * @property {string | string[]} [origin] - The allowed origin(s) for CORS requests.
+     * @property {string[]} [headers] - The allowed headers for CORS requests.
+     * @property {boolean} [allowCredentials] - Whether to allow credentials (cookies, HTTP authentication, and client-side SSL certificates) to be sent in CORS requests.
+     */
+    cors?: {
+        origin?: string | string[];
+        headers?: string[];
+        allowCredentials?: boolean;
+    };
+    /**
+     * The route for the health check endpoint.
+     * @type {string | undefined}
+     */
+    healthCheckRoute?: string;
+    /**
+     * Optional hook function that sets up the container with the provided HTTP server and Express app.
+     * @param {HTTPServer} server - The HTTP server instance.
+     * @param {express.Express} app - The Express application instance.
+     * @returns {Promise<void>} A promise that resolves when the setup is complete.
+     */
+    containerSetupHook?: (server: HTTPServer, app: express.Express) => Promise<void>;
+};
+/**
+ * Represents a router that handles routing logic for a web application.
+ */
+export default class Router {
+    /**
+     * The configuration object for the router.
+     */
+    private readonly config;
+    /**
+     * The private readonly server instance.
+     */
+    private readonly server;
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config: RouterConfig);
+    /**
+     * Retrieves the export function from the server.
+     * @returns {CallableFunction} The export function from the server.
+     */
+    getExport(): CallableFunction;
+    /**
+     * Checks if the current element is a container.
+     * @returns {boolean} - True if the element is a container, false otherwise.
+     */
+    private isContainer;
+}

package/dist/src/Server/Router.js

@@ -0,0 +1,32 @@
+import ContainerServer from './lib/ContainerServer.js';
+import Server from './lib/Server.js';
+import Utils from '../Util/Utils.js';
+/**
+ * Represents a router that handles routing logic for a web application.
+ */
+export default class Router {
+    /**
+     * Constructs a new instance of the Router class.
+     * @param {RouterConfig} config - The configuration object for the router.
+     * @returns None
+     */
+    constructor(config) {
+        this.config = config;
+        this.server = this.isContainer() ? new ContainerServer(config) : new Server(config);
+    }
+    /**
+     * Retrieves the export function from the server.
+     * @returns {CallableFunction} The export function from the server.
+     */
+    getExport() {
+        return this.server.getExport();
+    }
+    /**
+     * Checks if the current element is a container.
+     * @returns {boolean} - True if the element is a container, false otherwise.
+     */
+    isContainer() {
+        return Utils.isHybridlessContainer();
+    }
+}
+//# sourceMappingURL=Router.js.map

package/dist/src/Server/Router.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Router.js","sourceRoot":"","sources":["../../../src/Server/Router.ts"],"names":[],"mappings":"AAKA,OAAO,eAAe,MAAM,0BAA0B,CAAA;AACtD,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAQpC,OAAO,KAAK,MAAM,kBAAkB,CAAA;AAmJpC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IAUzB;;;;OAIG;IACH,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAA;IACrF,CAAC;IAED;;;OAGG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAA;IAChC,CAAC;IAED;;;OAGG;IACK,WAAW;QACjB,OAAO,KAAK,CAAC,qBAAqB,EAAE,CAAA;IACtC,CAAC;CACF"}