cloudcommerce 0.0.126 → 0.0.128

package/packages/emails/src/index.ts

@@ -0,0 +1,144 @@
+import type {
+  EmailAdrress,
+  TemplateData,
+  Template,
+  SmtpConfig,
+  EmailHeaders,
+} from '../types/index';
+import config from '@cloudcommerce/firebase/lib/config';
+import sendEmailSmpt, { setConfigSmtp } from './providers/smtp/index';
+import sendEmailSendGrid from './providers/sendgrid/index';
+
+// https://docs.adonisjs.com/guides/mailer
+let smtpConfig: SmtpConfig | undefined;
+
+const setApiKeySendGrid = (apiKey: string) => {
+  process.env.SENDGRID_API_KEY = apiKey;
+};
+
+const sendEmail = (
+  emailData: {
+    to: EmailAdrress[],
+    subject: string,
+    cc?: EmailAdrress[],
+    sender?: EmailAdrress,
+    bcc?: EmailAdrress[],
+    text?: string,
+    html?: string,
+    templateData?: TemplateData,
+    templateId?: string,
+    template?: Template,
+  },
+) => {
+  const {
+    MAIL_SENDER,
+    MAIL_SENDER_NAME,
+    MAIL_REPLY_TO,
+    SMTP_HOST,
+    SMTP_PORT,
+    SMTP_USER,
+    SMTP_PASS,
+    SMTP_TLS,
+    SENDGRID_API_KEY,
+  } = process.env;
+
+  const {
+    templateData,
+    templateId,
+    template,
+    to,
+    subject,
+    cc,
+    sender,
+    bcc,
+    text,
+    html,
+  } = emailData;
+
+  const { cmsSettings } = config.get();
+
+  if (!templateId && !template && !html) {
+    throw new Error('TemplateId, template or html not found');
+  }
+
+  if (!MAIL_SENDER) {
+    throw new Error('Sender email not configured');
+  }
+
+  const emailHeaders: EmailHeaders = {
+    to,
+    subject,
+    cc,
+    sender,
+    bcc,
+    from: {
+      name: MAIL_SENDER_NAME || cmsSettings.name,
+      email: MAIL_SENDER,
+    },
+  };
+
+  if (MAIL_REPLY_TO) {
+    emailHeaders.replyTo = {
+      name: MAIL_SENDER_NAME || cmsSettings.name,
+      email: MAIL_REPLY_TO,
+    };
+  }
+
+  if ((templateId || template || html) && SENDGRID_API_KEY) {
+    return sendEmailSendGrid(
+      emailHeaders,
+      {
+        templateData,
+        templateId,
+        template,
+        html,
+      },
+    );
+  }
+
+  if (!smtpConfig && SMTP_HOST && SMTP_PORT && SMTP_USER && SMTP_PASS) {
+    const port = parseInt(SMTP_PORT, 10);
+    const secure = SMTP_TLS && SMTP_TLS.toUpperCase() === 'TRUE' ? true : port === 465;
+    // secure = true for 465, false for other ports
+    smtpConfig = {
+      host: SMTP_HOST,
+      port,
+      secure,
+      auth: { user: SMTP_USER, pass: SMTP_PASS },
+    };
+    setConfigSmtp(smtpConfig);
+  }
+
+  if ((template || html) && smtpConfig) {
+    return sendEmailSmpt(
+      emailHeaders,
+      {
+        text,
+        html,
+        templateData,
+        template,
+      },
+    );
+  }
+
+  throw new Error('Provider settings or smtp not found');
+};
+
+const sendGrid = {
+  send: sendEmailSendGrid,
+  setConfig: setApiKeySendGrid,
+
+};
+
+const smtp = {
+  send: sendEmailSmpt,
+  setConfig: setConfigSmtp,
+};
+
+export default { send: sendEmail };
+
+export {
+  sendEmail,
+  sendGrid,
+  smtp,
+};

package/packages/emails/src/parse-template-to-html.ts

