@classytic/revenue 0.0.24 → 0.2.0

package/utils/commission-split.js

@@ -0,0 +1,180 @@
+/**
+ * Commission Split Utilities
+ * @classytic/revenue
+ *
+ * Multi-party commission split calculation for affiliate/referral systems
+ */
+
+import { SPLIT_TYPE, SPLIT_STATUS } from '../enums/split.enums.js';
+
+/**
+ * Calculate multi-party commission splits
+ *
+ * @param {Number} amount - Transaction amount
+ * @param {Array} splitRules - Split configuration
+ * @param {Number} gatewayFeeRate - Gateway fee rate (optional)
+ * @returns {Array} Split objects
+ *
+ * @example
+ * calculateSplits(1000, [
+ *   { type: 'platform_commission', recipientId: 'platform', recipientType: 'platform', rate: 0.10 },
+ *   { type: 'affiliate_commission', recipientId: 'affiliate-123', recipientType: 'user', rate: 0.02 },
+ * ], 0.018);
+ *
+ * Returns:
+ * [
+ *   { type: 'platform_commission', recipientId: 'platform', grossAmount: 100, gatewayFeeAmount: 18, netAmount: 82, ... },
+ *   { type: 'affiliate_commission', recipientId: 'affiliate-123', grossAmount: 20, gatewayFeeAmount: 0, netAmount: 20, ... },
+ * ]
+ */
+export function calculateSplits(amount, splitRules = [], gatewayFeeRate = 0) {
+  if (!splitRules || splitRules.length === 0) {
+    return [];
+  }
+
+  if (amount < 0) {
+    throw new Error('Transaction amount cannot be negative');
+  }
+
+  if (gatewayFeeRate < 0 || gatewayFeeRate > 1) {
+    throw new Error('Gateway fee rate must be between 0 and 1');
+  }
+
+  const totalRate = splitRules.reduce((sum, rule) => sum + rule.rate, 0);
+  if (totalRate > 1) {
+    throw new Error(`Total split rate (${totalRate}) cannot exceed 1.0`);
+  }
+
+  return splitRules.map((rule, index) => {
+    if (rule.rate < 0 || rule.rate > 1) {
+      throw new Error(`Split rate must be between 0 and 1 for split ${index}`);
+    }
+
+    const grossAmount = Math.round(amount * rule.rate * 100) / 100;
+
+    const gatewayFeeAmount = index === 0 && gatewayFeeRate > 0
+      ? Math.round(amount * gatewayFeeRate * 100) / 100
+      : 0;
+
+    const netAmount = Math.max(0, Math.round((grossAmount - gatewayFeeAmount) * 100) / 100);
+
+    return {
+      type: rule.type || SPLIT_TYPE.CUSTOM,
+      recipientId: rule.recipientId,
+      recipientType: rule.recipientType,
+      rate: rule.rate,
+      grossAmount,
+      gatewayFeeRate: gatewayFeeAmount > 0 ? gatewayFeeRate : 0,
+      gatewayFeeAmount,
+      netAmount,
+      status: SPLIT_STATUS.PENDING,
+      dueDate: rule.dueDate || null,
+      metadata: rule.metadata || {},
+    };
+  });
+}
+
+/**
+ * Calculate organization payout after splits
+ *
+ * @param {Number} amount - Total transaction amount
+ * @param {Array} splits - Calculated splits
+ * @returns {Number} Amount organization receives
+ */
+export function calculateOrganizationPayout(amount, splits = []) {
+  const totalSplitAmount = splits.reduce((sum, split) => sum + split.grossAmount, 0);
+  return Math.max(0, Math.round((amount - totalSplitAmount) * 100) / 100);
+}
+
+/**
+ * Reverse splits proportionally on refund
+ *
+ * @param {Array} originalSplits - Original split objects
+ * @param {Number} originalAmount - Original transaction amount
+ * @param {Number} refundAmount - Amount being refunded
+ * @returns {Array} Reversed splits
+ */
+export function reverseSplits(originalSplits, originalAmount, refundAmount) {
+  if (!originalSplits || originalSplits.length === 0) {
+    return [];
+  }
+
+  const refundRatio = refundAmount / originalAmount;
+
+  return originalSplits.map(split => ({
+    ...split,
+    grossAmount: Math.round(split.grossAmount * refundRatio * 100) / 100,
+    gatewayFeeAmount: Math.round(split.gatewayFeeAmount * refundRatio * 100) / 100,
+    netAmount: Math.round(split.netAmount * refundRatio * 100) / 100,
+    status: SPLIT_STATUS.WAIVED,
+  }));
+}
+
+/**
+ * Build commission object with splits support
+ * Backward compatible with existing calculateCommission
+ *
+ * @param {Number} amount - Transaction amount
+ * @param {Number} commissionRate - Platform commission rate
+ * @param {Number} gatewayFeeRate - Gateway fee rate
+ * @param {Object} options - Additional options
+ * @returns {Object} Commission with optional splits
+ */
+export function calculateCommissionWithSplits(amount, commissionRate, gatewayFeeRate = 0, options = {}) {
+  const { affiliateRate = 0, affiliateId = null, affiliateType = 'user' } = options;
+
+  if (commissionRate <= 0 && affiliateRate <= 0) {
+    return null;
+  }
+
+  const splitRules = [];
+
+  if (commissionRate > 0) {
+    splitRules.push({
+      type: SPLIT_TYPE.PLATFORM_COMMISSION,
+      recipientId: 'platform',
+      recipientType: 'platform',
+      rate: commissionRate,
+    });
+  }
+
+  if (affiliateRate > 0 && affiliateId) {
+    splitRules.push({
+      type: SPLIT_TYPE.AFFILIATE_COMMISSION,
+      recipientId: affiliateId,
+      recipientType: affiliateType,
+      rate: affiliateRate,
+    });
+  }
+
+  const splits = calculateSplits(amount, splitRules, gatewayFeeRate);
+
+  const platformSplit = splits.find(s => s.type === SPLIT_TYPE.PLATFORM_COMMISSION);
+  const affiliateSplit = splits.find(s => s.type === SPLIT_TYPE.AFFILIATE_COMMISSION);
+
+  return {
+    rate: commissionRate,
+    grossAmount: platformSplit?.grossAmount || 0,
+    gatewayFeeRate: platformSplit?.gatewayFeeRate || 0,
+    gatewayFeeAmount: platformSplit?.gatewayFeeAmount || 0,
+    netAmount: platformSplit?.netAmount || 0,
+    status: SPLIT_STATUS.PENDING,
+    ...(splits.length > 0 && { splits }),
+    ...(affiliateSplit && {
+      affiliate: {
+        recipientId: affiliateSplit.recipientId,
+        recipientType: affiliateSplit.recipientType,
+        rate: affiliateSplit.rate,
+        grossAmount: affiliateSplit.grossAmount,
+        netAmount: affiliateSplit.netAmount,
+      },
+    }),
+  };
+}
+
+export default {
+  calculateSplits,
+  calculateOrganizationPayout,
+  reverseSplits,
+  calculateCommissionWithSplits,
+};

