@final-commerce/command-frame 0.11.1-online.1 → 0.11.1-online.2

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

@@ -1,5 +1,7 @@
 /** 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';
+/** Why the server cancelled an order the shopper paid for. */
+export type CheckoutCancelReason = 'sold_out';
 export interface GetCheckoutStatusParams {
     /**
      * The receipt `startCheckout` returned, to name which order. Omitted: the checkout in flight,
@@ -13,6 +15,11 @@ export interface GetCheckoutStatusResponse {
     status: CheckoutOrderStatus | null;
     /** True once the money is in: `paid`, `fulfilled`, or refunded since. */
     paid: boolean;
+    /**
+     * Why a `cancelled` order was cancelled, when the server cancelled it. `sold_out`: the stock ran out
+     * before the payment was captured, so the payment was released and nothing was charged.
+     */
+    cancelReason?: CheckoutCancelReason;
     receiptId: string | null;
     timestamp: string;
 }

package/dist/index.d.ts

@@ -240,7 +240,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 { GetCheckoutStatus, GetCheckoutStatusParams, GetCheckoutStatusResponse, CheckoutOrderStatus, CheckoutCancelReason, } from './actions/get-checkout-status/types';
 export type { GetMotoConfig, GetMotoConfigResponse, MotoUnavailableReason } from './actions/get-moto-config/types';
 export type { AddCustomerNote, AddCustomerNoteParams, AddCustomerNoteResponse, } from './actions/add-customer-note/types';
 export type { RemoveCustomerNote, RemoveCustomerNoteParams, RemoveCustomerNoteResponse, } from './actions/remove-customer-note/types';

package/dist/pubsub/topics/checkout/payment-failed/types.d.ts

@@ -1,4 +1,4 @@
-import type { TopicEvent } from "../../../types";
+import type { TopicEvent } from '../../../types';
 /**
  * Payload for payment-failed event
  *
@@ -9,7 +9,10 @@ import type { TopicEvent } from "../../../types";
 export interface PaymentFailedPayload {
     orderId: string;
     receiptId: string;
-    /** The provider's result code, e.g. `Refused`, or an error name. */
+    /**
+     * The provider's result code, e.g. `Refused`, or an error name. `SoldOut`: the shopper pressed Pay
+     * and something in the cart can no longer be sold, so the card was never sent.
+     */
     resultCode: string;
     /** Present when the failure carried a message worth showing. */
     message?: string;

package/package.json

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