@openrails/billing-ui 0.237.0 → 0.239.0

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

@@ -2,6 +2,29 @@ export type ListPage<T> = {
     data: T[];
     next_cursor: string | null;
 };
+export type Agreement = {
+    id: string;
+    kind: "card_on_file" | "recurring" | "unscheduled";
+    status: "active" | "ended" | "requires_reconsent" | "revoked";
+    currency: string;
+    payment_method_id: string | null;
+    card: CardDetails | null;
+    subscription: AgreementSubscription | null;
+    accepted_at: string;
+    ended_at: string | null;
+};
+export type AgreementRevocation = {
+    agreement: Agreement;
+    subscription: Subscription | null;
+    usage_order: Order | null;
+};
+export type AgreementSubscription = {
+    id: string;
+    product: string;
+    amount: string;
+    billing_interval_hours: number | null;
+    next_charge_at: string | null;
+};
 export type Balance = {
     customer_id: string;
     currency: string;
@@ -120,6 +143,10 @@ export type CustomerChangeSubscriptionParams = {
     quantity?: number | null;
     signature?: string;
 };
+export type CustomerConfig = {
+    payment: PaymentConfig;
+    merchant: PublicMerchant;
+};
 export type CustomerEntitlement = {
     customer_id: string;
     entitlement: string;
@@ -442,15 +469,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 = {
@@ -516,8 +538,6 @@ export type PublicConfig = {
     capabilities: Capabilities;
     currencies: CurrencyUnits[];
     rails: RailDefinition[];
-    payment: PaymentConfig | null;
-    merchant: PublicMerchant | null;
     captcha: CaptchaConfig | null;
     network: PublicNetwork | null;
 };
@@ -589,12 +609,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;
 };
@@ -659,7 +673,6 @@ export type SubscriptionChange = {
     amount_due_now: string;
     next_charge_amount: string;
     next_charge_date?: string;
-    operation_id?: string;
 };
 export type SubscriptionChangePreview = {
     effective: string;
@@ -683,7 +696,7 @@ export type SubscriptionDunning = {
 };
 export type SubscriptionRetryNowResult = {
     subscription: Subscription;
-    operation: PaymentOperation;
+    status: string;
     replayed: boolean;
 };
 export type UpdatePaymentMethodParams = {
@@ -699,6 +712,7 @@ export type Usage = {
     to: string;
     group_by: "event_type" | "invoker" | "resource";
     rows: UsageRow[];
+    next_cursor: string | null;
 };
 export type UsageRow = {
     key: string;

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 { 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, type UsageOptions, } 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, CustomerLink, PaymentConfig, PaymentFailure, PublicConfig, PublicMerchant, ListPage, NetworkLinkChallenge, NewCard, NextAction, Order, OrderLine, OrderLineRefusal, OrderNextAction, OrderPaymentInput, OrderPreviewLine, Page, Payment, PaymentAuthentication, PaymentMethod, PaymentOperation, PaymentRecovery, Price, Product, 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, Usage, UsageRow, } 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;
+}>;

package/dist/client/types.d.ts

@@ -35,7 +35,7 @@ export declare const pspLinkStateSchema: z.ZodObject<{
     sync_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 /**
- * A catalog price, embedded in a product (`GET /catalog/products`): `unit_amount` of
+ * A catalog price, embedded in a product (`GET /products`): `unit_amount` of
  * `currency` for `access_duration_hours` of access (null: for good),
  * charging every `billing_interval_hours` (null: one-time).
  */
@@ -82,33 +82,27 @@ export declare const cardSummarySchema: z.ZodObject<{
     exp_year: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 export type CardSummary = z.infer<typeof cardSummarySchema>;
-export declare const paymentOperationSchema: z.ZodObject<{
-    id: z.ZodString;
-    status: z.ZodString;
-}, z.core.$strip>;
-export type PaymentOperation = z.infer<typeof paymentOperationSchema>;
 export declare const paymentRecoverySchema: z.ZodObject<{
     last_failure_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     retryable: z.ZodBoolean;
     blocked_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    operation: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodString;
-        status: z.ZodString;
-    }, z.core.$strip>>>;
     order_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type PaymentRecovery = z.infer<typeof paymentRecoverySchema>;
 /**
- * A step the customer takes before an action completes. With
- * `solana_sign_transactions` the wallet signs and sends `transactions` in
- * order; the action is then repeated with the last signature.
+ * What the customer completes before an action or payment can finish:
+ * `authenticate` runs the PSP's own script with `payload` (Stripe.js
+ * `handleNextAction` with `client_secret`), then the payable is confirmed;
+ * `redirect_to_url` leaves for `url`; with `solana_sign_transactions` the
+ * wallet signs and sends `transactions` in order and the action is repeated
+ * with the last signature.
  */
 export declare const nextActionSchema: z.ZodObject<{
     type: z.ZodString;
-    redirect_to_url: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, z.core.$strip>>>;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    psp_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     transactions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+    payload: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
 }, z.core.$strip>;
 export type NextAction = z.infer<typeof nextActionSchema>;
 /**
@@ -242,18 +236,14 @@ export declare const subscriptionSchema: z.ZodObject<{
         last_failure_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         retryable: z.ZodBoolean;
         blocked_reason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        operation: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            id: z.ZodString;
-            status: z.ZodString;
-        }, z.core.$strip>>>;
         order_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>>;
     next_action: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         type: z.ZodString;
-        redirect_to_url: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strip>>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        psp_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         transactions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        payload: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
     }, z.core.$strip>>>;
     created_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updated_at: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -326,19 +316,6 @@ export declare const paymentFailureSchema: z.ZodObject<{
     field: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type PaymentFailure = z.infer<typeof paymentFailureSchema>;
-/**
- * What the customer completes before a payment can finish: `authenticate`
- * runs the PSP's own script with `payload` (Stripe.js `handleNextAction`
- * with `client_secret`); `redirect_to_url` leaves for `url`.
- */
-export declare const orderNextActionSchema: z.ZodObject<{
-    type: z.ZodString;
-    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    psp_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    transactions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
-    payload: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
-}, z.core.$strip>;
-export type OrderNextAction = z.infer<typeof orderNextActionSchema>;
 /**
  * One line of an order. A purchased line names its price and product; a
  * usage order's line names its accrual source (`metered:<meter>`) instead.
@@ -740,6 +717,37 @@ export declare const accountSchema: z.ZodObject<{
     unread_notifications: z.ZodNumber;
 }, z.core.$strip>;
 export type Account = z.infer<typeof accountSchema>;
+/**
+ * One group of a usage report: its events and their total `amount`.
+ * `dimensions` are the summed event dimensions when grouped by event type.
+ */
+export declare const usageRowSchema: z.ZodObject<{
+    key: z.ZodString;
+    event_count: z.ZodNumber;
+    amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+    dimensions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>>;
+}, z.core.$strip>;
+export type UsageRow = z.infer<typeof usageRowSchema>;
+/**
+ * One page of the customer's usage in `currency` over [`from`, `to`): its
+ * groups by total amount, largest first, then by key. `next_cursor` reads the
+ * next page; null on the last.
+ */
+export declare const usageSchema: z.ZodObject<{
+    customer_id: z.ZodString;
+    currency: z.ZodString;
+    from: z.ZodString;
+    to: z.ZodString;
+    group_by: z.ZodString;
+    rows: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        event_count: z.ZodNumber;
+        amount: z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>;
+        dimensions: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNumber>>>;
+    }, z.core.$strip>>;
+    next_cursor: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>;
+}, z.core.$strip>;
+export type Usage = z.infer<typeof usageSchema>;
 /** Currency code (upper case) to its native-unit scale. */
 export type CurrencyScales = Readonly<Record<string, number>>;
 export declare const currencySchema: z.ZodObject<{
@@ -769,10 +777,10 @@ export declare const subscriptionChangeSchema: z.ZodObject<{
     subscription_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     next_action: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         type: z.ZodString;
-        redirect_to_url: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        }, z.core.$strip>>>;
+        url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        psp_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         transactions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
+        payload: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
     }, z.core.$strip>>>;
     delayed_start: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     currency: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -780,7 +788,6 @@ export declare const subscriptionChangeSchema: z.ZodObject<{
     next_charge_amount: z.ZodOptional<z.ZodNullable<z.ZodString & z.ZodType<string, string, z.core.$ZodTypeInternals<string, string>>>>;
     next_charge_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     message: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    operation_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type SubscriptionChange = z.infer<typeof subscriptionChangeSchema>;
 /**
@@ -865,12 +872,6 @@ export declare const captchaConfigSchema: z.ZodObject<{
     token_header: z.ZodString;
 }, z.core.$strip>;
 export type CaptchaConfig = z.infer<typeof captchaConfigSchema>;
-/**
- * What a browser needs to know about the deployment and its merchant
- * (`GET /config`): the mount's capabilities, the currency registry, the
- * merchant's payment setup (null when the request resolves no merchant) and
- * the captcha (null when the deployment challenges nobody).
- */
 /** The merchant as its customers see it; logo and support are https. */
 export declare const publicMerchantSchema: z.ZodObject<{
     display_name: z.ZodString;
@@ -879,6 +880,11 @@ export declare const publicMerchantSchema: z.ZodObject<{
     embed_origins: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>, z.ZodTransform<string[], string[] | null | undefined>>;
 }, z.core.$strip>;
 export type PublicMerchant = z.infer<typeof publicMerchantSchema>;
+/**
+ * What any browser needs to know about the deployment (`GET /config`, no
+ * credential): the mount's capabilities, the currency registry and the
+ * captcha (null when the deployment challenges nobody).
+ */
 export declare const publicConfigSchema: z.ZodObject<{
     capabilities: z.ZodObject<{
         route_groups: z.ZodRecord<z.ZodString, z.ZodBoolean>;
@@ -897,7 +903,25 @@ export declare const publicConfigSchema: z.ZodObject<{
         decimals: number;
         minor_decimals?: number | null | undefined;
     }[] | null | undefined>>;
-    payment: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    captcha: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        provider: z.ZodString;
+        site_key: z.ZodString;
+        script_url: z.ZodString;
+        action: z.ZodString;
+        token_header: z.ZodString;
+    }, z.core.$strip>>>;
+    network: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        issuer: z.ZodString;
+        client_id: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type PublicConfig = z.infer<typeof publicConfigSchema>;
+/**
+ * What a customer's browser needs to know about the merchant it pays
+ * (`GET /me/config`): its payment setup and how it presents itself.
+ */
+export declare const customerConfigSchema: z.ZodObject<{
+    payment: z.ZodObject<{
         psps: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             psp_id: z.ZodString;
             key: z.ZodString;
@@ -959,26 +983,15 @@ export declare const publicConfigSchema: z.ZodObject<{
                 recurring_eligible?: boolean | null | undefined;
             }[] | null | undefined>>;
         }, z.core.$strip>>>;
-    }, z.core.$strip>>>;
-    merchant: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    }, z.core.$strip>;
+    merchant: z.ZodObject<{
         display_name: z.ZodString;
         logo_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         support_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         embed_origins: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>, z.ZodTransform<string[], string[] | null | undefined>>;
-    }, z.core.$strip>>>;
-    captcha: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        provider: z.ZodString;
-        site_key: z.ZodString;
-        script_url: z.ZodString;
-        action: z.ZodString;
-        token_header: z.ZodString;
-    }, z.core.$strip>>>;
-    network: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        issuer: z.ZodString;
-        client_id: z.ZodString;
-    }, z.core.$strip>>>;
+    }, z.core.$strip>;
 }, z.core.$strip>;
-export type PublicConfig = z.infer<typeof publicConfigSchema>;
+export type CustomerConfig = z.infer<typeof customerConfigSchema>;
 export declare const networkLinkChallengeSchema: z.ZodObject<{
     id: z.ZodString;
     nonce: z.ZodString;
@@ -997,10 +1010,6 @@ export declare const customerLinkSchema: z.ZodObject<{
     revoked_by: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type CustomerLink = z.infer<typeof customerLinkSchema>;
-export declare const paymentAuthenticationSchema: z.ZodObject<{
-    client_secret: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-export type PaymentAuthentication = z.infer<typeof paymentAuthenticationSchema>;
 /**
  * What a card setup hands the server: tokenized data only, never a PAN.
  * OpenRails reads the saved card's brand, last four and expiry from the PSP.