platform-types 1.10.726 → 1.10.728

package/dist/appointment.js

@@ -141,7 +141,8 @@ export const APPOINTMENT_ERROR_CODES = [
     'ROLE_FORBIDDEN',
     'APPOINTMENT_FEED_SECRET_NOT_CONFIGURED',
     'APPOINTMENT_FEED_IDENTITY_INVALID',
-    // The storefront's self-booking surface, while the store has `modules.appointments` off.
+    // The storefront's self-booking surface, while the store has `modules.appointments` off;
+    // its `data` is `StoreModuleDisabledData` (`StoreModuleRefusalBody` types the whole body).
     'STORE_MODULE_DISABLED',
 ];
 /**

package/dist/cjs/appointment.js

@@ -144,7 +144,8 @@ exports.APPOINTMENT_ERROR_CODES = [
     'ROLE_FORBIDDEN',
     'APPOINTMENT_FEED_SECRET_NOT_CONFIGURED',
     'APPOINTMENT_FEED_IDENTITY_INVALID',
-    // The storefront's self-booking surface, while the store has `modules.appointments` off.
+    // The storefront's self-booking surface, while the store has `modules.appointments` off;
+    // its `data` is `StoreModuleDisabledData` (`StoreModuleRefusalBody` types the whole body).
     'STORE_MODULE_DISABLED',
 ];
 /**

package/dist/cjs/store.js

@@ -60,7 +60,10 @@ exports.isStoreModuleOn = isStoreModuleOn;
  *   `STORE_MODULE_KEYS`; `data.module` carries it.
  * - `STORE_MODULE_NOT_BOOLEAN` (400) — a module's value was not `true`/`false`.
  * - `STORE_MODULE_WAREHOUSES_ACTIVE` (409) — `multiWarehouse` off while more
- *   than one depósito is active; `data.activeWarehouses` carries the count.
+ *   than one depósito is active, or the depósito read stopped before it could
+ *   count them all; `data.activeWarehouses` carries the count, and
+ *   `data.truncated: true` marks it as a floor (see
+ *   {@link StoreModuleWarehousesActiveData}).
  * - `STORE_MODULE_TRANSFER_IN_FLIGHT` (409) — `multiWarehouse` off while a stock
  *   transfer is in transit or partially received; `data.transferId` names one.
  * - `STORE_MODULE_CUSTOMER_BALANCES` (409) — `customerAccounts` off while a

package/dist/return.d.ts

@@ -9,7 +9,14 @@ declare global {
     type ReturnRefundMethod = 'account' | 'cash';
     /** Return planning refusals: invalid selected lines, too many return summaries, or more than 100 transaction items. */
     type ReturnPlanFailureCode = 'RETURN_INVALID_SUBSET' | 'RETURN_LIMIT_REACHED' | 'RETURN_TRANSACTION_TOO_LARGE' | 'UNIT_QUANTITY_NOT_WHOLE' | 'UNIT_QUANTITY_UNREPRESENTABLE';
