@jarwizz/create-jarshop 0.1.1 → 0.1.2

package/dist/template/src/environment.d.ts

@@ -5,6 +5,8 @@ declare global {
     interface ProcessEnv {
       APP_ENV?: string;
       PORT?: string;
+      JARSHOP_STOREFRONT_PORT?: string;
+      JARSHOP_COMMERCE_ENDPOINT?: string;
       COOKIE_SECRET?: string;
       SUPERADMIN_USERNAME?: string;
       SUPERADMIN_PASSWORD?: string;
@@ -14,6 +16,10 @@ declare global {
       DB_USERNAME?: string;
       DB_PASSWORD?: string;
       DB_SCHEMA?: string;
+      JARSHOP_ORDER_EMAIL_ENCRYPTION_KEY?: string;
+      JARSHOP_EMAIL_TRANSPORT?: string;
+      JARSHOP_EMAIL_FILE_TRANSPORT_PATH?: string;
+      JARSHOP_STOREFRONT_URL?: string;
     }
   }
 }

package/dist/template/src/migrate.ts

@@ -0,0 +1,16 @@
+import { runMigrations } from "@vendure/core";
+
+import { config } from "./vendure-config.js";
+
+runMigrations(config)
+  .then((migrations) => {
+    if (migrations.length === 0) {
+      console.log("Migrations are up to date.");
+      return;
+    }
+    console.log(`Applied migrations: ${migrations.join(", ")}`);
+  })
+  .catch((error: unknown) => {
+    console.error(error);
+    process.exitCode = 1;
+  });

package/dist/template/src/migrations/1786024108434-jarshop-checkout-attempt.ts

@@ -0,0 +1,28 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class JarShopCheckoutAttempt1786024108434 implements MigrationInterface {
+  name = "JarShopCheckoutAttempt1786024108434";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_checkout_attempt" (
+        "id" SERIAL NOT NULL,
+        "attemptId" character varying(36) NOT NULL,
+        "marketCode" character varying(64) NOT NULL,
+        "languageCode" character varying(32) NOT NULL,
+        "status" character varying(16) NOT NULL,
+        "inputHash" character varying(128) NOT NULL,
+        "orderId" integer,
+        "errorCode" character varying(64),
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_checkout_attempt" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_checkout_attempt_attempt_id" UNIQUE ("attemptId")
+      )
+    `);
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`DROP TABLE "jarshop_checkout_attempt"`);
+  }
+}

package/dist/template/src/migrations/1786024108435-jarshop-legal-and-confirmation.ts

@@ -0,0 +1,60 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class JarShopLegalAndConfirmation1786024108435 implements MigrationInterface {
+  name = "JarShopLegalAndConfirmation1786024108435";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_legal_configuration" (
+        "id" SERIAL NOT NULL,
+        "channelId" integer NOT NULL,
+        "languageCode" character varying(10) NOT NULL,
+        "termsVersion" character varying(64) NOT NULL,
+        "termsUrl" character varying(2048) NOT NULL,
+        "privacyVersion" character varying(64) NOT NULL,
+        "privacyUrl" character varying(2048) NOT NULL,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_legal_configuration" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_legal_channel_language" UNIQUE ("channelId", "languageCode")
+      )
+    `);
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_order_consent" (
+        "id" SERIAL NOT NULL,
+        "orderId" integer NOT NULL,
+        "termsVersion" character varying(64) NOT NULL,
+        "termsUrl" character varying(2048) NOT NULL,
+        "privacyUrl" character varying(2048) NOT NULL,
+        "acceptedAt" TIMESTAMP WITH TIME ZONE NOT NULL,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_order_consent" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_order_consent_order" UNIQUE ("orderId")
+      )
+    `);
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_confirmation_token" (
+        "id" SERIAL NOT NULL,
+        "tokenHash" character varying(128) NOT NULL,
+        "orderId" integer NOT NULL,
+        "expiresAt" TIMESTAMP WITH TIME ZONE NOT NULL,
+        "consumedAt" TIMESTAMP WITH TIME ZONE,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_confirmation_token" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_confirmation_token_hash" UNIQUE ("tokenHash")
+      )
+    `);
+    await queryRunner.query(
+      `CREATE INDEX "IDX_jarshop_confirmation_token_order" ON "jarshop_confirmation_token" ("orderId")`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DROP INDEX "IDX_jarshop_confirmation_token_order"`,
+    );
+    await queryRunner.query(`DROP TABLE "jarshop_confirmation_token"`);
+    await queryRunner.query(`DROP TABLE "jarshop_order_consent"`);
+    await queryRunner.query(`DROP TABLE "jarshop_legal_configuration"`);
+  }
+}

package/dist/template/src/migrations/1786024108436-jarshop-order-email-outbox.ts

@@ -0,0 +1,37 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class JarShopOrderEmailOutbox1786024108436 implements MigrationInterface {
+  name = "JarShopOrderEmailOutbox1786024108436";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      CREATE TABLE "jarshop_order_email_delivery" (
+        "id" SERIAL NOT NULL,
+        "orderId" integer NOT NULL,
+        "checkoutAttemptId" character varying(36) NOT NULL,
+        "kind" character varying(64) NOT NULL,
+        "languageCode" character varying(10) NOT NULL,
+        "status" character varying(16) NOT NULL,
+        "payloadCiphertext" text NOT NULL,
+        "attemptCount" integer NOT NULL DEFAULT 0,
+        "nextAttemptAt" TIMESTAMP WITH TIME ZONE NOT NULL,
+        "lastErrorCode" character varying(64),
+        "sentAt" TIMESTAMP WITH TIME ZONE,
+        "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+        "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+        CONSTRAINT "PK_jarshop_order_email_delivery" PRIMARY KEY ("id"),
+        CONSTRAINT "UQ_jarshop_order_email_delivery_order_kind" UNIQUE ("orderId", "kind")
+      )
+    `);
+    await queryRunner.query(
+      `CREATE INDEX "IDX_jarshop_order_email_delivery_pending" ON "jarshop_order_email_delivery" ("status", "nextAttemptAt")`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `DROP INDEX "IDX_jarshop_order_email_delivery_pending"`,
+    );
+    await queryRunner.query(`DROP TABLE "jarshop_order_email_delivery"`);
+  }
+}

