@final-commerce/command-frame 0.0.5 → 0.0.7

package/README.md

@@ -460,11 +460,21 @@ import type {
     TriggerWebhookParams, TriggerWebhookResponse, TriggerWebhook,
     TriggerZapierWebhookParams, TriggerZapierWebhookResponse, TriggerZapierWebhook,
     // Reference
-    ExampleFunctionParams, ExampleFunctionResponse, ExampleFunction
+    ExampleFunctionParams, ExampleFunctionResponse, ExampleFunction,
+    // Common Types (Directly exported)
+    CFProduct, CFProductVariant, CFProductType,
+    CFCustomer, CFActiveCustomer, CFCustomerNote,
+    CFOrder, CFActiveOrder, CFActiveCart,
+    CFActiveProduct, CFActiveCustomSales,
+    CFLineItem, CFCustomSale,
+    CFDiscount, CFCustomFee, CFTax,
+    CFAddress, CFMetadataItem,
+    CFActiveUser, CFActiveOutlet, CFActiveStation,
+    CFContext
 } from '@final-commerce/command-frame';
 ```
 
-**Note:** Entity data (customers, products) is returned as `any[]` or `any` to allow flexibility between different database implementations (MongoDB/mongoose vs LokiJS/IndexedDB). For detailed entity structures, refer to the action-specific documentation in the [Actions Documentation](#actions-documentation) section.
+**Note:** The library exports useful types like `CFProduct`, `CFActiveCart`, `CFCustomer`, etc., we recommend using them in your code to type args for components displaying Products/ Customers / Variations / Orders etc
 
 ## License
 

package/dist/CommonTypes.d.ts

@@ -168,6 +168,8 @@ export interface CFCustomer {
     notes?: CFCustomerNote[];
     billing: CFAddress | null;
     shipping: CFAddress | null;
+    createdAt?: string;
+    updatedAt?: string;
 }
 export interface CFActiveCustomer extends CFCustomer {
     id?: string;
@@ -235,6 +237,7 @@ export interface CFPosDataItem {
 export interface CFDiscountDetail {
     percentage: number;
     amount: string;
+    const?: string;
 }
 export interface CFFeeDetail {
     percentage: number;

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

@@ -4,15 +4,10 @@ export const mockAddCustomer = async (params) => {
     if (!params?.customer)
         throw new Error("Customer data required");
     const newCustomer = {
+        ...params.customer,
         _id: "new_mock_cust_" + Date.now(),
-        companyId: "mock_company_id",
-        email: params.customer.email || "",
-        firstName: params.customer.firstName || "",
-        lastName: params.customer.lastName || "",
-        phone: params.customer.phone,
-        billing: null,
-        shipping: null,
-        ...params.customer
+        createdAt: new Date().toISOString(),
+        updatedAt: new Date().toISOString()
     };
     MOCK_CUSTOMERS.push(newCustomer);
     return {

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

@@ -1,6 +1,6 @@
 import { CFCustomer } from "../../CommonTypes";
 export interface AddCustomerParams {
-    customer: Partial<CFCustomer>;
+    customer: Omit<CFCustomer, '_id' | 'createdAt' | 'updatedAt'>;
 }
 export interface AddCustomerResponse {
     success: boolean;

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

@@ -23,6 +23,8 @@ export interface GetCustomersParams {
         outletId?: string;
         [key: string]: any;
     };
+    offset?: number;
+    limit?: number;
 }
 export interface GetCustomersResponse {
     customers: CFCustomer[];

package/dist/demo/database.js

@@ -319,7 +319,7 @@ export const MOCK_ORDER_1 = {
     },
     sessionId: "sess_1",
     metadata: [],
-    billing: MOCK_CUSTOMER_1.billing,
+    billing: MOCK_CUSTOMER_1.billing || null,
     shipping: null,
     lineItems: [
         createLineItem(MOCK_PRODUCT_GARLIC, 0, 1), // 9.00
@@ -450,8 +450,8 @@ export const createOrderFromCart = (paymentType, amount, processor = "cash") =>
             price: String(p.price),
             taxes: [],
             discount: {
-                itemDiscount: { percentage: 0, amount: "0" },
-                cartDiscount: { percentage: 0, amount: "0" }
+                itemDiscount: { percentage: 0, amount: "0", const: "0" },
+                cartDiscount: { percentage: 0, amount: "0", const: "0" }
             },
             fee: { itemFee: { percentage: 0, amount: "0", tax: "0", taxTableId: "" } },
             totalTax: "0",

package/dist/index.d.ts

@@ -105,5 +105,6 @@ export type { PartialPayment, PartialPaymentParams, PartialPaymentResponse } fro
 export type { SwitchUser, SwitchUserParams, SwitchUserResponse } from "./actions/switch-user/types";
 export type { TriggerWebhook, TriggerWebhookParams, TriggerWebhookResponse } from "./actions/trigger-webhook/types";
 export type { TriggerZapierWebhook, TriggerZapierWebhookParams, TriggerZapierWebhookResponse } from "./actions/trigger-zapier-webhook/types";
+export * from "./CommonTypes";
 export { commandFrameClient, CommandFrameClient } from "./client";
 export type { PostMessageRequest, PostMessageResponse } from "./client";

package/dist/index.js

@@ -117,5 +117,7 @@ export const command = {
     processPartialRefund,
     getCurrentCart
 };
+// Export Common Types
+export * from "./CommonTypes";
 // Export client
 export { commandFrameClient, CommandFrameClient } from "./client";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@final-commerce/command-frame",
-    "version": "0.0.5",
+    "version": "0.0.7",
     "description": "Commands Frame library",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",