@final-commerce/command-frame 0.8.1-online.1 → 0.9.0-online.1

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

@@ -2,14 +2,6 @@ import { MOCK_CART, MOCK_PRODUCTS, mockPublishEvent } from '../../demo/database'
 import { mockHoldBooking } from '../hold-booking/mock';
 export const mockAddBookingToCart = async (params) => {
     console.log('[Mock] addBookingToCart called', params);
-    // One call, two effects — the window is claimed AND the service is in the cart. The claim goes
-    // first and its refusal propagates: a cart line for a window somebody else took is worse than
-    // no line at all.
-    const held = await mockHoldBooking(params);
-    if (!held.success || !held.booking) {
-        return { success: false, reason: held.reason, timestamp: new Date().toISOString() };
-    }
-    const booking = held.booking;
     // An unknown product used to be sold as "Booking" at zero. The host refuses it, and a mock that
     // quietly sells something no catalogue contains teaches a screen a case that cannot happen.
     const product = MOCK_PRODUCTS.find(({ _id }) => _id === params.productId);
@@ -27,6 +19,18 @@ export const mockAddBookingToCart = async (params) => {
             timestamp: new Date().toISOString(),
         };
     }
+    // Same refusal and text as the host (kaching add-booking-to-cart).
+    if (product.notSoldInPos || variant?.notSoldInPos) {
+        return { success: false, reason: `${product.name} is not sold in POS`, timestamp: new Date().toISOString() };
+    }
+    // One call, two effects — the window is claimed AND the service is in the cart. Like the host, the
+    // claim comes after the product checks and before the line; its refusal propagates: a cart line for
+    // a window somebody else took is worse than no line at all.
+    const held = await mockHoldBooking(params);
+    if (!held.success || !held.booking) {
+        return { success: false, reason: held.reason, timestamp: new Date().toISOString() };
+    }
+    const booking = held.booking;
     const price = variant?.price ?? product.minPrice ?? 0;
     const reservation = {
         internalId: `res_${booking.id}`,

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

@@ -21,6 +21,10 @@ export const mockAddProductToCart = async (params) => {
             }
         }
     }
+    // Same refusal and text as the host (kaching add-product-to-cart).
+    if (product.notSoldInPos || variant.notSoldInPos) {
+        throw new Error(`${product.name} is not sold in POS`);
+    }
     // A measured variant carries a resolved unit; the host does the same. What the unit can
     // express is its precision — 1.5 of a kilogram is a sale, 1.5 of a piece is a typo.
     const unit = variant.unitId ? resolveUnit(variant.unitId) : undefined;

package/dist/actions/adjust-inventory/mock.js

@@ -1,6 +1,26 @@
 import { MOCK_PRODUCTS } from '../../demo/database';
