@unchainedshop/platform 1.1.3

package/src/templates/resolveForwardDeliveryTemplate.ts

@@ -0,0 +1,128 @@
+import { TemplateResolver } from '@unchainedshop/types/messaging';
+import moment from 'moment';
+import { systemLocale } from '@unchainedshop/utils';
+import { getOrderAttachmentsData } from './utils/getOrderAttachmentsData';
+import { getOrderPositionsData } from './utils/getOrderPositionsData';
+
+const { EMAIL_FROM, EMAIL_WEBSITE_NAME, ROOT_URL } = process.env;
+
+const mjmlTemplate = `
+<mjml>
+  <mj-body background-color="#FAFAFA">
+      <mj-section padding-bottom="32px" background-color="#fcfcfc">
+        <mj-column width="100%">
+          <mj-text align="center" font-size="20px" color="#232323" font-family="Helvetica Neue" font-weight="200">
+            <h2 >{{subject}}</h2>
+          </mj-text>
+          <mj-text align="left" font-size="20px" color="#232323" font-family="Helvetica Neue" font-weight="200">
+            <span>Order number: {{orderNumber}}</span><br/>
+            <span>Order date: {{orderDate}}</span>
+            <a href="{{controlpanelLink}}">{{controlpanelLink}}</a>
+          </mj-text>
+          <mj-text align="left" font-size="20px" color="#232323">Delivery address</mj-text>
+          <mj-text align="left">
+            {{address.firstName}} {{address.lastName}}<br/>
+            {{address.company}}<br/>
+            {{address.addressLine}}<br/>
+            {{address.addressLine2}}<br/>
+            {{address.postalCode}} {{address.city}} {{address.regionCode}}<br/>
+            {{address.countryCode}}<br/>
+          </mj-text>
+          <mj-divider border-width="1px" border-style="dashed" border-color="lightgrey" />
+          <mj-text align="left" font-size="20px" color="#232323">Articles</mj-text>
+          <mj-table>
+            <tr style="border-bottom:1px solid #ecedee;text-align:left;padding:15px 0;">
+              <th style="padding: 0 15px 0 0;">Article</th>
+              <th style="padding: 0 15px;">Quantity</th>
+            </tr>
+            {{#items}}
+              <tr>
+                <td style="padding: 0 15px 0 0;">{{sku}} - {{name}}</td>
+                <td style="padding: 0 15px;">{{quantity}}</td>
+              </tr>
+            {{/items}}
+          </mj-table>
+        </mj-column>
+      </mj-section>
+  </mj-body>
+</mjml>
+`;
+
+const textTemplate = `
+  {{subject}}\n
+  \n
+  Order number: {{orderNumber}}\n
+  Order date: {{orderDate}}\n
+  Link: {{controlpanelLink}}\n
+  \n
+  Delivery address:\n
+  -----------------\n
+  {{address.firstName}} {{address.lastName}}\n
+  {{address.company}}\n
+  {{address.addressLine}}\n
+  {{address.addressLine2}}\n
+  {{address.postalCode}} {{address.city}}\n
+  {{address.regionCode}}\n
+  {{address.countryCode}}\n
+  \n
+  Articles:\n
+  -----------------\n
+  {{#items}}
+  * {{sku}} - {{name}}      CHF {{price}}     {{quantity}}\n
+  {{/items}}
+`;
+
+export const resolveForwardDeliveryTemplate: TemplateResolver = async (
+  { config, orderId, transactionContext },
+  context,
+) => {
+  const { modules } = context;
+  const order = await modules.orders.findOrder({ orderId });
+  const orderPricing = modules.orders.pricingSheet(order);
+
+  const momentDate = moment(order.ordered);
+  momentDate.locale(systemLocale.normalized);
+  const orderDate = momentDate.format('lll');
+
+  const attachments = await getOrderAttachmentsData(order, { fileType: 'DELIVERY_NOTE' }, context);
+
+  const address = transactionContext?.address || order.billingAddress;
+  const configObject = config.reduce((acc, { key, value }) => {
+    return {
+      ...acc,
+      [key]: value,
+    };
+  }, {});
+
+  const subject = `${EMAIL_WEBSITE_NAME}: New Order / ${order.orderNumber}`;
+
+  const controlpanelLink = `${ROOT_URL}/orders/view/?_id=${order._id}`;
+
+  const data = {
+    contact: order.contact || {},
+    controlpanelLink,
+    items: getOrderPositionsData(order, { locale: systemLocale }, context),
+    orderDate,
+    orderNumber: order.orderNumber,
+    shopName: EMAIL_WEBSITE_NAME,
+    subject,
+    total: orderPricing.total({ useNetPrice: false }).amount / 100,
+    ...configObject,
+    address,
+  };
+
+  return [
+    {
+      type: 'EMAIL',
+      input: {
+        from: configObject.from || EMAIL_FROM || 'noreply@unchained.local',
+        to: configObject.to || 'orders@unchained.local',
+        cc: configObject.cc,
+        subject,
+        text: modules.messaging.renderToText(textTemplate, data),
+        html: modules.messaging.renderMjmlToHtml(mjmlTemplate, data),
+        attachments,
+      },
+    },
+  ];
+};

