platform-types 1.10.847 → 1.10.849

package/dist/cjs/messaging.js

@@ -8,7 +8,7 @@
  * modification, or distribution is strictly prohibited.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MESSAGE_DELIVERY_STAMPS = exports.MESSAGE_LEDGER_KINDS = exports.MESSAGE_CREDITS_PER_CHANNEL = exports.MESSAGE_ALLOWANCE_UNLIMITED = exports.SMS_FALLBACK_CREDITS = exports.WHATSAPP_MESSAGE_CREDITS = exports.MESSAGE_LEDGER_OPERATOR_ONLY_FIELDS = void 0;
+exports.STORE_MESSAGE_SKIP_REASONS = exports.STORE_MESSAGE_STATUSES = exports.MESSAGE_DELIVERY_STAMPS = exports.MESSAGE_LEDGER_KINDS = exports.MESSAGE_CREDITS_PER_CHANNEL = exports.MESSAGE_ALLOWANCE_UNLIMITED = exports.SMS_FALLBACK_CREDITS = exports.WHATSAPP_MESSAGE_CREDITS = exports.MESSAGE_LEDGER_OPERATOR_ONLY_FIELDS = void 0;
 /**
  * Fields a store's own ledger read drops from an `adjustment` entry: it is a
  * platform operator act, and its `actor`, `reason` and `refId` (the
@@ -47,3 +47,21 @@ exports.MESSAGE_DELIVERY_STAMPS = [
     'read',
     'failed',
 ];
+exports.STORE_MESSAGE_STATUSES = [
+    'queued',
+    'sending',
+    'sent',
+    'delivered',
+    'read',
+    'failed',
+    'undelivered',
+    'skipped',
+];
+exports.STORE_MESSAGE_SKIP_REASONS = [
+    'switched-off',
+    'no-consent',
+    'no-phone',
+    'no-credits',
+    'not-configured',
+    'messaging-disabled',
+];

package/dist/customer.d.ts

@@ -102,10 +102,11 @@ declare global {
      * `back-office` (staff, `POST /customers`), `storefront-post-purchase` (the
      * one-tap offer after an order is placed — the signed-in banner through web
      * `POST /user` with `whatsappOptInOrigin: 'post-purchase'`, or a guest's
-     * `POST /orders/status/whatsapp-opt-in`) and `storefront-profile` (the
-     * shopper's own profile toggle, web `POST /user`).
+     * `POST /orders/status/whatsapp-opt-in`), `storefront-profile` (the
+     * shopper's own profile toggle, web `POST /user`) and `whatsapp-reply` (a
+     * withdrawal only: the customer answered «BAJA» to a store notice).
      */
