@classytic/revenue 0.2.3 → 1.0.0

package/dist/types/utils/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./transaction-type.js";
-export * from "./subscription/index.js";
-export { triggerHook } from "./hooks.js";
-export { default as logger, setLogger } from "./logger.js";
-export { calculateCommission, reverseCommission } from "./commission.js";
-export { calculateSplits, calculateOrganizationPayout, reverseSplits, calculateCommissionWithSplits } from "./commission-split.js";

package/dist/types/utils/logger.d.ts

@@ -1,12 +0,0 @@
-/**
- * Set custom logger implementation
- * @param {Object} customLogger - Logger instance with info, warn, error, debug methods
- */
-export function setLogger(customLogger: any): void;
-export namespace logger {
-    function info(...args: any[]): void;
-    function warn(...args: any[]): void;
-    function error(...args: any[]): void;
-    function debug(...args: any[]): void;
-}
-export default logger;

package/dist/types/utils/subscription/actions.d.ts

@@ -1,28 +0,0 @@
-/**
- * Check if subscription is active
- */
-export function isSubscriptionActive(subscription: any): boolean;
-/**
- * Check if can renew
- */
-export function canRenewSubscription(entity: any): boolean;
-/**
- * Check if can cancel
- */
-export function canCancelSubscription(entity: any): boolean;
-/**
- * Check if can pause
- */
-export function canPauseSubscription(entity: any): boolean;
-/**
- * Check if can resume
- */
-export function canResumeSubscription(entity: any): boolean;
-declare namespace _default {
-    export { isSubscriptionActive };
-    export { canRenewSubscription };
-    export { canCancelSubscription };
-    export { canPauseSubscription };
-    export { canResumeSubscription };
-}
-export default _default;

package/dist/types/utils/subscription/index.d.ts

@@ -1,2 +0,0 @@
-export { addDuration, calculatePeriodRange, calculateProratedAmount, resolveIntervalToDuration } from "./period.js";
-export { isSubscriptionActive, canRenewSubscription, canCancelSubscription, canPauseSubscription, canResumeSubscription } from "./actions.js";

package/dist/types/utils/subscription/period.d.ts

@@ -1,47 +0,0 @@
-/**
- * Subscription Period Utilities
- * @classytic/revenue/utils/subscription
- *
- * Universal period calculation, proration, and date utilities
- */
-/**
- * Add duration to date
- */
-export function addDuration(startDate: any, duration: any, unit?: string): Date;
-/**
- * Calculate subscription period start/end dates
- */
-export function calculatePeriodRange({ currentEndDate, startDate, duration, unit, now, }: {
-    currentEndDate?: any;
-    startDate?: any;
-    duration: any;
-    unit?: string;
-    now?: Date;
-}): {
-    startDate: Date;
-    endDate: Date;
-};
-/**
- * Calculate prorated refund amount for unused period
- */
-export function calculateProratedAmount({ amountPaid, startDate, endDate, asOfDate, precision, }: {
-    amountPaid: any;
-    startDate: any;
-    endDate: any;
-    asOfDate?: Date;
-    precision?: number;
-}): number;
-/**
- * Convert interval + count to duration/unit
- */
-export function resolveIntervalToDuration(interval?: string, intervalCount?: number): {
-    duration: number;
-    unit: string;
-};
-declare namespace _default {
-    export { addDuration };
-    export { calculatePeriodRange };
-    export { calculateProratedAmount };
-    export { resolveIntervalToDuration };
-}
-export default _default;

package/dist/types/utils/transaction-type.d.ts