package/src/templates/resolveOrderConfirmationTemplate.ts

@@ -0,0 +1,133 @@
+import { TemplateResolver } from '@unchainedshop/types/messaging';
+import { OrderPricingRowCategory } from '@unchainedshop/types/orders.pricing';
+import { getOrderAttachmentsData } from './utils/getOrderAttachmentsData';
+import { getOrderPositionsData } from './utils/getOrderPositionsData';
+
+const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
+
+const mjmlTemplate = `
+<mjml>
+  <mj-body background-color="#FAFAFA">
+      <mj-section padding-bottom="32px" background-color="#FFFFFF">
+        <mj-column width="100%">
+          <mj-text font-size="20px" color="#232323" font-family="Helvetica Neue" font-weight="400">
+            <h2>{{subject}}</h2>
+          </mj-text>
+          <mj-text font-size="20px" color="#232323" font-family="Helvetica Neue">
+            <p>{{thankyou}} <a style="color:#2CAADF" href="{{shopUrl}}">{{shopName}}</a></p>
+          </mj-text>
+        </mj-column>
+      </mj-section>
+
+      <mj-section padding-bottom="20px" background-color="#F3F3F3">
+        <mj-column>
+          <mj-button href="{{url}}" font-family="Helvetica" background-color="#31302E" color="#FFFFFF">
+           {{buttonText}}
+         </mj-button>
+        </mj-column>
+      </mj-section>
+  </mj-body>
+</mjml>
+`;
+
+const textTemplate = `
+  {{subject}}\n
+  \n
+  {{thankyou}}\n
+  \n
+  -----------------\n
+  {{buttonText}}: {{url}}\n
+  -----------------\n
+`;
+
+const texts = {
+  en: {
+    buttonText: 'Follow purchase order status',
+    thankyou: 'Thank you for your order on',
+    subject: `${EMAIL_WEBSITE_NAME}: Order confirmation`,
+  },
+  de: {
+    buttonText: 'Bestellstatus verfolgen',
+    thankyou: 'Vielen Dank für deine Bestellung bei',
+    subject: `${EMAIL_WEBSITE_NAME}: Bestellbestätigung`,
+  },
+  fr: {
+    buttonText: 'Follow purchase order status',
+    thankyou: 'Thank you for your order on',
+    subject: `${EMAIL_WEBSITE_NAME}: Order confirmation`,
+  },
+};
+
+export const resolveOrderConfirmationTemplate: TemplateResolver = async (
+  { orderId, locale },
+  context,
+) => {
+  const { modules } = context;
+  const order = await modules.orders.findOrder({ orderId });
+
+  if (order.status === 'PENDING') {
+    return [];
+  }
+
+  const formatPrice = (price: number) => {
+    const fixedPrice = price / 100;
+    return `${order.currency} ${fixedPrice}`;
+  };
+
+  // TODO: If order.status is PENDING, we should only send the user
+  // a notice that we have received the order but not confirming it
+  const attachments = await getOrderAttachmentsData(order, { fileType: 'ORDER_CONFIRMATION' }, context);
+
+  const orderPricing = modules.orders.pricingSheet(order);
+
+  const { subject } = texts[locale.language];
+
+  const data = {
+    ...texts[locale.language],
+    shopName: EMAIL_WEBSITE_NAME,
+    shopUrl: EMAIL_WEBSITE_URL,
+    subject,
+    url: `${EMAIL_WEBSITE_URL}/order?_id=${order._id}`,
+    summary: {
+      items: formatPrice(
+        orderPricing.total({
+          category: OrderPricingRowCategory.Items,
+          useNetPrice: false,
+        }).amount,
+      ),
+      taxes: formatPrice(
+        orderPricing.total({
+          category: OrderPricingRowCategory.Taxes,
+          useNetPrice: false,
+        }).amount,
+      ),
+      delivery: formatPrice(
+        orderPricing.total({
+          category: OrderPricingRowCategory.Delivery,
+          useNetPrice: false,
+        }).amount,
+      ),
+      payment: formatPrice(
+        orderPricing.total({
+          category: OrderPricingRowCategory.Payment,
+          useNetPrice: false,
+        }).amount,
+      ),
+      gross: formatPrice(orderPricing.total({ useNetPrice: false }).amount),
+    },
+    positions: getOrderPositionsData(order, { locale }, context),
+  };
+  return [
+    {
+      type: 'EMAIL',
+      input: {
+        from: EMAIL_FROM || 'orders@unchained.local',
+        to: order.contact.emailAddress,
+        subject,
+        text: modules.messaging.renderToText(textTemplate, data),
+        html: modules.messaging.renderMjmlToHtml(mjmlTemplate, data),
+        attachments,
+      },
+    },
+  ];
+};

