@final-commerce/command-frame 0.8.0 → 0.9.0-staging.1

package/dist/index.js

@@ -28,6 +28,8 @@ import { updateCartItemQuantity } from './actions/update-cart-item-quantity/acti
 import { addProductNote } from './actions/add-product-note/action';
 import { addProductFee } from './actions/add-product-fee/action';
 import { getProductModifierSelections } from './actions/get-product-modifier-selections/action';
+import { getCompositePrice } from './actions/get-composite-price/action';
+import { getCompositeAvailability } from './actions/get-composite-availability/action';
 import { setProductModifierSelections } from './actions/set-product-modifier-selections/action';
 import { setActiveProductFee } from './actions/set-active-product-fee/action';
 import { setActiveProductDiscount } from './actions/set-active-product-discount/action';
@@ -174,6 +176,8 @@ export const command = {
     addProductNote,
     addProductFee,
     getProductModifierSelections,
+    getCompositePrice,
+    getCompositeAvailability,
     setProductModifierSelections,
     setActiveProductFee,
     setActiveProductDiscount,

package/dist/projects/render/mocks.js

@@ -13,6 +13,8 @@ import { mockRemoveOrderNote } from '../../actions/remove-order-note/mock';
 import { mockAddProductDiscount } from '../../actions/add-product-discount/mock';
 import { mockAddProductFee } from '../../actions/add-product-fee/mock';
 import { mockGetProductModifierSelections } from '../../actions/get-product-modifier-selections/mock';
+import { mockGetCompositePrice } from '../../actions/get-composite-price/mock';
+import { mockGetCompositeAvailability } from '../../actions/get-composite-availability/mock';
 import { mockSetProductModifierSelections } from '../../actions/set-product-modifier-selections/mock';
 import { mockRemoveProductDiscount } from '../../actions/remove-product-discount/mock';
 import { mockRemoveProductFee } from '../../actions/remove-product-fee/mock';
@@ -122,6 +124,8 @@ export const RENDER_MOCKS = {
     addProductDiscount: mockAddProductDiscount,
     addProductFee: mockAddProductFee,
     getProductModifierSelections: mockGetProductModifierSelections,
+    getCompositePrice: mockGetCompositePrice,
+    getCompositeAvailability: mockGetCompositeAvailability,
     setProductModifierSelections: mockSetProductModifierSelections,
     setActiveProductFee: mockSetActiveProductFee,
     setActiveProductDiscount: mockSetActiveProductDiscount,

package/dist/projects/render/types.d.ts

@@ -1,4 +1,4 @@
-import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, GetTimeClockStatus } from '../../index';
+import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, GetTimeClockStatus } from '../../index';
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
@@ -29,6 +29,8 @@ export interface RenderProviderActions {
     addProductNote: AddProductNote;
     addProductFee: AddProductFee;
     getProductModifierSelections: GetProductModifierSelections;
+    getCompositePrice: GetCompositePrice;
+    getCompositeAvailability: GetCompositeAvailability;
     setProductModifierSelections: SetProductModifierSelections;
     setActiveProductFee: SetActiveProductFee;
     setActiveProductDiscount: SetActiveProductDiscount;

package/dist/pubsub/topics/products/catalog-visibility-changed/types.d.ts

@@ -0,0 +1,17 @@
+import type { TopicEvent } from '../../../types';
+/**
+ * Payload for catalog-visibility-changed: a product was hidden or shown at an outlet. `getProducts` leaves hidden
+ * products out and a composite offers only items sold at the till's outlet — debounce, then re-ask `getProducts`.
+ */
+export interface CatalogVisibilityChangedPayload {
+    visibility: {
+        _id: string;
+        productId: string;
+        outletId: string;
+        isDeleted?: boolean;
+    };
+}
+/**
+ * Typed event for catalog-visibility-changed
+ */
+export type CatalogVisibilityChangedEvent = TopicEvent<CatalogVisibilityChangedPayload>;

package/dist/pubsub/topics/products/catalog-visibility-changed/types.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/topics/products/composite-changed/types.d.ts

@@ -0,0 +1,17 @@
+import type { TopicEvent } from '../../../types';
+/**
+ * Payload for composite-changed (FT-83): a part or item of a composite arrived. A save replaces all of a composite's
+ * parts and items at once (old rows come as `isDeleted: true`, new ones with new ids), so one save fires this many
+ * times — debounce, then re-ask `getProducts`; never patch `product.composite` from the row.
+ */
+export interface CompositeChangedPayload {
+    compositeRow: {
+        _id: string;
+        compositeProductId: string;
+        isDeleted?: boolean;
+    };
+}
+/**
+ * Typed event for composite-changed
+ */
+export type CompositeChangedEvent = TopicEvent<CompositeChangedPayload>;

package/dist/pubsub/topics/products/composite-changed/types.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/topics/products/index.d.ts

@@ -2,6 +2,6 @@
  * Products Topic Definition
  * Defines the products topic and its available event types
  */
-import type { TopicDefinition } from "../../types";
+import type { TopicDefinition } from '../../types';
 export declare const productsTopic: TopicDefinition;
-export * from "./types";
+export * from './types';

package/dist/pubsub/topics/products/index.js

@@ -3,31 +3,46 @@
  * Defines the products topic and its available event types
  */
 export const productsTopic = {
-    id: "products",
-    name: "Products",
-    description: "Topic for product-related events",
+    id: 'products',
+    name: 'Products',
+    description: 'Topic for product-related events',
     eventTypes: [
         {
-            id: "product-created",
-            name: "Product Created",
-            description: "Published when a new product is synced/created"
+            id: 'product-created',
+            name: 'Product Created',
+            description: 'Published when a new product is synced/created',
         },
         {
-            id: "product-updated",
-            name: "Product Updated",
-            description: "Published when a product is synced/updated"
+            id: 'product-updated',
+            name: 'Product Updated',
+            description: 'Published when a product is synced/updated',
         },
         {
-            id: "set-active-product",
-            name: "Set Active Product",
-            description: "Published when a product is set as the active product"
+            id: 'composite-changed',
+            name: 'Composite Changed',
+            description: "Published when a composite's part or item is synced; re-ask getProducts",
         },
         {
-            id: "get-active-product",
-            name: "Get Active Product",
-            description: "Published when a product is retrieved as the active product"
-        }
-    ]
+            id: 'catalog-visibility-changed',
+            name: 'Catalog Visibility Changed',
+            description: 'Published when a product is hidden or shown at an outlet; re-ask getProducts',
+        },
+        {
+            id: 'inventory-changed',
+            name: 'Inventory Changed',
+            description: "Published when a variant's stock at an outlet syncs; re-ask getProducts",
+        },
+        {
+            id: 'set-active-product',
+            name: 'Set Active Product',
+            description: 'Published when a product is set as the active product',
+        },
+        {
+            id: 'get-active-product',
+            name: 'Get Active Product',
+            description: 'Published when a product is retrieved as the active product',
+        },
+    ],
 };
 // Re-export types
