platform-types 1.10.848 → 1.10.850

package/dist/auth.d.ts

@@ -296,6 +296,14 @@ declare global {
         province?: string;
         /** Receptor identities. Every field of each entry is REQUIRED — there is no partial entry. */
         afip?: CustomerRegisterAfipInput[];
+        /**
+         * The shopper's own opt-in to marketing EMAIL, ticked at registration.
+         * `true` creates the customer with `marketing.email: true` and its
+         * provenance stamp `marketing.consent.email = { ts, source: 'storefront',
+         * ip? }` (the viewer's IP, when the request has one). `false` or absent
+         * writes no `marketing` at all — and absence is never consent.
+         */
+        marketingEmail?: boolean;
     }
     /**
      * Registration request body.

package/dist/cjs/marketing.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MARKETING_COPY_VARIANTS_MAX = exports.MARKETING_COPY_VARIANTS_MIN = exports.MARKETING_COPY_FACT_MAX_CHARS = exports.MARKETING_COPY_FACTS_MAX = exports.MARKETING_COPY_FACTS_MIN = exports.MARKETING_COPY_GOAL_MAX_CHARS = exports.ABANDONED_CART_SNAPSHOT_NAME_MAX = exports.ABANDONED_CART_SNAPSHOT_MAX_LINES = exports.CART_APPLICABLE_PROMOTION_TYPES = exports.PROMOTION_TYPES = exports.AUTOMATION_RULE_STATUSES = exports.AUTOMATION_SEND_STATUSES = exports.ATTRIBUTION_WINDOW_HOURS = exports.RFM_SEGMENT_LABELS = exports.CAMPAIGN_ERROR_CODES = exports.CAMPAIGN_CLIENT_STATUSES = exports.AUTOMATION_TRIGGERS = void 0;
+exports.MARKETING_COPY_VARIANTS_MAX = exports.MARKETING_COPY_VARIANTS_MIN = exports.MARKETING_COPY_FACT_MAX_CHARS = exports.MARKETING_COPY_FACTS_MAX = exports.MARKETING_COPY_FACTS_MIN = exports.MARKETING_COPY_GOAL_MAX_CHARS = exports.ABANDONED_CART_SNAPSHOT_NAME_MAX = exports.ABANDONED_CART_MAX_DELAY_MINUTES = exports.ABANDONED_CART_MIN_DELAY_MINUTES = exports.ABANDONED_CART_SNAPSHOT_MAX_LINES = exports.CART_APPLICABLE_PROMOTION_TYPES = exports.PROMOTION_TYPES = exports.AUTOMATION_RULE_STATUSES = exports.AUTOMATION_SEND_STATUSES = exports.ATTRIBUTION_WINDOW_HOURS = exports.RFM_SEGMENT_LABELS = exports.CAMPAIGN_ERROR_CODES = exports.CAMPAIGN_CLIENT_STATUSES = exports.AUTOMATION_TRIGGERS = void 0;
 /**
  * Runtime source for {@link AutomationTrigger}, the api’s Zod enum and the
  * configuration picker. Derive them from this tuple; a separate union plus
@@ -129,6 +129,25 @@ exports.CART_APPLICABLE_PROMOTION_TYPES = [
  * not assume `lines.length <= ` this value.
  */
 exports.ABANDONED_CART_SNAPSHOT_MAX_LINES = 5;
