platform-types 1.10.864 → 1.10.865

package/dist/cjs/order.js

@@ -207,8 +207,11 @@ exports.orderFulfilmentProgress = orderFulfilmentProgress;
  *   direction) and a `readyAt` change are refused. Voiding every shipment lifts
  *   it. Nothing was written.
  * - `ORDER_HAS_RETURNS` · 409 — the order carries at least one return and can no
- *   longer be edited, none of its shipments can be voided, and none of its
- *   señas refunded (`mode: 'deposit-refund'`). Nothing was written.
+ *   longer be edited, un-delivered (`mode: 'delivery'`, `delivered: false`),
+ *   none of its shipments can be voided, and none of its señas refunded
+ *   (`mode: 'deposit-refund'`). Also answered by the un-delivery and by a
+ *   shipment void (`mode: 'shipment-void'`) of an order holding a handed-off
+ *   purchase withdrawal (`awaiting-goods` or later). Nothing was written.
  * - `ORDER_CANCELLATION_NOT_PROTECTED` · 409 — `mode: 'cancel'` on an order with
  *   no cancel guard of the current generation, or with the switch off. Nothing
  *   was written.

package/dist/cjs/purchaseWithdrawal.js

@@ -26,11 +26,13 @@ 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 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.
+ * - `accepted` — an operator accepted it on an order SHIPPED but not yet
+ *   delivered: 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 before fulfilment, or after delivery, by the code that
+ *   predates the cancellation and the hand-off. Before fulfilment an accept never
+ *   leaves a record `accepted`: it cancels the order (below).
  * - `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
@@ -40,13 +42,18 @@ exports.PURCHASE_WITHDRAWAL_VERIFICATION_FAILED = exports.SHOPPER_REQUEST_INTENT
  *   `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
