@underpostnet/cyberia 3.2.80

package/src/mailer/EmailRender.js

@@ -0,0 +1,116 @@
+import { ssrFactory } from '../client-builder/ssr.js';
+
+/**
+ * Module for handling the rendering and styling of HTML emails using SSR components.
+ * @module src/mailer/EmailRender.js
+ * @namespace EmailRenderService
+ */
+
+/**
+ * @class
+ * @alias EmailRenderService
+ * @memberof EmailRenderService
+ * @classdesc Utility class for managing CSS styles and rendering email templates using
+ * Server-Side Rendering (SSR) components.
+ */
+class EmailRenderService {
+  /**
+   * Defines the base CSS styles for different elements within the email template.
+   * Keys are CSS selectors (or class names), and values are objects of CSS properties.
+   * @type {object.<string, object.<string, string>>}
+   * @property {object} body - Styles for the main email body wrapper.
+   * @property {object} .container - Styles for the main content container.
+   * @property {object} h1 - Styles for primary headings.
+   * @property {object} p - Styles for standard paragraphs.
+   * @property {object} button - Styles for call-to-action buttons.
+   * @property {object} .footer - Styles for the email footer.
+   */
+  style = {
+    body: {
+      'font-family': 'Arial, sans-serif',
+      'background-color': '#f4f4f4',
+      margin: 0,
+      padding: '20px',
+      'min-height': '300px',
+      width: '100%',
+      'max-width': '700px',
+      display: 'block',
+    },
+    '.container': {
+      'max-width': '600px',
+      margin: '0 auto',
+      'background-color': '#ffffff',
+      padding: '20px',
+      'border-radius': '5px',
+      // 'box-shadow': '0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.19)',
+    },
+    h1: {
+      'font-size': '24px',
+      'margin-bottom': '20px',
+      color: '#333333',
+    },
+    p: {
+      'font-size': '16px',
+      'line-height': 1.5,
+      'margin-bottom': '20px',
+      color: '#666666',
+    },
+    button: {
+      display: 'inline-block',
+      padding: '10px 20px',
+      'background-color': '#007bff',
+      color: '#ffffff',
+      'text-decoration': 'none',
+      'border-radius': '5px',
+      'font-size': '16px',
+    },
+    '.footer': {
+      'text-align': 'center',
+      padding: '20px',
+      'font-size': '14px',
+      color: '#999999',
+    },
+  };
+
+  /**
+   * Converts a style object defined in the `this.style` property into a CSS style string.
+   *
+   * @param {string} classObj - The key corresponding to a style object in `this.style`.
+   * @returns {string} A string containing inline CSS properties (e.g., ` property: value;`).
+   */
+  renderStyle(classObj) {
+    if (!this.style[classObj]) return '';
+    return Object.keys(this.style[classObj])
+      .map((classKey) => ` ${classKey}: ${this.style[classObj][classKey]};`)
+      .join(``);
+  }
+
+  /**
+   * Loads and renders email templates using the SSR factory.
+   *
+   * @async
+   * @param {object} [options] - Options containing the template names.
+   * @param {object.<string, string>} [options.templates={}] - Map of template keys to their SSR component file names.
+   * @returns {Promise<object.<string, string>>} A promise that resolves to an object map of rendered HTML email strings.
+   */
+  async getTemplates(options = { templates: {} }) {
+    const templates = {};
+    for (const templateKey of Object.keys(options.templates)) {
+      const ssrEmailComponent = options.templates[templateKey];
+      // Note: ssrFactory is assumed to load and return a functional component/function
+      const SrrComponent = await ssrFactory(`./src/client/ssr/mailer/${ssrEmailComponent}.js`);
+      templates[templateKey] = SrrComponent(this, options);
+    }
+    return templates;
+  }
+}
+
+/**
+ * Singleton instance of the EmailRenderService class for backward compatibility.
+ * @alias EmailRender
+ * @memberof EmailRenderService
+ * @type {EmailRenderService}
+ */
+const EmailRender = new EmailRenderService();
+
+export { EmailRender, EmailRenderService as EmailRenderClass };

package/src/mailer/MailerProvider.js