@@ -0,0 +1,19 @@
+import type { TemplateData, Template } from '../types/index';
+import ejs from 'ejs';
+
+const parseTemplateToHtml = (
+  templateData: TemplateData,
+  template: Template,
+) => {
+  if (typeof template === 'string') {
+    const html = ejs.render(template, templateData);
+    return html;
+  }
+  /*
+      TODO: if in the future the template is an object and
+      it is necessary to identify the type of the template
+    */
+  throw new Error('Template type is not a string');
+};
+
+export default parseTemplateToHtml;

package/packages/emails/src/providers/sendgrid/index.ts

@@ -0,0 +1,78 @@
+import type {
+  DataEmailSendGrid,
+  EmailHeaders,
+  TemplateData,
+  Template,
+} from '../../../types/index';
+import axios from 'axios';
+import {
+  sendGridBodyWithTemplateId,
+  sendGridBodyWithTemplate,
+  sendGridBodyWithHtml,
+} from './parse-to-data';
+
+const sgAxios = axios.create({
+  baseURL: 'https://api.sendgrid.com/v3/mail',
+  headers: {
+    'Content-Type': 'application/json',
+  },
+});
+
+const sendEmail = async (
+  emailHeaders: EmailHeaders,
+  dataOptions: {
+    html?: string,
+    templateData?: TemplateData,
+    templateId?: string,
+    template?: Template,
+  },
+) => {
+  const {
+    templateData,
+    templateId,
+    template,
+  } = dataOptions;
+  const { html } = dataOptions;
+  let bodyEmail: DataEmailSendGrid | null = null;
+  if (templateId && templateData) {
+    bodyEmail = sendGridBodyWithTemplateId(emailHeaders, templateData, templateId);
+  } else if (template && templateData) {
+    bodyEmail = await sendGridBodyWithTemplate(emailHeaders, templateData, template);
+  } else if (html) {
+    bodyEmail = sendGridBodyWithHtml(emailHeaders, html);
+  }
+
+  if (!bodyEmail) {
+    throw new Error(`Email body for template: #${templateId || template}, not found`);
+  }
+
+  try {
+    const result = await sgAxios.post('/send', bodyEmail, {
+      headers: {
+        Authorization: `Bearer ${process.env.SENDGRID_API_KEY}`,
+      },
+    });
+    return result;
+  } catch (err: any) {
+    const { response } = err;
+    const [errors] = response.data.errors;
+    if (errors.field === 'template_id' && ((template && templateData) || html)) {
+      if (template && templateData) {
+        bodyEmail = await sendGridBodyWithTemplate(emailHeaders, templateData, template);
+      } else if (html) {
+        bodyEmail = sendGridBodyWithHtml(emailHeaders, html);
+      }
+      if (bodyEmail) {
+        return sgAxios.post('/send', bodyEmail, {
+          headers: {
+            Authorization: `Bearer ${process.env.SENDGRID_API_KEY}`,
+          },
+        });
+      }
+      throw new Error('TemplateId and template not found');
+    }
+    throw err;
+  }
+};
+
+export default sendEmail;

package/packages/emails/src/providers/sendgrid/parse-to-data.ts

