@bpinternal/billing-ui 0.0.1 → 0.1.0

package/dist/index.d.ts

@@ -68,6 +68,24 @@ export declare type BadgeProps = {
 
 export declare const BankIcon: ({ size, ...props }: IconProps) => JSX.Element;
 
+export declare const BILLING_EVENTS: {
+    readonly PLAN_PICKER_VIEWED: "billing_plan_picker_viewed";
+    readonly PLAN_INTERVAL_TOGGLED: "billing_plan_interval_toggled";
+    readonly PLAN_UPGRADE_INITIATED: "billing_plan_upgrade_initiated";
+    readonly PLAN_DOWNGRADED: "billing_plan_downgraded";
+    readonly PLAN_DOWNGRADE_CANCELLED: "billing_plan_downgrade_cancelled";
+    readonly CHECKOUT_STEP_VIEWED: "billing_checkout_step_viewed";
+    readonly CHECKOUT_INTERVAL_CHANGED: "billing_checkout_interval_changed";
+    readonly PAYMENT_METHOD_SELECTED: "billing_payment_method_selected";
+    readonly PAYMENT_DETAILS_CONFIRMED: "billing_payment_details_confirmed";
+    readonly PLAN_UPGRADED: "billing_plan_upgraded";
+    readonly CHECKOUT_ERROR: "billing_checkout_error";
+    readonly PAYMENT_METHOD_UPDATED: "billing_payment_method_updated";
+    readonly BILLING_ADDRESS_UPDATED: "billing_address_updated";
+    readonly INVOICE_DOWNLOADED: "billing_invoice_downloaded";
+    readonly UPGRADE_CTA_CLICKED: "billing_upgrade_cta_clicked";
+};
+
 export declare type BillingAddress = {
     lineOne: string;
     lineTwo?: string;
@@ -77,32 +95,17 @@ export declare type BillingAddress = {
     country: string;
 };
 
-export declare type BillingAnalytics = {
-    trackPaymentDetailsConfirmed?: (props: {
-        plan_name: string;
-        interval: BillingInterval;
-    }) => void;
-    trackPlanUpgradeInitiated?: (props: {
-        plan_name: string;
-        interval: BillingInterval;
-        current_plan_name?: string;
-    }) => void;
-    trackPlanUpgraded?: (props: {
-        plan_name: string;
-        interval: BillingInterval;
-        amount_paid: number;
-        next_cycle_amount: number;
-        previous_plan_name?: string;
-        previous_interval?: BillingInterval;
-    }) => void;
-    trackPlanDowngraded?: (props: {
-        plan_name: string;
-        interval: BillingInterval;
-        previous_plan_name?: string;
-    }) => void;
-    trackPlanDowngradeCancelled?: (props: {
-        plan_name: string;
-    }) => void;
+/**
+ * Analytics sink the library captures billing events into. Structurally a subset
+ * of a `posthog-js` instance — pass `posthog` straight in (no adapter), or any
+ * object with a matching `capture`. The library never imports an analytics SDK,
+ * so it stays publishable and provider-agnostic. Omit it and every event no-ops.
+ *
+ * Event names + property shapes the library emits live in `BILLING_EVENTS`
+ * (./analytics) — that's the source of truth for what lands in your project.
+ */
+export declare type BillingAnalyticsClient = {
+    capture: (event: string, properties?: Record<string, unknown>) => void;
 };
 
 export declare type BillingChangeEvent = {
@@ -137,7 +140,7 @@ declare type BillingContextValue = {
     locale: string;
     isDark: boolean;
     toast: (toast: BillingToast) => void;
-    analytics: BillingAnalytics;
+    analytics: BillingAnalyticsClient;
     featureLabels?: Record<string, (quantity: number) => string>;
     isOutdatedBilling: boolean;
     manageBillingUrl?: string;
@@ -149,6 +152,8 @@ declare type BillingContextValue = {
     notifyBillingChange: (event: BillingChangeEvent) => void;
 };
 
+export declare type BillingEventName = (typeof BILLING_EVENTS)[keyof typeof BILLING_EVENTS];
+
 export declare type BillingInterval = 'month' | 'year';
 
 export declare const billingKeys: {
@@ -180,7 +185,13 @@ export declare type BillingProviderProps = {
     locale?: string;
     theme?: BillingTheme;
     onToast?: (toast: BillingToast) => void;
-    analytics?: BillingAnalytics;
+    /**
+     * 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`.
+     */
+    analytics?: BillingAnalyticsClient;
     /** Override the human label shown for a plan feature key (e.g. bot_count) */
     featureLabels?: Record<string, (quantity: number) => string>;
     /**