@@ -0,0 +1,213 @@
+import nodemailer from 'nodemailer';
+import { loggerFactory } from '../server/logger.js';
+import { EmailRender } from './EmailRender.js';
+
+/**
+ * Module for configuring and sending emails using Nodemailer.
+ * @module src/mailer/MailerProvider.js
+ * @namespace MailerProviderService
+ */
+
+const logger = loggerFactory(import.meta);
+
+/**
+ * @typedef {object} MailerOptions
+ * @property {string} id - Unique identifier for the mailer configuration.
+ * @property {string} [meta='mailer'] - Meta identifier for logging/context.
+ * @property {object} sender - The default sender details.
+ * @property {string} sender.email - The default sender email address.
+ * @property {string} sender.name - The default sender name.
+ * @property {object} transport - Nodemailer transport configuration.
+ * @property {string} transport.host - SMTP host.
+ * @property {number} [transport.port=587] - SMTP port.
+ * @property {boolean} [transport.secure=false] - Use TLS (true for 465, false for other ports).
+ * @property {object} transport.auth - Authentication details.
+ * @property {string} transport.auth.user - Username.
+ * @property {string} transport.auth.pass - Password.
+ * @property {string} [host=''] - Application host for context.
+ * @property {string} [path=''] - Application path for context.
+ * @property {object.<string, string>} templates - Map of template keys to SSR component file names.
+ * @memberof MailerProviderService
+ */
+
+/**
+ * @class
+ * @alias MailerProviderService
+ * @memberof MailerProviderService
+ * @classdesc Manages multiple Nodemailer transporter instances and handles loading of
+ * email templates and sending emails.
+ */
+class MailerProviderService {
+  /**
+   * Internal storage for mailer instances (transporters, options, templates), keyed by ID.
+   * @type {object.<string, object>}
+   * @method
+   */
+  #instance = {};
+
+  /**
+   * Retrieves the internal instance storage for direct access (used for backward compatibility).
+   * @returns {object.<string, object>} The internal mailer instance map.
+   */
+  get instance() {
+    return this.#instance;
+  }
+
+  /**
+   * Loads and initializes a new mailer provider instance using Nodemailer.
+   * The created instance is stored internally and includes the transporter and rendered templates.
+   *
+   * @async
+   * @param {MailerOptions} [options] - Configuration options for the mailer instance.
+   * @returns {Promise<object|undefined>} A promise that resolves to the initialized mailer instance
+   * object, or `undefined` on error.
+   */
+  async load(
+    options = {
+      id: '',
+      meta: 'mailer',
+      sender: {
+        email: '',
+        name: '',
+      },
+      transport: {
+        host: '', // smtp host
+        port: 587,
+        secure: false, // true for 465, false for other ports
+        auth: {
+          user: '', // generated ethereal user
+          pass: '', // generated ethereal password
+        },
+      },
+      host: '',
+      path: '',
+      templates: {
+        userVerifyEmail: 'DefaultVerifyEmail',
+        userRecoverEmail: 'DefaultRecoverEmail',
+      },
+    },
+  ) {
+    try {
+      options.transport.tls = {
+        rejectUnauthorized: false, // allows self-signed certs for local/dev
+      };
+      const { id } = options;
+
+      const transporter = nodemailer.createTransport(options.transport);
+
+      this.#instance[id] = {
+        ...options,
+        transporter,
+        templates: await EmailRender.getTemplates(options),
+        translateTemplates: {
+          confirmEmail: {
+            H1: {
+              en: 'Confirm Your Email',
+              es: 'Confirma tu correo electrónico',
+            },
+            P1: {
+              en: `Email confirmed! Thanks.
+               <br />
+             <span style="font-size: 12px; color: gray">
+                If it is not automatically verified,
+                please allow the image to be seen, thank you.
+             </span>
+              `,
+              es: `Correo electrónico confirmado! Gracias.
+              <br />
+              <span style="font-size: 12px; color: gray">
+               Si no se verifica automáticamente, por favor permita que se vea la imagen, gracias.
+              </span>
+              `,
+            },
+          },
+          recoverEmail: {
+            H1: {
+              en: 'Recover your account',
+              es: 'Recupera tu cuenta',
+            },
+            P1: {
+              en: 'To recover your account, please click the button below:',
+              es: 'Para recuperar tu cuenta, haz click en el botón de abajo:',
+            },
+            BTN_LABEL: {
+              en: 'Recover Password',
+              es: 'Recuperar Contraseña',
+            },
+          },
+        },
+      };
+
+      return this.#instance[id];
+    } catch (error) {
+      logger.error(error, error.stack);
+      return undefined;
+    }
+  }
+
+  /**
+   * Sends an email using a previously loaded transporter instance.
+   *
+   * @async
+   * @param {object} [options] - Options for sending the email.
+   * @param {string} options.id - The ID of the mailer instance/transporter to use.
+   * @param {object} options.sendOptions - Nodemailer mail options.
+   * @param {string} [options.sendOptions.from] - Sender address (defaults to loaded instance sender).
+   * @param {string} options.sendOptions.to - List of receivers (comma-separated).
+   * @param {string} options.sendOptions.subject - Subject line.
+   * @param {string} [options.sendOptions.text] - Plain text body.
+   * @param {string} [options.sendOptions.html] - HTML body.
+   * @returns {Promise<object|undefined>} A promise that resolves to the Nodemailer `info` object, or `undefined` on error.
+   */
+  async send(
+    options = {
+      id: '',
+      sendOptions: {
+        from: '"Fred Foo 👻" <foo@example.com>', // sender address
+        to: 'bar@example.com, baz@example.com', // list of receivers
+        subject: 'Hello ✔', // Subject line
+        text: 'Hello world?', // plain text body
+        html: '<b>Hello world?</b>', // html body
+        attachments: [
+          {
+            filename: 'logo.png',
+            path: `./logo.png`,
+            cid: 'logo', // <img src='cid:logo'>
+          },
+        ],
+      },
+    },
+  ) {
+    try {
+      const { id, sendOptions } = options;
+      const instance = this.#instance[id];
+
+      if (!instance) {
+        logger.error(`Mailer instance with ID '${id}' not loaded.`);
+        return undefined;
+      }
+
+      if (!sendOptions.from) sendOptions.from = `${instance.sender.name} <${instance.sender.email}>`;
+
+      // send mail with defined transport object
+      const info = await instance.transporter.sendMail(sendOptions);
+
+      // logger.info('Message sent', info);
+
+      return info;
+    } catch (error) {
+      logger.error(error, error.stack);
+      return undefined;
+    }
+  }
+}
+
+/**
+ * Singleton instance of the MailerProviderService class for backward compatibility.
+ * @alias MailerProvider
+ * @memberof MailerProviderService
+ * @type {MailerProviderService}
+ */
+const MailerProvider = new MailerProviderService();
+
+export { MailerProvider, MailerProviderService as MailerProviderClass };