@@ -0,0 +1,92 @@
+import type {
+  EmailHeaders,
+  TemplateData,
+  Template,
+  DataEmailSendGrid,
+} from '../../../types/index';
+import parseTemplateToHtml from '../../parse-template-to-html';
+
+const createBodySendGrid = (emailHeaders: EmailHeaders) => {
+  const {
+    from,
+    to,
+    subject,
+    replyTo,
+    cc,
+    bcc,
+  } = emailHeaders;
+
+  const body: DataEmailSendGrid = {
+    personalizations: [
+      {
+        to,
+        cc,
+        bcc,
+      },
+    ],
+    from,
+    subject,
+  };
+
+  if (replyTo) {
+    if (Array.isArray(replyTo)) {
+      body.reply_to_list = replyTo;
+    } else {
+      body.reply_to = replyTo;
+    }
+  }
+  return body;
+};
+
+const sendGridBodyWithTemplateId = (
+  emailHeaders: EmailHeaders,
+  templateData: TemplateData,
+  templateId: string,
+) => {
+  const body = createBodySendGrid(emailHeaders);
+  body.personalizations[0].dynamic_template_data = templateData;
+  body.template_id = templateId;
+
+  return body;
+};
+
+const sendGridBodyWithTemplate = async (
+  emailHeaders: EmailHeaders,
+  templateData: TemplateData,
+  template: Template,
+) => {
+  const body = createBodySendGrid(emailHeaders);
+
+  const contentValue = parseTemplateToHtml(templateData, template);
+
+  if (!contentValue) {
+    return null;
+  }
+
+  body.content = [{
+    type: 'text/html',
+    value: contentValue,
+  }];
+
+  return body;
+};
+
+const sendGridBodyWithHtml = (
+  emailHeaders: EmailHeaders,
+  html: string,
+) => {
+  const body = createBodySendGrid(emailHeaders);
+
+  body.content = [{
+    type: 'text/html',
+    value: html,
+  }];
+
+  return body;
+};
+
+export {
+  sendGridBodyWithTemplateId,
+  sendGridBodyWithTemplate,
+  sendGridBodyWithHtml,
+};

package/packages/emails/src/providers/smtp/index.ts

@@ -0,0 +1,115 @@
+import type {
+  EmailHeaders,
+  SmtpConfig,
+  EmailAdrress,
+  TemplateData,
+  Template,
+} from '../../../types/index';
+import type SMTPTransport from 'nodemailer/lib/smtp-transport';
+import nodemailer from 'nodemailer';
+import parseTemplateToHtml from '../../parse-template-to-html';
+
+const parseEmailsToString = (emails: EmailAdrress | EmailAdrress[]) => {
+  if (Array.isArray(emails)) {
+    return emails.reduce((value: string, emailAdrress: EmailAdrress) => {
+      return `${value}, ${emailAdrress.email}`;
+    }, '');
+  }
+  return `"${emails.name}" <${emails.email}>`;
+};
+
+let smtpConfig: SmtpConfig | undefined;
+
+let transporter: nodemailer.Transporter<SMTPTransport.SentMessageInfo> | undefined;
+
+const setConfigSmtp = (config: SmtpConfig) => {
+  smtpConfig = config;
+  // create reusable transporter object using the default SMTP transport
+  transporter = nodemailer.createTransport(config);
+};
+
+const sendEmail = async (
+  emailHeaders: EmailHeaders,
+  dataOptions: {
+    text?: string,
+    html?: string,
+    templateData?: TemplateData,
+    template?: Template,
+  },
+) => {
+  const {
+    text,
+    templateData,
+    template,
+  } = dataOptions;
+  let { html } = dataOptions;
+  const { from, to } = emailHeaders;
+
+  if (!template && !html) {
+    throw new Error('Template or html not found');
+  }
+
+  if (template && !templateData) {
+    throw new Error('Data for template not found');
+  }
+
+  if (template && templateData) {
+    html = parseTemplateToHtml(templateData, template);
+  }
+
+  if (!html) {
+    throw new Error(`Email body for template: #${template}, not found`);
+  }
+
+  // send mail with defined transport object
+  const mailOptions = {
+    from: `"${from.name}" <${from.email}>`,
+    to: parseEmailsToString(to),
+    subject: emailHeaders.subject,
+    html,
+  };
+  if (text) {
+    Object.assign(mailOptions, text);
+  }
+
+  if (emailHeaders.sender) {
+    Object.assign(mailOptions, {
+      sender: `"${emailHeaders.sender.name}" <${emailHeaders.sender.email}>`,
+    });
+  }
+
+  if (emailHeaders.cc) {
+    Object.assign(mailOptions, {
+      cc: parseEmailsToString(emailHeaders.cc),
+    });
+  }
+
+  if (emailHeaders.bcc) {
+    Object.assign(mailOptions, {
+      bcc: parseEmailsToString(emailHeaders.bcc),
+    });
+  }
+
+  if (emailHeaders.replyTo) {
+    const replyTo = parseEmailsToString(emailHeaders.replyTo);
+    Object.assign(mailOptions, {
+      replyTo,
+    });
+  }
+
+  if (!transporter && smtpConfig) {
+    setConfigSmtp(smtpConfig);
+  }
+
+  if (transporter) {
+    const info = await transporter.sendMail(mailOptions);
+    return { status: 202, message: `messageId: #${info.messageId}` };
+  }
+  throw new Error('Error configuring SMTP settings');
+};
+
+export default sendEmail;
+
+export {
+  setConfigSmtp,
+};

