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

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, ProdModifierBreakdown, OrderLineItemModifier, CustomerNote, Attribute, AttributeOption, Category, Transaction, ActiveSplitPayment, BookingAvailability, BookingSlot, BookingSlotResource, BookingResource, Booking, CartReservation, OrderReservation } 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, BookingAvailability, BookingSlot, BookingSlotResource, BookingResource, Booking, CartReservation, OrderReservation, CartAddress, CartShipping } 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>;
@@ -72,6 +72,8 @@ export type CFActiveOrder = ActiveOrder;
 export type CFActiveCustomSales = ActiveCustomSales;
 export type CFNonRevenueItem = NonRevenueItem;
 export type CFActiveCart = ActiveCart;
+export type CFCartAddress = CartAddress;
+export type CFCartShipping = CartShipping;
 export type CFActivePark = ActivePark;
 export type CFActiveCompany = ActiveCompany;
 /** Tile kinds a SmartGrid cell can represent. Mirrors common's `BaseTile['type']`. */

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-address-options/action.d.ts

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

package/dist/actions/get-address-options/action.js

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

package/dist/actions/get-address-options/mock.d.ts

@@ -0,0 +1,3 @@
+import type { GetAddressOptions } from './types';
+/** Standalone mock: the same country and province lists the runtime serves. The demo store is in Canada. */
+export declare const mockGetAddressOptions: GetAddressOptions;

package/dist/actions/get-address-options/mock.js

@@ -0,0 +1,15 @@
+import { CANADA_PROVINCES, listCountries } from '@final-commerce/common';
+/** Standalone mock: the same country and province lists the runtime serves. The demo store is in Canada. */
+export const mockGetAddressOptions = async (params) => {
+    console.log('[Mock] getAddressOptions called', params);
+    const french = params?.locale?.toLowerCase().startsWith('fr') ?? false;
+    const provinces = CANADA_PROVINCES.map((p) => ({ code: p.code, name: french ? p.nameFr : p.name }));
+    return {
+        countries: listCountries(params?.locale ?? 'en').map((c) => ({
+            ...c,
+            provinces: c.code === 'CA' ? provinces : [],
+        })),
+        defaultCountry: 'CA',
+        timestamp: new Date().toISOString(),
+    };
+};

package/dist/actions/get-address-options/types.d.ts

@@ -0,0 +1,25 @@
+export interface AddressProvinceOption {
+    /** Province code, e.g. `QC`. This is what goes in the address's `state`. */
+    code: string;
+    /** In the requested locale where we have it (English or French). */
+    name: string;
+}
+export interface AddressCountryOption {
+    /** ISO 3166-1 alpha-2, e.g. `CA`. This is what goes in the address's `country`. */
+    code: string;
+    name: string;
+    /** Empty when the country has no province list; the form then shows a free text field. */
+    provinces: AddressProvinceOption[];
+}
+export interface GetAddressOptionsParams {
+    /** BCP 47 locale for the names, e.g. `fr-CA`. Defaults to `en`. */
+    locale?: string;
+}
+export interface GetAddressOptionsResponse {
+    /** Sorted by name in the requested locale. */
+    countries: AddressCountryOption[];
+    /** The store's own country, to preselect. Null when it isn't known. */
+    defaultCountry: string | null;
+    timestamp: string;
+}
+export type GetAddressOptions = (params?: GetAddressOptionsParams) => Promise<GetAddressOptionsResponse>;

package/dist/actions/get-address-options/types.js

@@ -0,0 +1,8 @@
+// Get Address Options Types
+//
+// What an address form offers: countries, and the provinces of the countries that
+// have them (Canada today). A flow renders these as dropdowns and keeps no list of
+// its own, so what the shopper picks is always a code the shipping rules match.
+//
+// Served by the till and by the storefront runtime.
+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-shipping-options/action.d.ts

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

package/dist/actions/get-shipping-options/action.js

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

package/dist/actions/get-shipping-options/mock.d.ts

@@ -0,0 +1,3 @@
+import type { GetShippingOptions } from './types';
+/** Standalone mock: the demo store's zones run through the real resolver, as the website would. */
+export declare const mockGetShippingOptions: GetShippingOptions;

package/dist/actions/get-shipping-options/mock.js