@@ -1,102 +0,0 @@
-/**
- * Check if transaction is monetization-managed
- *
- * Monetization-managed means:
- * - Created through subscription/purchase flows via the library
- * - Status controlled by payment webhooks/verification
- * - Amount/commission calculated by library
- * - Protected fields: status, amount, commission, gateway, verifiedAt, verifiedBy
- *
- * @param {Object} transaction - Transaction document or data
- * @param {Object} options - Options
- * @param {Array<string>} options.targetModels - Target models from config (default: ['Subscription', 'Membership'])
- * @param {Array<string>} options.additionalCategories - Additional categories from user config
- * @returns {boolean}
- */
-export function isMonetizationTransaction(transaction: any, options?: {
-    targetModels: Array<string>;
-    additionalCategories: Array<string>;
-}): boolean;
-/**
- * Check if transaction is manual admin transaction
- *
- * Manual transactions:
- * - Created directly by admins for operational expenses/income
- * - Can be self-verified by admins
- * - More flexible updates allowed
- * - No commission/gateway complexity
- *
- * @param {Object} transaction - Transaction document or data
- * @param {Object} options - Options (same as isMonetizationTransaction)
- * @returns {boolean}
- */
-export function isManualTransaction(transaction: any, options?: any): boolean;
-/**
- * Get transaction type
- *
- * @param {Object} transaction - Transaction document or data
- * @param {Object} options - Options (same as isMonetizationTransaction)
- * @returns {string} TRANSACTION_TYPE.MONETIZATION or TRANSACTION_TYPE.MANUAL
- */
-export function getTransactionType(transaction: any, options?: any): string;
-/**
- * Get allowed update fields based on transaction type and status
- *
- * @param {Object} transaction - Transaction document
- * @param {Object} options - Options for transaction type detection
- * @returns {Array<string>} Allowed field names
- */
-export function getAllowedUpdateFields(transaction: any, options?: any): Array<string>;
-/**
- * Validate if field update is allowed
- *
- * @param {Object} transaction - Transaction document
- * @param {string} fieldName - Field being updated
- * @param {Object} options - Options for transaction type detection
- * @returns {Object} { allowed: boolean, reason?: string }
- */
-export function validateFieldUpdate(transaction: any, fieldName: string, options?: any): any;
-/**
- * Check if transaction can be self-verified by admin
- *
- * @param {Object} transaction - Transaction document
- * @param {Object} options - Options for transaction type detection
- * @returns {boolean}
- */
-export function canSelfVerify(transaction: any, options?: any): boolean;
-export namespace TRANSACTION_TYPE {
-    let MONETIZATION: string;
-    let MANUAL: string;
-}
-/**
- * Protected fields for monetization transactions
- * These fields cannot be updated directly by admins
- */
-export const PROTECTED_MONETIZATION_FIELDS: string[];
-/**
- * Editable fields for monetization transactions (before verification)
- * These fields can be updated by frontend/customer before payment is verified
- */
-export const EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION: string[];
-/**
- * Allowed fields for manual transaction creation
- */
-export const MANUAL_TRANSACTION_CREATE_FIELDS: string[];
-/**
- * Allowed fields for manual transaction updates
- */
-export const MANUAL_TRANSACTION_UPDATE_FIELDS: string[];
-declare namespace _default {
-    export { TRANSACTION_TYPE };
-    export { isMonetizationTransaction };
-    export { isManualTransaction };
-    export { getTransactionType };
-    export { PROTECTED_MONETIZATION_FIELDS };
-    export { EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION };
-    export { MANUAL_TRANSACTION_CREATE_FIELDS };
-    export { MANUAL_TRANSACTION_UPDATE_FIELDS };
-    export { getAllowedUpdateFields };
-    export { validateFieldUpdate };
-    export { canSelfVerify };
-}
-export default _default;

package/enums/escrow.enums.js

@@ -1,36 +0,0 @@
-/**
- * Escrow/Hold Enums
- * @classytic/revenue
- *
- * Enums for platform-as-intermediary payment flow
- */
-
-export const HOLD_STATUS = {
-  PENDING: 'pending',
-  HELD: 'held',
-  RELEASED: 'released',
-  CANCELLED: 'cancelled',
-  EXPIRED: 'expired',
-  PARTIALLY_RELEASED: 'partially_released',
-};
-
-export const HOLD_STATUS_VALUES = Object.values(HOLD_STATUS);
-
-export const RELEASE_REASON = {
-  PAYMENT_VERIFIED: 'payment_verified',
-  MANUAL_RELEASE: 'manual_release',
-  AUTO_RELEASE: 'auto_release',
-  DISPUTE_RESOLVED: 'dispute_resolved',
-};
-
-export const RELEASE_REASON_VALUES = Object.values(RELEASE_REASON);
-
-export const HOLD_REASON = {
-  PAYMENT_VERIFICATION: 'payment_verification',
-  FRAUD_CHECK: 'fraud_check',
-  MANUAL_REVIEW: 'manual_review',
-  DISPUTE: 'dispute',
-  COMPLIANCE: 'compliance',
-};
-
-export const HOLD_REASON_VALUES = Object.values(HOLD_REASON);

