@bpinternal/billing-ui 0.3.1 → 0.5.0

package/dist/index.d.ts

@@ -14,6 +14,8 @@ import { ReactPortal } from 'react';
 import { SelectHTMLAttributes } from 'react';
 import { Stripe } from '@stripe/stripe-js';
 import { StripeCardElementOptions } from '@stripe/stripe-js';
+import { SupportedLocale } from './i18n';
+import { SupportedLocale as SupportedLocale_2 } from '../i18n';
 import { SVGProps } from 'react';
 import { UseMutationResult } from '@tanstack/react-query';
 import { UseQueryResult } from '@tanstack/react-query';
@@ -145,6 +147,8 @@ export declare type BillingClient = Pick<billing.Client, 'listPlans' | 'listAddo
 */
 Partial<Pick<Client, 'breakDownWorkspaceUsageByBot' | 'listBots'>>;
 
+export declare type BillingColorScheme = 'default' | 'neutral';
+
 declare type BillingContextValue = {
     client: BillingClient;
     queryClient: QueryClient;
@@ -152,8 +156,9 @@ declare type BillingContextValue = {
     scope: string;
     stripePromise: Promise<Stripe | null>;
     email?: string;
-    locale: string;
+    locale: SupportedLocale_2;
     isDark: boolean;
+    colorScheme: BillingColorScheme;
     toast: (toast: BillingToast) => void;
     analytics: BillingAnalyticsClient;
     featureLabels?: Record<string, (quantity: number) => string>;
@@ -188,7 +193,7 @@ export declare const billingKeys: {
     usageByBot: (scope: string, type: string, period: string) => readonly ["bpb", string, "usage-by-bot", string, string];
 };
 
-export declare const BillingProvider: ({ client, stripePublishableKey, email, locale, theme, onToast, analytics, featureLabels, billingVersion, workspaceId, persist, manageBillingUrl, onBillingChange, refreshInterval, children, }: BillingProviderProps) => JSX.Element;
+export declare const BillingProvider: ({ client, stripePublishableKey, email, locale, theme, colorScheme, onToast, analytics, featureLabels, billingVersion, workspaceId, persist, manageBillingUrl, onBillingChange, refreshInterval, children, }: BillingProviderProps) => JSX.Element;
 
 export declare type BillingProviderProps = {
     /** Billing engine client — `@botpress/client`'s `billing.Client` or any compatible adapter */
@@ -197,8 +202,9 @@ export declare type BillingProviderProps = {
     stripePublishableKey: string;
     /** Workspace owner email shown in the checkout contact section */
     email?: string;
-    locale?: string;
+    locale?: SupportedLocale_2;
     theme?: BillingTheme;
+    colorScheme?: BillingColorScheme;
     onToast?: (toast: BillingToast) => void;
     /**
      * Analytics sink the library captures billing-funnel events into. Pass a
@@ -334,13 +340,6 @@ export declare function currencySymbol(currency: string): string;
 
 export declare type Customer = Awaited<ReturnType<BillingClient['getCustomer']>>;
 
-/**
- * Plain-language explanations of what each plan feature means, keyed by the exact
- * marketing label above. Shown as a hover tooltip in the pricing table. Override
- * per-app via UpgradePlanDialog's `featureDescriptions` prop.
- */
-export declare const DEFAULT_FEATURE_DESCRIPTIONS: Record<string, string>;
-
 /**
  * Human labels for Smaug plan feature keys. Overridable per-key via the
  * BillingProvider `featureLabels` prop.
@@ -353,7 +352,7 @@ export declare const DEFAULT_FEATURE_LABELS: Record<string, (quantity: number) =
  * conversations volume is rendered as the card's headline metric instead.
  * Override per-app via UpgradePlanDialog's `planFeatures` prop.
  */
-export declare const DEFAULT_PLAN_FEATURES: Record<PlanKind, string[]>;
+export declare const DEFAULT_PLAN_FEATURES: Record<PlanKind, PlanFeatureId[]>;
 
 export declare const Dialog: ({ open, onOpenChange, size, children, className, showClose, ...aria }: DialogProps) => ReactPortal | null;
 
@@ -386,19 +385,16 @@ export declare type Entitlement = {
 
 export declare const ExternalLinkIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
-/** Description for a feature label — exact map first, then a keyword fallback for templated quota labels. */
-export declare function featureDescription(label: string, overrides?: Record<string, string>): string | undefined;
-
 export declare function featureLabel(key: string, quantity: number, overrides?: Record<string, (quantity: number) => string>): string;
 
 /** Human-readable bytes — "10 GB", "1.5 GB", "500 MB". */
 export declare function formatBytes(bytes: number): string;
 
-export declare function formatCurrency(amount: number, currency?: string, decimal?: number): string;
+export declare function formatCurrency(amount: number, currency?: string, decimal?: number, locale?: string): string;
 
 export declare function formatDate(iso: string, locale?: string): string;
 
-export declare function formatQuantity(n: number): string;
+export declare function formatQuantity(n: number, locale?: string): string;
 
 export declare function formatUsage(value: number, unit: UsageUnit): string;
 
@@ -528,7 +524,7 @@ export declare type OutgrowFreeDialogProps = {
     /** Billing interval the prices are shown at. Default 'year' (annual). */
     interval?: BillingInterval;
     /** Per-kind marketing feature strings; defaults to DEFAULT_PLAN_FEATURES. */
-    planFeatures?: Partial<Record<PlanKind, string[]>>;
+    planFeatures?: Partial<Record<PlanKind, PlanFeatureId[]>>;
     /** Feature label → tooltip description; merged over DEFAULT_FEATURE_DESCRIPTIONS. */
     featureDescriptions?: Record<string, string>;
     /** Period (any datetime in the billing month) to evaluate usage; defaults to current month. */
@@ -558,6 +554,122 @@ export declare type PaymentMethodDialogProps = {
 
 export declare type Plan = Awaited<ReturnType<BillingClient['listPlans']>>[number];
 
+/** Maps an English feature ID to its i18n label and tooltip description keys. */
+export declare const PLAN_FEATURE_KEYS: {
+    'AI usage included': {
+        label: "planFeatureAiUsageIncluded";
+        desc: "planFeatureDescAiUsageIncluded";
+    };
+    '3 seats': {
+        label: "planFeature3Seats";
+        desc: "planFeatureDesc3Seats";
+    };
+    '3 AI agents': {
+        label: "planFeature3AiAgents";
+        desc: "planFeatureDesc3AiAgents";
+    };
+    'Botpress Desk': {
+        label: "planFeatureBotpressDesk";
+        desc: "planFeatureDescBotpressDesk";
+    };
+    'Botpress Studio + ADK': {
+        label: "planFeatureBotpressStudioAdk";
+        desc: "planFeatureDescBotpressStudioAdk";
+    };
+    'Help center': {
+        label: "planFeatureHelpCenter";
+        desc: "planFeatureDescHelpCenter";
+    };
+    '1K table rows': {
+        label: "planFeature1kTableRows";
+        desc: "planFeatureDesc1kTableRows";
+    };
+    '100K table rows': {
+        label: "planFeature100kTableRows";
+        desc: "planFeatureDesc100kTableRows";
+    };
+    '500K table rows': {
+        label: "planFeature500kTableRows";
+        desc: "planFeatureDesc500kTableRows";
+    };
+    '100MB file storage': {
+        label: "planFeature100mbFileStorage";
+        desc: "planFeatureDesc100mbFileStorage";
+    };
+    '10GB file storage': {
+        label: "planFeature10gbFileStorage";
+        desc: "planFeatureDesc10gbFileStorage";
+    };
+    '50GB file storage': {
+        label: "planFeature50gbFileStorage";
+        desc: "planFeatureDesc50gbFileStorage";
+    };
+    '100MB vector DB storage': {
+        label: "planFeature100mbVectorDb";
+        desc: "planFeatureDesc100mbVectorDb";
+    };
+    '1GB vector DB storage': {
+        label: "planFeature1gbVectorDb";
+        desc: "planFeatureDesc1gbVectorDb";
+    };
+    '5GB vector DB storage': {
+        label: "planFeature5gbVectorDb";
+        desc: "planFeatureDesc5gbVectorDb";
+    };
+    'Community support': {
+        label: "planFeatureCommunitySupport";
+        desc: "planFeatureDescCommunitySupport";
+    };
+    'Unlimited AI agents': {
+        label: "planFeatureUnlimitedAiAgents";
+        desc: "planFeatureDescUnlimitedAiAgents";
+    };
+    'WhatsApp channel': {
+        label: "planFeatureWhatsappChannel";
+        desc: "planFeatureDescWhatsappChannel";
+    };
+    'Help Center custom domain': {
+        label: "planFeatureHelpCenterCustomDomain";
+        desc: "planFeatureDescHelpCenterCustomDomain";
+    };
+    'Whitelabel webchat': {
+        label: "planFeatureWhitelabelWebchat";
+        desc: "planFeatureDescWhitelabelWebchat";
+    };
+    'Technical support via live chat': {
+        label: "planFeatureTechnicalSupportLiveChat";
+        desc: "planFeatureDescTechnicalSupportLiveChat";
+    };
+    'Unlimited seats': {
+        label: "planFeatureUnlimitedSeats";
+        desc: "planFeatureDescUnlimitedSeats";
+    };
+    'Teams, routing & RBAC': {
+        label: "planFeatureTeamsRoutingRbac";
+        desc: "planFeatureDescTeamsRoutingRbac";
+    };
+    'Team-level analytics': {
+        label: "planFeatureTeamLevelAnalytics";
+        desc: "planFeatureDescTeamLevelAnalytics";
+    };
+    'Voice channel': {
+        label: "planFeatureVoiceChannel";
+        desc: "planFeatureDescVoiceChannel";
+    };
+    'Dedicated support': {
+        label: "planFeatureDedicatedSupport";
+        desc: "planFeatureDescDedicatedSupport";
+    };
+    'SLA & security review': {
+        label: "planFeatureSlaSecurity";
+        desc: "planFeatureDescSlaSecurity";
+    };
+    'Custom storage': {
+        label: "planFeatureCustomStorage";
+        desc: "planFeatureDescCustomStorage";
+    };
+};
+
 export declare const PLAN_ORDER: PlanKind[];
 
 /**
@@ -585,6 +697,8 @@ export declare function planDisplayName(name: string): string;
  */
 export declare function planEntitlements(plan: Plan | undefined, addons: Addon[] | undefined, quantities: Record<string, number>): Entitlement[];
 
+export declare type PlanFeatureId = keyof typeof PLAN_FEATURE_KEYS;
+
 /**
  * Canonical plan kinds. Smaug plan ids/names vary by environment, so plans are
  * classified by name — same heuristic as the dashboard's getPlanNameFromId.
@@ -722,6 +836,8 @@ export declare type SubscriptionUpdate = {
     couponCode?: string;
 };
 
+export { SupportedLocale }
+
 export declare type TaxId = Customer['taxIds'][number];
 
 export declare function toStripeLocale(locale: string): string;
@@ -739,7 +855,7 @@ export declare type UpgradePlanDialogProps = {
     /** Additional plan ids to hide. Enterprise + managed are always hidden. */
     excludePlanIds?: string[];
     /** Per-kind marketing feature strings; defaults to DEFAULT_PLAN_FEATURES (Desk copy). */
-    planFeatures?: Partial<Record<PlanKind, string[]>>;
+    planFeatures?: Partial<Record<PlanKind, PlanFeatureId[]>>;
     /** Feature label → tooltip description; merged over DEFAULT_FEATURE_DESCRIPTIONS. */
     featureDescriptions?: Record<string, string>;
 };