@final-commerce/command-frame 0.1.44 → 0.1.47

package/README.md

@@ -61,7 +61,7 @@ const products = await client.getProducts();
 For building applications that run inside the Final Commerce Management Dashboard.
 
 - **[Manage Documentation](./src/projects/manage/README.md)**
-- **Features:** Context information, Dashboard widgets (more coming soon).
+- **Features:** Context, catalog, entities, custom tables, secrets, and optional host-specific commands (navigation, media, tax, branding, notifications) when the dashboard implements them.
 
 ```typescript
 import { ManageClient } from '@final-commerce/command-frame';

package/dist/CommonTypes.d.ts

@@ -1,4 +1,47 @@
 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"
@@ -51,7 +94,7 @@ export interface CFTax {
     id: string;
     name: string;
     percentage: number;
-    amount: string;
+    amount: number;
     taxTableName: string;
     taxTableId: string;
 }
@@ -82,11 +125,11 @@ export interface CFCategory {
 }
 export interface CFProductVariant {
     sku: string;
-    price: string;
-    salePrice: string;
+    price: number;
+    salePrice: number;
     isOnSale: boolean;
     barcode?: string;
-    costPrice?: string;
+    costPrice?: number;
     manageStock: boolean;
     externalId?: string;
     inventory?: CFInventory[];
@@ -121,8 +164,10 @@ export interface CFProduct {
     sku?: string;
     productType: CFProductType;
     variants: CFProductVariant[];
-    minPrice?: string;
-    maxPrice?: string;
+    currency: CurrencyCode;
+    minorUnits: number;
+    minPrice?: number;
+    maxPrice?: number;
     status?: string;
     isDeleted?: boolean;
 }
@@ -172,15 +217,15 @@ export interface CFActiveCustomer extends CFCustomer {
     id?: string;
 }
 export interface CFTip {
-    amount: string;
+    amount: number;
     percentage: number;
 }
 export interface CFSummary {
-    discountTotal: string;
-    shippingTotal?: string | null;
-    total: string;
-    totalTaxes: string;
-    subTotal: string;
+    discountTotal: number;
+    shippingTotal?: number | null;
+    total: number;
+    totalTaxes: number;
+    subTotal: number;
     taxes: CFTax[];
     tip?: CFTip | null;
     isTaxInclusive: boolean;
@@ -189,25 +234,25 @@ export interface CFSummary {
 }
 export interface CFCartDiscountItem {
     label: string;
-    amount: string;
+    amount: number;
     percentage: number;
 }
 export interface CFCartFeeItem {
     id: string;
     label: string;
-    amount: string;
+    amount: number;
     percentage: number;
     taxTableId?: string;
-    tax?: string;
+    tax?: number;
     taxName: string;
 }
 export interface CFTipPayment {
-    amount: string;
+    amount: number;
     tipTo: string;
     percentage: number;
 }
 export interface CFRefundedTipPayment {
-    amount: string;
+    amount: number;
     percentage: number;
     transactionId: string;
     tipTo: string;
@@ -215,11 +260,11 @@ export interface CFRefundedTipPayment {
 export interface CFPaymentMethod {
     transactionId: string;
     paymentType: string;
-    amount: string;
+    amount: number;
     timestamp: string;
     processor: string;
     saleId?: string;
-    change?: string | null;
+    change?: number | null;
     tip?: CFTipPayment | null;
     cashRounding?: number;
     emv?: string | null;
@@ -235,13 +280,13 @@ export interface CFPosDataItem {
 }
 export interface CFDiscountDetail {
     percentage: number;
-    amount: string;
+    amount: number;
     label?: string;
 }
 export interface CFFeeDetail {
     percentage: number;
-    amount: string;
-    tax: string;
+    amount: number;
+    tax: number;
     taxTableId: string;
     label?: string;
 }
@@ -260,12 +305,12 @@ export interface CFLineItem {
     internalId?: string;
     name: string;
     quantity: number;
-    price: string;
+    price: number;
     taxes: CFTax[];
     discount: CFDiscountLineItem;
     fee: CFFeeLineItem;
-    totalTax: string;
-    total: string;
+    totalTax: number;
+    total: number;
     metadata: CFMetadataItem[];
     image: string;
     sku: string;
@@ -279,11 +324,11 @@ export interface CFLineItem {
 export interface CFCustomSale {
     customSaleId: string;
     name: string;
-    price: string;
+    price: number;
     quantity: number;
     applyTaxes: boolean;
-    total: string;
-    totalTax: string;
+    total: number;
+    totalTax: number;
     taxes: CFTax[];
     discount: {
         cartDiscount: CFDiscountDetail;
@@ -300,11 +345,11 @@ export interface CFRefundedLineItem {
     internalId?: string;
     name: string;
     quantity: number;
-    price: string;
+    price: number;
     taxes: CFTax[];
     discount: CFDiscountLineItem;
-    totalTax: string;
-    total: string;
+    totalTax: number;
+    total: number;
     image: string;
     sku: string;
     note?: string;
@@ -323,12 +368,15 @@ export interface CFRefundItem {
     timestamp: string | undefined;
     summary?: CFSummary;
     refundPayment: CFPaymentMethod[];
-    balance?: string;
+    balance?: number;
     receiptId?: string;
-    currency?: string;
+    currency: CurrencyCode;
+    minorUnits: number;
 }
 export interface CFOrder {
     _id: string;
+    currency: CurrencyCode;
+    minorUnits: number;
     receiptId?: string;
     companyId: string;
     externalId: string | null;
@@ -353,7 +401,7 @@ export interface CFOrder {
     /** Gift card / liability purchase lines (not product revenue) */
     nonRevenueItems?: CFNonRevenueItem[];
     refund?: CFRefundItem[];
-    balance: string;
+    balance: number;
     signature?: string | null;
 }
 export interface CFActiveUserRole {
@@ -424,7 +472,6 @@ export interface CFActiveOrder extends CFOrder {
     outlet?: CFActiveOutlet;
     isDeleted?: boolean;
     newOrder?: boolean;
-    currency?: string;
     station?: CFActiveStation;
 }
 export interface CFActiveCustomSales {

package/dist/CommonTypes.js

@@ -1,4 +1,48 @@
 export * from "./common-types";
+export var CurrencyCode;
+(function (CurrencyCode) {
+    CurrencyCode["USD"] = "USD";
+    CurrencyCode["EUR"] = "EUR";
+    CurrencyCode["GBP"] = "GBP";
+    CurrencyCode["CAD"] = "CAD";
+    CurrencyCode["AUD"] = "AUD";
+    CurrencyCode["NZD"] = "NZD";
+    CurrencyCode["CHF"] = "CHF";
+    CurrencyCode["CNY"] = "CNY";
+    CurrencyCode["INR"] = "INR";
+    CurrencyCode["MXN"] = "MXN";
+    CurrencyCode["BRL"] = "BRL";
+    CurrencyCode["ZAR"] = "ZAR";
+    CurrencyCode["SGD"] = "SGD";
+    CurrencyCode["HKD"] = "HKD";
+    CurrencyCode["SEK"] = "SEK";
+    CurrencyCode["NOK"] = "NOK";
+    CurrencyCode["DKK"] = "DKK";
+    CurrencyCode["PLN"] = "PLN";
+    CurrencyCode["THB"] = "THB";
+    CurrencyCode["MYR"] = "MYR";
+    CurrencyCode["PHP"] = "PHP";
+    CurrencyCode["IDR"] = "IDR";
+    CurrencyCode["AED"] = "AED";
+    CurrencyCode["SAR"] = "SAR";
+    CurrencyCode["ILS"] = "ILS";
+    CurrencyCode["TRY"] = "TRY";
+    CurrencyCode["RUB"] = "RUB";
+    CurrencyCode["JPY"] = "JPY";
+    CurrencyCode["KRW"] = "KRW";
+    CurrencyCode["VND"] = "VND";
+    CurrencyCode["CLP"] = "CLP";
+    CurrencyCode["ISK"] = "ISK";
+    CurrencyCode["HUF"] = "HUF";
+    CurrencyCode["TWD"] = "TWD";
+    CurrencyCode["KWD"] = "KWD";
+    CurrencyCode["BHD"] = "BHD";
+    CurrencyCode["OMR"] = "OMR";
+    CurrencyCode["JOD"] = "JOD";
+    CurrencyCode["TND"] = "TND";
+    CurrencyCode["LYD"] = "LYD";
+    CurrencyCode["IQD"] = "IQD";
+})(CurrencyCode || (CurrencyCode = {}));
 // Enums
 export var CFProductType;
 (function (CFProductType) {

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

@@ -1,10 +1,12 @@
-import { CFProductType } from "../../CommonTypes";
+import { CFProductType, CurrencyCode } from "../../CommonTypes";
 export const mockAddProduct = async (params) => {
     console.log("[Mock] addProduct called", params);
     const hasVariants = params.variants && params.variants.length > 0;
     return {
         product: {
             _id: "mock_product_" + Date.now(),
+            currency: CurrencyCode.USD,
+            minorUnits: 2,
             name: params.name,
             description: params.description,
             categories: params.categories || [],
@@ -14,15 +16,15 @@ export const mockAddProduct = async (params) => {
             sku: params.sku,
             productType: hasVariants ? CFProductType.VARIABLE : CFProductType.SIMPLE,
             attributes: [],
-            minPrice: params.price || "0",
-            maxPrice: params.price || "0",
+            minPrice: params.price || 0,
+            maxPrice: params.price || 0,
             variants: hasVariants
                 ? params.variants.map((v, i) => ({ ...v, _id: `mock_variant_${Date.now()}_${i}` }))
                 : [{
                         _id: `mock_variant_${Date.now()}_0`,
                         sku: params.sku || "",
-                        price: params.price || "0",
-                        salePrice: "0",
+                        price: params.price || 0,
+                        salePrice: 0,
                         isOnSale: false,
                         manageStock: params.manageStock || false,
                         attributes: [],

package/dist/actions/add-product/types.d.ts

@@ -7,9 +7,9 @@ export interface AddProductParams {
     images?: string[];
     status?: 'active' | 'inactive';
     /** For simple products: set price directly */
-    price?: string;
+    price?: number;
     sku?: string;
-    costPrice?: string;
+    costPrice?: number;
     manageStock?: boolean;
     /** For variable products: provide variants array */
     variants?: Omit<CFProductVariant, '_id'>[];

package/dist/actions/edit-product/mock.js

@@ -1,9 +1,11 @@
-import { CFProductType } from "../../CommonTypes";
+import { CFProductType, CurrencyCode } from "../../CommonTypes";
 export const mockEditProduct = async (params) => {
     console.log("[Mock] editProduct called", params);
     return {
         product: {
             _id: params.productId,
+            currency: CurrencyCode.USD,
+            minorUnits: 2,
             name: params.changes.name || "Updated Product",
             description: params.changes.description,
             categories: params.changes.categories || [],

package/dist/actions/get-branding/action.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get branding action — current theme tokens from the Manage host.
+ */
+import type { GetBranding } from "./types";
+export declare const getBranding: GetBranding;

package/dist/actions/get-branding/action.js

@@ -0,0 +1,7 @@
+/**
+ * Get branding action — current theme tokens from the Manage host.
+ */
+import { commandFrameClient } from "../../client";
+export const getBranding = async () => {
+    return await commandFrameClient.call("getBranding");
+};

package/dist/actions/get-branding/mock.d.ts

@@ -0,0 +1,2 @@
+import { GetBranding } from "./types";
+export declare const mockGetBranding: GetBranding;

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

@@ -0,0 +1,24 @@
+export const mockGetBranding = async () => {
+    console.log("[Mock] getBranding called");
+    return {
+        theme: "light",
+        colors: {
+            primary: "#2563eb",
+            secondary: "#64748b",
+            accent: "#0ea5e9",
+            destructive: "#dc2626",
+            sidebar: "#1e293b",
+            background: "#ffffff",
+            foreground: "#0f172a",
+            muted: "#f1f5f9",
+            border: "#e2e8f0"
+        },
+        borderRadius: "round",
+        borderRadiusValue: "0.5rem",
+        font: {
+            family: "system-ui, sans-serif"
+        },
+        logo: null,
+        timestamp: new Date().toISOString()
+    };
+};

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

@@ -0,0 +1,23 @@
+export type BorderRadiusPreset = "sharp" | "soft" | "round" | "pill";
+export interface GetBrandingResponse {
+    theme: "light" | "dark";
+    colors: {
+        primary: string;
+        secondary: string;
+        accent: string;
+        destructive: string;
+        sidebar: string;
+        background: string;
+        foreground: string;
+        muted: string;
+        border: string;
+    };
+    borderRadius: BorderRadiusPreset;
+    borderRadiusValue: string;
+    font: {
+        family: string;
+    };
+    logo: string | null;
+    timestamp: string;
+}
+export type GetBranding = () => Promise<GetBrandingResponse>;

package/dist/actions/get-branding/types.js

@@ -0,0 +1,2 @@
+// Get Branding Types (Manage host extension)
+export {};

package/dist/actions/get-current-company-custom-extensions/mock.js

@@ -14,7 +14,7 @@ export const mockGetCurrentCompanyCustomExtensions = async (params) => {
                 "https://example.com/images/loyalty-1.png",
                 "https://example.com/images/loyalty-2.png"
             ],
-            price: "$29.99",
+            price: 2999,
             website: "https://loyalty-extension.example.com",
             isDeleted: false,
             createdAt: "2024-01-01T10:00:00.000Z",
@@ -29,7 +29,7 @@ export const mockGetCurrentCompanyCustomExtensions = async (params) => {
             short_description: "Real-time inventory insights",
             long_description: "Get detailed insights into your inventory with real-time tracking, low stock alerts, and comprehensive reporting.",
             main_image: "https://example.com/images/inventory-extension.png",
-            price: "$49.99",
+            price: 4999,
             isDeleted: false,
             createdAt: "2024-01-05T08:00:00.000Z",
             updatedAt: "2024-01-05T08:00:00.000Z",

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

@@ -14,7 +14,7 @@ export const mockGetCustomExtensions = async () => {
                 "https://example.com/images/loyalty-1.png",
                 "https://example.com/images/loyalty-2.png"
             ],
-            price: "$29.99",
+            price: 2999,
             website: "https://loyalty-extension.example.com",
             isDeleted: false,
             createdAt: "2024-01-01T10:00:00.000Z",
@@ -29,7 +29,7 @@ export const mockGetCustomExtensions = async () => {
             short_description: "Real-time inventory insights",
             long_description: "Get detailed insights into your inventory with real-time tracking, low stock alerts, and comprehensive reporting.",
             main_image: "https://example.com/images/inventory-extension.png",
-            price: "$49.99",
+            price: 4999,
             isDeleted: false,
             createdAt: "2024-01-05T08:00:00.000Z",
             updatedAt: "2024-01-05T08:00:00.000Z",

package/dist/actions/get-media/action.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get media action — list media library items from the Manage host.
+ */
+import type { GetMedia } from "./types";
+export declare const getMedia: GetMedia;

package/dist/actions/get-media/action.js

@@ -0,0 +1,7 @@
+/**
+ * Get media action — list media library items from the Manage host.
+ */
+import { commandFrameClient } from "../../client";
+export const getMedia = async (params) => {
+    return await commandFrameClient.call("getMedia", params);
+};

package/dist/actions/get-media/mock.d.ts

@@ -0,0 +1,2 @@
+import { GetMedia } from "./types";
+export declare const mockGetMedia: GetMedia;

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

@@ -0,0 +1,35 @@
+const now = new Date().toISOString();
+export const mockGetMedia = async (params) => {
+    console.log("[Mock] getMedia called", params);
+    const items = [
+        {
+            _id: "mock_media_1",
+            url: "https://example.com/media/photo1.jpg",
+            filename: "photo1.jpg",
+            mimeType: "image/jpeg",
+            size: 102400,
+            folder: "images",
+            title: "Sample photo",
+            alt: "Sample",
+            width: 800,
+            height: 600,
+            createdAt: now
+        },
+        {
+            _id: "mock_media_2",
+            url: "https://example.com/media/doc.pdf",
+            filename: "doc.pdf",
+            mimeType: "application/pdf",
+            size: 51200,
+            folder: "documents",
+            createdAt: now
+        }
+    ];
+    return {
+        items,
+        total: items.length,
+        page: params?.page ?? 1,
+        pageSize: params?.pageSize ?? 20,
+        timestamp: new Date().toISOString()
+    };
+};

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

@@ -0,0 +1,30 @@
+export interface GetMediaParams {
+    search?: string;
+    mimeType?: string[];
+    folder?: string;
+    page?: number;
+    pageSize?: number;
+    sortBy?: "createdAt" | "filename" | "size" | "title";
+    sortDir?: "asc" | "desc";
+}
+export interface MediaItemPayload {
+    _id: string;
+    url: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    folder: string;
+    title?: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    createdAt: string;
+}
+export interface GetMediaResponse {
+    items: MediaItemPayload[];
+    total: number;
+    page: number;
+    pageSize: number;
+    timestamp: string;
+}
+export type GetMedia = (params?: GetMediaParams) => Promise<GetMediaResponse>;

package/dist/actions/get-media/types.js

@@ -0,0 +1,2 @@
+// Get Media Types (Manage host extension)
+export {};

package/dist/actions/get-tax-tables/action.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Get tax tables action — list tax tables for the company.
+ */
+import type { GetTaxTables } from "./types";
+export declare const getTaxTables: GetTaxTables;

package/dist/actions/get-tax-tables/action.js

@@ -0,0 +1,7 @@
+/**
+ * Get tax tables action — list tax tables for the company.
+ */
+import { commandFrameClient } from "../../client";
+export const getTaxTables = async () => {
+    return await commandFrameClient.call("getTaxTables");
+};

package/dist/actions/get-tax-tables/mock.d.ts

@@ -0,0 +1,2 @@
+import { GetTaxTables } from "./types";
+export declare const mockGetTaxTables: GetTaxTables;

package/dist/actions/get-tax-tables/mock.js

@@ -0,0 +1,21 @@
+export const mockGetTaxTables = async () => {
+    console.log("[Mock] getTaxTables called");
+    return {
+        taxTables: [
+            {
+                _id: "mock_table_1",
+                name: "Standard",
+                rates: [
+                    { _id: "mock_rate_1", name: "GST", isCompounding: false },
+                    { _id: "mock_rate_2", name: "PST", isCompounding: true }
+                ]
+            },
+            {
+                _id: "mock_table_2",
+                name: "Zero",
+                rates: [{ _id: "mock_rate_3", name: "Zero rated", isCompounding: false }]
+            }
+        ],
+        timestamp: new Date().toISOString()
+    };
+};

package/dist/actions/get-tax-tables/types.d.ts

@@ -0,0 +1,15 @@
+export interface TaxRatePayload {
+    _id: string;
+    name: string;
+    isCompounding: boolean;
+}
+export interface TaxTablePayload {
+    _id: string;
+    name: string;
+    rates: TaxRatePayload[];
+}
+export interface GetTaxTablesResponse {
+    taxTables: TaxTablePayload[];
+    timestamp: string;
+}
+export type GetTaxTables = () => Promise<GetTaxTablesResponse>;

package/dist/actions/get-tax-tables/types.js

@@ -0,0 +1,2 @@
+// Get Tax Tables Types (Manage host extension)
+export {};

package/dist/actions/navigate-to/action.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Navigate to action — SPA navigation in the Manage host.
+ */
+import type { NavigateTo } from "./types";
+export declare const navigateTo: NavigateTo;

package/dist/actions/navigate-to/action.js

@@ -0,0 +1,7 @@
+/**
+ * Navigate to action — SPA navigation in the Manage host.
+ */
+import { commandFrameClient } from "../../client";
+export const navigateTo = async (params) => {
+    return await commandFrameClient.call("navigateTo", params);
+};

package/dist/actions/navigate-to/mock.d.ts

@@ -0,0 +1,2 @@
+import { NavigateTo } from "./types";
+export declare const mockNavigateTo: NavigateTo;

package/dist/actions/navigate-to/mock.js

@@ -0,0 +1,7 @@
+export const mockNavigateTo = async (params) => {
+    console.log("[Mock] navigateTo called", params.path);
+    return {
+        success: true,
+        timestamp: new Date().toISOString()
+    };
+};