@bpinternal/billing-ui 0.20.0 → 0.22.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Appearance } from '@stripe/stripe-js';
 import { billing } from '@botpress/client';
 import { ButtonHTMLAttributes } from 'react';
+import { CancellationReason } from '@bpinternal/const';
 import { ClassValue } from 'clsx';
 import { Client } from '@botpress/client';
 import { ComponentType } from 'react';
@@ -118,6 +119,9 @@ export declare const BILLING_EVENTS: {
     readonly PLAN_UPGRADE_INITIATED: "billing_plan_upgrade_initiated";
     readonly PLAN_DOWNGRADED: "billing_plan_downgraded";
     readonly PLAN_DOWNGRADE_CANCELLED: "billing_plan_downgrade_cancelled";
+    readonly DOWNGRADE_CONFIRM_VIEWED: "billing_downgrade_confirm_viewed";
+    readonly DOWNGRADE_SURVEY_VIEWED: "billing_downgrade_survey_viewed";
+    readonly DOWNGRADE_SURVEY_SUBMITTED: "billing_downgrade_survey_submitted";
     readonly CHECKOUT_STEP_VIEWED: "billing_checkout_step_viewed";
     readonly CHECKOUT_INTERVAL_CHANGED: "billing_checkout_interval_changed";
     readonly PAYMENT_METHOD_SELECTED: "billing_payment_method_selected";
@@ -180,12 +184,13 @@ export declare type BillingChangeEvent = {
  */
 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
-* check the caller's workspace membership. Every host must pass a client
-* object that also exposes it. Still type-only — no runtime dep.
+* `getWorkspaceMember` and `saveWorkspaceCancellationReasons` live on the
+* generic `@botpress/client`, not the billing client, but are REQUIRED here:
+* `useIsAuthorized` checks the caller's workspace membership, and the
+* downgrade flow saves the cancellation survey answers. Every host must pass
+* a client object that also exposes them. Still type-only — no runtime dep.
 */
-Pick<Client, 'getWorkspaceMember'> & 
+Pick<Client, 'getWorkspaceMember' | 'saveWorkspaceCancellationReasons'> & 
 /**
 * 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
@@ -327,6 +332,29 @@ export declare type ButtonProps = ButtonHTMLAttributes<HTMLButtonElement> & {
 
 export declare const CalendarIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
+/** Answers from the cancellation survey shown before a downgrade. */
+export declare type CancellationFeedback = {
+    reason: CancellationReason;
+    comment?: string;
+    /** Plan being left. */
+    previousPlanId: string;
+    /** Plan being downgraded to. */
+    planId: string;
+};
+
+/** Two-step downgrade flow: what the user loses, then why they're leaving. */
+export declare const CancellationSurveyDialog: ({ open, onOpenChange, planId, onConfirm, loading, planFeatures, }: CancellationSurveyDialogProps) => JSX.Element;
+
+export declare type CancellationSurveyDialogProps = {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    /** Plan the user is downgrading to. */
+    planId: string;
+    onConfirm: (feedback: CancellationFeedback) => void;
+    loading?: boolean;
+    planFeatures?: Partial<Record<PlanKind, PlanFeatureId[]>>;
+};
+
 /** Minimal card-brand badge (saved-card row). Stripe's own UI shows real brand art. */
 export declare const CardBrandBadge: ({ brand }: {
     brand: string;
@@ -1167,6 +1195,9 @@ export declare function usePlans(): UseQueryResult<Plan[], Error>;
 
 export declare const UsersIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
+/** Persists the cancellation survey answers; no-op without BillingProvider's `workspaceId`. */
+export declare function useSaveCancellationFeedback(): UseMutationResult<void, Error, CancellationFeedback>;
+
 /** Absolute add-on quantities for the current subscription (0 removes an add-on). */
 export declare function useSetAddons(): UseMutationResult<Subscription, Error, {
     addons: Record<string, number>;