sinfactura-types 1.10.199 → 1.10.201

package/dist/cjs/socket.js

@@ -61,6 +61,17 @@ exports.SOCKET_ACTIONS = [
     'brands',
     'cash',
     'categories',
+    /**
+     * A marketing campaign created, updated, scheduled or cancelled.
+     * Operator-only — `wsPostStore(..., { audience: 'operator' })`.
+     *
+     * `Campaign` carries no `customerId`, so the customer leg of
+     * `'operator-and-customer'` would be a no-op query rather than a leak —
+     * but state the audience explicitly anyway: the safety here is a property
+     * of today's shape, not of the broadcast call, and a later field would
+     * silently turn a no-op into a fan-out.
+     */
+    'campaigns',
     'customers',
     /**
      * A delivery created, or an event appended to its timeline. Operator-only —
@@ -75,10 +86,33 @@ exports.SOCKET_ACTIONS = [
     'literals',
     'orders',
     'products',
+    /**
+     * A promotion created, updated or retired. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`. Carries no discount
+     * mechanics: `couponCode` links to the `Coupon` that holds them, so a
+     * customer-visible offer still reaches the storefront through its own
+     * surface rather than this operator frame.
+     */
+    'promotions',
+    /**
+     * A customer segment created, updated or deleted. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`, NEVER
+     * `'operator-and-customer'`: `SegmentCriteria` describes how customers are
+     * TARGETED, and broadcasting that to a customer socket would disclose the
+     * store's targeting rules to the people being targeted.
+     */
+    'segments',
     // BE → all store users when a return (devolución) commits. Distinct from
     // `orders` — carries the committed `Return` row itself (stock/account/credit-note
     // effects), not just the order's bumped `updatedAt`.
     'returns',
+    /**
+     * A message template created, updated or deleted. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`. A template is authoring
+     * content, never a sent message: nothing here implies a customer received
+     * anything.
+     */
+    'templates',
     // BE → all store users on any service-order mutation. Operator-only by
     // construction: a `ServiceOrder` carries internal diagnosis notes, per-part
     // `unitCost`, work logs and technician ids, and `scrubForCustomer` strips

package/dist/marketing.d.ts

@@ -36,6 +36,57 @@ declare global {
         createdAt: number;
         updatedAt?: number;
     }
+    type SegmentOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'within' | 'olderThan' | 'includes';
+    /**
+     * What a segment rule may target. Closed deliberately: an open `string`
+     * would be the same unversioned escape hatch as an untyped criteria object,
+     * just spread across three fields — a typo'd field name would compile, store,
+     * and silently match zero customers forever.
+     *
+     * ⚠️ Limited to what is queryable on `Customer` TODAY. No product or order
+     * predicates ("bought category X"), because no domain logic exists to
+     * evaluate them — a v1 boundary, not an oversight.
+     *
+     * ⚠️ RFM (`recency` / `frequency` / `monetary`) is deliberately ABSENT. It
+     * has no evaluator, and reserving a word costs nothing to defer while
+     * shipping it costs a stored segment whose meaning is undefined until
+     * somebody picks semantics — at which point every stored row silently
+     * changes meaning. Adding a member is a patch bump; un-defining one is not.
+     */
+    type SegmentField = 'balance' | 'creditLimit' | 'lastBuy' | 'disabled' | 'marketing.adds' | 'marketing.email' | 'marketing.phone' | 'marketing.sms' | 'marketing.whatsapp';
+    /**
+     * ⚠️ The type cannot express which operators suit which field — `disabled`
+     * with `gt` compiles. The handler validates the pairing; the type only bounds
+     * the vocabulary.
+     */
+    interface SegmentRule {
+        field: SegmentField;
+        operator: SegmentOperator;
+        value: string | number | boolean;
+    }
+    interface SegmentCriteria {
+        matchMode: 'all' | 'any';
+        rules: SegmentRule[];
+    }
+    /**
+     * A saved, dynamic customer set a campaign targets.
+     *
+     * ⚠️ **A segment is a TARGETING filter, never a consent decision.** The rule
+     * vocabulary can express `marketing.email eq false`, so a segment CAN name
+     * customers who have refused a channel. The send pipeline must filter on live
+     * consent independently of the segment, and must never treat segment
+     * membership as permission to send. A campaign that mails a segment because
+     * the segment said so is how a refusal becomes a delivered email.
+     */
+    interface Segment {
+        storeId: string;
+        segmentId: string;
+        name: string;
+        criteria: SegmentCriteria;
+        status: 'active' | 'archived';
+        createdAt: number;
+        updatedAt?: number;
+    }
     /**
      * A marketing wrapper around a coupon that already exists.
      *

package/dist/socket.d.ts

@@ -26,7 +26,7 @@
  * A client must ignore actions it does not own rather than assume it
  * receives all of them.
  */
-export declare const SOCKET_ACTIONS: readonly ["account", "appointments", "attendance", "baskets", "cart", "brands", "cash", "categories", "customers", "deliveries", "globals", "invoices", "literals", "orders", "products", "returns", "services", "service-templates", "shifts", "stores", "suppliers", "supplier-invoice", "support", "surveys", "users", "favorites", "webhooks", "account-delete", "baskets-delete", "cart-delete", "log-delete", "notifications", "support-message", "whatsapp-message", "payment_received", "payment_linked", "payment_unlinked", "mercadopago", "mercadopago_dynamic_qr_created", "mercadopago_static_qr_created", "mp_hook_log_appended", "mp_ipn_log_appended", "stripe", "subscription", "caea", "print", "print-order", "print-invoice", "print-product", "print-tag", "print_job_failed", "request_printers", "printers_changed", "agent_status_changed", "print_rules_changed", "printers_active", "agent_command", "maintenance", "currency_auto_updated", "drain_progress", "integration_event_appended", "userActivityRecorded", "mercadolibre_settlement_period", "customDomain", "purchaseOrders"];
+export declare const SOCKET_ACTIONS: readonly ["account", "appointments", "attendance", "baskets", "cart", "brands", "cash", "categories", "campaigns", "customers", "deliveries", "globals", "invoices", "literals", "orders", "products", "promotions", "segments", "returns", "templates", "services", "service-templates", "shifts", "stores", "suppliers", "supplier-invoice", "support", "surveys", "users", "favorites", "webhooks", "account-delete", "baskets-delete", "cart-delete", "log-delete", "notifications", "support-message", "whatsapp-message", "payment_received", "payment_linked", "payment_unlinked", "mercadopago", "mercadopago_dynamic_qr_created", "mercadopago_static_qr_created", "mp_hook_log_appended", "mp_ipn_log_appended", "stripe", "subscription", "caea", "print", "print-order", "print-invoice", "print-product", "print-tag", "print_job_failed", "request_printers", "printers_changed", "agent_status_changed", "print_rules_changed", "printers_active", "agent_command", "maintenance", "currency_auto_updated", "drain_progress", "integration_event_appended", "userActivityRecorded", "mercadolibre_settlement_period", "customDomain", "purchaseOrders"];
 /** Union of every server→client data-frame action. */
 export type SocketAction = (typeof SOCKET_ACTIONS)[number];
 /**

package/dist/socket.js

@@ -58,6 +58,17 @@ export const SOCKET_ACTIONS = [
     'brands',
     'cash',
     'categories',
+    /**
+     * A marketing campaign created, updated, scheduled or cancelled.
+     * Operator-only — `wsPostStore(..., { audience: 'operator' })`.
+     *
+     * `Campaign` carries no `customerId`, so the customer leg of
+     * `'operator-and-customer'` would be a no-op query rather than a leak —
+     * but state the audience explicitly anyway: the safety here is a property
+     * of today's shape, not of the broadcast call, and a later field would
+     * silently turn a no-op into a fan-out.
+     */
+    'campaigns',
     'customers',
     /**
      * A delivery created, or an event appended to its timeline. Operator-only —
@@ -72,10 +83,33 @@ export const SOCKET_ACTIONS = [
     'literals',
     'orders',
     'products',
+    /**
+     * A promotion created, updated or retired. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`. Carries no discount
+     * mechanics: `couponCode` links to the `Coupon` that holds them, so a
+     * customer-visible offer still reaches the storefront through its own
+     * surface rather than this operator frame.
+     */
+    'promotions',
+    /**
+     * A customer segment created, updated or deleted. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`, NEVER
+     * `'operator-and-customer'`: `SegmentCriteria` describes how customers are
+     * TARGETED, and broadcasting that to a customer socket would disclose the
+     * store's targeting rules to the people being targeted.
+     */
+    'segments',
     // BE → all store users when a return (devolución) commits. Distinct from
     // `orders` — carries the committed `Return` row itself (stock/account/credit-note
     // effects), not just the order's bumped `updatedAt`.
     'returns',
+    /**
+     * A message template created, updated or deleted. Operator-only —
+     * `wsPostStore(..., { audience: 'operator' })`. A template is authoring
+     * content, never a sent message: nothing here implies a customer received
+     * anything.
+     */
+    'templates',
     // BE → all store users on any service-order mutation. Operator-only by
     // construction: a `ServiceOrder` carries internal diagnosis notes, per-part
     // `unitCost`, work logs and technician ids, and `scrubForCustomer` strips

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sinfactura-types",
-  "version": "1.10.199",
+  "version": "1.10.201",
   "main": "dist/index.js",
   "type": "module",
   "types": "./dist/index.d.ts",