package/enums/index.d.ts

@@ -1,116 +0,0 @@
-/**
- * TypeScript definitions for @classytic/revenue/enums
- * Centralized Enums
- */
-
-// ============ TRANSACTION ENUMS ============
-
-export const TRANSACTION_TYPE: {
-  readonly INCOME: 'income';
-  readonly EXPENSE: 'expense';
-};
-
-export const TRANSACTION_TYPE_VALUES: string[];
-
-export const TRANSACTION_STATUS: {
-  readonly PENDING: 'pending';
-  readonly PAYMENT_INITIATED: 'payment_initiated';
-  readonly PROCESSING: 'processing';
-  readonly REQUIRES_ACTION: 'requires_action';
-  readonly VERIFIED: 'verified';
-  readonly COMPLETED: 'completed';
-  readonly FAILED: 'failed';
-  readonly CANCELLED: 'cancelled';
-  readonly EXPIRED: 'expired';
-  readonly REFUNDED: 'refunded';
-  readonly PARTIALLY_REFUNDED: 'partially_refunded';
-};
-
-export const TRANSACTION_STATUS_VALUES: string[];
-
-export const LIBRARY_CATEGORIES: {
-  readonly SUBSCRIPTION: 'subscription';
-  readonly PURCHASE: 'purchase';
-};
-
-export const LIBRARY_CATEGORY_VALUES: string[];
-
-// ============ PAYMENT ENUMS ============
-
-export const PAYMENT_STATUS: {
-  readonly PENDING: 'pending';
-  readonly VERIFIED: 'verified';
-  readonly FAILED: 'failed';
-  readonly REFUNDED: 'refunded';
-  readonly CANCELLED: 'cancelled';
-};
-
-export const PAYMENT_STATUS_VALUES: string[];
-
-export const PAYMENT_GATEWAY_TYPE: {
-  readonly MANUAL: 'manual';
-  readonly STRIPE: 'stripe';
-  readonly SSLCOMMERZ: 'sslcommerz';
-};
-
-export const PAYMENT_GATEWAY_TYPE_VALUES: string[];
-
-// Backward compatibility aliases
-export const GATEWAY_TYPES: typeof PAYMENT_GATEWAY_TYPE;
-export const GATEWAY_TYPE_VALUES: typeof PAYMENT_GATEWAY_TYPE_VALUES;
-
-// ============ SUBSCRIPTION ENUMS ============
-
-export const SUBSCRIPTION_STATUS: {
-  readonly ACTIVE: 'active';
-  readonly PAUSED: 'paused';
-  readonly CANCELLED: 'cancelled';
-  readonly EXPIRED: 'expired';
-  readonly PENDING: 'pending';
-  readonly INACTIVE: 'inactive';
-};
-
-export const SUBSCRIPTION_STATUS_VALUES: string[];
-
-export const PLAN_KEYS: {
-  readonly MONTHLY: 'monthly';
-  readonly QUARTERLY: 'quarterly';
-  readonly YEARLY: 'yearly';
-};
-
-export const PLAN_KEY_VALUES: string[];
-
-// ============ MONETIZATION ENUMS ============
-
-export const MONETIZATION_TYPES: {
-  readonly FREE: 'free';
-  readonly PURCHASE: 'purchase';
-  readonly SUBSCRIPTION: 'subscription';
-};
-
-export const MONETIZATION_TYPE_VALUES: string[];
-
-// ============ DEFAULT EXPORT ============
-
-declare const _default: {
-  TRANSACTION_TYPE: typeof TRANSACTION_TYPE;
-  TRANSACTION_TYPE_VALUES: typeof TRANSACTION_TYPE_VALUES;
-  TRANSACTION_STATUS: typeof TRANSACTION_STATUS;
-  TRANSACTION_STATUS_VALUES: typeof TRANSACTION_STATUS_VALUES;
-  LIBRARY_CATEGORIES: typeof LIBRARY_CATEGORIES;
-  LIBRARY_CATEGORY_VALUES: typeof LIBRARY_CATEGORY_VALUES;
-  PAYMENT_STATUS: typeof PAYMENT_STATUS;
-  PAYMENT_STATUS_VALUES: typeof PAYMENT_STATUS_VALUES;
-  PAYMENT_GATEWAY_TYPE: typeof PAYMENT_GATEWAY_TYPE;
-  PAYMENT_GATEWAY_TYPE_VALUES: typeof PAYMENT_GATEWAY_TYPE_VALUES;
-  GATEWAY_TYPES: typeof GATEWAY_TYPES;
-  GATEWAY_TYPE_VALUES: typeof GATEWAY_TYPE_VALUES;
-  SUBSCRIPTION_STATUS: typeof SUBSCRIPTION_STATUS;
-  SUBSCRIPTION_STATUS_VALUES: typeof SUBSCRIPTION_STATUS_VALUES;
-  PLAN_KEYS: typeof PLAN_KEYS;
-  PLAN_KEY_VALUES: typeof PLAN_KEY_VALUES;
-  MONETIZATION_TYPES: typeof MONETIZATION_TYPES;
-  MONETIZATION_TYPE_VALUES: typeof MONETIZATION_TYPE_VALUES;
-};
-
-export default _default;