-    type WhatsappNoticeSource = 'back-office' | 'storefront-post-purchase' | 'storefront-profile';
+    type WhatsappNoticeSource = 'back-office' | 'storefront-post-purchase' | 'storefront-profile' | 'whatsapp-reply';
     /**
      * Provenance of one transactional WhatsApp grant or withdrawal.
      * Server-written only. Carries NO phone number and NO IP, unlike
@@ -1256,6 +1257,88 @@ declare global {
         productId: string;
         lastOrderedAt: number;
     }
+    /**
+     * One entry of `CustomerDataExport.serviceOrders`: a service ticket as the
+     * customer was told about it — an ALLOW-LIST of the `ServiceOrder` row, never
+     * the row itself. The diagnosis, the work logs, the parts and their cost, the
+     * technician, the operator status notes and who moved each status, the quote's
+     * approver/rejecter and rejection note, the hold, the deposits and the
+     * pictures are the workshop's own record and are NOT here.
+     */
+    interface CustomerDataExportServiceOrder {
+        serviceOrderId: string;
+        ticketNumber: string;
+        serviceType: ServiceType;
+        status: ServiceStatus;
+        /** The status timeline, oldest first: each status and when it was entered, nothing else. */
+        statusHistory: {
+            status: ServiceStatus;
+            timestamp: number;
+        }[];
+        /** The equipment as received. Absent when the ticket recorded none (or an erasure removed it). */
+        equipment?: {
+            type?: string;
+            brand?: string;
+            model?: string;
+            serialNumber?: string;
+            accessories?: string[];
+            condition?: string;
+            reportedIssue?: string;
+        };
+        /** Every quote version, oldest first — the customer-facing fields only. */
+        quote?: {
+            quoteId: string;
+            version: number;
+            status: ServiceQuoteStatus;
+            amount: number;
+            currency?: string;
+            quotedAt?: number;
+            expiresAt?: number;
+            /** When and through which channel the customer approved — never who recorded it. */
+            approval?: {
+                at: number;
+                channel: ServiceQuoteChannel;
+            };
+            /** When and why the customer declined — never the operator's note or who recorded it. */
+            rejection?: {
+                at: number;
+                reason: ServiceQuoteRejectionReason;
+            };
+        }[];
+        total?: number;
+        currency: string;
+        createdAt: number;
+        promisedAt?: number;
+        readyAt?: number;
+        deliveredAt?: number;
+        /** `true` on a ticket the store soft-deleted; absent on a live one. */
+        disabled?: boolean;
+    }
+    /**
+     * `CustomerDataExport.loyalty`: the subject's points account and ledger. Never
+     * the acting user (`createdBy`) of a ledger row — a third party's id.
+     */
+    interface CustomerDataExportLoyalty {
+        /** Absent when nothing ever credited or debited the customer (no account row exists). */
+        account?: {
+            balance: number;
+            lifetimePoints: number;
+            tierId?: string;
+            updatedAt: number;
+        };
+        /** The ledger, newest first. */
+        transactions: {
+            transactionId: string;
+            kind: LoyaltyTransactionKind;
+            /** Signed, as written: an `earn` positive, a `redeem` negative, an `adjust` either. */
+            points: number;
+            currency: string;
+            createdAt: number;
+            orderId?: string;
+            couponCode?: string;
+            rewardId?: string;
+        }[];
+    }
     /**
      * Supported customer, CRM, order, invoice, ledger and directly customer-linked
      * payment collections, assembled for the SUBJECT
@@ -1363,6 +1446,20 @@ declare global {
          * storefront quote requests).
          */
         quoteRequests?: QuoteRequest[];
+        /**
+         * The subject's service tickets, newest first, on BOTH surfaces: live and
+         * soft-deleted (`disabled: true`), under their own id plus any merged-away id
+         * folded into them (the same folded ids, and the same cap, as the financial
+         * collections). At most 200 live and 200 soft-deleted per id. Absent when
+         * there is none (and from servers predating this section).
+         */
+        serviceOrders?: CustomerDataExportServiceOrder[];
+        /**
+         * The subject's loyalty account and points ledger (at most 1,000 rows), on
+         * BOTH surfaces, under their OWN id only. Absent when there is neither an
+         * account nor a ledger row (and from servers predating this section).
+         */
+        loyalty?: CustomerDataExportLoyalty;
         /**
          * Per COLLECTION, and honest: `true` means the read stopped before the
          * end of a partition, folded financial IDs were omitted at the cap, or whole
@@ -1398,6 +1495,15 @@ declare global {
              * past the per-export request cap, may be missing.
              */
             quoteRequests?: boolean;
+            /**
+             * Present when `serviceOrders` is, or when merged-away ids were cut at the
+             * folded-id cap — then `true`: a ticket under an omitted id, past the
+             * per-id cap or the read budget, or cut by the response-byte bound, may be
+             * missing.
+             */
+            serviceOrders?: boolean;
+            /** Present exactly when `loyalty` is: `true` when ledger rows past the cap, or the byte bound, are missing. */
+            loyalty?: boolean;
         };
     }
     /**
@@ -1736,6 +1842,25 @@ declare global {
          * (`CUSTOMER_ANONYMIZE_CREDIT_NOTE_MARKER_INCOMPLETE`).
          */
         creditNoteMarkerEraseComplete?: boolean;
