@classytic/revenue 1.0.2 → 1.1.2

package/dist/{index-BnJWVXuw.d.ts → index-DxIK0UmZ.d.ts}

@@ -1,4 +1,5 @@
-import { E as MonetizationCreateParams, F as MonetizationCreateResult, G as ActivateOptions, e as SubscriptionDocument, I as RenewalParams, J as CancelOptions, K as PauseOptions, N as ResumeOptions, Q as ListOptions, U as PaymentVerifyOptions, V as PaymentVerifyResult, X as PaymentStatusResult, Y as RefundOptions, Z as PaymentRefundResult, _ as WebhookResult, d as TransactionDocument, w as PaymentProviderInterface, $ as TransactionListResult, a0 as HoldOptions, a1 as ReleaseOptions, a2 as ReleaseResult, a3 as CancelHoldOptions, o as SplitRule, a4 as SplitResult, a5 as EscrowStatusResult } from './index-ChVD3P9k.js';
+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
@@ -69,14 +70,31 @@ declare class Container {
 /**
  * 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 hooks;
+    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)
      *
@@ -88,8 +106,8 @@ declare class MonetizationService {
      *   data: {
      *     organizationId: '...',
      *     customerId: '...',
-     *     referenceId: order._id,
-     *     referenceModel: 'Order',
+     *     sourceId: order._id,
+     *     sourceModel: 'Order',
      *   },
      *   planKey: 'one_time',
      *   monetizationType: 'purchase',
@@ -102,8 +120,8 @@ declare class MonetizationService {
      *   data: {
      *     organizationId: '...',
      *     customerId: '...',
-     *     referenceId: subscription._id,
-     *     referenceModel: 'Subscription',
+     *     sourceId: subscription._id,
+     *     sourceModel: 'Subscription',
      *   },
      *   planKey: 'monthly',
      *   monetizationType: 'subscription',
@@ -174,11 +192,6 @@ declare class MonetizationService {
      * @private
      */
     private _calculatePeriodEnd;
-    /**
-     * Trigger event hook (fire-and-forget, non-blocking)
-     * @private
-     */
-    private _triggerHook;
 }
 
 /**
@@ -192,14 +205,31 @@ declare class MonetizationService {
 /**
  * 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 hooks;
+    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
      *
@@ -255,11 +285,6 @@ declare class PaymentService {
      * @returns Provider instance
      */
     getProvider(providerName: string): PaymentProviderInterface;
-    /**
-     * Trigger event hook (fire-and-forget, non-blocking)
-     * @private
-     */
-    private _triggerHook;
     /**
      * Find transaction by sessionId, paymentIntentId, or transaction ID
      * @private
@@ -283,12 +308,22 @@ declare class PaymentService {
 /**
  * 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 hooks;
+    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
      *
@@ -312,11 +347,6 @@ declare class TransactionService {
      * @returns Updated transaction
      */
     update(transactionId: string, updates: Partial<TransactionDocument>): Promise<TransactionDocument>;
-    /**
-     * Trigger event hook (fire-and-forget, non-blocking)
-     * @private
-     */
-    private _triggerHook;
 }
 
 /**
@@ -327,11 +357,25 @@ declare class TransactionService {
  * 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 hooks;
+    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
      *
@@ -372,7 +416,218 @@ declare class EscrowService {
      * @returns Escrow status
      */
     getStatus(transactionId: string): Promise<EscrowStatusResult>;
-    private _triggerHook;
 }
 
-export { Container as C, EscrowService as E, MonetizationService as M, PaymentService as P, TransactionService as T };
+/**
+ * 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 };