@bpinternal/billing-ui 0.17.0 → 0.19.0

package/dist/index.d.ts

@@ -53,7 +53,7 @@ export declare function addonPrice(addon: Addon, plan: Plan, interval: BillingIn
  * Clickable summary of active add-ons (current quantities from the live
  * subscription). Acts as a preview button that opens add-on management.
  */
-export declare const AddonsSummaryCard: ({ onManage, className }: AddonsSummaryCardProps) => JSX.Element;
+export declare const AddonsSummaryCard: ({ onManage, className }: AddonsSummaryCardProps) => JSX.Element | null;
 
 export declare type AddonsSummaryCardProps = {
     /** Opens the manage-add-ons dialog. */
@@ -65,7 +65,7 @@ export declare const AgentsIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
 export declare const ArrowRightIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
-export declare const AutoRechargeDialog: ({ open, onOpenChange, onSuccess, onUpgrade }: AutoRechargeDialogProps) => JSX.Element;
+export declare const AutoRechargeDialog: ({ open, onOpenChange, onSuccess, onUpgrade }: AutoRechargeDialogProps) => JSX.Element | null;
 
 export declare type AutoRechargeDialogProps = {
     open: boolean;
@@ -166,7 +166,7 @@ export declare type BillingAnalyticsClient = {
 };
 
 export declare type BillingChangeEvent = {
-    type: 'subscription' | 'addons' | 'payment-method' | 'billing-address' | 'auto-recharge';
+    type: 'subscription' | 'addons' | 'payment-method' | 'billing-address' | 'auto-recharge' | 'pending-upgrade';
 };
 
 /**
@@ -178,12 +178,19 @@ export declare type BillingChangeEvent = {
  * this interface over your own backend proxy (e.g. tRPC) — the shapes are the
  * official wire shapes, the transport is yours.
  */
-export declare type BillingClient = Pick<billing.Client, 'listPlans' | 'listAddons' | 'getSubscription' | 'previewSubscriptionUpdate' | 'setPlan' | 'setAddons' | 'getPaymentMethod' | 'createPaymentMethodIntent' | 'setPaymentMethod' | 'getCustomer' | 'setCustomer' | 'listInvoices' | 'getBillingReadonly' | 'getWorkspaceUsages' | 'getAutoRechargeSettings' | 'setAutoRechargeSettings'> & 
+export declare type BillingClient = Pick<billing.Client, 'listPlans' | 'listAddons' | 'getSubscription' | 'previewSubscriptionUpdate' | 'setPlan' | 'setAddons' | 'getPaymentMethod' | 'createPaymentMethodIntent' | 'setPaymentMethod' | 'getCustomer' | 'setCustomer' | 'listInvoices' | 'getBillingReadonly' | 'getWorkspaceUsages' | 'getAutoRechargeSettings' | 'setAutoRechargeSettings' | 'payInvoice' | 'cancelPendingSubscriptionUpgrade'> & 
 /**
-* Per-bot usage breakdown is OPTIONAL: those methods live on the generic
-* `@botpress/client` (not the billing client), so a host that wants the per-bot
-* view passes a client object that also exposes them. Omit them and the
-* UsageDashboard hides the per-bot section. Still type-only — no runtime dep.
+* `getWorkspaceMember` lives on the generic `@botpress/client`, not the
+* billing client, but is REQUIRED here: `useIsAuthorized` depends on it to
+* check the caller's workspace membership. Every host must pass a client
+* object that also exposes it. Still type-only — no runtime dep.
+*/
+Pick<Client, 'getWorkspaceMember'> & 
+/**
+* Per-bot usage breakdown is OPTIONAL: those methods also live on the
+* generic `@botpress/client`, but only a host that wants the per-bot view
+* needs to pass a client exposing them. Omit them and the UsageDashboard
+* hides the per-bot section.
 */
 Partial<Pick<Client, 'breakDownWorkspaceUsageByBot' | 'listBots'>>;
 
@@ -227,6 +234,7 @@ export declare const billingKeys: {
     customer: (scope: string) => readonly ["bpb", string, "customer"];
     invoices: (scope: string) => readonly ["bpb", string, "invoices"];
     readonly: (scope: string) => readonly ["bpb", string, "billing-readonly"];
+    isAuthorized: (scope: string) => readonly ["bpb", string, "is-authorized"];
     autoRecharge: (scope: string) => readonly ["bpb", string, "auto-recharge"];
     usages: (scope: string, period: string) => readonly ["bpb", string, "usages", string];
     bots: (scope: string) => readonly ["bpb", string, "bots"];
@@ -338,7 +346,7 @@ export declare const CheckIcon: ({ size, ...props }: IconProps) => JSX.Element;
  * the subscribe button share the same Stripe context. The SetupIntent itself is only
  * requested from CheckoutBody at Subscribe time, not eagerly on open.
  */
-export declare const CheckoutDialog: ({ open, onOpenChange, planId, interval, onBack, onSuccess }: CheckoutDialogProps) => JSX.Element;
+export declare const CheckoutDialog: ({ open, onOpenChange, planId, interval, onBack, onSuccess }: CheckoutDialogProps) => JSX.Element | null;
 
 export declare type CheckoutDialogProps = {
     open: boolean;
@@ -434,6 +442,8 @@ export declare function formatCurrency(amount: number, currency?: string, decima
 
 export declare function formatDate(iso: string, locale?: string): string;
 
+export declare function formatDateTime(iso: string, locale?: string): string;
+
 export declare function formatQuantity(n: number, locale?: string): string;
 
 export declare function formatUsage(value: number, unit: UsageUnit): string;
@@ -488,7 +498,7 @@ export declare type Invoice = Awaited<ReturnType<BillingClient['listInvoices']>>
  * Read-only billing history. Lists invoices newest-first with status, amount,
  * period, and a PDF download when Stripe provides one.
  */
-export declare const InvoicesDialog: ({ open, onOpenChange }: InvoicesDialogProps) => JSX.Element;
+export declare const InvoicesDialog: ({ open, onOpenChange }: InvoicesDialogProps) => JSX.Element | null;
 
 export declare type InvoicesDialogProps = {
     open: boolean;
@@ -516,7 +526,7 @@ export declare const LockIcon: ({ size, ...props }: IconProps) => JSX.Element;
  * first), totals computed client-side, committed as absolute quantities via
  * setAddons — 0 removes an add-on. No plan change involved.
  */
-export declare const ManageAddonsDialog: ({ open, onOpenChange, onSuccess, onUpgrade }: ManageAddonsDialogProps) => JSX.Element;
+export declare const ManageAddonsDialog: ({ open, onOpenChange, onSuccess, onUpgrade }: ManageAddonsDialogProps) => JSX.Element | null;
 
 export declare type ManageAddonsDialogProps = {
     open: boolean;
@@ -579,6 +589,8 @@ export declare type OutgrowFreeDialogProps = {
 
 export declare const PaintIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
+export declare type PayInvoiceResult = Awaited<ReturnType<BillingClient['payInvoice']>>;
+
 export declare type PaymentMethod = NonNullable<Awaited<ReturnType<BillingClient['getPaymentMethod']>>['paymentMethod']>;
 
 export declare type PaymentMethodCard = NonNullable<PaymentMethod['card']>;
@@ -590,7 +602,7 @@ export declare type PaymentMethodCard = NonNullable<PaymentMethod['card']>;
  * confirmCardSetup (no address required), then persisted; address is saved
  * independently — matching Desk's separation.
  */
-export declare const PaymentMethodDialog: ({ open, onOpenChange, onSuccess }: PaymentMethodDialogProps) => JSX.Element;
+export declare const PaymentMethodDialog: ({ open, onOpenChange, onSuccess }: PaymentMethodDialogProps) => JSX.Element | null;
 
 export declare type PaymentMethodDialogProps = {
     open: boolean;
@@ -598,6 +610,32 @@ export declare type PaymentMethodDialogProps = {
     onSuccess?: () => void;
 };
 
+/** A plan/addon change awaiting payment confirmation. */
+export declare type PendingUpgrade = NonNullable<Subscription['pendingUpgrade']>;
+
+/**
+ * Full-width alert shown when the subscription has a plan/add-on change awaiting
+ * payment confirmation (`subscription.pendingUpgrade`). Clicking it opens
+ * `PendingUpgradeDialog` (or `onManage`, when the host wants to own that flow).
+ * Renders nothing without a pending upgrade — safe to mount unconditionally.
+ */
+export declare const PendingUpgradeBanner: ({ onManage, className }: PendingUpgradeBannerProps) => JSX.Element | null;
+
+export declare type PendingUpgradeBannerProps = {
+    /** Opens a host-owned pending-upgrade view instead of the library's own dialog. */
+    onManage?: () => void;
+    className?: string;
+};
+
+/** Standalone dialog around `PendingUpgradeContent` — opened from `PendingUpgradeBanner`. */
+export declare const PendingUpgradeDialog: ({ open, onOpenChange, onSuccess }: PendingUpgradeDialogProps) => JSX.Element | null;
+
+export declare type PendingUpgradeDialogProps = {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onSuccess?: () => void;
+};
+
 export declare type Plan = Awaited<ReturnType<BillingClient['listPlans']>>[number];
 
 /** Maps an English feature ID to its i18n label and tooltip description keys. */
@@ -725,7 +763,7 @@ export declare const PLAN_ORDER: PlanKind[];
  * renews (paid, self-serve plans only), plus a manage CTA. On legacy billing
  * it deep-links to the Dashboard.
  */
-export declare const PlanBanner: ({ onManage, className }: PlanBannerProps) => JSX.Element;
+export declare const PlanBanner: ({ onManage, className }: PlanBannerProps) => JSX.Element | null;
 
 export declare type PlanBannerProps = {
     /** Opens the plan picker / checkout. */
@@ -758,7 +796,7 @@ export declare function planKind(plan: Pick<Plan, 'name' | 'metadata'>): PlanKin
  * Clickable summary of the current plan — name, interval, price, conversation
  * allowance. Acts as a preview button that opens the plan-management flow.
  */
-export declare const PlanSummaryCard: ({ onManage, className }: PlanSummaryCardProps) => JSX.Element;
+export declare const PlanSummaryCard: ({ onManage, className }: PlanSummaryCardProps) => JSX.Element | null;
 
 export declare type PlanSummaryCardProps = {
     /** Opens the plan picker / checkout. */
@@ -905,7 +943,7 @@ export declare type TaxId = Customer['taxIds'][number];
 
 export declare function toStripeLocale(locale: string): string;
 
-export declare const UpgradePlanDialog: ({ open, onOpenChange, onSelectPlan, recommendedPlanId, defaultInterval, excludePlanIds, planFeatures, featureDescriptions, }: UpgradePlanDialogProps) => JSX.Element;
+export declare const UpgradePlanDialog: ({ open, onOpenChange, onSelectPlan, recommendedPlanId, defaultInterval, excludePlanIds, planFeatures, featureDescriptions, }: UpgradePlanDialogProps) => JSX.Element | null;
 
 export declare type UpgradePlanDialogProps = {
     open: boolean;
@@ -1094,12 +1132,18 @@ export declare function useBillingReadonly(options?: QueryOptions): UseQueryResu
     addonsReadonly: boolean;
 }, Error>;
 
+/** Cancels a pending upgrade (the plan/add-on change and its unpaid invoice), reverting to the current subscription. */
+export declare function useCancelPendingSubscriptionUpgrade(): UseMutationResult<void, Error, void>;
+
 export declare function useCreatePaymentMethodIntent(): UseMutationResult<{
     clientSecret: string;
 }, Error, void>;
 
 export declare function useCustomer(options?: QueryOptions): UseQueryResult<Customer, Error>;
 
+/** Whether the subscription has a plan/add-on change awaiting payment confirmation. */
+export declare function useHasPendingUpgrade(options?: QueryOptions): boolean;
+
 export declare function useInvoices(options?: QueryOptions): UseQueryResult<{
     invoices: Invoice[];
     meta: {
@@ -1107,7 +1151,13 @@ export declare function useInvoices(options?: QueryOptions): UseQueryResult<{
     };
 }, Error>;
 
-export declare function useIsAuthorized(): boolean | Error | undefined;
+/** Whether the caller's role (via `getWorkspaceMember`) has `workspace.manageBilling`. */
+export declare function useIsAuthorized(options?: QueryOptions): UseQueryResult<boolean, Error>;
+
+/** Pays the invoice tied to a pending upgrade, confirming the plan/add-on change. */
+export declare function usePayInvoice(): UseMutationResult<PayInvoiceResult, Error, {
+    invoiceId: string;
+}>;
 
 export declare function usePaymentMethod(options?: QueryOptions): UseQueryResult<{
     paymentMethod: PaymentMethod | null;
@@ -1118,7 +1168,7 @@ export declare function usePlans(): UseQueryResult<Plan[], Error>;
 export declare const UsersIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
 /** Absolute add-on quantities for the current subscription (0 removes an add-on). */
-export declare function useSetAddons(): UseMutationResult<void, Error, {
+export declare function useSetAddons(): UseMutationResult<Subscription, Error, {
     addons: Record<string, number>;
     couponCode?: string;
 }>;
@@ -1131,8 +1181,8 @@ export declare function useSetPaymentMethod(): UseMutationResult<PaymentMethod,
     paymentMethodId: string;
 }>;
 
-/** Commits the plan (and add-ons when provided), then invalidates everything cost-related. */
-export declare function useSetSubscription(): UseMutationResult<void, Error, SetSubscriptionInput>;
+/** Commits the plan and add-ons. A failed charge returns `pendingUpgrade` instead of throwing. */
+export declare function useSetSubscription(): UseMutationResult<Subscription, Error, SetSubscriptionInput>;
 
 export declare function useSubscription(options?: QueryOptions): UseQueryResult<Subscription, Error>;
 
@@ -1159,6 +1209,9 @@ export declare function useUsageByBot(type: string, options?: QueryOptions & {
     period?: string;
 }): UseQueryResult<BotUsageRow[], Error>;
 
+/** The caller's own workspace membership, as returned by `getWorkspaceMember`. */
+export declare type WorkspaceMember = Awaited<ReturnType<Client['getWorkspaceMember']>>;
+
 export declare type WorkspaceUsages = Awaited<ReturnType<BillingClient['getWorkspaceUsages']>>['quotas'];
 
 export { }