@final-commerce/command-frame 0.10.0-staging.4 → 0.10.0-staging.6

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

@@ -7,8 +7,11 @@ export declare function compositePicksRefusal(composite: CFComposite, picks: CFC
  *  left empty is not listed. A copy — change both in one step. */
 export declare function mockPicksStillNeeded(composite: CFComposite, picks: CFCompositePick[]): {
     partId: string;
+    name: string | null;
     needed: number;
 }[];
+/** The parts whose picks already reach their `max` — a picker disables "+" on them. A copy of the host's. */
+export declare const mockFullPartIds: (composite: CFComposite, picks: CFCompositePick[]) => string[];
 type MockCompositeLine = {
     price: number;
     components: CFCartLineComponent[];

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

@@ -275,17 +275,19 @@ function mockSelectionsRefusal(modifiers, selections) {
     }
     return null;
 }
+const mockPartPicks = (part, picks) => picks
+    .filter((pick) => part.items.some((item) => item._id === pick.itemId))
+    .reduce((sum, pick) => sum + (pick.quantity ?? 1), 0);
 /** The host's `picksStillNeeded` (kaching `resolveComposite.ts`): per part, what is left of its min; an Optional part
  *  left empty is not listed. A copy — change both in one step. */
 export function mockPicksStillNeeded(composite, picks) {
     return composite.parts.flatMap((part) => {
-        const count = picks
-            .filter((pick) => part.items.some((item) => item._id === pick.itemId))
-            .reduce((sum, pick) => sum + (pick.quantity ?? 1), 0);
-        const needed = Math.max(0, part.min - count);
-        return needed > 0 ? [{ partId: part._id, needed }] : [];
+        const needed = Math.max(0, part.min - mockPartPicks(part, picks));
+        return needed > 0 ? [{ partId: part._id, name: part.name, needed }] : [];
     });
 }
+/** The parts whose picks already reach their `max` — a picker disables "+" on them. A copy of the host's. */
+export const mockFullPartIds = (composite, picks) => composite.parts.filter((part) => mockPartPicks(part, picks) >= part.max).map((part) => part._id);
 /** kaching `buildCompositeLine` (B31): a component's share of ONE composite = the composite price split by the picked
  *  variant's price × units (all 0 → units) + its own upcharge; Σ = price. Item modifiers flat with `componentIndex`
  *  and quantity × the component's units. A copy — change both in one step. */

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-composite-availability/mock.js

@@ -5,9 +5,11 @@ export const mockGetCompositeAvailability = async (params) => {
     console.log('[Mock] getCompositeAvailability called', params);
     const timestamp = new Date().toISOString();
     const refuse = (reason) => ({ success: false, reason, slots: [], timeZone: null, timestamp });
-    const product = MOCK_PRODUCTS.find((candidate) => candidate.variants.some((v) => v._id === params?.variantId));
+    if (!params?.variantId)
+        return refuse('variantId is required');
+    const product = MOCK_PRODUCTS.find((candidate) => candidate.variants.some((v) => v._id === params.variantId));
     if (!product)
-        throw new Error(`Variant with ID ${params?.variantId} not found`);
+        return refuse(`Variant with ID ${params.variantId} not found`);
     if (!product.composite)
         return refuse(`${product.name} is not a composite: it takes no composite picks`);
     const composite = mockCompositeAtOutlet(product.composite);

package/dist/actions/get-composite-price/mock.js

@@ -1,6 +1,6 @@
 import { MOCK_CART, MOCK_PRODUCTS, buildModifierRows, mockCompositeAtOutlet, mockCompositeStockRefusal, mockHiddenProductIds, } from '../../demo/database';
-import { compositePicksRefusal, mockCompositeLine, mockNeedsDateRefusal, mockPicksStillNeeded, } from '../add-product-to-cart/mock';
-// The same line the mock addProductToCart builds, priced for ONE composite and added to nothing.
+import { compositePicksRefusal, mockCompositeLine, mockFullPartIds, mockNeedsDateRefusal, mockPicksStillNeeded, } from '../add-product-to-cart/mock';
+// The same line the mock addProductToCart builds, priced for `quantity` composites and added to nothing.
 export const mockGetCompositePrice = async (params) => {
     console.log('[Mock] getCompositePrice called', params);
     const timestamp = new Date().toISOString();
@@ -12,6 +12,7 @@ export const mockGetCompositePrice = async (params) => {
             success: false,
             reason: `${product.name} is not a composite: it takes no composite picks`,
             missing: [],
+            fullPartIds: [],
             timestamp,
         };
     }
@@ -19,19 +20,22 @@ export const mockGetCompositePrice = async (params) => {
     // What this outlet sells (the host's catalog-visibility rules).
     const composite = mockCompositeAtOutlet(product.composite, undefined, params.compositeSlot);
     const missing = mockPicksStillNeeded(composite, picks);
+    const fullPartIds = mockFullPartIds(composite, picks);
+    const quantity = params.quantity ?? 1;
     if (mockHiddenProductIds().has(product._id)) {
-        return { success: false, reason: `${product.name} is not sold at this outlet`, missing, timestamp };
+        return { success: false, reason: `${product.name} is not sold at this outlet`, missing, fullPartIds, timestamp };
     }
     const line = mockNeedsDateRefusal(product.name, composite, params.compositeSlot) ??
         compositePicksRefusal(composite, picks) ??
         mockCompositeLine(composite, picks, !product.taxTable);
     if (typeof line === 'string')
-        return { success: false, reason: line, missing, timestamp };
+        return { success: false, reason: line, missing, fullPartIds, timestamp };
     const shortOfStock = mockCompositeStockRefusal([
         ...MOCK_CART.products,
-        { variantId: params.variantId, quantity: 1, components: line.components },
+        { variantId: params.variantId, quantity, components: line.components },
     ]);
     if (shortOfStock)
-        return { success: false, reason: shortOfStock, missing, timestamp };
-    return { success: true, total: line.price + buildModifierRows(line.modifiers, 1).modifiersTotal, missing, timestamp };
+        return { success: false, reason: shortOfStock, missing, fullPartIds, timestamp };
+    const unitTotal = line.price + buildModifierRows(line.modifiers, 1).modifiersTotal;
+    return { success: true, total: unitTotal * quantity, unitTotal, missing, fullPartIds, timestamp };
 };

package/dist/actions/get-composite-price/types.d.ts

@@ -8,24 +8,33 @@ export interface GetCompositePriceParams {
     compositeSlot?: {
         startAt: string;
     };
+    /** How many of this composite, as `addProductToCart({ quantity })` takes it. Defaults to 1. */
+    quantity?: number;
 }
 export interface GetCompositePriceResponse {
     success: boolean;
     /** Why these picks are refused — the same refusal and text `addProductToCart` would give. */
     reason?: string;
     /**
-     * What ONE composite with these picks adds to the cart, minor units: the line price the host would build plus the
-     * picked items' modifiers. Before discounts, fees and tax. Show it; do not recompute it. Absent when refused.
+     * What `quantity` composites with these picks add to the cart, minor units: `unitTotal` × `quantity`. Before
+     * discounts, fees and tax. Show it; do not recompute it. Absent when refused.
      */
     total?: number;
+    /** What ONE composite with these picks adds: the line price the host would build plus the picked items' modifiers,
+     *  minor units. Absent when refused. */
+    unitTotal?: number;
     /**
-     * The parts that still need picks before the composite can be added, and how many ("Pick 2 more"); empty when every
-     * required part is filled. Decided by the host — keep Add to cart disabled while this is not empty.
+     * The parts that still need picks before the composite can be added, with the part's `name` (null = untitled) and
+     * how many ("Pick 2 more side"); empty when every required part is filled. Decided by the host — keep Add to cart
+     * disabled while this is not empty.
      */
     missing: {
         partId: string;
+        name: string | null;
         needed: number;
     }[];
+    /** The parts whose picks already reach their `max` — disable "+" on them. Decided by the host. */
+    fullPartIds: string[];
     timestamp: string;
 }
 export type GetCompositePrice = (params: GetCompositePriceParams) => Promise<GetCompositePriceResponse>;

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/set-variant-unavailable/mock.js

@@ -1,12 +1,22 @@
 import { MOCK_OUTLET, MOCK_PRODUCTS } from '../../demo/database';
 export const mockSetVariantUnavailable = async (params) => {
     console.log('[Mock] setVariantUnavailable called', params);
-    if (!params?.variantId)
-        throw new Error('variantId is required');
+    const answer = (success, reason) => ({
+        success,
+        reason,
+        variantId: params?.variantId ?? '',
+        outletId: MOCK_OUTLET.id,
+        unavailable: !!params?.unavailable,
+        timestamp: new Date().toISOString(),
+    });
+    // Same refusals and texts as the host, resolved instead of thrown.
+    if (!params?.variantId || typeof params.unavailable !== 'boolean') {
+        return answer(false, 'variantId and unavailable are required');
+    }
     const { variantId, unavailable } = params;
     const variant = MOCK_PRODUCTS.flatMap((product) => product.variants).find((v) => v._id === variantId);
     if (!variant)
-        throw new Error(`Variant with ID ${variantId} not found`);
+        return answer(false, `Variant with ID ${variantId} not found`);
     variant.unavailable = unavailable;
-    return { success: true, variantId, outletId: MOCK_OUTLET.id, unavailable, timestamp: new Date().toISOString() };
+    return answer(true);
 };

package/dist/actions/set-variant-unavailable/types.d.ts

@@ -8,7 +8,9 @@ export interface SetVariantUnavailableParams {
     unavailable: boolean;
 }
 export interface SetVariantUnavailableResponse {
+    /** False when the host refused: missing params, no active outlet or company, unknown variant, offline. */
     success: boolean;
+    reason?: string;
     variantId: string;
     outletId: string;
     unavailable: boolean;

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

@@ -1,5 +1,5 @@
-import { MOCK_CART, MOCK_PRODUCTS, mockPublishEvent } from '../../demo/database';
-import { extendPrice, isValidQuantity } from '@final-commerce/common';
+import { MOCK_BOOKINGS, MOCK_CART, MOCK_PRODUCTS, mockCompositeStockRefusal, mockPublishEvent, } from '../../demo/database';
+import { ReservationStatus, extendPrice, isValidQuantity } from '@final-commerce/common';
 export const mockUpdateCartItemQuantity = (params) => {
     console.log('[Mock] updateCartItemQuantity called', params);
     if (!params?.internalId) {
@@ -16,6 +16,10 @@ export const mockUpdateCartItemQuantity = (params) => {
     }
     const product = MOCK_CART.products[productIndex];
     const previousQuantity = product.quantity;
+    // Same refusal and text as the host: a line holding bookings keeps its quantity — its holds are that many seats.
+    if (quantity !== 0 && MOCK_CART.reservations?.some((reservation) => reservation.lineItemInternalId === internalId)) {
+        throw new Error(`${product.name} holds a booking — its quantity is the seats held: remove the line and add it again with the new quantity (addProductToCart with compositeSlot)`);
+    }
     // The line resolved its unit when it was added; a piece-sold line has none and stays whole.
     if (quantity !== 0 &&
         !isValidQuantity(quantity, (product.unit ?? { unitId: 'piece', ratioToBase: 1, precision: 0 }))) {
@@ -26,6 +30,12 @@ export const mockUpdateCartItemQuantity = (params) => {
     // If quantity is 0, remove the item
     if (quantity === 0) {
         MOCK_CART.products.splice(productIndex, 1);
+        // Like the host's `dropCompositeLine`: the line's reservations leave with it and their holds are released.
+        const linked = (MOCK_CART.reservations ?? []).filter((reservation) => reservation.lineItemInternalId === internalId);
+        MOCK_CART.reservations = (MOCK_CART.reservations ?? []).filter((reservation) => !linked.includes(reservation));
+        for (const booking of MOCK_BOOKINGS.filter(({ id }) => linked.some(({ bookingId }) => bookingId === id))) {
+            booking.status = ReservationStatus.CANCELLED;
+        }
         // Recalculate totals
         const lineTotal = extendPrice(product.price, previousQuantity);
         MOCK_CART.subtotal -= lineTotal;
@@ -50,6 +60,12 @@ export const mockUpdateCartItemQuantity = (params) => {
     if (quantity > previousQuantity && (source?.notSoldInPos || variant?.notSoldInPos)) {
         throw new Error(`${source?.name} is not sold in POS`);
     }
+    // A raised composite line draws on its components' shelves, like the host's `compositeStockRefusal`.
+    if (quantity > previousQuantity && product.components?.length) {
+        const refusal = mockCompositeStockRefusal(MOCK_CART.products.map((line) => (line.internalId === internalId ? { ...line, quantity } : line)));
+        if (refusal)
+            throw new Error(refusal);
+    }
     // Update quantity
     product.quantity = quantity;
     // Difference of the two ROUNDED extensions — rounding the delta itself would let the

package/dist/index.d.ts

@@ -38,6 +38,7 @@ export declare const command: {
     readonly setActiveProduct: import(".").SetActiveProduct;
     readonly adjustInventory: import(".").AdjustInventory;
     readonly setVariantUnavailable: import(".").SetVariantUnavailable;
+    readonly getCustomStockActions: import(".").GetCustomStockActions;
     readonly addOrderNote: import(".").AddOrderNote;
     readonly addCartFee: import(".").AddCartFee;
     readonly getCurrentCart: import(".").GetCurrentCart;
@@ -184,8 +185,9 @@ 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 { SetVariantUnavailable, SetVariantUnavailableParams, SetVariantUnavailableResponse, } from './actions/set-variant-unavailable/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

@@ -37,6 +37,7 @@ import { getActiveProduct } from './actions/get-active-product/action';
 import { setActiveProduct } from './actions/set-active-product/action';
 import { adjustInventory } from './actions/adjust-inventory/action';
 import { setVariantUnavailable } from './actions/set-variant-unavailable/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';
@@ -186,6 +187,7 @@ export const command = {
     setActiveProduct,
     adjustInventory,
     setVariantUnavailable,
+    getCustomStockActions,
     // Order Actions
     addOrderNote,
     addCartFee,

package/dist/projects/render/mocks.js

@@ -29,6 +29,7 @@ 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 { mockSetVariantUnavailable } from '../../actions/set-variant-unavailable/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';
@@ -138,6 +139,7 @@ export const RENDER_MOCKS = {
     updateCartItemQuantity: mockUpdateCartItemQuantity,
     adjustInventory: mockAdjustInventory,
     setVariantUnavailable: mockSetVariantUnavailable,
+    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, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, 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, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, GetCompositePrice, GetCompositeAvailability, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, SetVariantUnavailable, 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;
@@ -38,6 +38,7 @@ export interface RenderProviderActions {
     setActiveProduct: SetActiveProduct;
     adjustInventory: AdjustInventory;
     setVariantUnavailable: SetVariantUnavailable;
+    getCustomStockActions: GetCustomStockActions;
     addOrderNote: AddOrderNote;
     addCartFee: AddCartFee;
     clearCart: ClearCart;

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

@@ -27,6 +27,11 @@ export const productsTopic = {
             name: 'Catalog Visibility Changed',
             description: 'Published when a product is hidden or shown at an outlet; re-ask getProducts',
         },
+        {
+            id: 'variant-unavailability-changed',
+            name: 'Variant Unavailability Changed',
+            description: 'Published when a variant is marked sold out at an outlet or unmarked; re-ask getProducts',
+        },
         {
             id: 'inventory-changed',
             name: 'Inventory Changed',

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

@@ -6,6 +6,7 @@ export * from './product-created/types';
 export * from './product-updated/types';
 export * from './composite-changed/types';
 export * from './catalog-visibility-changed/types';
+export * from './variant-unavailability-changed/types';
 export * from './inventory-changed/types';
 export * from './product-set-active/types';
 export * from './product-get-active/types';
@@ -13,8 +14,9 @@ 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 { VariantUnavailabilityChangedPayload } from './variant-unavailability-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';
+export type ProductsEventPayload = ProductCreatedPayload | ProductUpdatedPayload | CompositeChangedPayload | CatalogVisibilityChangedPayload | VariantUnavailabilityChangedPayload | InventoryChangedPayload | ProductSetActivePayload | ProductGetActivePayload;
+export type ProductsEventType = 'product-created' | 'product-updated' | 'composite-changed' | 'catalog-visibility-changed' | 'variant-unavailability-changed' | 'inventory-changed' | 'set-active-product' | 'get-active-product';

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

@@ -7,6 +7,7 @@ export * from './product-created/types';
 export * from './product-updated/types';
 export * from './composite-changed/types';
 export * from './catalog-visibility-changed/types';
+export * from './variant-unavailability-changed/types';
 export * from './inventory-changed/types';
 export * from './product-set-active/types';
 export * from './product-get-active/types';

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

@@ -0,0 +1,19 @@
+import type { TopicEvent } from '../../../types';
+/**
+ * Payload for variant-unavailability-changed: a variant was marked sold out at an outlet, or the mark was removed
+ * (`isDeleted`). `getProducts` reports the mark as `variant.unavailable` and a composite refuses a marked item —
+ * debounce, then re-ask `getProducts`.
+ */
+export interface VariantUnavailabilityChangedPayload {
+    unavailability: {
+        _id: string;
+        productId: string;
+        variantId: string;
+        outletId: string;
+        isDeleted?: boolean;
+    };
+}
+/**
+ * Typed event for variant-unavailability-changed
+ */
+export type VariantUnavailabilityChangedEvent = TopicEvent<VariantUnavailabilityChangedPayload>;

package/dist/pubsub/topics/products/variant-unavailability-changed/types.js

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

package/package.json

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