@final-commerce/command-frame 0.1.10 → 0.1.11

package/dist/actions/add-cart-discount/types.d.ts

@@ -1,6 +1,9 @@
 export interface AddCartDiscountParams {
+    /** The discount amount. If isPercent is true, this is a percentage (0-100). */
     amount: number;
+    /** Defaults to `false`. */
     isPercent?: boolean;
+    /** Defaults to "Discount". */
     label?: string;
 }
 export interface AddCartDiscountResponse {

package/dist/actions/add-cart-fee/types.d.ts

@@ -1,7 +1,11 @@
 export interface AddCartFeeParams {
+    /** The fee amount. If isPercent is true, this is a percentage. */
     amount: number;
+    /** Defaults to `false`. */
     isPercent?: boolean;
+    /** Defaults to "Fee". */
     label?: string;
+    /** Defaults to `false`. */
     applyTaxes?: boolean;
     taxTableId?: string;
 }

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

@@ -1,5 +1,6 @@
 import { CFCustomer } from "../../CommonTypes";
 export interface AddCustomerParams {
+    /** Requires all fields except those generated by the server/database. */
     customer: Omit<CFCustomer, '_id' | 'createdAt' | 'updatedAt'>;
 }
 export interface AddCustomerResponse {

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

@@ -1,6 +1,9 @@
 export interface AddProductDiscountParams {
+    /** The discount amount. If isPercent is true, this is a percentage. */
     amount: number;
+    /** Defaults to `false`. */
     isPercent?: boolean;
+    /** Defaults to "Discount". */
     label?: string;
     cartItemId?: string;
 }

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

@@ -1,7 +1,10 @@
 export interface AddProductFeeParams {
     amount: number;
+    /** Defaults to `false`. */
     isPercent?: boolean;
+    /** Defaults to "Fee". */
     label?: string;
+    /** Defaults to `false`. */
     applyTaxes?: boolean;
     taxTableId?: string;
     cartItemId?: string;

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

@@ -1,5 +1,6 @@
 export interface AddProductNoteParams {
     note: string;
+    /** The internalId of the cart item to modify. If not provided, it may attempt to modify the active product context. */
     cartItemId?: string;
 }
 export interface AddProductNoteResponse {

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

@@ -1,10 +1,15 @@
 import type { AddProductDiscountParams } from "../add-product-discount/types";
 import type { AddProductFeeParams } from "../add-product-fee/types";
 export interface AddProductToCartParams {
+    /** ID of the variant to add. Optional but recommended. */
     variantId?: string;
+    /** Defaults to 1. */
     quantity?: number;
+    /** Array of discounts to apply immediately. */
     discounts?: AddProductDiscountParams[];
+    /** Array of fees to apply immediately. */
     fees?: AddProductFeeParams[];
+    /** Note or array of notes to add immediately. */
     notes?: string | string[];
 }
 export interface AddProductToCartResponse {

package/dist/actions/adjust-inventory/types.d.ts

@@ -1,5 +1,7 @@
 export interface AdjustInventoryParams {
+    /** String to preserve precision. */
     amount: string;
+    /** 'add' (increase), 'subtract' (decrease), or 'set' (recount). */
     stockType: 'add' | 'subtract' | 'set';
     variantId?: string;
 }

package/dist/actions/calculate-refund-total/types.d.ts

@@ -1,5 +1,6 @@
 import { CFRefundedLineItem, CFRefundedCustomSale } from "../../CommonTypes";
 export interface CalculateRefundTotalParams {
+    /** Optional order ID to set as the active order context for the calculation. */
     orderId?: string;
 }
 export interface CalculateRefundTotalResponse {

package/dist/actions/cash-payment/types.d.ts

@@ -1,6 +1,8 @@
 import { CFOrder } from "../../CommonTypes";
 export interface CashPaymentParams {
+    /** If not provided, uses the cart total. */
     amount?: number;
+    /** Defaults to false. */
     openChangeCalculator?: boolean;
 }
 export interface CashPaymentResponse {

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

@@ -1,5 +1,6 @@
 import { CFCategory } from "../../CommonTypes";
 export interface GetCategoriesParams {
+    /** MongoDB-like query object. */
     query?: {
         name?: string | {
             $regex?: string;

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

@@ -1,5 +1,6 @@
 import { CFCustomer } from "../../CommonTypes";
 export interface GetCustomersParams {
+    /** MongoDB-like query object. */
     query?: {
         email?: string | {
             $regex?: string;
@@ -23,7 +24,9 @@ export interface GetCustomersParams {
         outletId?: string;
         [key: string]: any;
     };
+    /** Defaults to 0. */
     offset?: number;
+    /** Defaults to 100. */
     limit?: number;
 }
 export interface GetCustomersResponse {

package/dist/actions/get-line-items-by-order/types.d.ts

@@ -1,5 +1,6 @@
 import { CFLineItem, CFCustomSale } from "../../CommonTypes";
 export interface GetLineItemsByOrderParams {
+    /** If not provided, uses the currently active order. */
     orderId?: string;
 }
 export interface GetLineItemsByOrderResponse {

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

@@ -1,12 +1,17 @@
 import { CFOrder } from "../../CommonTypes";
 export interface GetOrdersParams {
+    /** e.g. 'completed', 'parked', 'refunded'. */
     status?: string;
     customerId?: string;
     sessionId?: string;
+    /** Default: 50. */
     limit?: number;
+    /** Default: 0. */
     offset?: number;
     searchValue?: string;
+    /** Default: 'createdAt'. */
     sortBy?: string;
+    /** Default: 'descending'. */
     sortDirection?: 'ascending' | 'descending';
 }
 export interface GetOrdersResponse {

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

@@ -1,5 +1,6 @@
 import { CFProduct } from "../../CommonTypes";
 export interface GetProductsParams {
+    /** MongoDB-like query object. */
     query?: {
         name?: string | {
             $regex?: string;
@@ -21,7 +22,9 @@ export interface GetProductsParams {
         externalId?: string;
         [key: string]: any;
     };
+    /** Defaults to 0. */
     offset?: number;
+    /** Defaults to 100. */
     limit?: number;
 }
 export interface GetProductsResponse {

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

@@ -3,9 +3,13 @@ export interface GetRefundsParams {
     orderId?: string;
     sessionId?: string;
     outletId?: string;
+    /** Default: 50. */
     limit?: number;
+    /** Default: 0. */
     offset?: number;
+    /** Default: 'createdAt'. */
     sortBy?: string;
+    /** Default: 'desc'. */
     sortDirection?: 'asc' | 'desc';
 }
 export interface GetRefundsResponse {

package/dist/actions/initiate-refund/types.d.ts

@@ -1,4 +1,5 @@
 export interface InitiateRefundParams {
+    /** The ID of the order to refund. If not provided, uses the currently active order. */
     orderId?: string;
 }
 export interface InitiateRefundResponse {

package/dist/actions/partial-payment/types.d.ts

@@ -1,7 +1,10 @@
 import { CFOrder } from "../../CommonTypes";
 export interface PartialPaymentParams {
+    /** The payment amount (required if openUI is false). */
     amount?: number;
+    /** Defaults to false. */
     isPercent?: boolean;
+    /** If true, opens the split payment UI. */
     openUI?: boolean;
 }
 export interface PartialPaymentResponse {

package/dist/actions/process-partial-refund/types.d.ts

@@ -1,7 +1,11 @@
 export interface ProcessPartialRefundParams {
+    /** Optional refund reason. */
     reason?: string;
+    /** Optional: specify which order to refund (sets it as active). */
     orderId?: string;
+    /** Optional items to refund. */
     items?: {
+        /** internalId or variantId or customSaleId. */
         itemKey: string;
         quantity: number;
         type?: 'product' | 'customSale' | 'fee' | 'tip';

package/dist/actions/select-all-refund-items/types.d.ts

@@ -1,4 +1,5 @@
 export interface SelectAllRefundItemsParams {
+    /** Optional. Sets specific order as active before selecting. */
     orderId?: string;
 }
 export interface SelectAllRefundItemsResponse {

package/dist/actions/set-refund-stock-action/types.d.ts

@@ -1,5 +1,6 @@
 export interface SetRefundStockActionParams {
     orderId?: string;
+    /** The 'key' field from getLineItemsByOrder response (internalId || variantId || productId). */
     itemKey: string;
     action: 'RESTOCK' | 'REFUND_DAMAGE';
 }

package/dist/actions/switch-user/types.d.ts

@@ -1,6 +1,8 @@
 export interface SwitchUserParams {
     mode: 'dialog' | 'role' | 'specific';
+    /** Required if mode is 'role'. */
     roleIds?: string[];
+    /** Required if mode is 'specific'. */
     userId?: string;
 }
 export interface SwitchUserResponse {

package/dist/actions/tap-to-pay-payment/types.d.ts

@@ -1,5 +1,6 @@
 import { CFOrder } from "../../CommonTypes";
 export interface TapToPayPaymentParams {
+    /** If not provided, uses the cart total. */
     amount?: number;
 }
 export interface TapToPayPaymentResponse {

package/dist/actions/terminal-payment/types.d.ts

@@ -1,5 +1,6 @@
 import { CFOrder } from "../../CommonTypes";
 export interface TerminalPaymentParams {
+    /** If not provided, uses the cart total. */
     amount?: number;
 }
 export interface TerminalPaymentResponse {

package/dist/actions/trigger-webhook/types.d.ts

@@ -1,11 +1,15 @@
 export type TriggerWebhookPresetType = 'product' | 'cart' | 'order' | 'customer';
 export interface TriggerWebhookParams {
     webhookUrl: string;
+    /** Public key for authentication. */
     publicKey?: string;
+    /** Defaults to false. */
     presetData?: boolean;
     presetType?: TriggerWebhookPresetType;
+    /** Defaults to false. */
     isCustomHook?: boolean;
     customHookData?: string;
+    /** 'json' or 'form-urlencoded'. Defaults to 'json'. */
     payloadType?: string;
     dynamicDataFields?: unknown[];
 }

package/dist/actions/vendara-payment/types.d.ts

@@ -1,5 +1,6 @@
 import { CFOrder } from "../../CommonTypes";
 export interface VendaraPaymentParams {
+    /** If not provided, uses the cart total. */
     amount?: number;
 }
 export interface VendaraPaymentResponse {

package/package.json

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