-export * from "./types";
+export * from './types';

package/dist/pubsub/topics/products/inventory-changed/types.d.ts

@@ -0,0 +1,18 @@
+import type { TopicEvent } from '../../../types';
+/**
+ * Payload for inventory-changed (B35): a variant's stock at an outlet moved. A composite may turn Sold out or
+ * Unavailable by its components' shelves — debounce, then re-ask `getProducts`.
+ */
+export interface InventoryChangedPayload {
+    inventory: {
+        _id: string;
+        variantId: string;
+        outletId: string;
+        quantity?: number | null;
+        manageStock?: boolean;
+    };
+}
+/**
+ * Typed event for inventory-changed
+ */
+export type InventoryChangedEvent = TopicEvent<InventoryChangedPayload>;

package/dist/pubsub/topics/products/inventory-changed/types.js

@@ -0,0 +1 @@
+export {};

package/dist/pubsub/topics/products/types.d.ts

@@ -2,13 +2,19 @@
  * Products Topic Types
  * Aggregated types for all product-related events
  */
-export * from "./product-created/types";
-export * from "./product-updated/types";
-export * from "./product-set-active/types";
-export * from "./product-get-active/types";
-import type { ProductCreatedPayload } from "./product-created/types";
-import type { ProductUpdatedPayload } from "./product-updated/types";
-import type { ProductSetActivePayload } from "./product-set-active/types";
-import type { ProductGetActivePayload } from "./product-get-active/types";
-export type ProductsEventPayload = ProductCreatedPayload | ProductUpdatedPayload | ProductSetActivePayload | ProductGetActivePayload;
-export type ProductsEventType = "product-created" | "product-updated" | "set-active-product" | "get-active-product";
+export * from './product-created/types';
+export * from './product-updated/types';
+export * from './composite-changed/types';
+export * from './catalog-visibility-changed/types';
+export * from './inventory-changed/types';
+export * from './product-set-active/types';
+export * from './product-get-active/types';
+import type { ProductCreatedPayload } from './product-created/types';
+import type { ProductUpdatedPayload } from './product-updated/types';
+import type { CompositeChangedPayload } from './composite-changed/types';
+import type { CatalogVisibilityChangedPayload } from './catalog-visibility-changed/types';
+import type { InventoryChangedPayload } from './inventory-changed/types';
+import type { ProductSetActivePayload } from './product-set-active/types';
+import type { ProductGetActivePayload } from './product-get-active/types';
+export type ProductsEventPayload = ProductCreatedPayload | ProductUpdatedPayload | CompositeChangedPayload | CatalogVisibilityChangedPayload | InventoryChangedPayload | ProductSetActivePayload | ProductGetActivePayload;
+export type ProductsEventType = 'product-created' | 'product-updated' | 'composite-changed' | 'catalog-visibility-changed' | 'inventory-changed' | 'set-active-product' | 'get-active-product';

