platform-types 1.10.851 → 1.10.852

package/dist/cjs/customerAddress.js

@@ -15,7 +15,11 @@
 //
 // Every existing reader of those fields keeps working unchanged. Forward-only:
 // a customer written before the address book has no address rows; the first
-// edit of their address (through `/customers/addresses`, `POST /customers`, the
-// storefront profile, or an order's `saveAsDefault`) creates the row and points
-// the default at it. Nothing sweeps.
+// edit of their address (through `/customers/addresses`, the web `/addresses`,
+// `POST /customers`, the storefront profile, or an order's `saveAsDefault`)
+// creates the row and points the default at it. Nothing sweeps.
+//
+// Two surfaces: staff `/customers/addresses` (both kinds, uncapped) and the
+// shopper's own web `/addresses` (the `delivery` kind only, at most
+// `SHOPPER_DELIVERY_ADDRESS_CAP` = 20, plus an order's `saveAddress`).
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/customerAddress.d.ts

@@ -30,7 +30,8 @@ declare global {
     }
     /**
      * `GET /customers/addresses?customerId=` — one page, ascending by
-     * `addressId` (oldest first).
+     * `addressId` (oldest first). Also web `GET /addresses`, where it holds the
+     * caller's own `delivery` addresses only.
      */
     interface CustomerAddressPage {
         items: CustomerAddress[];
@@ -41,8 +42,10 @@ declare global {
     }
     /**
      * `data` of the `customerAddress` socket frame. OPERATOR audience only — the
-     * customer's own socket is NOT addressed (staff only, for now: no storefront
-     * address-book surface consumes it).
+     * customer's own socket is NOT addressed, also when the customer made the
+     * change through web `/addresses` (the storefront reads its own write from
+     * the REST answer). A shopper's write sends exactly the frame a staff write
+     * does.
      *
      * `address` is the whole row on the admin tier for `created` / `updated`.
      * It is absent on a `deleted` change, and on the rare `updated` frame of a
@@ -97,9 +100,48 @@ declare global {
         updatedAt: number;
     }
     /**
-     * Every DOMAIN refusal on `/customers/addresses`, one bare code each (the
-     * generic `VALIDATION_FAILED`, `CAPABILITY_REQUIRED` and `INVALID_CURSOR`
-     * are not listed). None of them writes.
+     * Web `POST /addresses` body — the shopper's own new `delivery` address.
+     * There is no `kind` (a sent one is ignored: the shopper surface books
+     * `delivery` only) and no `customerId` (the session names the customer).
+     * `address` is required; every text field is trimmed and at most 200
+     * characters.
+     */
+    interface ShopperAddressCreateRequest {
+        label?: string;
+        fullName?: string;
+        phone?: string;
+        address: string;
+        city?: string;
+        province?: string;
+        postalCode?: string;
+        /** Make it the delivery default — `Customer.deliveryAddress` follows in the same write. */
+        makeDefault?: boolean;
+    }
+    /**
+     * Web `PUT /addresses` body: the address to edit plus ONLY the fields that
+     * changed (the storefront sends a dirty-field diff), and/or `makeDefault:
+     * true`. At least one of the two. A billing `addressId`, or another
+     * customer's, is `404 CUSTOMER_ADDRESS_NOT_FOUND`.
+     */
+    interface ShopperAddressUpdateRequest extends Partial<Omit<ShopperAddressCreateRequest, 'makeDefault'>> {
+        addressId: string;
+        /** A default is replaced, never cleared, so only `true` is accepted. */
+        makeDefault?: true;
+    }
+    /**
+     * Web `POST` / `PUT /addresses` → `{ data, defaultAddressId }`: the address
+     * as written, and the delivery default AFTER the write — a create that
+     * adopted the customer's legacy `deliveryAddress` leaves THAT one the
+     * default. Absent when the customer has no delivery default.
+     */
+    interface ShopperAddressWriteResult {
+        data: CustomerAddress;
+        defaultAddressId?: string;
+    }
+    /**
+     * Every DOMAIN refusal on `/customers/addresses` and the web `/addresses`,
+     * one bare code each (the generic `VALIDATION_FAILED`, `CAPABILITY_REQUIRED`
+     * and `INVALID_CURSOR` are not listed). None of them writes.
      *
      * - `CUSTOMER_ADDRESS_CUSTOMER_NOT_FOUND` (404) — not a customer of the
      *   caller's store; covers «no such id», so the route is no cross-tenant
@@ -108,13 +150,20 @@ declare global {
      *   art. 16; enforced atomically with the write.
      * - `CUSTOMER_ADDRESS_CUSTOMER_MERGED` (409) — folded into another customer
      *   (`mergedInto`); write on the survivor.
-     * - `CUSTOMER_ADDRESS_NOT_FOUND` (404) — no such address for that customer.
+     * - `CUSTOMER_ADDRESS_NOT_FOUND` (404) — no such address for that customer;
+     *   on the web `/addresses`, also a `billing` address.
      * - `CUSTOMER_ADDRESS_IS_DEFAULT` (409) — the address is its kind's default;
      *   make another address the default first. The default is what
      *   `Customer.address` / `deliveryAddress` mirror, so it is never deleted
-     *   out from under them.
+     *   out from under them. One exception, web `/addresses` only: the
+     *   shopper's ONLY delivery address may be deleted, which unmarks the
+     *   default and removes `Customer.deliveryAddress` in the same write.
+     * - `CUSTOMER_ADDRESS_LIMIT_REACHED` (409) — web `/addresses` only: the
+     *   shopper already holds 20 delivery addresses (a book too large to count
+     *   counts as full). Delete one first. Staff routes are uncapped.
      * - `CUSTOMER_ADDRESS_WRITE_CONTENDED` (503) — the customer's default or the
-     *   address changed under every bounded retry; retry is safe. ALSO answered
+     *   address changed under every bounded retry, on either surface; retry is
+     *   safe. ALSO answered
      *   by `POST /customers` and the storefront `POST /user` when an edit of
      *   the address loses to a rival that moved the default or its copy — those
      *   refuse on the FIRST failure, with no retry of their own. The storefront
@@ -126,6 +175,6 @@ declare global {
      * `409 CUSTOMER_ANONYMIZED` (see `Customer.anonymizedAt`) and `409
      * CUSTOMER_MERGE_IN_PROGRESS` (merged or mid-merge after their read).
      */
-    type CustomerAddressErrorCode = 'CUSTOMER_ADDRESS_CUSTOMER_NOT_FOUND' | 'CUSTOMER_ADDRESS_CUSTOMER_ANONYMIZED' | 'CUSTOMER_ADDRESS_CUSTOMER_MERGED' | 'CUSTOMER_ADDRESS_NOT_FOUND' | 'CUSTOMER_ADDRESS_IS_DEFAULT' | 'CUSTOMER_ADDRESS_WRITE_CONTENDED';
+    type CustomerAddressErrorCode = 'CUSTOMER_ADDRESS_CUSTOMER_NOT_FOUND' | 'CUSTOMER_ADDRESS_CUSTOMER_ANONYMIZED' | 'CUSTOMER_ADDRESS_CUSTOMER_MERGED' | 'CUSTOMER_ADDRESS_NOT_FOUND' | 'CUSTOMER_ADDRESS_IS_DEFAULT' | 'CUSTOMER_ADDRESS_LIMIT_REACHED' | 'CUSTOMER_ADDRESS_WRITE_CONTENDED';
 }
 export {};

