@classytic/revenue 0.2.4 → 1.0.0

package/dist/index-BnJWVXuw.d.ts

@@ -0,0 +1,378 @@
+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';
+
+/**
+ * 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
+ */
+declare class MonetizationService {
+    private readonly models;
+    private readonly providers;
+    private readonly config;
+    private readonly hooks;
+    private readonly logger;
+    constructor(container: Container);
+    /**
+     * Create a new monetization (purchase, subscription, or free item)
+     *
+     * @param params - Monetization parameters
+     *
+     * @example
+     * // One-time purchase
+     * await revenue.monetization.create({
+     *   data: {
+     *     organizationId: '...',
+     *     customerId: '...',
+     *     referenceId: order._id,
+     *     referenceModel: 'Order',
+     *   },
+     *   planKey: 'one_time',
+     *   monetizationType: 'purchase',
+     *   gateway: 'bkash',
+     *   amount: 1500,
+     * });
+     *
+     * // Recurring subscription
+     * await revenue.monetization.create({
+     *   data: {
+     *     organizationId: '...',
+     *     customerId: '...',
+     *     referenceId: subscription._id,
+     *     referenceModel: '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;
+    /**
+     * Trigger event hook (fire-and-forget, non-blocking)
+     * @private
+     */
+    private _triggerHook;
+}
+
+/**
+ * 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
+ */
+declare class PaymentService {
+    private readonly models;
+    private readonly providers;
+    private readonly config;
+    private readonly hooks;
+    private readonly logger;
+    constructor(container: Container);
+    /**
+     * 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;
+    /**
+     * Trigger event hook (fire-and-forget, non-blocking)
+     * @private
+     */
+    private _triggerHook;
+    /**
+     * 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
+ */
+declare class TransactionService {
+    private readonly models;
+    private readonly hooks;
+    private readonly logger;
+    constructor(container: Container);
+    /**
+     * 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>;
+    /**
+     * Trigger event hook (fire-and-forget, non-blocking)
+     * @private
+     */
+    private _triggerHook;
+}
+
+/**
+ * Escrow Service
+ * @classytic/revenue
+ *
+ * Platform-as-intermediary payment flow
+ * Hold funds → Verify → Split/Deduct → Release to organization
+ */
+
+declare class EscrowService {
+    private readonly models;
+    private readonly hooks;
+    private readonly logger;
+    constructor(container: Container);
+    /**
+     * 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>;
+    private _triggerHook;
+}
+
+export { Container as C, EscrowService as E, MonetizationService as M, PaymentService as P, TransactionService as T };