@final-commerce/command-frame 0.9.0-online.3 → 0.9.0-online.5

package/dist/CommonTypes.d.ts

@@ -116,6 +116,7 @@ export interface CFActiveRefundDetails {
     buttonsDisabled?: Record<string, boolean>;
     isRefund?: boolean;
     customSalesQuantities?: Record<string, number>;
+    /** Keyed by cart-fee id, plus the reserved key `'shipping'` for the order's shipping. 0/1 each. */
     cartFeesRefunds?: Record<string, number>;
     tipsRefunds?: Record<string, number>;
     refundProcessingStatus?: CFRefundProcessingStatus | null;

package/dist/actions/get-checkout-status/action.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get Checkout Status action
+ * Calls the getCheckoutStatus action on the parent window
+ */
+import type { GetCheckoutStatus } from './types';
+export declare const getCheckoutStatus: GetCheckoutStatus;

package/dist/actions/get-checkout-status/action.js

@@ -0,0 +1,8 @@
+/**
+ * Get Checkout Status action
+ * Calls the getCheckoutStatus action on the parent window
+ */
+import { commandFrameClient } from '../../client';
+export const getCheckoutStatus = async (params) => {
+    return await commandFrameClient.call('getCheckoutStatus', params);
+};

package/dist/actions/get-checkout-status/mock.d.ts

@@ -0,0 +1,3 @@
+import { GetCheckoutStatus } from './types';
+/** Standalone mock: every order the preview knows about is already paid. */
+export declare const mockGetCheckoutStatus: GetCheckoutStatus;

package/dist/actions/get-checkout-status/mock.js

@@ -0,0 +1,11 @@
+/** Standalone mock: every order the preview knows about is already paid. */
+export const mockGetCheckoutStatus = async (params) => {
+    console.log('[Mock] getCheckoutStatus called', params);
+    return {
+        success: true,
+        status: params?.orderPassword ? 'paid' : null,
+        paid: Boolean(params?.orderPassword),
+        receiptId: params?.orderPassword ? 'ON-001-000001' : null,
+        timestamp: new Date().toISOString(),
+    };
+};

package/dist/actions/get-checkout-status/types.d.ts

@@ -0,0 +1,22 @@
+/** The shopper-facing vocabulary: never the platform's payment / fulfilment states. */
+export type CheckoutOrderStatus = 'awaiting_payment' | 'confirming' | 'payment_failed' | 'paid' | 'fulfilled' | 'partially_refunded' | 'refunded' | 'cancelled';
+export interface GetCheckoutStatusParams {
+    /** The order password from `startCheckout` or `resumeCheckout`. */
+    orderPassword: string;
+    /**
+     * The provider's opaque `sessionResult` from the payment-completed event, when the page has it.
+     * Lets the server verify the payment with the provider while the notification is still on its way.
+     */
+    sessionResult?: string;
+}
+export interface GetCheckoutStatusResponse {
+    success: boolean;
+    /** `null` when the order is unknown or the password has expired. */
+    status: CheckoutOrderStatus | null;
+    /** True once the money is in: `paid`, `fulfilled`, or refunded since. */
+    paid: boolean;
+    receiptId: string | null;
+    timestamp: string;
+}
+/** Never throws for an unknown order: answers `status: null`. */
+export type GetCheckoutStatus = (params: GetCheckoutStatusParams) => Promise<GetCheckoutStatusResponse>;

package/dist/actions/get-checkout-status/types.js

@@ -0,0 +1,12 @@
+// Get Checkout Status Types
+//
+// Where an online order stands NOW, as the server holds it. A confirmation page uses it to move
+// from "we're confirming your payment" to "paid" once the payment provider's notification has
+// landed, which the browser alone can never know: it only ever sees that the provider ACCEPTED
+// a payment.
+//
+// Keyed by the one-time order password `startCheckout` (or `resumeCheckout`, after a redirect)
+// returned, so a page can only ever ask about an order it created.
+//
+// Served ONLY by the storefront runtime (a published website). On a register it does not exist.
+export {};

package/dist/actions/get-refund-plan/mockRows.js

@@ -96,7 +96,7 @@ export function mockRefundBreakdown(rows, items) {
         return { type: row.type, itemKey: row.itemKey, quantity, amounts: scale(row.amounts, quantity / row.quantity) };
     })
         .filter((r) => r.quantity > 0);