package/dist/template/src/migrations/1786030000000-jarshop-order-email-delivery-lease.ts

@@ -0,0 +1,27 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+/**
+ * This is additive and nullable: existing pending/sent deliveries remain valid
+ * while application code rolls forward. It must not delete delivery intent.
+ */
+export class JarShopOrderEmailDeliveryLease1786030000000 implements MigrationInterface {
+  name = "JarShopOrderEmailDeliveryLease1786030000000";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ADD "leaseToken" character varying(36)`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" ADD "leaseExpiresAt" TIMESTAMP WITH TIME ZONE`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" DROP COLUMN "leaseExpiresAt"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "jarshop_order_email_delivery" DROP COLUMN "leaseToken"`,
+    );
+  }
+}

package/dist/template/src/plugins/jarshop-checkout/checkout-attempt.entity.ts

@@ -0,0 +1,42 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from "typeorm";
+
+export type CheckoutAttemptStatus = "processing" | "completed" | "failed";
+
+@Entity({ name: "jarshop_checkout_attempt" })
+export class CheckoutAttempt {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Column({ type: "varchar", length: 36, unique: true })
+  attemptId!: string;
+
+  @Column({ type: "varchar", length: 64 })
+  marketCode!: string;
+
+  @Column({ type: "varchar", length: 32 })
+  languageCode!: string;
+
+  @Column({ type: "varchar", length: 16 })
+  status!: CheckoutAttemptStatus;
+
+  @Column({ type: "varchar", length: 128 })
+  inputHash!: string;
+
+  @Column({ type: "int", nullable: true })
+  orderId!: number | null;
+
+  @Column({ type: "varchar", length: 64, nullable: true })
+  errorCode!: string | null;
+
+  @CreateDateColumn()
+  createdAt!: Date;
+
+  @UpdateDateColumn()
+  updatedAt!: Date;
+}

package/dist/template/src/plugins/jarshop-checkout/confirmation-token.entity.ts

@@ -0,0 +1,31 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  PrimaryGeneratedColumn,
+  Unique,
+} from "typeorm";
+
+@Entity({ name: "jarshop_confirmation_token" })
+export class JarShopConfirmationToken {
+  @PrimaryGeneratedColumn()
+  id!: number;
+
+  @Unique("UQ_jarshop_confirmation_token_hash", ["tokenHash"])
+  @Column({ type: "varchar", length: 128 })
+  tokenHash!: string;
+
+  @Index("IDX_jarshop_confirmation_token_order")
+  @Column({ type: "int" })
+  orderId!: number;
+
+  @Column({ type: "timestamptz" })
+  expiresAt!: Date;
+
+  @Column({ type: "timestamptz", nullable: true })
+  consumedAt!: Date | null;
+
+  @CreateDateColumn()
+  createdAt!: Date;
+}

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

