@openrails/billing-ui 0.0.0-stage → 0.233.2

package/dist/react/hooks.d.ts

@@ -0,0 +1,82 @@
+import { SendSolanaTransaction } from '../client/client';
+import { BillingError } from '../client/errors';
+import { NewCard, Payment, PaymentMethod, Product, Subscription, TierChange } from '../client/types';
+export type ActionResult = Promise<BillingError | null>;
+/** `signing` and `confirming` are a wallet step's stages. */
+export type SubscriptionAction = "cancel" | "resume" | "payment_method" | "change_tier" | "signing" | "confirming";
+export interface SubscriptionsOptions {
+    /** Server filter; default `all`. */
+    status?: string;
+    limit?: number;
+}
+export interface SubscriptionsState {
+    subscriptions: Subscription[] | null;
+    /** The next page's cursor; null on the last page. */
+    nextCursor: string | null;
+    loading: boolean;
+    error: BillingError | null;
+    refetch: () => void;
+    /** In-flight action per subscription id. */
+    pending: Readonly<Record<string, SubscriptionAction>>;
+    /**
+     * Cancels at period end. A Solana subscription is canceled by the wallet:
+     * pass `sendTransaction`; without it the cancel resolves to a
+     * `wallet_required` error.
+     */
+    cancel: (subscriptionId: string, reason: string, sendTransaction?: SendSolanaTransaction) => ActionResult;
+    resume: (subscriptionId: string) => ActionResult;
+    setPaymentMethod: (subscriptionId: string, paymentMethodId: string) => ActionResult;
+    /**
+     * Resolves to the change, whose `status` may still be `processing` or
+     * `requires_action`, or to the error. A Solana change is signed with
+     * `sendTransaction` and resolves once the chain confirms it.
+     */
+    changeTier: (subscriptionId: string, input: {
+        priceId: string;
+        idempotencyKey: string;
+    }, sendTransaction?: SendSolanaTransaction) => Promise<TierChange | BillingError>;
+}
+export declare function useSubscriptions(options?: SubscriptionsOptions): SubscriptionsState;
+export interface ProductsState {
+    products: Product[] | null;
+    /** The cursor of the next page; null on the last. */
+    nextCursor: string | null;
+    loading: boolean;
+    error: BillingError | null;
+    refetch: () => void;
+}
+/** The catalog: active products with their active prices. */
+export declare function useProducts(options?: {
+    limit?: number;
+}): ProductsState;
+export type PaymentMethodAction = "remove" | "collection";
+export interface PaymentMethodsState {
+    methods: PaymentMethod[] | null;
+    loading: boolean;
+    error: BillingError | null;
+    refetch: () => void;
+    pending: Readonly<Record<string, PaymentMethodAction>>;
+    adding: boolean;
+    add: (card: NewCard) => ActionResult;
+    remove: (paymentMethodId: string) => ActionResult;
+    /** Makes the card the one that collects one currency's invoices. */
+    setCollection: (paymentMethodId: string, currency: string) => ActionResult;
+}
+export declare function usePaymentMethods(): PaymentMethodsState;
+export interface PaymentsOptions {
+    pageSize?: number;
+    /** Filter by rail. */
+    rail?: string;
+}
+export interface PaymentsState {
+    payments: Payment[] | null;
+    /** Zero-based. */
+    page: number;
+    hasMore: boolean;
+    loading: boolean;
+    error: BillingError | null;
+    next: () => void;
+    previous: () => void;
+    refetch: () => void;
+}
+export declare function usePayments(options?: PaymentsOptions): PaymentsState;

package/dist/react/index.d.ts

@@ -0,0 +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 { usePaymentMethods, usePayments, useProducts, useSubscriptions, type ActionResult, type PaymentMethodAction, type PaymentMethodsState, type PaymentsOptions, type PaymentsState, type ProductsState, type SubscriptionAction, type SubscriptionsOptions, type SubscriptionsState, } from './hooks';

package/dist/react/provider.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+import { BillingClient } from '../client/client';
+import { BillingChange } from './context';
+export interface BillingProviderProps {
+    client: BillingClient;
+    /** Fires after each successful mutation: the host's cache-invalidation hook. */
+    onChange?: (change: BillingChange) => void;
+    children?: ReactNode;
+}
+export declare function BillingProvider({ client, onChange, children, }: BillingProviderProps): import("react").JSX.Element;

package/dist/react/remote.d.ts

@@ -0,0 +1,10 @@
+import { BillingError } from '../client/errors';
+export interface RemoteState<T> {
+    data: T | null;
+    loading: boolean;
+    error: BillingError | null;
+    refetch: () => void;
+}
+export declare function useRemote<T>(key: string, load: (signal: AbortSignal) => Promise<T>): RemoteState<T> & {
+    replace: (update: (data: T) => T) => void;
+};

package/dist/react.js