@@ -0,0 +1,15 @@
+import { MOCK_SHIPPING_ZONES, mockShippingOptions } from '../../demo/shipping';
+/** Standalone mock: the demo store's zones run through the real resolver, as the website would. */
+export const mockGetShippingOptions = async () => {
+    console.log('[Mock] getShippingOptions called');
+    const { resolution, options } = mockShippingOptions();
+    const message = resolution.message ??
+        (options.length === 0 && resolution.reason === 'NO_COVERAGE' ? 'Sorry, we only ship within Canada.' : null);
+    return {
+        required: MOCK_SHIPPING_ZONES.length > 0,
+        options,
+        reason: resolution.reason,
+        message,
+        timestamp: new Date().toISOString(),
+    };
+};

package/dist/actions/get-shipping-options/types.d.ts

@@ -0,0 +1,43 @@
+import type { ShippingNoOptionReason, ShippingOptionType } from '@final-commerce/common';
+export interface ShippingPickupView {
+    outletId: string;
+    /** The store's name, e.g. "Duckworth Street". */
+    name: string;
+    /** One line per open day, e.g. "Mon–Fri 9:00 AM – 6:00 PM". Empty when the store set no hours. */
+    hours: string[];
+}
+export interface ShippingOptionView {
+    optionId: string;
+    type: ShippingOptionType | `${ShippingOptionType}`;
+    /** "Standard shipping", or "Pickup at Duckworth Street". */
+    name: string;
+    /** What this option costs on this cart, minor units, before its tax. */
+    amount: number;
+    /** "$10.00" or "Free". */
+    priceText: string;
+    /** "Add $20.00 more for free shipping", when a free-shipping line exists and isn't reached. */
+    freeShippingHint: string | null;
+    /** "Arrives Tue, Oct 20 – Fri, Oct 23", counted in business days from today. Null for pickup. */
+    arrivalText: string | null;
+    pickup: ShippingPickupView | null;
+    /** The option on the cart now. The cheapest is chosen by default. */
+    selected: boolean;
+}
+export interface GetShippingOptionsResponse {
+    /**
+     * False when this store doesn't ship at all (no shipping set up) or the cart has
+     * nothing to ship: show no shipping step.
+     */
+    required: boolean;
+    /** Ship options cheapest first, then pickups. */
+    options: ShippingOptionView[];
+    /** Why there is nothing to choose; null when `options` isn't empty. */
+    reason: ShippingNoOptionReason | `${ShippingNoOptionReason}` | null;
+    /**
+     * What to tell the customer: the store's "we don't ship here" message, or the
+     * default for the reason ("Sorry, we only ship within Canada."). Null when there are options.
+     */
+    message: string | null;
+    timestamp: string;
+}
+export type GetShippingOptions = () => Promise<GetShippingOptionsResponse>;

package/dist/actions/get-shipping-options/types.js

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

package/dist/actions/select-shipping-option/action.d.ts

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

package/dist/actions/select-shipping-option/action.js

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

package/dist/actions/select-shipping-option/mock.d.ts

@@ -0,0 +1,3 @@
+import type { SelectShippingOption } from './types';
+/** Standalone mock: refuses an option the cart isn't offered, like the runtime does. */
+export declare const mockSelectShippingOption: SelectShippingOption;

package/dist/actions/select-shipping-option/mock.js

@@ -0,0 +1,31 @@
+import { MOCK_CART, mockPublishEvent } from '../../demo/database';
+import { mockShippingOptions } from '../../demo/shipping';
+/** Standalone mock: refuses an option the cart isn't offered, like the runtime does. */
+export const mockSelectShippingOption = async (params) => {
+    console.log('[Mock] selectShippingOption called', params);
+    if (!params)
+        throw new Error('Params required');
+    const previous = MOCK_CART.shippingTotal ?? 0;
+    if (params.optionId === null) {
+        MOCK_CART.shipping = null;
+    }
+    else {
+        const option = mockShippingOptions().resolution.options.find((o) => o.optionId === params.optionId);
+        if (!option)
+            throw new Error('selectShippingOption: this option is not offered for this cart');
+        MOCK_CART.shipping = {
+            zoneId: option.zoneId,
+            optionId: option.optionId,
+            type: option.type,
+            name: option.name,
+            amount: option.amount,
+            minDays: option.minDays,
+            maxDays: option.maxDays,
+            outletId: option.outletId,
+        };
+    }
+    MOCK_CART.shippingTotal = MOCK_CART.shipping?.amount ?? 0;
+    MOCK_CART.total += MOCK_CART.shippingTotal - previous;
+    mockPublishEvent('cart', 'cart-updated', { shipping: MOCK_CART.shipping });
+    return { shipping: MOCK_CART.shipping, cart: MOCK_CART, timestamp: new Date().toISOString() };
+};

package/dist/actions/select-shipping-option/types.d.ts

