@final-commerce/command-frame 0.2.0-beta.6 → 0.3.0-beta.3

package/dist/CommonTypes.d.ts

@@ -1,557 +1,78 @@
 export * from "./common-types";
-export declare enum CurrencyCode {
-    USD = "USD",
-    EUR = "EUR",
-    GBP = "GBP",
-    CAD = "CAD",
-    AUD = "AUD",
-    NZD = "NZD",
-    CHF = "CHF",
-    CNY = "CNY",
-    INR = "INR",
-    MXN = "MXN",
-    BRL = "BRL",
-    ZAR = "ZAR",
-    SGD = "SGD",
-    HKD = "HKD",
-    SEK = "SEK",
-    NOK = "NOK",
-    DKK = "DKK",
-    PLN = "PLN",
-    THB = "THB",
-    MYR = "MYR",
-    PHP = "PHP",
-    IDR = "IDR",
-    AED = "AED",
-    SAR = "SAR",
-    ILS = "ILS",
-    TRY = "TRY",
-    RUB = "RUB",
-    JPY = "JPY",
-    KRW = "KRW",
-    VND = "VND",
-    CLP = "CLP",
-    ISK = "ISK",
-    HUF = "HUF",
-    TWD = "TWD",
-    KWD = "KWD",
-    BHD = "BHD",
-    OMR = "OMR",
-    JOD = "JOD",
-    TND = "TND",
-    LYD = "LYD",
-    IQD = "IQD"
-}
-export declare enum CFProductType {
-    SIMPLE = "simple",
-    VARIABLE = "variable"
-}
-export declare enum CFUserTypes {
-    OWNER = "owner",
-    ORG_USER = "organization_user",
-    ORG_OWNER = "organization_owner",
-    FINAL_USER = "final_user",
-    FINAL_OWNER = "final_owner",
-    EMPLOYEE = "employee",
-    SUPER_ADMIN = "super_admin",
-    MANAGER = "manager",
-    ADMIN = "admin",
-    ASSISTANT_MANAGER = "assistant",
-    CASHIER = "cashier",
-    RESELLER = "reseller"
-}
+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, CustomerNote, Attribute, AttributeOption, Category, Transaction } 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>;
-export interface CFDiscount {
-    value: number;
-    label?: string;
-    isPercent?: boolean;
-}
-export interface CFCustomFee {
-    label: string;
-    amount: number;
-    isPercent: boolean;
-    applyTaxes: boolean;
-    taxTableId?: string;
-}
-export interface CFAddress {
-    firstName: string;
-    lastName: string;
-    company?: string | null;
-    city: string;
-    postCode: string;
-    province?: string;
-    state?: string;
-    country?: string;
-    address1: string;
-    address2: string;
-}
-export interface CFMetadataItem {
-    key: string;
-    value: string;
-}
-export interface CFTax {
-    id: string;
-    name: string;
-    percentage: number;
-    amount: number;
-    taxTableName: string;
-    taxTableId: string;
-    /** Whether this tax compounds on top of others. */
-    compounding?: boolean;
-    /** Application order; lower numbers apply first. */
-    priority?: number;
-}
-/** Per-rate tax entry on a cart fee (gst, hst, etc.). Same shape as `CFTax`; declared
- *  separately to match the host's distinct `CartFeeTaxEntry` type. */
-export interface CFCartFeeTaxEntry {
-    id: string;
-    name: string;
-    percentage: number;
-    amount: number;
-    taxTableId: string;
-    taxTableName: string;
-    compounding?: boolean;
-    priority?: number;
-}
-export interface CFInventory {
-    /** Warehouse identifier the stock is held at. */
-    warehouse: string;
-    outletId: string;
-    stock?: number | null;
-    _id?: string;
-}
-export interface CFCustomerNote {
-    _id?: string;
-    createdAt: string;
-    message: string;
-}
-export interface CFOrderNote {
-    externalId?: string;
-    author?: string;
-    note?: string;
-    customerNote?: boolean;
-    addedByUser?: string;
-    dateCreated?: string;
-}
-export interface CFAttributeOption {
-    name: string;
-    order?: number;
-}
-export interface CFAttribute {
-    _id: string;
-    companyId?: string;
-    optionName: string;
-    sortingOrder: number;
-    options: CFAttributeOption[];
-}
-export interface CFTransaction {
-    _id: string;
-    companyId?: string;
-    orderId?: string;
-    amount: number;
-    currency?: string;
-    status?: string;
-    paymentMethod?: string;
-    createdAt?: string;
-    updatedAt?: string;
-    [key: string]: unknown;
-}
-export interface CFCategory {
-    _id: string;
-    companyId: string;
-    externalId: string;
-    name: string;
-    parentId: null | string;
-    __v?: number;
-}
-export interface CFProductVariant {
-    sku: string;
-    price: number;
-    salePrice: number;
-    isOnSale: boolean;
-    barcode?: string;
-    costPrice?: number;
-    manageStock: boolean;
-    /** External variant identifier — required by host. */
-    externalId: string;
-    inventory?: CFInventory[];
-    allowBackorder?: boolean;
-    images?: string[];
-    attributes: {
-        name: string;
-        value?: string;
-    }[];
-    metadata?: {
-        key: string;
-        value: string;
-    }[];
-    _id: string;
-    isDeleted?: boolean;
-    currency?: CurrencyCode;
-    minorUnits?: number;
-}
-export interface CFProduct {
-    _id: string;
-    companyId?: string;
-    /** External product identifier — required by host. */
-    externalId: string;
-    taxTable: string;
-    name: string;
-    description?: string;
-    shortDescription?: string;
-    images?: string[];
-    categories: string[];
-    attributes: {
-        name: string;
-        values: string[];
-    }[];
-    tags?: string[];
-    supplier?: string;
-    sku?: string;
-    productType: CFProductType;
-    variants: CFProductVariant[];
-    currency: CurrencyCode;
-    minorUnits: number;
-    minPrice?: number;
-    maxPrice?: number;
-    /** Catalog-level price (rare; usually only on simple products). */
-    price?: number;
-    status?: string;
-    isDeleted?: boolean;
-    createdAt?: string;
-    updatedAt?: string;
-}
-export interface CFActiveProduct extends CFActiveEntity {
-    id: string;
-    internalId: string;
-    externalId: string;
-    productExternalId: string;
-    variantId: string;
-    name: string;
-    sku: string;
-    price: number;
-    images: string[];
-    taxTableId: string;
-    quantity: number;
-    note?: string;
-    discount?: CFDiscount;
-    description?: string;
-    longDescription?: string;
-    shortDescription?: string;
-    barcodeId?: string;
-    stock: number;
-    allowBackOrder?: boolean;
-    fee?: CFCustomFee;
-    isUnlimited?: boolean;
-    attributes?: string;
-    localQuantity?: number;
-    /** Mongo-style id when the active product retains the catalog `_id`. */
-    _id?: string;
-    productType?: CFProductType;
-    /** Currency code for the line price. */
-    currency?: CurrencyCode;
-    /** Number of minor units (decimal places) for the line currency. */
-    minorUnits?: number;
-}
-export interface CFCustomer {
-    _id: string;
-    companyId: string;
-    externalId?: string;
-    email: string;
-    firstName: string;
-    lastName: string;
-    fromOliver?: boolean;
-    phone?: string;
-    tags?: string[];
-    metadata?: Record<string, string>[];
-    notes?: CFCustomerNote[];
-    billing: CFAddress | null;
-    shipping: CFAddress | null;
-    createdAt?: string;
-    updatedAt?: string;
-}
-export interface CFActiveCustomer extends CFCustomer {
-    id?: string;
-}
-export interface CFTip {
-    amount: number;
-    percentage: number;
-}
-export interface CFSummary {
-    discountTotal: number;
-    shippingTotal?: number | null;
-    total: number;
-    totalTaxes: number;
-    subTotal: number;
-    taxes: CFTax[];
-    tip?: CFTip | null;
-    isTaxInclusive: boolean;
-    /** Portion of order total that is non-revenue (e.g. gift card load), same string money format as `total` */
-    nonRevenueTotal?: string;
-}
-export interface CFCartDiscountItem {
-    label: string;
-    amount: number;
-    percentage: number;
-}
-export interface CFCartFeeItem {
-    id: string;
-    label: string;
-    amount: number;
-    percentage: number;
-    taxTableId?: string;
-    tax?: number;
-    taxName: string;
-    /** Per-rate breakdown so summary/refund views can show correct amounts per rate. */
-    taxes?: CFCartFeeTaxEntry[];
-}
-export interface CFTipPayment {
-    amount: number;
-    tipTo: string;
-    percentage: number;
-}
-export interface CFRefundedTipPayment {
-    amount: number;
-    percentage: number;
-    transactionId: string;
-    tipTo: string;
-}
-export interface CFPaymentMethod {
-    transactionId: string;
-    paymentType: string;
-    amount: number;
-    timestamp: string;
-    processor: string;
-    saleId?: string;
-    change?: number | null;
-    tip?: CFTipPayment | null;
-    cashRounding?: number;
-    emv?: string | null;
-    /** Processor fee charged on this payment. */
-    processorFee?: number | null;
-}
-export interface CFPosDataItem {
-    outlet: string;
-    station: string;
-    employee: string | {
-        _id?: string;
-        firstName: string;
-        lastName: string;
-    };
-}
-export interface CFDiscountDetail {
-    percentage: number;
-    amount: number;
-    label?: string;
-}
-export interface CFFeeDetail {
-    percentage: number;
-    amount: number;
-    tax: number;
-    taxTableId: string;
-    label?: string;
-}
-export interface CFDiscountLineItem {
-    itemDiscount: CFDiscountDetail;
-    cartDiscount: CFDiscountDetail;
-}
-export interface CFFeeLineItem {
-    itemFee: CFFeeDetail;
-    cartFee?: CFFeeDetail;
-}
-export interface CFLineItem {
-    productId: string;
-    variantExternalId?: string;
-    productExternalId?: string;
-    internalId?: string;
-    name: string;
-    quantity: number;
-    price: number;
-    taxes: CFTax[];
-    discount: CFDiscountLineItem;
-    fee: CFFeeLineItem;
-    totalTax: number;
-    total: number;
-    metadata: CFMetadataItem[];
-    image: string;
-    sku: string;
-    stock: number;
-    note?: string;
-    description?: string;
-    variantId: string;
-    images?: string[];
-    attributes?: string;
-}
-export interface CFCustomSale {
-    customSaleId: string;
-    name: string;
-    price: number;
-    quantity: number;
-    applyTaxes: boolean;
-    total: number;
-    totalTax: number;
-    taxes: CFTax[];
-    discount: {
-        cartDiscount: CFDiscountDetail;
-    };
-    fee: {
-        cartFee: CFFeeDetail;
-    };
-}
-export interface CFRefundedLineItem {
-    productId: string;
-    variantId: string;
-    variantExternalId?: string;
-    productExternalId?: string;
-    internalId?: string;
-    name: string;
-    quantity: number;
-    price: number;
-    taxes: CFTax[];
-    discount: CFDiscountLineItem;
-    totalTax: number;
-    total: number;
-    image: string;
-    sku: string;
-    note?: string;
-    description?: string;
-    images?: string[];
-    fee: CFFeeLineItem;
-}
-export type CFRefundedCustomSale = CFCustomSale;
-export interface CFRefundItem {
-    lineItems: CFRefundedLineItem[];
-    customSales: CFRefundedCustomSale[];
-    cartFees: CFCartFeeItem[];
-    tips: CFRefundedTipPayment[];
-    refundedBy: string;
-    timestamp: string | undefined;
-    summary?: CFSummary;
-    refundPayment: CFPaymentMethod[];
-    balance?: number;
-    receiptId?: string;
-    currency: CurrencyCode;
-    minorUnits: number;
-}
-export interface CFOrder {
-    _id: string;
-    currency: CurrencyCode;
-    minorUnits: number;
-    receiptId?: string;
-    companyId: string;
-    externalId: string | null;
-    status: string;
-    /** Financial state (state machine). Undefined on legacy orders pre-backfill. */
-    paymentState?: string;
-    /** Operational state (state machine). Undefined on legacy orders pre-backfill. */
-    fulfillmentState?: string;
-    /** Computed display label from paymentState + fulfillmentState matrix. */
-    displayState?: string;
-    customer: Partial<CFActiveCustomer | null>;
-    customerNote?: string;
-    summary: CFSummary;
-    cartDiscount: CFCartDiscountItem | null;
-    cartFees: CFCartFeeItem[] | null;
-    updatedAt?: string;
-    createdAt?: string;
-    paymentMethods: CFPaymentMethod[];
-    source: string;
-    posData: CFPosDataItem | null;
-    sessionId: string;
-    metadata: CFMetadataItem[];
-    notes?: CFOrderNote[] | null;
-    billing: CFAddress | null;
-    shipping: CFAddress | null;
-    lineItems: CFLineItem[];
-    customSales: CFCustomSale[];
-    /** Gift card / liability purchase lines (not product revenue) */
-    nonRevenueItems?: CFNonRevenueItem[];
-    refund?: CFRefundItem[];
-    balance: number;
-    signature?: string | null;
-    /** ISO timestamp at which a parked order's stock reservation expires. */
-    parkExpiryDate?: string;
-    /** Park stock-reduction policy (host-defined string flag). */
-    parkReduceStock?: string;
-}
-export interface CFActiveUserRole {
-    id?: string;
-    _id?: string;
-    companyId?: string;
-    name: string;
-    permissions: {
-        category: string;
-        label?: string;
-        name: string;
-        value: boolean;
-        permissionId?: string;
-        subCategory?: string;
-    }[];
-}
-export interface CFActiveUser extends CFActiveEntity {
-    firstName?: string;
-    lastName?: string;
-    email?: string;
-    phone?: string;
-    pincode?: string;
-    role: CFActiveUserRole | {
-        _id: string;
-        name: string;
-    };
-    id: string;
-    _id?: string;
-    outlets?: string[] | {
-        _id: string;
-    }[];
-    type?: CFUserTypes;
-    companies?: unknown;
-}
-export interface CFActiveOutlet extends CFActiveEntity {
-    address: string;
-    address2: string;
-    city: string;
-    state: string;
-    country?: string;
-    taxId: string;
-    postCode?: string;
+export type CFDiscount = Discount;
+export type CFCustomFee = CustomFee;
+export type CFAddress = Address;
+export type CFMetadataItem = MetadataItem;
+export type CFTax = Tax;
+export type CFCartFeeTaxEntry = CartFeeTaxEntry;
+export type CFInventory = Inventory;
+export type CFCustomerNote = CustomerNote;
+export type CFOrderNote = OrderNote;
+export type CFAttributeOption = AttributeOption;
+export type CFAttribute = Attribute;
+export type CFTransaction = Transaction;
+export type CFCategory = Category;
+export type CFProductVariant = ProductVariant;
+export type CFProduct = FullProduct;
+export type CFActiveProduct = ActiveProduct;
+export type CFCustomer = ActiveCustomer;
+export type CFActiveCustomer = ActiveCustomer;
+export type CFTip = Tip;
+export type CFSummary = Summary;
+export type CFCartDiscountItem = CartDiscountItem;
+export type CFCartFeeItem = CartFeeItem;
+export type CFTipPayment = TipPayment;
+export type CFRefundedTipPayment = RefundedTipPayment;
+export type CFPaymentMethod = PaymentMethod;
+export type CFPosDataItem = PosDataItem;
+export type CFDiscountDetail = DiscountDetail;
+export type CFFeeDetail = FeeDetail;
+export type CFDiscountLineItem = DiscountLineItem;
+export type CFFeeLineItem = FeeLineItem;
+export type CFLineItem = LineItem;
+export type CFCustomSale = CustomSale;
+export type CFRefundedLineItem = RefundedLineItem;
+export type CFRefundedCustomSale = RefundedCustomSale;
+export type CFRefundItem = RefundItem;
+export type CFOrder = ActiveOrder;
+export type CFActiveUserRole = ActiveUserRole;
+export type CFActiveUser = ActiveUser;
+export type CFActiveOutlet = ActiveOutlet;
+export type CFActiveStation = ActiveStation;
+export type CFSession = ActiveSession;
+export type CFActiveOrder = ActiveOrder;
+export type CFActiveCustomSales = ActiveCustomSales;
+export type CFNonRevenueItem = NonRevenueItem;
+export type CFActiveCart = ActiveCart;
+export type CFActivePark = ActivePark;
+export type CFActiveCompany = ActiveCompany;
+/** Tile kinds a SmartGrid cell can represent. Mirrors common's `BaseTile['type']`. */
+export type CFTileType = "empty" | "product" | "action" | "category" | "folder" | "back";
+/**
+ * A single positioned cell in a SmartGrid layout. The wire/extension-facing shape
+ * (Render's adapter maps this to/from common's `BaseTile`).
+ */
+export interface CFTileCell {
+    /** Position of the cell within its grid (or folder). */
+    index: number;
+    type: CFTileType;
+    /** Entity id the cell points at (product/category/folder id, action key, …). */
+    entityId?: string;
+    /** Opaque entity payload round-tripped with the cell. */
+    entityData?: Record<string, unknown>;
+}
+/** A builder SmartGrid layout addressed by `gridId`, with optional folder sub-grids. */
+export interface CFSmartGridLayout {
+    gridId: string;
+    cells: CFTileCell[];
+    /** Operator-editable display name for the grid. */
     name?: string;
-    stripe?: {
-        locationId: string;
-    };
-    id: string;
-    sequenceNumber: number;
-    _id?: string;
-    stripeAccountId: string;
-}
-export interface CFActiveStation {
-    _id: string;
-    sequenceNumber?: number;
-    name: string;
-    status: string;
-    buildSrcId?: string;
-    buildVersion?: string;
-    publishBuildId?: string;
-    createdAt?: string;
-    updatedAt?: string;
-    stripeTerminalId?: string;
-    /** Stripe serial-reader identifier when paired. */
-    serialReaderId?: string;
-    /** User id of whoever enrolled the station. */
-    enrolledBy?: string;
-    /** Whether the station is virtual (no physical terminal). */
-    isVirtual?: boolean;
-}
-/** Cash register session (station session), aligned with Render `Session`. */
-export interface CFSession {
-    id: string;
-    stationId: string;
-    openingAmount?: number;
-    closingAmount?: number;
-    openedBy?: string;
-    closedBy?: string;
-    notes?: string[];
-    currency?: CurrencyCode;
-    minorUnits?: number;
+    /** Folder id → its cells. */
+    folders?: Record<string, CFTileCell[]>;
 }
 /** Refund UI / selection state in POS, aligned with Render `ActiveRefundOrder`. */
 export interface CFRefundProcessingStatus {
@@ -574,77 +95,6 @@ export interface CFActiveRefundDetails {
     refundProcessingStatus?: CFRefundProcessingStatus | null;
     sessionRefundedTotal?: number;
 }
-export interface CFActiveOrder extends CFOrder {
-    id?: string;
-    internalId?: string;
-    user?: CFActiveUser;
-    outlet?: CFActiveOutlet;
-    isDeleted?: boolean;
-    newOrder?: boolean;
-    station?: CFActiveStation;
-}
-export interface CFActiveCustomSales {
-    id: string;
-    name: string;
-    applyTaxes: boolean;
-    taxTableId?: string;
-    quantity: number;
-    price: number;
-    discount?: Record<string, unknown>;
-    fee?: Record<string, unknown>;
-}
-/** Non-revenue cart line (e.g. gift card load) — aligned with Render `NonRevenueItem.externalId` (order line id). */
-export interface CFNonRevenueItem {
-    /** Unique cart/order line id (Mongo-style id from host). Extension reference is usually `metadata.refId`. */
-    externalId: string;
-    amount: number | string;
-    label?: string;
-    metadata?: Record<string, unknown>;
-    applyTaxes?: boolean;
-    taxTableId?: string;
-}
-export interface CFActiveCart extends CFActiveEntity {
-    tax?: number;
-    /** Per-rate tax breakdown for the cart. Same shape as line item taxes. */
-    taxes?: CFTax[];
-    total: number;
-    subtotal: number;
-    discount?: CFDiscount;
-    customFee?: CFCustomFee[];
-    products: CFActiveProduct[];
-    customSales?: CFActiveCustomSales[];
-    /** Gift card / liability lines — included in cart total */
-    nonRevenueItems?: CFNonRevenueItem[];
-    remainingBalance?: number;
-    amountToBeCharged: number;
-    customer?: Partial<CFCustomer | null> | null;
-    orderNotes?: string;
-    cartTotal?: number;
-    orderTotal?: number;
-    orderId?: string;
-    /** Currency code for amounts on this cart. */
-    currency?: CurrencyCode;
-    /** Number of minor units (decimal places) for the cart's currency. */
-    minorUnits?: number;
-}
-/** A parked order. Extends `CFActiveCart` with parking-specific fields. */
-export interface CFActivePark extends CFActiveCart {
-    /** Required on parked orders (overrides the optional `orderId` on the parent). */
-    orderId: string;
-    receiptId: string;
-    servedBy: string | {
-        _id?: string;
-        firstName: string;
-        lastName: string;
-    } | undefined;
-    createdAt: string | number;
-}
-export interface CFActiveCompany extends CFActiveEntity {
-    id?: string;
-    name?: string;
-    logo?: string;
-    settings?: Record<string, unknown>;
-}
 export type CFProjectName = "Render" | "Manage";
 export interface CFContextRender {
     userId: string | null;