@final-commerce/command-frame 0.1.61 → 0.1.63

package/README.md

@@ -6,6 +6,8 @@ A TypeScript library for type-safe communication between iframes and their paren
 
 Command Frame provides a structured way to build integrations that run inside Final Commerce applications (like Render POS or Manage Dashboard). It handles the underlying `postMessage` communication while enforcing strict type safety for both the host application (Provider) and the embedded app (Client).
 
+`RenderClient` and `ManageClient` extend `CommandFrameClient`: dynamic methods such as `getProducts()` map to `postMessage` actions named after the method (camelCase), with typed params and responses per project.
+
 The library provides three main capabilities:
 
 | Capability | Purpose | Scope |
@@ -15,6 +17,8 @@ The library provides three main capabilities:
 | **Hooks** | Register business-logic callbacks that persist across all pages | Session-scoped (survives page navigation) |
 | **Host → iframe refunds** | Render asks the extension to reverse redeem / gift-card payments before completing a POS refund | Parent `postMessage` + `requestId` (see below) |
 
+Domain models (orders, cart, customers, products, and related types) are documented in **[Types reference](./src/types/README.md)**.
+
 ## Installation
 
 ### From npm (public registry)
@@ -75,7 +79,7 @@ const context = await client.getContext();
 The pub/sub system allows iframe extensions to subscribe to topics and receive real-time events published by the host (Render). Subscriptions are **page-scoped** -- they fire only while the iframe is mounted on the current page.
 
 - **[Pub/Sub Documentation](./src/pubsub/README.md)**
