platform-types 1.10.829 → 1.10.831

package/dist/cjs/purchaseWithdrawal.js

@@ -26,10 +26,22 @@ exports.PURCHASE_WITHDRAWAL_VERIFICATION_FAILED = exports.SHOPPER_REQUEST_INTENT
  *   (`purchase-withdrawal-pending`) until an operator decides.
  * - `declined` — an operator declined it with a typed exemption reason.
  *   Terminal.
- * - `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). Moves
+ * - `accepted` — an operator accepted it before delivery (shipped or not): the
+ *   dispatch lock is released so the delivery can be recorded. Accepting an
+ *   `accepted` withdrawal again once its order is delivered, while no open
+ *   `purchase-withdrawal` RMA names it, hands it off as below. That also covers
+ *   a row accepted after delivery before the hand-off shipped.
+ * - `awaiting-goods` — after delivery, the goods are on their way back. The
+ *   operator's accept hands it off in one transaction: an `authorized` RMA
+ *   (`source: 'purchase-withdrawal'`, `withdrawalId`, `collectByAt`), one
+ *   `awaiting-goods` refund obligation per payment bucket at a provisional
+ *   amount, and the collection pointer. At the collection deadline
+ *   (`collectByAt` on its RMA) the hourly refund sweep opens them, due
+ *   `refundObligationDueDays` after that deadline, whether or not the goods
+ *   came back, and moves the withdrawal to `refund-pending` when one is owed.
+ * - `refund-pending` — money is owed back (an open refund obligation): reached
+ *   from `awaiting-goods` at the collection deadline, or from `completed` by a
+ *   late capture. 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

package/dist/purchaseWithdrawal.d.ts

@@ -23,10 +23,22 @@
  *   (`purchase-withdrawal-pending`) until an operator decides.
  * - `declined` — an operator declined it with a typed exemption reason.
  *   Terminal.
- * - `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). Moves
+ * - `accepted` — an operator accepted it before delivery (shipped or not): the
+ *   dispatch lock is released so the delivery can be recorded. Accepting an
+ *   `accepted` withdrawal again once its order is delivered, while no open
+ *   `purchase-withdrawal` RMA names it, hands it off as below. That also covers
+ *   a row accepted after delivery before the hand-off shipped.
+ * - `awaiting-goods` — after delivery, the goods are on their way back. The
+ *   operator's accept hands it off in one transaction: an `authorized` RMA
+ *   (`source: 'purchase-withdrawal'`, `withdrawalId`, `collectByAt`), one
+ *   `awaiting-goods` refund obligation per payment bucket at a provisional
+ *   amount, and the collection pointer. At the collection deadline
+ *   (`collectByAt` on its RMA) the hourly refund sweep opens them, due
+ *   `refundObligationDueDays` after that deadline, whether or not the goods
+ *   came back, and moves the withdrawal to `refund-pending` when one is owed.
+ * - `refund-pending` — money is owed back (an open refund obligation): reached
+ *   from `awaiting-goods` at the collection deadline, or from `completed` by a
+ *   late capture. 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

package/dist/purchaseWithdrawal.js

@@ -23,10 +23,22 @@
  *   (`purchase-withdrawal-pending`) until an operator decides.
  * - `declined` — an operator declined it with a typed exemption reason.
  *   Terminal.
- * - `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). Moves
+ * - `accepted` — an operator accepted it before delivery (shipped or not): the
+ *   dispatch lock is released so the delivery can be recorded. Accepting an
+ *   `accepted` withdrawal again once its order is delivered, while no open
+ *   `purchase-withdrawal` RMA names it, hands it off as below. That also covers
+ *   a row accepted after delivery before the hand-off shipped.
+ * - `awaiting-goods` — after delivery, the goods are on their way back. The
+ *   operator's accept hands it off in one transaction: an `authorized` RMA
+ *   (`source: 'purchase-withdrawal'`, `withdrawalId`, `collectByAt`), one
+ *   `awaiting-goods` refund obligation per payment bucket at a provisional
+ *   amount, and the collection pointer. At the collection deadline
+ *   (`collectByAt` on its RMA) the hourly refund sweep opens them, due
+ *   `refundObligationDueDays` after that deadline, whether or not the goods
+ *   came back, and moves the withdrawal to `refund-pending` when one is owed.
+ * - `refund-pending` — money is owed back (an open refund obligation): reached
+ *   from `awaiting-goods` at the collection deadline, or from `completed` by a
+ *   late capture. 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

package/dist/rma.d.ts

@@ -128,16 +128,35 @@ declare global {
          * did, which would have stamped `NaN` on every row. When a store-level
          * default does land it becomes that parameter's fallback, and this
          * field's meaning does not change.
+         *
+         * Never written on a `purchase-withdrawal` RMA, which is born `authorized`
+         * and never expires: the expiry sweep skips that source, whatever this
+         * field says.
          */
         expiresAt?: number;
         /**
          * Who opened the request. Absent means `operator`. `shopper` is the
          * 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.
+         * mind (a withdrawal-shaped body past W2 while the store's policy is on).
+         * `purchase-withdrawal` is written by the operator's accept of a purchase
+         * withdrawal on a delivered order (`POST /purchase-withdrawals { mode:
+         * 'accept' }`), born `authorized`, with `withdrawalId` and `collectByAt`.
+         * Only its `Return` settles it: `POST /rma { mode: 'settle' }` refuses it.
          */
         source?: RmaSource;
+        /**
+         * The purchase withdrawal this RMA hands off. Set only on a
+         * `purchase-withdrawal` RMA; absent means an operator or shopper request.
+         */
+        withdrawalId?: string;
+        /**
+         * The withdrawal's collection deadline: `purchaseWithdrawalCollectionDays`
+         * after the hand-off (`source: 'global:purchaseWithdrawalCollectionDays'`).
+         * The refund sweep opens its withdrawal's obligations at it. Set only on a
+         * `purchase-withdrawal` RMA.
+         */
+        collectByAt?: StatutoryInstant;
         /** Server-derived legal track. Absent on an operator request. */
         flow?: ReturnFlow;
         /** End of the legal warranty window (W3). Set only on a `warranty` request. */

package/package.json

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