platform-types 1.10.824 → 1.10.826

package/dist/cjs/purchaseWithdrawal.js

@@ -83,11 +83,14 @@ exports.PURCHASE_WITHDRAWAL_ACTION_MODES = ['accept', 'decline', 'relay'];
  *   already returned (`data.orderItemIndex`).
  * - `nothing-to-withdraw` — every line is already withdrawn or returned.
  * - `not-delivered` — a warranty request on an order not yet delivered.
- * - `return-request-open` — a warranty request on an order that already has an
- *   open shopper return request (`requested`, `authorized` or `received`);
- *   `data.rmaId` names it. One open shopper request per order.
- * - `too-many-lines` — a warranty request naming, or resolving to, more lines
- *   than one return request may hold; `data.max` is the bound.
+ * - `return-request-open` — a shopper return request (a warranty request, or a
+ *   change of mind: a withdrawal-shaped body past W2 while the store's policy is
+ *   on) on an order that already has an open shopper return request
+ *   (`requested`, `authorized` or `received`); `data.rmaId` names it. One open
+ *   shopper request per order.
+ * - `too-many-lines` — a shopper return request (either flow) naming, or
+ *   resolving to, more lines than one return request may hold; `data.max` is
+ *   the bound.
  */
 exports.PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS = [
     'order-cancelled',

package/dist/guestOrderStatus.d.ts

@@ -106,9 +106,14 @@ declare global {
         purchaseWithdrawals?: OrderPurchaseWithdrawalView[];
         /** Whether the withdrawal window is open now — as on `StorefrontOrderView`. Always present. */
         purchaseWithdrawalEligibility: OrderPurchaseWithdrawalEligibility;
-        /** Shopper-sourced return requests, newest first. Reserved — not attached yet. */
+        /**
+         * The order's shopper-sourced return requests (`source: 'shopper'`), any
+         * status, newest first. Absent when there are none, and — with
+         * `returnRequestEligibility` — when the store's return requests could not be
+         * read whole.
+         */
         returnRequests?: OrderReturnRequestView[];
-        /** Reserved — not attached yet. */
+        /** Whether a return request can be opened now. Absent only when the return requests could not be read whole. */
         returnRequestEligibility?: OrderReturnRequestEligibility;
         contact: {
             /** The stored address, masked (e.g. `j***@d***.com`). */

package/dist/paymentAttempt.d.ts

@@ -136,9 +136,14 @@ declare global {
         delivery?: OrderDeliveryView;
         purchaseWithdrawals?: OrderPurchaseWithdrawalView[];
         purchaseWithdrawalEligibility?: OrderPurchaseWithdrawalEligibility;
-        /** Shopper-sourced return requests, newest first. Reserved — not attached yet. */
+        /**
+         * The order's shopper-sourced return requests (`source: 'shopper'`), any
+         * status, newest first. Absent when there are none, and — with
+         * `returnRequestEligibility` — when the store's return requests could not be
+         * read whole.
+         */
         returnRequests?: OrderReturnRequestView[];
-        /** Reserved — not attached yet. */
+        /** Whether a return request can be opened now. Absent only when the return requests could not be read whole. */
         returnRequestEligibility?: OrderReturnRequestEligibility;
     };
     /**

package/dist/purchaseWithdrawal.d.ts

@@ -65,11 +65,14 @@ export declare const PURCHASE_WITHDRAWAL_ACTION_MODES: readonly ["accept", "decl
  *   already returned (`data.orderItemIndex`).
  * - `nothing-to-withdraw` — every line is already withdrawn or returned.
  * - `not-delivered` — a warranty request on an order not yet delivered.
- * - `return-request-open` — a warranty request on an order that already has an
- *   open shopper return request (`requested`, `authorized` or `received`);
- *   `data.rmaId` names it. One open shopper request per order.
- * - `too-many-lines` — a warranty request naming, or resolving to, more lines
- *   than one return request may hold; `data.max` is the bound.
+ * - `return-request-open` — a shopper return request (a warranty request, or a
+ *   change of mind: a withdrawal-shaped body past W2 while the store's policy is
+ *   on) on an order that already has an open shopper return request
+ *   (`requested`, `authorized` or `received`); `data.rmaId` names it. One open
+ *   shopper request per order.
+ * - `too-many-lines` — a shopper return request (either flow) naming, or
+ *   resolving to, more lines than one return request may hold; `data.max` is
+ *   the bound.
  */
 export declare const PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS: readonly ["order-cancelled", "no-customer", "partial-before-fulfilment", "line-not-on-order", "line-unavailable", "nothing-to-withdraw", "not-delivered", "return-request-open", "too-many-lines"];
 /**
@@ -282,7 +285,14 @@ declare global {
         /** 1–{@link PURCHASE_WITHDRAWAL_LINES_MAX} distinct lines, each with a positive quantity. */
         lines?: PurchaseWithdrawalLine[];
     }
-    /** `data` of the `201` of `POST /orders/purchase-withdrawal`: the code is `purchaseWithdrawal.withdrawalId`. */
+    /**
+     * `data` of the `201` of `POST /orders/purchase-withdrawal` when a withdrawal
+     * was recorded: the code is `purchaseWithdrawal.withdrawalId`. A
+     * withdrawal-shaped body past W2 may instead open a change-of-mind return
+     * request (the store's policy on, its window open) and answer
+     * {@link ShopperReturnRequestSubmitResponse} — tell them apart by key
+     * ({@link ShopperOrderRequestResponse}).
+     */
     interface PurchaseWithdrawalSubmitResponse {
         purchaseWithdrawal: OrderPurchaseWithdrawalView;
     }
@@ -329,7 +339,11 @@ declare global {
      * `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.
+     * the refund. Absent only when the token could not be minted. A
+     * withdrawal-shaped body past W2 may instead open a change-of-mind return
+     * request (the store's policy on, its window open) and answer
+     * {@link ShopperReturnRequestGuestSubmitResponse} — tell them apart by key
+     * ({@link ShopperOrderGuestRequestResponse}).
      */
     interface PurchaseWithdrawalGuestSubmitResponse extends PurchaseWithdrawalSubmitResponse {
         statusToken?: string;

package/dist/purchaseWithdrawal.js

@@ -80,11 +80,14 @@ export const PURCHASE_WITHDRAWAL_ACTION_MODES = ['accept', 'decline', 'relay'];
  *   already returned (`data.orderItemIndex`).
  * - `nothing-to-withdraw` — every line is already withdrawn or returned.
  * - `not-delivered` — a warranty request on an order not yet delivered.
- * - `return-request-open` — a warranty request on an order that already has an
- *   open shopper return request (`requested`, `authorized` or `received`);
- *   `data.rmaId` names it. One open shopper request per order.
- * - `too-many-lines` — a warranty request naming, or resolving to, more lines
- *   than one return request may hold; `data.max` is the bound.
+ * - `return-request-open` — a shopper return request (a warranty request, or a
+ *   change of mind: a withdrawal-shaped body past W2 while the store's policy is
+ *   on) on an order that already has an open shopper return request
+ *   (`requested`, `authorized` or `received`); `data.rmaId` names it. One open
+ *   shopper request per order.
+ * - `too-many-lines` — a shopper return request (either flow) naming, or
+ *   resolving to, more lines than one return request may hold; `data.max` is
+ *   the bound.
  */
 export const PURCHASE_WITHDRAWAL_INELIGIBLE_REASONS = [
     'order-cancelled',

package/dist/rma.d.ts

@@ -132,9 +132,10 @@ declare global {
         expiresAt?: number;
         /**
          * Who opened the request. Absent means `operator`. `shopper` is the
-         * storefront warranty request (`POST /orders/purchase-withdrawal` and its
-         * guest twin with `intent: 'warranty'`); `purchase-withdrawal` has no
-         * writer yet.
+         * storefront's own request on `POST /orders/purchase-withdrawal` and its
+         * guest twin: the warranty request (`intent: 'warranty'`), or a change of
+         * mind (a withdrawal-shaped body past W2 while the store's policy is on);
+         * `purchase-withdrawal` has no writer yet.
          */
         source?: RmaSource;
         /** Server-derived legal track. Absent on an operator request. */
@@ -233,14 +234,21 @@ declare global {
     /**
      * A shopper-sourced return request as the shopper sees it, by ALLOW-LIST:
      * never the operator's reasons or actors, carrier, tracking, nor the
-     * shopper's own description. Answered by the shopper's warranty request
-     * (`ShopperReturnRequestSubmitResponse`) and its `orderReturnRequest` frame.
+     * shopper's own description. Answered by the shopper's warranty or
+     * change-of-mind request (`ShopperReturnRequestSubmitResponse`), its `orderReturnRequest` frame (on
+     * the request and on every later status move), and the order reads
+     * (`StorefrontOrderView.returnRequests`, `GuestOrderStatusView.returnRequests`).
      */
     interface OrderReturnRequestView {
         rmaId: string;
         flow: ShopperReturnRequestFlow;
         status: RmaStatus;
         requestedAt: number;
+        /**
+         * Unix ms of the request's last write (the `Rma` row's `updatedAt`). Of two
+         * frames or reads of one request, the later `updatedAt` is the current one.
+         */
+        updatedAt: number;
         items: OrderReturnRequestItemView[];
         /** Unix ms. */
         warrantyEndsAt?: number;
@@ -250,6 +258,10 @@ declare global {
             returnShippingPaidBy: ChangeOfMindReturnShippingPayer;
             refundAs: ChangeOfMindRefundAs;
         };
+        /**
+         * The refunds owed on this request, as on a withdrawal. No writer links a
+         * refund to a shopper request yet, so it is absent today.
+         */
         refunds?: OrderPurchaseWithdrawalRefundView[];
     }
     /** `data` of an `orderReturnRequest` socket frame, sent to the order's own customer only. */
@@ -257,7 +269,11 @@ declare global {
         orderId: string;
         returnRequest: OrderReturnRequestView;
     }
-    /** Whether the shopper can open a return request on the order now. Reserved — no read serves it yet. */
+    /**
+     * Whether the shopper can open a return request on the order now — display
+     * only; the request path decides. Served on the order reads beside
+     * `returnRequests`.
+     */
     interface OrderReturnRequestEligibility {
         warranty: {
             open: boolean;

package/package.json

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