package/packages/emails/tests/assets/customer.json

@@ -0,0 +1,68 @@
+{
+  "oauth_providers": [
+      {
+          "_id": "3c2a00000000000000000003",
+          "provider": "facebook",
+          "user_id": "1234567890"
+      }
+  ],
+  "main_email": "mail@sample.ex",
+  "emails": [
+      {
+          "address": "mail@sample.ex",
+          "type": "personal",
+          "verified": true
+      },
+      {
+          "address": "janedue@inc.sample",
+          "type": "work",
+          "verified": false
+      }
+  ],
+  "accepts_marketing": true,
+  "display_name": "Jane",
+  "name": {
+      "family_name": "Due",
+      "given_name": "Jane"
+  },
+  "gender": "f",
+  "phones": [
+      {
+          "country_code": 55,
+          "number": "31999889988",
+          "type": "personal"
+      },
+      {
+          "country_code": 55,
+          "number": "3133443344",
+          "type": "home"
+      }
+  ],
+  "registry_type": "p",
+  "doc_country": "BR",
+  "doc_number": "11111111111",
+  "addresses": [
+      {
+          "_id": "4d2b00000000000000000003",
+          "zip": "30111222",
+          "street": "Rua Augusta",
+          "number": 92200,
+          "complement": "Apto. 200",
+          "borough": "Jardins",
+          "near_to": "Supermercado Exemplifica",
+          "line_address": "Rua Augusta 922200 Apto. 200, Jardins, Belo Horizonte, MG",
+          "city": "Belo Horizonte",
+          "country": "Brasil",
+          "country_code": "BR",
+          "province": "Minas Gerais",
+          "province_code": "MG",
+          "name": "Fulano",
+          "last_name": "Beltrano",
+          "phone": {
+              "country_code": 55,
+              "number": "31999889988"
+          },
+          "default": true
+      }
+  ]
+}

package/packages/emails/tests/assets/order.json

