@classytic/revenue 1.1.2 → 1.1.3

package/dist/index-DxIK0UmZ.d.ts

@@ -1,633 +0,0 @@
-import { o as MonetizationCreateParams, p as MonetizationCreateResult, A as ActivateOptions, S as SubscriptionDocument, q as RenewalParams, r as CancelOptions, s as PauseOptions, t as ResumeOptions, u as ListOptions, v as PaymentVerifyOptions, w as PaymentVerifyResult, x as PaymentStatusResult, y as RefundOptions, z as PaymentRefundResult, B as WebhookResult, T as TransactionDocument, k as PaymentProviderInterface, E as TransactionListResult, H as HoldOptions, G as ReleaseOptions, I as ReleaseResult, J as CancelHoldOptions, c as SplitRule, K as SplitResult, N as EscrowStatusResult } from './index-cLJBLUvx.js';
-import { S as SettlementDocument } from './settlement.schema-CpamV7ZY.js';
-
-/**
- * Dependency Injection Container
- * @classytic/revenue
- *
- * Lightweight DI container for managing dependencies
- * Inspired by: Awilix, InversifyJS but much simpler
- */
-declare class Container {
-    private _services;
-    private _singletons;
-    constructor();
-    /**
-     * Register a service
-     * @param name - Service name
-     * @param implementation - Service implementation or factory
-     * @param options - Registration options
-     */
-    register<T>(name: string, implementation: T | ((container: Container) => T), options?: {
-        singleton?: boolean;
-        factory?: boolean;
-    }): this;
-    /**
-     * Register a singleton service
-     * @param name - Service name
-     * @param implementation - Service implementation
-     */
-    singleton<T>(name: string, implementation: T): this;
-    /**
-     * Register a transient service (new instance each time)
-     * @param name - Service name
-     * @param factory - Factory function
-     */
-    transient<T>(name: string, factory: (container: Container) => T): this;
-    /**
-     * Get a service from the container
-     * @param name - Service name
-     * @returns Service instance
-     */
-    get<T>(name: string): T;
-    /**
-     * Check if service is registered
-     * @param name - Service name
-     */
-    has(name: string): boolean;
-    /**
-     * Get all registered service names
-     */
-    keys(): string[];
-    /**
-     * Clear all services (useful for testing)
-     */
-    clear(): void;
-    /**
-     * Create a child container (for scoped dependencies)
-     */
-    createScope(): Container;
-}
-
-/**
- * Monetization Service
- * @classytic/revenue
- *
- * Framework-agnostic monetization management service with DI
- * Handles purchases, subscriptions, and free items using provider system
- */
-
-/**
- * Monetization Service
- * Uses DI container for all dependencies
- *
- * Architecture:
- * - PluginManager: Wraps operations with lifecycle hooks (before/after)
- * - EventBus: Fire-and-forget notifications for completed operations
- */
-declare class MonetizationService {
-    private readonly models;
-    private readonly providers;
-    private readonly config;
-    private readonly plugins;
-    private readonly logger;
-    private readonly events;
-    private readonly retryConfig;
-    private readonly circuitBreaker;
-    constructor(container: Container);
-    /**
-     * Create plugin context for hook execution
-     * @private
-     */
-    private getPluginContext;
-    /**
-     * Execute provider call with retry and circuit breaker protection
-     * @private
-     */
-    private executeProviderCall;
-    /**
-     * Create a new monetization (purchase, subscription, or free item)
-     *
-     * @param params - Monetization parameters
-     *
-     * @example
-     * // One-time purchase
-     * await revenue.monetization.create({
-     *   data: {
-     *     organizationId: '...',
-     *     customerId: '...',
-     *     sourceId: order._id,
-     *     sourceModel: 'Order',
-     *   },
-     *   planKey: 'one_time',
-     *   monetizationType: 'purchase',
-     *   gateway: 'bkash',
-     *   amount: 1500,
-     * });
-     *
-     * // Recurring subscription
-     * await revenue.monetization.create({
-     *   data: {
-     *     organizationId: '...',
-     *     customerId: '...',
-     *     sourceId: subscription._id,
-     *     sourceModel: 'Subscription',
-     *   },
-     *   planKey: 'monthly',
-     *   monetizationType: 'subscription',
-     *   gateway: 'stripe',
-     *   amount: 2000,
-     * });
-     *
-     * @returns Result with subscription, transaction, and paymentIntent
-     */
-    create(params: MonetizationCreateParams): Promise<MonetizationCreateResult>;
-    /**
-     * Activate subscription after payment verification
-     *
-     * @param subscriptionId - Subscription ID or transaction ID
-     * @param options - Activation options
-     * @returns Updated subscription
-     */
-    activate(subscriptionId: string, options?: ActivateOptions): Promise<SubscriptionDocument>;
-    /**
-     * Renew subscription
-     *
-     * @param subscriptionId - Subscription ID
-     * @param params - Renewal parameters
-     * @returns { subscription, transaction, paymentIntent }
-     */
-    renew(subscriptionId: string, params?: RenewalParams): Promise<MonetizationCreateResult>;
-    /**
-     * Cancel subscription
-     *
-     * @param subscriptionId - Subscription ID
-     * @param options - Cancellation options
-     * @returns Updated subscription
-     */
-    cancel(subscriptionId: string, options?: CancelOptions): Promise<SubscriptionDocument>;
-    /**
-     * Pause subscription
-     *
-     * @param subscriptionId - Subscription ID
-     * @param options - Pause options
-     * @returns Updated subscription
-     */
-    pause(subscriptionId: string, options?: PauseOptions): Promise<SubscriptionDocument>;
-    /**
-     * Resume subscription
-     *
-     * @param subscriptionId - Subscription ID
-     * @param options - Resume options
-     * @returns Updated subscription
-     */
-    resume(subscriptionId: string, options?: ResumeOptions): Promise<SubscriptionDocument>;
-    /**
-     * List subscriptions with filters
-     *
-     * @param filters - Query filters
-     * @param options - Query options (limit, skip, sort)
-     * @returns Subscriptions
-     */
-    list(filters?: Record<string, unknown>, options?: ListOptions): Promise<SubscriptionDocument[]>;
-    /**
-     * Get subscription by ID
-     *
-     * @param subscriptionId - Subscription ID
-     * @returns Subscription
-     */
-    get(subscriptionId: string): Promise<SubscriptionDocument>;
-    /**
-     * Calculate period end date based on plan key
-     * @private
-     */
-    private _calculatePeriodEnd;
-}
-
-/**
- * Payment Service
- * @classytic/revenue
- *
- * Framework-agnostic payment verification and management service with DI
- * Handles payment verification, refunds, and status updates
- */
-
-/**
- * Payment Service
- * Uses DI container for all dependencies
- *
- * Architecture:
- * - PluginManager: Wraps operations with lifecycle hooks (before/after)
- * - EventBus: Fire-and-forget notifications for completed operations
- */
-declare class PaymentService {
-    private readonly models;
-    private readonly providers;
-    private readonly config;
-    private readonly plugins;
-    private readonly logger;
-    private readonly events;
-    private readonly retryConfig;
-    private readonly circuitBreaker;
-    constructor(container: Container);
-    /**
-     * Create plugin context for hook execution
-     * @private
-     */
-    private getPluginContext;
-    /**
-     * Execute provider call with retry and circuit breaker protection
-     * @private
-     */
-    private executeProviderCall;
-    /**
-     * Verify a payment
-     *
-     * @param paymentIntentId - Payment intent ID, session ID, or transaction ID
-     * @param options - Verification options
-     * @returns { transaction, status }
-     */
-    verify(paymentIntentId: string, options?: PaymentVerifyOptions): Promise<PaymentVerifyResult>;
-    /**
-     * Get payment status
-     *
-     * @param paymentIntentId - Payment intent ID, session ID, or transaction ID
-     * @returns { transaction, status }
-     */
-    getStatus(paymentIntentId: string): Promise<PaymentStatusResult>;
-    /**
-     * Refund a payment
-     *
-     * @param paymentId - Payment intent ID, session ID, or transaction ID
-     * @param amount - Amount to refund (optional, full refund if not provided)
-     * @param options - Refund options
-     * @returns { transaction, refundResult }
-     */
-    refund(paymentId: string, amount?: number | null, options?: RefundOptions): Promise<PaymentRefundResult>;
-    /**
-     * Handle webhook from payment provider
-     *
-     * @param provider - Provider name
-     * @param payload - Webhook payload
-     * @param headers - Request headers
-     * @returns { event, transaction }
-     */
-    handleWebhook(providerName: string, payload: unknown, headers?: Record<string, string>): Promise<WebhookResult>;
-    /**
-     * List payments/transactions with filters
-     *
-     * @param filters - Query filters
-     * @param options - Query options (limit, skip, sort)
-     * @returns Transactions
-     */
-    list(filters?: Record<string, unknown>, options?: ListOptions): Promise<TransactionDocument[]>;
-    /**
-     * Get payment/transaction by ID
-     *
-     * @param transactionId - Transaction ID
-     * @returns Transaction
-     */
-    get(transactionId: string): Promise<TransactionDocument>;
-    /**
-     * Get provider instance
-     *
-     * @param providerName - Provider name
-     * @returns Provider instance
-     */
-    getProvider(providerName: string): PaymentProviderInterface;
-    /**
-     * Find transaction by sessionId, paymentIntentId, or transaction ID
-     * @private
-     */
-    private _findTransaction;
-}
-
-/**
- * Transaction Service
- * @classytic/revenue
- *
- * Thin, focused transaction service for core operations
- * Users handle their own analytics, exports, and complex queries
- *
- * Works with ANY model implementation:
- * - Plain Mongoose models
- * - @classytic/mongokit Repository instances
- * - Any other abstraction with compatible interface
- */
-
-/**
- * Transaction Service
- * Focused on core transaction lifecycle operations
- *
- * Architecture:
- * - PluginManager: Wraps operations with lifecycle hooks (before/after)
- * - EventBus: Fire-and-forget notifications for completed operations
- */
-declare class TransactionService {
-    private readonly models;
-    private readonly plugins;
-    private readonly events;
-    private readonly logger;
-    constructor(container: Container);
-    /**
-     * Create plugin context for hook execution
-     * @private
-     */
-    private getPluginContext;
-    /**
-     * Get transaction by ID
-     *
-     * @param transactionId - Transaction ID
-     * @returns Transaction
-     */
-    get(transactionId: string): Promise<TransactionDocument>;
-    /**
-     * List transactions with filters
-     *
-     * @param filters - Query filters
-     * @param options - Query options (limit, skip, sort, populate)
-     * @returns { transactions, total, page, limit }
-     */
-    list(filters?: Record<string, unknown>, options?: ListOptions): Promise<TransactionListResult>;
-    /**
-     * Update transaction
-     *
-     * @param transactionId - Transaction ID
-     * @param updates - Fields to update
-     * @returns Updated transaction
-     */
-    update(transactionId: string, updates: Partial<TransactionDocument>): Promise<TransactionDocument>;
-}
-
-/**
- * Escrow Service
- * @classytic/revenue
- *
- * Platform-as-intermediary payment flow
- * Hold funds → Verify → Split/Deduct → Release to organization
- */
-
-/**
- * Escrow Service
- * Uses DI container for all dependencies
- *
- * Architecture:
- * - PluginManager: Wraps operations with lifecycle hooks (before/after)
- * - EventBus: Fire-and-forget notifications for completed operations
- */
-declare class EscrowService {
-    private readonly models;
-    private readonly plugins;
-    private readonly logger;
-    private readonly events;
-    constructor(container: Container);
-    /**
-     * Create plugin context for hook execution
-     * @private
-     */
-    private getPluginContext;
-    /**
-     * Hold funds in escrow
-     *
-     * @param transactionId - Transaction to hold
-     * @param options - Hold options
-     * @returns Updated transaction
-     */
-    hold(transactionId: string, options?: HoldOptions): Promise<TransactionDocument>;
-    /**
-     * Release funds from escrow to recipient
-     *
-     * @param transactionId - Transaction to release
-     * @param options - Release options
-     * @returns { transaction, releaseTransaction }
-     */
-    release(transactionId: string, options: ReleaseOptions): Promise<ReleaseResult>;
-    /**
-     * Cancel hold and release back to customer
-     *
-     * @param transactionId - Transaction to cancel hold
-     * @param options - Cancel options
-     * @returns Updated transaction
-     */
-    cancel(transactionId: string, options?: CancelHoldOptions): Promise<TransactionDocument>;
-    /**
-     * Split payment to multiple recipients
-     * Deducts splits from held amount and releases remainder to organization
-     *
-     * @param transactionId - Transaction to split
-     * @param splitRules - Split configuration
-     * @returns { transaction, splitTransactions, organizationTransaction }
-     */
-    split(transactionId: string, splitRules?: SplitRule[]): Promise<SplitResult>;
-    /**
-     * Get escrow status
-     *
-     * @param transactionId - Transaction ID
-     * @returns Escrow status
-     */
-    getStatus(transactionId: string): Promise<EscrowStatusResult>;
-}
-
-/**
- * Settlement Service
- * @classytic/revenue
- *
- * Tracks payouts from platform to vendors/affiliates/partners
- * Manages the flow: Transaction → Split → Settlement → Bank Transfer
- */
-
-interface CreateFromSplitsOptions {
-    scheduledAt?: Date;
-    payoutMethod?: 'bank_transfer' | 'mobile_wallet' | 'platform_balance' | 'crypto' | 'manual';
-    metadata?: Record<string, unknown>;
-}
-interface ScheduleSettlementParams {
-    organizationId: string;
-    recipientId: string;
-    recipientType: 'platform' | 'organization' | 'user' | 'affiliate' | 'partner';
-    type: 'split_payout' | 'platform_withdrawal' | 'manual_payout' | 'escrow_release';
-    amount: number;
-    currency?: string;
-    payoutMethod: 'bank_transfer' | 'mobile_wallet' | 'platform_balance' | 'crypto' | 'manual';
-    sourceTransactionIds?: string[];
-    sourceSplitIds?: string[];
-    scheduledAt?: Date;
-    bankTransferDetails?: {
-        accountNumber?: string;
-        accountName?: string;
-        bankName?: string;
-        routingNumber?: string;
-        swiftCode?: string;
-        iban?: string;
-    };
-    mobileWalletDetails?: {
-        provider?: string;
-        phoneNumber?: string;
-        accountNumber?: string;
-    };
-    cryptoDetails?: {
-        network?: string;
-        walletAddress?: string;
-    };
-    notes?: string;
-    metadata?: Record<string, unknown>;
-}
-interface ProcessOptions {
-    limit?: number;
-    organizationId?: string;
-    payoutMethod?: string;
-    dryRun?: boolean;
-}
-interface ProcessResult {
-    processed: number;
-    succeeded: number;
-    failed: number;
-    settlements: SettlementDocument[];
-    errors: Array<{
-        settlementId: string;
-        error: string;
-    }>;
-}
-interface CompletionDetails {
-    transferReference?: string;
-    transferredAt?: Date;
-    transactionHash?: string;
-    notes?: string;
-    metadata?: Record<string, unknown>;
-}
-interface SettlementFilters {
-    organizationId?: string;
-    recipientId?: string;
-    status?: string | string[];
-    type?: string;
-    payoutMethod?: string;
-    scheduledAfter?: Date;
-    scheduledBefore?: Date;
-    limit?: number;
-    skip?: number;
-    sort?: Record<string, 1 | -1>;
-}
-interface SummaryOptions {
-    organizationId?: string;
-    startDate?: Date;
-    endDate?: Date;
-}
-interface SettlementSummary {
-    recipientId: string;
-    totalPending: number;
-    totalProcessing: number;
-    totalCompleted: number;
-    totalFailed: number;
-    amountPending: number;
-    amountCompleted: number;
-    amountFailed: number;
-    currency: string;
-    lastSettlementDate?: Date;
-    settlements: {
-        pending: number;
-        processing: number;
-        completed: number;
-        failed: number;
-        cancelled: number;
-    };
-}
-/**
- * Settlement Service
- *
- * Handles payout tracking after splits are released from escrow:
- *
- * Flow:
- * 1. Transaction has splits → 2. Escrow released → 3. Create settlements → 4. Process payouts → 5. Mark complete
- *
- * @example
- * ```typescript
- * // Auto-create settlements from transaction splits
- * await revenue.settlement.createFromSplits(transactionId);
- *
- * // Schedule a manual payout
- * await revenue.settlement.schedule({
- *   recipientId: vendorId,
- *   amount: 8500,
- *   payoutMethod: 'bank_transfer',
- * });
- *
- * // Process pending payouts
- * const result = await revenue.settlement.processPending({ limit: 100 });
- *
- * // Mark as completed after bank confirms
- * await revenue.settlement.complete(settlementId, { transferReference: 'TRF123' });
- * ```
- */
-/**
- * Settlement Service
- * Uses DI container for all dependencies
- *
- * Architecture:
- * - PluginManager: Wraps operations with lifecycle hooks (before/after)
- * - EventBus: Fire-and-forget notifications for completed operations
- */
-declare class SettlementService {
-    private readonly models;
-    private readonly plugins;
-    private readonly logger;
-    private readonly events;
-    constructor(container: Container);
-    /**
-     * Create settlements from transaction splits
-     * Typically called after escrow is released
-     *
-     * @param transactionId - Transaction ID with splits
-     * @param options - Creation options
-     * @returns Array of created settlements
-     */
-    createFromSplits(transactionId: string, options?: CreateFromSplitsOptions): Promise<SettlementDocument[]>;
-    /**
-     * Schedule a payout
-     *
-     * @param params - Settlement parameters
-     * @returns Created settlement
-     */
-    schedule(params: ScheduleSettlementParams): Promise<SettlementDocument>;
-    /**
-     * Process pending settlements
-     * Batch process settlements that are due
-     *
-     * @param options - Processing options
-     * @returns Processing result
-     */
-    processPending(options?: ProcessOptions): Promise<ProcessResult>;
-    /**
-     * Mark settlement as completed
-     * Call this after bank confirms the transfer
-     *
-     * @param settlementId - Settlement ID
-     * @param details - Completion details
-     * @returns Updated settlement
-     */
-    complete(settlementId: string, details?: CompletionDetails): Promise<SettlementDocument>;
-    /**
-     * Mark settlement as failed
-     *
-     * @param settlementId - Settlement ID
-     * @param reason - Failure reason
-     * @returns Updated settlement
-     */
-    fail(settlementId: string, reason: string, options?: {
-        code?: string;
-        retry?: boolean;
-    }): Promise<SettlementDocument>;
-    /**
-     * List settlements with filters
-     *
-     * @param filters - Query filters
-     * @returns Settlements
-     */
-    list(filters?: SettlementFilters): Promise<SettlementDocument[]>;
-    /**
-     * Get payout summary for recipient
-     *
-     * @param recipientId - Recipient ID
-     * @param options - Summary options
-     * @returns Settlement summary
-     */
-    getSummary(recipientId: string, options?: SummaryOptions): Promise<SettlementSummary>;
-    /**
-     * Get settlement by ID
-     *
-     * @param settlementId - Settlement ID
-     * @returns Settlement
-     */
-    get(settlementId: string): Promise<SettlementDocument>;
-}
-
-export { Container as C, EscrowService as E, MonetizationService as M, PaymentService as P, SettlementService as S, TransactionService as T };