@@ -0,0 +1,26 @@
+import { createHash, randomBytes } from "node:crypto";
+
+export const CONFIRMATION_TTL_MS = 2 * 60 * 60 * 1000;
+
+export function hashConfirmationToken(token: string): string {
+  return createHash("sha256").update(token).digest("hex");
+}
+
+export function createConfirmationToken(now = Date.now()) {
+  const token = randomBytes(32).toString("base64url");
+  return {
+    token,
+    tokenHash: hashConfirmationToken(token),
+    expiresAt: new Date(now + CONFIRMATION_TTL_MS),
+  };
+}
+
+export function canUseConfirmationToken(input: {
+  expiresAt: Date;
+  consumedAt: Date | null;
+  cookieMatches: boolean;
+  now?: number;
+}): boolean {
+  if (input.expiresAt.getTime() <= (input.now ?? Date.now())) return false;
+  return input.consumedAt === null || input.cookieMatches;
+}

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

@@ -0,0 +1,107 @@
+import { api, defineDashboardExtension, useQuery } from "@vendure/dashboard";
+import { graphql } from "@/gql";
+import {
+  getDashboardOrderId,
+  toOrderEmailDeliveryStatusPanel,
+} from "./order-email-delivery-status.js";
+
+const orderEmailDeliveryStatusDocument = graphql(`
+  query JarShopOrderEmailDeliveryStatus($orderId: ID!) {
+    jarShopOrderEmailDeliveryStatus(orderId: $orderId) {
+      status
+      attemptCount
+      nextAttemptAt
+      sentAt
+      lastErrorCode
+    }
+  }
+`);
+
+function formatDateTime(value: string): string {
+  return new Intl.DateTimeFormat(undefined, {
+    dateStyle: "medium",
+    timeStyle: "short",
+  }).format(new Date(value));
+}
+
+function OrderEmailDeliveryStatusBlock({ context }: { context: unknown }) {
+  const orderId = getDashboardOrderId((context as { entity?: unknown }).entity);
+  const query = useQuery({
+    queryKey: ["jarshop-order-email-delivery-status", orderId],
+    enabled: orderId !== undefined,
+    queryFn: () =>
+      api.query(orderEmailDeliveryStatusDocument, {
+        orderId: orderId ?? "",
+      }),
+  });
+
+  if (!orderId) return null;
+  if (query.isPending) {
+    return (
+      <p className="text-sm text-muted-foreground">Loading delivery status…</p>
+    );
+  }
+  if (query.isError) {
+    return (
+      <p className="text-sm text-destructive">
+        Delivery status is currently unavailable.
+      </p>
+    );
+  }
+
+  const panel = toOrderEmailDeliveryStatusPanel(
+    query.data?.jarShopOrderEmailDeliveryStatus,
+  );
+  if (panel.kind === "unavailable") {
+    return (
+      <p className="text-sm text-muted-foreground">
+        No JarShop order email is queued for this order.
+      </p>
+    );
+  }
+
+  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>
+      </div>
+      <div className="flex justify-between gap-4">
+        <dt className="text-muted-foreground">Next attempt</dt>
+        <dd>{formatDateTime(panel.nextAttemptAt)}</dd>
+      </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>
+  );
+}
+
+defineDashboardExtension({
+  pageBlocks: [
+    {
+      id: "jarshop-order-email-delivery-status",
+      title: "Email delivery",
+      location: {
+        pageId: "order-detail",
+        column: "side",
+        position: { blockId: "state", order: "after" },
+      },
+      component: OrderEmailDeliveryStatusBlock,
+      requiresPermission: "ReadOrder",
+    },
+  ],
+});

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

@@ -0,0 +1,43 @@
+export type OrderEmailDeliveryStatusPanel =
+  | { kind: "unavailable" }
+  | {
+      kind: "ready";
+      status: "pending" | "processing" | "sent" | "failed";
+      attemptCount: number;
+      nextAttemptAt: string;
+      sentAt: string | null;
+      lastErrorCode: string | null;
+    };
+
+export function getDashboardOrderId(entity: unknown): string | undefined {
+  if (!entity || typeof entity !== "object") return undefined;
+  const id = (entity as { id?: unknown }).id;
+  if (typeof id === "string" && id.trim()) return id;
+  if (typeof id === "number" && Number.isSafeInteger(id) && id > 0) {
+    return String(id);
+  }
+  return undefined;
+}
+
+export function toOrderEmailDeliveryStatusPanel(
+  delivery:
+    | {
+        status: "pending" | "processing" | "sent" | "failed";
+        attemptCount: number;
+        nextAttemptAt: string;
+        sentAt: string | null;
+        lastErrorCode: string | null;
+      }
+    | null
+    | undefined,
+): OrderEmailDeliveryStatusPanel {
+  if (!delivery) return { kind: "unavailable" };
+  return {
+    kind: "ready",
+    status: delivery.status,
+    attemptCount: delivery.attemptCount,
+    nextAttemptAt: delivery.nextAttemptAt,
+    sentAt: delivery.sentAt,
+    lastErrorCode: delivery.lastErrorCode,
+  };
+}

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

