platform-types 1.10.825 → 1.10.827

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/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"];
 /**
@@ -140,7 +143,8 @@ declare global {
      * `purchase-withdrawal-received` mail is queued after the commit and
      * stamps `emailQueuedAt`, and the mail worker records `emailStatus`:
      * `sent`, or `not-sent` when the order's customer has no address to mail
-     * or the send was refused for good (a suppressed address included).
+     * or the send was refused for good (a suppressed address included), or
+     * when an operator decided the request before the mail went out.
      */
     interface PurchaseWithdrawalAcknowledgement {
         /** Unix ms. */
@@ -282,7 +286,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 +340,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. */
@@ -143,6 +144,14 @@ declare global {
         warrantyEndsAt?: StatutoryInstant;
         /** The store's change-of-mind terms as they stood when requested. Set only on a `change-of-mind` request. */
         changeOfMind?: RmaChangeOfMindTerms;
+        /**
+         * Set only on a `shopper` request, in its create transaction (`shownAt`);
+         * the `return-request-received` mail then stamps `emailQueuedAt` and its
+         * worker `emailStatus`. Absent on an operator request, which mails nothing,
+         * and on a shopper request opened before the acknowledgement shipped — a
+         * missing `acknowledgement` is not an unsent one.
+         */
+        acknowledgement?: ReturnRequestAcknowledgement;
         /** Lowercase, rebuilt on every write. A row missing it is invisible to search. */
         search?: string;
         createdAt: number;
@@ -218,6 +227,15 @@ declare global {
     type RmaSource = (typeof RMA_SOURCES)[number];
     /** The flows a shopper's own return request can land in. */
     type ShopperReturnRequestFlow = Extract<ReturnFlow, 'warranty' | 'change-of-mind'>;
+    /**
+     * A shopper return request's acknowledgement — the purchase withdrawal's
+     * shape: `shownAt` (the `201` showed the request number), `emailQueuedAt`
+     * (the `return-request-received` mail was queued) and `emailStatus` (`sent`,
+     * or `not-sent` when the customer has no address, the send was refused for
+     * good, or an operator decided the request before the mail went out). The operator reads an undelivered acknowledgement off it; the
+     * shopper's view never carries it.
+     */
+    type ReturnRequestAcknowledgement = PurchaseWithdrawalAcknowledgement;
     /** The change-of-mind terms snapshotted onto a request, so a later policy edit does not rewrite them. */
     interface RmaChangeOfMindTerms {
         endsAt: StatutoryInstant;
@@ -233,8 +251,8 @@ 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`), its `orderReturnRequest` frame (on
+     * 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`).
      */

package/package.json

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