+/**
+ * The smallest `delayMinutes` an `'ABANDONED_CART'` rule may carry.
+ *
+ * `POST /automation-rules` refuses a lower value with `400` at `delayMinutes`,
+ * on create and on an update that would leave the rule below it. A rule stored
+ * before the floor existed is READ as this value by the recovery cron and
+ * never rewritten. An hour is also the cron's own cadence: a shorter delay
+ * could not be honoured more precisely than one tick anyway.
+ */
+exports.ABANDONED_CART_MIN_DELAY_MINUTES = 60;
+/**
+ * The longest delay an `ABANDONED_CART` rule may set, in minutes: 71 hours.
+ * The recovery cron only considers carts whose last change is within the
+ * last 72 hours, so a delay of 72 hours or more leaves no cart it could ever
+ * arm. One hour below that keeps at least one hourly tick inside the window.
+ * Refused above this on create and update; a rule stored above it is READ as
+ * this value by the cron and never rewritten.
+ */
+exports.ABANDONED_CART_MAX_DELAY_MINUTES = 71 * 60;
 /**
  * How many characters of a product NAME the snapshot keeps.
  *

package/dist/customer.d.ts

@@ -1257,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
@@ -1364,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
@@ -1399,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;
         };
     }
     /**
@@ -1737,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/marketing.d.ts

@@ -510,7 +510,8 @@ declare global {
      * a per-customer frequency cap. The configuration record for automated
      * marketing — abandoned-cart recovery first.
      *
-     * ⚠️ **An `'active'` rule is an ARMED SENDER.** `cartSweep` (`ABANDONED_CART`)
+     * ⚠️ **An `'active'` rule is an ARMED SENDER.** `cartRecoveryCron`
+     * (`ABANDONED_CART`, hourly, carts idle between the rule's delay and 72 hours)
      * and `reorderDueCron` (`REORDER_DUE`) arm an {@link AutomationSend} for
      * every active rule matching the trigger; the `automation-due` cron re-reads
      * the rule, its template, the cap and consent when the delay ends, and the
@@ -562,6 +563,11 @@ declare global {
          * message delay at 15 minutes, and the whole point of an abandoned-cart
          * recovery is that it lands hours later. What implements the wait is the
          * consumer slice's problem; the rule only declares it.
+         *
+         * ⚠️ At least {@link ABANDONED_CART_MIN_DELAY_MINUTES} on an
+         * `'ABANDONED_CART'` rule — counted from the cart's own last update, and
+         * a send that would land between 21:00 and 09:00 ART is deferred to
+         * 09:00 ART.
          */
         delayMinutes: number;
         /**
@@ -593,9 +599,13 @@ declare global {
      * consent re-check, because the store had its Marketing module switched
      * off (`reason: 'MODULE_OFF'`, a store choice rather than a customer's),
      * because its plan does not carry `marketing`
-     * (`reason: 'AUTOMATION_NOT_ENTITLED'`), or because the rule's template was
-     * archived (`reason: 'AUTOMATION_TEMPLATE_ARCHIVED'`). A `'skipped'` row
-     * does not count against the frequency cap.
+     * (`reason: 'AUTOMATION_NOT_ENTITLED'`), because the rule's template was
+     * archived (`reason: 'AUTOMATION_TEMPLATE_ARCHIVED'`), or — on an
+     * `'ABANDONED_CART'` send — because the cart stopped being abandoned before
+     * the send was due: the customer ordered (`'ABANDONED_CART_CONVERTED'`),
+     * came back to the cart (`'ABANDONED_CART_TOUCHED'`), or the cart is gone or
+     * empty (`'ABANDONED_CART_GONE'`). A `'skipped'` row does not count against
+     * the frequency cap.
      *
      * Deliberately the same four values as {@link CampaignRecipientStatus}, and
      * deliberately a SEPARATE type rather than an alias: the two vocabularies
@@ -968,6 +978,46 @@ declare global {
          */
         complete: boolean;
     }
