@jarwizz/create-jarshop 0.1.4 → 0.1.6

package/dist/template/src/email-smoke.ts

@@ -14,6 +14,7 @@ async function main(): Promise<void> {
         "This is a controlled JarShop SMTP transport smoke message.",
         "No customer order, bearer token, or checkout data is included.",
       ].join("\n"),
+      html: "<p>This is a controlled JarShop SMTP transport smoke message. No customer order, bearer token, or checkout data is included.</p>",
     },
   });
   console.log("SMTP smoke email was accepted by the configured transport.");

package/dist/template/src/migrations/1787800000000-jarshop-order-email-event-key.ts

@@ -0,0 +1,60 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+/**
+ * Generalizes confirmation-only deduplication without replacing or deleting
+ * existing delivery history. New lifecycle events may omit checkoutAttemptId.
+ */
+export class JarShopOrderEmailEventKey1787800000000 implements MigrationInterface {
+  name = "JarShopOrderEmailEventKey1787800000000";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ADD "eventKey" character varying(255)`,
+    );
+    await queryRunner.query(`
+      UPDATE "jarshop_order_email_delivery"
+      SET "eventKey" = 'order:' || "orderId"::text || ':' || "kind"
+      WHERE "eventKey" IS NULL
+    `);
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ALTER COLUMN "eventKey" SET NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ALTER COLUMN "checkoutAttemptId" DROP NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" DROP CONSTRAINT "UQ_jarshop_order_email_delivery_order_kind"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ADD CONSTRAINT "UQ_jarshop_order_email_delivery_event_key" UNIQUE ("eventKey")`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      DO $$
+      BEGIN
+        IF EXISTS (
+          SELECT 1
+          FROM "jarshop_order_email_delivery"
+          WHERE "checkoutAttemptId" IS NULL OR "kind" <> 'order-confirmation'
+        ) THEN
+          RAISE EXCEPTION 'cannot restore confirmation-only order email schema while lifecycle deliveries exist';
+        END IF;
+      END
+      $$
+    `);
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" DROP CONSTRAINT "UQ_jarshop_order_email_delivery_event_key"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ALTER COLUMN "checkoutAttemptId" SET NOT NULL`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ADD CONSTRAINT "UQ_jarshop_order_email_delivery_order_kind" UNIQUE ("orderId", "kind")`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" DROP COLUMN "eventKey"`,
+    );
+  }
+}

package/dist/template/src/migrations/1787900000000-jarshop-email-brand-configuration.ts

@@ -0,0 +1,32 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class JarShopEmailBrandConfiguration1787900000000 implements MigrationInterface {
+  name = "JarShopEmailBrandConfiguration1787900000000";
+
+  async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_email_brand_configuration" (
+        "id" SERIAL NOT NULL,
+        "channelId" integer NOT NULL,
+        "brandName" character varying(120) NOT NULL,
+        "logoUrl" character varying(2048),
+        "primaryColor" character varying(7) NOT NULL,
+        "websiteUrl" character varying(2048) NOT NULL,
+        "supportEmail" character varying(320) NOT NULL,
+        "companyName" character varying(160) NOT NULL,
+        "companyAddress" text NOT NULL,
+        "enabledEvents" jsonb NOT NULL DEFAULT '[]'::jsonb,
+        "shippingMethods" jsonb NOT NULL DEFAULT '[]'::jsonb,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_email_brand_configuration" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_email_brand_configuration_channel" UNIQUE ("channelId"),
+        CONSTRAINT "FK_jarshop_email_brand_configuration_channel" FOREIGN KEY ("channelId") REFERENCES "channel"("id") ON DELETE CASCADE ON UPDATE CASCADE
+      )
+    `);
+  }
+
+  async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "jarshop_email_brand_configuration"`);
+  }
+}

package/dist/template/src/migrations/1788000000000-jarshop-email-brand-schema-parity.ts