+ *   from `requested` by an accept before fulfilment that cancelled a paid order
+ *   (or by a decision on an order another door cancelled, while one of the
+ *   withdrawal's obligations is still owed), 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
- *   arrive: a late capture (a new payment approval the order's payment
- *   attempt refused to settle) moves it back to `refund-pending`.
+ * - `completed` — nothing is owed any more: reached from `requested` by an
+ *   accept before fulfilment that cancelled an order that received nothing (or
+ *   by a decision on an order another door cancelled, nothing owed), or from
+ *   `refund-pending`. Not final while money can still 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',

package/dist/order.d.ts

@@ -2827,8 +2827,11 @@ export declare const orderFulfilmentProgress: (order: OrderFulfilmentProgressInp
  *   direction) and a `readyAt` change are refused. Voiding every shipment lifts
  *   it. Nothing was written.
  * - `ORDER_HAS_RETURNS` · 409 — the order carries at least one return and can no
- *   longer be edited, none of its shipments can be voided, and none of its
- *   señas refunded (`mode: 'deposit-refund'`). Nothing was written.
+ *   longer be edited, un-delivered (`mode: 'delivery'`, `delivered: false`),
+ *   none of its shipments can be voided, and none of its señas refunded
+ *   (`mode: 'deposit-refund'`). Also answered by the un-delivery and by a
+ *   shipment void (`mode: 'shipment-void'`) of an order holding a handed-off
+ *   purchase withdrawal (`awaiting-goods` or later). Nothing was written.
  * - `ORDER_CANCELLATION_NOT_PROTECTED` · 409 — `mode: 'cancel'` on an order with
  *   no cancel guard of the current generation, or with the switch off. Nothing
  *   was written.

package/dist/order.js

@@ -200,8 +200,11 @@ export const orderFulfilmentProgress = (order) => {
  *   direction) and a `readyAt` change are refused. Voiding every shipment lifts
  *   it. Nothing was written.
  * - `ORDER_HAS_RETURNS` · 409 — the order carries at least one return and can no
- *   longer be edited, none of its shipments can be voided, and none of its
- *   señas refunded (`mode: 'deposit-refund'`). Nothing was written.
+ *   longer be edited, un-delivered (`mode: 'delivery'`, `delivered: false`),
+ *   none of its shipments can be voided, and none of its señas refunded
+ *   (`mode: 'deposit-refund'`). Also answered by the un-delivery and by a
+ *   shipment void (`mode: 'shipment-void'`) of an order holding a handed-off
+ *   purchase withdrawal (`awaiting-goods` or later). Nothing was written.
  * - `ORDER_CANCELLATION_NOT_PROTECTED` · 409 — `mode: 'cancel'` on an order with
  *   no cancel guard of the current generation, or with the switch off. Nothing
  *   was written.

package/dist/purchaseWithdrawal.d.ts

@@ -23,11 +23,13 @@
  *   (`purchase-withdrawal-pending`) until an operator decides.
  * - `declined` — an operator declined it with a typed exemption reason.
  *   Terminal.
- * - `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.
+ * - `accepted` — an operator accepted it on an order SHIPPED but not yet
+ *   delivered: 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 before fulfilment, or after delivery, by the code that
+ *   predates the cancellation and the hand-off. Before fulfilment an accept never
+ *   leaves a record `accepted`: it cancels the order (below).
  * - `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
@@ -37,13 +39,18 @@
  *   `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
+ *   from `requested` by an accept before fulfilment that cancelled a paid order
+ *   (or by a decision on an order another door cancelled, while one of the
+ *   withdrawal's obligations is still owed), 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
- *   arrive: a late capture (a new payment approval the order's payment
- *   attempt refused to settle) moves it back to `refund-pending`.
+ * - `completed` — nothing is owed any more: reached from `requested` by an
+ *   accept before fulfilment that cancelled an order that received nothing (or
+ *   by a decision on an order another door cancelled, nothing owed), or from
+ *   `refund-pending`. Not final while money can still 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"];
 /**
@@ -516,7 +523,17 @@ declare global {
      * - `accept` / `decline` — decide a `requested` withdrawal under
      *   `expectedRevision` (the `revision` the operator acted on). A decline
      *   names one {@link PurchaseWithdrawalDeclineReason} and may carry a note.
-     *   Both release the order's dispatch lock in the same transaction.
+     *   Both release the order's dispatch lock in the same transaction. What an
+     *   accept does depends on the order as it stands: before fulfilment it
+     *   CANCELS the order (the record goes to `refund-pending` or `completed`, the
+     *   money it received is owed back and its credit note is queued) and can
+     *   answer `409 PURCHASE_WITHDRAWAL_FISCAL_IN_FLIGHT`
+     *   ({@link PurchaseWithdrawalFiscalInFlightData}), `409
+     *   ORDER_VERSION_CONFLICT`, `409 ORDER_CANCELLATION_LOCKED` or `502
+     *   PURCHASE_WITHDRAWAL_REFUND_BASIS_UNAVAILABLE`; shipped and undelivered it
+     *   moves the record to `accepted` alone; delivered it hands the withdrawal
+     *   off (`awaiting-goods`); on an order another door already cancelled it
+     *   decides the record alone (`refund-pending` or `completed`).
      * - `relay` — record a request the store received by email or WhatsApp and
      *   mint its code, which the operator then sends on that channel.
      */

package/dist/purchaseWithdrawal.js

@@ -23,11 +23,13 @@
  *   (`purchase-withdrawal-pending`) until an operator decides.
  * - `declined` — an operator declined it with a typed exemption reason.
  *   Terminal.
- * - `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.
+ * - `accepted` — an operator accepted it on an order SHIPPED but not yet
+ *   delivered: 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 before fulfilment, or after delivery, by the code that
+ *   predates the cancellation and the hand-off. Before fulfilment an accept never
+ *   leaves a record `accepted`: it cancels the order (below).
  * - `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
@@ -37,13 +39,18 @@
  *   `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
+ *   from `requested` by an accept before fulfilment that cancelled a paid order
+ *   (or by a decision on an order another door cancelled, while one of the
+ *   withdrawal's obligations is still owed), 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
- *   arrive: a late capture (a new payment approval the order's payment
- *   attempt refused to settle) moves it back to `refund-pending`.
+ * - `completed` — nothing is owed any more: reached from `requested` by an
+ *   accept before fulfilment that cancelled an order that received nothing (or
+ *   by a decision on an order another door cancelled, nothing owed), or from
+ *   `refund-pending`. Not final while money can still 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',

package/package.json

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