@final-commerce/command-frame 0.3.0-beta.7 → 0.3.0-beta.8

package/dist/actions/send-email/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Send email action — email the customer the active order's (or a refund's) receipt.
+ * Calls the sendEmail action on the parent window.
+ */
+import type { SendEmail } from "./types";
+export declare const sendEmail: SendEmail;

package/dist/actions/send-email/action.js

@@ -0,0 +1,8 @@
+/**
+ * Send email action — email the customer the active order's (or a refund's) receipt.
+ * Calls the sendEmail action on the parent window.
+ */
+import { commandFrameClient } from "../../client";
+export const sendEmail = async (params) => {
+    return await commandFrameClient.call("sendEmail", params);
+};

package/dist/actions/send-email/mock.d.ts

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

package/dist/actions/send-email/mock.js

@@ -0,0 +1,11 @@
+export const mockSendEmail = async (params) => {
+    console.log("[Mock] sendEmail called", params);
+    return {
+        success: true,
+        channel: "email",
+        email: params?.email || "mock@example.com",
+        entityId: params?.refundId || params?.orderId || "mock_order_1",
+        type: params?.type || "order",
+        timestamp: new Date().toISOString()
+    };
+};

package/dist/actions/send-email/types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Which receipt to send: a finalized order (default) or a refund.
+ * Values MUST stay in lockstep with `ReceiptType` in `@final-commerce/common` (used by hub-api);
+ * this SDK intentionally has no dependency on that package, so the literal is duplicated here.
+ */
+export type SendReceiptType = 'order' | 'refund';
+export interface SendEmailParams {
+    /** Recipient email. Defaults to the active customer's email. */
+    email?: string;
+    /** Order id to send the receipt for. Defaults to the active order. */
+    orderId?: string;
+    /** Refund id — required when `type` is 'refund'. */
+    refundId?: string;
+    /** 'order' (default) or 'refund'. */
+    type?: SendReceiptType;
+}
+export interface SendEmailResponse {
+    success: boolean;
+    /** Always 'email' for this action. */
+    channel: 'email';
+    /** The email the receipt was sent to. */
+    email: string;
+    /** The order or refund id the receipt was sent for. */
+    entityId: string;
+    type: SendReceiptType;
+    timestamp: string;
+}
+export type SendEmail = (params?: SendEmailParams) => Promise<SendEmailResponse>;

package/dist/actions/send-email/types.js

@@ -0,0 +1,2 @@
+// Send Email Types — email the customer their order/refund receipt.
+export {};

package/dist/actions/send-sms/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Send SMS action — text the customer the active order's (or a refund's) receipt.
+ * Calls the sendSms action on the parent window.
+ */
+import type { SendSms } from "./types";
+export declare const sendSms: SendSms;

package/dist/actions/send-sms/action.js

@@ -0,0 +1,8 @@
+/**
+ * Send SMS action — text the customer the active order's (or a refund's) receipt.
+ * Calls the sendSms action on the parent window.
+ */
+import { commandFrameClient } from "../../client";
+export const sendSms = async (params) => {
+    return await commandFrameClient.call("sendSms", params);
+};

package/dist/actions/send-sms/mock.d.ts

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

package/dist/actions/send-sms/mock.js

@@ -0,0 +1,11 @@
+export const mockSendSms = async (params) => {
+    console.log("[Mock] sendSms called", params);
+    return {
+        success: true,
+        channel: "text",
+        phone: params?.phone || "+15555550123",
+        entityId: params?.refundId || params?.orderId || "mock_order_1",
+        type: params?.type || "order",
+        timestamp: new Date().toISOString()
+    };
+};

package/dist/actions/send-sms/types.d.ts

@@ -0,0 +1,24 @@
+import type { SendReceiptType } from "../send-email/types";
+export type { SendReceiptType };
+export interface SendSmsParams {
+    /** Recipient phone in E.164 format (e.g. +15555550123). Defaults to the active customer's phone. */
+    phone?: string;
+    /** Order id to send the receipt for. Defaults to the active order. */
+    orderId?: string;
+    /** Refund id — required when `type` is 'refund'. */
+    refundId?: string;
+    /** 'order' (default) or 'refund'. */
+    type?: SendReceiptType;
+}
+export interface SendSmsResponse {
+    success: boolean;
+    /** Always 'text' for this action. */
+    channel: 'text';
+    /** The phone the receipt was sent to (E.164). */
+    phone: string;
+    /** The order or refund id the receipt was sent for. */
+    entityId: string;
+    type: SendReceiptType;
+    timestamp: string;
+}
+export type SendSms = (params?: SendSmsParams) => Promise<SendSmsResponse>;

package/dist/actions/send-sms/types.js

@@ -0,0 +1,2 @@
+// Send SMS Types — text the customer their order/refund receipt.
+export {};

package/dist/index.d.ts

