@final-commerce/command-frame 0.8.0-online.4 → 0.8.0-staging.1

package/dist/actions/start-checkout/types.d.ts

@@ -1,81 +0,0 @@
-/**
- * Guest contact for the order. There is no shopper account, so this is the only
- * way to reach them — `email` is where the receipt goes and is required.
- */
-export interface StartCheckoutContact {
-    email: string;
-    name?: string;
-    phone?: string;
-}
-export interface StartCheckoutParams {
-    contact: StartCheckoutContact;
-    /**
-     * CSS SELECTOR for the element the payment fields mount into, e.g.
-     * `'#card-fields'`. The element must already be in the DOM when this is
-     * called.
-     *
-     * A SELECTOR, NOT AN ELEMENT — and this is not a style preference. Command
-     * params cross a `postMessage` boundary, which serializes them with the
-     * structured clone algorithm; a DOM node is not cloneable, so passing
-     * `ref.current` throws `DataCloneError: HTMLDivElement object could not be
-     * cloned` before the command is ever sent. The string is resolved on the
-     * runtime's side against the same document the page rendered.
-     */
-    container: string;
-    /**
-     * Where the provider returns the shopper after a redirect payment method
-     * (bank apps, wallets). Defaults to the current URL.
-     *
-     * Must be HTTPS and on the SAME ORIGIN the storefront token was minted for;
-     * the server rejects anything else, since this URL is handed to a payment
-     * provider and an open redirect on a checkout is a phishing primitive.
-     */
-    returnUrl?: string;
-    /**
-     * Overrides the cart-derived idempotency key. Leave unset: the default is
-     * derived from the cart, which is what makes a shopper's double-tap on "Pay"
-     * return the SAME order instead of creating a second, abandoned one.
-     */
-    idempotencyKey?: string;
-    /** Defaults to the outlet the storefront booted against. */
-    outletId?: string;
-    /** Forwarded verbatim to the provider's Drop-in (`showPayButton`, `locale`, field styling, …). */
-    dropinConfiguration?: Record<string, unknown>;
-}
-/**
- * The created order. Deliberately says nothing about money having moved — see
- * `paymentStatus` and the `checkout` topic.
- */
-export interface StartCheckoutOrder {
-    orderId: string;
-    receiptId: string;
-    /** The SERVER-computed total in integer minor units — the only total that matters. */
-    serverTotal: number;
-    currency: string;
-    /**
-     * `ready` — the payment fields are mounted and the shopper can pay.
-     * `unavailable` — THE ORDER EXISTS but no payment could be started, so the
-     * shopper has NOT been charged. Never report this as a failed order.
-     */
-    paymentStatus: 'ready' | 'unavailable';
-    /**
-     * One-time password for reading this order back, returned only on the first
-     * create. It is the ONLY route to this order's status — the guest token
-     * grants order creation and deliberately not order reads — so a caller that
-     * drops it cannot check whether the payment settled.
-     */
-    orderPassword?: string;
-}
-export interface StartCheckoutResponse {
-    success: boolean;
-    timestamp: string;
-    order: StartCheckoutOrder;
-}
-/**
- * Creates the server-priced order and mounts the provider's hosted card fields.
- *
- * RESOLVES WHEN THE SHOPPER *CAN* PAY, NOT WHEN THEY HAVE. The shopper has not
- * typed a card yet when this returns. The outcome arrives on the `checkout`
- * topic instead.
- */
-export type StartCheckout = (params: StartCheckoutParams) => Promise<StartCheckoutResponse>;

package/dist/actions/start-checkout/types.js

@@ -1,10 +0,0 @@
-// Start Checkout Types
-//
-// The ONLINE counterpart of the POS tenders: a shopper on a published website
-// pays for the current cart with their own card. Mirrors kaching's storefront
-// `startCheckout` input and result. All money is integer MINOR currency units.
-//
-// This command is served ONLY by the storefront runtime (a published website).
-// On a register it does not exist, exactly as the till tenders (`cashPayment`,
-// `terminalPayment`, `tapToPayPayment`, `chargeMoto`) do not exist online.
-export {};

package/dist/pubsub/topics/checkout/checkout-started/types.d.ts

@@ -1,26 +0,0 @@
-import type { TopicEvent } from "../../../types";
-/**
- * Payload for checkout-started event
- *
- * The order EXISTS and is unpaid. `serverTotal` is the server's own price for
- * the cart, in integer minor units — the browser never sends a price, so this
- * is the first and only authoritative total.
- */
-export interface CheckoutStartedPayload {
-    orderId: string;
-    receiptId: string;
-    serverTotal: number;
-    currency: string;
-    /**
-     * `ready` — the payment fields are mounted and the shopper can pay.
-     * `unavailable` — the order exists but no payment could be started, so the
-     * shopper has NOT been charged.
-     */
-    paymentStatus: "ready" | "unavailable";
-    /** One-time password for reading this order back. Returned only on the first create. */
-    orderPassword?: string;
-}
-/**
- * Typed event for checkout-started
- */
-export type CheckoutStartedEvent = TopicEvent<CheckoutStartedPayload>;