+        /**
+         * `SERVICE#` tickets of this customer, live and soft-deleted, whose
+         * customer-describing free text this erasure took off: `equipment`'s
+         * `serialNumber`, `reportedIssue`, `condition` and `accessories` REMOVEd, and
+         * `search` rebuilt without the serial and the customer's name. The ticket's
+         * operational and fiscal skeleton is kept. Both wires carry it: it counts the
+         * subject's own rows. A re-issue counts only the tickets an earlier pass did
+         * not reach. Optional only so the field is additive.
+         */
+        serviceOrdersScrubbed?: number;
+        /**
+         * `false` when those tickets could not be read or written to the end, so a
+         * serial or a reported fault may remain. Re-issuing the erasure re-runs the
+         * step (it reads at most 1,000 of the subject's tickets, so past that a
+         * re-issue cannot finish it); BOTH erasure handlers write a deduped `ERROR` row
+         * (`CUSTOMER_ANONYMIZE_SERVICE_ORDERS_INCOMPLETE`). Only a measured `true` is
+         * a finished step.
+         */
+        serviceOrderScrubComplete?: boolean;
         /**
          * Storefront quote requests the subject sent signed in
          * (`QUOTEREQUEST#{storeId}`), DELETED by this erasure — the whole row goes:

package/dist/messaging.d.ts

@@ -144,6 +144,65 @@ declare global {
          */
         adjustmentId: string;
     }