package/enums/index.js

@@ -1,110 +0,0 @@
-/**
- * @classytic/revenue - Centralized Enums
- * All enums for the revenue management system
- *
- * This file serves as the single source of truth for all enum values
- * used across monetization and payment subsystems.
- *
- * @module @classytic/revenue/enums
- */
-
-// Re-export all enums
-export * from './transaction.enums.js';
-export * from './payment.enums.js';
-export * from './subscription.enums.js';
-export * from './monetization.enums.js';
-export * from './escrow.enums.js';
-export * from './split.enums.js';
-
-// Default export for convenience
-import {
-  TRANSACTION_TYPE,
-  TRANSACTION_TYPE_VALUES,
-  TRANSACTION_STATUS,
-  TRANSACTION_STATUS_VALUES,
-  LIBRARY_CATEGORIES,
-  LIBRARY_CATEGORY_VALUES,
-} from './transaction.enums.js';
-
-import {
-  PAYMENT_STATUS,
-  PAYMENT_STATUS_VALUES,
-  PAYMENT_GATEWAY_TYPE,
-  PAYMENT_GATEWAY_TYPE_VALUES,
-  GATEWAY_TYPES,
-  GATEWAY_TYPE_VALUES,
-} from './payment.enums.js';
-
-import {
-  SUBSCRIPTION_STATUS,
-  SUBSCRIPTION_STATUS_VALUES,
-  PLAN_KEYS,
-  PLAN_KEY_VALUES,
-} from './subscription.enums.js';
-
-import {
-  MONETIZATION_TYPES,
-  MONETIZATION_TYPE_VALUES,
-} from './monetization.enums.js';
-
-import {
-  HOLD_STATUS,
-  HOLD_STATUS_VALUES,
-  RELEASE_REASON,
-  RELEASE_REASON_VALUES,
-  HOLD_REASON,
-  HOLD_REASON_VALUES,
-} from './escrow.enums.js';
-
-import {
-  SPLIT_TYPE,
-  SPLIT_TYPE_VALUES,
-  SPLIT_STATUS,
-  SPLIT_STATUS_VALUES,
-  PAYOUT_METHOD,
-  PAYOUT_METHOD_VALUES,
-} from './split.enums.js';
-
-export default {
-  // Transaction enums
-  TRANSACTION_TYPE,
-  TRANSACTION_TYPE_VALUES,
-  TRANSACTION_STATUS,
-  TRANSACTION_STATUS_VALUES,
-  LIBRARY_CATEGORIES,
-  LIBRARY_CATEGORY_VALUES,
-
-  // Payment enums
-  PAYMENT_STATUS,
-  PAYMENT_STATUS_VALUES,
-  PAYMENT_GATEWAY_TYPE,
-  PAYMENT_GATEWAY_TYPE_VALUES,
-  GATEWAY_TYPES,
-  GATEWAY_TYPE_VALUES,
-
-  // Subscription enums
-  SUBSCRIPTION_STATUS,
-  SUBSCRIPTION_STATUS_VALUES,
-  PLAN_KEYS,
-  PLAN_KEY_VALUES,
-
-  // Monetization enums
-  MONETIZATION_TYPES,
-  MONETIZATION_TYPE_VALUES,
-
-  // Escrow enums
-  HOLD_STATUS,
-  HOLD_STATUS_VALUES,
-  RELEASE_REASON,
-  RELEASE_REASON_VALUES,
-  HOLD_REASON,
-  HOLD_REASON_VALUES,
-
-  // Split enums
-  SPLIT_TYPE,
-  SPLIT_TYPE_VALUES,
-  SPLIT_STATUS,
-  SPLIT_STATUS_VALUES,
-  PAYOUT_METHOD,
-  PAYOUT_METHOD_VALUES,
-};