@@ -0,0 +1,15 @@
+import type { CFActiveCart, CFCartShipping } from '../../CommonTypes';
+export interface SelectShippingOptionParams {
+    /** An `optionId` from `getShippingOptions`. `null` takes shipping off the cart. */
+    optionId: string | null;
+}
+export interface SelectShippingOptionResponse {
+    shipping: CFCartShipping | null;
+    cart: CFActiveCart;
+    timestamp: string;
+}
+/**
+ * THROWS for an option this cart isn't offered: one from another address, a
+ * website-only option at the till, or one the store has since removed.
+ */
+export type SelectShippingOption = (params: SelectShippingOptionParams) => Promise<SelectShippingOptionResponse>;

package/dist/actions/select-shipping-option/types.js

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

package/dist/actions/set-order-address/action.d.ts

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

package/dist/actions/set-order-address/action.js

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

package/dist/actions/set-order-address/mock.d.ts

@@ -0,0 +1,7 @@
+import type { SetOrderAddress } from './types';
+/**
+ * Standalone mock of putting an address on the cart. It refuses what the runtime refuses (no
+ * country, an unreadable one, a shipping address without street and city) so a checkout form
+ * that looks finished in preview doesn't lose orders on the published site.
+ */
+export declare const mockSetOrderAddress: SetOrderAddress;

package/dist/actions/set-order-address/mock.js

@@ -0,0 +1,29 @@
+import { normalizeAddress } from '@final-commerce/common';
+import { MOCK_CART, mockPublishEvent } from '../../demo/database';
+/**
+ * Standalone mock of putting an address on the cart. It refuses what the runtime refuses (no
+ * country, an unreadable one, a shipping address without street and city) so a checkout form
+ * that looks finished in preview doesn't lose orders on the published site.
+ */
+export const mockSetOrderAddress = async (params) => {
+    console.log('[Mock] setOrderAddress called', params);
+    if (!params || (params.type !== 'shipping' && params.type !== 'billing')) {
+        throw new Error("setOrderAddress: type must be 'shipping' or 'billing'");
+    }
+    const key = params.type === 'shipping' ? 'shippingAddress' : 'billingAddress';
+    let address = params.address;
+    if (address) {
+        const read = normalizeAddress(address);
+        if (!read.country)
+            throw new Error('setOrderAddress: choose a country');
+        if (params.type === 'shipping' && (!address.address1?.trim() || !address.city?.trim())) {
+            throw new Error('setOrderAddress: a shipping address needs a street and a city');
+        }
+        address = { ...address, country: read.country, state: read.province ?? address.state, fromCustomer: false };
+    }
+    MOCK_CART[key] = address;
+    if (params.type === 'shipping')
+        MOCK_CART.shipping = null;
+    mockPublishEvent('cart', 'cart-updated', { [key]: address });
+    return { address, cart: MOCK_CART, timestamp: new Date().toISOString() };
+};

package/dist/actions/set-order-address/types.d.ts

@@ -0,0 +1,19 @@
+import type { CFActiveCart, CFCartAddress } from '../../CommonTypes';
+export type OrderAddressType = 'shipping' | 'billing';
+export interface SetOrderAddressParams {
+    type: OrderAddressType;
+    /** `null` clears it. Country and province may be codes or names; the runtime stores codes. */
+    address: CFCartAddress | null;
+}
+export interface SetOrderAddressResponse {
+    /** As stored: country as ISO-2, province as its code, postal code tidied. */
+    address: CFCartAddress | null;
+    /** The cart after the change. A new shipping address re-checks the chosen shipping option. */
+    cart: CFActiveCart;
+    timestamp: string;
+}
+/**
+ * THROWS when the address can't be used: no country, a country we can't read, or a
+ * shipping address without a street and city. The message says which, for the form.
+ */
+export type SetOrderAddress = (params: SetOrderAddressParams) => Promise<SetOrderAddressResponse>;

package/dist/actions/set-order-address/types.js

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

package/dist/demo/shipping.d.ts

@@ -0,0 +1,8 @@
+import { type ShippingZoneRule } from '@final-commerce/common';
+import type { ShippingOptionView } from '../actions/get-shipping-options/types';
+export declare const MOCK_SHIPPING_ZONES: ShippingZoneRule[];
+/** The demo cart's options, shaped like the runtime's answer. The mock runs as the website. */
+export declare function mockShippingOptions(): {
+    resolution: import("@final-commerce/common").ShippingResolution;
+    options: ShippingOptionView[];
+};

package/dist/demo/shipping.js

