@classytic/revenue 0.0.23 → 0.1.0

package/utils/index.d.ts

@@ -100,6 +100,37 @@ export function reverseCommission(
   refundAmount: number
 ): CommissionObject | null;
 
+// ============ SUBSCRIPTION UTILITIES ============
+
+export function addDuration(startDate: Date, duration: number, unit?: string): Date;
+
+export function calculatePeriodRange(params: {
+  currentEndDate?: Date | null;
+  startDate?: Date | null;
+  duration: number;
+  unit?: string;
+  now?: Date;
+}): { startDate: Date; endDate: Date };
+
+export function calculateProratedAmount(params: {
+  amountPaid: number;
+  startDate: Date;
+  endDate: Date;
+  asOfDate?: Date;
+  precision?: number;
+}): number;
+
+export function resolveIntervalToDuration(
+  interval?: string,
+  intervalCount?: number
+): { duration: number; unit: string };
+
+export function isSubscriptionActive(subscription: any): boolean;
+export function canRenewSubscription(entity: any): boolean;
+export function canCancelSubscription(entity: any): boolean;
+export function canPauseSubscription(entity: any): boolean;
+export function canResumeSubscription(entity: any): boolean;
+
 // ============ DEFAULT EXPORT ============
 
 declare const _default: {
@@ -119,6 +150,15 @@ declare const _default: {
   triggerHook: typeof triggerHook;
   calculateCommission: typeof calculateCommission;
   reverseCommission: typeof reverseCommission;
+  addDuration: typeof addDuration;
+  calculatePeriodRange: typeof calculatePeriodRange;
+  calculateProratedAmount: typeof calculateProratedAmount;
+  resolveIntervalToDuration: typeof resolveIntervalToDuration;
+  isSubscriptionActive: typeof isSubscriptionActive;
+  canRenewSubscription: typeof canRenewSubscription;
+  canCancelSubscription: typeof canCancelSubscription;
+  canPauseSubscription: typeof canPauseSubscription;
+  canResumeSubscription: typeof canResumeSubscription;
 };
 
 export default _default;

package/utils/index.js

@@ -7,3 +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/utils/subscription/actions.js

@@ -0,0 +1,68 @@
+/**
+ * Subscription Action Utilities
+ * @classytic/revenue/utils/subscription
+ *
+ * Eligibility checks for subscription actions
+ */
+
+import { SUBSCRIPTION_STATUS } from '../../enums/subscription.enums.js';
+
+/**
+ * Check if subscription is active
+ */
+export function isSubscriptionActive(subscription) {
+  if (!subscription) return false;
+  if (!subscription.isActive) return false;
+
+  if (subscription.endDate) {
+    const now = new Date();
+    const endDate = new Date(subscription.endDate);
+    if (endDate < now) return false;
+  }
+
+  return true;
+}
+
+/**
+ * Check if can renew
+ */
+export function canRenewSubscription(entity) {
+  if (!entity || !entity.subscription) return false;
+  return isSubscriptionActive(entity.subscription);
+}
+
+/**
+ * Check if can cancel
+ */
+export function canCancelSubscription(entity) {
+  if (!entity || !entity.subscription) return false;
+  if (!isSubscriptionActive(entity.subscription)) return false;
+  return !entity.subscription.canceledAt;
+}
+
+/**
+ * Check if can pause
+ */
+export function canPauseSubscription(entity) {
+  if (!entity || !entity.subscription) return false;
+  if (entity.status === SUBSCRIPTION_STATUS.PAUSED) return false;
+  if (entity.status === SUBSCRIPTION_STATUS.CANCELLED) return false;
+  return isSubscriptionActive(entity.subscription);
+}
+
+/**
+ * Check if can resume
+ */
+export function canResumeSubscription(entity) {
+  if (!entity || !entity.subscription) return false;
+  return entity.status === SUBSCRIPTION_STATUS.PAUSED;
+}
+
+export default {
+  isSubscriptionActive,
+  canRenewSubscription,
+  canCancelSubscription,
+  canPauseSubscription,
+  canResumeSubscription,
+};
+

package/utils/subscription/index.js

@@ -0,0 +1,20 @@
+/**
+ * Subscription Utilities Index
+ * @classytic/revenue/utils/subscription
+ */
+
+export {
+  addDuration,
+  calculatePeriodRange,
+  calculateProratedAmount,
+  resolveIntervalToDuration,
+} from './period.js';
+
+export {
+  isSubscriptionActive,
+  canRenewSubscription,
+  canCancelSubscription,
+  canPauseSubscription,
+  canResumeSubscription,
+} from './actions.js';
+

package/utils/subscription/period.js

@@ -0,0 +1,123 @@
+/**
+ * Subscription Period Utilities
+ * @classytic/revenue/utils/subscription
+ *
+ * Universal period calculation, proration, and date utilities
+ */
+
+/**
+ * Add duration to date
+ */
+export function addDuration(startDate, duration, unit = 'days') {
+  const date = new Date(startDate);
+  
+  switch (unit) {
+    case 'months':
+    case 'month':
+      date.setMonth(date.getMonth() + duration);
+      return date;
+    case 'years':
+    case 'year':
+      date.setFullYear(date.getFullYear() + duration);
+      return date;
+    case 'weeks':
+    case 'week':
+      date.setDate(date.getDate() + (duration * 7));
+      return date;
+    case 'days':
+    case 'day':
+    default:
+      date.setDate(date.getDate() + duration);
+      return date;
+  }
+}
+
+/**
+ * Calculate subscription period start/end dates
+ */
+export function calculatePeriodRange({
+  currentEndDate = null,
+  startDate = null,
+  duration,
+  unit = 'days',
+  now = new Date(),
+}) {
+  let periodStart;
+
+  if (startDate) {
+    periodStart = new Date(startDate);
+  } else if (currentEndDate) {
+    const end = new Date(currentEndDate);
+    periodStart = end > now ? end : now;
+  } else {
+    periodStart = now;
+  }
+
+  const periodEnd = addDuration(periodStart, duration, unit);
+
+  return { startDate: periodStart, endDate: periodEnd };
+}
+
+/**
+ * Calculate prorated refund amount for unused period
+ */
+export function calculateProratedAmount({
+  amountPaid,
+  startDate,
+  endDate,
+  asOfDate = new Date(),
+  precision = 2,
+}) {
+  if (!amountPaid || amountPaid <= 0) return 0;
+
+  const start = new Date(startDate);
+  const end = new Date(endDate);
+  const asOf = new Date(asOfDate);
+
+  const totalMs = end - start;
+  if (totalMs <= 0) return 0;
+
+  const remainingMs = Math.max(0, end - asOf);
+  if (remainingMs <= 0) return 0;
+
+  const ratio = remainingMs / totalMs;
+  const amount = amountPaid * ratio;
+  
+  const factor = 10 ** precision;
+  return Math.round(amount * factor) / factor;
+}
+
+/**
+ * Convert interval + count to duration/unit
+ */
+export function resolveIntervalToDuration(interval = 'month', intervalCount = 1) {
+  const normalized = (interval || 'month').toLowerCase();
+  const count = Number(intervalCount) > 0 ? Number(intervalCount) : 1;
+
+  switch (normalized) {
+    case 'year':
+    case 'years':
+      return { duration: count, unit: 'years' };
+    case 'week':
+    case 'weeks':
+      return { duration: count, unit: 'weeks' };
+    case 'quarter':
+    case 'quarters':
+      return { duration: count * 3, unit: 'months' };
+    case 'day':
+    case 'days':
+      return { duration: count, unit: 'days' };
+    case 'month':
+    case 'months':
+    default:
+      return { duration: count, unit: 'months' };
+  }
+}
+
+export default {
+  addDuration,
+  calculatePeriodRange,
+  calculateProratedAmount,
+  resolveIntervalToDuration,
+};
+

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;