@startsimpli/billing 0.1.0 → 0.1.2

package/dist/index.d.mts

@@ -0,0 +1,194 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { BillingConfig, BillingProduct, CheckoutResult, FreeSubscriptionResult, PortalResult, CachedSubscriptionState, SubscriptionInfo, ProductOffer } from './types/index.mjs';
+export { OfferFeature, PaymentMethod } from './types/index.mjs';
+
+/**
+ * API client for billing endpoints.
+ */
+
+declare class BillingApiClient {
+    private config;
+    constructor(config: BillingConfig);
+    private get fetcher();
+    private get headers();
+    /** Fetch a public billing product by slug. */
+    getProduct(slug: string): Promise<BillingProduct>;
+    /** Create a checkout session for an offer. */
+    createCheckout(params: {
+        offerId: string;
+        successUrl: string;
+        cancelUrl: string;
+        quantity?: number;
+    }): Promise<CheckoutResult>;
+    /** Subscribe to a free offer (no billing provider). */
+    subscribeFree(offerId: string): Promise<FreeSubscriptionResult>;
+    /** Create a customer portal session. */
+    createPortal(returnUrl: string): Promise<PortalResult>;
+    /**
+     * Eagerly sync subscription state after Stripe checkout redirect.
+     * Call this from your success_url page to avoid waiting for the webhook.
+     */
+    successSync(): Promise<CachedSubscriptionState | null>;
+    /** Get current user's subscription. */
+    getSubscription(): Promise<SubscriptionInfo | null>;
+}
+
+interface BillingContextValue {
+    client: BillingApiClient;
+    config: BillingConfig;
+}
+interface BillingProviderProps extends BillingConfig {
+    children: React.ReactNode;
+}
+declare function BillingProvider({ children, ...config }: BillingProviderProps): react_jsx_runtime.JSX.Element;
+declare function useBillingContext(): BillingContextValue;
+
+/**
+ * useProduct — Fetch a BillingProduct by slug.
+ *
+ * Usage:
+ *   const { product, loading, error } = useProduct("raise-simpli");
+ */
+
+interface UseProductResult {
+    product: BillingProduct | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+declare function useProduct(slug: string): UseProductResult;
+
+/**
+ * useCheckout — Create a checkout session and redirect, or subscribe to a free offer.
+ *
+ * Usage:
+ *   const { checkout, subscribeFree, loading, error } = useCheckout();
+ *   // For paid offers:
+ *   await checkout({ offerId, successUrl, cancelUrl });
+ *   // For free offers:
+ *   await subscribeFree(offerId);
+ */
+
+interface UseCheckoutResult {
+    checkout: (params: {
+        offerId: string;
+        successUrl: string;
+        cancelUrl: string;
+        quantity?: number;
+    }) => Promise<CheckoutResult>;
+    subscribeFree: (offerId: string) => Promise<FreeSubscriptionResult>;
+    loading: boolean;
+    error: Error | null;
+}
+declare function useCheckout(): UseCheckoutResult;
+
+/**
+ * usePortal — Create a customer portal session and redirect.
+ *
+ * Usage:
+ *   const { openPortal, loading, error } = usePortal();
+ *   await openPortal("https://app.example.com/settings");
+ */
+
+interface UsePortalResult {
+    openPortal: (returnUrl: string) => Promise<PortalResult>;
+    loading: boolean;
+    error: Error | null;
+}
+declare function usePortal(): UsePortalResult;
+
+/**
+ * useSubscription — Fetch current user's active subscription.
+ */
+
+interface UseSubscriptionResult {
+    subscription: SubscriptionInfo | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+declare function useSubscription(): UseSubscriptionResult;
+
+/**
+ * useSuccessSync — Eagerly sync subscription state after Stripe checkout.
+ *
+ * Call this from your checkout success page. It POSTs to the success-sync
+ * endpoint which fetches the latest subscription from Stripe and populates
+ * the Redis cache + DB, so the UI can show subscription status immediately
+ * instead of waiting for the webhook.
+ *
+ * Usage:
+ *   const { sync, data, loading, error } = useSuccessSync();
+ *   useEffect(() => { sync(); }, [sync]);
+ */
+
+interface UseSuccessSyncResult {
+    sync: () => Promise<CachedSubscriptionState | null>;
+    data: CachedSubscriptionState | null;
+    loading: boolean;
+    error: Error | null;
+}
+declare function useSuccessSync(): UseSuccessSyncResult;
+
+interface PricingPageProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+}
+declare function PricingPage({ productId, onSelectOffer }: PricingPageProps): react_jsx_runtime.JSX.Element;
+
+interface PricingSectionProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+    /** Maximum number of features to display per card (default 4) */
+    maxFeatures?: number;
+}
+declare function PricingSection({ productId, onSelectOffer, maxFeatures, }: PricingSectionProps): react_jsx_runtime.JSX.Element;
+
+interface UpgradeModalProps {
+    productId: string;
+    open: boolean;
+    onClose: () => void;
+    onSelectOffer?: (offer: ProductOffer) => void;
+}
+declare function UpgradeModal({ productId, open, onClose, onSelectOffer, }: UpgradeModalProps): react_jsx_runtime.JSX.Element | null;
+
+interface PricingDetailPageProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+    /** Whether to show the feature comparison table (defaults to true) */
+    showComparison?: boolean;
+}
+declare function PricingDetailPage({ productId, onSelectOffer, showComparison, }: PricingDetailPageProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * ManageSubscription — Button that opens the billing provider's customer portal.
+ *
+ * Usage:
+ *   <ManageSubscription returnUrl="https://app.example.com/settings" />
+ */
+interface ManageSubscriptionProps {
+    returnUrl: string;
+    buttonText?: string;
+}
+declare function ManageSubscription({ returnUrl, buttonText, }: ManageSubscriptionProps): react_jsx_runtime.JSX.Element;
+
+interface SubscriptionManagerProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** URL to return to after portal session */
+    returnUrl: string;
+    /** Called when user clicks an available plan's CTA button */
+    onPlanChange?: (offer: ProductOffer) => void;
+    /** Optional status message to display (e.g., after checkout redirect) */
+    statusMessage?: "success" | "cancelled" | "activating" | null;
+}
+declare function SubscriptionManager({ productId, returnUrl, onPlanChange, statusMessage, }: SubscriptionManagerProps): react_jsx_runtime.JSX.Element;
+
+export { BillingApiClient, BillingConfig, BillingProduct, BillingProvider, type BillingProviderProps, CachedSubscriptionState, CheckoutResult, FreeSubscriptionResult, ManageSubscription, type ManageSubscriptionProps, PortalResult, PricingDetailPage, type PricingDetailPageProps, PricingPage, type PricingPageProps, PricingSection, type PricingSectionProps, ProductOffer, SubscriptionInfo, SubscriptionManager, type SubscriptionManagerProps, UpgradeModal, type UpgradeModalProps, useBillingContext, useCheckout, usePortal, useProduct, useSubscription, useSuccessSync };