@@ -69,6 +69,8 @@ export declare const command: {
     readonly removeOrderNote: import(".").RemoveOrderNote;
     readonly removeCustomSale: import(".").RemoveCustomSale;
     readonly removeNonRevenueItem: import(".").RemoveNonRevenueItem;
+    readonly sendEmail: import(".").SendEmail;
+    readonly sendSms: import(".").SendSms;
     readonly initiateRefund: import(".").InitiateRefund;
     readonly setRefundStockAction: import(".").SetRefundStockAction;
     readonly selectAllRefundItems: import(".").SelectAllRefundItems;
@@ -200,6 +202,8 @@ export type { RemoveCartFee, RemoveCartFeeParams, RemoveCartFeeResponse } from "
 export type { RemoveOrderNote, RemoveOrderNoteResponse } from "./actions/remove-order-note/types";
 export type { RemoveCustomSale, RemoveCustomSaleParams, RemoveCustomSaleResponse } from "./actions/remove-custom-sale/types";
 export type { RemoveNonRevenueItem, RemoveNonRevenueItemParams, RemoveNonRevenueItemResponse } from "./actions/remove-non-revenue-item/types";
+export type { SendEmail, SendEmailParams, SendEmailResponse, SendReceiptType } from "./actions/send-email/types";
+export type { SendSms, SendSmsParams, SendSmsResponse } from "./actions/send-sms/types";
 export * from "./CommonTypes";
 export { setMockDatabase, setMockActiveProduct } from "./demo/database";
 export type { MockDatabaseConfig } from "./demo/database";

package/dist/index.js

@@ -73,6 +73,9 @@ import { removeOrderNote } from "./actions/remove-order-note/action";
 import { removeCustomSale } from "./actions/remove-custom-sale/action";
 import { removeNonRevenueItem } from "./actions/remove-non-revenue-item/action";
 // Integration Actions
+// Receipt send Actions
+import { sendEmail } from "./actions/send-email/action";
+import { sendSms } from "./actions/send-sms/action";
 // Refund Actions
 import { getRefunds } from "./actions/get-refunds/action";
 import { initiateRefund } from "./actions/initiate-refund/action";
@@ -199,6 +202,9 @@ export const command = {
     removeCustomSale,
     removeNonRevenueItem,
     // Integration Actions
+    // Receipt send Actions
+    sendEmail,
+    sendSms,
     // Refund Actions
     initiateRefund,
     setRefundStockAction,
@@ -247,7 +253,6 @@ export const command = {
     getAvailableTransitions,
     applyTransition
 };
-// Integration Actions
 // Export Common Types
 export * from "./CommonTypes";
 // Mock database override (standalone / extension dev)

package/dist/projects/render/mocks.js

@@ -92,6 +92,8 @@ import { canTransitionMock } from "../../actions/can-transition/mock";
 import { getAvailableTransitionsMock } from "../../actions/get-available-transitions/mock";
 import { mockGetSmartGridLayout } from "../../actions/get-smart-grid-layout/mock";
 import { mockSaveSmartGridLayout } from "../../actions/save-smart-grid-layout/mock";
+import { mockSendEmail } from "../../actions/send-email/mock";
+import { mockSendSms } from "../../actions/send-sms/mock";
 export const RENDER_MOCKS = {
     addCartDiscount: mockAddCartDiscount,
     addCartFee: mockAddCartFee,
@@ -188,5 +190,7 @@ export const RENDER_MOCKS = {
     canTransition: canTransitionMock,
     getAvailableTransitions: getAvailableTransitionsMock,
     getSmartGridLayout: mockGetSmartGridLayout,
-    saveSmartGridLayout: mockSaveSmartGridLayout
+    saveSmartGridLayout: mockSaveSmartGridLayout,
+    sendEmail: mockSendEmail,
+    sendSms: mockSendSms
 };

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

@@ -1,4 +1,4 @@
-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, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, VendaraPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, 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, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout } 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, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, VendaraPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, 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, GetActiveStation, GetActiveSession, GetActiveUser, SetActiveUser, SetActiveRefund, RemoveProductDiscount, RemoveProductFee, RemoveProductNote, RemoveCartFee, RemoveOrderNote, RemoveCustomSale, RemoveNonRevenueItem, CanTransition, GetAvailableTransitions, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms } from "../../index";
 import type { OpenExtensionOverlay } from "../../actions/open-extension-overlay/types";
 import type { ResolveExtensionOverlay } from "../../actions/resolve-extension-overlay/types";
 export interface RenderProviderActions {
@@ -98,4 +98,6 @@ export interface RenderProviderActions {
     getAvailableTransitions: GetAvailableTransitions;
     getSmartGridLayout: GetSmartGridLayout;
     saveSmartGridLayout: SaveSmartGridLayout;
+    sendEmail: SendEmail;
+    sendSms: SendSms;
 }

package/package.json

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