@jarwizz/create-jarshop 0.1.4 → 0.1.5

package/dist/template/src/plugins/jarshop-checkout/order-email-delivery-core.ts

@@ -1,5 +1,15 @@
 import { mkdir, rename, writeFile } from "node:fs/promises";
 import path from "node:path";
+import type { JarShopEmailBrandConfiguration } from "./order-email-configuration.entity.js";
+import {
+  createTrackingUrl,
+  resolveShippingEmailConfiguration,
+} from "./order-email-configuration.js";
+import type {
+  FulfillmentLifecycleEmailKind,
+  FulfillmentLifecycleEmailSnapshot,
+  OrderCancellationEmailSnapshot,
+} from "./order-email-outbox.js";
 
 const fileTransport = "file";
 const defaultStorefrontUrl = "http://localhost:3001";
@@ -11,6 +21,7 @@ export type OrderConfirmationEmail = {
   recipient: string;
   subject: string;
   text: string;
+  html: string;
 };
 
 export type OrderEmailTransport = {
@@ -55,8 +66,21 @@ export type OrderConfirmationEmailInput = {
     quantity: number;
     totalWithTax: number;
   }>;
+  brandConfiguration?: JarShopEmailBrandConfiguration;
 };
 
+export type OrderLifecycleEmailInput =
+  | {
+      kind: FulfillmentLifecycleEmailKind;
+      snapshot: FulfillmentLifecycleEmailSnapshot;
+      brandConfiguration: JarShopEmailBrandConfiguration;
+    }
+  | {
+      kind: "order-cancelled";
+      snapshot: OrderCancellationEmailSnapshot;
+      brandConfiguration: JarShopEmailBrandConfiguration;
+    };
+
 export const orderEmailDeliveryPolicy = {
   maximumAttempts: 5,
   leaseDurationMs: 2 * 60 * 1_000,
@@ -182,6 +206,7 @@ export function createSmtpOrderEmailTransport(
     to: string;
     subject: string;
     text: string;
+    html: string;
   }) => Promise<unknown>,
 ): OrderEmailTransport {
   return {
@@ -192,6 +217,7 @@ export function createSmtpOrderEmailTransport(
         to: email.recipient,
         subject: email.subject,
         text: email.text,
+        html: email.html,
       });
     },
   };