-    /** Cash handed back in the return transaction, linked to its drawer and compensating account debit. */
+    /**
+     * Cash handed back in the return transaction, linked to its drawer and, for a
+     * named customer, its compensating account debit. On a walk-in return (the
+     * system customer) no `ACCOUNT#` row is written, so `accountId` is only the
+     * payout id the drawer `refund` event carries — it names no ledger row.
+     * `amount` is the full return total for a named customer; on a walk-in return
+     * it is only the part the order had actually been paid (see `owedReduction`).
+     */
     interface ReturnCashRefund {
         amount: number;
         currency: string;
@@ -150,8 +157,20 @@ declare global {
         fiscalAllocation?: ReturnFiscalAllocation;
         /** Absent on legacy rows: account. Cash never retains a customer balance credit. */
         refundMethod?: ReturnRefundMethod;
-        /** Present only when the return paid its full total in cash. */
+        /**
+         * Present only when cash left the drawer: the full total for a named
+         * customer's cash return, the paid part of a walk-in return. A walk-in
+         * return of goods never paid for carries none.
+         */
         cashRefund?: ReturnCashRefund;
+        /**
+         * Walk-in returns only (the system customer). The part of `total` the
+         * order had never been paid: it moved no money and lowered what the order
+         * still owes, so the till collects that much less. `total` equals
+         * `cashRefund.amount` (or 0) plus this. Absent when zero, and on every
+         * named-customer return.
+         */
+        owedReduction?: number;
         reason: ReturnReason;
         notes?: string;
         userId: string;
@@ -591,6 +610,8 @@ declare global {
         refundMethod?: ReturnRefundMethod;
         /** Mirrors the committed cash payout on Return.cashRefund. */
         cashRefund?: ReturnCashRefund;
+        /** Mirrors Return.owedReduction: the unpaid part of a walk-in return, which lowered what the order owes. */
+        owedReduction?: number;
         reason: ReturnReason;
         ncStatus?: ReturnCreditNoteStatus;
         creditNoteId?: string;
@@ -713,7 +734,7 @@ declare global {
      */
     interface CreateReturnRequest {
         mode: 'return';
-        /** Omission credits the customer account. Cash pays the full server-calculated return total; no provider refund. */
+        /** Omission credits the customer account. Cash pays the full server-calculated return total; no provider refund. A walk-in order (the system customer) is always refunded in cash, whatever is sent, but only up to what the order was paid; the unpaid rest lowers what the order still owes. */
         refundMethod?: ReturnRefundMethod;
         /** Client-minted UUID; the idempotency key. A replay returns the original outcome. */
         requestId: string;
@@ -728,7 +749,7 @@ declare global {
         /**
          * Required when the order has a non-empty `linkedPayments` map: the
          * operator acknowledges SINFACTURA does NOT refund or unlink the provider
-         * payment. The return pays by refundMethod (account by default).
+         * payment. The return pays by refundMethod (account by default; always cash on a walk-in order).
          */
         acknowledgeNoProviderRefund?: boolean;
         /**

package/dist/store.d.ts

@@ -907,8 +907,10 @@ declare global {
              * `400 STORE_MODULE_NOT_BOOLEAN`.
              *
              * Turning a module OFF is refused while it still carries state:
-             * `multiWarehouse` while more than one depósito is active
-             * (`409 STORE_MODULE_WAREHOUSES_ACTIVE`) or a transfer is in transit or
+             * `multiWarehouse` while more than one depósito is active, or the
+             * depósito read could not finish counting
+             * (`409 STORE_MODULE_WAREHOUSES_ACTIVE`, `data.truncated: true` on the
+             * latter — `StoreModuleWarehousesActiveData`) or a transfer is in transit or
              * partially received (`409 STORE_MODULE_TRANSFER_IN_FLIGHT`);
              * `customerAccounts` while any customer carries a non-zero balance
              * (`409 STORE_MODULE_CUSTOMER_BALANCES`, or
@@ -2025,7 +2027,10 @@ export declare const isStoreModuleOn: (modules: StoreModules | null | undefined,
  *   `STORE_MODULE_KEYS`; `data.module` carries it.
  * - `STORE_MODULE_NOT_BOOLEAN` (400) — a module's value was not `true`/`false`.
  * - `STORE_MODULE_WAREHOUSES_ACTIVE` (409) — `multiWarehouse` off while more
- *   than one depósito is active; `data.activeWarehouses` carries the count.
+ *   than one depósito is active, or the depósito read stopped before it could
+ *   count them all; `data.activeWarehouses` carries the count, and
+ *   `data.truncated: true` marks it as a floor (see
+ *   {@link StoreModuleWarehousesActiveData}).
  * - `STORE_MODULE_TRANSFER_IN_FLIGHT` (409) — `multiWarehouse` off while a stock
  *   transfer is in transit or partially received; `data.transferId` names one.
  * - `STORE_MODULE_CUSTOMER_BALANCES` (409) — `customerAccounts` off while a
@@ -2038,3 +2043,73 @@ export declare const isStoreModuleOn: (modules: StoreModules | null | undefined,
  */
 export declare const STORE_MODULE_ERROR_CODES: readonly ["STORE_MODULE_UNKNOWN", "STORE_MODULE_NOT_BOOLEAN", "STORE_MODULE_WAREHOUSES_ACTIVE", "STORE_MODULE_TRANSFER_IN_FLIGHT", "STORE_MODULE_CUSTOMER_BALANCES", "STORE_MODULE_BALANCE_CHECK_INCOMPLETE", "STORE_MODULE_DISABLED"];
 export type StoreModuleErrorCode = (typeof STORE_MODULE_ERROR_CODES)[number];
+/** `data` of `400 STORE_MODULE_UNKNOWN` — the unknown key, cut to its first 64 UTF-16 code units. */
+export interface StoreModuleUnknownData {
+    module: string;
+}
+/** `data` of `400 STORE_MODULE_NOT_BOOLEAN` — the module whose value was not a boolean. */
+export interface StoreModuleNotBooleanData {
+    module: StoreModuleKey;
+}
+/**
+ * `data` of `409 STORE_MODULE_WAREHOUSES_ACTIVE`.
+ *
+ * `activeWarehouses` is the number of active depósitos the read SAW.
+ * `truncated: true` marks the read as stopped early, so that number is a FLOOR:
+ * at `2` or more the store still has extra depósitos to deactivate (the true
+ * count is at least that); at `0` or `1` the refusal means only "could not
+ * finish counting", and deactivating depósitos is not the remedy. `truncated`
+ * is present only on a stopped read; its absence means the count is exact (and
+ * therefore above one).
+ */
+export interface StoreModuleWarehousesActiveData {
+    module: 'multiWarehouse';
+    activeWarehouses: number;
+    truncated?: true;
+}
+/** `data` of `409 STORE_MODULE_TRANSFER_IN_FLIGHT` — one in-flight transfer, the bare `TRF…` id. */
+export interface StoreModuleTransferInFlightData {
+    module: 'multiWarehouse';
+    transferId: string;
+}
+/** `data` of `409 STORE_MODULE_CUSTOMER_BALANCES` — one customer with a balance, the bare `CUST…` id. */
+export interface StoreModuleCustomerBalancesData {
+    module: 'customerAccounts';
+    customerId: string;
+}
+/** `data` of `409 STORE_MODULE_BALANCE_CHECK_INCOMPLETE`. */
+export interface StoreModuleBalanceCheckIncompleteData {
+    module: 'customerAccounts';
+}
+/** `data` of `403 STORE_MODULE_DISABLED` — the switched-off module the request needed. */
+export interface StoreModuleDisabledData {
+    module: StoreModuleKey;
+}
+/**
+ * Each `STORE_MODULE_*` code and the `data` it carries — the union below is
+ * derived from it. Keyed by exactly `StoreModuleErrorCode`, both ways: a code
+ * missing here fails the union's index, and a key no code names fails
+ * `tests/unit/storeModules.test.ts`'s type-level check.
+ */
+export interface StoreModuleRefusalDataByCode {
+    STORE_MODULE_UNKNOWN: StoreModuleUnknownData;
+    STORE_MODULE_NOT_BOOLEAN: StoreModuleNotBooleanData;
+    STORE_MODULE_WAREHOUSES_ACTIVE: StoreModuleWarehousesActiveData;
+    STORE_MODULE_TRANSFER_IN_FLIGHT: StoreModuleTransferInFlightData;
+    STORE_MODULE_CUSTOMER_BALANCES: StoreModuleCustomerBalancesData;
+    STORE_MODULE_BALANCE_CHECK_INCOMPLETE: StoreModuleBalanceCheckIncompleteData;
+    STORE_MODULE_DISABLED: StoreModuleDisabledData;
+}
+/**
+ * The wire body of any store-module refusal, discriminated on `error` —
+ * narrowing on the code types `data`. Every emitter checks its whole body
+ * against it with `satisfies`, so a code cannot travel with another code's
+ * `data`.
+ */
+export type StoreModuleRefusalBody = {
+    [Code in StoreModuleErrorCode]: {
+        error: Code;
+        message: string;
+        data: StoreModuleRefusalDataByCode[Code];
+    };
+}[StoreModuleErrorCode];

package/dist/store.js

@@ -55,7 +55,10 @@ export const isStoreModuleOn = (modules, module) => modules?.[module] !== false;
  *   `STORE_MODULE_KEYS`; `data.module` carries it.
  * - `STORE_MODULE_NOT_BOOLEAN` (400) — a module's value was not `true`/`false`.
  * - `STORE_MODULE_WAREHOUSES_ACTIVE` (409) — `multiWarehouse` off while more
- *   than one depósito is active; `data.activeWarehouses` carries the count.
+ *   than one depósito is active, or the depósito read stopped before it could
+ *   count them all; `data.activeWarehouses` carries the count, and
+ *   `data.truncated: true` marks it as a floor (see
+ *   {@link StoreModuleWarehousesActiveData}).
  * - `STORE_MODULE_TRANSFER_IN_FLIGHT` (409) — `multiWarehouse` off while a stock
  *   transfer is in transit or partially received; `data.transferId` names one.
  * - `STORE_MODULE_CUSTOMER_BALANCES` (409) — `customerAccounts` off while a

package/package.json

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