package/src/templates/resolveOrderRejectionTemplate.ts

@@ -0,0 +1,85 @@
+import { TemplateResolver } from '@unchainedshop/types/messaging';
+
+const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
+
+const mjmlTemplate = `
+<mjml>
+  <mj-body background-color="#FAFAFA">
+      <mj-section padding-bottom="32px" background-color="#FFFFFF">
+        <mj-column width="100%">
+          <mj-text font-size="20px" color="#232323" font-family="Helvetica Neue" font-weight="400">
+            <h2>{{subject}}</h2>
+          </mj-text>
+          <mj-text font-size="20px" color="#232323" font-family="Helvetica Neue">
+            <p>{{rejection}}</p>
+          </mj-text>
+        </mj-column>
+      </mj-section>
+
+      <mj-section padding-bottom="20px" background-color="#F3F3F3">
+        <mj-column>
+          <mj-button href="{{url}}" font-family="Helvetica" background-color="#31302E" color="#FFFFFF">
+           {{buttonText}}
+         </mj-button>
+        </mj-column>
+      </mj-section>
+  </mj-body>
+</mjml>
+`;
+
+const textTemplate = `
+  {{subject}}\n
+  \n
+  {{rejection}}\n
+  \n
+  -----------------\n
+  {{buttonText}}: {{url}}\n
+  -----------------\n
+`;
+
+const texts = {
+  en: {
+    buttonText: 'Details are available at',
+    rejection: 'Your order was cancelled.',
+    subject: `${EMAIL_WEBSITE_NAME}: Order cancelled`,
+  },
+  de: {
+    buttonText: 'Details abrufen',
+    rejection: 'Deine Bestellung wurde storniert',
+    subject: `${EMAIL_WEBSITE_NAME}: Bestellung storniert`,
+  },
+  fr: {
+    buttonText: 'Details are available at',
+    rejection: 'Your order was cancelled.',
+    subject: `${EMAIL_WEBSITE_NAME}: Order cancelled`,
+  },
+};
+
+export const resolveOrderRejectionTemplate: TemplateResolver = async ({ orderId, locale }, context) => {
+  const { modules } = context;
+  const order = await modules.orders.findOrder({ orderId });
+
+  if (order.status !== 'REJECTED') {
+    return [];
+  }
+
+  const { subject } = texts[locale.language];
+
+  const data = {
+    ...texts[locale.language],
+    subject,
+    url: `${EMAIL_WEBSITE_URL}/order?_id=${order._id}`,
+  };
+  return [
+    {
+      type: 'EMAIL',
+      input: {
+        from: EMAIL_FROM || 'orders@unchained.local',
+        to: order.contact.emailAddress,
+        subject,
+        text: modules.messaging.renderToText(textTemplate, data),
+        html: modules.messaging.renderMjmlToHtml(mjmlTemplate, data),
+      },
+    },
+  ];
+};

package/src/templates/resolveQuotationStatusTemplate.ts