+// Same rules and messages as the kaching handler.
+const STOCK_TYPE_BY_REASON = {
+    STOCK_RECEIVED: 'add',
+    RESTOCK_RETURN: 'add',
+    DAMAGE: 'subtract',
+    THEFT: 'subtract',
+    LOSS: 'subtract',
+    INVENTORY_RECOUNT: 'set',
+};
 export const mockAdjustInventory = async (params) => {
     console.log('[Mock] adjustInventory called', params);
+    if (params?.specificAction != null) {
+        const { specificAction, stockType, customActionId } = params;
+        if (customActionId)
+            throw new Error('Pass either customActionId or specificAction, not both');
+        const reasonStockType = STOCK_TYPE_BY_REASON[specificAction];
+        if (!reasonStockType)
+            throw new Error(`Unknown specificAction: ${specificAction}`);
+        if (reasonStockType !== stockType) {
+            throw new Error(`specificAction ${specificAction} requires stockType '${reasonStockType}', got '${stockType}'`);
+        }
+    }
     let newStock = 0;
     // Real handler keys off variantId (falling back to the active product's
     // variant); mirror that here by finding the owning product for the variant.

package/dist/actions/adjust-inventory/types.d.ts

@@ -1,3 +1,5 @@
+/** The manual reasons a person can pick, as hub-api's InventorySpecificActionType names them. */
+export type ManualStockReason = 'STOCK_RECEIVED' | 'RESTOCK_RETURN' | 'DAMAGE' | 'THEFT' | 'LOSS' | 'INVENTORY_RECOUNT';
 export interface AdjustInventoryParams {
     /** String to preserve precision. */
     amount: string;
@@ -5,6 +7,17 @@ export interface AdjustInventoryParams {
     stockType: 'add' | 'subtract' | 'set';
     /** Variant to adjust. Omit to use the active product's selected variant. */
     variantId?: string;
+    /**
+     * A company action from getCustomStockActions. The movement is recorded under its name;
+     * `stockType` must match its baseAction (ADD → 'add', REMOVE → 'subtract', RECOUNT → 'set').
+     */
+    customActionId?: string;
+    /**
+     * A built-in reason to record instead of the host's default for `stockType`. Must match it:
+     * STOCK_RECEIVED / RESTOCK_RETURN → 'add', DAMAGE / THEFT / LOSS → 'subtract', INVENTORY_RECOUNT → 'set'.
+     * Rejected together with `customActionId`.
+     */
+    specificAction?: ManualStockReason;
 }
 export interface AdjustInventoryResponse {
     success: boolean;

package/dist/actions/adjust-inventory/types.js

@@ -1 +1,2 @@
+// Adjust Inventory Types
 export {};

package/dist/actions/get-custom-stock-actions/action.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get custom stock actions action — the company's own stock adjustment actions.
+ */
+import type { GetCustomStockActions } from './types';
+export declare const getCustomStockActions: GetCustomStockActions;

package/dist/actions/get-custom-stock-actions/action.js

@@ -0,0 +1,7 @@
+/**
+ * Get custom stock actions action — the company's own stock adjustment actions.
+ */
+import { commandFrameClient } from '../../client';
+export const getCustomStockActions = async () => {
+    return await commandFrameClient.call('getCustomStockActions');
+};

package/dist/actions/get-custom-stock-actions/mock.d.ts

@@ -0,0 +1,2 @@
+import { GetCustomStockActions } from './types';
+export declare const mockGetCustomStockActions: GetCustomStockActions;

package/dist/actions/get-custom-stock-actions/mock.js

@@ -0,0 +1,11 @@
+export const mockGetCustomStockActions = async () => {
+    console.log('[Mock] getCustomStockActions called');
+    return {
+        customStockActions: [
+            { _id: 'mock_custom_action_1', name: 'Opening stock', baseAction: 'ADD' },
+            { _id: 'mock_custom_action_2', name: 'Exhibition loan', baseAction: 'REMOVE' },
+            { _id: 'mock_custom_action_3', name: 'Year-end count', baseAction: 'RECOUNT' },
+        ],
+        timestamp: new Date().toISOString(),
+    };
+};

package/dist/actions/get-custom-stock-actions/types.d.ts

@@ -0,0 +1,12 @@
+export interface CustomStockActionPayload {
+    _id: string;
+    /** Name the company gave the action, shown in pickers and stock history. */
+    name: string;
+    /** What the action does to stock — pass the matching `stockType` to adjustInventory. */
+    baseAction: 'ADD' | 'REMOVE' | 'RECOUNT';
+}
+export interface GetCustomStockActionsResponse {
+    customStockActions: CustomStockActionPayload[];
+    timestamp: string;
+}
+export type GetCustomStockActions = () => Promise<GetCustomStockActionsResponse>;

package/dist/actions/get-custom-stock-actions/types.js

@@ -0,0 +1,2 @@
+// Get Custom Stock Actions Types
+export {};

package/dist/actions/get-products/mock.js

@@ -11,6 +11,19 @@ export const mockGetProducts = async (params) => {
     if (!JSON.stringify(query).includes('productType')) {
         products = products.filter((p) => p.productType !== 'booking');
     }
+    // Same as the host: `true` = flagged, `false` = not flagged (missing counts).
+    for (const flag of ['notSoldInPos', 'notSoldOnline']) {
+        if (typeof query[flag] === 'boolean')
+            products = products.filter((p) => !!p[flag] === query[flag]);
+    }
+    if (!params?.includeUnlisted) {
+        // Same as the host: flagged variants are stripped, a product left with none is dropped.
+        if (query.notSoldInPos === undefined)
+            products = products.filter((p) => !p.notSoldInPos);
+        products = products
+            .filter((p) => !p.variants.length || p.variants.some((v) => !v.notSoldInPos))
+            .map((p) => ({ ...p, variants: p.variants.filter((v) => !v.notSoldInPos) }));
+    }
     if (query.searchValue) {
         const search = String(query.searchValue).toLowerCase();
         products = products.filter((p) => p.name.toLowerCase().includes(search) || p.sku?.toLowerCase().includes(search));

package/dist/actions/get-products/types.d.ts

@@ -42,8 +42,24 @@ export interface GetProductsParams {
         };
         supplier?: string;
         externalId?: string;
+        /**
+         * Product-level flag filter. `true` = only products flagged `notSoldInPos`; `false` = only
+         * products NOT flagged (a missing field counts as not flagged). On a till, naming it switches off
+         * the default exclusion, so `true` works without `includeUnlisted`.
+         */
+        notSoldInPos?: boolean;
+        /** Product-level flag filter: `true` = flagged `notSoldOnline`; `false` = sold online (missing counts). On a storefront, naming it switches off the default exclusion. */
+        notSoldOnline?: boolean;
         [key: string]: any;
     };
+    /**
+     * The sales-channel flag follows the host channel: `notSoldInPos` on a till, `notSoldOnline` on a
+     * storefront. Products with that flag are left out unless this is `true` (default `false`) or the
+     * query names that flag. They still cannot be sold: `addProductToCart` / `addBookingToCart` refuse a
+     * product or a variant with it. Without it, flagged variants are also stripped from `variants[]`
+     * and a product whose every variant is flagged is left out — whatever the query says.
+     */
+    includeUnlisted?: boolean;
     /** Defaults to 0. */
     offset?: number;
     /** Defaults to 100. */

package/dist/actions/resume-parked-order/mock.d.ts

@@ -1,2 +1,2 @@
-import { ResumeParkedOrder } from "./types";
+import { ResumeParkedOrder } from './types';
 export declare const mockResumeParkedOrder: ResumeParkedOrder;

package/dist/actions/resume-parked-order/mock.js

@@ -1,11 +1,11 @@
-import { MOCK_PARKED_ORDERS, MOCK_CART, resetMockCart, mockPublishEvent } from "../../demo/database";
+import { MOCK_PARKED_ORDERS, MOCK_CART, MOCK_PRODUCTS, resetMockCart, mockPublishEvent } from '../../demo/database';
 export const mockResumeParkedOrder = async (params) => {
-    console.log("[Mock] resumeParkedOrder called", params);
+    console.log('[Mock] resumeParkedOrder called', params);
     const orderId = params?.orderId;
     let orderToResume = null;
     let index = -1;
     if (orderId) {
-        index = MOCK_PARKED_ORDERS.findIndex(o => o._id === orderId);
+        index = MOCK_PARKED_ORDERS.findIndex((o) => o._id === orderId);
         if (index !== -1)
             orderToResume = MOCK_PARKED_ORDERS[index];
     }
@@ -17,8 +17,14 @@ export const mockResumeParkedOrder = async (params) => {
         }
     }
     if (!orderToResume) {
-        throw new Error("Parked order not found");
+        throw new Error('Parked order not found');
     }
+    // Same refusal and text as the host, before anything is restored: the parked order stays.
+    const notSoldNames = orderToResume.lineItems
+        .filter((li) => MOCK_PRODUCTS.some((p) => p.variants.some((v) => v._id === li.variantId && (p.notSoldInPos || v.notSoldInPos))))
+        .map((li) => li.name);
+    if (notSoldNames.length)
+        throw new Error(`${notSoldNames.join(', ')} is not sold in POS`);
     // Restore to MOCK_CART
     // Logic to convert Order back to Cart (simplified)
     resetMockCart();
@@ -26,7 +32,7 @@ export const mockResumeParkedOrder = async (params) => {
     MOCK_CART.customer = orderToResume.customer; // Cast if needed
     // MOCK_CART.products = orderToResume.lineItems... (Mapping needed)
     // For Mock demo, we'll do a best effort mapping
-    MOCK_CART.products = orderToResume.lineItems.map(li => ({
+    MOCK_CART.products = orderToResume.lineItems.map((li) => ({
         id: li.productId,
         name: li.name,
         quantity: li.quantity,
@@ -36,8 +42,8 @@ export const mockResumeParkedOrder = async (params) => {
         sku: li.sku,
         images: [li.image],
         stock: 100,
-        taxTableId: "",
-        attributes: li.attributes
+        taxTableId: '',
+        attributes: li.attributes,
     }));
     MOCK_CART.subtotal = orderToResume.summary.subtotalAfterFees;
     MOCK_CART.total = orderToResume.summary.total;
@@ -46,11 +52,11 @@ export const mockResumeParkedOrder = async (params) => {
     // Remove from parked
     MOCK_PARKED_ORDERS.splice(index, 1);
     // Refresh the restored cart and the order lists.
-    mockPublishEvent("cart", "parked-order-resumed", { orderId });
-    mockPublishEvent("orders", "parked-order-resumed", { orderId });
+    mockPublishEvent('cart', 'parked-order-resumed', { orderId });
+    mockPublishEvent('orders', 'parked-order-resumed', { orderId });
     return {
         success: true,
         order: orderToResume,
-        timestamp: new Date().toISOString()
+        timestamp: new Date().toISOString(),
     };
 };

package/dist/actions/update-cart-item-quantity/mock.js

@@ -1,4 +1,4 @@
-import { MOCK_CART, mockPublishEvent } from '../../demo/database';
+import { MOCK_CART, MOCK_PRODUCTS, mockPublishEvent } from '../../demo/database';
 import { extendPrice, isValidQuantity } from '@final-commerce/common';
 export const mockUpdateCartItemQuantity = (params) => {
     console.log('[Mock] updateCartItemQuantity called', params);
@@ -44,6 +44,12 @@ export const mockUpdateCartItemQuantity = (params) => {
             timestamp: new Date().toISOString(),
         });
     }
+    // Same refusal and text as the host: raising a line not sold in POS (lowering always works).
+    const source = MOCK_PRODUCTS.find((p) => p.variants.some((v) => v._id === product.variantId));
+    const variant = source?.variants.find((v) => v._id === product.variantId);
+    if (quantity > previousQuantity && (source?.notSoldInPos || variant?.notSoldInPos)) {
+        throw new Error(`${source?.name} is not sold in POS`);
+    }
     // Update quantity
     product.quantity = quantity;
     // Difference of the two ROUNDED extensions — rounding the delta itself would let the

package/dist/index.d.ts

@@ -35,6 +35,7 @@ export declare const command: {
     readonly getActiveProduct: import(".").GetActiveProduct;
     readonly setActiveProduct: import(".").SetActiveProduct;
     readonly adjustInventory: import(".").AdjustInventory;
+    readonly getCustomStockActions: import(".").GetCustomStockActions;
     readonly addOrderNote: import(".").AddOrderNote;
     readonly addCartFee: import(".").AddCartFee;
     readonly getCurrentCart: import(".").GetCurrentCart;
@@ -183,7 +184,8 @@ export type { SetActiveProductFee, SetActiveProductFeeParams, SetActiveProductFe
 export type { SetActiveProductDiscount, SetActiveProductDiscountParams, SetActiveProductDiscountResponse, } from './actions/set-active-product-discount/types';
 export type { GetActiveProduct, GetActiveProductResponse } from './actions/get-active-product/types';
 export type { SetActiveProduct, SetActiveProductParams, SetActiveProductResponse, } from './actions/set-active-product/types';
-export type { AdjustInventory, AdjustInventoryParams, AdjustInventoryResponse } from './actions/adjust-inventory/types';
+export type { AdjustInventory, AdjustInventoryParams, AdjustInventoryResponse, ManualStockReason, } from './actions/adjust-inventory/types';
+export type { CustomStockActionPayload, GetCustomStockActions, GetCustomStockActionsResponse, } from './actions/get-custom-stock-actions/types';
 export type { AddOrderNote, AddOrderNoteParams, AddOrderNoteResponse } from './actions/add-order-note/types';
 export type { AddCartFee, AddCartFeeParams, AddCartFeeResponse } from './actions/add-cart-fee/types';
 export type { ClearCart, ClearCartResponse } from './actions/clear-cart/types';

package/dist/index.js

@@ -34,6 +34,7 @@ import { setActiveProductDiscount } from './actions/set-active-product-discount/
 import { getActiveProduct } from './actions/get-active-product/action';
 import { setActiveProduct } from './actions/set-active-product/action';
 import { adjustInventory } from './actions/adjust-inventory/action';
+import { getCustomStockActions } from './actions/get-custom-stock-actions/action';
 // Order Actions
 import { addOrderNote } from './actions/add-order-note/action';
 import { addCartFee } from './actions/add-cart-fee/action';
@@ -184,6 +185,7 @@ export const command = {
     getActiveProduct,
     setActiveProduct,
     adjustInventory,
+    getCustomStockActions,
     // Order Actions
     addOrderNote,
     addCartFee,

package/dist/projects/render/mocks.js

@@ -26,6 +26,7 @@ import { mockRemoveProductFromCart } from '../../actions/remove-product-from-car
 import { mockRemoveCartDiscount } from '../../actions/remove-cart-discount/mock';
 import { mockUpdateCartItemQuantity } from '../../actions/update-cart-item-quantity/mock';
 import { mockAdjustInventory } from '../../actions/adjust-inventory/mock';
+import { mockGetCustomStockActions } from '../../actions/get-custom-stock-actions/mock';
 import { mockAssignCustomer } from '../../actions/assign-customer/mock';
 import { mockAuthenticateUser } from '../../actions/authenticate-user/mock';
 import { mockCalculateRefundTotal } from '../../actions/calculate-refund-total/mock';
@@ -137,6 +138,7 @@ export const RENDER_MOCKS = {
     removeProductFromCart: mockRemoveProductFromCart,
     updateCartItemQuantity: mockUpdateCartItemQuantity,
     adjustInventory: mockAdjustInventory,
+    getCustomStockActions: mockGetCustomStockActions,
     assignCustomer: mockAssignCustomer,
     authenticateUser: mockAuthenticateUser,
     calculateRefundTotal: mockCalculateRefundTotal,

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, StartCheckout, AttachCheckoutContact, GetOutlets, SetOutlet, ResumeCheckout, GetTimeClockStatus } from '../../index';
+import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, 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, StartCheckout, AttachCheckoutContact, GetOutlets, SetOutlet, ResumeCheckout, GetTimeClockStatus } from '../../index';
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
@@ -35,6 +35,7 @@ export interface RenderProviderActions {
     getActiveProduct: GetActiveProduct;
     setActiveProduct: SetActiveProduct;
     adjustInventory: AdjustInventory;
+    getCustomStockActions: GetCustomStockActions;
     addOrderNote: AddOrderNote;
     addCartFee: AddCartFee;
     clearCart: ClearCart;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.8.1-online.1",
+  "version": "0.9.0-online.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.1-online.1"
+    "@final-commerce/common": "2.5.1-online.1"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.0.0",