@openrails/billing-ui 0.236.0 → 0.238.0

package/dist/modal.d.ts

@@ -1,12 +1,6 @@
-import { CheckoutProps } from './checkout';
-import * as React from "react";
-export interface CheckoutModalProps extends CheckoutProps {
+import { OrderCheckoutProps } from './order-checkout';
+export interface OrderModalProps extends OrderCheckoutProps {
     open: boolean;
     onOpenChange: (open: boolean) => void;
-    /**
-     * Rendered instead of the checkout while set, e.g. the host's sign-in.
-     * Clear it to continue to payment in the same modal.
-     */
-    gate?: React.ReactNode;
 }
-export declare function CheckoutModal({ open, onOpenChange, onPhaseChange, gate, ...checkoutProps }: CheckoutModalProps): React.JSX.Element;
+export declare function OrderModal({ open, onOpenChange, ...checkout }: OrderModalProps): import("react").JSX.Element;

package/dist/offers.d.ts

@@ -1,13 +1,14 @@
 import { CheckoutAppearance } from './appearance';
-import { Product } from './client/types';
-import { PayResult } from './types';
+import { Order, Product } from './client/types';
 import * as React from "react";
 export interface OffersProps {
+    /** The id of the merchant whose catalog `keys` are looked up in. */
+    merchant?: string;
     /**
-     * What to sell: these product keys, such as a course, its bundle and the
-     * membership that also unlocks it, looked up in OpenRails' public catalog.
-     * The host's server names them (the Go Client's ListOffers finds the
-     * products granting an entitlement).
+     * What to sell: these product keys of `merchant`, such as a course, its
+     * bundle and the membership that also unlocks it, looked up in OpenRails'
+     * public catalog. The host's server names them (the Go Client's
+     * ListOffers finds the products granting an entitlement).
      */
     keys?: string[];
     /**
@@ -16,10 +17,10 @@ export interface OffersProps {
      */
     products?: Product[];
     /**
-     * The checkout succeeded. A hint: the host's own gate decides access, so
-     * send the buyer back to the content it guards.
+     * The order is paid. A hint: the host's own gate decides access, so send
+     * the buyer back to the content it guards.
      */
-    onPaid: (result: PayResult) => void;
+    onPaid: (order: Order) => void;
     /**
      * Buying needs a signed-in customer: called instead of the checkout when
      * `signedIn` is false or OpenRails answers 401.

package/dist/psp.d.ts

@@ -1,6 +1,4 @@
 import { z } from 'zod';
-import { PaymentMethod } from './client/types';
-import { PaymentOption, SavedPaymentMethod } from './types';
 export declare const pspConfigSchema: z.ZodObject<{
     psp_id: z.ZodString;
     key: z.ZodString;
@@ -14,8 +12,6 @@ export declare const pspConfigSchema: z.ZodObject<{
     retry_after: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 export type PspConfig = z.infer<typeof pspConfigSchema>;
-/** Whether a rail takes a card in the page (saved or new). */
-export declare const isCardRail: (rail: PaymentOption) => boolean;
 /** PSPs that take new purchases and new cards. */
 export declare const checkoutPsps: (psps: readonly PspConfig[]) => PspConfig[];
 /**
@@ -23,13 +19,9 @@ export declare const checkoutPsps: (psps: readonly PspConfig[]) => PspConfig[];
  * for again; null when none is.
  */
 export declare function cardRetryAfter(psps: readonly PspConfig[]): number | null;
-/** Saved cards the checkout can charge in place, for the given rails, newest first. */
-export declare function savedMethodsFor(methods: readonly PaymentMethod[], rails: readonly PaymentOption[]): SavedPaymentMethod[];
 export type CardSetupDriver = "collect_js" | "card" | "stripe_elements";
 /** How a card is saved with this PSP in the page, or null when it cannot be. */
 export declare function cardSetupDriver(psp: PspConfig): CardSetupDriver | null;
 export declare const canSavePaymentMethod: (psp: PspConfig) => boolean;
 /** Whether a pending payment on this PSP can be authenticated in the page. */
 export declare const canAuthenticatePayment: (psp: PspConfig) => boolean;
-/** The PSP config behind a checkout rail, for card setup and authentication. */
-export declare function railPsp(rail: PaymentOption): PspConfig;

package/dist/react/config.d.ts

@@ -1,31 +1,36 @@
-import { BillingClient } from '../client/client';
 import { BillingError } from '../client/errors';
-import { CurrencyScales, PublicConfig } from '../client/types';
-export interface ConfigState {
-    config: PublicConfig | null;
+import { CurrencyScales, CustomerConfig, PublicConfig } from '../client/types';
+export interface ConfigState<T = PublicConfig> {
+    config: T | null;
     loading: boolean;
     error: BillingError | null;
     refetch: () => void;
 }
-interface Snapshot {
-    config: PublicConfig | null;
+interface Snapshot<T> {
+    config: T | null;
     loading: boolean;
     error: BillingError | null;
 }
-/** One shared copy of `GET /config` per client, fetched on first use. */
-export interface ConfigStore {
+/** One shared copy of a configuration read per client, fetched on first use. */
+export interface ConfigStore<T = PublicConfig> {
     subscribe(listener: () => void): () => void;
-    snapshot(): Snapshot;
-    /** Fetches the document unless it was already requested. */
+    snapshot(): Snapshot<T>;
+    /** Fetches the document unless it is loaded or loading. */
     ensure(): void;
     refetch(): void;
 }
-export declare function createConfigStore(client: BillingClient): ConfigStore;
+export declare function createConfigStore<T>(read: () => Promise<T>): ConfigStore<T>;
 /**
- * The deployment's public configuration (`GET /config`), fetched once per
+ * The deployment's configuration (`GET /config`), fetched once per
  * `BillingProvider` and shared by every component that reads it.
  */
 export declare function useConfig(): ConfigState;
+/**
+ * The customer's merchant (`GET /me/config`): its payment setup and how it
+ * presents itself, fetched once per `BillingProvider` for the signed-in
+ * customer and shared by every component that reads it.
+ */
+export declare function useCustomerConfig(): ConfigState<CustomerConfig>;
 /**
  * Currency scales: the server's registry, under the client's pinned copy and
  * host overrides, which stand alone until the registry loads.

package/dist/react/context.d.ts

@@ -1,5 +1,5 @@
 import { BillingClient } from '../client/client';
-import { SubscriptionChange } from '../client/types';
+import { CustomerConfig, SubscriptionChange } from '../client/types';
 import { ConfigStore } from './config';
 export type BillingChange = {
     type: "subscription.canceled" | "subscription.resumed";
@@ -27,6 +27,8 @@ export interface BillingContextValue {
     refresh(): void;
     /** The shared `GET /config`; read it with `useConfig()`. */
     config: ConfigStore;
+    /** The shared `GET /me/config`; read it with `useCustomerConfig()`. */
+    customerConfig: ConfigStore<CustomerConfig>;
 }
 export declare const BillingContext: import('react').Context<BillingContextValue | null>;
 export declare function useBillingContext(): BillingContextValue;

package/dist/react/hooks.d.ts

@@ -43,13 +43,13 @@ export interface ProductsState {
     error: BillingError | null;
     refetch: () => void;
 }
-/** The product keys to look up: `ProductListOptions`. */
-export type ProductsOptions = Pick<ProductListOptions, "keys">;
+/** The merchant and its product keys to look up: `ProductListOptions`. */
+export type ProductsOptions = Pick<ProductListOptions, "merchant" | "keys">;
 /**
- * The products on sale named by `keys`, each with its active prices: a
- * public catalog lookup.
+ * The products `merchant` has on sale named by `keys`, each with its active
+ * prices: a public catalog lookup.
  */
-export declare function useProducts({ keys }: ProductsOptions): ProductsState;
+export declare function useProducts({ merchant, keys, }: ProductsOptions): ProductsState;
 export type PaymentMethodAction = "remove" | "default";
 export interface PaymentMethodsState {
     methods: PaymentMethod[] | null;

package/dist/react/index.d.ts

@@ -1,4 +1,4 @@
 export { BillingProvider, type BillingProviderProps } from './provider';
 export { useBillingClient, useBillingRefresh, useOptionalBillingContext, type BillingChange, type BillingContextValue, } from './context';
-export { useConfig, useCurrencyScales, type ConfigState, type ConfigStore, } from './config';
+export { useConfig, useCurrencyScales, useCustomerConfig, type ConfigState, type ConfigStore, } from './config';
 export { usePaymentMethods, usePayments, useProducts, useSubscriptions, type ActionResult, type PaymentMethodAction, type PaymentMethodsState, type PaymentsOptions, type PaymentsState, type ProductsOptions, type ProductsState, type SubscriptionAction, type SubscriptionsOptions, type SubscriptionsState, } from './hooks';

package/dist/react.js

@@ -1,2 +1,2 @@
-import { a as e, c as t, d as n, i as r, n as i, o as a, r as o, s, t as c, u as l } from "./hooks-2d-XjpuI.js";
-export { e as BillingProvider, t as useBillingClient, l as useBillingRefresh, a as useConfig, s as useCurrencyScales, n as useOptionalBillingContext, c as usePaymentMethods, i as usePayments, o as useProducts, r as useSubscriptions };
+import { a as e, c as t, d as n, f as r, i, l as a, n as o, o as s, r as c, s as l, t as u } from "./hooks-Bk80rNv8.js";
+export { e as BillingProvider, a as useBillingClient, n as useBillingRefresh, s as useConfig, l as useCurrencyScales, t as useCustomerConfig, r as useOptionalBillingContext, u as usePaymentMethods, o as usePayments, c as useProducts, i as useSubscriptions };