@@ -0,0 +1,54 @@
+import { TemplateResolver } from '@unchainedshop/types/messaging';
+
+const { EMAIL_FROM, EMAIL_WEBSITE_NAME, EMAIL_WEBSITE_URL } = process.env;
+
+const textTemplate = `
+  {{subject}}\n
+  \n
+  Status: {{quotation.status}}
+  \n
+  -----------------\n
+  Show: {{url}}\n
+  -----------------\n
+`;
+
+export const resolveQuotationStatusTemplate: TemplateResolver = async (
+  { quotationId, locale },
+  { modules },
+) => {
+  const quotation = await modules.quotations.findQuotation({ quotationId });
+  const user = await modules.users.findUserById(quotation.userId);
+  const attachments = (
+    await modules.files.findFilesByMetaData(
+      { meta: { quotationId: quotation._id, type: 'PROPOSAL ' } },
+      { sort: { 'meta.date': -1 } },
+    )
+  )
+    .filter(Boolean)
+    .map((file) => ({
+      filename: `${quotation.quotationNumber}_${file.name}`,
+      path: file.url,
+    }));
+
+  const subject = `${EMAIL_WEBSITE_NAME}: Updated Quotation / ${quotation.quotationNumber}`;
+
+  const data = {
+    locale,
+    quotation,
+    subject,
+    url: `${EMAIL_WEBSITE_URL}/quotation?_id=${quotation._id}`,
+  };
+
+  return [
+    {
+      type: 'EMAIL',
+      input: {
+        from: EMAIL_FROM,
+        to: modules.users.primaryEmail(user)?.address,
+        subject,
+        text: modules.messaging.renderToText(textTemplate, data),
+        attachments,
+      },
+    },
+  ];
+};

package/src/templates/utils/getOrderAttachmentsData.ts

@@ -0,0 +1,47 @@
+import { Context } from '@unchainedshop/types/api';
+import { Order } from '@unchainedshop/types/orders';
+
+export const getOrderAttachmentsData = async (
+  order: Order,
+  params: { fileType: string },
+  { modules }: Context,
+) => {
+  const orderId = order._id;
+  const attachments = [];
+
+  const orderFiles = await modules.files.findFilesByMetaData(
+    {
+      meta: { orderId: order._id, type: params.fileType },
+    },
+    { limit: 1 },
+  );
+  attachments.concat(orderFiles);
+  const payment = await modules.orders.payments.findOrderPayment(
+    {
+      orderPaymentId: order.paymentId,
+    },
+    { limit: 1 },
+  );
+  if (modules.orders.payments.isBlockingOrderFullfillment(payment)) {
+    const invoices = await modules.files.findFilesByMetaData(
+      {
+        meta: { orderId, type: 'INVOICE' },
+      },
+      { limit: 1 },
+    );
+    attachments.concat(invoices);
+  } else {
+    const receipts = await modules.files.findFilesByMetaData(
+      {
+        meta: { orderId, type: 'RECEIPT' },
+      },
+      { limit: 1 },
+    );
+    attachments.concat(receipts);
+  }
+
+  return attachments.map((file) => ({
+    filename: `${order.orderNumber}_${file.name}`,
+    path: file.path,
+  }));
+};

package/src/templates/utils/getOrderPositionsData.ts

@@ -0,0 +1,49 @@
+import { Context } from '@unchainedshop/types/api';
+import { Locale } from '@unchainedshop/types/common';
+import { Order } from '@unchainedshop/types/orders';
+
+export const getOrderPositionsData = async (
+  order: Order,
+  params: { locale?: Locale },
+  context: Context,
+) => {
+  const { modules } = context;
+  const orderPositions = await modules.orders.positions.findOrderPositions({
+    orderId: order._id,
+  });
+
+  const formatPrice = (price: number) => {
+    const fixedPrice = price / 100;
+    return `${order.currency} ${fixedPrice}`;
+  };
+
+  await Promise.all(
+    orderPositions.map(async (orderPosition) => {
+      const productTexts = await modules.products.texts.findLocalizedText({
+        productId: orderPosition.productId,
+        locale: params.locale?.normalized,
+      });
+      const originalProductTexts = await modules.products.texts.findLocalizedText({
+        productId: orderPosition.originalProductId,
+        locale: params.locale?.normalized,
+      });
+
+      const productTitle = productTexts?.title; // deprecated
+
+      const positionPricing = modules.orders.positions.pricingSheet(
+        orderPosition,
+        order.currency,
+        context,
+      );
+      const total = formatPrice(positionPricing.sum());
+      const { quantity } = positionPricing;
+      return {
+        originalProductTexts,
+        product: productTitle,
+        productTexts,
+        quantity,
+        total,
+      };
+    }),
+  );
+};

package/tsconfig.build.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": "lib",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "types": ["node"],
+    "baseUrl": ".", // This must be specified if "paths" is.
+    "paths": {
+      "meteor/unchained:*": ["node_modules/@unchainedshop/types/index.d.ts"]
+    }
+  },
+  "include": ["src"]
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.build.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node", "mocha"]
+  },
+  "include": ["src", "tests"]
+}