package/enums/monetization.enums.js

@@ -1,15 +0,0 @@
-/**
- * Monetization Enums
- * @classytic/revenue
- *
- * General monetization enums and constants
- */
-
-// ============ MONETIZATION TYPES ============
-export const MONETIZATION_TYPES = {
-  FREE: 'free',
-  PURCHASE: 'purchase',
-  SUBSCRIPTION: 'subscription',
-};
-
-export const MONETIZATION_TYPE_VALUES = Object.values(MONETIZATION_TYPES);

package/enums/payment.enums.js

@@ -1,64 +0,0 @@
-/**
- * Payment Enums
- * @classytic/revenue
- *
- * Library-managed payment enums only.
- * Users define their own payment methods in their schema.
- */
-
-// ============ PAYMENT STATUS ============
-/**
- * Payment Status - Library-managed states
- */
-export const PAYMENT_STATUS = {
-  PENDING: 'pending',
-  VERIFIED: 'verified',
-  FAILED: 'failed',
-  REFUNDED: 'refunded',
-  CANCELLED: 'cancelled',
-};
-
-export const PAYMENT_STATUS_VALUES = Object.values(PAYMENT_STATUS);
-
-// ============ PAYMENT GATEWAY TYPES ============
-/**
- * Common gateway type constants for convenience
- *
- * ⚠️ IMPORTANT: These are NOT restrictions - just common reference values
- *
- * You can register ANY custom gateway provider by passing it to createRevenue():
- *
- * @example
- * ```javascript
- * const revenue = createRevenue({
- *   providers: {
- *     manual: new ManualProvider(),
- *     bkash: new BkashProvider(),      // ✅ Custom gateway
- *     nagad: new NagadProvider(),      // ✅ Custom gateway
- *     stripe: new StripeProvider(),    // ✅ Custom gateway
- *     paypal: new PaypalProvider(),    // ✅ Any gateway you want
- *   }
- * });
- *
- * // Use by name
- * await revenue.monetization.create({ gateway: 'bkash', ... });
- * ```
- *
- * Reference values:
- * - MANUAL: Built-in manual provider (@classytic/revenue-manual)
- * - STRIPE: Stripe provider (build with @classytic/revenue-stripe)
- * - SSLCOMMERZ: SSLCommerz provider (build with @classytic/revenue-sslcommerz)
- *
- * Add your own: bkash, nagad, rocket, paypal, razorpay, flutterwave, etc.
- */
-export const PAYMENT_GATEWAY_TYPE = {
-  MANUAL: 'manual',
-  STRIPE: 'stripe',
-  SSLCOMMERZ: 'sslcommerz',
-};
-
-export const PAYMENT_GATEWAY_TYPE_VALUES = Object.values(PAYMENT_GATEWAY_TYPE);
-
-// Backward compatibility alias
-export const GATEWAY_TYPES = PAYMENT_GATEWAY_TYPE;
-export const GATEWAY_TYPE_VALUES = PAYMENT_GATEWAY_TYPE_VALUES;

package/enums/split.enums.js

