@final-commerce/command-frame 0.9.0-preprod.2 → 0.9.0-preprod.3

package/dist/actions/get-current-cart/mock.d.ts

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

package/dist/actions/get-current-cart/mock.js

@@ -1,9 +1,12 @@
-import { MOCK_CART, safeSerialize } from "../../demo/database";
+import { MOCK_CART, safeSerialize } from '../../demo/database';
 export const mockGetCurrentCart = async () => {
-    console.log("[Mock] getCurrentCart called");
+    console.log('[Mock] getCurrentCart called');
     return {
         success: true,
         cart: safeSerialize(MOCK_CART),
-        timestamp: new Date().toISOString()
+        // Every mock tender settles the whole sale and clears the cart, so the demo cart
+        // never holds an order with money on it — nothing to lock.
+        itemsLocked: false,
+        timestamp: new Date().toISOString(),
     };
 };

package/dist/actions/get-current-cart/types.d.ts

@@ -1,7 +1,13 @@
-import { CFActiveCart } from "../../CommonTypes";
+import { CFActiveCart } from '../../CommonTypes';
 export interface GetCurrentCartResponse {
     success: boolean;
     cart: CFActiveCart;
+    /**
+     * `true` while the order in this cart has any payment on it (a split leg, a part payment,
+     * or paid in full): its items, amounts and customer can no longer be changed — the
+     * value-changing cart commands and clearCart refuse. Absent on hosts that predate the lock.
+     */
+    itemsLocked?: boolean;
     timestamp: string;
 }
 export type GetCurrentCart = () => Promise<GetCurrentCartResponse>;

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

