@jarwizz/create-jarshop 0.1.1 → 0.1.3

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,51 @@
+export { CheckoutAttempt } from "./checkout-attempt.entity.js";
+export type { CheckoutAttemptStatus } from "./checkout-attempt.entity.js";
+export { jarShopCodPaymentHandler } from "./cod-payment.js";
+export { JarShopConfirmationToken } from "./confirmation-token.entity.js";
+export {
+  CONFIRMATION_TTL_MS,
+  CONFIRMATION_COOKIE_NAME,
+  canExchangeConfirmationToken,
+  canReadConfirmationCredential,
+  createConfirmationToken,
+  hashConfirmationToken,
+  readCookieValue,
+} 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";