sinfactura-types 1.10.488 → 1.10.489

package/dist/cjs/socket.js

@@ -312,8 +312,9 @@ exports.SOCKET_ACTIONS = [
      */
     'presupuestos',
     /**
-     * A product row changed. Sent in TWO shapes, and a consumer must handle both
-     * — see {@link ProductStockFrameData}.
+     * A product row changed. Sent in TWO shapes to an operator and a THIRD to a
+     * shopper, and a consumer must handle each — see {@link ProductStockFrameData}
+     * and {@link ProductRemovedFrameData}.
      *
      * 1. **Full row** — the whole `Product`. Sent by the paths that create or
      *    re-state a row: `products/_post.ts` (create, edit, disable),
@@ -349,12 +350,25 @@ exports.SOCKET_ACTIONS = [
      * order create, edit, void, return and return-disposition paths, the web
      * cancel, `/inventory` movements, the purchase-order receipt and cycle-count
      * finalization reach customer sockets too (`wsPostStoreCustomers`, which
-     * suppresses a row by reading `hiddenFromStorefront` off the payload);
+     * replaces a hidden or disabled row with shape 3 by reading
+     * `hiddenFromStorefront` / `disabled` off the payload);
      * service-order parts and status, presupuesto conversion, MercadoLibre stock,
      * the price-list cascade and the product CSV import's announcement are
      * operator-only. A customer's copy is
      * `scrubForCustomer`'d, so `cost` is absent there — never rely on its
      * presence to tell the shapes apart.
+     *
+     * 3. **Removal marker** — {@link ProductRemovedFrameData}, SHOPPER-ONLY
+     *    (operators still see the two shapes above). When
+     *    either shape above carries a truthy `hiddenFromStorefront` or `disabled`,
+     *    `wsPostStoreCustomers` replaces it, per customer connection, with
+     *    `{ storeId, productId, removed: true, changed: 'removed' }` and nothing
+     *    else. Key on `data.removed === true` BEFORE treating a frame as a row or
+     *    a patch: drop the product from every cached list and mark its page
+     *    unavailable. It is emitted on EVERY write to a hidden or disabled
+     *    product, not only on the transition, so receiving it for a product the
+     *    client does not hold is normal and must be a no-op. An operator socket
+     *    never receives this shape.
      */
     'products',
     /**
@@ -636,9 +650,13 @@ exports.isSocketAction = isSocketAction;
  * it stand still across a whole day of sales; order by `lastMovementAt`, or do
  * not order these frames at all.
  *
- * ⚠️ Neither name is a DynamoDB reserved word, so the joined projection needs
- * no `ExpressionAttributeNames` alias. Adding one that IS reserved (`status`,
- * `size`, `name`, …) breaks every read at once — alias it at the join site.
+ * ⚠️ The api aliases `disabled` at the join site (`#disabled`) by convention —
+ * it is NOT on DynamoDB's reserved list (`DISABLE` is), but the alias costs
+ * nothing and keeps the join site the one place a name is aliased. A member
+ * that IS reserved (`status`, `size`, `name`, …) must be aliased there too, or
+ * it breaks every read at once. It is carried, like `hiddenFromStorefront`, so the shopper
+ * fan-out can turn a stock movement on a disabled product into a
+ * {@link ProductRemovedFrameData} marker instead of a priced patch.
  */
 exports.PRODUCT_STOCK_FRAME_FIELDS = [
     'stock',
@@ -646,6 +664,7 @@ exports.PRODUCT_STOCK_FRAME_FIELDS = [
     'cost',
     'currency',
     'hiddenFromStorefront',
+    'disabled',
     'updatedAt',
     'lastMovementAt',
 ];

package/dist/socket.d.ts

@@ -119,11 +119,15 @@ export interface SocketMessage<T = unknown> {
  * it stand still across a whole day of sales; order by `lastMovementAt`, or do
  * not order these frames at all.
  *
- * ⚠️ Neither name is a DynamoDB reserved word, so the joined projection needs
- * no `ExpressionAttributeNames` alias. Adding one that IS reserved (`status`,
- * `size`, `name`, …) breaks every read at once — alias it at the join site.
+ * ⚠️ The api aliases `disabled` at the join site (`#disabled`) by convention —
+ * it is NOT on DynamoDB's reserved list (`DISABLE` is), but the alias costs
+ * nothing and keeps the join site the one place a name is aliased. A member
+ * that IS reserved (`status`, `size`, `name`, …) must be aliased there too, or
+ * it breaks every read at once. It is carried, like `hiddenFromStorefront`, so the shopper
+ * fan-out can turn a stock movement on a disabled product into a
+ * {@link ProductRemovedFrameData} marker instead of a priced patch.
  */
-export declare const PRODUCT_STOCK_FRAME_FIELDS: readonly ["stock", "prices", "cost", "currency", "hiddenFromStorefront", "updatedAt", "lastMovementAt"];
+export declare const PRODUCT_STOCK_FRAME_FIELDS: readonly ["stock", "prices", "cost", "currency", "hiddenFromStorefront", "disabled", "updatedAt", "lastMovementAt"];
 /**
  * `data` of a **partial** `products` frame — the projection every stock-moving
  * write announces, and the only `products` shape that is not a whole `Product`.
@@ -139,6 +143,26 @@ export declare const PRODUCT_STOCK_FRAME_FIELDS: readonly ["stock", "prices", "c
  */
 export interface ProductStockFrameData extends Pick<Product, 'storeId' | 'productId'>, Partial<Pick<Product, (typeof PRODUCT_STOCK_FRAME_FIELDS)[number]>> {
 }
+/**
+ * `data` of a **removal** `products` frame — the only shape a shopper socket
+ * receives for a product that is hidden from the storefront or disabled.
+ *
+ * ⚠️ SHOPPER-ONLY, and deliberately carries nothing but identity: no name,
+ * price, pictures, stock or cost. A hidden or disabled product's DATA never
+ * reaches a shopper; only this marker does. Key on `removed === true` and drop
+ * the product from cached lists; mark its page unavailable. `changed` is the
+ * typed marker a client's frame router places the frame by.
+ *
+ * ⚠️ Sent on every write to such a product, not only the transition, so it is
+ * idempotent by design: a marker for a product the client never held is a
+ * no-op.
+ */
+export interface ProductRemovedFrameData {
+    storeId: string;
+    productId: string;
+    removed: true;
+    changed: 'removed';
+}
 /**
  * The `/logs` read mode a `log-delete` frame can refer to.
  *

package/dist/socket.js

@@ -309,8 +309,9 @@ export const SOCKET_ACTIONS = [
      */
     'presupuestos',
     /**
-     * A product row changed. Sent in TWO shapes, and a consumer must handle both
-     * — see {@link ProductStockFrameData}.
+     * A product row changed. Sent in TWO shapes to an operator and a THIRD to a
+     * shopper, and a consumer must handle each — see {@link ProductStockFrameData}
+     * and {@link ProductRemovedFrameData}.
      *
      * 1. **Full row** — the whole `Product`. Sent by the paths that create or
      *    re-state a row: `products/_post.ts` (create, edit, disable),
@@ -346,12 +347,25 @@ export const SOCKET_ACTIONS = [
      * order create, edit, void, return and return-disposition paths, the web
      * cancel, `/inventory` movements, the purchase-order receipt and cycle-count
      * finalization reach customer sockets too (`wsPostStoreCustomers`, which
-     * suppresses a row by reading `hiddenFromStorefront` off the payload);
+     * replaces a hidden or disabled row with shape 3 by reading
+     * `hiddenFromStorefront` / `disabled` off the payload);
      * service-order parts and status, presupuesto conversion, MercadoLibre stock,
      * the price-list cascade and the product CSV import's announcement are
      * operator-only. A customer's copy is
      * `scrubForCustomer`'d, so `cost` is absent there — never rely on its
      * presence to tell the shapes apart.
+     *
+     * 3. **Removal marker** — {@link ProductRemovedFrameData}, SHOPPER-ONLY
+     *    (operators still see the two shapes above). When
+     *    either shape above carries a truthy `hiddenFromStorefront` or `disabled`,
+     *    `wsPostStoreCustomers` replaces it, per customer connection, with
+     *    `{ storeId, productId, removed: true, changed: 'removed' }` and nothing
+     *    else. Key on `data.removed === true` BEFORE treating a frame as a row or
+     *    a patch: drop the product from every cached list and mark its page
+     *    unavailable. It is emitted on EVERY write to a hidden or disabled
+     *    product, not only on the transition, so receiving it for a product the
+     *    client does not hold is normal and must be a no-op. An operator socket
+     *    never receives this shape.
      */
     'products',
     /**
@@ -632,9 +646,13 @@ export const isSocketAction = (value) => typeof value === 'string' && SOCKET_ACT
  * it stand still across a whole day of sales; order by `lastMovementAt`, or do
  * not order these frames at all.
  *
- * ⚠️ Neither name is a DynamoDB reserved word, so the joined projection needs
- * no `ExpressionAttributeNames` alias. Adding one that IS reserved (`status`,
- * `size`, `name`, …) breaks every read at once — alias it at the join site.
+ * ⚠️ The api aliases `disabled` at the join site (`#disabled`) by convention —
+ * it is NOT on DynamoDB's reserved list (`DISABLE` is), but the alias costs
+ * nothing and keeps the join site the one place a name is aliased. A member
+ * that IS reserved (`status`, `size`, `name`, …) must be aliased there too, or
+ * it breaks every read at once. It is carried, like `hiddenFromStorefront`, so the shopper
+ * fan-out can turn a stock movement on a disabled product into a
+ * {@link ProductRemovedFrameData} marker instead of a priced patch.
  */
 export const PRODUCT_STOCK_FRAME_FIELDS = [
     'stock',
@@ -642,6 +660,7 @@ export const PRODUCT_STOCK_FRAME_FIELDS = [
     'cost',
     'currency',
     'hiddenFromStorefront',
+    'disabled',
     'updatedAt',
     'lastMovementAt',
 ];

package/package.json

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