@umituz/web-payment 0.0.0-stage → 1.0.1

package/dist/portal.d.mts

@@ -0,0 +1,445 @@
+import * as react from 'react';
+import { ReactNode, ButtonHTMLAttributes } from 'react';
+import { b as BillingCycle } from './billing-cycle.enum--hJRYlgP.mjs';
+export { B as BILLING_CYCLE } from './billing-cycle.enum--hJRYlgP.mjs';
+import { b as VisualTone, N as NavigationStrategy } from './visual-tokens-BCLVR85G.mjs';
+import { a as Product, h as ProductPrice } from './product.mapper-noVl-sel.mjs';
+import { B as BillingAdapter } from './billing-adapter.interface-CDkeeowZ.mjs';
+
+declare const SUBSCRIPTION_STATUS: {
+    readonly ACTIVE: "active";
+    readonly TRIALING: "trialing";
+    readonly PAST_DUE: "past_due";
+    readonly CANCELED: "canceled";
+    readonly UNPAID: "unpaid";
+    readonly INCOMPLETE: "incomplete";
+    readonly REVOKED: "revoked";
+};
+declare const INVOICE_STATUS: {
+    readonly DRAFT: "draft";
+    readonly OPEN: "open";
+    readonly PAID: "paid";
+    readonly VOID: "void";
+    readonly UNCOLLECTIBLE: "uncollectible";
+    readonly REFUNDED: "refunded";
+};
+declare const CURRENCY: {
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly TRY: "TRY";
+    readonly JPY: "JPY";
+};
+type Currency$1 = typeof CURRENCY[keyof typeof CURRENCY];
+declare const PLAN_TYPE: {
+    readonly STANDARD: "standard";
+    readonly PRO: "pro";
+    readonly BUSINESS: "business";
+    readonly ENTERPRISE: "enterprise";
+};
+declare const DEFAULT_BILLING_CONFIG: {
+    readonly enableYearlyDiscount: true;
+    readonly yearlyDiscount: 20;
+    readonly currencies: Currency$1[];
+    readonly defaultCurrency: "USD";
+    readonly taxRate: 0;
+};
+
+declare function formatLabel(template: string, params: Record<string, string | number>): string;
+interface BillingLabels {
+    common: {
+        loading: string;
+        usage: string;
+    };
+    page: {
+        backToDashboard: string;
+        title: string;
+        description: string;
+        needHelp: string;
+        contactAria: string;
+    };
+    tabs: {
+        overview: string;
+        paymentMethods: string;
+        invoices: string;
+        plan: string;
+    };
+    overview: {
+        currentSubscription: string;
+        trialDaysLeft: string;
+        nextBilling: string;
+        upcomingInvoice: string;
+    };
+    invoices: {
+        empty: string;
+        moreItems: string;
+        due: string;
+        viewInvoice: string;
+        downloadPdf: string;
+    };
+    plan: {
+        title: string;
+        actionsTitle: string;
+        changePlan: string;
+        cancelSubscription: string;
+        confirmCancel: string;
+        cancelling: string;
+        cancelConfirmMessage: string;
+        cancelFailed: string;
+    };
+    planComparison: {
+        monthly: string;
+        yearly: string;
+        monthlyShort: string;
+        yearlyShort: string;
+        save: string;
+        saveWithYearly: string;
+        mostPopular: string;
+        currentPlan: string;
+        selectPlan: string;
+        processing: string;
+        billingCycleLabel: string;
+        radiogroupLabel: string;
+    };
+    paymentMethods: {
+        none: string;
+        add: string;
+        bankAccount: string;
+        expires: string;
+        default: string;
+        setDefault: string;
+        remove: string;
+        removeConfirm: string;
+        confirmRemove: string;
+        cancelRemove: string;
+    };
+    usage: {
+        limit: string;
+        resets: string;
+    };
+    status: Record<SubscriptionStatus, string>;
+    invoiceStatus: Record<InvoiceStatus, string>;
+}
+type BillingLabelsOverrides = {
+    [K in keyof BillingLabels]?: BillingLabels[K] extends string ? string : {
+        [K2 in keyof BillingLabels[K]]?: BillingLabels[K][K2];
+    };
+};
+declare const DEFAULT_BILLING_LABELS: Readonly<BillingLabels>;
+declare function mergeLabels(overrides?: BillingLabelsOverrides): BillingLabels;
+declare function BillingLabelsProvider({ labels, children, }: {
+    labels?: BillingLabelsOverrides;
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useBillingLabels(): BillingLabels;
+
+type SubscriptionStatus = typeof SUBSCRIPTION_STATUS[keyof typeof SUBSCRIPTION_STATUS];
+type InvoiceStatus = typeof INVOICE_STATUS[keyof typeof INVOICE_STATUS];
+type PlanType = string;
+type Currency = typeof CURRENCY[keyof typeof CURRENCY];
+type PlanFeature = string | {
+    text: string;
+    bold?: boolean;
+    included?: boolean;
+};
+interface PlanTier {
+    id: string;
+    type?: PlanType;
+    name: string;
+    description: string;
+    badge?: string;
+    badgeColor?: string;
+    monthlyPrice: number;
+    yearlyPrice: number;
+    currency: Currency;
+    features: PlanFeature[];
+    highlight?: boolean;
+    maxUsers?: number;
+    storageLimit?: number;
+    apiLimit?: number;
+}
+interface Subscription {
+    id: string;
+    planId: string;
+    plan: PlanTier;
+    status: SubscriptionStatus;
+    cycle: BillingCycle;
+    currentPeriodStart: string;
+    currentPeriodEnd: string;
+    cancelAtPeriodEnd?: boolean;
+    trialEnd?: string;
+    seats?: number;
+}
+type PaymentMethodType = 'card' | 'bank_account' | 'wallet';
+interface PaymentMethod {
+    id: string;
+    type: PaymentMethodType;
+    isDefault: boolean;
+    card?: {
+        last4: string;
+        brand: string;
+        expiryMonth: number;
+        expiryYear: number;
+        name?: string;
+    };
+    bankAccount?: {
+        last4: string;
+        bankName: string;
+        accountType?: 'checking' | 'savings';
+    };
+    createdAt: string;
+}
+interface InvoiceItem {
+    description: string;
+    quantity: number;
+    unitPrice: number;
+    amount: number;
+}
+interface Invoice {
+    id: string;
+    number: string;
+    amount: number;
+    currency: string;
+    status: InvoiceStatus;
+    date: string;
+    dueDate: string;
+    paidAt?: string;
+    invoiceUrl?: string;
+    pdfUrl?: string;
+    items?: InvoiceItem[];
+    subtotal?: number;
+    tax?: number;
+    total?: number;
+}
+interface UsageMetric {
+    id: string;
+    name: string;
+    current: number;
+    limit: number;
+    unit: string;
+    resetPeriod: 'daily' | 'monthly' | 'yearly';
+    resetAt?: string;
+}
+interface BillingSummary {
+    subscription: Subscription;
+    paymentMethods: PaymentMethod[];
+    defaultPaymentMethod?: PaymentMethod;
+    upcomingInvoice?: {
+        amount: number;
+        currency: Currency;
+        date: string;
+    };
+    usage: UsageMetric[];
+    recentInvoices: Invoice[];
+}
+type PaymentMethodInput = {
+    type: 'card';
+    last4: string;
+    brand: string;
+    expiryMonth: number;
+    expiryYear: number;
+    name?: string;
+} | {
+    type: 'bank_account';
+    last4: string;
+    bankName: string;
+    accountType?: 'checking' | 'savings';
+};
+interface PlanComparisonProps {
+    plans: PlanTier[];
+    selectedPlan?: string;
+    cycle: BillingCycle;
+    showCycleToggle?: boolean;
+    showFeatures?: boolean;
+    onPlanSelect?: (planId: string) => void;
+    onCycleChange?: (cycle: BillingCycle) => void;
+    loading?: boolean;
+    labels?: BillingLabelsOverrides;
+}
+interface PaymentMethodsListProps {
+    paymentMethods: PaymentMethod[];
+    loading?: boolean;
+    busyId?: string | null;
+    onSetDefault?: (methodId: string) => void;
+    onRemove?: (methodId: string) => void;
+    onAddNew?: () => void;
+}
+interface InvoiceCardProps {
+    invoice: Invoice;
+    compact?: boolean;
+    onClick?: (invoice: Invoice) => void;
+    onDownload?: (invoice: Invoice) => void;
+    locale?: string;
+}
+interface UsageCardProps {
+    metric: UsageMetric;
+    locale?: string;
+    showProgress?: boolean;
+    showLimit?: boolean;
+}
+type BillingTabId = 'overview' | 'payment-methods' | 'invoices' | 'plan';
+interface BillingPortalProps {
+    billing: BillingSummary;
+    loading?: boolean;
+    error?: string;
+    showTabs?: boolean;
+    activeTab?: BillingTabId;
+    locale?: string;
+    onTabChange?: (tab: BillingTabId) => void;
+    onAddPaymentMethod?: () => void;
+    onSetDefaultPaymentMethod?: (methodId: string) => void;
+    onRemovePaymentMethod?: (methodId: string) => void;
+    onViewInvoice?: (invoice: Invoice) => void;
+    onChangePlan?: () => void;
+    onCancelSubscription?: () => void | Promise<void>;
+    labels?: BillingLabelsOverrides;
+}
+interface BillingLayoutProps {
+    config: BillingConfig;
+    children?: ReactNode;
+    onBack?: () => void;
+}
+interface BillingConfig {
+    brandName: string;
+    logo?: ReactNode;
+    plans: PlanTier[];
+    currencies?: Currency[];
+    defaultCurrency?: Currency;
+    enableYearlyDiscount?: boolean;
+    yearlyDiscount?: number;
+    taxRate?: number;
+    supportEmail?: string;
+    cancelRoute?: string;
+    updatePaymentRoute?: string;
+    invoiceHistoryRoute?: string;
+}
+interface BillingPageProps extends Omit<BillingPortalProps, 'showTabs'> {
+    config: BillingConfig;
+}
+
+declare const BillingPortal: ({ billing, loading, error, showTabs, activeTab, locale, onTabChange, onAddPaymentMethod, onSetDefaultPaymentMethod, onRemovePaymentMethod, onViewInvoice, onChangePlan, onCancelSubscription, labels, }: BillingPortalProps) => react.JSX.Element;
+
+declare const BillingLayout: ({ config, children, onBack }: BillingLayoutProps) => react.JSX.Element;
+
+declare const BillingPage: ({ config, labels, ...portalProps }: BillingPageProps) => react.JSX.Element;
+
+declare const RADIO_GROUP_NAME = "plan-comparison";
+declare const PlanComparison: ({ plans, selectedPlan, cycle, showCycleToggle, showFeatures, onPlanSelect, onCycleChange, loading, labels: labelsOverride, }: PlanComparisonProps) => react.JSX.Element;
+
+declare const PaymentMethodsList: ({ paymentMethods, loading, busyId, onSetDefault, onRemove, onAddNew, }: PaymentMethodsListProps) => react.JSX.Element;
+
+declare const InvoiceCard: ({ invoice, compact, locale, onClick, onDownload, }: InvoiceCardProps) => react.JSX.Element;
+
+declare const UsageCard: ({ metric, locale, showProgress, showLimit, }: UsageCardProps) => react.JSX.Element;
+
+type PortalButtonVariant = 'default' | 'outline' | 'destructive' | 'ghost';
+type PortalButtonSize = 'sm' | 'md';
+interface PortalButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    variant?: PortalButtonVariant;
+    size?: PortalButtonSize;
+    fullWidth?: boolean;
+    pill?: boolean;
+    icon?: ReactNode;
+    children?: ReactNode;
+}
+declare const PortalButton: ({ variant, size, fullWidth, pill, icon, children, disabled, style, type, ...rest }: PortalButtonProps) => react.JSX.Element;
+
+declare const PortalSpinner: ({ size }: {
+    size?: number;
+}) => react.JSX.Element;
+
+interface BillingApiClient {
+    loadBilling: () => Promise<BillingSummary>;
+    updatePlan: (planId: string) => Promise<void>;
+    cancelSubscription: () => Promise<void>;
+    updateCycle: (cycle: BillingCycle) => Promise<void>;
+    addPaymentMethod: (input: PaymentMethodInput) => Promise<PaymentMethod>;
+    removePaymentMethod: (methodId: string) => Promise<void>;
+    setDefaultPaymentMethod: (methodId: string) => Promise<void>;
+    getInvoiceUrl: (invoiceId: string) => Promise<string>;
+}
+interface UseBillingOptions {
+    initialData?: BillingSummary;
+    apiClient: BillingApiClient;
+}
+interface UseBillingReturn {
+    billing: BillingSummary | null;
+    isLoading: boolean;
+    error: string | null;
+    loadBilling: () => Promise<void>;
+    updatePlan: (planId: string) => Promise<void>;
+    cancelSubscription: () => Promise<void>;
+    updateCycle: (cycle: BillingCycle) => Promise<void>;
+    addPaymentMethod: (input: PaymentMethodInput) => Promise<PaymentMethod | null>;
+    removePaymentMethod: (methodId: string) => Promise<void>;
+    setDefaultPaymentMethod: (methodId: string) => Promise<void>;
+    getInvoiceUrl: (invoiceId: string) => Promise<string | null>;
+}
+declare function useBilling(options: UseBillingOptions): UseBillingReturn;
+declare const createStubBillingApiClient: (overrides?: Partial<BillingApiClient>) => BillingApiClient;
+
+declare function formatNumber(num: number, locale?: string): string;
+declare function formatPrice(amount: number, currency?: string): string;
+declare function calculateDiscount(monthlyPrice: number, yearlyPrice: number): number;
+declare function calculateProratedAmount(amount: number, daysUsed: number, totalDays: number): number;
+declare function getPlanPrice(plan: PlanTier, cycle: BillingCycle): number;
+declare function calculateUsagePercentage(metric: UsageMetric): number;
+declare function isNearLimit(metric: UsageMetric, threshold?: number): boolean;
+declare function getStatusTone(status: SubscriptionStatus): VisualTone;
+declare function getStatusLabel(status: SubscriptionStatus): string;
+declare function getInvoiceStatusTone(status: InvoiceStatus): VisualTone;
+declare function getInvoiceStatusLabel(status: InvoiceStatus): string;
+declare function formatCardNumber(last4: string, brand: string): string;
+declare function formatExpiry(month: number, year: number): string;
+declare function getDaysRemaining(endDate: string): number;
+declare function isTrialExpiringSoon(trialEnd: string, daysThreshold?: number): boolean;
+declare function getNextBillingDate(currentPeriodEnd: string, cycle: BillingCycle): Date;
+declare function groupInvoicesByStatus(invoices: Invoice[]): Record<InvoiceStatus, Invoice[]>;
+declare function calculateInvoiceTotal(invoices: Invoice[], status?: InvoiceStatus): number;
+declare function sortInvoicesByDate(invoices: Invoice[], order?: 'asc' | 'desc'): Invoice[];
+declare function formatFeature(feature: string | {
+    text: string;
+    bold?: boolean;
+    included?: boolean;
+}): {
+    text: string;
+    bold?: boolean;
+    included?: boolean;
+};
+declare function isPopularPlan(plan: PlanTier, plans: PlanTier[]): boolean;
+declare function getTrialDaysText(trialEnd: string): string;
+
+declare function transformProductToPlan(product: Product, price: ProductPrice): PlanTier;
+declare function transformProducts(products: Product[]): PlanTier[];
+
+interface PortalClientOptions {
+    adapter: BillingAdapter;
+    products: Product[];
+    userId?: string;
+    defaultCycle?: BillingCycle;
+    successUrl?: string;
+    navigation?: NavigationStrategy;
+}
+interface PortalClient extends BillingApiClient {
+    selectPlan: (productId: string, cycle?: BillingCycle) => Promise<void>;
+    openPortal: () => Promise<string>;
+}
+declare function createPortalClient(options: PortalClientOptions): PortalClient;
+
+interface TurnkeyBillingPageProps {
+    adapter: BillingAdapter;
+    products: Product[];
+    config: Omit<BillingConfig, 'plans'> & {
+        plans?: PlanTier[];
+    };
+    userId?: string;
+    defaultCycle?: BillingCycle;
+    successUrl?: string;
+    navigation?: NavigationStrategy;
+    locale?: string;
+    labels?: BillingLabelsOverrides;
+    onError?: (error: Error) => void;
+}
+declare function TurnkeyBillingPage({ adapter, products, config, userId, defaultCycle, successUrl, navigation, locale, labels, onError, }: TurnkeyBillingPageProps): react.JSX.Element;
+
+export { type BillingApiClient, type BillingConfig, BillingCycle, type BillingLabels, type BillingLabelsOverrides, BillingLabelsProvider, BillingLayout, type BillingLayoutProps, BillingPage, type BillingPageProps, BillingPortal, type BillingPortalProps, type BillingSummary, type BillingTabId, CURRENCY, type Currency, DEFAULT_BILLING_CONFIG, DEFAULT_BILLING_LABELS, INVOICE_STATUS, type Invoice, InvoiceCard, type InvoiceCardProps, type InvoiceItem, type InvoiceStatus, PLAN_TYPE, type PaymentMethod, type PaymentMethodInput, type PaymentMethodType, PaymentMethodsList, type PaymentMethodsListProps, PlanComparison, type PlanComparisonProps, type PlanTier, type PlanType, PortalButton, type PortalButtonProps, type PortalButtonSize, type PortalButtonVariant, type PortalClient, type PortalClientOptions, PortalSpinner, RADIO_GROUP_NAME, SUBSCRIPTION_STATUS, type Subscription, type SubscriptionStatus, TurnkeyBillingPage, type TurnkeyBillingPageProps, UsageCard, type UsageCardProps, type UsageMetric, type UseBillingOptions, type UseBillingReturn, calculateDiscount, calculateInvoiceTotal, calculateProratedAmount, calculateUsagePercentage, createPortalClient, createStubBillingApiClient, formatCardNumber, formatExpiry, formatFeature, formatLabel, formatNumber, formatPrice, getDaysRemaining, getInvoiceStatusLabel, getInvoiceStatusTone, getNextBillingDate, getPlanPrice, getStatusLabel, getStatusTone, getTrialDaysText, groupInvoicesByStatus, isNearLimit, isPopularPlan, isTrialExpiringSoon, mergeLabels, sortInvoicesByDate, transformProductToPlan, transformProducts, useBilling, useBillingLabels };