platform-types 1.10.817 → 1.10.819

package/dist/cjs/guestOrderStatus.js

@@ -7,8 +7,13 @@
  * 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.
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago — unless a
+ * purchase withdrawal on it is not final or a refund on it is not closed — and
+ * every earlier link dies when a recovery or an operator revokes it.
+ *
+ * The guest purchase-withdrawal start (`POST /orders/purchase-withdrawal/guest/start`)
+ * accepts the token only to NAME the order: the withdrawal itself needs the
+ * code mailed to the order's address, so the token still authorises none.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GUEST_ORDER_STATUS_LINK_TEMPLATE = exports.GUEST_ORDER_STATUS_ERROR_CODES = void 0;

package/dist/cjs/purchaseWithdrawal.js

@@ -20,7 +20,7 @@
  * `status`, `revisedAt` replaces `updatedAt`, and there is no `dated`.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PURCHASE_WITHDRAWAL_CODE_DUE_MS = exports.PURCHASE_WITHDRAWAL_CODE_DUE_SOURCE = exports.PURCHASE_WITHDRAWAL_WINDOW_SOURCE = exports.PURCHASE_WITHDRAWAL_WINDOW_DAYS = exports.PURCHASE_WITHDRAWAL_LINES_MAX = exports.PURCHASE_WITHDRAWAL_NOTE_MAX = exports.PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS = exports.PURCHASE_WITHDRAWAL_ACTION_MODES = exports.PURCHASE_WITHDRAWAL_RELAY_CHANNELS = exports.PURCHASE_WITHDRAWAL_DECLINE_REASONS = exports.PURCHASE_WITHDRAWAL_SOURCES = exports.PURCHASE_WITHDRAWAL_LIST_FILTERS = exports.PURCHASE_WITHDRAWAL_STATES = void 0;