package/dist/index.d.ts

@@ -0,0 +1,194 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { BillingConfig, BillingProduct, CheckoutResult, FreeSubscriptionResult, PortalResult, CachedSubscriptionState, SubscriptionInfo, ProductOffer } from './types/index.js';
+export { OfferFeature, PaymentMethod } from './types/index.js';
+
+/**
+ * API client for billing endpoints.
+ */
+
+declare class BillingApiClient {
+    private config;
+    constructor(config: BillingConfig);
+    private get fetcher();
+    private get headers();
+    /** Fetch a public billing product by slug. */
+    getProduct(slug: string): Promise<BillingProduct>;
+    /** Create a checkout session for an offer. */
+    createCheckout(params: {
+        offerId: string;
+        successUrl: string;
+        cancelUrl: string;
+        quantity?: number;
+    }): Promise<CheckoutResult>;
+    /** Subscribe to a free offer (no billing provider). */
+    subscribeFree(offerId: string): Promise<FreeSubscriptionResult>;
+    /** Create a customer portal session. */
+    createPortal(returnUrl: string): Promise<PortalResult>;
+    /**
+     * Eagerly sync subscription state after Stripe checkout redirect.
+     * Call this from your success_url page to avoid waiting for the webhook.
+     */
+    successSync(): Promise<CachedSubscriptionState | null>;
+    /** Get current user's subscription. */
+    getSubscription(): Promise<SubscriptionInfo | null>;
+}
+
+interface BillingContextValue {
+    client: BillingApiClient;
+    config: BillingConfig;
+}
+interface BillingProviderProps extends BillingConfig {
+    children: React.ReactNode;
+}
+declare function BillingProvider({ children, ...config }: BillingProviderProps): react_jsx_runtime.JSX.Element;
+declare function useBillingContext(): BillingContextValue;
+
+/**
+ * useProduct — Fetch a BillingProduct by slug.
+ *
+ * Usage:
+ *   const { product, loading, error } = useProduct("raise-simpli");
+ */
+
+interface UseProductResult {
+    product: BillingProduct | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+declare function useProduct(slug: string): UseProductResult;
+
+/**
+ * useCheckout — Create a checkout session and redirect, or subscribe to a free offer.
+ *
+ * Usage:
+ *   const { checkout, subscribeFree, loading, error } = useCheckout();
+ *   // For paid offers:
+ *   await checkout({ offerId, successUrl, cancelUrl });
+ *   // For free offers:
+ *   await subscribeFree(offerId);
+ */
+
+interface UseCheckoutResult {
+    checkout: (params: {
+        offerId: string;
+        successUrl: string;
+        cancelUrl: string;
+        quantity?: number;
+    }) => Promise<CheckoutResult>;
+    subscribeFree: (offerId: string) => Promise<FreeSubscriptionResult>;
+    loading: boolean;
+    error: Error | null;
+}
+declare function useCheckout(): UseCheckoutResult;
+
+/**
+ * usePortal — Create a customer portal session and redirect.
+ *
+ * Usage:
+ *   const { openPortal, loading, error } = usePortal();
+ *   await openPortal("https://app.example.com/settings");
+ */
+
+interface UsePortalResult {
+    openPortal: (returnUrl: string) => Promise<PortalResult>;
+    loading: boolean;
+    error: Error | null;
+}
+declare function usePortal(): UsePortalResult;
+
+/**
+ * useSubscription — Fetch current user's active subscription.
+ */
+
+interface UseSubscriptionResult {
+    subscription: SubscriptionInfo | null;
+    loading: boolean;
+    error: Error | null;
+    refetch: () => void;
+}
+declare function useSubscription(): UseSubscriptionResult;
+
+/**
+ * useSuccessSync — Eagerly sync subscription state after Stripe checkout.
+ *
+ * Call this from your checkout success page. It POSTs to the success-sync
+ * endpoint which fetches the latest subscription from Stripe and populates
+ * the Redis cache + DB, so the UI can show subscription status immediately
+ * instead of waiting for the webhook.
+ *
+ * Usage:
+ *   const { sync, data, loading, error } = useSuccessSync();
+ *   useEffect(() => { sync(); }, [sync]);
+ */
+
+interface UseSuccessSyncResult {
+    sync: () => Promise<CachedSubscriptionState | null>;
+    data: CachedSubscriptionState | null;
+    loading: boolean;
+    error: Error | null;
+}
+declare function useSuccessSync(): UseSuccessSyncResult;
+
+interface PricingPageProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+}
+declare function PricingPage({ productId, onSelectOffer }: PricingPageProps): react_jsx_runtime.JSX.Element;
+
+interface PricingSectionProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+    /** Maximum number of features to display per card (default 4) */
+    maxFeatures?: number;
+}
+declare function PricingSection({ productId, onSelectOffer, maxFeatures, }: PricingSectionProps): react_jsx_runtime.JSX.Element;
+
+interface UpgradeModalProps {
+    productId: string;
+    open: boolean;
+    onClose: () => void;
+    onSelectOffer?: (offer: ProductOffer) => void;
+}
+declare function UpgradeModal({ productId, open, onClose, onSelectOffer, }: UpgradeModalProps): react_jsx_runtime.JSX.Element | null;
+
+interface PricingDetailPageProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** Called when user clicks an offer's CTA button */
+    onSelectOffer?: (offer: ProductOffer) => void;
+    /** Whether to show the feature comparison table (defaults to true) */
+    showComparison?: boolean;
+}
+declare function PricingDetailPage({ productId, onSelectOffer, showComparison, }: PricingDetailPageProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * ManageSubscription — Button that opens the billing provider's customer portal.
+ *
+ * Usage:
+ *   <ManageSubscription returnUrl="https://app.example.com/settings" />
+ */
+interface ManageSubscriptionProps {
+    returnUrl: string;
+    buttonText?: string;
+}
+declare function ManageSubscription({ returnUrl, buttonText, }: ManageSubscriptionProps): react_jsx_runtime.JSX.Element;
+
+interface SubscriptionManagerProps {
+    /** Product slug (e.g., "raise-simpli") */
+    productId: string;
+    /** URL to return to after portal session */
+    returnUrl: string;
+    /** Called when user clicks an available plan's CTA button */
+    onPlanChange?: (offer: ProductOffer) => void;
+    /** Optional status message to display (e.g., after checkout redirect) */
+    statusMessage?: "success" | "cancelled" | "activating" | null;
+}
+declare function SubscriptionManager({ productId, returnUrl, onPlanChange, statusMessage, }: SubscriptionManagerProps): react_jsx_runtime.JSX.Element;
+
+export { BillingApiClient, BillingConfig, BillingProduct, BillingProvider, type BillingProviderProps, CachedSubscriptionState, CheckoutResult, FreeSubscriptionResult, ManageSubscription, type ManageSubscriptionProps, PortalResult, PricingDetailPage, type PricingDetailPageProps, PricingPage, type PricingPageProps, PricingSection, type PricingSectionProps, ProductOffer, SubscriptionInfo, SubscriptionManager, type SubscriptionManagerProps, UpgradeModal, type UpgradeModalProps, useBillingContext, useCheckout, usePortal, useProduct, useSubscription, useSuccessSync };