@@ -0,0 +1,190 @@
+{
+  "checkout_link": "https://www.sampleshop.com.br/checkout?_id=(_id)",
+  "status_link": "https://www.sampleshop.com.br/order/status?_id=(_id)",
+  "utm": {
+      "campaign": "adwords_example"
+  },
+  "browser_ip": "8.8.8.8",
+  "channel_id": "10001",
+  "domain": "www.sampleshop.com.br",
+  "opened_at": "2017-11-19T13:10:00.612Z",
+  "seller_status": "pending",
+  "financial_status": {
+      "updated_at": "2017-11-19T13:10:00.612Z",
+      "current": "pending"
+  },
+  "amount": {
+      "total": 48.05,
+      "subtotal": 42.9,
+      "freight": 5.15,
+      "discount": 0
+  },
+  "payment_method_label": "PayPal",
+  "shipping_method_label": "PAC",
+  "buyers": [
+      {
+          "_id": "3c1000000000000000000001",
+          "locale": "pt_br",
+          "main_email": "123@mail.com",
+          "display_name": "Fulano",
+          "name": {
+              "family_name": "Beltrano",
+              "given_name": "Fulano",
+              "middle_name": "Sicrano"
+          },
+          "gender": "m",
+          "phones": [
+              {
+                  "country_code": 55,
+                  "number": "31999889988",
+                  "type": "personal"
+              }
+          ],
+          "registry_type": "p",
+          "doc_country": "BR",
+          "doc_number": "11111111111"
+      }
+  ],
+  "shipping_lines": [
+      {
+          "from": {
+              "zip": "10111222",
+              "street": "Rua Exemplar",
+              "number": 100,
+              "borough": "Bairro Examplar",
+              "city": "São Paulo",
+              "province": "São Paulo",
+              "province_code": "SP"
+          },
+          "to": {
+              "zip": "30111222",
+              "street": "Rua Augusta",
+              "number": 92200,
+              "complement": "Apto. 200",
+              "borough": "Jardins",
+              "near_to": "Supermercado Exemplifica",
+              "line_address": "Rua Augusta 922200 Apto. 200, Jardins, Belo Horizonte, MG",
+              "city": "Belo Horizonte",
+              "country": "Brasil",
+              "country_code": "BR",
+              "province": "Minas Gerais",
+              "province_code": "MG",
+              "name": "Fulano",
+              "last_name": "Beltrano",
+              "phone": {
+                  "country_code": 55,
+                  "number": "31999889988"
+              }
+          },
+          "package": {
+              "dimensions": {
+                  "width": {
+                      "value": 10
+                  },
+                  "height": {
+                      "value": 8
+                  },
+                  "length": {
+                      "value": 8
+                  }
+              },
+              "weight": {
+                  "value": 400,
+                  "unit": "g"
+              }
+          },
+          "app": {
+              "_id": "77f000000000000000000001",
+              "label": "PAC",
+              "carrier": "Correios",
+              "service_name": "PAC",
+              "service_code": "44000",
+              "tracking_url": "http://www2.correios.com.br/sistemas/rastreamento/"
+          },
+          "price": 5,
+          "declared_value": 42.9,
+          "declared_value_price": 0.15,
+          "total_price": 5.15,
+          "posting_deadline": {
+              "days": 3
+          },
+          "delivery_time": {
+              "days": 5
+          }
+      }
+  ],
+  "transactions": [
+      {
+          "_id": "3ab0000000000000000000f1",
+          "created_at": "2017-11-19T13:10:00.612Z",
+          "payment_method": {
+              "code": "credit_card",
+              "name": "PayPal"
+          },
+          "billing_address": {
+              "zip": "30111222",
+              "street": "Rua Augusta",
+              "number": 92200,
+              "complement": "Apto. 200",
+              "borough": "Jardins",
+              "near_to": "Supermercado Exemplifica",
+              "line_address": "Rua Augusta 922200 Apto. 200, Jardins, Belo Horizonte, MG",
+              "city": "Belo Horizonte",
+              "country": "Brasil",
+              "country_code": "BR",
+              "province": "Minas Gerais",
+              "province_code": "MG",
+              "name": "Fulano",
+              "last_name": "Beltrano",
+              "phone": {
+                  "country_code": 55,
+                  "number": "31999889988"
+              }
+          },
+          "app": {
+              "_id": "77f000000000000000000011",
+              "label": "PayPal",
+              "icon": "https://www.paypal-brasil.com.br/logocenter/util/img/selo_aceitacao_horizontal.png",
+              "intermediator": {
+                  "name": "PayPal",
+                  "link": "https://www.paypal.com/br/home",
+                  "code": "paypal"
+              },
+              "payment_url": "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=1abc"
+          },
+          "intermediator": {
+              "transaction_code": "1abc"
+          },
+          "amount": 48.05,
+          "installments": {
+              "number": 2,
+              "value": 24.03,
+              "total": 48.06
+          },
+          "status": {
+              "updated_at": "2017-11-19T13:10:00.612Z",
+              "current": "pending"
+          }
+      }
+  ],
+  "payments_history": [
+      {
+          "_id": "4ab0000000000000000000f1",
+          "transaction_id": "3ab0000000000000000000f1",
+          "date_time": "2017-11-19T13:10:00.612Z",
+          "status": "pending",
+          "notification_code": "1abcde"
+      }
+  ],
+  "items": [
+      {
+          "_id": "3120000000000000000000a1",
+          "product_id": "123a5432109876543210cdef",
+          "sku": "s-MP_2B4",
+          "name": "Mens Pique Polo Shirt",
+          "quantity": 1,
+          "price": 42.9
+      }
+  ],
+  "notes": "Sample order notes by customer"
+}