package/dist/pubsub/topics/products/types.js

@@ -3,7 +3,10 @@
  * Aggregated types for all product-related events
  */
 // Re-export all event types
-export * from "./product-created/types";
-export * from "./product-updated/types";
-export * from "./product-set-active/types";
-export * from "./product-get-active/types";
+export * from './product-created/types';
+export * from './product-updated/types';
+export * from './composite-changed/types';
+export * from './catalog-visibility-changed/types';
+export * from './inventory-changed/types';
+export * from './product-set-active/types';
+export * from './product-get-active/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.8.0",
+  "version": "0.9.0-staging.1",
   "description": "Commands Frame library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -57,7 +57,7 @@
     "ignoreBranchesMissingTickets": true
   },
   "dependencies": {
-    "@final-commerce/common": "2.4.0"
+    "@final-commerce/common": "2.5.0-staging.1"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.0.0",

package/dist/actions/get-refund-plan/mockRows.d.ts

@@ -1,6 +0,0 @@
-import type { CFActiveOrder } from '../../CommonTypes';
-import type { GetRefundPlanParams, RefundPlanBreakdown, RefundPlanRow } from './types';
-/** Every row of a demo order. The demo has no refund ledger, so everything is refundable. */
-export declare function mockRefundRows(order: CFActiveOrder): RefundPlanRow[];
-/** The selection's breakdown; no `items` means everything, like the demo's full-refund legs. */
-export declare function mockRefundBreakdown(rows: RefundPlanRow[], items?: GetRefundPlanParams['items']): RefundPlanBreakdown;

package/dist/actions/get-refund-plan/mockRows.js

@@ -1,114 +0,0 @@
-// Demo derivation of `getRefundPlan`'s `rows` and `allocation.breakdown`, for
-// local/standalone mode only. See the note on `mockGetRefundPlan`.
-const minor = (v) => Math.round(Number(v ?? 0)) || 0;
-/** A line's whole-quantity money, reading `total` as tax-inclusive (the engine's reading). */
-function lineAmounts(line) {
-    const tax = minor(line.totalTax);
-    const itemDiscount = (line.discount?.itemDiscounts ?? []).reduce((s, d) => s + minor(d.amount), 0);
-    const cartDiscount = minor(line.discount?.cartDiscount?.amount);
-    const net = Math.max(0, minor(line.total) - tax);
-    const taxes = (line.taxes ?? []).map((t) => ({
-        name: String(t.name ?? 'Tax'),
-        percentage: t.percentage,
-        amount: minor(t.amount),
-    }));
-    return { subtotal: net + itemDiscount + cartDiscount, itemDiscount, cartDiscount, tax, taxes, total: net + tax };
-}
-function scale(a, share) {
-    if (share >= 1)
-        return a;
-    const r = (n) => Math.round(n * share);
-    const out = {
-        subtotal: r(a.subtotal),
-        itemDiscount: r(a.itemDiscount),
-        cartDiscount: r(a.cartDiscount),
-        tax: r(a.tax),
-        taxes: a.taxes.map((t) => ({ ...t, amount: r(t.amount) })),
-    };
-    return { ...out, total: out.subtotal - out.itemDiscount - out.cartDiscount + out.tax };
-}
-/** Every row of a demo order. The demo has no refund ledger, so everything is refundable. */
-export function mockRefundRows(order) {
-    const rows = [];
-    for (const li of order.lineItems ?? []) {
-        const itemKey = String(li.internalId || li.variantId || '');
-        if (!itemKey || !(li.quantity > 0))
-            continue;
-        rows.push({
-            type: 'product',
-            itemKey,
-            label: String(li.name ?? 'Item'),
-            ...(li.sku ? { sku: li.sku } : {}),
-            ...(li.attributes ? { attributes: li.attributes } : {}),
-            quantity: li.quantity,
-            refundableQuantity: li.quantity,
-            amounts: lineAmounts(li),
-        });
-    }
-    for (const cs of order.customSales ?? []) {
-        if (!cs.customSaleId || !(cs.quantity > 0))
-            continue;
-        rows.push({
-            type: 'customSale',
-            itemKey: cs.customSaleId,
-            label: String(cs.name ?? 'Custom sale'),
-            quantity: cs.quantity,
-            refundableQuantity: cs.quantity,
-            amounts: lineAmounts(cs),
-        });
-    }
-    for (const fee of order.cartFees ?? []) {
-        const amount = minor(fee.amount);
-        const tax = minor(fee.tax);
-        rows.push({
-            type: 'fee',
-            itemKey: String(fee.id),
-            label: String(fee.label || 'Cart fee'),
-            quantity: 1,
-            refundableQuantity: 1,
-            amounts: { subtotal: amount, itemDiscount: 0, cartDiscount: 0, tax, taxes: [], total: amount + tax },
-        });
-    }
-    for (const pm of order.paymentMethods ?? []) {
-        const tip = minor(pm.tip?.amount);
-        if (tip <= 0)
-            continue;
-        rows.push({
-            type: 'tip',
-            itemKey: pm.transactionId,
-            label: 'Tip',
-            paymentType: pm.paymentType,
-            quantity: 1,
-            refundableQuantity: 1,
-            amounts: { subtotal: tip, itemDiscount: 0, cartDiscount: 0, tax: 0, taxes: [], total: tip },
-        });
-    }
-    return rows;
-}
-/** The selection's breakdown; no `items` means everything, like the demo's full-refund legs. */
-export function mockRefundBreakdown(rows, items) {
-    const picked = new Map((items ?? []).map((i) => [i.itemKey, i.quantity]));
-    const selected = rows
-        .map((row) => {
-        const quantity = items?.length
-            ? Math.min(picked.get(row.itemKey) ?? 0, row.refundableQuantity)
-            : row.refundableQuantity;
-        return { type: row.type, itemKey: row.itemKey, quantity, amounts: scale(row.amounts, quantity / row.quantity) };
-    })
-        .filter((r) => r.quantity > 0);
-    const totals = { items: 0, discounts: 0, fees: 0, tax: 0, tip: 0, total: 0 };
-    for (const r of selected) {
-        const a = r.amounts;
-        if (r.type === 'fee')
-            totals.fees += a.subtotal;
-        else if (r.type === 'tip')
-            totals.tip += a.subtotal;
-        else {
-            totals.items += a.subtotal;
-            totals.discounts += a.itemDiscount + a.cartDiscount;
-        }
-        totals.tax += a.tax;
-        totals.total += a.total;
-    }
-    return { rows: selected, totals };
-}