+    /**
+     * Where one store-paid customer notice stands (`MSG#{storeId}` row):
+     * - `queued` — decided to send, credits reserved, handed to the sender.
+     * - `sending` — the sender claimed it; the provider call is in flight, or
+     *   its outcome is unknown (the provider may have accepted it — it is never
+     *   sent again).
+     * - `sent` — the provider accepted it.
+     * - `delivered` / `read` — reported by the provider.
+     * - `failed` — the provider refused it or reported it failed; its credits
+     *   were refunded.
+     * - `undelivered` — the provider reported it could not be delivered; its
+     *   credits were refunded.
+     * - `skipped` — never sent, see `StoreMessageSkipReason`.
+     */
+    type StoreMessageStatus = 'queued' | 'sending' | 'sent' | 'delivered' | 'read' | 'failed' | 'undelivered' | 'skipped';
+    /**
+     * Why a notice was not sent:
+     * - `switched-off` — the store's switch for this notice is off.
+     * - `no-consent` — the customer has not opted in to WhatsApp notices (or
+     *   the order has no live customer).
+     * - `no-phone` — no usable number (see `MessageNoticeListItem`).
+     * - `no-credits` — the store's credits could not cover it.
+     * - `not-configured` — the platform has no approved template for it yet.
+     * - `messaging-disabled` — the `tenantMessagingEnabled` platform global is
+     *   off. Decided, never stored: no notice row is written for it.
+     */
+    type StoreMessageSkipReason = 'switched-off' | 'no-consent' | 'no-phone' | 'no-credits' | 'not-configured' | 'messaging-disabled';
+    /**
+     * One customer notice of an order or a service order — `Order.messageNotices`
+     * (operator point read) and `ServiceOrder.messageNotices`. Operator-only: no
+     * storefront read or customer socket carries it. Oldest first.
+     */
+    interface MessageNoticeListItem {
+        /** Stable per notice occurrence; a frame replaces the item with the same id. */
+        noticeId: string;
+        notice: StoreMessageNotice;
+        /** What happened to the order: `ready`, `delivered`, `status:<to>`, `quote-sent`, `hold-set`, `hold-cleared`. */
+        event: string;
+        /** The channel it went out (or would have gone out) on. Absent on a skipped notice. */
+        channel?: MessageCreditChannel;
+        status: StoreMessageStatus;
+        /** Present exactly when `status` is `skipped`. */
+        skipReason?: StoreMessageSkipReason;
+        /** `true` once the WhatsApp leg failed and the SMS fallback took over. */
+        fellBackToSms?: boolean;
+        /** When the notice was decided. */
+        ts: number;
+        updatedAt: number;
+    }
+    /**
+     * The `orders` / `services` frame the notice pipeline sends (operator audience
+     * only) whenever a notice of that entity moves: the entity's id and its WHOLE
+     * current list, never a delta — merge it onto the cached row.
+     */
+    interface MessageNoticesFrameData {
+        orderId?: string;
+        serviceOrderId?: string;
+        messageNotices: MessageNoticeListItem[];
+    }
     interface MessageCreditAdjustmentResult {
         storeId: string;
         /** The `adjustment` ledger entry. */
@@ -178,3 +237,5 @@ export declare const MESSAGE_CREDITS_PER_CHANNEL: {
 };
 export declare const MESSAGE_LEDGER_KINDS: readonly ["debit", "refund", "allowance-grant", "purchase", "adjustment"];
 export declare const MESSAGE_DELIVERY_STAMPS: readonly ["delivered", "read", "failed"];
+export declare const STORE_MESSAGE_STATUSES: readonly ["queued", "sending", "sent", "delivered", "read", "failed", "undelivered", "skipped"];
+export declare const STORE_MESSAGE_SKIP_REASONS: readonly ["switched-off", "no-consent", "no-phone", "no-credits", "not-configured", "messaging-disabled"];

package/dist/messaging.js

@@ -44,3 +44,21 @@ export const MESSAGE_DELIVERY_STAMPS = [
     'read',
     'failed',
 ];
+export const STORE_MESSAGE_STATUSES = [
+    'queued',
+    'sending',
+    'sent',
+    'delivered',
+    'read',
+    'failed',
+    'undelivered',
+    'skipped',
+];
+export const STORE_MESSAGE_SKIP_REASONS = [
+    'switched-off',
+    'no-consent',
+    'no-phone',
+    'no-credits',
+    'not-configured',
+    'messaging-disabled',
+];

package/dist/order.d.ts

@@ -443,7 +443,10 @@ declare global {
         tracking?: OrderShipmentTracking;
         /** ≤ 500 chars, operator-only. */
         note?: string;
-        /** SMS the customer when THIS shipment completes the order. */
+        /**
+         * Accepted and IGNORED: a completing shipment owes the store's `orderShipped`
+         * notice, which the store's settings decide (`docs/NOTIFICATIONS.md` § Store notices).
+         */
         sendSms?: boolean;
     }
     /**
@@ -2025,6 +2028,14 @@ declare global {
          * on a list branch, the storefront read or any socket frame.
          */
         cancellation?: OrderCancellability;
+        /**
+         * The order's store-paid customer notices (WhatsApp / SMS), oldest first,
+         * read from the `MSG#` partition — never stored on the ORDER row, and a
+         * body echoing it is stripped. Present only while the
+         * `tenantMessagingEnabled` platform global is on. Kept live by the
+         * operator `orders` frame `MessageNoticesFrameData`.
+         */
+        messageNotices?: MessageNoticeListItem[];
     }
     /**
      * `POST /orders { mode: 'tender' }` — ring one or more tender legs against an
@@ -2419,7 +2430,10 @@ declare global {
          * stored. Required alongside {@link lines}, which is refused without it.
          */
         counterSale?: boolean;
-        /** Send the order's SMS notification. Directive only, never stored. */
+        /**
+         * Accepted and IGNORED, never stored: the store's `orderReady` notice is
+         * decided by the store's settings (`docs/NOTIFICATIONS.md` § Store notices).
+         */
         sendSms?: boolean;
         /** Persist `deliveryAddress` as the customer's default. Directive only, never stored. */
         saveAsDefault?: boolean;

package/dist/serviceOrder.d.ts

@@ -918,6 +918,13 @@ declare global {
          * write response over a previously-read derivation.
          */
         slaStatus?: ServiceSlaStatus;
+        /**
+         * The ticket's store-paid customer notices (WhatsApp / SMS), oldest first —
+         * the point read only, read from the `MSG#` partition and never persisted.
+         * Present only while the `tenantMessagingEnabled` platform global is on.
+         * Kept live by the operator `services` frame `MessageNoticesFrameData`.
+         */
+        messageNotices?: MessageNoticeListItem[];
         technicianId?: string;
         /** Unix ms the order was assigned. */
         assignedAt?: number;

package/package.json

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