@@ -0,0 +1,21 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class JarShopEmailBrandSchemaParity1788000000000 implements MigrationInterface {
+  name = "JarShopEmailBrandSchemaParity1788000000000";
+
+  async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE "jarshop_email_brand_configuration"
+      DROP CONSTRAINT IF EXISTS "FK_jarshop_email_brand_configuration_channel"
+    `);
+  }
+
+  async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE "jarshop_email_brand_configuration"
+      ADD CONSTRAINT "FK_jarshop_email_brand_configuration_channel"
+      FOREIGN KEY ("channelId") REFERENCES "channel"("id")
+      ON DELETE CASCADE ON UPDATE CASCADE
+    `);
+  }
+}

package/dist/template/src/plugins/jarshop-checkout/dashboard/index.tsx

@@ -1,13 +1,16 @@
 import { api, defineDashboardExtension, useQuery } from "@vendure/dashboard";
 import { graphql } from "@/gql";
+import { useState, type FormEvent } from "react";
 import {
   getDashboardOrderId,
-  toOrderEmailDeliveryStatusPanel,
+  toOrderEmailDeliveryTimeline,
 } from "./order-email-delivery-status.js";
 
-const orderEmailDeliveryStatusDocument = graphql(`
-  query JarShopOrderEmailDeliveryStatus($orderId: ID!) {
-    jarShopOrderEmailDeliveryStatus(orderId: $orderId) {
+const orderEmailDeliveriesDocument = graphql(`
+  query JarShopOrderEmailDeliveries($orderId: ID!) {
+    jarShopOrderEmailDeliveries(orderId: $orderId) {
+      deliveryId
+      kind
       status
       attemptCount
       nextAttemptAt
@@ -17,6 +20,37 @@ const orderEmailDeliveryStatusDocument = graphql(`
   }
 `);
 
+const emailBrandConfigurationDocument = graphql(`
+  query JarShopEmailBrandConfiguration {
+    jarShopEmailBrandConfiguration {
+      brandName
+      logoUrl
+      primaryColor
+      websiteUrl
+      supportEmail
+      companyName
+      companyAddress
+      enabledEvents
+      shippingMethods {
+        code
+        pickupDetails
+        trackingUrlTemplate
+      }
+    }
+  }
+`);
+
+const updateEmailBrandConfigurationDocument = graphql(`
+  mutation UpdateJarShopEmailBrandConfiguration(
+    $input: JarShopEmailBrandConfigurationInput!
+  ) {
+    updateJarShopEmailBrandConfiguration(input: $input) {
+      brandName
+      enabledEvents
+    }
+  }
+`);
+
 function formatDateTime(value: string): string {
   return new Intl.DateTimeFormat(undefined, {
     dateStyle: "medium",
@@ -30,7 +64,7 @@ function OrderEmailDeliveryStatusBlock({ context }: { context: unknown }) {
     queryKey: ["jarshop-order-email-delivery-status", orderId],
     enabled: orderId !== undefined,
     queryFn: () =>
-      api.query(orderEmailDeliveryStatusDocument, {
+      api.query(orderEmailDeliveriesDocument, {
         orderId: orderId ?? "",
       }),
   });
@@ -49,10 +83,10 @@ function OrderEmailDeliveryStatusBlock({ context }: { context: unknown }) {
     );
   }
 
-  const panel = toOrderEmailDeliveryStatusPanel(
-    query.data?.jarShopOrderEmailDeliveryStatus,
+  const timeline = toOrderEmailDeliveryTimeline(
+    query.data?.jarShopOrderEmailDeliveries ?? [],
   );
-  if (panel.kind === "unavailable") {
+  if (timeline.length === 0) {
     return (
       <p className="text-sm text-muted-foreground">
         No JarShop order email is queued for this order.
@@ -61,32 +95,168 @@ function OrderEmailDeliveryStatusBlock({ context }: { context: unknown }) {
   }
 
   return (
-    <dl className="grid gap-2 text-sm">
-      <div className="flex justify-between gap-4">
-        <dt className="text-muted-foreground">Status</dt>
-        <dd className="font-medium capitalize">{panel.status}</dd>
-      </div>
-      <div className="flex justify-between gap-4">
-        <dt className="text-muted-foreground">Attempts</dt>
-        <dd>{panel.attemptCount}</dd>
+    <ol className="grid gap-4 text-sm">
+      {timeline.map((delivery) => (
+        <li key={delivery.deliveryId} className="border-l-2 pl-3">
+          <div className="flex justify-between gap-4">
+            <strong className="capitalize">{delivery.label}</strong>
+            <span className="capitalize">{delivery.status}</span>
+          </div>
+          <p className="text-muted-foreground">
+            Attempts: {delivery.attemptCount} · Next:{" "}
+            {formatDateTime(delivery.nextAttemptAt)}
+          </p>
+          {delivery.sentAt ? (
+            <p>Sent: {formatDateTime(delivery.sentAt)}</p>
+          ) : null}
+          {delivery.lastErrorCode ? (
+            <p className="font-mono text-xs">{delivery.lastErrorCode}</p>
+          ) : null}
+        </li>
+      ))}
+    </ol>
+  );
+}
+
+function EmailBrandConfigurationBlock() {
+  const [message, setMessage] = useState<string>();
+  const query = useQuery({
+    queryKey: ["jarshop-email-brand-configuration"],
+    queryFn: () => api.query(emailBrandConfigurationDocument),
+  });
+  if (query.isPending) return <p>Loading email configuration…</p>;
+  if (query.isError)
+    return (
+      <p className="text-destructive">Email configuration is unavailable.</p>
+    );
+
+  const configuration = query.data?.jarShopEmailBrandConfiguration;
+  const methods = new Map(
+    configuration?.shippingMethods.map((method) => [method.code, method]),
+  );
+  const enabled = new Set(configuration?.enabledEvents ?? []);
+  const handleSubmit = async (event: FormEvent<HTMLFormElement>) => {
+    event.preventDefault();
+    setMessage(undefined);
+    const form = new FormData(event.currentTarget);
+    try {
+      await api.mutate(updateEmailBrandConfigurationDocument, {
+        input: {
+          brandName: String(form.get("brandName") ?? ""),
+          logoUrl: String(form.get("logoUrl") ?? "") || null,
+          primaryColor: String(form.get("primaryColor") ?? ""),
+          websiteUrl: String(form.get("websiteUrl") ?? ""),
+          supportEmail: String(form.get("supportEmail") ?? ""),
+          companyName: String(form.get("companyName") ?? ""),
+          companyAddress: String(form.get("companyAddress") ?? ""),
+          enabledEvents: form.getAll("enabledEvents").map(String),
+          shippingMethods: [
+            {
+              code: "pickup",
+              pickupDetails: String(form.get("pickupDetails") ?? ""),
+              trackingUrlTemplate: "",
+            },
+            {
+              code: "courier",
+              pickupDetails: "",
+              trackingUrlTemplate: String(
+                form.get("trackingUrlTemplate") ?? "",
+              ),
+            },
+          ],
+        },
+      });
+      setMessage("Email configuration saved.");
+      await query.refetch();
+    } catch {
+      setMessage("Email configuration could not be saved.");
+    }
+  };
+
+  return (
+    <form
+      key={JSON.stringify(configuration)}
+      onSubmit={handleSubmit}
+      className="grid gap-4 text-sm"
+    >
+      <div className="grid grid-cols-2 gap-3">
+        {[
+          ["brandName", "Brand name", configuration?.brandName],
+          [
+            "primaryColor",
+            "Primary color",
+            configuration?.primaryColor ?? "#111827",
+          ],
+          ["websiteUrl", "Website URL", configuration?.websiteUrl],
+          ["logoUrl", "Logo URL", configuration?.logoUrl],
+          ["supportEmail", "Support email", configuration?.supportEmail],
+          ["companyName", "Company name", configuration?.companyName],
+        ].map(([name, label, value]) => (
+          <label key={name} className="grid gap-1">
+            <span>{label}</span>
+            <input
+              className="rounded border bg-background px-3 py-2"
+              name={name}
+              defaultValue={value ?? ""}
+            />
+          </label>
+        ))}
       </div>
-      <div className="flex justify-between gap-4">
-        <dt className="text-muted-foreground">Next attempt</dt>
-        <dd>{formatDateTime(panel.nextAttemptAt)}</dd>
+      <label className="grid gap-1">
+        <span>Company address</span>
+        <textarea
+          className="rounded border bg-background px-3 py-2"
+          name="companyAddress"
+          defaultValue={configuration?.companyAddress ?? ""}
+        />
+      </label>
+      <label className="grid gap-1">
+        <span>Pickup details</span>
+        <textarea
+          className="rounded border bg-background px-3 py-2"
+          name="pickupDetails"
+          defaultValue={methods.get("pickup")?.pickupDetails ?? ""}
+        />
+      </label>
+      <label className="grid gap-1">
+        <span>Courier tracking URL template</span>
+        <input
+          className="rounded border bg-background px-3 py-2"
+          name="trackingUrlTemplate"
+          placeholder="https://carrier.example/track/{trackingCode}"
+          defaultValue={methods.get("courier")?.trackingUrlTemplate ?? ""}
+        />
+      </label>
+      <fieldset className="grid grid-cols-2 gap-2">
+        <legend className="mb-2 font-medium">Enabled lifecycle events</legend>
+        {[
+          "pickup-ready",
+          "pickup-picked-up",
+          "shipment-shipped",
+          "shipment-delivered",
+          "order-cancelled",
+        ].map((kind) => (
+          <label key={kind} className="flex gap-2">
+            <input
+              type="checkbox"
+              name="enabledEvents"
+              value={kind}
+              defaultChecked={enabled.has(kind)}
+            />
+            <span>{kind}</span>
+          </label>
+        ))}
+      </fieldset>
+      <div className="flex items-center gap-3">
+        <button
+          type="submit"
+          className="rounded bg-primary px-4 py-2 text-primary-foreground"
+        >
+          Save email configuration
+        </button>
+        {message ? <span>{message}</span> : null}
       </div>
-      {panel.sentAt ? (
-        <div className="flex justify-between gap-4">
-          <dt className="text-muted-foreground">Sent</dt>
-          <dd>{formatDateTime(panel.sentAt)}</dd>
-        </div>
-      ) : null}
-      {panel.lastErrorCode ? (
-        <div className="flex justify-between gap-4">
-          <dt className="text-muted-foreground">Error code</dt>
-          <dd className="font-mono text-xs">{panel.lastErrorCode}</dd>
-        </div>
-      ) : null}
-    </dl>
+    </form>
   );
 }
 
@@ -103,5 +273,16 @@ defineDashboardExtension({
       component: OrderEmailDeliveryStatusBlock,
       requiresPermission: "ReadOrder",
     },
+    {
+      id: "jarshop-email-brand-configuration",
+      title: "JarShop lifecycle email",
+      location: {
+        pageId: "channel-detail",
+        column: "main",
+        position: { blockId: "channel-defaults", order: "after" },
+      },
+      component: EmailBrandConfigurationBlock,
+      requiresPermission: "UpdateSettings",
+    },
   ],
 });

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

@@ -41,3 +41,20 @@ export function toOrderEmailDeliveryStatusPanel(
     lastErrorCode: delivery.lastErrorCode,
   };
 }
+
+export function toOrderEmailDeliveryTimeline(
+  deliveries: ReadonlyArray<{
+    deliveryId: string;
+    kind: string;
+    status: "pending" | "processing" | "sent" | "failed";
+    attemptCount: number;
+    nextAttemptAt: string;
+    sentAt: string | null;
+    lastErrorCode: string | null;
+  }>,
+) {
+  return deliveries.map((delivery) => ({
+    ...delivery,
+    label: delivery.kind.replaceAll("-", " "),
+  }));
+}

package/dist/template/src/plugins/jarshop-checkout/index.ts

@@ -13,14 +13,50 @@ export {
 } from "./confirmation.js";
 export { JarShopLegalConfiguration } from "./legal.entity.js";
 export { JarShopOrderEmailDelivery } from "./order-email-delivery.entity.js";
-export type { OrderEmailDeliveryStatus } from "./order-email-delivery.entity.js";
+export type {
+  OrderEmailDeliveryKind,
+  OrderEmailDeliveryStatus,
+} from "./order-email-delivery.entity.js";
+export { JarShopEmailBrandConfiguration } from "./order-email-configuration.entity.js";
+export type {
+  ConfigurableOrderEmailKind,
+  OrderEmailShippingMethodConfiguration,
+} from "./order-email-configuration.entity.js";
+export {
+  createTrackingUrl,
+  isLifecycleEmailEnabled,
+  normalizeOrderEmailBrandConfiguration,
+  resolveShippingEmailConfiguration,
+  toOrderEmailBrandConfiguration,
+  validateOrderEmailBrandConfiguration,
+  validateTrackingUrlTemplate,
+} from "./order-email-configuration.js";
+export type { OrderEmailBrandConfigurationInput } from "./order-email-configuration.js";
 export {
   assertOrderEmailOutboxEncryptionConfiguration,
+  createPendingCancellationEmailDelivery,
+  createPendingFulfillmentEmailDelivery,
+  createOrderConfirmationEventKey,
   createPendingOrderEmailDelivery,
   decryptOrderEmailOutboxPayload,
   encryptOrderEmailOutboxPayload,
+  isLegacyOrderConfirmationOutboxPayload,
+  isSnapshotOrderEmailOutboxPayload,
   parseOrderEmailEncryptionKey,
 } from "./order-email-outbox.js";
+export type {
+  FulfillmentLifecycleEmailKind,
+  FulfillmentLifecycleEmailSnapshot,
+  LegacyOrderConfirmationOutboxPayload,
+  OrderCancellationEmailSnapshot,
+  OrderConfirmationEmailSnapshot,
+  OrderEmailLineSnapshot,
+  OrderEmailOutboxPayload,
+} from "./order-email-outbox.js";
+export {
+  JarShopOrderEmailLifecycleOutbox,
+  toEmailLineSnapshots,
+} from "./order-email-lifecycle.js";
 export {
   assertOrderEmailDeliveryConfiguration,
   createFileOrderEmailTransport,
@@ -29,6 +65,7 @@ export {
   readOrderEmailTransportConfiguration,
   registerUniqueScheduledTask,
   renderOrderConfirmationEmail,
+  renderOrderLifecycleEmail,
   scheduleOrderEmailRetry,
   sanitizeFileTransportEmail,
   writeSanitizedFileTransport,
@@ -36,6 +73,7 @@ export {
 export type {
   OrderConfirmationEmail,
   OrderConfirmationEmailInput,
+  OrderLifecycleEmailInput,
   OrderEmailLanguageCode,
   OrderEmailTransport,
   OrderEmailTransportConfiguration,
@@ -48,4 +86,14 @@ export {
   registerJarShopOrderEmailWorkerTask,
 } from "./order-email-worker.js";
 export { JarShopOrderConsent } from "./order-consent.entity.js";
+export {
+  getCourierOrderAlignmentState,
+  resolveShippingMethodCodeForOrderLines,
+  toFulfillmentLifecycleEmailKind,
+  validateFulfillmentTransition,
+} from "./order-lifecycle-core.js";
+export {
+  jarShopFulfillmentProcess,
+  registerJarShopOrderLifecycle,
+} from "./order-lifecycle-process.js";
 export { JarShopCheckoutPlugin } from "./jarshop-checkout.plugin.js";