@@ -0,0 +1,69 @@
+import { resolveShipping } from '@final-commerce/common';
+import { MOCK_CART, MOCK_OUTLET_MAIN } from './database';
+/*
+ * The demo store's Settings › Shipping, so a flow previewed against the mocks meets the real rules
+ * (common's `resolveShipping`) rather than a canned list: Canada $10 (free over $100) or Express,
+ * Quebec at $15, pickup at the demo store, and nowhere else.
+ */
+export const MOCK_SHIPPING_ZONES = [
+    {
+        id: 'zone_canada',
+        kind: 'country',
+        places: [{ country: 'CA' }],
+        ships: true,
+        options: [
+            {
+                id: 'opt_standard',
+                type: 'ship',
+                name: 'Standard shipping',
+                price: 1000,
+                freeOver: 10000,
+                minDays: 3,
+                maxDays: 6,
+                channels: ['web', 'pos'],
+            },
+            { id: 'opt_express', type: 'ship', name: 'Express', price: 2000, minDays: 1, maxDays: 2, channels: ['web'] },
+            { id: 'opt_pickup', type: 'pickup', price: 0, channels: ['web'], outletId: MOCK_OUTLET_MAIN.id },
+        ],
+    },
+    {
+        id: 'zone_quebec',
+        kind: 'province',
+        places: [{ country: 'CA', province: 'QC' }],
+        ships: true,
+        options: [
+            {
+                id: 'opt_quebec',
+                type: 'ship',
+                name: 'Standard shipping',
+                price: 1500,
+                minDays: 4,
+                maxDays: 7,
+                channels: ['web', 'pos'],
+            },
+        ],
+    },
+];
+const STORE_NAME = MOCK_OUTLET_MAIN.name ?? 'the store';
+const money = (amount) => (amount === 0 ? 'Free' : `$${(amount / 100).toFixed(2)}`);
+/** The demo cart's options, shaped like the runtime's answer. The mock runs as the website. */
+export function mockShippingOptions() {
+    const resolution = resolveShipping({
+        zones: MOCK_SHIPPING_ZONES,
+        address: MOCK_CART.shippingAddress,
+        itemsTotal: MOCK_CART.subtotal,
+        channel: 'web',
+    });
+    const options = resolution.options.map((option) => ({
+        optionId: option.optionId,
+        type: option.type,
+        name: option.type === 'pickup' ? `Pickup at ${STORE_NAME}` : (option.name ?? ''),
+        amount: option.amount,
+        priceText: money(option.amount),
+        freeShippingHint: option.amountToFree ? `Add ${money(option.amountToFree)} more for free shipping` : null,
+        arrivalText: option.minDays != null ? `Arrives in ${option.minDays}–${option.maxDays} business days` : null,
+        pickup: option.type === 'pickup' ? { outletId: MOCK_OUTLET_MAIN.id, name: STORE_NAME, hours: [] } : null,
+        selected: MOCK_CART.shipping?.optionId === option.optionId,
+    }));
+    return { resolution, options };
+}

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;
@@ -54,6 +55,10 @@ export declare const command: {
     readonly chargeMoto: import(".").ChargeMoto;
     readonly startCheckout: import(".").StartCheckout;
     readonly attachCheckoutContact: import(".").AttachCheckoutContact;
+    readonly getAddressOptions: import(".").GetAddressOptions;
+    readonly setOrderAddress: import(".").SetOrderAddress;
+    readonly getShippingOptions: import(".").GetShippingOptions;
+    readonly selectShippingOption: import(".").SelectShippingOption;
     readonly setOutlet: import(".").SetOutlet;
     readonly resumeCheckout: import(".").ResumeCheckout;
     readonly addCustomerNote: import(".").AddCustomerNote;
@@ -183,7 +188,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';
@@ -202,6 +208,10 @@ export type { CreatePaymentLink, CreatePaymentLinkParams, CreatePaymentLinkRespo
 export type { ChargeMoto, ChargeMotoParams, ChargeMotoResponse, ChargeMotoCardFields, } from './actions/charge-moto/types';
 export type { StartCheckout, StartCheckoutParams, StartCheckoutResponse, StartCheckoutContact, StartCheckoutOrder, } from './actions/start-checkout/types';
 export type { AttachCheckoutContact, AttachCheckoutContactParams, AttachCheckoutContactResponse, } from './actions/attach-checkout-contact/types';
+export type { GetAddressOptions, GetAddressOptionsParams, GetAddressOptionsResponse, AddressCountryOption, AddressProvinceOption, } from './actions/get-address-options/types';
+export type { SetOrderAddress, SetOrderAddressParams, SetOrderAddressResponse, OrderAddressType, } from './actions/set-order-address/types';
+export type { GetShippingOptions, GetShippingOptionsResponse, ShippingOptionView, ShippingPickupView, } from './actions/get-shipping-options/types';
+export type { SelectShippingOption, SelectShippingOptionParams, SelectShippingOptionResponse, } from './actions/select-shipping-option/types';
 export type { SetOutlet, SetOutletParams, SetOutletResponse } from './actions/set-outlet/types';
 export type { ResumeCheckout, ResumeCheckoutParams, ResumeCheckoutResponse, ResumeCheckoutResult, } from './actions/resume-checkout/types';
 export type { AddCustomerNote, AddCustomerNoteParams, AddCustomerNoteResponse, } from './actions/add-customer-note/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';
@@ -54,6 +55,10 @@ import { createPaymentLink } from './actions/create-payment-link/action';
 import { chargeMoto } from './actions/charge-moto/action';
 import { startCheckout } from './actions/start-checkout/action';
 import { attachCheckoutContact } from './actions/attach-checkout-contact/action';
+import { getAddressOptions } from './actions/get-address-options/action';
+import { setOrderAddress } from './actions/set-order-address/action';
+import { getShippingOptions } from './actions/get-shipping-options/action';
+import { selectShippingOption } from './actions/select-shipping-option/action';
 import { setOutlet } from './actions/set-outlet/action';
 import { resumeCheckout } from './actions/resume-checkout/action';
 // Customer Actions
@@ -184,6 +189,7 @@ export const command = {
     getActiveProduct,
     setActiveProduct,
     adjustInventory,
+    getCustomStockActions,
     // Order Actions
     addOrderNote,
     addCartFee,
@@ -204,6 +210,10 @@ export const command = {
     chargeMoto,
     startCheckout,
     attachCheckoutContact,
+    getAddressOptions,
+    setOrderAddress,
+    getShippingOptions,
+    selectShippingOption,
     setOutlet,
     resumeCheckout,
     // Customer Actions

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';
@@ -35,6 +36,10 @@ import { mockCreatePaymentLink } from '../../actions/create-payment-link/mock';
 import { mockChargeMoto } from '../../actions/charge-moto/mock';
 import { mockStartCheckout } from '../../actions/start-checkout/mock';
 import { mockAttachCheckoutContact } from '../../actions/attach-checkout-contact/mock';
+import { mockGetAddressOptions } from '../../actions/get-address-options/mock';
+import { mockSetOrderAddress } from '../../actions/set-order-address/mock';
+import { mockGetShippingOptions } from '../../actions/get-shipping-options/mock';
+import { mockSelectShippingOption } from '../../actions/select-shipping-option/mock';
 import { mockGetOutlets } from '../../actions/get-outlets/mock';
 import { mockSetOutlet } from '../../actions/set-outlet/mock';
 import { mockResumeCheckout } from '../../actions/resume-checkout/mock';
@@ -137,6 +142,7 @@ export const RENDER_MOCKS = {
     removeProductFromCart: mockRemoveProductFromCart,
     updateCartItemQuantity: mockUpdateCartItemQuantity,
     adjustInventory: mockAdjustInventory,
+    getCustomStockActions: mockGetCustomStockActions,
     assignCustomer: mockAssignCustomer,
     authenticateUser: mockAuthenticateUser,
     calculateRefundTotal: mockCalculateRefundTotal,
@@ -146,6 +152,10 @@ export const RENDER_MOCKS = {
     chargeMoto: mockChargeMoto,
     startCheckout: mockStartCheckout,
     attachCheckoutContact: mockAttachCheckoutContact,
+    getAddressOptions: mockGetAddressOptions,
+    setOrderAddress: mockSetOrderAddress,
+    getShippingOptions: mockGetShippingOptions,
+    selectShippingOption: mockSelectShippingOption,
     getOutlets: mockGetOutlets,
     setOutlet: mockSetOutlet,
     resumeCheckout: mockResumeCheckout,

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, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, 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;
@@ -59,6 +60,11 @@ export interface RenderProviderActions {
      */
     startCheckout: StartCheckout;
     attachCheckoutContact: AttachCheckoutContact;
+    /** Shipping, on the till (ship-to) and the website alike. The runtime prices; the flow renders. */
+    getAddressOptions: GetAddressOptions;
+    setOrderAddress: SetOrderAddress;
+    getShippingOptions: GetShippingOptions;
+    selectShippingOption: SelectShippingOption;
     getOutlets: GetOutlets;
     setOutlet: SetOutlet;
     /**

package/package.json

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