@bpinternal/billing-ui 0.21.0 → 0.23.0

package/dist/index.d.ts

@@ -184,25 +184,20 @@ 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
 * needs to pass a client exposing them. Omit them and the UsageDashboard
 * hides the per-bot section.
 */
-Partial<Pick<Client, 'breakDownWorkspaceUsageByBot' | 'listBots'>> & {
-    /**
-     * Persists the cancellation survey answers. Not part of the billing engine,
-     * so every host implements it over its own backend
-     */
-    saveCancellationFeedback: (feedback: CancellationFeedback) => Promise<void>;
-};
+Partial<Pick<Client, 'breakDownWorkspaceUsageByBot' | 'listBots'>>;
 
 export declare type BillingColorScheme = 'default' | 'neutral';
 
@@ -268,7 +263,8 @@ export declare type BillingProviderProps = {
      * Analytics sink the library captures billing-funnel events into. Pass a
      * `posthog-js` instance directly (it satisfies the shape), or any object with
      * a matching `capture`. Omit and every event no-ops. The event names + props
-     * the library emits are listed in `BILLING_EVENTS`.
+     * the library emits are listed in `BILLING_EVENTS`. Every event also carries
+     * `workspace_billing_version`, `workspace_plan` and `workspace_is_paid` when known.
      */
     analytics?: BillingAnalyticsClient;
     /** Override the human label shown for a plan feature key (e.g. bot_count) */
@@ -1200,7 +1196,7 @@ export declare function usePlans(): UseQueryResult<Plan[], Error>;
 
 export declare const UsersIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
-/** Persists the cancellation survey answers. */
+/** 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). */