@@ -5,7 +5,7 @@ export const mockGetOrders = async (params) => {
     let orders = safeSerialize([...MOCK_ORDERS, ...MOCK_PARKED_ORDERS]);
     // Filter simulation
     if (params) {
-        const { customerId, status, sessionId, paymentState, fulfillmentState, outletId, assignedUserId, inCart, orderType, customStatusId, searchValue, limit, offset, sortBy, sortDirection, } = params;
+        const { customerId, status, sessionId, paymentState, fulfillmentState, outletId, assignedUserId, inCart, orderType, customStatusId, scheduled, scheduledFrom, scheduledTo, searchValue, limit, offset, sortBy, sortDirection, } = params;
         // 1. Filtering
         if (customerId) {
             orders = orders.filter((o) => o.customer && '_id' in o.customer && o.customer._id === customerId);
@@ -43,6 +43,19 @@ export const mockGetOrders = async (params) => {
             if (ids.length)
                 orders = orders.filter((o) => !!o.customStatus && ids.includes(o.customStatus.id));
         }
+        // Requested time (setScheduledFor). ISO strings in UTC compare correctly as strings.
+        const scheduledOf = (o) => o.scheduledFor ?? null;
+        if (typeof scheduled === 'boolean') {
+            orders = orders.filter((o) => (scheduledOf(o) !== null) === scheduled);
+        }
+        if (scheduledFrom) {
+            const from = new Date(scheduledFrom).toISOString();
+            orders = orders.filter((o) => (scheduledOf(o) ?? '') !== '' && scheduledOf(o) >= from);
+        }
+        if (scheduledTo) {
+            const to = new Date(scheduledTo).toISOString();
+            orders = orders.filter((o) => (scheduledOf(o) ?? '') !== '' && scheduledOf(o) <= to);
+        }
         if (typeof inCart === 'boolean') {
             // Mirrors common's isInCart: the flag when present, else the legacy reading.
             const orderInCart = (o) => o.inCart != null
@@ -70,6 +83,11 @@ export const mockGetOrders = async (params) => {
             orders.sort((a, b) => {
                 let valA = a[sortBy];
                 let valB = b[sortBy];
+                // Like the host: a missing time sorts as '' (first when ascending).
+                if (sortBy === 'scheduledFor') {
+                    valA = valA ?? '';
+                    valB = valB ?? '';
+                }
                 // Handle nested sort fields if necessary, basic support for now
                 if (!valA && sortBy === 'createdAt')
                     valA = a.createdAt || '';

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

@@ -24,12 +24,18 @@ export interface GetOrdersParams {
     orderType?: string | string[];
     /** Custom status id(s) set with setOrderStatus, e.g. 'in-kitchen'. A list matches any of them. */
     customStatusId?: string | string[];
+    /** true: only orders with a time (setScheduledFor); false: only "as soon as possible" orders (no time). */
+    scheduled?: boolean;
+    /** Only orders scheduled at or after this ISO 8601 date-time. Orders with no time never match. */
+    scheduledFrom?: string;
+    /** Only orders scheduled at or before this ISO 8601 date-time. Orders with no time never match. */
+    scheduledTo?: string;
     /** Default: 50. */
     limit?: number;
     /** Default: 0. */
     offset?: number;
     searchValue?: string;
-    /** Default: 'createdAt'. */
+    /** Default: 'createdAt'. 'scheduledFor' sorts by the customer's requested time — orders with no time come first ascending. */
     sortBy?: string;
     /** Default: 'descending'. */
     sortDirection?: 'ascending' | 'descending';

package/dist/actions/set-scheduled-for/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Set scheduled-for action
+ * Calls the setScheduledFor action on the parent window
+ */
+import type { SetScheduledFor } from './types';
+export declare const setScheduledFor: SetScheduledFor;

package/dist/actions/set-scheduled-for/action.js

@@ -0,0 +1,8 @@
+/**
+ * Set scheduled-for action
+ * Calls the setScheduledFor action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const setScheduledFor = async (params) => {
+    return await commandFrameClient.call('setScheduledFor', params);
+};

package/dist/actions/set-scheduled-for/mock.d.ts

@@ -0,0 +1,4 @@
+import type { SetScheduledFor } from './types';
+/** ISO 8601 in, UTC ISO 8601 out; null stays null (as soon as possible). */
+export declare const normalizeScheduledFor: (value: unknown) => string | null;
+export declare const mockSetScheduledFor: SetScheduledFor;

package/dist/actions/set-scheduled-for/mock.js

@@ -0,0 +1,45 @@
+import { MOCK_ORDERS, MOCK_PARKED_ORDERS, mockPublishEvent } from '../../demo/database';
+/** Time for the demo's live cart, which has no order until it is paid or parked. */
+let mockCartScheduledFor = null;
+/**
+ * An ISO 8601 date-time WITH a zone — 'Z' or an offset. A zoneless time ('2026-10-13T19:00') is
+ * refused: it would mean a different moment on every device. Date.parse alone is too lenient
+ * (it accepts strings like "tomorrow at 7"), so the shape is checked first.
+ */
+const ISO_DATE_TIME = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2}(\.\d{1,9})?)?(Z|[+-]\d{2}:?\d{2})$/;
+/** The YYYY-MM-DD part is a real day — Date.parse quietly rolls "Feb 30" over to March 2. */
+const isCalendarDate = (text) => {
+    const [y, m, d] = text.slice(0, 10).split('-').map(Number);
+    const day = new Date(Date.UTC(y, m - 1, d));
+    return day.getUTCFullYear() === y && day.getUTCMonth() === m - 1 && day.getUTCDate() === d;
+};
+/** ISO 8601 in, UTC ISO 8601 out; null stays null (as soon as possible). */
+export const normalizeScheduledFor = (value) => {
+    if (value === null)
+        return null;
+    if (typeof value !== 'string' || !value.trim()) {
+        throw new Error('setScheduledFor: scheduledFor must be an ISO 8601 date-time or null');
+    }
+    const text = value.trim();
+    const ms = ISO_DATE_TIME.test(text) && isCalendarDate(text) ? Date.parse(text) : NaN;
+    if (Number.isNaN(ms)) {
+        throw new Error(`setScheduledFor: "${value}" is not an ISO 8601 date-time with Z or an offset`);
+    }
+    return new Date(ms).toISOString();
+};
+export const mockSetScheduledFor = async (params) => {
+    console.log('[Mock] setScheduledFor called', params);
+    const scheduledFor = normalizeScheduledFor(params?.scheduledFor);
+    const timestamp = new Date().toISOString();
+    if (!params.orderId) {
+        mockCartScheduledFor = scheduledFor;
+        return { success: true, orderId: null, scheduledFor: mockCartScheduledFor, timestamp };
+    }
+    const order = [...MOCK_ORDERS, ...MOCK_PARKED_ORDERS].find((o) => o._id === params.orderId);
+    if (!order) {
+        throw new Error(`Order with ID ${params.orderId} not found`);
+    }
+    order.scheduledFor = scheduledFor;
+    mockPublishEvent('orders', 'order-updated', { order });
+    return { success: true, orderId: order._id, scheduledFor, timestamp };
+};

package/dist/actions/set-scheduled-for/types.d.ts

@@ -0,0 +1,22 @@
+export interface SetScheduledForParams {
+    /**
+     * Order to schedule. Omit to target the live cart — including a cart that isn't an
+     * order yet; the time is carried onto the order when it's created.
+     */
+    orderId?: string;
+    /**
+     * When the customer wants the order, as an ISO 8601 date-time with Z or an offset (e.g.
+     * '2026-10-13T23:00:00.000Z' or '2026-10-13T19:00:00-04:00'), or null for as soon as possible.
+     * Stored in UTC.
+     */
+    scheduledFor: string | null;
+}
+export interface SetScheduledForResponse {
+    success: boolean;
+    /** The order that was updated, or null when the live cart has no order yet. */
+    orderId: string | null;
+    /** The time after the call, normalised to UTC ISO 8601 — or null (as soon as possible). */
+    scheduledFor: string | null;
+    timestamp: string;
+}
+export type SetScheduledFor = (params: SetScheduledForParams) => Promise<SetScheduledForResponse>;

package/dist/actions/set-scheduled-for/types.js

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

package/dist/index.d.ts

@@ -47,6 +47,7 @@ export declare const command: {
     readonly assignOrderUser: import(".").AssignOrderUser;
     readonly releaseFromCart: import(".").ReleaseFromCart;
     readonly setOrderType: import(".").SetOrderType;
+    readonly setScheduledFor: import(".").SetScheduledFor;
     readonly setOrderStatus: import(".").SetOrderStatus;
     readonly getOrderStatuses: import(".").GetOrderStatuses;
     readonly deleteParkedOrder: import(".").DeleteParkedOrder;
@@ -200,6 +201,7 @@ export type { SetOrderMetadata, SetOrderMetadataParams, SetOrderMetadataResponse
 export type { AssignOrderUser, AssignOrderUserParams, AssignOrderUserResponse, } from './actions/assign-order-user/types';
 export type { ReleaseFromCart, ReleaseFromCartResponse } from './actions/release-from-cart/types';
 export type { SetOrderType, SetOrderTypeParams, SetOrderTypeResponse } from './actions/set-order-type/types';
+export type { SetScheduledFor, SetScheduledForParams, SetScheduledForResponse, } from './actions/set-scheduled-for/types';
 export type { SetOrderStatus, SetOrderStatusParams, SetOrderStatusResponse } from './actions/set-order-status/types';
 export type { GetOrderStatuses, GetOrderStatusesResponse } from './actions/get-order-statuses/types';
 export type { DeleteParkedOrder, DeleteParkedOrderParams, DeleteParkedOrderResponse, } from './actions/delete-parked-order/types';

package/dist/index.js

@@ -47,6 +47,7 @@ import { setOrderMetadata } from './actions/set-order-metadata/action';
 import { assignOrderUser } from './actions/assign-order-user/action';
 import { releaseFromCart } from './actions/release-from-cart/action';
 import { setOrderType } from './actions/set-order-type/action';
+import { setScheduledFor } from './actions/set-scheduled-for/action';
 import { setOrderStatus } from './actions/set-order-status/action';
 import { getOrderStatuses } from './actions/get-order-statuses/action';
 import { deleteParkedOrder } from './actions/delete-parked-order/action';
@@ -202,6 +203,7 @@ export const command = {
     assignOrderUser,
     releaseFromCart,
     setOrderType,
+    setScheduledFor,
     setOrderStatus,
     getOrderStatuses,
     deleteParkedOrder,

package/dist/projects/render/mocks.js

@@ -73,6 +73,7 @@ import { mockSetOrderMetadata } from '../../actions/set-order-metadata/mock';
 import { mockAssignOrderUser } from '../../actions/assign-order-user/mock';
 import { mockReleaseFromCart } from '../../actions/release-from-cart/mock';
 import { mockSetOrderType } from '../../actions/set-order-type/mock';
+import { mockSetScheduledFor } from '../../actions/set-scheduled-for/mock';
 import { mockSetOrderStatus } from '../../actions/set-order-status/mock';
 import { mockGetOrderStatuses } from '../../actions/get-order-statuses/mock';
 import { mockSelectAllRefundItems } from '../../actions/select-all-refund-items/mock';
@@ -188,6 +189,7 @@ export const RENDER_MOCKS = {
     assignOrderUser: mockAssignOrderUser,
     releaseFromCart: mockReleaseFromCart,
     setOrderType: mockSetOrderType,
+    setScheduledFor: mockSetScheduledFor,
     setOrderStatus: mockSetOrderStatus,
     getOrderStatuses: mockGetOrderStatuses,
     selectAllRefundItems: mockSelectAllRefundItems,

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, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, 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, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, ResumeOrder, SetOrderMetadata, AssignOrderUser, ReleaseFromCart, SetOrderType, SetScheduledFor, SetOrderStatus, GetOrderStatuses, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, RecordExternalPayment, 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;
@@ -46,6 +46,7 @@ export interface RenderProviderActions {
     assignOrderUser: AssignOrderUser;
     releaseFromCart: ReleaseFromCart;
     setOrderType: SetOrderType;
+    setScheduledFor: SetScheduledFor;
     setOrderStatus: SetOrderStatus;
     getOrderStatuses: GetOrderStatuses;
     deleteParkedOrder: DeleteParkedOrder;

package/package.json

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