-    const totals = { items: 0, discounts: 0, fees: 0, tax: 0, tip: 0, total: 0 };
+    const totals = { items: 0, discounts: 0, fees: 0, shipping: 0, tax: 0, tip: 0, total: 0 };
     for (const r of selected) {
         const a = r.amounts;
         if (r.type === 'fee')

package/dist/actions/get-refund-plan/types.d.ts

@@ -20,12 +20,13 @@ export interface GetRefundPlanParams {
     items?: {
         /**
          * `internalId` / `variantId` for a product, `customSaleId`, cart-fee id, tip
-         * `transactionId`, or a booking's own `internalId` on `order.reservations[]`.
+         * `transactionId`, a booking's own `internalId` on `order.reservations[]`, or
+         * `'shipping'` for the order's shipping (all or nothing, like a fee).
          */
         itemKey: string;
         quantity: number;
         /** Optional hint; inferred from the order when omitted. */
-        type?: 'product' | 'customSale' | 'fee' | 'tip' | 'reservation';
+        type?: 'product' | 'customSale' | 'fee' | 'tip' | 'reservation' | 'shipping';
     }[];
 }
 export interface RefundPlanSource {
@@ -79,7 +80,7 @@ export interface RefundPlanLeg {
         rounding: number;
     };
 }
-export type RefundPlanRowType = 'product' | 'customSale' | 'fee' | 'tip';
+export type RefundPlanRowType = 'product' | 'customSale' | 'fee' | 'tip' | 'shipping';
 /** One tax rate's share of a row's refund (minor units). */
 export interface RefundPlanTaxLine {
     name: string;
@@ -107,7 +108,7 @@ export interface RefundPlanAmounts {
     total: number;
 }
 /**
- * One refundable row of the order — a line item, custom sale, cart fee or tip —
+ * One refundable row of the order — a line item, custom sale, cart fee, shipping or tip —
  * served ready to render. Rows with nothing left to refund are not listed.
  */
 export interface RefundPlanRow {
@@ -121,7 +122,7 @@ export interface RefundPlanRow {
     attributes?: string;
     /** Tip rows only: the tender that took the tip (`card`, `cash`, …). */
     paymentType?: string;
-    /** Quantity originally sold. Fees and tips are `1` — all or nothing. */
+    /** Quantity originally sold. Fees, shipping and tips are `1` — all or nothing. */
     quantity: number;
     /** Quantity still refundable — the stepper's max. */
     refundableQuantity: number;
@@ -137,7 +138,7 @@ export interface RefundPlanSelectedRow {
 }
 /**
  * The selection's goods value broken down for display. Minor units;
- * `items − discounts + fees + tax + tip === total === allocation.itemTotal`.
+ * `items − discounts + fees + shipping + tax + tip === total === allocation.itemTotal`.
  */
 export interface RefundPlanTotals {
     /** Σ selected line subtotals (before discounts, tax excluded). */
@@ -146,6 +147,8 @@ export interface RefundPlanTotals {
     discounts: number;
     /** Σ selected cart fees, tax excluded. */
     fees: number;
+    /** The order's shipping when selected, tax excluded; 0 otherwise. */
+    shipping: number;
     tax: number;
     tip: number;
     total: number;

package/dist/actions/get-remaining-refundable-quantities/mock.js

@@ -5,6 +5,7 @@ export const mockGetRemainingRefundableQuantities = async (_params) => {
         lineItems: {},
         customSales: {},
         cartFees: {},
+        shipping: 0,
         tips: {},
         reservations: {},
         timestamp: new Date().toISOString(),

package/dist/actions/get-remaining-refundable-quantities/types.d.ts

@@ -11,6 +11,11 @@ export interface GetRemainingRefundableQuantitiesResponse {
      * 0/1 semantics: `1` = still refundable, `0` = already refunded.
      */
     cartFees: Record<string, number>;
+    /**
+     * The order's shipping: `1` = still refundable, `0` = already refunded or the order has none.
+     * Refunded with `itemKey: 'shipping'`, all or nothing.
+     */
+    shipping: number;
     /**
      * Remaining refundable tips, keyed by the paying method's
      * `transactionId` — the same key `processPartialRefund` takes for

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

@@ -134,7 +134,7 @@ export interface ProcessPartialRefundParams {
         /** internalId or variantId, customSaleId, or a booking's own internalId. */
         itemKey: string;
         quantity: number;
-        type?: 'product' | 'customSale' | 'fee' | 'tip' | 'reservation';
+        type?: 'product' | 'customSale' | 'fee' | 'tip' | 'reservation' | 'shipping';
         /**
          * Per-item stock disposition for a refunded **product** line — the
          * headless equivalent of the old refund popup's per-row restock/damaged

package/dist/index.d.ts

@@ -61,6 +61,7 @@ export declare const command: {
     readonly selectShippingOption: import(".").SelectShippingOption;
     readonly setOutlet: import(".").SetOutlet;
     readonly resumeCheckout: import(".").ResumeCheckout;
+    readonly getCheckoutStatus: import(".").GetCheckoutStatus;
     readonly addCustomerNote: import(".").AddCustomerNote;
     readonly removeCustomerNote: import(".").RemoveCustomerNote;
     readonly removeCustomerFromCart: import(".").RemoveCustomerFromCart;
@@ -214,6 +215,7 @@ export type { GetShippingOptions, GetShippingOptionsResponse, ShippingOptionView
 export type { SelectShippingOption, SelectShippingOptionParams, SelectShippingOptionResponse, } from './actions/select-shipping-option/types';
 export type { SetOutlet, SetOutletParams, SetOutletResponse } from './actions/set-outlet/types';
 export type { ResumeCheckout, ResumeCheckoutParams, ResumeCheckoutResponse, ResumeCheckoutResult, } from './actions/resume-checkout/types';
+export type { GetCheckoutStatus, GetCheckoutStatusParams, GetCheckoutStatusResponse, CheckoutOrderStatus, } from './actions/get-checkout-status/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';

package/dist/index.js

@@ -61,6 +61,7 @@ import { getShippingOptions } from './actions/get-shipping-options/action';
 import { selectShippingOption } from './actions/select-shipping-option/action';
 import { setOutlet } from './actions/set-outlet/action';
 import { resumeCheckout } from './actions/resume-checkout/action';
+import { getCheckoutStatus } from './actions/get-checkout-status/action';
 // Customer Actions
 import { addCustomerNote } from './actions/add-customer-note/action';
 import { removeCustomerNote } from './actions/remove-customer-note/action';
@@ -216,6 +217,7 @@ export const command = {
     selectShippingOption,
     setOutlet,
     resumeCheckout,
+    getCheckoutStatus,
     // Customer Actions
     addCustomerNote,
     removeCustomerNote,

package/dist/projects/render/mocks.js

@@ -43,6 +43,7 @@ import { mockSelectShippingOption } from '../../actions/select-shipping-option/m
 import { mockGetOutlets } from '../../actions/get-outlets/mock';
 import { mockSetOutlet } from '../../actions/set-outlet/mock';
 import { mockResumeCheckout } from '../../actions/resume-checkout/mock';
+import { mockGetCheckoutStatus } from '../../actions/get-checkout-status/mock';
 import { mockGetTimeClockStatus } from '../../actions/get-time-clock-status/mock';
 import { mockClearCart } from '../../actions/clear-cart/mock';
 import { mockDeleteParkedOrder } from '../../actions/delete-parked-order/mock';
@@ -159,6 +160,7 @@ export const RENDER_MOCKS = {
     getOutlets: mockGetOutlets,
     setOutlet: mockSetOutlet,
     resumeCheckout: mockResumeCheckout,
+    getCheckoutStatus: mockGetCheckoutStatus,
     clearCart: mockClearCart,
     deleteParkedOrder: mockDeleteParkedOrder,
     voidOrder: mockVoidOrder,

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

@@ -1,4 +1,4 @@
-import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, 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, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetTimeClockStatus } from '../../index';
+import type { ExampleFunction, GetProducts, AddCustomSale, EditCustomSale, GetCustomers, AssignCustomer, AddCustomer, EditCustomer, GetCategories, GetOrders, GetRefunds, GetTaxTables, GetCustomStockActions, AddProductDiscount, AddProductToCart, RemoveProductFromCart, UpdateCartItemQuantity, AddCartDiscount, GetContext, GetFinalContext, AddProductNote, AddProductFee, GetProductModifierSelections, SetProductModifierSelections, SetActiveProductFee, SetActiveProductDiscount, GetActiveProduct, SetActiveProduct, AdjustInventory, AddOrderNote, AddCartFee, ClearCart, ParkOrder, ResumeParkedOrder, DeleteParkedOrder, VoidOrder, InitiateRefund, CashPayment, GetCashRoundingAmount, TapToPayPayment, TerminalPayment, ExtensionPayment, RedeemPayment, AddNonRevenueItem, AddCustomerNote, RemoveCustomerNote, RemoveCustomerFromCart, GoToStationHome, OpenCashDrawer, ShowNotification, ShowConfirmation, AuthenticateUser, PartialPayment, SwitchUser, SetRefundStockAction, SelectAllRefundItems, ResetRefundDetails, CalculateRefundTotal, GetRemainingRefundableQuantities, ProcessPartialRefund, RedeemRefund, GetRefundPlan, CheckPermission, 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, ApplyTransition, IntegrationPayment, GetSmartGridLayout, SaveSmartGridLayout, SendEmail, SendSms, GetBookingResources, GetBookingAvailability, GetBookings, HoldBooking, AddBookingToCart, RemoveBookingFromCart, CancelBooking, CreatePaymentLink, ChargeMoto, StartCheckout, AttachCheckoutContact, GetAddressOptions, SetOrderAddress, GetShippingOptions, SelectShippingOption, GetOutlets, SetOutlet, ResumeCheckout, GetCheckoutStatus, GetTimeClockStatus } from '../../index';
 export interface RenderProviderActions {
     exampleFunction: ExampleFunction;
     getProducts: GetProducts;
@@ -73,6 +73,8 @@ export interface RenderProviderActions {
      * `startCheckout`, and safe to call on every page load.
      */
     resumeCheckout: ResumeCheckout;
+    /** Where an online order stands now, by its order password. Storefront-only. */
+    getCheckoutStatus: GetCheckoutStatus;
     addNonRevenueItem: AddNonRevenueItem;
     addCustomerNote: AddCustomerNote;
     removeCustomerNote: RemoveCustomerNote;

package/package.json

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