package/dist/pubsub/topics/checkout/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * Checkout Topic Definition
- * Defines the checkout topic and its available event types
- */
-import type { TopicDefinition } from "../../types";
-export declare const checkoutTopic: TopicDefinition;
-export * from "./types";

package/dist/pubsub/topics/checkout/index.js

@@ -1,28 +0,0 @@
-/**
- * Checkout Topic Definition
- * Defines the checkout topic and its available event types
- */
-export const checkoutTopic = {
-    id: "checkout",
-    name: "Checkout",
-    description: "Topic for online (website) checkout events",
-    eventTypes: [
-        {
-            id: "checkout-started",
-            name: "Checkout Started",
-            description: "Published when the order has been created and the payment fields are mounted"
-        },
-        {
-            id: "payment-completed",
-            name: "Payment Completed",
-            description: "Published when the shopper's payment succeeds on their side (authorisation, not settlement)"
-        },
-        {
-            id: "payment-failed",
-            name: "Payment Failed",
-            description: "Published when a payment attempt is refused or errors; the shopper can retry"
-        }
-    ]
-};
-// Re-export types
-export * from "./types";

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

@@ -1,31 +0,0 @@
-import type { TopicEvent } from "../../../types";
-/**
- * Payload for payment-completed event
- *
- * THIS IS NOT SETTLEMENT. It reports that the SHOPPER'S side finished —
- * `resultCode` is the provider's own outcome, typically `Authorised`. The money
- * is confirmed by the provider's capture webhook reaching the backend, out of
- * band and after this page is done, so this event cannot and does not claim it.
- */
-export interface PaymentCompletedPayload {
-    orderId: string;
-    receiptId: string;
-    /** The provider's result code, e.g. `Authorised`. */
-    resultCode: string;
-    /**
-     * OPAQUE PROOF OF THIS PAYMENT, handed to the browser by the provider and to
-     * nobody else. Pass it to the order-status read and the server verifies it
-     * with the provider before believing a word of it.
-     *
-     * It is the only evidence of an outcome that exists outside the provider's
-     * webhook, so it is what recovers an order whose confirmation never arrived.
-     * Treat it as a credential: do not log it, do not put it in a URL you share.
-     *
-     * Absent when the provider reported no payment (see `resultCode`).
-     */
-    sessionResult?: string;
-}
-/**
- * Typed event for payment-completed
- */
-export type PaymentCompletedEvent = TopicEvent<PaymentCompletedPayload>;

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

@@ -1,20 +0,0 @@
-import type { TopicEvent } from "../../../types";
-/**
- * Payload for payment-failed event
- *
- * ONE DECLINED ATTEMPT, NOT A DEAD CHECKOUT. The order and the mounted payment
- * fields both survive, so the shopper can try another card without the page
- * starting a new checkout.
- */
-export interface PaymentFailedPayload {
-    orderId: string;
-    receiptId: string;
-    /** The provider's result code, e.g. `Refused`, or an error name. */
-    resultCode: string;
-    /** Present when the failure carried a message worth showing. */
-    message?: string;
-}
-/**
- * Typed event for payment-failed
- */
-export type PaymentFailedEvent = TopicEvent<PaymentFailedPayload>;

package/dist/pubsub/topics/checkout/types.d.ts

@@ -1,12 +0,0 @@
-/**
- * Checkout Topic Types
- * Aggregated types for all online-checkout events
- */
-export * from "./checkout-started/types";
-export * from "./payment-completed/types";
-export * from "./payment-failed/types";
-import type { CheckoutStartedPayload } from "./checkout-started/types";
-import type { PaymentCompletedPayload } from "./payment-completed/types";
-import type { PaymentFailedPayload } from "./payment-failed/types";
-export type CheckoutEventPayload = CheckoutStartedPayload | PaymentCompletedPayload | PaymentFailedPayload;
-export type CheckoutEventType = "checkout-started" | "payment-completed" | "payment-failed";

package/dist/pubsub/topics/checkout/types.js

@@ -1,8 +0,0 @@
-/**
- * Checkout Topic Types
- * Aggregated types for all online-checkout events
- */
-// Re-export all event types
-export * from "./checkout-started/types";
-export * from "./payment-completed/types";
-export * from "./payment-failed/types";