@final-commerce/command-frame 0.6.0-staging3.4 → 0.6.0-staging3.5

package/dist/CommonTypes.d.ts

@@ -1,5 +1,5 @@
 export * from './common-types';
-import type { Tax, Tip, Address, MetadataItem, PosDataItem, CartFeeTaxEntry, CartFeeItem, CartDiscountItem, OrderNote, NonRevenueItem, DiscountDetail, FeeDetail, DiscountLineItem, FeeLineItem, LineItem, TipPayment, RefundedTipPayment, PaymentMethod, Discount, CustomFee, Summary, CustomSale, RefundedCustomSale, RefundItem, RefundedLineItem, ActiveStation, ActiveSession, ActiveOutlet, ActiveUser, ActiveUserRole, ActiveOrder, ActiveCart, ActivePark, ActiveCompany, ActiveCustomSales, ActiveProduct, ActiveCustomer, FullProduct, ProductVariant, Inventory, ResolvedModifier, ResolvedModifierChoice, ModifierSelectionType, ModifierSelection, ModifierChoiceSelection, CartLineModifier, OrderLineItemModifier, CustomerNote, Attribute, AttributeOption, Category, Transaction, ActiveSplitPayment } from '@final-commerce/common/pos-types';
+import type { Tax, Tip, Address, MetadataItem, PosDataItem, CartFeeTaxEntry, CartFeeItem, CartDiscountItem, OrderNote, NonRevenueItem, DiscountDetail, FeeDetail, DiscountLineItem, FeeLineItem, LineItem, TipPayment, RefundedTipPayment, PaymentMethod, Discount, CustomFee, Summary, CustomSale, RefundedCustomSale, RefundItem, RefundedLineItem, ActiveStation, ActiveSession, ActiveOutlet, ActiveUser, ActiveUserRole, ActiveOrder, ActiveCart, ActivePark, ActiveCompany, ActiveCustomSales, ActiveProduct, ActiveCustomer, FullProduct, ProductVariant, Inventory, ResolvedModifier, ResolvedModifierChoice, ModifierSelectionType, ModifierSelection, ModifierChoiceSelection, CartLineModifier, ProdModifierBreakdown, OrderLineItemModifier, CustomerNote, Attribute, AttributeOption, Category, Transaction, ActiveSplitPayment } from '@final-commerce/common/pos-types';
 export { CurrencyCode, ProductType as CFProductType, UserTypes as CFUserTypes } from '@final-commerce/common';
 /** Open record used as a base for active entities. */
 export type CFActiveEntity = Record<string, unknown>;
@@ -29,6 +29,8 @@ export type CFModifierSelection = ModifierSelection;
 export type CFModifierChoiceSelection = ModifierChoiceSelection;
 /** One selected choice PRICED onto a cart line — `CFActiveProduct.modifiers` (not the resolved stack). */
 export type CFCartLineModifier = CartLineModifier;
+/** A priced, line-extended modifier row: "Toppings - Avocado" x2, `amount` 1000. */
+export type CFProdModifierBreakdown = ProdModifierBreakdown;
 export type CFActiveProduct = ActiveProduct;
 export type CFCustomer = ActiveCustomer;
 export type CFActiveCustomer = ActiveCustomer;

package/dist/actions/add-product-to-cart/mock.js

