@digilogiclabs/saas-factory-payments 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,365 @@
+import React, { ReactNode } from 'react';
+
+interface Subscription {
+    id: string;
+    customerId: string;
+    priceId: string;
+    status: 'active' | 'canceled' | 'past_due' | 'unpaid' | 'incomplete' | 'incomplete_expired' | 'trialing';
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+    cancelAtPeriodEnd: boolean;
+    trialEnd?: Date;
+    trialStart?: Date;
+    canceledAt?: Date;
+    endedAt?: Date;
+    metadata?: Record<string, string>;
+}
+interface SubscriptionItem {
+    id: string;
+    subscriptionId: string;
+    priceId: string;
+    quantity: number;
+    metadata?: Record<string, string>;
+}
+interface SubscriptionCreateParams {
+    customerId: string;
+    priceId: string;
+    quantity?: number;
+    trialPeriodDays?: number;
+    metadata?: Record<string, string>;
+    paymentBehavior?: 'default_incomplete' | 'error_if_incomplete' | 'allow_incomplete';
+}
+interface SubscriptionUpdateParams {
+    priceId?: string;
+    quantity?: number;
+    cancelAtPeriodEnd?: boolean;
+    metadata?: Record<string, string>;
+}
+type SubscriptionStatus = Subscription['status'];
+
+interface Customer {
+    id: string;
+    email: string;
+    name?: string;
+    phone?: string;
+    stripeCustomerId?: string;
+    subscriptions: Subscription[];
+    defaultPaymentMethodId?: string;
+    metadata?: Record<string, string>;
+    created: Date;
+    updated: Date;
+}
+interface CustomerCreateParams {
+    email: string;
+    name?: string;
+    phone?: string;
+    metadata?: Record<string, string>;
+    paymentMethod?: string;
+}
+interface CustomerUpdateParams {
+    email?: string;
+    name?: string;
+    phone?: string;
+    metadata?: Record<string, string>;
+    defaultPaymentMethod?: string;
+}
+interface PaymentMethod {
+    id: string;
+    type: 'card' | 'bank_account' | 'sepa_debit' | 'ideal' | 'sofort';
+    card?: {
+        brand: string;
+        last4: string;
+        expMonth: number;
+        expYear: number;
+        country?: string;
+    };
+    bankAccount?: {
+        last4: string;
+        bankName?: string;
+        accountType?: string;
+    };
+    isDefault: boolean;
+    created: Date;
+}
+interface BillingAddress {
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+
+interface PaymentsConfig {
+    provider: 'stripe';
+    publishableKey: string;
+    secretKey?: string;
+    webhookSecret?: string;
+    environment: 'development' | 'production';
+    apiVersion?: string;
+}
+interface PricingPlan {
+    id: string;
+    name: string;
+    description?: string;
+    price: number;
+    currency: string;
+    interval: 'day' | 'week' | 'month' | 'year';
+    intervalCount?: number;
+    stripePriceId: string;
+    stripeProductId?: string;
+    features: string[];
+    popular?: boolean;
+    trialPeriodDays?: number;
+    metadata?: Record<string, string>;
+}
+interface CheckoutSessionParams {
+    priceId: string;
+    customerId?: string;
+    customerEmail?: string;
+    successUrl: string;
+    cancelUrl: string;
+    mode?: 'payment' | 'subscription' | 'setup';
+    allowPromotionCodes?: boolean;
+    billingAddressCollection?: 'auto' | 'required';
+    metadata?: Record<string, string>;
+    trialPeriodDays?: number;
+}
+interface PaymentIntentParams {
+    amount: number;
+    currency: string;
+    customerId?: string;
+    paymentMethodTypes?: string[];
+    metadata?: Record<string, string>;
+    description?: string;
+}
+interface WebhookEvent {
+    id: string;
+    type: string;
+    data: {
+        object: any;
+        previous_attributes?: any;
+    };
+    created: number;
+    livemode: boolean;
+    pending_webhooks: number;
+    request?: {
+        id: string;
+        idempotency_key?: string;
+    };
+}
+interface StripeError {
+    type: 'card_error' | 'invalid_request_error' | 'api_error' | 'authentication_error' | 'rate_limit_error';
+    code?: string;
+    message: string;
+    param?: string;
+    decline_code?: string;
+}
+interface Invoice {
+    id: string;
+    customerId: string;
+    subscriptionId?: string;
+    status: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void';
+    amountDue: number;
+    amountPaid: number;
+    currency: string;
+    dueDate?: Date;
+    paidAt?: Date;
+    hostedInvoiceUrl?: string;
+    invoicePdf?: string;
+    metadata?: Record<string, string>;
+}
+
+declare const STRIPE_API_VERSION = "2023-10-16";
+declare const PAYMENT_METHODS: {
+    readonly CARD: "card";
+    readonly BANK_ACCOUNT: "bank_account";
+    readonly SEPA_DEBIT: "sepa_debit";
+    readonly IDEAL: "ideal";
+    readonly SOFORT: "sofort";
+};
+declare const SUBSCRIPTION_STATUS: {
+    readonly ACTIVE: "active";
+    readonly CANCELED: "canceled";
+    readonly PAST_DUE: "past_due";
+    readonly UNPAID: "unpaid";
+    readonly INCOMPLETE: "incomplete";
+    readonly INCOMPLETE_EXPIRED: "incomplete_expired";
+    readonly TRIALING: "trialing";
+};
+declare const INVOICE_STATUS: {
+    readonly DRAFT: "draft";
+    readonly OPEN: "open";
+    readonly PAID: "paid";
+    readonly UNCOLLECTIBLE: "uncollectible";
+    readonly VOID: "void";
+};
+declare const CHECKOUT_MODE: {
+    readonly PAYMENT: "payment";
+    readonly SUBSCRIPTION: "subscription";
+    readonly SETUP: "setup";
+};
+declare const BILLING_INTERVALS: {
+    readonly DAY: "day";
+    readonly WEEK: "week";
+    readonly MONTH: "month";
+    readonly YEAR: "year";
+};
+declare const CURRENCY_SYMBOLS: {
+    readonly USD: "$";
+    readonly EUR: "€";
+    readonly GBP: "£";
+    readonly JPY: "¥";
+    readonly CAD: "C$";
+    readonly AUD: "A$";
+    readonly CHF: "CHF";
+    readonly CNY: "¥";
+    readonly SEK: "kr";
+    readonly NZD: "NZ$";
+};
+declare const DEFAULT_CURRENCY = "USD";
+declare const WEBHOOK_EVENTS: {
+    readonly CUSTOMER_SUBSCRIPTION_CREATED: "customer.subscription.created";
+    readonly CUSTOMER_SUBSCRIPTION_UPDATED: "customer.subscription.updated";
+    readonly CUSTOMER_SUBSCRIPTION_DELETED: "customer.subscription.deleted";
+    readonly INVOICE_PAYMENT_SUCCEEDED: "invoice.payment_succeeded";
+    readonly INVOICE_PAYMENT_FAILED: "invoice.payment_failed";
+    readonly CHECKOUT_SESSION_COMPLETED: "checkout.session.completed";
+    readonly PAYMENT_INTENT_SUCCEEDED: "payment_intent.succeeded";
+    readonly PAYMENT_INTENT_PAYMENT_FAILED: "payment_intent.payment_failed";
+};
+declare const ERROR_MESSAGES: {
+    readonly PROVIDER_NOT_CONFIGURED: "Payments provider is not properly configured";
+    readonly STRIPE_NOT_LOADED: "Stripe has not been loaded yet";
+    readonly INVALID_PRICE_ID: "Invalid price ID provided";
+    readonly INVALID_CUSTOMER_ID: "Invalid customer ID provided";
+    readonly CHECKOUT_FAILED: "Checkout session creation failed";
+    readonly PAYMENT_FAILED: "Payment processing failed";
+    readonly SUBSCRIPTION_NOT_FOUND: "Subscription not found";
+    readonly CUSTOMER_NOT_FOUND: "Customer not found";
+};
+
+declare const validateEmail: (email: string) => boolean;
+declare const validatePhoneNumber: (phone: string) => boolean;
+declare const validatePaymentsConfig: (config: PaymentsConfig) => {
+    isValid: boolean;
+    errors: string[];
+};
+declare const validatePricingPlan: (plan: PricingPlan) => {
+    isValid: boolean;
+    errors: string[];
+};
+declare const validateStripeId: (id: string, type: "customer" | "subscription" | "price" | "product" | "payment_intent") => boolean;
+declare const validateAmount: (amount: number, currency: string) => {
+    isValid: boolean;
+    error?: string;
+};
+
+declare const formatCurrency: (amount: number, currency?: string, options?: {
+    showSymbol?: boolean;
+    showCents?: boolean;
+    locale?: string;
+}) => string;
+declare const formatPricingPlan: (plan: PricingPlan) => string;
+declare const formatSubscriptionStatus: (status: SubscriptionStatus) => string;
+declare const formatDate: (date: Date | string | number, options?: {
+    format?: "short" | "medium" | "long" | "full";
+    locale?: string;
+    timeZone?: string;
+}) => string;
+declare const formatRelativeTime: (date: Date | string | number, options?: {
+    locale?: string;
+    numeric?: "always" | "auto";
+}) => string;
+declare const formatBillingInterval: (interval: string, count?: number) => string;
+declare const formatTrialPeriod: (days: number) => string;
+declare const truncateText: (text: string, maxLength: number) => string;
+declare const formatCardBrand: (brand: string) => string;
+declare const formatPaymentMethodDisplay: (paymentMethod: {
+    type: string;
+    card?: {
+        brand: string;
+        last4: string;
+    };
+    bankAccount?: {
+        last4: string;
+        bankName?: string;
+    };
+}) => string;
+
+/**
+ * Environment validation utilities for SaaS Factory Payments
+ */
+interface EnvironmentConfig {
+    stripePublishableKey: string;
+    stripeSecretKey?: string;
+    stripeWebhookSecret?: string;
+    environment: 'development' | 'production';
+    appUrl?: string;
+}
+declare const validateEnvironment: (config: Partial<EnvironmentConfig>) => {
+    isValid: boolean;
+    errors: string[];
+    warnings: string[];
+};
+declare const getEnvironmentConfig: () => EnvironmentConfig;
+declare const validateCurrentEnvironment: () => {
+    isValid: boolean;
+    errors: string[];
+    warnings: string[];
+};
+declare const isDevelopment: () => boolean;
+declare const isProduction: () => boolean;
+declare const isServer: () => boolean;
+declare const isClient: () => boolean;
+
+interface PaymentsContextType {
+    config: PaymentsConfig;
+    isConfigured: boolean;
+    isProduction: boolean;
+}
+interface PaymentsProviderProps {
+    children: ReactNode;
+    config: PaymentsConfig;
+}
+declare const PaymentsProvider: React.FC<PaymentsProviderProps>;
+declare const usePaymentsConfig: () => PaymentsContextType;
+declare const usePaymentsConfigSafe: () => PaymentsContextType | null;
+
+interface UsePaymentsOptions {
+    customerId?: string;
+    autoFetch?: boolean;
+    onError?: (error: string) => void;
+}
+interface UsePaymentsReturn {
+    customer: Customer | null;
+    subscriptions: Subscription[];
+    activeSubscription: Subscription | null;
+    loading: boolean;
+    error: string | null;
+    createCustomer: (params: {
+        email: string;
+        name?: string;
+        phone?: string;
+        metadata?: Record<string, string>;
+    }) => Promise<Customer | null>;
+    updateCustomer: (params: {
+        email?: string;
+        name?: string;
+        phone?: string;
+        metadata?: Record<string, string>;
+    }) => Promise<boolean>;
+    subscribe: (priceId: string, options?: {
+        trialPeriodDays?: number;
+        metadata?: Record<string, string>;
+    }) => Promise<boolean>;
+    cancelSubscription: (subscriptionId?: string) => Promise<boolean>;
+    reactivateSubscription: (subscriptionId?: string) => Promise<boolean>;
+    refetch: () => Promise<void>;
+    hasActiveSubscription: () => boolean;
+    isSubscribedToPlan: (priceId: string) => boolean;
+    getSubscriptionStatus: (subscriptionId?: string) => string | null;
+}
+declare const usePayments: (options?: UsePaymentsOptions) => UsePaymentsReturn;
+
+export { BILLING_INTERVALS, type BillingAddress, CHECKOUT_MODE, CURRENCY_SYMBOLS, type CheckoutSessionParams, type Customer, type CustomerCreateParams, type CustomerUpdateParams, DEFAULT_CURRENCY, ERROR_MESSAGES, type EnvironmentConfig, INVOICE_STATUS, type Invoice, PAYMENT_METHODS, type PaymentIntentParams, type PaymentMethod, type PaymentsConfig, PaymentsProvider, type PricingPlan, STRIPE_API_VERSION, SUBSCRIPTION_STATUS, type StripeError, type Subscription, type SubscriptionCreateParams, type SubscriptionItem, type SubscriptionStatus, type SubscriptionUpdateParams, WEBHOOK_EVENTS, type WebhookEvent, formatBillingInterval, formatCardBrand, formatCurrency, formatDate, formatPaymentMethodDisplay, formatPricingPlan, formatRelativeTime, formatSubscriptionStatus, formatTrialPeriod, getEnvironmentConfig, isClient, isDevelopment, isProduction, isServer, truncateText, usePayments, usePaymentsConfig, usePaymentsConfigSafe, validateAmount, validateCurrentEnvironment, validateEmail, validateEnvironment, validatePaymentsConfig, validatePhoneNumber, validatePricingPlan, validateStripeId };