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

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-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/package.json

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