@classytic/revenue 1.0.2 → 1.0.6

package/dist/index.js

@@ -1,6 +1,5 @@
 import { nanoid } from 'nanoid';
 import * as z from 'zod';
-export { z };
 import { Schema } from 'mongoose';
 
 // @classytic/revenue - Enterprise Revenue Management System
@@ -1115,7 +1114,9 @@ var TRANSACTION_TYPE = {
   INCOME: "income",
   EXPENSE: "expense"
 };
-var TRANSACTION_TYPE_VALUES = Object.values(TRANSACTION_TYPE);
+var TRANSACTION_TYPE_VALUES = Object.values(
+  TRANSACTION_TYPE
+);
 var TRANSACTION_STATUS = {
   PENDING: "pending",
   PAYMENT_INITIATED: "payment_initiated",
@@ -1129,12 +1130,30 @@ var TRANSACTION_STATUS = {
   REFUNDED: "refunded",
   PARTIALLY_REFUNDED: "partially_refunded"
 };
-var TRANSACTION_STATUS_VALUES = Object.values(TRANSACTION_STATUS);
+var TRANSACTION_STATUS_VALUES = Object.values(
+  TRANSACTION_STATUS
+);
 var LIBRARY_CATEGORIES = {
   SUBSCRIPTION: "subscription",
   PURCHASE: "purchase"
 };
-var LIBRARY_CATEGORY_VALUES = Object.values(LIBRARY_CATEGORIES);
+var LIBRARY_CATEGORY_VALUES = Object.values(
+  LIBRARY_CATEGORIES
+);
+var transactionTypeSet = new Set(TRANSACTION_TYPE_VALUES);
+var transactionStatusSet = new Set(
+  TRANSACTION_STATUS_VALUES
+);
+var libraryCategorySet = new Set(LIBRARY_CATEGORY_VALUES);
+function isLibraryCategory(value) {
+  return typeof value === "string" && libraryCategorySet.has(value);
+}
+function isTransactionType(value) {
+  return typeof value === "string" && transactionTypeSet.has(value);
+}
+function isTransactionStatus(value) {
+  return typeof value === "string" && transactionStatusSet.has(value);
+}
 
 // src/utils/category-resolver.ts
 function resolveCategory(entity, monetizationType, categoryMappings = {}) {
@@ -1207,7 +1226,13 @@ var MONETIZATION_TYPES = {
   PURCHASE: "purchase",
   SUBSCRIPTION: "subscription"
 };
-var MONETIZATION_TYPE_VALUES = Object.values(MONETIZATION_TYPES);
+var MONETIZATION_TYPE_VALUES = Object.values(
+  MONETIZATION_TYPES
+);
+var monetizationTypeSet = new Set(MONETIZATION_TYPE_VALUES);
+function isMonetizationType(value) {
+  return typeof value === "string" && monetizationTypeSet.has(value);
+}
 
 // src/services/monetization.service.ts
 var MonetizationService = class {
@@ -2221,7 +2246,9 @@ var RELEASE_REASON = {
   AUTO_RELEASE: "auto_release",
   DISPUTE_RESOLVED: "dispute_resolved"
 };
-var RELEASE_REASON_VALUES = Object.values(RELEASE_REASON);
+var RELEASE_REASON_VALUES = Object.values(
+  RELEASE_REASON
+);
 var HOLD_REASON = {
   PAYMENT_VERIFICATION: "payment_verification",
   FRAUD_CHECK: "fraud_check",
@@ -2230,6 +2257,18 @@ var HOLD_REASON = {
   COMPLIANCE: "compliance"
 };
 var HOLD_REASON_VALUES = Object.values(HOLD_REASON);
+var holdStatusSet = new Set(HOLD_STATUS_VALUES);
+var releaseReasonSet = new Set(RELEASE_REASON_VALUES);
+var holdReasonSet = new Set(HOLD_REASON_VALUES);
+function isHoldStatus(value) {
+  return typeof value === "string" && holdStatusSet.has(value);
+}
+function isReleaseReason(value) {
+  return typeof value === "string" && releaseReasonSet.has(value);
+}
+function isHoldReason(value) {
+  return typeof value === "string" && holdReasonSet.has(value);
+}
 
 // src/enums/split.enums.ts
 var SPLIT_TYPE = {
@@ -2247,7 +2286,9 @@ var SPLIT_STATUS = {
   WAIVED: "waived",
   CANCELLED: "cancelled"
 };
-var SPLIT_STATUS_VALUES = Object.values(SPLIT_STATUS);
+var SPLIT_STATUS_VALUES = Object.values(
+  SPLIT_STATUS
+);
 var PAYOUT_METHOD = {
   BANK_TRANSFER: "bank_transfer",
   MOBILE_WALLET: "mobile_wallet",
@@ -2257,6 +2298,18 @@ var PAYOUT_METHOD = {
   MANUAL: "manual"
 };
 var PAYOUT_METHOD_VALUES = Object.values(PAYOUT_METHOD);
+var splitTypeSet = new Set(SPLIT_TYPE_VALUES);
+var splitStatusSet = new Set(SPLIT_STATUS_VALUES);
+var payoutMethodSet = new Set(PAYOUT_METHOD_VALUES);
+function isSplitType(value) {
+  return typeof value === "string" && splitTypeSet.has(value);
+}
+function isSplitStatus(value) {
+  return typeof value === "string" && splitStatusSet.has(value);
+}
+function isPayoutMethod(value) {
+  return typeof value === "string" && payoutMethodSet.has(value);
+}
 
 // src/utils/commission-split.ts
 function calculateSplits(amount, splitRules = [], gatewayFeeRate = 0) {
@@ -3567,6 +3620,50 @@ var CommissionConfigSchema = z.object({
     rate: z.number().min(0).max(100)
   }).optional()
 });
+var PaymentStatusEnumSchema = z.enum([
+  "pending",
+  "verified",
+  "failed",
+  "refunded",
+  "cancelled"
+]);
+var PaymentEntrySchema = z.object({
+  /** Payment method (e.g., 'cash', 'bank_transfer', 'bkash') */
+  method: z.string().min(1, "Payment method is required"),
+  /** Amount in smallest currency unit */
+  amount: MoneyAmountSchema,
+  /** Reference/transaction ID for this payment */
+  reference: z.string().optional(),
+  /** Method-specific details (walletNumber, bankName, trxId, etc.) */
+  details: z.record(z.string(), z.unknown()).optional()
+});
+var CurrentPaymentInputSchema = z.object({
+  /** Transaction ID reference */
+  transactionId: z.string().optional(),
+  /** Total amount (sum of all payments for split payments) */
+  amount: MoneyAmountSchema,
+  /** Payment status */
+  status: PaymentStatusEnumSchema.default("pending"),
+  /** Primary method for single payments, or 'split' when multiple methods */
+  method: z.string().min(1, "Payment method is required"),
+  /** Reference/transaction ID for single payment */
+  reference: z.string().optional(),
+  /** Array of individual payments for split payment scenarios */
+  payments: z.array(PaymentEntrySchema).optional(),
+  /** Verification timestamp */
+  verifiedAt: z.date().optional(),
+  /** User ID who verified the payment */
+  verifiedBy: z.string().optional()
+}).refine(
+  (data) => {
+    if (data.payments && data.payments.length > 0) {
+      const paymentsTotal = data.payments.reduce((sum, p) => sum + p.amount, 0);
+      return paymentsTotal === data.amount;
+    }
+    return true;
+  },
+  { message: "Split payments total must equal the transaction amount" }
+);
 var HoldStatusSchema = z.enum([
   "none",
   "held",
@@ -3634,6 +3731,16 @@ function safeValidate(schema, data) {
 function formatZodError(error) {
   return error.issues.map((issue) => `${issue.path.join(".")}: ${issue.message}`).join(", ");
 }
+function validateSplitPayments(currentPayment) {
+  if (!currentPayment.payments?.length) {
+    return true;
+  }
+  const paymentsTotal = currentPayment.payments.reduce(
+    (sum, p) => sum + p.amount,
+    0
+  );
+  return paymentsTotal === currentPayment.amount;
+}
 
 // src/enums/payment.enums.ts
 var PAYMENT_STATUS = {
@@ -3643,15 +3750,30 @@ var PAYMENT_STATUS = {
   REFUNDED: "refunded",
   CANCELLED: "cancelled"
 };
-var PAYMENT_STATUS_VALUES = Object.values(PAYMENT_STATUS);
+var PAYMENT_STATUS_VALUES = Object.values(
+  PAYMENT_STATUS
+);
 var PAYMENT_GATEWAY_TYPE = {
   MANUAL: "manual",
   STRIPE: "stripe",
   SSLCOMMERZ: "sslcommerz"
 };
-var PAYMENT_GATEWAY_TYPE_VALUES = Object.values(PAYMENT_GATEWAY_TYPE);
+var PAYMENT_GATEWAY_TYPE_VALUES = Object.values(
+  PAYMENT_GATEWAY_TYPE
+);
 var GATEWAY_TYPES = PAYMENT_GATEWAY_TYPE;
 var GATEWAY_TYPE_VALUES = PAYMENT_GATEWAY_TYPE_VALUES;
+var paymentStatusSet = new Set(PAYMENT_STATUS_VALUES);
+var paymentGatewayTypeSet = new Set(
+  PAYMENT_GATEWAY_TYPE_VALUES
+);
+function isPaymentStatus(value) {
+  return typeof value === "string" && paymentStatusSet.has(value);
+}
+function isPaymentGatewayType(value) {
+  return typeof value === "string" && paymentGatewayTypeSet.has(value);
+}
+var isGatewayType = isPaymentGatewayType;
 
 // src/enums/subscription.enums.ts
 var SUBSCRIPTION_STATUS = {
@@ -3662,13 +3784,25 @@ var SUBSCRIPTION_STATUS = {
   PENDING: "pending",
   INACTIVE: "inactive"
 };
-var SUBSCRIPTION_STATUS_VALUES = Object.values(SUBSCRIPTION_STATUS);
+var SUBSCRIPTION_STATUS_VALUES = Object.values(
+  SUBSCRIPTION_STATUS
+);
 var PLAN_KEYS = {
   MONTHLY: "monthly",
   QUARTERLY: "quarterly",
   YEARLY: "yearly"
 };
 var PLAN_KEY_VALUES = Object.values(PLAN_KEYS);
+var subscriptionStatusSet = new Set(
+  SUBSCRIPTION_STATUS_VALUES
+);
+var planKeySet = new Set(PLAN_KEY_VALUES);
+function isSubscriptionStatus(value) {
+  return typeof value === "string" && subscriptionStatusSet.has(value);
+}
+function isPlanKey(value) {
+  return typeof value === "string" && planKeySet.has(value);
+}
 var baseMetadataSchema = new Schema(
   {
     // Flexible key-value metadata
@@ -3678,8 +3812,7 @@ var baseMetadataSchema = new Schema(
 var referenceSchema = {
   referenceId: {
     type: Schema.Types.ObjectId,
-    refPath: "referenceModel",
-    index: true
+    refPath: "referenceModel"
   },
   referenceModel: {
     type: String,
@@ -3690,18 +3823,15 @@ var gatewaySchema = new Schema(
   {
     type: {
       type: String,
-      required: true,
-      index: true
+      required: true
     },
     sessionId: {
       type: String,
-      sparse: true,
-      index: true
+      sparse: true
     },
     paymentIntentId: {
       type: String,
-      sparse: true,
-      index: true
+      sparse: true
     },
     provider: {
       type: String
@@ -3716,31 +3846,58 @@ var gatewaySchema = new Schema(
   },
   { _id: false }
 );
+var paymentEntrySchema = new Schema(
+  {
+    method: {
+      type: String,
+      required: true
+    },
+    amount: {
+      type: Number,
+      required: true,
+      min: 0
+    },
+    reference: {
+      type: String,
+      trim: true
+    },
+    details: {
+      type: Schema.Types.Mixed
+      // For method-specific data: walletNumber, bankName, trxId, etc.
+    }
+  },
+  { _id: false }
+);
 var currentPaymentSchema = new Schema(
   {
     transactionId: {
       type: Schema.Types.ObjectId,
-      ref: "Transaction",
-      index: true
+      ref: "Transaction"
     },
     amount: {
       type: Number,
       min: 0
+      // Total amount (sum of all payments for split payments)
     },
     status: {
       type: String,
       enum: PAYMENT_STATUS_VALUES,
-      default: "pending",
-      index: true
+      default: "pending"
     },
     method: {
       type: String
-      // Users define payment methods in their transaction model
+      // Primary method for single payments, or 'split' when multiple methods
     },
     reference: {
       type: String,
       trim: true
     },
+    // Split payments support - array of individual payment entries
+    payments: {
+      type: [paymentEntrySchema],
+      default: void 0
+      // Not set for single payments (backward compat)
+    },
     verifiedAt: {
       type: Date
     },
@@ -3913,20 +4070,17 @@ var subscriptionInfoSchema = new Schema(
     status: {
       type: String,
       enum: SUBSCRIPTION_STATUS_VALUES,
-      default: "pending",
-      index: true
+      default: "pending"
     },
     isActive: {
       type: Boolean,
-      default: false,
-      index: true
+      default: false
     },
     startDate: {
       type: Date
     },
     endDate: {
-      type: Date,
-      index: true
+      type: Date
     },
     canceledAt: {
       type: Date
@@ -3956,8 +4110,7 @@ var holdSchema = {
   status: {
     type: String,
     enum: HOLD_STATUS_VALUES,
-    default: HOLD_STATUS.PENDING,
-    index: true
+    default: HOLD_STATUS.PENDING
   },
   heldAmount: {
     type: Number,
@@ -4004,8 +4157,7 @@ var splitSchema = new Schema(
     },
     recipientId: {
       type: String,
-      required: true,
-      index: true
+      required: true
     },
     recipientType: {
       type: String,
@@ -4042,8 +4194,7 @@ var splitSchema = new Schema(
     status: {
       type: String,
       enum: SPLIT_STATUS_VALUES,
-      default: SPLIT_STATUS.PENDING,
-      index: true
+      default: SPLIT_STATUS.PENDING
     },
     dueDate: {
       type: Date
@@ -4342,6 +4493,6 @@ var index_default = {
  * @license MIT
  */
 
-export { AlreadyVerifiedError, CancelSubscriptionSchema, CircuitBreaker, CircuitOpenError, CommissionConfigSchema, ConfigurationError, Container, CreateHoldSchema, CreateMonetizationSchema, CreatePaymentSchema, CreateSubscriptionSchema, CurrencySchema, EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION, ERROR_CODES, EmailSchema, EscrowService, EventBus, GATEWAY_TYPES, GATEWAY_TYPE_VALUES, HOLD_REASON, HOLD_REASON_VALUES, HOLD_STATUS, HOLD_STATUS_VALUES, HoldStatusSchema, IdempotencyError, IdempotencyKeySchema, IdempotencyManager, IntervalSchema, InvalidAmountError, InvalidStateTransitionError, LIBRARY_CATEGORIES, LIBRARY_CATEGORY_VALUES, MANUAL_TRANSACTION_CREATE_FIELDS, MANUAL_TRANSACTION_UPDATE_FIELDS, MONETIZATION_TYPES, MONETIZATION_TYPE_VALUES, MemoryIdempotencyStore, MetadataSchema, MissingRequiredFieldError, ModelNotRegisteredError, MonetizationService, MonetizationTypeSchema, Money, MoneyAmountSchema, MoneySchema, NotFoundError, ObjectIdSchema, OperationError, PAYMENT_GATEWAY_TYPE, PAYMENT_GATEWAY_TYPE_VALUES, PAYMENT_STATUS, PAYMENT_STATUS_VALUES, PAYOUT_METHOD, PAYOUT_METHOD_VALUES, PLAN_KEYS, PLAN_KEY_VALUES, PROTECTED_MONETIZATION_FIELDS, PaymentIntent, PaymentIntentCreationError, PaymentProvider, PaymentResult, PaymentService, PaymentVerificationError, PluginManager, ProviderCapabilityError, ProviderConfigSchema, ProviderError, ProviderNotFoundError, RELEASE_REASON, RELEASE_REASON_VALUES, RefundError, RefundNotSupportedError, RefundResult, RefundSchema, ReleaseHoldSchema, Result, RetryConfigSchema, RetryExhaustedError, Revenue, RevenueBuilder, RevenueConfigSchema, RevenueError, SPLIT_STATUS, SPLIT_STATUS_VALUES, SPLIT_TYPE, SPLIT_TYPE_VALUES, SUBSCRIPTION_STATUS, SUBSCRIPTION_STATUS_VALUES, SplitRecipientSchema, StateError, SubscriptionNotActiveError, SubscriptionNotFoundError, SubscriptionStatusSchema, TRANSACTION_MANAGEMENT_TYPE, TRANSACTION_STATUS, TRANSACTION_STATUS_VALUES, TRANSACTION_TYPE, TRANSACTION_TYPE_VALUES, TransactionNotFoundError, TransactionService, ValidationError, VerifyPaymentSchema, WebhookEvent, addDuration, all, auditPlugin, baseMetadataSchema, calculateCommission, calculateCommissionWithSplits, calculateDelay, calculateOrganizationPayout, calculatePeriodRange, calculateProratedAmount, calculateSplits, canCancelSubscription, canPauseSubscription, canRenewSubscription, canResumeSubscription, canSelfVerify, commissionSchema, createCircuitBreaker, createEventBus, createIdempotencyManager, createRevenue, currentPaymentSchema, index_default as default, definePlugin, err, flatMap, formatZodError, fromSmallestUnit, gatewaySchema, getAllowedUpdateFields, getTransactionType, holdSchema, isCategoryValid, isErr, isManualTransaction, isMonetizationTransaction, isOk, isRetryable, isRetryableError, isRevenueError, isSubscriptionActive, logger, loggingPlugin, map, mapErr, match, metricsPlugin, ok, paymentDetailsSchema, paymentSummarySchema, planSchema, referenceSchema, resilientExecute, resolveCategory, resolveIntervalToDuration, retry, retryWithResult, reverseCommission, reverseSplits, safeValidate, setLogger, splitSchema, subscriptionInfoSchema, tenantSnapshotSchema, toSmallestUnit, tryCatch, tryCatchSync, unwrap, unwrapOr, validate, validateFieldUpdate };
+export { AlreadyVerifiedError, CancelSubscriptionSchema, CircuitBreaker, CircuitOpenError, CommissionConfigSchema, ConfigurationError, Container, CreateHoldSchema, CreateMonetizationSchema, CreatePaymentSchema, CreateSubscriptionSchema, CurrencySchema, CurrentPaymentInputSchema, EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION, ERROR_CODES, EmailSchema, EscrowService, EventBus, GATEWAY_TYPES, GATEWAY_TYPE_VALUES, HOLD_REASON, HOLD_REASON_VALUES, HOLD_STATUS, HOLD_STATUS_VALUES, HoldStatusSchema, IdempotencyError, IdempotencyKeySchema, IdempotencyManager, IntervalSchema, InvalidAmountError, InvalidStateTransitionError, LIBRARY_CATEGORIES, LIBRARY_CATEGORY_VALUES, MANUAL_TRANSACTION_CREATE_FIELDS, MANUAL_TRANSACTION_UPDATE_FIELDS, MONETIZATION_TYPES, MONETIZATION_TYPE_VALUES, MemoryIdempotencyStore, MetadataSchema, MissingRequiredFieldError, ModelNotRegisteredError, MonetizationService, MonetizationTypeSchema, Money, MoneyAmountSchema, MoneySchema, NotFoundError, ObjectIdSchema, OperationError, PAYMENT_GATEWAY_TYPE, PAYMENT_GATEWAY_TYPE_VALUES, PAYMENT_STATUS, PAYMENT_STATUS_VALUES, PAYOUT_METHOD, PAYOUT_METHOD_VALUES, PLAN_KEYS, PLAN_KEY_VALUES, PROTECTED_MONETIZATION_FIELDS, PaymentEntrySchema, PaymentIntent, PaymentIntentCreationError, PaymentProvider, PaymentResult, PaymentService, PaymentStatusEnumSchema, PaymentVerificationError, PluginManager, ProviderCapabilityError, ProviderConfigSchema, ProviderError, ProviderNotFoundError, RELEASE_REASON, RELEASE_REASON_VALUES, RefundError, RefundNotSupportedError, RefundResult, RefundSchema, ReleaseHoldSchema, Result, RetryConfigSchema, RetryExhaustedError, Revenue, RevenueBuilder, RevenueConfigSchema, RevenueError, SPLIT_STATUS, SPLIT_STATUS_VALUES, SPLIT_TYPE, SPLIT_TYPE_VALUES, SUBSCRIPTION_STATUS, SUBSCRIPTION_STATUS_VALUES, SplitRecipientSchema, StateError, SubscriptionNotActiveError, SubscriptionNotFoundError, SubscriptionStatusSchema, TRANSACTION_MANAGEMENT_TYPE, TRANSACTION_STATUS, TRANSACTION_STATUS_VALUES, TRANSACTION_TYPE, TRANSACTION_TYPE_VALUES, TransactionNotFoundError, TransactionService, ValidationError, VerifyPaymentSchema, WebhookEvent, addDuration, all, auditPlugin, baseMetadataSchema, calculateCommission, calculateCommissionWithSplits, calculateDelay, calculateOrganizationPayout, calculatePeriodRange, calculateProratedAmount, calculateSplits, canCancelSubscription, canPauseSubscription, canRenewSubscription, canResumeSubscription, canSelfVerify, commissionSchema, createCircuitBreaker, createEventBus, createIdempotencyManager, createRevenue, currentPaymentSchema, index_default as default, definePlugin, err, flatMap, formatZodError, fromSmallestUnit, gatewaySchema, getAllowedUpdateFields, getTransactionType, holdSchema, isCategoryValid, isErr, isGatewayType, isHoldReason, isHoldStatus, isLibraryCategory, isManualTransaction, isMonetizationTransaction, isMonetizationType, isOk, isPaymentGatewayType, isPaymentStatus, isPayoutMethod, isPlanKey, isReleaseReason, isRetryable, isRetryableError, isRevenueError, isSplitStatus, isSplitType, isSubscriptionActive, isSubscriptionStatus, isTransactionStatus, isTransactionType, logger, loggingPlugin, map, mapErr, match, metricsPlugin, ok, paymentDetailsSchema, paymentEntrySchema, paymentSummarySchema, planSchema, referenceSchema, resilientExecute, resolveCategory, resolveIntervalToDuration, retry, retryWithResult, reverseCommission, reverseSplits, safeValidate, setLogger, splitSchema, subscriptionInfoSchema, tenantSnapshotSchema, toSmallestUnit, tryCatch, tryCatchSync, unwrap, unwrapOr, validate, validateFieldUpdate, validateSplitPayments };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map