@openrails/billing-ui 0.236.0 → 0.238.0

package/dist/client/generated/wire.d.ts

@@ -8,8 +8,12 @@ export type Balance = {
     billing_mode: "arrears" | "prepaid";
     balance_amount: string;
     held_amount: string;
+    accrued_amount: string;
     available_amount: string;
     owed_amount: string;
+    accrual_rate_per_hour: string;
+    as_of: string;
+    depletes_at: string | null;
 };
 export type BalanceTransaction = {
     id: string;
@@ -49,13 +53,6 @@ export type CaptchaConfig = {
     action: string;
     token_header: string;
 };
-export type CaptchaStatus = {
-    enabled: boolean;
-    required: boolean;
-    provider: string | null;
-    token_header: string;
-    client_script_url: string;
-};
 export type CardDetails = {
     brand: string | null;
     last4: string | null;
@@ -76,71 +73,6 @@ export type Cart = {
     last_changed_at: string | null;
     expires_at: string | null;
 };
-export type CheckoutSession = {
-    id: string;
-    status: string;
-    merchant: CheckoutSessionMerchant;
-    plan: CheckoutSessionPlan;
-    line_items: CheckoutSessionLineItem[];
-    tax: string | null;
-    due_today: string | null;
-    options: CheckoutSessionOption[];
-    saved_methods: CheckoutSessionSavedMethod[];
-    next_action: NextAction | null;
-    operation: PaymentOperation | null;
-    payment_id: string | null;
-    subscription_id: string | null;
-    failure_message: string | null;
-    failure: PaymentFailure | null;
-    success_url: string | null;
-    embed_origin: string | null;
-    expires_at: string;
-};
-export type CheckoutSessionLineItem = {
-    label: string;
-    sublabel: string | null;
-    amount: string;
-};
-export type CheckoutSessionLink = {
-    id: string;
-    url: string | null;
-    expires_at: string;
-};
-export type CheckoutSessionMerchant = {
-    display_name: string;
-};
-export type CheckoutSessionOption = {
-    id: string;
-    psp_id: string;
-    rail: string;
-    mode: string;
-    driver: string;
-    public_config: Record<string, string> | null;
-};
-export type CheckoutSessionPayResult = {
-    status: string;
-    next_action: NextAction | null;
-    operation: PaymentOperation | null;
-    payment_id: string | null;
-    subscription_id: string | null;
-    failure_message: string | null;
-    failure: PaymentFailure | null;
-};
-export type CheckoutSessionPlan = {
-    auto_renew: boolean;
-    display_name: string;
-    unit_amount: string;
-    currency: string;
-    unit_decimals: number;
-    billing_interval_hours: number | null;
-    access_duration_hours: number | null;
-};
-export type CheckoutSessionSavedMethod = {
-    id: string;
-    option_id: string;
-    rail: string;
-    card: CardDetails | null;
-};
 export type CreateMyOrderParams = {
     lines?: OrderLineParams[];
     cart?: boolean;
@@ -188,6 +120,10 @@ export type CustomerChangeSubscriptionParams = {
     quantity?: number | null;
     signature?: string;
 };
+export type CustomerConfig = {
+    payment: PaymentConfig;
+    merchant: PublicMerchant;
+};
 export type CustomerEntitlement = {
     customer_id: string;
     entitlement: string;
@@ -219,62 +155,10 @@ export type DriftField = {
 export type Health = {
     status: "ok" | "ready";
 };
-export type Invoice = {
-    id: string;
-    customer_id: string;
-    currency: string;
-    invoice_number: string | null;
-    period_starts_at: string;
-    period_ends_at: string;
-    usage_total: string;
-    deposits_total: string;
-    owed_accrued: string;
-    owed_paid: string;
-    closing_balance: string;
-    subtotal_amount: string;
-    total_amount: string;
-    amount_paid: string;
-    amount_due: string;
-    line_items: InvoiceLineItem[];
-    money_movements: Record<string, string> | null;
-    po_number: string | null;
-    tax: Record<string, unknown> | null;
-    billing_contacts: InvoiceContact[];
-    memo: string | null;
-    status: "draft" | "open" | "paid" | "uncollectible" | "voided";
-    collection_method: "charge_automatically" | "send_invoice";
-    issued_at: string | null;
-    due_at: string | null;
-    delinquent: boolean;
-    paid_at: string | null;
-    voided_at: string | null;
-    uncollectible_at: string | null;
-    finalized_at: string | null;
-    external_invoice_id: string | null;
-    collection_failure_count: number;
-    collection_failed_at: string | null;
-    next_collection_attempt_at: string | null;
-    last_collection_failure_code: string | null;
-    recovery: PaymentRecovery | null;
-    available_actions: ("mark_uncollectible" | "record_payment" | "retry_collection" | "void")[];
-    created_at: string;
-};
 export type InvoiceContact = {
     name: string;
     email: string;
 };
-export type InvoiceLineItem = {
-    event_type: string;
-    amount: string;
-    count: number;
-    dimensions: Record<string, number> | null;
-};
-export type InvoicePayNow = {
-    invoice: Invoice;
-    payment_id: string | null;
-    operation: PaymentOperation;
-    replayed: boolean;
-};
 export type Mandate = {
     id: string;
     customer_id: string;
@@ -298,14 +182,6 @@ export type MarkNotificationsReadParams = {
     notification_ids?: string[];
     all?: boolean;
 };
-export type MintCheckoutSessionParams = {
-    price_id?: string;
-    price_key?: string;
-    product_key?: string;
-    amount?: string;
-    auto_renew?: boolean;
-    success_url?: string;
-};
 export type NetworkLinkChallenge = {
     id: string;
     nonce: string;
@@ -346,12 +222,10 @@ export type NotificationData = {
     downgrade_applied?: boolean;
     new_product?: string;
     overdue_amount?: string;
-    overdue_invoices?: number;
+    overdue_orders?: number;
     overdue_started_at?: string;
     from_state?: string;
     to_state?: string;
-    invoice_id?: string;
-    invoice_number?: string;
     amount_due?: string;
     due_at?: string;
     failure_code?: string;
@@ -373,8 +247,8 @@ export type NotificationData = {
 export type Order = {
     id: string;
     customer_id: string;
-    origin: "customer" | "merchant" | "subscription";
-    status: "canceled" | "complete" | "expired" | "open" | "processing" | "void";
+    origin: "customer" | "merchant" | "subscription" | "usage";
+    status: "canceled" | "complete" | "expired" | "open" | "processing" | "uncollectible" | "void";
     number: string | null;
     currency: string;
     total: string;
@@ -383,15 +257,18 @@ export type Order = {
     payment_options: OrderPaymentOption[];
     checkout: OrderCheckout | null;
     renewal: OrderRenewal | null;
+    usage: OrderUsage | null;
     expires_at: string | null;
     completed_at: string | null;
     canceled_at: string | null;
     expired_at: string | null;
     voided_at: string | null;
+    uncollectible_at: string | null;
     created_at: string;
 };
 export type OrderCheckout = {
     url: string | null;
+    ui_mode: "embedded" | "hosted";
     expires_at: string;
     success_url: string;
     cancel_url: string | null;
@@ -399,13 +276,14 @@ export type OrderCheckout = {
 };
 export type OrderLine = {
     id: string;
-    price_id: string;
-    product_id: string;
+    price_id: string | null;
+    product_id: string | null;
+    source: string | null;
     description: string;
     quantity: number | null;
     unit_amount: string;
     amount: string;
-    ownership: "consumable" | "extend" | "unique";
+    ownership: "consumable" | "extend" | "unique" | null;
     billing_interval_hours: number | null;
     access_duration_hours: number | null;
     subscription_id: string | null;
@@ -466,6 +344,20 @@ export type OrderRenewal = {
     period_ends_at: string;
     due_at: string;
 };
+export type OrderUsage = {
+    period_starts_at: string;
+    period_ends_at: string;
+    due_at: string;
+    amount_paid: string;
+    amount_due: string;
+    collection_method: "charge_automatically" | "send_invoice";
+    next_collection_attempt_at: string | null;
+    po_number: string | null;
+    memo: string | null;
+    tax: Record<string, unknown> | null;
+    billing_contacts: InvoiceContact[];
+    delinquent: boolean;
+};
 export type PSPLinkState = {
     status: "error" | "linked" | "pending_manual_link" | "sync_disabled";
     ids: Record<string, string> | null;
@@ -486,17 +378,6 @@ export type PSPPaymentConfig = {
     status?: string;
     retry_after?: number;
 };
-export type PayCheckoutSessionParams = {
-    option_id?: string;
-    payment_method_id?: string;
-    payment_token?: string;
-    card?: CardEntry;
-    billing_details?: BillingDetails;
-    token_symbol?: string;
-};
-export type PayInvoiceParams = {
-    payment_method_id?: string;
-};
 export type PayOrderParams = {
     payment?: OrderPaymentParams;
     expected_total?: string;
@@ -512,7 +393,6 @@ export type Payment = {
     customer_id: string;
     subscription_id: string | null;
     order_id: string | null;
-    invoice_id: string | null;
     quantity: number | null;
     price_id: string | null;
     price: Price | null;
@@ -566,15 +446,10 @@ export type PaymentMethodSubscription = {
     display_name: string;
     created_at: string;
 };
-export type PaymentOperation = {
-    id: string;
-    status: string;
-};
 export type PaymentRecovery = {
     last_failure_reason?: string;
     retryable: boolean;
     blocked_reason?: string;
-    operation?: PaymentOperation;
     order_id?: string;
 };
 export type PendingAction = {
@@ -640,14 +515,18 @@ export type PublicConfig = {
     capabilities: Capabilities;
     currencies: CurrencyUnits[];
     rails: RailDefinition[];
-    payment: PaymentConfig | null;
-    merchant: PublicMerchant | null;
     captcha: CaptchaConfig | null;
+    network: PublicNetwork | null;
 };
 export type PublicMerchant = {
     display_name: string;
     logo_url: string | null;
     support_url: string | null;
+    embed_origins: string[];
+};
+export type PublicNetwork = {
+    issuer: string;
+    client_id: string;
 };
 export type Quantity = {
     min: number;
@@ -659,11 +538,6 @@ export type RailDefinition = {
     credential_keys: string[];
     setting_keys: string[];
 };
-export type ReplacePaymentMethodCardParams = {
-    payment_token?: string;
-    card?: CardEntry;
-    billing_details?: BillingDetails;
-};
 export type RetrySubscriptionNowParams = {
     payment_method_id?: string;
 };
@@ -712,12 +586,6 @@ export type SolanaPaymentToken = {
     preferred: boolean;
     recurring_eligible: boolean;
 };
-export type StripeEngineAuthentication = {
-    operation: PaymentOperation;
-    payment_intent_id?: string;
-    client_secret?: string;
-    provider_payment_method_id?: string;
-};
 export type StripePortalSession = {
     url: string;
 };
@@ -782,7 +650,6 @@ export type SubscriptionChange = {
     amount_due_now: string;
     next_charge_amount: string;
     next_charge_date?: string;
-    operation_id?: string;
 };
 export type SubscriptionChangePreview = {
     effective: string;
@@ -806,37 +673,9 @@ export type SubscriptionDunning = {
 };
 export type SubscriptionRetryNowResult = {
     subscription: Subscription;
-    operation: PaymentOperation;
+    status: string;
     replayed: boolean;
 };
-export type SupportedTokensResponse = {
-    tokens: TokenInfo[];
-};
-export type TokenBalance = {
-    amount: string;
-    units: string;
-    sufficient: boolean;
-};
-export type TokenInfo = {
-    symbol: string;
-    name: string;
-    mint: string;
-    decimals: number;
-    price?: string;
-    preferred: boolean;
-    recurring_eligible: boolean;
-    quote?: TokenQuote;
-    balance?: TokenBalance;
-};
-export type TokenQuote = {
-    amount: string;
-    units: string;
-    token_price_usd: string;
-    fx_rate: string;
-    fx_currency: string;
-    quoted_at: string;
-    expires_at: string;
-};
 export type UpdatePaymentMethodParams = {
     exp_month?: number;
     exp_year?: number;

package/dist/client/index.d.ts

@@ -1,4 +1,5 @@
 export { CANCEL_REASON_MAX, CANCEL_REASON_MIN, createBillingClient, isWalletAction, isWalletRejection, RETRY_BUDGET_MS, signWalletAction, WalletRejectedError, type BillingClient, type BillingClientOptions, type ListOptions, type OrderResult, type ProductListOptions, type SendSolanaTransaction, type SubscriptionChangeInput, } from './client';
+export { redeemAssertion, tokenSource, type RedeemAssertionOptions, type TokenResponse, type TokenSource, type TokenSourceOptions, } from './token-source';
 export { BillingError, isBillingError, isServerError, readBillingError, toBillingError, type BillingErrorBody, } from './errors';
-export type { Account, Balance, CaptchaConfig, CardSummary, Cart, Currency, CurrencyScales, PaymentConfig, PaymentFailure, PublicConfig, PublicMerchant, CheckoutSessionLink, Invoice, ListPage, NewCard, NextAction, Order, OrderLine, OrderLineRefusal, OrderNextAction, OrderPaymentInput, OrderPreviewLine, Page, Payment, PaymentAuthentication, PaymentMethod, PaymentOperation, PaymentRecovery, Price, Product, SolanaToken, Subscription, SubscriptionDunning, SubscriptionProduct, SubscriptionStatus, SubscriptionChange, SubscriptionChangePreview, } from './types';
+export type { Account, Balance, CaptchaConfig, CardSummary, Cart, Currency, CurrencyScales, CustomerConfig, CustomerLink, PaymentConfig, PaymentFailure, PublicConfig, PublicMerchant, ListPage, NetworkLinkChallenge, NewCard, NextAction, Order, OrderLine, OrderLineRefusal, OrderPaymentInput, OrderPreviewLine, Page, Payment, PaymentMethod, PaymentRecovery, Price, Product, Subscription, SubscriptionDunning, SubscriptionProduct, SubscriptionStatus, SubscriptionChange, SubscriptionChangePreview, } from './types';
 export { amountToDecimal, decimalToAmount, formatAmount, type Amount, } from '../lib/money';

package/dist/client/token-source.d.ts

@@ -0,0 +1,60 @@
+/** A token endpoint's answer (RFC 6749 §5.1). */
+export interface TokenResponse {
+    access_token: string;
+    /** Seconds until the token expires. */
+    expires_in: number;
+}
+export interface TokenSourceOptions {
+    /**
+     * Asks the host for the customer's access token: one bound to the
+     * merchant, from the host's own backend or `redeemAssertion`.
+     */
+    fetchToken: () => Promise<TokenResponse>;
+    /** Seconds before its expiry at which a token is replaced. Default 60. */
+    skew?: number;
+}
+/**
+ * A `getToken` for `createBillingClient`: the current token, fetched when
+ * there is none or the cached one is about to expire.
+ */
+export interface TokenSource {
+    (): Promise<string>;
+    /**
+     * Drops the cached token, so the next call fetches a new one. With
+     * `token`, only when that is the one cached.
+     */
+    invalidate(token?: string): void;
+}
+/**
+ * Keeps the customer's access token for a billing client: it caches the
+ * token until `skew` seconds before it expires and fetches the next one with
+ * a single request, however many calls are waiting. A failed fetch is not
+ * cached. Tokens stay in memory, never in browser storage, so a reload
+ * fetches again. The client retries a call answered 401 `credential_expired`
+ * once with a new token.
+ */
+export declare function tokenSource({ fetchToken, skew, }: TokenSourceOptions): TokenSource;
+/** Whether `getToken` is a `tokenSource`, whose token the client can replace. */
+export declare const isTokenSource: (getToken: unknown) => getToken is TokenSource;
+export interface RedeemAssertionOptions {
+    /** The authorization server's token endpoint, such as `https://billing.example/oauth2/token`. */
+    tokenEndpoint: string;
+    /**
+     * The assertion the merchant's backend signed for this customer (RFC
+     * 7523): single use and minutes long, so redeem each one once.
+     */
+    assertion: string;
+    /**
+     * Transport. Pass a fetch that adds a DPoP proof (auth-ui's `dpopFetch`)
+     * to bind the token to the browser's key.
+     */
+    fetch?: (input: string, init: RequestInit) => Promise<Response>;
+}
+/**
+ * Redeems a customer assertion for an access token to OpenRails
+ * (`scope=openrails:self`): a `fetchToken` for `tokenSource`, after the
+ * host's backend signed the assertion.
+ */
+export declare function redeemAssertion(options: RedeemAssertionOptions): Promise<TokenResponse & {
+    token_type: string;
+}>;