+    /**
+     * What one pass of the hourly abandoned-cart recovery EMITTER
+     * (`cartRecoveryCron`) did — the body of its operator-facing `response()`.
+     *
+     * ⚠️ See {@link AutomationDueCronTotals} for why each cron has its own type.
+     */
+    interface CartRecoveryCronTotals {
+        /** Tenants visited this pass. */
+        stores: number;
+        /** Of those, the few with an ACTIVE `'ABANDONED_CART'` rule — the only ones whose carts are read. */
+        storesWithRules: number;
+        /** Tenants whose pass threw. Isolated: the rest of the tick still ran. */
+        storesFailed: number;
+        /** The store roster hit its page bound, so some tenants went unvisited. */
+        rosterTruncated: boolean;
+        /** Candidate cart rows read inside the recovery window. */
+        scanned: number;
+        /** Carts claimed for this version and handed to the rules. */
+        carts: number;
+        /** Sends queued across every rule, for those carts. */
+        sendsArmed: number;
+        /** Rule matches declined at arm time because the customer was at that rule's cap. */
+        sendsCapped: number;
+        /**
+         * Candidates already claimed for the version of the cart stored now — an
+         * earlier tick armed them and the shopper has not been back since. The
+         * EXPECTED steady state for most of the window.
+         */
+        alreadyArmed: number;
+        /** Candidates that are not a recoverable cart — no valid customer or no items. */
+        ineligible: number;
+        /** Carts touched (or deleted) between the read and the claim — left for a later tick. */
+        raced: number;
+        /**
+         * The pass reached the end of its roster rather than stopping on its own
+         * clock reserve. ⚠️ `false` is normal under load: the next hourly tick
+         * resumes, and the 72-hour window spans many ticks.
+         */
+        complete: boolean;
+    }
     /**
      * The channel one `POST /marketing/copy` request generates for.
      *
@@ -1204,6 +1254,25 @@ export declare const CART_APPLICABLE_PROMOTION_TYPES: readonly ["buyXGetY", "fre
  * not assume `lines.length <= ` this value.
  */
 export declare const ABANDONED_CART_SNAPSHOT_MAX_LINES = 5;
+/**
+ * The smallest `delayMinutes` an `'ABANDONED_CART'` rule may carry.
+ *
+ * `POST /automation-rules` refuses a lower value with `400` at `delayMinutes`,
+ * on create and on an update that would leave the rule below it. A rule stored
+ * before the floor existed is READ as this value by the recovery cron and
+ * never rewritten. An hour is also the cron's own cadence: a shorter delay
+ * could not be honoured more precisely than one tick anyway.
+ */
+export declare const ABANDONED_CART_MIN_DELAY_MINUTES = 60;
+/**
+ * The longest delay an `ABANDONED_CART` rule may set, in minutes: 71 hours.
+ * The recovery cron only considers carts whose last change is within the
+ * last 72 hours, so a delay of 72 hours or more leaves no cart it could ever
+ * arm. One hour below that keeps at least one hourly tick inside the window.
+ * Refused above this on create and update; a rule stored above it is READ as
+ * this value by the cron and never rewritten.
+ */
+export declare const ABANDONED_CART_MAX_DELAY_MINUTES: number;
 /**
  * How many characters of a product NAME the snapshot keeps.
  *

package/dist/marketing.js

@@ -126,6 +126,25 @@ export const CART_APPLICABLE_PROMOTION_TYPES = [
  * not assume `lines.length <= ` this value.
  */
 export const ABANDONED_CART_SNAPSHOT_MAX_LINES = 5;
+/**
+ * The smallest `delayMinutes` an `'ABANDONED_CART'` rule may carry.
+ *
+ * `POST /automation-rules` refuses a lower value with `400` at `delayMinutes`,
+ * on create and on an update that would leave the rule below it. A rule stored
+ * before the floor existed is READ as this value by the recovery cron and
+ * never rewritten. An hour is also the cron's own cadence: a shorter delay
+ * could not be honoured more precisely than one tick anyway.
+ */
+export const ABANDONED_CART_MIN_DELAY_MINUTES = 60;
+/**
+ * The longest delay an `ABANDONED_CART` rule may set, in minutes: 71 hours.
+ * The recovery cron only considers carts whose last change is within the
+ * last 72 hours, so a delay of 72 hours or more leaves no cart it could ever
+ * arm. One hour below that keeps at least one hourly tick inside the window.
+ * Refused above this on create and update; a rule stored above it is READ as
+ * this value by the cron and never rewritten.
+ */
+export const ABANDONED_CART_MAX_DELAY_MINUTES = 71 * 60;
 /**
  * How many characters of a product NAME the snapshot keeps.
  *

package/package.json

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