@bpinternal/billing-ui 0.18.0 → 0.19.0

package/dist/index.d.ts

@@ -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,7 +178,7 @@ 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'> & 
 /**
 * `getWorkspaceMember` lives on the generic `@botpress/client`, not the
 * billing client, but is REQUIRED here: `useIsAuthorized` depends on it to
@@ -442,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;
@@ -587,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']>;
@@ -606,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. */
@@ -1102,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: {
@@ -1118,6 +1154,11 @@ export declare function useInvoices(options?: QueryOptions): UseQueryResult<{
 /** 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;
 }, Error>;
@@ -1127,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;
 }>;
@@ -1140,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>;