@@ -0,0 +1,56 @@
+import {
+  readOrderEmailTransportConfiguration,
+  type SmtpOrderEmailTransportConfiguration,
+} from "./order-email-delivery-core.js";
+
+type Environment = Readonly<Record<string, string | undefined>>;
+
+export type SmtpSmokeCommand = {
+  recipient: string;
+  configuration: SmtpOrderEmailTransportConfiguration;
+};
+
+export function parseSmtpSmokeCommand(
+  arguments_: readonly string[],
+  environment: Environment,
+): SmtpSmokeCommand {
+  if (environment.APP_ENV !== "staging") {
+    throw new Error("SMTP smoke is allowed only when APP_ENV=staging");
+  }
+  if (!arguments_.includes("--confirm-external-send")) {
+    throw new Error("SMTP smoke requires --confirm-external-send");
+  }
+  const recipient = readRecipient(arguments_);
+  const configuration = readOrderEmailTransportConfiguration(environment);
+  if (configuration.kind !== "smtp") {
+    throw new Error("SMTP smoke requires JARSHOP_EMAIL_TRANSPORT=smtp");
+  }
+  return { recipient, configuration };
+}
+
+function readRecipient(arguments_: readonly string[]): string {
+  const toIndex = arguments_.indexOf("--to");
+  const recipient =
+    toIndex === -1 ? undefined : arguments_[toIndex + 1]?.trim();
+  if (recipient === undefined || !isEmailAddress(recipient)) {
+    throw new Error("SMTP smoke requires a valid --to email address");
+  }
+  if (
+    arguments_.some(
+      (argument, index) =>
+        (argument === "--to" && index !== toIndex) ||
+        (argument !== "--to" &&
+          argument !== "--confirm-external-send" &&
+          index !== toIndex + 1),
+    )
+  ) {
+    throw new Error(
+      "SMTP smoke supports only --to and --confirm-external-send",
+    );
+  }
+  return recipient;
+}
+
+function isEmailAddress(value: string): boolean {
+  return /^[^\s@]+@[^\s@]+\.[^\s@]+$/u.test(value);
+}

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

@@ -0,0 +1,47 @@
+export { CheckoutAttempt } from "./checkout-attempt.entity.js";
+export type { CheckoutAttemptStatus } from "./checkout-attempt.entity.js";
+export { JarShopConfirmationToken } from "./confirmation-token.entity.js";
+export {
+  CONFIRMATION_TTL_MS,
+  canUseConfirmationToken,
+  createConfirmationToken,
+  hashConfirmationToken,
+} 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 {
+  assertOrderEmailOutboxEncryptionConfiguration,
+  createPendingOrderEmailDelivery,
+  decryptOrderEmailOutboxPayload,
+  encryptOrderEmailOutboxPayload,
+  parseOrderEmailEncryptionKey,
+} from "./order-email-outbox.js";
+export {
+  assertOrderEmailDeliveryConfiguration,
+  createFileOrderEmailTransport,
+  createSmtpOrderEmailTransport,
+  orderEmailDeliveryPolicy,
+  readOrderEmailTransportConfiguration,
+  registerUniqueScheduledTask,
+  renderOrderConfirmationEmail,
+  scheduleOrderEmailRetry,
+  sanitizeFileTransportEmail,
+  writeSanitizedFileTransport,
+} from "./order-email-delivery-core.js";
+export type {
+  OrderConfirmationEmail,
+  OrderConfirmationEmailInput,
+  OrderEmailLanguageCode,
+  OrderEmailTransport,
+  OrderEmailTransportConfiguration,
+  SmtpOrderEmailTransportConfiguration,
+} from "./order-email-delivery-core.js";
+export { createConfiguredOrderEmailTransport } from "./order-email-transport.js";
+export { parseSmtpSmokeCommand } from "./email-smoke-core.js";
+export {
+  jarShopOrderEmailWorkerTask,
+  registerJarShopOrderEmailWorkerTask,
+} from "./order-email-worker.js";
+export { JarShopOrderConsent } from "./order-consent.entity.js";
+export { JarShopCheckoutPlugin } from "./jarshop-checkout.plugin.js";