@@ -1,4 +1,4 @@
-import { MOCK_CART, MOCK_PRODUCTS, buildCartLineModifiers, mockPublishEvent } from '../../demo/database';
+import { MOCK_CART, MOCK_PRODUCTS, buildCartLineModifiers, buildModifierRows, mockPublishEvent, } from '../../demo/database';
 import { extendPrice, isValidQuantity, resolveUnit } from '@final-commerce/common';
 export const mockAddProductToCart = async (params) => {
     console.log('[Mock] addProductToCart called', params);
@@ -76,6 +76,9 @@ export const mockAddProductToCart = async (params) => {
     MOCK_CART.remainingBalance = MOCK_CART.total;
     // Publish cart event to simulate real behavior
     mockPublishEvent('cart', 'product-added', { product: activeProduct });
+    // Display-ready modifier rows for the line that was just created, so a flow can
+    // show what the modifiers added without re-reading the cart or multiplying.
+    const { rows, modifiersTotal } = buildModifierRows(activeProduct.modifiers, quantity);
     return {
         success: true,
         productId: activeProduct.id,
@@ -83,6 +86,8 @@ export const mockAddProductToCart = async (params) => {
         internalId: activeProduct.internalId,
         name: activeProduct.name,
         quantity: quantity,
+        rows,
+        modifiersTotal,
         timestamp: new Date().toISOString(),
     };
 };

package/dist/actions/add-product-to-cart/types.d.ts

@@ -1,11 +1,7 @@
 import type { AddProductDiscountParams } from '../add-product-discount/types';
 import type { AddProductFeeParams } from '../add-product-fee/types';
 import type { ModifierSelection } from '../get-product-modifier-selections/types';
-/**
- * One modifier answer passed at ring-time. Same shape as the
- * get-product-modifier-selections `ModifierSelection` (single source of truth).
- */
-export type AddProductToCartModifierParams = ModifierSelection;
+import type { CFProdModifierBreakdown } from '../../CommonTypes';
 export interface AddProductToCartParams {
     /** ID of the variant to add. */
     variantId: string;
@@ -28,7 +24,7 @@ export interface AddProductToCartParams {
     /** Array of fees to apply immediately. */
     fees?: AddProductFeeParams[];
     /** Modifier selections to apply immediately. */
-    modifiers?: AddProductToCartModifierParams[];
+    modifiers?: ModifierSelection[];
     /** Note or array of notes to add immediately. */
     notes?: string | string[];
 }
@@ -42,6 +38,10 @@ export interface AddProductToCartResponse {
     internalId: string;
     name: string;
     quantity: number;
+    /** The modifiers the line was created with, display-ready. Empty when there are none. */
+    rows: CFProdModifierBreakdown[];
+    /** Sum of `rows[].amount` — what the modifiers added to this line, in minor units. */
+    modifiersTotal: number;
     timestamp: string;
 }
 export type AddProductToCart = (params?: AddProductToCartParams) => Promise<AddProductToCartResponse>;

package/dist/actions/get-product-modifier-selections/mock.js

@@ -1,4 +1,4 @@
-import { MOCK_CART } from "../../demo/database";
+import { MOCK_CART, buildModifierRows } from "../../demo/database";
 export const mockGetProductModifierSelections = async (params) => {
     console.log("[Mock] getProductModifierSelections called", params);
     // Read the line's stored selections from the mock cart (last line when no internalId).
@@ -11,13 +11,20 @@ export const mockGetProductModifierSelections = async (params) => {
             reason: "No matching cart line",
             internalId: params?.internalId,
             selections: [],
+            rows: [],
+            modifiersTotal: 0,
             timestamp: new Date().toISOString()
         };
     }
+    // The priced rows already sit on the line; extending them by the line quantity is
+    // the host's job, not the flow's.
+    const { rows, modifiersTotal } = buildModifierRows(line.modifiers, line.quantity);
     return {
         success: true,
         internalId: line.internalId,
         selections: line.modifierSelections ?? [],
+        rows,
+        modifiersTotal,
         timestamp: new Date().toISOString()
     };
 };

package/dist/actions/get-product-modifier-selections/types.d.ts

@@ -1,13 +1,8 @@
-/** One chosen choice: `quantity` is units PER LINE-ITEM UNIT (1 unless the control is a stepper). */
-export interface ModifierChoiceSelection {
-    choiceId: string;
-    quantity: number;
-}
-/** The cashier's answer to one modifier. */
-export interface ModifierSelection {
-    modifierId: string;
-    choices: ModifierChoiceSelection[];
-}
+import type { CFModifierSelection, CFModifierChoiceSelection, CFProdModifierBreakdown } from "../../CommonTypes";
+/** Alias of common's — `quantity` is units PER LINE-ITEM UNIT. */
+export type ModifierChoiceSelection = CFModifierChoiceSelection;
+/** Alias of common's — the cashier's answer to one modifier. */
+export type ModifierSelection = CFModifierSelection;
 export interface GetProductModifierSelectionsParams {
     /** The cart line to read. Defaults to the active product's line. */
     internalId?: string;
@@ -17,14 +12,12 @@ export interface GetProductModifierSelectionsResponse {
     /** Set when the read failed (e.g. no such line, no active product). */
     reason?: string;
     internalId?: string;
-    /**
-     * The line's current modifier selections. Supplied at creation via
-     * `addProductToCart({ modifiers })`; edit them with
-     * `setProductModifierSelections` (full replacement, re-validated).
-     * Modifier DEFINITIONS remain read-only — they flow one-way from
-     * station-sync into the till.
-     */
+    /** Raw ids — round-trips back into the setter. No names, no money: use `rows` to display. */
     selections: ModifierSelection[];
+    /** Display-ready: "Toppings - Avocado" x2, `amount` 1000. One row per chosen choice. */
+    rows: CFProdModifierBreakdown[];
+    /** Sum of `rows[].amount` for THIS line, in minor units. */
+    modifiersTotal: number;
     timestamp: string;
 }
 export type GetProductModifierSelections = (params?: GetProductModifierSelectionsParams) => Promise<GetProductModifierSelectionsResponse>;

package/dist/actions/get-product-modifier-selections/types.js

@@ -1,2 +1 @@
-// Get Product Modifier Selections Types
 export {};

package/dist/actions/set-product-modifier-selections/mock.js

@@ -1,4 +1,4 @@
-import { MOCK_CART, MOCK_PRODUCTS, buildCartLineModifiers } from "../../demo/database";
+import { MOCK_CART, MOCK_PRODUCTS, buildCartLineModifiers, buildModifierRows } from "../../demo/database";
 export const mockSetProductModifierSelections = async (params) => {
     console.log("[Mock] setProductModifierSelections called", params);
     if (!params?.selections) {
@@ -7,6 +7,8 @@ export const mockSetProductModifierSelections = async (params) => {
             reason: "selections is required (pass [] to clear)",
             internalId: params?.internalId,
             selections: [],
+            rows: [],
+            modifiersTotal: 0,
             timestamp: new Date().toISOString()
         };
     }
@@ -23,6 +25,8 @@ export const mockSetProductModifierSelections = async (params) => {
             reason: "No matching cart line",
             internalId: params.internalId,
             selections: [],
+            rows: [],
+            modifiersTotal: 0,
             timestamp: new Date().toISOString()
         };
     }
@@ -33,10 +37,13 @@ export const mockSetProductModifierSelections = async (params) => {
     const source = MOCK_PRODUCTS.find((product) => product._id === line.id);
     line.modifierSelections = params.selections;
     line.modifiers = buildCartLineModifiers(source?.modifiers, params.selections, source?.taxTable);
+    const { rows, modifiersTotal } = buildModifierRows(line.modifiers, line.quantity);
     return {
         success: true,
         internalId: line.internalId,
         selections: params.selections,
+        rows,
+        modifiersTotal,
         timestamp: new Date().toISOString()
     };
 };

package/dist/actions/set-product-modifier-selections/types.d.ts

@@ -1,4 +1,5 @@
 import type { ModifierSelection } from "../get-product-modifier-selections/types";
+import type { CFProdModifierBreakdown } from "../../CommonTypes";
 export interface SetProductModifierSelectionsParams {
     /** The cart line to edit. Defaults to the active product's line. */
     internalId?: string;
@@ -17,6 +18,10 @@ export interface SetProductModifierSelectionsResponse {
     internalId?: string;
     /** The selections now on the line (the new ones on success, the old ones on rejection). */
     selections: ModifierSelection[];
+    /** Display-ready — repaint from this instead of re-reading after an edit. */
+    rows: CFProdModifierBreakdown[];
+    /** Sum of `rows[].amount` for THIS line, in minor units. */
+    modifiersTotal: number;
     timestamp: string;
 }
 export type SetProductModifierSelections = (params?: SetProductModifierSelectionsParams) => Promise<SetProductModifierSelectionsResponse>;

package/dist/demo/database.d.ts

@@ -2,7 +2,7 @@
  * Mock Database for Standalone/Demo Mode
  * Stores mock data that mimics the Render environment
  */
-import { CFActiveCompany, CFActiveUser, CFActiveStation, CFActiveOutlet, CFActiveOrder, CFCustomer, CFProduct, CFActiveCart, CFCategory, CFActiveProduct, CFSession, CFActiveRefundDetails, CFSmartGridLayout, CFCartLineModifier, CFModifierSelection, CFResolvedModifier } from '../CommonTypes';
+import { CFActiveCompany, CFActiveUser, CFActiveStation, CFActiveOutlet, CFActiveOrder, CFCustomer, CFProduct, CFActiveCart, CFCategory, CFActiveProduct, CFSession, CFActiveRefundDetails, CFSmartGridLayout, CFCartLineModifier, CFProdModifierBreakdown, CFModifierSelection, CFResolvedModifier } from '../CommonTypes';
 export * from './mocks';
 /** Replace mock catalog / context data in place (same array references mock handlers use). */
 export interface MockDatabaseConfig {
@@ -104,4 +104,9 @@ export declare const applyMockPayment: (amount: number, paymentType: string, pro
  * rewrites an open cart. No `total`: a cart row is per line UNIT, and the host extends it.
  * Rule validation (required/min/max) is deliberately not mocked; the real host owns it.
  */
+/** Extend a line's priced modifier rows by the line quantity. Mirrors kaching's `buildProdModifiers`. */
+export declare const buildModifierRows: (modifiers: CFCartLineModifier[] | undefined, lineQuantity: number | undefined) => {
+    rows: CFProdModifierBreakdown[];
+    modifiersTotal: number;
+};
 export declare const buildCartLineModifiers: (menu: CFResolvedModifier[] | undefined, selections: CFModifierSelection[] | undefined, productTaxTableId?: string) => CFCartLineModifier[];

package/dist/demo/database.js

@@ -931,6 +931,26 @@ export const applyMockPayment = (amount, paymentType, processor = 'cash') => {
  * rewrites an open cart. No `total`: a cart row is per line UNIT, and the host extends it.
  * Rule validation (required/min/max) is deliberately not mocked; the real host owns it.
  */
+/** Extend a line's priced modifier rows by the line quantity. Mirrors kaching's `buildProdModifiers`. */
+export const buildModifierRows = (modifiers, lineQuantity) => {
+    const quantity = lineQuantity ?? 1;
+    const rows = (modifiers ?? []).map((modifier) => ({
+        modifierId: modifier.modifierId,
+        modifierName: modifier.modifierName,
+        choiceId: modifier.choiceId,
+        choiceName: modifier.choiceName,
+        label: modifier.label ?? `${modifier.modifierName} - ${modifier.choiceName}`,
+        unitPrice: modifier.unitPrice,
+        quantity: modifier.quantity,
+        // extendPrice, not a raw multiply: a fractional line quantity (1.5 kg) must not
+        // leave fractional minor units on the row.
+        amount: extendPrice(modifier.unitPrice * modifier.quantity, quantity),
+        tax: 0,
+        ...(modifier.taxTableId ? { taxTableId: modifier.taxTableId } : {}),
+        ...(modifier.taxRateId ? { taxRateId: modifier.taxRateId } : {})
+    }));
+    return { rows, modifiersTotal: rows.reduce((sum, row) => sum + row.amount, 0) };
+};
 export const buildCartLineModifiers = (menu, selections, productTaxTableId) => {
     if (!menu?.length || !selections?.length)
         return [];

package/dist/index.d.ts

@@ -151,7 +151,7 @@ export type { CheckPermission, CheckPermissionParams, CheckPermissionResponse }
 export type { InitiateRefund, InitiateRefundParams, InitiateRefundResponse } from './actions/initiate-refund/types';
 export type { GetCurrentCart, GetCurrentCartResponse } from './actions/get-current-cart/types';
 export type { AddProductDiscount, AddProductDiscountParams, AddProductDiscountResponse, } from './actions/add-product-discount/types';
-export type { AddProductToCart, AddProductToCartParams, AddProductToCartModifierParams, AddProductToCartResponse, } from './actions/add-product-to-cart/types';
+export type { AddProductToCart, AddProductToCartParams, AddProductToCartResponse, } from './actions/add-product-to-cart/types';
 export type { RemoveProductFromCart, RemoveProductFromCartParams, RemoveProductFromCartResponse, } from './actions/remove-product-from-cart/types';
 export type { UpdateCartItemQuantity, UpdateCartItemQuantityParams, UpdateCartItemQuantityResponse, } from './actions/update-cart-item-quantity/types';
 export type { AddCartDiscount, AddCartDiscountParams, AddCartDiscountResponse, } from './actions/add-cart-discount/types';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.6.0-staging3.4",
+  "version": "0.6.0-staging3.5",
   "description": "Commands Frame library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",