@@ -210,22 +236,104 @@ export function renderOrderConfirmationEmail(
   const lines = input.lines.map(
     (line) => `- ${line.quantity}× ${line.name}: ${money(line.totalWithTax)}`,
   );
+  const brand = input.brandConfiguration ?? defaultBrandConfiguration;
 
+  const text = [
+    `${copy.greeting} #${input.orderCode}.`,
+    "",
+    copy.items,
+    ...lines,
+    "",
+    `${copy.shipping}: ${input.shippingMethod || copy.notAvailable} (${money(input.shippingWithTax)})`,
+    `${copy.payment}: ${input.paymentMethod || copy.notAvailable}`,
+    `${copy.total}: ${money(input.totalWithTax)}`,
+    "",
+    `${copy.confirmation}: ${input.confirmationUrl}`,
+    "",
+    ...renderTextBrandFooter(brand),
+  ].join("\n");
   return {
     recipient: input.recipient,
     subject: `${copy.subject} #${input.orderCode}`,
-    text: [
-      `${copy.greeting} #${input.orderCode}.`,
-      "",
-      copy.items,
-      ...lines,
-      "",
-      `${copy.shipping}: ${input.shippingMethod || copy.notAvailable} (${money(input.shippingWithTax)})`,
-      `${copy.payment}: ${input.paymentMethod || copy.notAvailable}`,
-      `${copy.total}: ${money(input.totalWithTax)}`,
-      "",
-      `${copy.confirmation}: ${input.confirmationUrl}`,
-    ].join("\n"),
+    text,
+    html: renderBrandedEmailHtml({
+      brand,
+      languageCode,
+      heading: `${copy.subject} #${input.orderCode}`,
+      intro: `${copy.greeting} #${input.orderCode}.`,
+      lines: input.lines,
+      currencyCode: input.currencyCode,
+      details: [
+        [copy.shipping, input.shippingMethod || copy.notAvailable],
+        [copy.payment, input.paymentMethod || copy.notAvailable],
+        [copy.total, money(input.totalWithTax)],
+      ],
+      action: { label: copy.confirmation, url: input.confirmationUrl },
+    }),
+  };
+}
+
+export function renderOrderLifecycleEmail(
+  input: OrderLifecycleEmailInput,
+): OrderConfirmationEmail {
+  const { snapshot } = input;
+  const languageCode = toOrderEmailLanguageCode(snapshot.languageCode);
+  const copy = lifecycleEmailCopy[languageCode][input.kind];
+  const money = createMoneyFormatter(languageCode, snapshot.currencyCode);
+  const methodConfiguration =
+    input.kind === "order-cancelled"
+      ? undefined
+      : resolveShippingEmailConfiguration(
+          input.brandConfiguration,
+          input.snapshot.shippingMethodCode,
+        );
+  const trackingUrl =
+    input.kind === "shipment-shipped"
+      ? createTrackingUrl(
+          methodConfiguration?.trackingUrlTemplate ?? "",
+          input.snapshot.trackingCode,
+        )
+      : undefined;
+  const extraText =
+    input.kind === "pickup-ready"
+      ? methodConfiguration?.pickupDetails.trim()
+      : undefined;
+  const lines = snapshot.lines.map(
+    (line) => `- ${line.quantity}× ${line.name}: ${money(line.totalWithTax)}`,
+  );
+  const text = [
+    `${copy.intro} #${snapshot.orderCode}.`,
+    "",
+    copy.items,
+    ...lines,
+    "",
+    `${copy.total}: ${money(snapshot.totalWithTax)}`,
+    ...(extraText ? ["", `${copy.details}: ${extraText}`] : []),
+    ...(trackingUrl ? ["", `${copy.tracking}: ${trackingUrl}`] : []),
+    "",
+    ...renderTextBrandFooter(input.brandConfiguration),
+  ].join("\n");
+  return {
+    recipient: snapshot.recipient,
+    subject: `${copy.subject} #${snapshot.orderCode}`,
+    text,
+    html: renderBrandedEmailHtml({
+      brand: input.brandConfiguration,
+      languageCode,
+      heading: `${copy.subject} #${snapshot.orderCode}`,
+      intro: `${copy.intro} #${snapshot.orderCode}.`,
+      lines: snapshot.lines,
+      currencyCode: snapshot.currencyCode,
+      details: [
+        [copy.total, money(snapshot.totalWithTax)],
+        ...(extraText
+          ? ([[copy.details, extraText]] as [string, string][])
+          : []),
+      ],
+      ...(trackingUrl
+        ? { action: { label: copy.tracking, url: trackingUrl } }
+        : {}),
+    }),
   };
 }
 
@@ -264,7 +372,10 @@ export function sanitizeFileTransportEmail(
     "To: [redacted]",
     `Subject: ${email.subject}`,
     "",
-    email.text.replace(/([?&]token=)[^\s]+/gu, "$1[redacted]"),
+    redactEmailTokens(email.text),
+    "",
+    "HTML:",
+    redactEmailTokens(email.html),
   ].join("\n");
 }
 
@@ -335,3 +446,200 @@ const emailCopy = {
     notAvailable: "not available",
   },
 } as const;