package/utils/index.js

@@ -7,4 +7,10 @@ export * from './transaction-type.js';
 export { default as logger, setLogger } from './logger.js';
 export { triggerHook } from './hooks.js';
 export { calculateCommission, reverseCommission } from './commission.js';
+export {
+  calculateSplits,
+  calculateOrganizationPayout,
+  reverseSplits,
+  calculateCommissionWithSplits,
+} from './commission-split.js';
 export * from './subscription/index.js';

package/revenue.d.ts

@@ -1,350 +0,0 @@
-/**
- * TypeScript definitions for @classytic/revenue
- * Enterprise Revenue Management System
- *
- * Thin, focused, production-ready library with smart defaults.
- *
- * @version 1.0.0
- */
-
-import { Schema, Model, Document } from 'mongoose';
-
-// ============ CORE API ============
-
-// Container
-export class Container {
-  register(name: string, implementation: any, options?: { singleton?: boolean; factory?: boolean }): this;
-  singleton(name: string, implementation: any): this;
-  transient(name: string, factory: Function): this;
-  get(name: string): any;
-  has(name: string): boolean;
-  keys(): string[];
-  clear(): void;
-  createScope(): Container;
-}
-
-// Provider System
-export interface PaymentIntentParams {
-  amount: number;
-  currency?: string;
-  metadata?: Record<string, any>;
-}
-
-export class PaymentIntent {
-  id: string;
-  provider: string;
-  status: string;
-  amount: number;
-  currency: string;
-  metadata: Record<string, any>;
-  clientSecret?: string;
-  paymentUrl?: string;
-  instructions?: string;
-  raw?: any;
-}
-
-export class PaymentResult {
-  id: string;
-  provider: string;
-  status: string;
-  amount: number;
-  currency: string;
-  paidAt?: Date;
-  metadata: Record<string, any>;
-  raw?: any;
-}
-
-export class RefundResult {
-  id: string;
-  provider: string;
-  status: string;
-  amount: number;
-  currency: string;
-  refundedAt?: Date;
-  reason?: string;
-  metadata: Record<string, any>;
-  raw?: any;
-}
-
-export class WebhookEvent {
-  id: string;
-  provider: string;
-  type: string;
-  data: any;
-  createdAt: Date;
-  raw?: any;
-}
-
-export abstract class PaymentProvider {
-  name: string;
-  config: any;
-
-  createIntent(params: PaymentIntentParams): Promise<PaymentIntent>;
-  verifyPayment(intentId: string): Promise<PaymentResult>;
-  getStatus(intentId: string): Promise<PaymentResult>;
-  refund(paymentId: string, amount?: number, options?: any): Promise<RefundResult>;
-  handleWebhook(payload: any, headers?: any): Promise<WebhookEvent>;
-  verifyWebhookSignature(payload: any, signature: string): boolean;
-  getCapabilities(): {
-    supportsWebhooks: boolean;
-    supportsRefunds: boolean;
-    supportsPartialRefunds: boolean;
-    requiresManualVerification: boolean;
-  };
-}
-
-// Note: ManualProvider moved to @classytic/revenue-manual (separate package)
-
-// Services
-export class SubscriptionService {
-  constructor(container: Container);
-
-  create(params: {
-    data: any;
-    planKey: string;
-    amount: number;
-    currency?: string;
-    gateway?: string;
-    entity?: string;
-    monetizationType?: 'free' | 'subscription' | 'purchase';
-    paymentData?: any;
-    metadata?: Record<string, any>;
-    idempotencyKey?: string;
-  }): Promise<{ subscription: any; transaction: any; paymentIntent: PaymentIntent | null }>;
-
-  activate(subscriptionId: string, options?: { timestamp?: Date }): Promise<any>;
-  renew(subscriptionId: string, params?: {
-    gateway?: string;
-    entity?: string;
-    paymentData?: any;
-    metadata?: Record<string, any>;
-    idempotencyKey?: string;
-  }): Promise<{ subscription: any; transaction: any; paymentIntent: PaymentIntent }>;
-  cancel(subscriptionId: string, options?: { immediate?: boolean; reason?: string }): Promise<any>;
-  pause(subscriptionId: string, options?: { reason?: string }): Promise<any>;
-  resume(subscriptionId: string, options?: { extendPeriod?: boolean }): Promise<any>;
-  list(filters?: any, options?: any): Promise<any[]>;
-  get(subscriptionId: string): Promise<any>;
-}
-
-export class PaymentService {
-  constructor(container: Container);
-
-  verify(paymentIntentId: string, options?: { verifiedBy?: string }): Promise<{ transaction: any; paymentResult: PaymentResult; status: string }>;
-  getStatus(paymentIntentId: string): Promise<{ transaction: any; paymentResult: PaymentResult; status: string; provider: string }>;
-  refund(paymentId: string, amount?: number, options?: { reason?: string }): Promise<{ transaction: any; refundTransaction: any; refundResult: RefundResult; status: string }>;
-  handleWebhook(providerName: string, payload: any, headers?: any): Promise<{ event: WebhookEvent; transaction: any; status: string }>;
-  list(filters?: any, options?: any): Promise<any[]>;
-  get(transactionId: string): Promise<any>;
-  getProvider(providerName: string): PaymentProvider;
-}
-
-export class TransactionService {
-  constructor(container: Container);
-
-  get(transactionId: string): Promise<any>;
-  list(filters?: any, options?: any): Promise<{ transactions: any[]; total: number; page: number; limit: number; pages: number }>;
-  update(transactionId: string, updates: any): Promise<any>;
-}
-
-// Error Classes
-export class RevenueError extends Error {
-  code: string;
-  retryable: boolean;
-  metadata: Record<string, any>;
-  toJSON(): { name: string; message: string; code: string; retryable: boolean; metadata: Record<string, any> };
-}
-
-export class ConfigurationError extends RevenueError {}
-export class ModelNotRegisteredError extends ConfigurationError {}
-export class ProviderError extends RevenueError {}
-export class ProviderNotFoundError extends ProviderError {}
-export class ProviderCapabilityError extends ProviderError {}
-export class PaymentIntentCreationError extends ProviderError {}
-export class PaymentVerificationError extends ProviderError {}
-export class NotFoundError extends RevenueError {}
-export class SubscriptionNotFoundError extends NotFoundError {}
-export class TransactionNotFoundError extends NotFoundError {}
-export class ValidationError extends RevenueError {}
-export class InvalidAmountError extends ValidationError {}
-export class MissingRequiredFieldError extends ValidationError {}
-export class StateError extends RevenueError {}
-export class AlreadyVerifiedError extends StateError {}
-export class InvalidStateTransitionError extends StateError {}
-export class SubscriptionNotActiveError extends StateError {}
-export class OperationError extends RevenueError {}
-export class RefundNotSupportedError extends OperationError {}
-export class RefundError extends OperationError {}
-
-export function isRetryable(error: Error): boolean;
-export function isRevenueError(error: Error): boolean;
-
-// Revenue Instance (Immutable)
-export interface Revenue {
-  readonly container: Container;
-  readonly providers: Readonly<Record<string, PaymentProvider>>;
-  readonly config: Readonly<any>;
-
-  readonly subscriptions: SubscriptionService;
-  readonly payments: PaymentService;
-  readonly transactions: TransactionService;
-
-  getProvider(name: string): PaymentProvider;
-}
-
-export interface RevenueOptions {
-  models: {
-    Transaction: Model<any>;
-    Subscription?: Model<any>;
-    [key: string]: Model<any> | undefined;
-  };
-  providers?: Record<string, PaymentProvider>;
-  hooks?: Record<string, Function[]>;
-  config?: {
-    /**
-     * Maps logical entity identifiers to custom transaction category names
-     *
-     * Entity identifiers are NOT database model names - they are logical identifiers
-     * you choose to organize your business logic.
-     *
-     * @example
-     * categoryMappings: {
-     *   Order: 'order_subscription',              // Customer orders
-     *   PlatformSubscription: 'platform_subscription',  // Tenant/org subscriptions
-     *   TenantUpgrade: 'tenant_upgrade',          // Tenant upgrades
-     *   Membership: 'gym_membership',              // User memberships
-     *   Enrollment: 'course_enrollment',           // Course enrollments
-     * }
-     *
-     * If not specified, falls back to library defaults: 'subscription' or 'purchase'
-     */
-    categoryMappings?: Record<string, string>;
-    
-    /**
-     * Maps transaction types to income/expense for your accounting system
-     * 
-     * Allows you to control how different transaction types are recorded:
-     * - 'income': Money coming in (payments, subscriptions)
-     * - 'expense': Money going out (refunds)
-     * 
-     * @example
-     * transactionTypeMapping: {
-     *   subscription: 'income',
-     *   subscription_renewal: 'income',
-     *   purchase: 'income',
-     *   refund: 'expense',
-     * }
-     * 
-     * If not specified, library defaults to 'income' for all payment transactions
-     */
-    transactionTypeMapping?: Record<string, 'income' | 'expense'>;
-    
-    /**
-     * Commission rates by category (0 to 1)
-     * 
-     * Automatically calculates platform commission for each transaction.
-     * Gateway fees are automatically deducted from gross commission.
-     * 
-     * @example
-     * commissionRates: {
-     *   'course_enrollment': 0.10,     // 10% commission
-     *   'product_order': 0.05,          // 5% commission
-     *   'gym_membership': 0,            // No commission
-     * }
-     */
-    commissionRates?: Record<string, number>;
-    
-    /**
-     * Gateway fee rates by provider (0 to 1)
-     * 
-     * Gateway fees are deducted from gross commission.
-     * 
-     * @example
-     * gatewayFeeRates: {
-     *   'bkash': 0.018,      // 1.8% fee
-     *   'stripe': 0.029,     // 2.9% fee
-     *   'manual': 0,         // No fee
-     * }
-     */
-    gatewayFeeRates?: Record<string, number>;
-    
-    [key: string]: any;
-  };
-  logger?: Console | any;
-}
-
-export function createRevenue(options: RevenueOptions): Revenue;
-
-// ============ ENUMS ============
-
-export const TRANSACTION_TYPE: {
-  INCOME: 'income';
-  EXPENSE: 'expense';
-};
-
-export const TRANSACTION_STATUS: {
-  PENDING: 'pending';
-  PAYMENT_INITIATED: 'payment_initiated';
-  PROCESSING: 'processing';
-  REQUIRES_ACTION: 'requires_action';
-  VERIFIED: 'verified';
-  COMPLETED: 'completed';
-  FAILED: 'failed';
-  CANCELLED: 'cancelled';
-  EXPIRED: 'expired';
-  REFUNDED: 'refunded';
-  PARTIALLY_REFUNDED: 'partially_refunded';
-};
-
-export const PAYMENT_GATEWAY_TYPE: {
-  MANUAL: 'manual';
-  STRIPE: 'stripe';
-  SSLCOMMERZ: 'sslcommerz';
-};
-
-export const SUBSCRIPTION_STATUS: {
-  ACTIVE: 'active';
-  PAUSED: 'paused';
-  CANCELLED: 'cancelled';
-  EXPIRED: 'expired';
-  PENDING: 'pending';
-  INACTIVE: 'inactive';
-};
-
-export const PLAN_KEYS: {
-  MONTHLY: 'monthly';
-  QUARTERLY: 'quarterly';
-  YEARLY: 'yearly';
-};
-
-export const MONETIZATION_TYPES: {
-  FREE: 'free';
-  PURCHASE: 'purchase';
-  SUBSCRIPTION: 'subscription';
-};
-
-// ============ SCHEMAS ============
-
-export const currentPaymentSchema: Schema;
-export const paymentSummarySchema: Schema;
-export const subscriptionInfoSchema: Schema;
-export const subscriptionPlanSchema: Schema;
-export const gatewaySchema: Schema;
-export const commissionSchema: Schema;
-export const paymentDetailsSchema: Schema;
-
-// ============ UTILITIES ============
-
-export const logger: Console | any;
-export function setLogger(logger: Console | any): void;
-
-// ============ DEFAULT EXPORT ============
-
-declare const _default: {
-  createRevenue: typeof createRevenue;
-  PaymentProvider: typeof PaymentProvider;
-  RevenueError: typeof RevenueError;
-  Container: typeof Container;
-};
-
-export default _default;