+exports.PURCHASE_WITHDRAWAL_VERIFICATION_FAILED = exports.PURCHASE_WITHDRAWAL_GUEST_INTENTS = exports.PURCHASE_WITHDRAWAL_CODE_DUE_MS = exports.PURCHASE_WITHDRAWAL_CODE_DUE_SOURCE = exports.PURCHASE_WITHDRAWAL_WINDOW_SOURCE = exports.PURCHASE_WITHDRAWAL_WINDOW_DAYS = exports.PURCHASE_WITHDRAWAL_LINES_MAX = exports.PURCHASE_WITHDRAWAL_NOTE_MAX = exports.PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS = exports.PURCHASE_WITHDRAWAL_ACTION_MODES = exports.PURCHASE_WITHDRAWAL_RELAY_CHANNELS = exports.PURCHASE_WITHDRAWAL_DECLINE_REASONS = exports.PURCHASE_WITHDRAWAL_SOURCES = exports.PURCHASE_WITHDRAWAL_LIST_FILTERS = exports.PURCHASE_WITHDRAWAL_STATES = void 0;
 /**
  * - `requested` — submitted, the code minted, the order's dispatch locked
  *   (`purchase-withdrawal-pending`) until an operator decides.
@@ -29,9 +29,12 @@ exports.PURCHASE_WITHDRAWAL_CODE_DUE_MS = exports.PURCHASE_WITHDRAWAL_CODE_DUE_S
  * - `accepted` — an operator accepted it. The order's cancellation (before
  *   fulfilment) or its return authorisation (after it) follows from here.
  * - `awaiting-goods` — after fulfilment, the goods are on their way back.
- * - `refund-pending` — money is owed back (an open refund obligation).
+ * - `refund-pending` — money is owed back (an open refund obligation). Moves
+ *   to `completed` with the closure of its last open obligation, never while
+ *   another one is open.
  * - `completed` — nothing is owed any more. Not final while money can still
- *   arrive: a late capture moves it back to `refund-pending`.
+ *   arrive: a late capture (a new payment approval the order's payment
+ *   attempt refused to settle) moves it back to `refund-pending`.
  */
 exports.PURCHASE_WITHDRAWAL_STATES = [
     'requested',
@@ -100,3 +103,17 @@ exports.PURCHASE_WITHDRAWAL_WINDOW_SOURCE = 'W2';
 exports.PURCHASE_WITHDRAWAL_CODE_DUE_SOURCE = 'W1';
 /** How long after a relayed request was received its code is due, in ms. */
 exports.PURCHASE_WITHDRAWAL_CODE_DUE_MS = 24 * 60 * 60 * 1000;
+/**
+ * The `intent` a guest's `POST /orders/purchase-withdrawal/guest` names. Only
+ * the purchase withdrawal (*"Me arrepentí"*) today; the warranty intent joins
+ * this tuple with the warranty request.
+ */
+exports.PURCHASE_WITHDRAWAL_GUEST_INTENTS = ['purchase-withdrawal'];
+/**
+ * The one refusal of every guest code failure on `POST
+ * /orders/purchase-withdrawal/guest` (`401`): a wrong, expired, exhausted or
+ * already used code, a challenge that does not exist (another store's
+ * included), and an order that is no longer a guest order — one body, so the
+ * route is never an oracle for which one it was.
+ */
+exports.PURCHASE_WITHDRAWAL_VERIFICATION_FAILED = 'PURCHASE_WITHDRAWAL_VERIFICATION_FAILED';

package/dist/cjs/socket.js

@@ -551,7 +551,8 @@ exports.SOCKET_ACTIONS = [
      *
      * ⚠️ To the order's OWN customer only (`wsPostCustomer`), never a store-wide
      * customer broadcast. The operator frame for the same write is
-     * `purchaseWithdrawalChanged`.
+     * `purchaseWithdrawalChanged`; the order's own `orders` frame (the post-commit
+     * row, carrying or no longer carrying the dispatch lock) follows both.
      */
     'orderPurchaseWithdrawal',
     /**

package/dist/guestOrderStatus.d.ts

@@ -6,8 +6,13 @@
  * 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.
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago — unless a
+ * purchase withdrawal on it is not final or a refund on it is not closed — and
+ * every earlier link dies when a recovery or an operator revokes it.
+ *
+ * The guest purchase-withdrawal start (`POST /orders/purchase-withdrawal/guest/start`)
+ * accepts the token only to NAME the order: the withdrawal itself needs the
+ * code mailed to the order's address, so the token still authorises none.
  */
 /**
  * The refusals the guest status routes answer themselves.
@@ -93,6 +98,14 @@ declare global {
         onlinePayment?: true;
         /** The latest online payment attempt, when the order has one. */
         paymentAttempt?: OrderPaymentAttemptView;
+        /**
+         * The order's purchase withdrawals, newest first, with their refunds —
+         * the same `OrderPurchaseWithdrawalView`s `StorefrontOrderView` carries.
+         * Absent when the order has none.
+         */
+        purchaseWithdrawals?: OrderPurchaseWithdrawalView[];
+        /** Whether the withdrawal window is open now — as on `StorefrontOrderView`. Always present. */
+        purchaseWithdrawalEligibility: OrderPurchaseWithdrawalEligibility;
         contact: {
             /** The stored address, masked (e.g. `j***@d***.com`). */
             emailMasked: string;

package/dist/guestOrderStatus.js

@@ -6,8 +6,13 @@
  * 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.
+ * cancelled) more than `guestStatusLinkDaysAfterDelivery` days ago — unless a
+ * purchase withdrawal on it is not final or a refund on it is not closed — and
+ * every earlier link dies when a recovery or an operator revokes it.
+ *
+ * The guest purchase-withdrawal start (`POST /orders/purchase-withdrawal/guest/start`)
+ * accepts the token only to NAME the order: the withdrawal itself needs the
+ * code mailed to the order's address, so the token still authorises none.
  */
 /**
  * The refusals the guest status routes answer themselves.

package/dist/purchaseWithdrawal.d.ts

@@ -26,9 +26,12 @@
  * - `accepted` — an operator accepted it. The order's cancellation (before
  *   fulfilment) or its return authorisation (after it) follows from here.
  * - `awaiting-goods` — after fulfilment, the goods are on their way back.
- * - `refund-pending` — money is owed back (an open refund obligation).
+ * - `refund-pending` — money is owed back (an open refund obligation). Moves
+ *   to `completed` with the closure of its last open obligation, never while
+ *   another one is open.
  * - `completed` — nothing is owed any more. Not final while money can still
- *   arrive: a late capture moves it back to `refund-pending`.
+ *   arrive: a late capture (a new payment approval the order's payment
+ *   attempt refused to settle) moves it back to `refund-pending`.
  */
 export declare const PURCHASE_WITHDRAWAL_STATES: readonly ["requested", "declined", "accepted", "awaiting-goods", "refund-pending", "completed"];
 /**
@@ -75,6 +78,20 @@ export declare const PURCHASE_WITHDRAWAL_WINDOW_SOURCE = "W2";
 export declare const PURCHASE_WITHDRAWAL_CODE_DUE_SOURCE = "W1";
 /** How long after a relayed request was received its code is due, in ms. */
 export declare const PURCHASE_WITHDRAWAL_CODE_DUE_MS: number;
+/**
+ * The `intent` a guest's `POST /orders/purchase-withdrawal/guest` names. Only
+ * the purchase withdrawal (*"Me arrepentí"*) today; the warranty intent joins
+ * this tuple with the warranty request.
+ */
+export declare const PURCHASE_WITHDRAWAL_GUEST_INTENTS: readonly ["purchase-withdrawal"];
+/**
+ * The one refusal of every guest code failure on `POST
+ * /orders/purchase-withdrawal/guest` (`401`): a wrong, expired, exhausted or
+ * already used code, a challenge that does not exist (another store's
+ * included), and an order that is no longer a guest order — one body, so the
+ * route is never an oracle for which one it was.
+ */
+export declare const PURCHASE_WITHDRAWAL_VERIFICATION_FAILED: "PURCHASE_WITHDRAWAL_VERIFICATION_FAILED";
 declare global {
     type PurchaseWithdrawalState = (typeof PURCHASE_WITHDRAWAL_STATES)[number];
     type PurchaseWithdrawalSource = (typeof PURCHASE_WITHDRAWAL_SOURCES)[number];
@@ -82,6 +99,7 @@ declare global {
     type PurchaseWithdrawalRelayChannel = (typeof PURCHASE_WITHDRAWAL_RELAY_CHANNELS)[number];
     type PurchaseWithdrawalActionMode = (typeof PURCHASE_WITHDRAWAL_ACTION_MODES)[number];
     type PurchaseWithdrawalIneligibleReason = (typeof PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS)[number];
+    type PurchaseWithdrawalGuestIntent = (typeof PURCHASE_WITHDRAWAL_GUEST_INTENTS)[number];
     /** One withdrawn order line, by its index in `Order.items`. */
     interface PurchaseWithdrawalLine {
         orderItemIndex: number;
@@ -239,6 +257,54 @@ declare global {
     interface PurchaseWithdrawalSubmitResponse {
         purchaseWithdrawal: OrderPurchaseWithdrawalView;
     }
+    /**
+     * `POST /orders/purchase-withdrawal/guest/start` (Web host, PUBLIC, bound
+     * origin). Strict body, ONE of two shapes, each naming the order only:
+     *
+     * - `{ token }` — the guest order status token (`gs1.…`). It grants nothing
+     *   by itself: the code still goes to the order's address.
+     * - `{ orderId, email }` — the order number and the address the order was
+     *   placed with.
+     *
+     * Always the same `202` ({@link PurchaseWithdrawalGuestStartResponse})
+     * whether or not anything matches; a match within budget mails a 6-digit
+     * code to the address on the order's LIVE guest customer row (never the one
+     * typed). Only a malformed body answers otherwise (`400`).
+     */
+    type PurchaseWithdrawalGuestStartRequest = {
+        token: string;
+    } | {
+        orderId: string;
+        email: string;
+    };
+    /** `data` of the `202` of the guest start: the handle step 2 names. Random, 128 bits, base64url. */
+    interface PurchaseWithdrawalGuestStartResponse {
+        challengeHandle: string;
+    }
+    /**
+     * `POST /orders/purchase-withdrawal/guest` (Web host, PUBLIC, bound origin).
+     * Strict body. `lines` as on {@link PurchaseWithdrawalSubmitRequest}. Every
+     * code failure is the one `401 PURCHASE_WITHDRAWAL_VERIFICATION_FAILED`;
+     * the fifth wrong code burns the challenge. A correct code is consumed by
+     * the request's own transaction, so it creates at most one record.
+     */
+    interface PurchaseWithdrawalGuestSubmitRequest {
+        /** The start's `challengeHandle`. */
+        challengeHandle: string;
+        /** The 6-digit code mailed to the order's address. */
+        code: string;
+        intent: PurchaseWithdrawalGuestIntent;
+        lines?: PurchaseWithdrawalLine[];
+    }
+    /**
+     * `data` of the `201` of the guest submit: the code on screen, and a guest
+     * order status token minted at the order's CURRENT fence generation (no
+     * earlier link dies) — the storefront opens `/pedido/{statusToken}` to follow
+     * the refund. Absent only when the token could not be minted.
+     */
+    interface PurchaseWithdrawalGuestSubmitResponse extends PurchaseWithdrawalSubmitResponse {
+        statusToken?: string;
+    }
     /** `data` of `409 PURCHASE_WITHDRAWAL_ALREADY_REQUESTED`: the undecided request's code. */
     interface PurchaseWithdrawalAlreadyRequestedData {
         withdrawalId: string;

package/dist/purchaseWithdrawal.js

@@ -26,9 +26,12 @@
  * - `accepted` — an operator accepted it. The order's cancellation (before
  *   fulfilment) or its return authorisation (after it) follows from here.
  * - `awaiting-goods` — after fulfilment, the goods are on their way back.
- * - `refund-pending` — money is owed back (an open refund obligation).
+ * - `refund-pending` — money is owed back (an open refund obligation). Moves
+ *   to `completed` with the closure of its last open obligation, never while
+ *   another one is open.
  * - `completed` — nothing is owed any more. Not final while money can still
- *   arrive: a late capture moves it back to `refund-pending`.
+ *   arrive: a late capture (a new payment approval the order's payment
+ *   attempt refused to settle) moves it back to `refund-pending`.
  */
 export const PURCHASE_WITHDRAWAL_STATES = [
     'requested',
@@ -97,3 +100,17 @@ export const PURCHASE_WITHDRAWAL_WINDOW_SOURCE = 'W2';
 export const PURCHASE_WITHDRAWAL_CODE_DUE_SOURCE = 'W1';
 /** How long after a relayed request was received its code is due, in ms. */
 export const PURCHASE_WITHDRAWAL_CODE_DUE_MS = 24 * 60 * 60 * 1000;
+/**
+ * The `intent` a guest's `POST /orders/purchase-withdrawal/guest` names. Only
+ * the purchase withdrawal (*"Me arrepentí"*) today; the warranty intent joins
+ * this tuple with the warranty request.
+ */
+export const PURCHASE_WITHDRAWAL_GUEST_INTENTS = ['purchase-withdrawal'];
+/**
+ * The one refusal of every guest code failure on `POST
+ * /orders/purchase-withdrawal/guest` (`401`): a wrong, expired, exhausted or
+ * already used code, a challenge that does not exist (another store's
+ * included), and an order that is no longer a guest order — one body, so the
+ * route is never an oracle for which one it was.
+ */
+export const PURCHASE_WITHDRAWAL_VERIFICATION_FAILED = 'PURCHASE_WITHDRAWAL_VERIFICATION_FAILED';

package/dist/socket.js

@@ -548,7 +548,8 @@ export const SOCKET_ACTIONS = [
      *
      * ⚠️ To the order's OWN customer only (`wsPostCustomer`), never a store-wide
      * customer broadcast. The operator frame for the same write is
-     * `purchaseWithdrawalChanged`.
+     * `purchaseWithdrawalChanged`; the order's own `orders` frame (the post-commit
+     * row, carrying or no longer carrying the dispatch lock) follows both.
      */
     'orderPurchaseWithdrawal',
     /**

package/package.json

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