cloudcommerce 0.0.125 → 0.0.127

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"
+}

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

@@ -0,0 +1,25 @@
+{
+  "_id": "5a674f224e0dcec2c3353d9d",
+  "created_at": "2017-11-19T13:10:00.612Z",
+  "store_id": 100,
+  "name": "Minha Loja Online",
+  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
+  "segment_id": 23,
+  "doc_type": "CNPJ",
+  "doc_number": "12345678901234",
+  "corporate_name": "Minha Loja Online LTDA",
+  "address": "Rua Exemplar 100, Bairro Examplar, São Paulo, SP",
+  "phone": "31988887777",
+  "representant_name": "Fulano Ciclano",
+  "representant_email": "fulano@sample.shop.eg",
+  "contact_email": "contato@sample.shop.eg",
+  "financial_email": "financeiro@sample.shop.eg",
+  "logo": {
+      "url": "https://sample.shop.eg/assets/logo.png",
+      "size": "120x80"
+  },
+  "brand_colors": {
+      "primary": "#03a9b3",
+      "secondary": "#ffffff"
+  }
+}

package/packages/emails/tests/ex.config-sendgrid.json

@@ -0,0 +1,19 @@
+{
+  "ecomAuthenticationId": "",
+  "ecomApiKey": "",
+  "ecomStoreId": "",
+  "apiKey": "",
+  "from": {
+    "email": "",
+    "name": ""
+  },
+  "to": [
+    {
+      "email": "",
+      "name": ""
+    }
+  ],
+  "templateIdOrders": "",
+  "templateIdCarts": "",
+  "templateIdProducts": ""
+}

package/packages/emails/tests/ex.config-smtp.json

@@ -0,0 +1,21 @@
+{
+  "ecomAuthenticationId": "",
+  "ecomApiKey": "",
+  "ecomStoreId": "",
+  "smtp": {
+    "host": "",
+    "port": "",
+    "user": "",
+    "pass": ""
+  },
+  "from": {
+    "email": "",
+    "name": ""
+  },
+  "to": [
+    {
+      "email": "",
+      "name": ""
+    }
+  ]
+}

package/packages/emails/tests/sendgrid.test.ts

@@ -0,0 +1,156 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import url from 'url';
+import fs from 'fs';
+import { test, expect } from 'vitest';
+import email, { sendGrid } from '../src/index';
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+const readFile = (path: string) => fs.readFileSync(`${__dirname}/${path}`, 'utf-8');
+
+const readJson = (path: string) => JSON.parse(readFile(path));
+
+const config = readJson('config-sendgrid.json');
+const order = readJson('assets/order.json');
+const store = readJson('/assets/store.json');
+const customer = readJson('/assets/customer.json');
+const templateNewOrder = readFile('templates/new-order.ejs');
+
+const header = {
+  to: config.to,
+  subject: '',
+};
+
+process.env.ECOM_STORE_ID = config.ecomStoreId;
+process.env.ECOM_AUTHENTICATION_ID = config.ecomAuthenticationId;
+process.env.ECOM_API_KEY = config.ecomApiKey;
+
+process.env.MAIL_SENDER = config.from.email;
+process.env.MAIL_SENDER_NAME = config.from.name;
+
+const timeOut = 10000;
+
+test('Error settings not found', async () => {
+  try {
+    await email.send({
+      ...header,
+      templateData: {
+        store,
+        order,
+        customer,
+      },
+      template: templateNewOrder,
+    });
+  } catch (err: any) {
+    expect(err.message).toBe('Provider settings or smtp not found');
+  }
+}, timeOut);
+
+test('Error template not found', async () => {
+  process.env.SENDGRID_API_KEY = config.apiKey;
+  try {
+    await email.send({
+      ...header,
+      templateData: {
+        store,
+        order,
+        customer,
+      },
+    });
+  } catch (err: any) {
+    expect(err.message).toBe('TemplateId, template or html not found');
+  }
+}, timeOut);
+
+test('Send email with templateId for order', async () => {
+  header.subject = 'Test email with order templateId';
+  const data = await email.send({
+    ...header,
+    templateData: {
+      store,
+      order,
+      customer,
+    },
+    templateId: config.templateIdOrders,
+  });
+  expect(data?.status).toBe(202);
+}, timeOut);
+
+test('Send email with template for order', async () => {
+  header.subject = 'Test email with order template';
+  const data = await email.send({
+    ...header,
+    templateData: {
+      store,
+      order,
+      customer,
+    },
+    template: templateNewOrder,
+  });
+  expect(data?.status).toBe(202);
+}, timeOut);
+
+test('Send email retry with template for templateId error', async () => {
+  header.subject = 'Test retry email';
+  const data = await email.send({
+    ...header,
+    templateData: {
+      store,
+      order,
+      customer,
+    },
+    templateId: 'd-00000000000000000000000000000000',
+    template: templateNewOrder,
+  });
+  expect(data?.status).toBe(202);
+}, timeOut * 1.5);
+
+test('Error templateId not found', async () => {
+  header.subject = 'Test email, templateId error';
+  try {
+    await email.send({
+      ...header,
+      templateData: {
+        store,
+        order,
+        customer,
+      },
+      templateId: 'd-00000000000000000000000000000000',
+    });
+  } catch (err: any) {
+    expect(err.response.status).toBe(400);
+  }
+}, timeOut);
+
+test('Unauthorized Error API Key', async () => {
+  sendGrid.setConfig('dadasdas');
+  header.subject = 'Test email, Unauthorized Error API Key';
+  try {
+    await email.send({
+      ...header,
+      templateData: {
+        store,
+        order,
+        customer,
+      },
+      template: templateNewOrder,
+    });
+  } catch (err: any) {
+    expect(err.response.status).toBe(401);
+  }
+}, timeOut);
+
+test('Back to original sendGrid settings', async () => {
+  sendGrid.setConfig(config.apiKey);
+  header.subject = 'Test email with order templateId';
+  const data = await email.send({
+    ...header,
+    templateData: {
+      store,
+      order,
+      customer,
+    },
+    templateId: config.templateIdOrders,
+  });
+  expect(data?.status).toBe(202);
+}, timeOut);