@@ -0,0 +1,33 @@
+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 "./config-BQELtBh4.js";
+import { useCallback as d, useEffect as f, useMemo as p, useRef as m, useState as h } from "react";
+import { jsx as g } from "react/jsx-runtime";
+//#region src/react/provider.tsx
+function _({ client: e, onChange: n, children: r }) {
+	let [i, a] = h(0), o = m(n);
+	f(() => {
+		o.current = n;
+	});
+	let s = d((e) => {
+		a((e) => e + 1), o.current?.(e);
+	}, []), c = d(() => a((e) => e + 1), []), l = p(() => u(e), [e]), _ = p(() => ({
+		client: e,
+		version: i,
+		notify: s,
+		refresh: c,
+		config: l
+	}), [
+		e,
+		i,
+		s,
+		c,
+		l
+	]);
+	return /* @__PURE__ */ g(t.Provider, {
+		value: _,
+		children: r
+	});
+}
+//#endregion
+export { _ as BillingProvider, a as useBillingClient, n as useBillingRefresh, o as useConfig, c as useCurrencyScales, r as useOptionalBillingContext, i as usePaymentMethods, e as usePayments, s as useProducts, l as useSubscriptions };
+
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","names":[],"sources":["../src/react/provider.tsx"],"sourcesContent":["import {\n  useCallback,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n  type ReactNode,\n} from \"react\"\n\nimport type { BillingClient } from \"../client/client\"\nimport { createConfigStore } from \"./config\"\nimport { BillingContext, type BillingChange } from \"./context\"\n\nexport interface BillingProviderProps {\n  client: BillingClient\n  /** Fires after each successful mutation: the host's cache-invalidation hook. */\n  onChange?: (change: BillingChange) => void\n  children?: ReactNode\n}\n\nexport function BillingProvider({\n  client,\n  onChange,\n  children,\n}: BillingProviderProps) {\n  const [version, setVersion] = useState(0)\n  const onChangeRef = useRef(onChange)\n  useEffect(() => {\n    onChangeRef.current = onChange\n  })\n  const notify = useCallback((change: BillingChange) => {\n    setVersion((v) => v + 1)\n    onChangeRef.current?.(change)\n  }, [])\n  const refresh = useCallback(() => setVersion((v) => v + 1), [])\n  const config = useMemo(() => createConfigStore(client), [client])\n  const value = useMemo(\n    () => ({ client, version, notify, refresh, config }),\n    [client, version, notify, refresh, config]\n  )\n  return (\n    <BillingContext.Provider value={value}>{children}</BillingContext.Provider>\n  )\n}\n"],"mappings":";;;;AAoBA,SAAgB,EAAgB,EAC9B,WACA,aACA,eACuB;CACvB,IAAM,CAAC,GAAS,KAAc,EAAS,CAAC,GAClC,IAAc,EAAO,CAAQ;CACnC,QAAgB;EACd,EAAY,UAAU;CACxB,CAAC;CACD,IAAM,IAAS,GAAa,MAA0B;EAEpD,AADA,GAAY,MAAM,IAAI,CAAC,GACvB,EAAY,UAAU,CAAM;CAC9B,GAAG,CAAC,CAAC,GACC,IAAU,QAAkB,GAAY,MAAM,IAAI,CAAC,GAAG,CAAC,CAAC,GACxD,IAAS,QAAc,EAAkB,CAAM,GAAG,CAAC,CAAM,CAAC,GAC1D,IAAQ,SACL;EAAE;EAAQ;EAAS;EAAQ;EAAS;CAAO,IAClD;EAAC;EAAQ;EAAS;EAAQ;EAAS;CAAM,CAC3C;CACA,OACE,kBAAC,EAAe,UAAhB;EAAgC;EAAQ;CAAkC,CAAA;AAE9E"}

package/dist/save-payment-method.d.ts

@@ -0,0 +1,26 @@
+import { CheckoutAppearance } from './appearance';
+import { PspConfig } from './psp';
+import * as React from "react";
+export interface SavePaymentMethodProps {
+    /** The PSP to save the card with, from OpenRails's payment config. */
+    psp: PspConfig;
+    onSaved: (paymentMethodId: string) => void;
+    /**
+     * Where the provider returns after an off-page verification (3-D Secure),
+     * given the setup id to confirm with `client.confirmCardSetup`. Default:
+     * the current page with `?setup_id=`.
+     */
+    returnURL?: (setupId: string) => string;
+    /** Billing country to preselect; default: the browser locale's region. */
+    defaultCountry?: string;
+    submitLabel?: string;
+    appearance?: CheckoutAppearance;
+    className?: string;
+}
+/**
+ * Saves a card to the customer's account with any PSP OpenRails serves, in
+ * the page. The PSP's configuration picks the flow: card data enters the
+ * provider's own frames, or, for a PSP whose card_entry is server, is posted
+ * to OpenRails. Requires `BillingProvider`.
+ */
+export declare function SavePaymentMethod(props: SavePaymentMethodProps): React.JSX.Element;

package/dist/scope-context.d.ts

@@ -0,0 +1,17 @@
+import { CSSProperties } from 'react';
+import { CheckoutAppearance, CheckoutTheme } from './appearance';
+export type Navigate = (to: string) => void;
+export interface UiSettings {
+    appearance?: CheckoutAppearance;
+    locale?: string;
+    navigate?: Navigate;
+}
+export declare const UiContext: import('react').Context<UiSettings>;
+export declare const useUiSettings: () => UiSettings;
+export interface ScopeProps {
+    className: string;
+    "data-orck-theme": CheckoutTheme;
+    style?: CSSProperties;
+}
+/** Props that make an element a styling root; portals carry them too. */
+export declare function useScopeProps(appearance?: CheckoutAppearance): ScopeProps;

package/dist/scope.d.ts

@@ -0,0 +1,6 @@
+import { ComponentProps } from 'react';
+import { CheckoutAppearance } from './appearance';
+/** Styling root for in-page billing surfaces. */
+export declare function BillingUiRoot({ appearance, className, style, ...props }: ComponentProps<"div"> & {
+    appearance?: CheckoutAppearance;
+}): import("react").JSX.Element;

package/dist/source.d.ts

@@ -0,0 +1,5 @@
+import { CheckoutSession, PayRequest, PayResult } from './types';
+export interface CheckoutSource {
+    getSession(): Promise<CheckoutSession>;
+    pay(request: PayRequest): Promise<PayResult>;
+}