+
+const lifecycleEmailCopy = {
+  sk: {
+    "pickup-ready": {
+      subject: "Objednávka je pripravená na vyzdvihnutie",
+      intro: "Vaša objednávka je pripravená na vyzdvihnutie",
+      items: "Pripravené položky:",
+      total: "Aktuálna suma objednávky",
+      details: "Miesto a pokyny na vyzdvihnutie",
+      tracking: "Sledovanie zásielky",
+    },
+    "pickup-picked-up": {
+      subject: "Objednávka bola vyzdvihnutá",
+      intro: "Vaša objednávka bola vyzdvihnutá",
+      items: "Vyzdvihnuté položky:",
+      total: "Celkom",
+      details: "Podrobnosti",
+      tracking: "Sledovanie zásielky",
+    },
+    "shipment-shipped": {
+      subject: "Objednávka bola odoslaná",
+      intro: "Časť vašej objednávky bola odoslaná",
+      items: "Odoslané položky:",
+      total: "Aktuálna suma objednávky",
+      details: "Podrobnosti",
+      tracking: "Sledovať zásielku",
+    },
+    "shipment-delivered": {
+      subject: "Objednávka bola doručená",
+      intro: "Časť vašej objednávky bola doručená",
+      items: "Doručené položky:",
+      total: "Aktuálna suma objednávky",
+      details: "Podrobnosti",
+      tracking: "Sledovanie zásielky",
+    },
+    "order-cancelled": {
+      subject: "Objednávka bola zrušená",
+      intro: "V objednávke bola vykonaná storno operácia",
+      items: "Zrušené položky:",
+      total: "Nová suma objednávky",
+      details: "Podrobnosti",
+      tracking: "Sledovanie zásielky",
+    },
+  },
+  en: {
+    "pickup-ready": {
+      subject: "Order ready for pickup",
+      intro: "Your order is ready for pickup",
+      items: "Items ready for pickup:",
+      total: "Current order total",
+      details: "Pickup location and instructions",
+      tracking: "Track shipment",
+    },
+    "pickup-picked-up": {
+      subject: "Order picked up",
+      intro: "Your order has been picked up",
+      items: "Picked-up items:",
+      total: "Total",
+      details: "Details",
+      tracking: "Track shipment",
+    },
+    "shipment-shipped": {
+      subject: "Order shipped",
+      intro: "Part of your order has been shipped",
+      items: "Shipped items:",
+      total: "Current order total",
+      details: "Details",
+      tracking: "Track shipment",
+    },
+    "shipment-delivered": {
+      subject: "Order delivered",
+      intro: "Part of your order has been delivered",
+      items: "Delivered items:",
+      total: "Current order total",
+      details: "Details",
+      tracking: "Track shipment",
+    },
+    "order-cancelled": {
+      subject: "Order cancelled",
+      intro: "A cancellation was applied to your order",
+      items: "Cancelled items:",
+      total: "New order total",
+      details: "Details",
+      tracking: "Track shipment",
+    },
+  },
+} as const;
+
+const defaultBrandConfiguration = {
+  brandName: "JarShop",
+  logoUrl: null,
+  primaryColor: "#111827",
+  websiteUrl: "https://jarwizz.com",
+  supportEmail: "support@jarwizz.com",
+  companyName: "JarShop",
+  companyAddress: "",
+} as const;
+
+function createMoneyFormatter(
+  languageCode: OrderEmailLanguageCode,
+  currencyCode: string,
+) {
+  const formatter = new Intl.NumberFormat(
+    languageCode === "sk" ? "sk-SK" : "en-GB",
+    { style: "currency", currency: currencyCode },
+  );
+  return (minorUnits: number) => formatter.format(minorUnits / 100);
+}
+
+function renderBrandedEmailHtml(input: {
+  brand: Pick<
+    JarShopEmailBrandConfiguration,
+    | "brandName"
+    | "logoUrl"
+    | "primaryColor"
+    | "websiteUrl"
+    | "supportEmail"
+    | "companyName"
+    | "companyAddress"
+  >;
+  languageCode: OrderEmailLanguageCode;
+  heading: string;
+  intro: string;
+  lines: ReadonlyArray<{
+    name: string;
+    quantity: number;
+    totalWithTax: number;
+  }>;
+  currencyCode: string;
+  details: readonly (readonly [string, string])[];
+  action?: { label: string; url: string };
+}): string {
+  const money = new Intl.NumberFormat(
+    input.languageCode === "sk" ? "sk-SK" : "en-GB",
+    {
+      style: "currency",
+      currency: input.currencyCode,
+    },
+  );
+  const logo = input.brand.logoUrl
+    ? `<img src="${escapeHtml(input.brand.logoUrl)}" alt="${escapeHtml(input.brand.brandName)}" style="max-height:56px;max-width:180px">`
+    : `<strong style="font-size:24px">${escapeHtml(input.brand.brandName)}</strong>`;
+  const itemRows = input.lines
+    .map(
+      (line) =>
+        `<tr><td style="padding:8px;border-bottom:1px solid #e5e7eb">${escapeHtml(`${line.quantity}× ${line.name}`)}</td><td style="padding:8px;border-bottom:1px solid #e5e7eb;text-align:right">${escapeHtml(money.format(line.totalWithTax / 100))}</td></tr>`,
+    )
+    .join("");
+  const details = input.details
+    .map(
+      ([label, value]) =>
+        `<p><strong>${escapeHtml(label)}:</strong> ${escapeHtml(value)}</p>`,
+    )
+    .join("");
+  const action = input.action
+    ? `<p style="margin:24px 0"><a href="${escapeHtml(input.action.url)}" style="background:${escapeHtml(input.brand.primaryColor)};color:#fff;padding:12px 18px;text-decoration:none;border-radius:4px">${escapeHtml(input.action.label)}</a></p>`
+    : "";
+  return `<!doctype html><html><body style="margin:0;background:#f3f4f6;font-family:Arial,sans-serif;color:#111827"><main style="max-width:640px;margin:0 auto;background:#fff;padding:32px"><header><a href="${escapeHtml(input.brand.websiteUrl)}" style="color:${escapeHtml(input.brand.primaryColor)}">${logo}</a></header><h1 style="color:${escapeHtml(input.brand.primaryColor)}">${escapeHtml(input.heading)}</h1><p>${escapeHtml(input.intro)}</p><table style="width:100%;border-collapse:collapse">${itemRows}</table>${details}${action}<footer style="margin-top:32px;padding-top:16px;border-top:1px solid #e5e7eb;font-size:12px;color:#6b7280"><p>${escapeHtml(input.brand.companyName)}<br>${escapeHtml(input.brand.companyAddress)}</p><p><a href="mailto:${escapeHtml(input.brand.supportEmail)}">${escapeHtml(input.brand.supportEmail)}</a></p></footer></main></body></html>`;
+}
+
+function renderTextBrandFooter(
+  brand: Pick<
+    JarShopEmailBrandConfiguration,
+    | "brandName"
+    | "websiteUrl"
+    | "supportEmail"
+    | "companyName"
+    | "companyAddress"
+  >,
+): string[] {
+  return [
+    brand.brandName,
+    brand.companyName,
+    brand.companyAddress,
+    brand.websiteUrl,
+    brand.supportEmail,
+  ].filter((value, index, values) => value && values.indexOf(value) === index);
+}
+
+function escapeHtml(value: string): string {
+  return value.replace(/[&<>"']/gu, (character) => htmlEscapes[character]);
+}
+
+function redactEmailTokens(value: string): string {
+  return value.replace(
+    /([?&](?:token|credential)=)[^\s"'&<]+/gu,
+    "$1[redacted]",
+  );
+}
+
+const htmlEscapes: Record<string, string> = {
+  "&": "&amp;",
+  "<": "&lt;",
+  ">": "&gt;",
+  '"': "&quot;",
+  "'": "&#39;",
+};

package/dist/template/src/plugins/jarshop-checkout/order-email-delivery-status.ts

@@ -1,7 +1,9 @@
+import type { OrderEmailDeliveryKind } from "./order-email-delivery.entity.js";
+
 export type OrderEmailDeliveryStatusRecord = {
   id: number;
   orderId: number;
-  kind: "order-confirmation";
+  kind: OrderEmailDeliveryKind;
   status: "pending" | "processing" | "sent" | "failed";
   attemptCount: number;
   nextAttemptAt: Date;

package/dist/template/src/plugins/jarshop-checkout/order-email-delivery.entity.ts

@@ -11,8 +11,16 @@ import {
 export type OrderEmailDeliveryStatus =
   "pending" | "processing" | "sent" | "failed";
 
+export type OrderEmailDeliveryKind =
+  | "order-confirmation"
+  | "pickup-ready"
+  | "pickup-picked-up"
+  | "shipment-shipped"
+  | "shipment-delivered"
+  | "order-cancelled";
+
 @Entity({ name: "jarshop_order_email_delivery" })
-@Unique("UQ_jarshop_order_email_delivery_order_kind", ["orderId", "kind"])
+@Unique("UQ_jarshop_order_email_delivery_event_key", ["eventKey"])
 @Index("IDX_jarshop_order_email_delivery_pending", ["status", "nextAttemptAt"])
 export class JarShopOrderEmailDelivery {
   @PrimaryGeneratedColumn()
@@ -21,11 +29,14 @@ export class JarShopOrderEmailDelivery {
   @Column({ type: "int" })
   orderId!: number;
 
-  @Column({ type: "varchar", length: 36 })
-  checkoutAttemptId!: string;
+  @Column({ type: "varchar", length: 255 })
+  eventKey!: string;
+
+  @Column({ type: "varchar", length: 36, nullable: true })
+  checkoutAttemptId!: string | null;
 
   @Column({ type: "varchar", length: 64 })
-  kind!: "order-confirmation";
+  kind!: OrderEmailDeliveryKind;
 
   @Column({ type: "varchar", length: 10 })
   languageCode!: string;