-- **Topics:** Cart (9), Customers (8), Orders (4), Payments (2), Products (4), Refunds (4), Print (3), Custom Tables (3), Outlet (2), Station (2), Session (2), Users (2).
+- **Topics:** Cart (16), Customers (8), Orders (4), Payments (2), Products (4), Refunds (4), Print (3), Custom Tables (3), Outlet (2), Station (2), Session (2), Users (2).
 
 ```typescript
 import { topics } from '@final-commerce/command-frame';

package/dist/CommonTypes.d.ts

@@ -104,6 +104,7 @@ export interface CFInventory {
     _id?: string;
 }
 export interface CFCustomerNote {
+    _id?: string;
     createdAt: string;
     message: string;
 }

package/dist/actions/add-customer-note/mock.js

@@ -8,6 +8,7 @@ export const mockAddCustomerNote = async (params) => {
                 customer.notes = [];
             }
             customer.notes.push({
+                _id: `mock_note_${Date.now()}_${Math.random().toString(36).slice(2, 11)}`,
                 message: params.note,
                 createdAt: new Date().toISOString()
             });

package/dist/actions/remove-cart-fee/mock.d.ts

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

package/dist/actions/remove-cart-fee/mock.js

@@ -0,0 +1,35 @@
+import { MOCK_CART, mockPublishEvent } from "../../demo/database";
+function feeContributionToTotal(fee, subtotal) {
+    if (fee.isPercent) {
+        return subtotal * (fee.amount / 100);
+    }
+    return fee.amount;
+}
+export const mockRemoveCartFee = (params) => {
+    console.log("[Mock] removeCartFee called", params);
+    const { index } = params;
+    if (typeof index !== "number" || !Number.isInteger(index) || index < 0) {
+        throw new Error("removeCartFee requires a non-negative integer index");
+    }
+    const fees = MOCK_CART.customFee;
+    if (!fees?.length) {
+        throw new Error("Cart has no fees to remove");
+    }
+    if (index >= fees.length) {
+        throw new Error(`Cart fee index ${index} is out of range (0–${fees.length - 1})`);
+    }
+    const removed = fees[index];
+    const delta = feeContributionToTotal(removed, MOCK_CART.subtotal);
+    fees.splice(index, 1);
+    if (fees.length === 0) {
+        MOCK_CART.customFee = undefined;
+    }
+    MOCK_CART.total -= delta;
+    MOCK_CART.amountToBeCharged = MOCK_CART.total;
+    MOCK_CART.remainingBalance = MOCK_CART.total;
+    mockPublishEvent("cart", "cart-fee-removed", { feeIndex: index });
+    return Promise.resolve({
+        success: true,
+        timestamp: new Date().toISOString()
+    });
+};

package/dist/actions/remove-customer-note/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Remove customer note action
+ * Calls the removeCustomerNote action on the parent window
+ */
+import type { RemoveCustomerNote } from "./types";
+export declare const removeCustomerNote: RemoveCustomerNote;

package/dist/actions/remove-customer-note/action.js

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

package/dist/actions/remove-customer-note/mock.d.ts

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

package/dist/actions/remove-customer-note/mock.js

@@ -0,0 +1,13 @@
+export const mockRemoveCustomerNote = async (params) => {
+    console.log("[Mock] removeCustomerNote called", params);
+    const noteId = params?.noteId ?? "";
+    const timestamp = new Date().toISOString();
+    if (!noteId) {
+        return { success: false, noteId, timestamp };
+    }
+    return {
+        success: true,
+        noteId,
+        timestamp
+    };
+};

package/dist/actions/remove-customer-note/types.d.ts

@@ -0,0 +1,9 @@
+export interface RemoveCustomerNoteParams {
+    noteId: string;
+}
+export interface RemoveCustomerNoteResponse {
+    success: boolean;
+    noteId: string;
+    timestamp: string;
+}
+export type RemoveCustomerNote = (params?: RemoveCustomerNoteParams) => Promise<RemoveCustomerNoteResponse>;

package/dist/actions/remove-customer-note/types.js

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

package/dist/index.d.ts

@@ -39,6 +39,7 @@ export declare const command: {
     readonly extensionPayment: import("./actions/extension-payment/types").ExtensionPayment;
     readonly redeemPayment: import("./actions/redeem-payment/types").RedeemPayment;
     readonly addCustomerNote: import("./actions/add-customer-note/types").AddCustomerNote;
+    readonly removeCustomerNote: import("./actions/remove-customer-note/types").RemoveCustomerNote;
     readonly removeCustomerFromCart: import("./actions/remove-customer-from-cart/types").RemoveCustomerFromCart;
     readonly removeCartDiscount: import("./actions/remove-cart-discount/types").RemoveCartDiscount;
     readonly goToStationHome: import("./actions/go-to-station-home/types").GoToStationHome;
@@ -160,6 +161,7 @@ export { EXTENSION_REFUND_REQUEST_ACTION } from "./actions/extension-refund/cons
 export { installExtensionRefundListener } from "./actions/extension-refund/extension-refund-listener";
 export type { ExtensionRefundParams, ExtensionRefundResponse } from "./actions/extension-refund/types";
 export type { AddCustomerNote, AddCustomerNoteParams, AddCustomerNoteResponse } from "./actions/add-customer-note/types";
+export type { RemoveCustomerNote, RemoveCustomerNoteParams, RemoveCustomerNoteResponse } from "./actions/remove-customer-note/types";
 export type { RemoveCustomerFromCart, RemoveCustomerFromCartResponse } from "./actions/remove-customer-from-cart/types";
 export type { RemoveCartDiscount, RemoveCartDiscountResponse } from "./actions/remove-cart-discount/types";
 export type { GoToStationHome, GoToStationHomeResponse } from "./actions/go-to-station-home/types";

package/dist/index.js

@@ -40,6 +40,7 @@ import { extensionPayment } from "./actions/extension-payment/action";
 import { redeemPayment } from "./actions/redeem-payment/action";
 // Customer Actions
 import { addCustomerNote } from "./actions/add-customer-note/action";
+import { removeCustomerNote } from "./actions/remove-customer-note/action";
 import { removeCustomerFromCart } from "./actions/remove-customer-from-cart/action";
 import { removeCartDiscount } from "./actions/remove-cart-discount/action";
 // System Actions
@@ -161,6 +162,7 @@ export const command = {
     redeemPayment,
     // Customer Actions
     addCustomerNote,
+    removeCustomerNote,
     removeCustomerFromCart,
     removeCartDiscount,
     // System Actions

package/dist/projects/render/mocks.js

@@ -1,8 +1,10 @@
 import { mockAddCartDiscount } from "../../actions/add-cart-discount/mock";
 import { mockAddCartFee } from "../../actions/add-cart-fee/mock";
+import { mockRemoveCartFee } from "../../actions/remove-cart-fee/mock";
 import { mockAddCustomSale } from "../../actions/add-custom-sale/mock";
 import { mockAddCustomer } from "../../actions/add-customer/mock";
 import { mockAddCustomerNote } from "../../actions/add-customer-note/mock";
+import { mockRemoveCustomerNote } from "../../actions/remove-customer-note/mock";
 import { mockEditCustomer } from "../../actions/edit-customer/mock";
 import { mockAddOrderNote } from "../../actions/add-order-note/mock";
 import { mockAddProductDiscount } from "../../actions/add-product-discount/mock";
@@ -31,6 +33,7 @@ import { mockGetCustomers } from "../../actions/get-customers/mock";
 import { mockGetOrders } from "../../actions/get-orders/mock";
 import { mockGetProducts } from "../../actions/get-products/mock";
 import { mockGetRefunds } from "../../actions/get-refunds/mock";
+import { mockGetTaxTables } from "../../actions/get-tax-tables/mock";
 import { mockGetRemainingRefundableQuantities } from "../../actions/get-remaining-refundable-quantities/mock";
 import { mockGoToStationHome } from "../../actions/go-to-station-home/mock";
 import { mockInitiateRefund } from "../../actions/initiate-refund/mock";
@@ -89,6 +92,7 @@ export const RENDER_MOCKS = {
     addCustomer: mockAddCustomer,
     editCustomer: mockEditCustomer,
     addCustomerNote: mockAddCustomerNote,
+    removeCustomerNote: mockRemoveCustomerNote,
     addOrderNote: mockAddOrderNote,
     addProductDiscount: mockAddProductDiscount,
     addProductFee: mockAddProductFee,
@@ -115,6 +119,7 @@ export const RENDER_MOCKS = {
     getOrders: mockGetOrders,
     getProducts: mockGetProducts,
     getRefunds: mockGetRefunds,
+    getTaxTables: mockGetTaxTables,
     getRemainingRefundableQuantities: mockGetRemainingRefundableQuantities,
     goToStationHome: mockGoToStationHome,
     initiateRefund: mockInitiateRefund,
@@ -167,11 +172,11 @@ export const RENDER_MOCKS = {
     getActiveUser: mockGetActiveUser,
     setActiveUser: mockSetActiveUser,
     setActiveRefund: mockSetActiveRefund,
-    removeProductDiscount: async () => ({ success: true, timestamp: new Date().toISOString() }),
-    removeProductFee: async () => ({ success: true, timestamp: new Date().toISOString() }),
-    removeProductNote: async () => ({ success: true, timestamp: new Date().toISOString() }),
-    removeCartFee: async () => ({ success: true, timestamp: new Date().toISOString() }),
-    removeOrderNote: async () => ({ success: true, timestamp: new Date().toISOString() }),
-    removeCustomSale: async (params) => ({ success: true, id: params.id, timestamp: new Date().toISOString() }),
-    removeNonRevenueItem: async (params) => ({ success: true, externalId: params.externalId, timestamp: new Date().toISOString() })
+    removeProductDiscount: () => Promise.resolve({ success: true, timestamp: new Date().toISOString() }),
+    removeProductFee: () => Promise.resolve({ success: true, timestamp: new Date().toISOString() }),
+    removeProductNote: () => Promise.resolve({ success: true, timestamp: new Date().toISOString() }),
+    removeCartFee: mockRemoveCartFee,
+    removeOrderNote: () => Promise.resolve({ success: true, timestamp: new Date().toISOString() }),
+    removeCustomSale: params => Promise.resolve({ success: true, id: params.id, timestamp: new Date().toISOString() }),
+    removeNonRevenueItem: params => Promise.resolve({ success: true, externalId: params.externalId, timestamp: new Date().toISOString() })
 };

package/dist/projects/render/types.d.ts

@@ -1,4 +1,4 @@
-import type { ExampleFunction, GetProducts, AddCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, InitiateRefund, CashPayment, TapToPayPayment, TerminalPayment, VendaraPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, TriggerWebhook, TriggerZapierWebhook, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, SetActiveOutlet, GetActiveStation, SetActiveStation, GetActiveSession, SetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem } from "../../index";
+import type { ExampleFunction, GetProducts, AddCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, InitiateRefund, CashPayment, TapToPayPayment, TerminalPayment, VendaraPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, TriggerWebhook, TriggerZapierWebhook, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, GetCurrentCart, Print, SetActiveOrder, GetCustomTables, GetCustomTableData, UpsertCustomTableData, DeleteCustomTableData, GetCustomExtensions, GetCurrentCompanyCustomExtensions, GetCustomExtensionCustomTables, GetCustomTableFields, GetSecretsKeys, GetSecretVal, SetSecretVal, GetUsers, GetRoles, RemoveCartDiscount, GetActiveOrder, GetActiveCustomer, SetActiveCustomer, GetActiveOutlet, SetActiveOutlet, GetActiveStation, SetActiveStation, GetActiveSession, SetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem } from "../../index";
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
@@ -10,6 +10,7 @@ export interface RenderProviderActions {
     getCategories: GetCategories;
     getOrders: GetOrders;
     getRefunds: GetRefunds;
+    getTaxTables: GetTaxTables;
     addProductDiscount: AddProductDiscount;
     addProductToCart: AddProductToCart;
     removeProductFromCart: RemoveProductFromCart;
@@ -39,6 +40,7 @@ export interface RenderProviderActions {
     redeemPayment: RedeemPayment;
     addNonRevenueItem: AddNonRevenueItem;
     addCustomerNote: AddCustomerNote;
+    removeCustomerNote: RemoveCustomerNote;
     removeCustomerFromCart: RemoveCustomerFromCart;
     removeCartDiscount: RemoveCartDiscount;
     goToStationHome: GoToStationHome;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@final-commerce/command-frame",
-  "version": "0.1.61",
+  "version": "0.1.63",
   "description": "Commands Frame library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,7 +17,8 @@
     "test": "vitest",
     "test:run": "vitest run",
     "prepublishOnly": "npm run build",
-    "prepare": "npm run build",
+    "prepare": "husky && npm run build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "publish:npm": "npm publish --registry=https://registry.npmjs.org",
@@ -41,9 +42,30 @@
     "type": "git",
     "url": "git+https://github.com/Final-Commerce/command-frame.git"
   },
+  "lint-staged": {
+    "**/*.{ts,tsx,js,json,md}": [
+      "prettier --write"
+    ],
+    "**/*.{ts,tsx}": [
+      "eslint --fix"
+    ]
+  },
+  "jira-prepare-commit-msg": {
+    "messagePattern": "$M [$J]",
+    "jiraTicketPattern": "([A-Z]+-\\d+)",
+    "ignoredBranchesPattern": "^(main|master|develop|release-staging.*|pre-prod)$",
+    "ignoreBranchesMissingTickets": true
+  },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^8.48.0",
     "@typescript-eslint/parser": "^8.48.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-refresh": "^0.4.26",
+    "husky": "^9.1.7",
+    "jira-prepare-commit-msg": "^1.7.2",
+    "lint-staged": "^16.2.7",
     "prettier": "^3.7.1",
     "typescript": "^5.0.0",
     "vitest": "^3.0.5"