@@ -1,37 +0,0 @@
-/**
- * Split Payment Enums
- * @classytic/revenue
- *
- * Enums for multi-party commission splits
- */
-
-export const SPLIT_TYPE = {
-  PLATFORM_COMMISSION: 'platform_commission',
-  AFFILIATE_COMMISSION: 'affiliate_commission',
-  REFERRAL_COMMISSION: 'referral_commission',
-  PARTNER_COMMISSION: 'partner_commission',
-  CUSTOM: 'custom',
-};
-
-export const SPLIT_TYPE_VALUES = Object.values(SPLIT_TYPE);
-
-export const SPLIT_STATUS = {
-  PENDING: 'pending',
-  DUE: 'due',
-  PAID: 'paid',
-  WAIVED: 'waived',
-  CANCELLED: 'cancelled',
-};
-
-export const SPLIT_STATUS_VALUES = Object.values(SPLIT_STATUS);
-
-export const PAYOUT_METHOD = {
-  BANK_TRANSFER: 'bank_transfer',
-  MOBILE_WALLET: 'mobile_wallet',
-  PLATFORM_BALANCE: 'platform_balance',
-  CRYPTO: 'crypto',
-  CHECK: 'check',
-  MANUAL: 'manual',
-};
-
-export const PAYOUT_METHOD_VALUES = Object.values(PAYOUT_METHOD);

package/enums/subscription.enums.js

@@ -1,33 +0,0 @@
-/**
- * Subscription Enums
- * @classytic/revenue
- *
- * All subscription-related enums and constants
- */
-
-// ============ SUBSCRIPTION STATUS ============
-/**
- * Subscription Status
- */
-export const SUBSCRIPTION_STATUS = {
-  ACTIVE: 'active',
-  PAUSED: 'paused',
-  CANCELLED: 'cancelled',
-  EXPIRED: 'expired',
-  PENDING: 'pending',
-  INACTIVE: 'inactive',
-};
-
-export const SUBSCRIPTION_STATUS_VALUES = Object.values(SUBSCRIPTION_STATUS);
-
-// ============ PLAN KEYS ============
-/**
- * Supported plan intervals
- */
-export const PLAN_KEYS = {
-  MONTHLY: 'monthly',
-  QUARTERLY: 'quarterly',
-  YEARLY: 'yearly',
-};
-
-export const PLAN_KEY_VALUES = Object.values(PLAN_KEYS);

package/enums/transaction.enums.js

@@ -1,69 +0,0 @@
-/**
- * Transaction Enums
- * @classytic/revenue
- *
- * Library-managed transaction enums only.
- * Users should define their own categories and merge with these.
- */
-
-// ============ TRANSACTION TYPE ============
-/**
- * Transaction Type - Income vs Expense
- * 
- * INCOME: Money coming in (payments, subscriptions, purchases)
- * EXPENSE: Money going out (refunds, payouts)
- * 
- * Users can map these in their config via transactionTypeMapping
- */
-export const TRANSACTION_TYPE = {
-  INCOME: 'income',
-  EXPENSE: 'expense',
-};
-
-export const TRANSACTION_TYPE_VALUES = Object.values(TRANSACTION_TYPE);
-
-// ============ TRANSACTION STATUS ============
-/**
- * Transaction Status - Library-managed states
- */
-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 TRANSACTION_STATUS_VALUES = Object.values(TRANSACTION_STATUS);
-
-// ============ LIBRARY CATEGORIES ============
-/**
- * Categories managed by this library
- *
- * SUBSCRIPTION: Recurring subscription payments
- * PURCHASE: One-time purchases
- *
- * Users should spread these into their own category enums:
- *
- * @example
- * import { LIBRARY_CATEGORIES } from '@classytic/revenue';
- *
- * export const MY_CATEGORIES = {
- *   ...LIBRARY_CATEGORIES,
- *   SALARY: 'salary',
- *   RENT: 'rent',
- *   EQUIPMENT: 'equipment',
- * };
- */
-export const LIBRARY_CATEGORIES = {
-  SUBSCRIPTION: 'subscription',
-  PURCHASE: 'purchase',
-};
-
-export const LIBRARY_CATEGORY_VALUES = Object.values(LIBRARY_CATEGORIES);