platform-types 1.10.788 → 1.10.789

package/dist/cjs/guestOrderStatus.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * Guest order status link — the read-only page a buyer with no account opens
+ * from the order email (`/pedido/{token}`), and the route that mails a fresh
+ * link to the address stored on the order.
+ *
+ * The token (`gs1.…`) is a bearer credential over exactly ONE order, read-only:
+ * it authorises no cart write, payment, cancellation, withdrawal or export. It
+ * carries no expiry; the read is refused once the order was delivered (or
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago, and every
+ * earlier link dies when a recovery or an operator revokes it.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GUEST_ORDER_STATUS_LINK_TEMPLATE = exports.GUEST_ORDER_STATUS_ERROR_CODES = void 0;
+/**
+ * The refusals the guest status routes answer themselves.
+ *
+ * - GUEST_STATUS_TOKEN_INVALID (401): every reason the token cannot be honoured
+ *   — missing, tampered, another version, minted for another store or presented
+ *   on another store's host, revoked (a newer link was sent), past the delivery
+ *   horizon, or naming an order that is gone or is not a guest order — with one
+ *   identical body, so the token is never an oracle. Ask for a new link through
+ *   `POST /orders/status/recover`.
+ */
+exports.GUEST_ORDER_STATUS_ERROR_CODES = ['GUEST_STATUS_TOKEN_INVALID'];
+/** The transactional email template that mails a guest their (new) status link. */
+exports.GUEST_ORDER_STATUS_LINK_TEMPLATE = 'guest-order-status-link';

package/dist/cjs/index.js

@@ -54,6 +54,7 @@ __exportStar(require("./delivery.js"), exports);
 __exportStar(require("./favorite.js"), exports);
 __exportStar(require("./fiscalConditions.js"), exports);
 __exportStar(require("./gating.js"), exports);
+__exportStar(require("./guestOrderStatus.js"), exports);
 __exportStar(require("./holdingCost.js"), exports);
 __exportStar(require("./demo.js"), exports);
 __exportStar(require("./emailIdentity.js"), exports);

package/dist/guestOrderStatus.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Guest order status link — the read-only page a buyer with no account opens
+ * from the order email (`/pedido/{token}`), and the route that mails a fresh
+ * link to the address stored on the order.
+ *
+ * The token (`gs1.…`) is a bearer credential over exactly ONE order, read-only:
+ * it authorises no cart write, payment, cancellation, withdrawal or export. It
+ * carries no expiry; the read is refused once the order was delivered (or
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago, and every
+ * earlier link dies when a recovery or an operator revokes it.
+ */
+/**
+ * The refusals the guest status routes answer themselves.
+ *
+ * - GUEST_STATUS_TOKEN_INVALID (401): every reason the token cannot be honoured
+ *   — missing, tampered, another version, minted for another store or presented
+ *   on another store's host, revoked (a newer link was sent), past the delivery
+ *   horizon, or naming an order that is gone or is not a guest order — with one
+ *   identical body, so the token is never an oracle. Ask for a new link through
+ *   `POST /orders/status/recover`.
+ */
+export declare const GUEST_ORDER_STATUS_ERROR_CODES: readonly ["GUEST_STATUS_TOKEN_INVALID"];
+export type GuestOrderStatusErrorCode = (typeof GUEST_ORDER_STATUS_ERROR_CODES)[number];
+/** The transactional email template that mails a guest their (new) status link. */
+export declare const GUEST_ORDER_STATUS_LINK_TEMPLATE: "guest-order-status-link";
+declare global {
+    /** One line of a {@link GuestOrderStatusView}, in the order's currency. */
+    interface GuestOrderStatusLine {
+        /** The line's name as sold. */
+        description: string;
+        sku?: string;
+        quantity: number;
+        /** The unit price the order booked for the line (`OrderLine.price`). */
+        unitPrice: number;
+        /** `unitPrice × quantity` as the order booked it. */
+        lineTotal: number;
+    }
+    /**
+     * The order's money as the buyer is shown it. Named by UNIT, because the
+     * stored order mixes units: `discountPercent` is a percentage, never money.
+     */
+    interface GuestOrderStatusTotals {
+        /**
+         * What the order charges — `Order.total`, already net of every discount
+         * and including freight. Do not re-apply `discountPercent` to it.
+         */
+        total: number;
+        /** `Order.discount`: the composed order-level percentage (0–100). */
+        discountPercent: number;
+        /** Money the redeemed coupon(s) took off (`Order.coupons[].amount`), when any. */
+        couponAmount?: number;
+        /** The delivery charge (the order's freight line), when one was booked. */
+        freight?: number;
+    }
+    /**
+     * `GET /orders/status?token=` — one guest order, projected by ALLOW-LIST.
+     * Carries no address, document, full email, phone, customer id or other
+     * internal id; a client must not expect any field not listed here.
+     */
+    interface GuestOrderStatusView {
+        orderId: string;
+        /** Epoch ms the order was placed. */
+        dated: number;
+        /**
+         * Derived when the stored order carries none. ⚠️ A cancelled order reads
+         * `'delivered'` here (a cancellation lands the row in the delivered end
+         * state), so a client must check `cancelled` first.
+         */
+        fulfilmentStatus: OrderFulfilmentStatus;
+        /** Derived when the stored order carries none. */
+        financialStatus: OrderFinancialStatus;
+        /**
+         * Present, and `true`, only when the order was cancelled (`Order.cancelledAt`
+         * set) — by the buyer, the store or the system. Absent on every live order.
+         */
+        cancelled?: true;
+        lines: GuestOrderStatusLine[];
+        totals: GuestOrderStatusTotals;
+        /** The order's currency catalog id. */
+        currency: string;
+        /** The store's name for the delivery method chosen, when it still resolves. */
+        deliveryMethodName?: string;
+        /** The latest online payment attempt, when the order has one. */
+        paymentAttempt?: OrderPaymentAttemptView;
+        contact: {
+            /** The stored address, masked (e.g. `j***@d***.com`). */
+            emailMasked: string;
+            firstName: string;
+        };
+    }
+    /**
+     * `POST /orders/status/recover` body. Always answers the same `202` whether
+     * or not anything matched; a match within budget mails a new link to the
+     * address STORED on the order (never this one) and kills every earlier link.
+     * Only a malformed body answers otherwise (`400`).
+     */
+    interface GuestOrderStatusRecoverRequest {
+        orderId: string;
+        email: string;
+    }
+}

package/dist/guestOrderStatus.js

@@ -0,0 +1,24 @@
+/**
+ * Guest order status link — the read-only page a buyer with no account opens
+ * from the order email (`/pedido/{token}`), and the route that mails a fresh
+ * link to the address stored on the order.
+ *
+ * The token (`gs1.…`) is a bearer credential over exactly ONE order, read-only:
+ * it authorises no cart write, payment, cancellation, withdrawal or export. It
+ * carries no expiry; the read is refused once the order was delivered (or
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago, and every
+ * earlier link dies when a recovery or an operator revokes it.
+ */
+/**
+ * The refusals the guest status routes answer themselves.
+ *
+ * - GUEST_STATUS_TOKEN_INVALID (401): every reason the token cannot be honoured
+ *   — missing, tampered, another version, minted for another store or presented
+ *   on another store's host, revoked (a newer link was sent), past the delivery
+ *   horizon, or naming an order that is gone or is not a guest order — with one
+ *   identical body, so the token is never an oracle. Ask for a new link through
+ *   `POST /orders/status/recover`.
+ */
+export const GUEST_ORDER_STATUS_ERROR_CODES = ['GUEST_STATUS_TOKEN_INVALID'];
+/** The transactional email template that mails a guest their (new) status link. */
+export const GUEST_ORDER_STATUS_LINK_TEMPLATE = 'guest-order-status-link';

package/dist/index.d.ts

@@ -30,6 +30,7 @@ export * from './delivery.ts';
 export * from './favorite.ts';
 export * from './fiscalConditions.ts';
 export * from './gating.ts';
+export * from './guestOrderStatus.ts';
 export * from './holdingCost.ts';
 export * from './demo.ts';
 export * from './emailIdentity.ts';

package/dist/index.js

@@ -38,6 +38,7 @@ export * from "./delivery.js";
 export * from "./favorite.js";
 export * from "./fiscalConditions.js";
 export * from "./gating.js";
+export * from "./guestOrderStatus.js";
 export * from "./holdingCost.js";
 export * from "./demo.js";
 export * from "./emailIdentity.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.788",
+	"version": "1.10.789",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",