package/dist/customerAddress.js

@@ -14,7 +14,11 @@
 //
 // Every existing reader of those fields keeps working unchanged. Forward-only:
 // a customer written before the address book has no address rows; the first
-// edit of their address (through `/customers/addresses`, `POST /customers`, the
-// storefront profile, or an order's `saveAsDefault`) creates the row and points
-// the default at it. Nothing sweeps.
+// edit of their address (through `/customers/addresses`, the web `/addresses`,
+// `POST /customers`, the storefront profile, or an order's `saveAsDefault`)
+// creates the row and points the default at it. Nothing sweeps.
+//
+// Two surfaces: staff `/customers/addresses` (both kinds, uncapped) and the
+// shopper's own web `/addresses` (the `delivery` kind only, at most
+// `SHOPPER_DELIVERY_ADDRESS_CAP` = 20, plus an order's `saveAddress`).
 export {};

package/dist/order.d.ts

@@ -2524,8 +2524,33 @@ declare global {
             province?: string;
             postalCode?: string;
         };
-        /** Persist `deliveryAddress` as the customer's default. Directive only, never stored. */
+        /**
+         * Persist `deliveryAddress` as the customer's default, OVERWRITING the
+         * current delivery default's text in place (creating one only when there
+         * is none). Directive only, never stored.
+         *
+         * DEPRECATED — use {@link saveAddress}, which appends a new address to
+         * the customer's book instead of overwriting the default. `saveAsDefault`
+         * keeps working, and retires one release after `saveAddress` is live.
+         * `saveAsDefault: true` together with `saveAddress` is `400
+         * VALIDATION_FAILED`; `false` asks for nothing and is accepted beside it.
+         */
         saveAsDefault?: boolean;
+        /**
+         * Save `deliveryAddress` as a NEW delivery address in the customer's
+         * book (web `/addresses`), AFTER the order commits — best effort: it
+         * never refuses or fails the order. `makeDefault: true` also makes it the
+         * delivery default (and `Customer.deliveryAddress`); otherwise the
+         * current default, text included, is left as it was. Ignored without
+         * `deliveryAddress`, or when that address carries no `address` line or a
+         * field over 200 characters; skipped (and logged) when the customer
+         * already holds 20 delivery addresses. Directive only, never stored.
+         * Sending it together with `saveAsDefault: true` is `400
+         * VALIDATION_FAILED`; an unknown inner key is stripped.
+         */
+        saveAddress?: {
+            makeDefault?: boolean;
+        };
         /**
          * The `cartId` of the cart the shopper confirmed (`CART` + 6-10 digits).
          * Omit it ONLY when that cart had none (a legacy cart). ⚠️ Compared
@@ -2560,11 +2585,12 @@ declare global {
     /**
      * Web `POST /orders/guest` body: a guest places an order from the server
      * guest cart its `X-Guest-Cart-Token` names. `StorefrontOrderCreateRequest`
-     * without `saveAsDefault` (a guest has no defaults), plus the guest's
+     * without `saveAsDefault` / `saveAddress` (a guest has no defaults and no
+     * address book), plus the guest's
      * `contact`, and with the cart pin REQUIRED: the guest cart always has an
      * id and a version.
      */
-    interface StorefrontGuestOrderCreateRequest extends Omit<StorefrontOrderCreateRequest, 'saveAsDefault' | 'expectedCartId' | 'expectedCartVersion'> {
+    interface StorefrontGuestOrderCreateRequest extends Omit<StorefrontOrderCreateRequest, 'saveAsDefault' | 'saveAddress' | 'expectedCartId' | 'expectedCartVersion'> {
         contact: GuestContact;
         expectedCartId: string;
         expectedCartVersion: number;

package/package.json

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