@classytic/revenue 1.1.2 → 1.1.3

package/dist/schemas/index.js

@@ -1,841 +0,0 @@
-import { Schema } from 'mongoose';
-
-// @classytic/revenue - Enterprise Revenue Management System
-
-var baseMetadataSchema = new Schema(
-  {
-    // Flexible key-value metadata
-  },
-  { _id: false, strict: false }
-);
-var gatewaySchema = new Schema(
-  {
-    type: {
-      type: String,
-      required: true
-    },
-    sessionId: {
-      type: String,
-      sparse: true
-    },
-    paymentIntentId: {
-      type: String,
-      sparse: true
-    },
-    provider: {
-      type: String
-    },
-    metadata: {
-      type: Schema.Types.Mixed,
-      default: {}
-    },
-    verificationData: {
-      type: Schema.Types.Mixed
-    }
-  },
-  { _id: false }
-);
-var gateway_schema_default = gatewaySchema;
-
-// src/enums/transaction.enums.ts
-var TRANSACTION_FLOW = {
-  INFLOW: "inflow",
-  OUTFLOW: "outflow"
-};
-var TRANSACTION_FLOW_VALUES = Object.values(
-  TRANSACTION_FLOW
-);
-var 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"
-};
-var TRANSACTION_STATUS_VALUES = Object.values(
-  TRANSACTION_STATUS
-);
-var LIBRARY_CATEGORIES = {
-  SUBSCRIPTION: "subscription",
-  PURCHASE: "purchase"
-};
-var LIBRARY_CATEGORY_VALUES = Object.values(
-  LIBRARY_CATEGORIES
-);
-new Set(TRANSACTION_FLOW_VALUES);
-new Set(
-  TRANSACTION_STATUS_VALUES
-);
-new Set(LIBRARY_CATEGORY_VALUES);
-
-// src/enums/payment.enums.ts
-var PAYMENT_STATUS = {
-  PENDING: "pending",
-  VERIFIED: "verified",
-  FAILED: "failed",
-  REFUNDED: "refunded",
-  CANCELLED: "cancelled"
-};
-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
-);
-new Set(PAYMENT_STATUS_VALUES);
-new Set(
-  PAYMENT_GATEWAY_TYPE_VALUES
-);
-
-// src/enums/subscription.enums.ts
-var SUBSCRIPTION_STATUS = {
-  ACTIVE: "active",
-  PAUSED: "paused",
-  CANCELLED: "cancelled",
-  EXPIRED: "expired",
-  PENDING: "pending",
-  PENDING_RENEWAL: "pending_renewal",
-  INACTIVE: "inactive"
-};
-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);
-new Set(
-  SUBSCRIPTION_STATUS_VALUES
-);
-new Set(PLAN_KEY_VALUES);
-
-// src/enums/monetization.enums.ts
-var MONETIZATION_TYPES = {
-  FREE: "free",
-  PURCHASE: "purchase",
-  SUBSCRIPTION: "subscription"
-};
-var MONETIZATION_TYPE_VALUES = Object.values(
-  MONETIZATION_TYPES
-);
-new Set(MONETIZATION_TYPE_VALUES);
-
-// src/enums/escrow.enums.ts
-var HOLD_STATUS = {
-  PENDING: "pending",
-  HELD: "held",
-  RELEASED: "released",
-  CANCELLED: "cancelled",
-  EXPIRED: "expired",
-  PARTIALLY_RELEASED: "partially_released"
-};
-var HOLD_STATUS_VALUES = Object.values(HOLD_STATUS);
-var RELEASE_REASON = {
-  PAYMENT_VERIFIED: "payment_verified",
-  MANUAL_RELEASE: "manual_release",
-  AUTO_RELEASE: "auto_release",
-  DISPUTE_RESOLVED: "dispute_resolved"
-};
-var RELEASE_REASON_VALUES = Object.values(
-  RELEASE_REASON
-);
-var HOLD_REASON = {
-  PAYMENT_VERIFICATION: "payment_verification",
-  FRAUD_CHECK: "fraud_check",
-  MANUAL_REVIEW: "manual_review",
-  DISPUTE: "dispute",
-  COMPLIANCE: "compliance"
-};
-var HOLD_REASON_VALUES = Object.values(HOLD_REASON);
-new Set(HOLD_STATUS_VALUES);
-new Set(RELEASE_REASON_VALUES);
-new Set(HOLD_REASON_VALUES);
-
-// src/enums/split.enums.ts
-var SPLIT_TYPE = {
-  PLATFORM_COMMISSION: "platform_commission",
-  AFFILIATE_COMMISSION: "affiliate_commission",
-  REFERRAL_COMMISSION: "referral_commission",
-  PARTNER_COMMISSION: "partner_commission",
-  CUSTOM: "custom"
-};
-var SPLIT_TYPE_VALUES = Object.values(SPLIT_TYPE);
-var SPLIT_STATUS = {
-  PENDING: "pending",
-  DUE: "due",
-  PAID: "paid",
-  WAIVED: "waived",
-  CANCELLED: "cancelled"
-};
-var SPLIT_STATUS_VALUES = Object.values(
-  SPLIT_STATUS
-);
-var PAYOUT_METHOD = {
-  BANK_TRANSFER: "bank_transfer",
-  MOBILE_WALLET: "mobile_wallet",
-  PLATFORM_BALANCE: "platform_balance",
-  CRYPTO: "crypto",
-  CHECK: "check",
-  MANUAL: "manual"
-};
-var PAYOUT_METHOD_VALUES = Object.values(PAYOUT_METHOD);
-new Set(SPLIT_TYPE_VALUES);
-new Set(SPLIT_STATUS_VALUES);
-new Set(PAYOUT_METHOD_VALUES);
-
-// src/enums/settlement.enums.ts
-var SETTLEMENT_STATUS = {
-  PENDING: "pending",
-  PROCESSING: "processing",
-  COMPLETED: "completed",
-  FAILED: "failed",
-  CANCELLED: "cancelled"
-};
-var SETTLEMENT_STATUS_VALUES = Object.values(SETTLEMENT_STATUS);
-var SETTLEMENT_TYPE = {
-  SPLIT_PAYOUT: "split_payout",
-  // Payout to split recipient (vendor/affiliate)
-  PLATFORM_WITHDRAWAL: "platform_withdrawal",
-  // Platform withdraws commission
-  MANUAL_PAYOUT: "manual_payout",
-  // Manual vendor payout
-  ESCROW_RELEASE: "escrow_release"
-  // Release from escrow hold
-};
-var SETTLEMENT_TYPE_VALUES = Object.values(SETTLEMENT_TYPE);
-
-// src/schemas/transaction/payment.schema.ts
-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"
-    },
-    amount: {
-      type: Number,
-      min: 0
-      // Total amount (sum of all payments for split payments)
-    },
-    status: {
-      type: String,
-      enum: PAYMENT_STATUS_VALUES,
-      default: "pending"
-    },
-    method: {
-      type: String
-      // 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
-    },
-    verifiedBy: {
-      type: Schema.Types.ObjectId,
-      ref: "User"
-    }
-  },
-  { _id: false }
-);
-var paymentSummarySchema = new Schema(
-  {
-    totalPayments: {
-      type: Number,
-      default: 0,
-      min: 0
-    },
-    totalAmountPaid: {
-      type: Number,
-      default: 0,
-      min: 0
-    },
-    lastPaymentDate: {
-      type: Date
-    },
-    lastPaymentAmount: {
-      type: Number,
-      min: 0
-    }
-  },
-  { _id: false }
-);
-var paymentDetailsSchema = new Schema(
-  {
-    provider: { type: String },
-    walletNumber: { type: String },
-    walletType: { type: String },
-    trxId: { type: String },
-    bankName: { type: String },
-    accountNumber: { type: String },
-    accountName: { type: String },
-    proofUrl: { type: String }
-  },
-  { _id: false }
-);
-var tenantSnapshotSchema = new Schema(
-  {
-    paymentInstructions: { type: String },
-    bkashNumber: { type: String },
-    nagadNumber: { type: String },
-    bankAccount: { type: String }
-  },
-  { _id: false }
-);
-var payment_schema_default = {
-  paymentEntrySchema,
-  currentPaymentSchema,
-  paymentSummarySchema,
-  paymentDetailsSchema,
-  tenantSnapshotSchema
-};
-var commissionSchema = new Schema(
-  {
-    // Commission rate (e.g., 0.10 for 10%)
-    rate: {
-      type: Number,
-      min: 0,
-      max: 1
-    },
-    // Gross commission amount (before gateway fees)
-    grossAmount: {
-      type: Number,
-      min: 0
-    },
-    // Gateway fee rate (e.g., 0.029 for 2.9%)
-    gatewayFeeRate: {
-      type: Number,
-      min: 0,
-      max: 1
-    },
-    // Gateway fee amount deducted from commission
-    gatewayFeeAmount: {
-      type: Number,
-      min: 0
-    },
-    // Net commission (grossAmount - gatewayFeeAmount)
-    netAmount: {
-      type: Number,
-      min: 0
-    },
-    // Commission status
-    status: {
-      type: String,
-      enum: ["pending", "paid", "waived", "reversed"],
-      default: "pending"
-    },
-    // For affiliate tracking
-    affiliate: {
-      recipientId: String,
-      recipientType: {
-        type: String,
-        enum: ["user", "organization", "partner"]
-      },
-      rate: Number,
-      grossAmount: Number,
-      netAmount: Number
-    },
-    // For multi-party splits
-    splits: [
-      {
-        type: String,
-        recipientId: String,
-        rate: Number,
-        grossAmount: Number,
-        netAmount: Number
-      }
-    ]
-  },
-  { _id: false }
-);
-var commission_schema_default = commissionSchema;
-var taxBreakdownSchema = new Schema({
-  /** Is tax applicable for this transaction? */
-  isApplicable: {
-    type: Boolean,
-    default: false
-  },
-  /** Tax rate used (0-1, e.g., 0.15 = 15%) */
-  rate: {
-    type: Number,
-    default: 0,
-    min: 0,
-    max: 1
-  },
-  /** Base amount (before tax) */
-  baseAmount: {
-    type: Number,
-    default: 0,
-    min: 0
-  },
-  /** Tax amount */
-  taxAmount: {
-    type: Number,
-    default: 0,
-    min: 0
-  },
-  /** Total amount (base + tax) */
-  totalAmount: {
-    type: Number,
-    default: 0,
-    min: 0
-  },
-  /** Were prices tax-inclusive? */
-  pricesIncludeTax: {
-    type: Boolean
-  },
-  /** Tax type: collected (revenue), paid (expense), or exempt */
-  type: {
-    type: String,
-    enum: ["collected", "paid", "exempt"]
-  }
-}, { _id: false });
-var tax_schema_default = taxBreakdownSchema;
-
-// src/schemas/transaction/index.ts
-var transaction_default = {
-  baseMetadataSchema,
-  gatewaySchema: gateway_schema_default,
-  commissionSchema: commission_schema_default,
-  taxBreakdownSchema: tax_schema_default,
-  ...payment_schema_default
-};
-var planSchema = new Schema(
-  {
-    key: {
-      type: String,
-      enum: PLAN_KEY_VALUES,
-      required: true
-    },
-    name: {
-      type: String,
-      required: true
-    },
-    description: {
-      type: String
-    },
-    amount: {
-      type: Number,
-      required: true,
-      min: 0
-    },
-    currency: {
-      type: String,
-      default: "BDT"
-    },
-    interval: {
-      type: String,
-      enum: ["day", "week", "month", "year"],
-      default: "month"
-    },
-    intervalCount: {
-      type: Number,
-      default: 1,
-      min: 1
-    },
-    features: [
-      {
-        type: String
-      }
-    ],
-    metadata: {
-      type: Schema.Types.Mixed,
-      default: {}
-    },
-    isActive: {
-      type: Boolean,
-      default: true
-    }
-  },
-  { _id: false }
-);
-var plan_schema_default = planSchema;
-var subscriptionInfoSchema = new Schema(
-  {
-    planKey: {
-      type: String,
-      enum: PLAN_KEY_VALUES,
-      required: true
-    },
-    status: {
-      type: String,
-      enum: SUBSCRIPTION_STATUS_VALUES,
-      default: "pending"
-    },
-    isActive: {
-      type: Boolean,
-      default: false
-    },
-    startDate: {
-      type: Date
-    },
-    endDate: {
-      type: Date
-    },
-    canceledAt: {
-      type: Date
-    },
-    cancelAt: {
-      type: Date
-    },
-    pausedAt: {
-      type: Date
-    },
-    lastPaymentDate: {
-      type: Date
-    },
-    lastPaymentAmount: {
-      type: Number
-    },
-    renewalCount: {
-      type: Number,
-      default: 0
-    }
-  },
-  { _id: false }
-);
-var info_schema_default = subscriptionInfoSchema;
-
-// src/schemas/subscription/index.ts
-var subscription_default = {
-  planSchema: plan_schema_default,
-  subscriptionInfoSchema: info_schema_default
-};
-
-// src/schemas/escrow/hold.schema.ts
-var holdSchema = {
-  status: {
-    type: String,
-    enum: HOLD_STATUS_VALUES,
-    default: HOLD_STATUS.PENDING
-  },
-  heldAmount: {
-    type: Number,
-    required: false
-  },
-  releasedAmount: {
-    type: Number,
-    default: 0
-  },
-  reason: {
-    type: String,
-    enum: HOLD_REASON_VALUES,
-    required: false
-  },
-  holdUntil: {
-    type: Date,
-    required: false
-  },
-  heldAt: Date,
-  releasedAt: Date,
-  cancelledAt: Date,
-  releases: [
-    {
-      amount: Number,
-      recipientId: String,
-      recipientType: String,
-      releasedAt: Date,
-      releasedBy: String,
-      reason: String,
-      metadata: Object
-    }
-  ],
-  metadata: {
-    type: Object,
-    default: {}
-  }
-};
-var hold_schema_default = holdSchema;
-
-// src/schemas/escrow/index.ts
-var escrow_default = {
-  holdSchema: hold_schema_default
-};
-var splitSchema = new Schema(
-  {
-    type: {
-      type: String,
-      enum: SPLIT_TYPE_VALUES,
-      required: true
-    },
-    recipientId: {
-      type: String,
-      required: true
-    },
-    recipientType: {
-      type: String,
-      enum: ["platform", "organization", "user", "affiliate", "partner"],
-      required: true
-    },
-    rate: {
-      type: Number,
-      required: true,
-      min: 0,
-      max: 1
-    },
-    grossAmount: {
-      type: Number,
-      required: true,
-      min: 0
-    },
-    gatewayFeeRate: {
-      type: Number,
-      default: 0,
-      min: 0,
-      max: 1
-    },
-    gatewayFeeAmount: {
-      type: Number,
-      default: 0,
-      min: 0
-    },
-    netAmount: {
-      type: Number,
-      required: true,
-      min: 0
-    },
-    status: {
-      type: String,
-      enum: SPLIT_STATUS_VALUES,
-      default: SPLIT_STATUS.PENDING
-    },
-    dueDate: {
-      type: Date
-    },
-    paidDate: {
-      type: Date
-    },
-    payoutMethod: {
-      type: String,
-      enum: PAYOUT_METHOD_VALUES
-    },
-    payoutTransactionId: {
-      type: String
-    },
-    metadata: {
-      type: Schema.Types.Mixed,
-      default: {}
-    }
-  },
-  { _id: false }
-);
-var split_schema_default = splitSchema;
-
-// src/schemas/split/index.ts
-var split_default = {
-  splitSchema: split_schema_default
-};
-var settlementSchema = new Schema({
-  // ============ IDENTIFICATION ============
-  organizationId: {
-    type: Schema.Types.ObjectId,
-    required: true,
-    index: true
-    // The organization responsible for this payout
-  },
-  recipientId: {
-    type: Schema.Types.ObjectId,
-    required: true,
-    index: true
-    // Who receives the payout (vendor, affiliate, partner)
-  },
-  recipientType: {
-    type: String,
-    enum: ["platform", "organization", "user", "affiliate", "partner"],
-    required: true
-    // Type of recipient
-  },
-  // ============ CLASSIFICATION ============
-  type: {
-    type: String,
-    enum: SETTLEMENT_TYPE_VALUES,
-    required: true
-    // split_payout | platform_withdrawal | manual_payout | escrow_release
-  },
-  status: {
-    type: String,
-    enum: SETTLEMENT_STATUS_VALUES,
-    default: "pending",
-    index: true
-    // pending | processing | completed | failed | cancelled
-  },
-  payoutMethod: {
-    type: String,
-    enum: PAYOUT_METHOD_VALUES,
-    required: true
-    // bank_transfer | mobile_wallet | platform_balance | crypto | manual
-  },
-  // ============ AMOUNT ============
-  amount: {
-    type: Number,
-    required: true,
-    min: 0
-    // Amount in smallest currency unit (cents, paisa, etc.)
-  },
-  currency: {
-    type: String,
-    required: true,
-    default: "USD"
-    // ISO 4217 currency code
-  },
-  // ============ SOURCE LINKAGE ============
-  sourceTransactionIds: [{
-    type: Schema.Types.ObjectId,
-    ref: "Transaction"
-    // Transactions this settlement pays out from
-  }],
-  sourceSplitIds: [{
-    type: String
-    // Split IDs within transactions (if applicable)
-  }],
-  // ============ BANK TRANSFER DETAILS ============
-  bankTransferDetails: {
-    accountNumber: { type: String },
-    accountName: { type: String },
-    bankName: { type: String },
-    routingNumber: { type: String },
-    swiftCode: { type: String },
-    iban: { type: String },
-    transferReference: { type: String },
-    // Bank confirmation reference
-    transferredAt: { type: Date }
-  },
-  // ============ MOBILE WALLET DETAILS ============
-  mobileWalletDetails: {
-    provider: { type: String },
-    // bKash, Nagad, Rocket, etc.
-    phoneNumber: { type: String },
-    accountNumber: { type: String },
-    // Wallet account number
-    transactionId: { type: String },
-    // Provider transaction ID
-    transferredAt: { type: Date }
-  },
-  // ============ CRYPTO DETAILS ============
-  cryptoDetails: {
-    network: { type: String },
-    // Ethereum, Bitcoin, etc.
-    walletAddress: { type: String },
-    transactionHash: { type: String },
-    transferredAt: { type: Date }
-  },
-  // ============ PLATFORM BALANCE ============
-  platformBalanceDetails: {
-    balanceId: { type: Schema.Types.ObjectId },
-    // Reference to balance record
-    appliedAt: { type: Date }
-  },
-  // ============ DATES ============
-  scheduledAt: {
-    type: Date,
-    index: true
-    // When this payout is scheduled for
-  },
-  processedAt: {
-    type: Date
-    // When processing started
-  },
-  completedAt: {
-    type: Date
-    // When successfully completed
-  },
-  failedAt: {
-    type: Date
-    // When it failed
-  },
-  cancelledAt: {
-    type: Date
-    // When it was cancelled
-  },
-  // ============ FAILURE INFO ============
-  failureReason: {
-    type: String
-    // Human-readable failure reason
-  },
-  failureCode: {
-    type: String
-    // Machine-readable error code
-  },
-  retryCount: {
-    type: Number,
-    default: 0,
-    min: 0
-    // Number of retry attempts
-  },
-  // ============ NOTES & METADATA ============
-  notes: {
-    type: String
-    // Admin notes about this settlement
-  },
-  metadata: {
-    type: Schema.Types.Mixed,
-    default: {}
-    // Flexible metadata for app-specific data
-  }
-}, {
-  timestamps: true
-  // Adds createdAt and updatedAt
-});
-settlementSchema.index({ organizationId: 1, status: 1 });
-settlementSchema.index({ recipientId: 1, status: 1 });
-settlementSchema.index({ type: 1, status: 1, scheduledAt: 1 });
-settlementSchema.index({ sourceTransactionIds: 1 });
-settlementSchema.index({ status: 1, scheduledAt: 1 });
-
-// src/schemas/settlement/index.ts
-var settlement_default = { settlementSchema };
-
-// src/schemas/index.ts
-var schemas_default = {
-  ...transaction_default,
-  ...subscription_default,
-  ...escrow_default,
-  ...split_default,
-  ...settlement_default
-};
-
-export { baseMetadataSchema, commissionSchema, currentPaymentSchema, schemas_default as default, gatewaySchema, holdSchema, paymentDetailsSchema, paymentEntrySchema, paymentSummarySchema, planSchema, settlementSchema, splitSchema, subscriptionInfoSchema, taxBreakdownSchema, tenantSnapshotSchema };
-//# sourceMappingURL=index.js.map
-//# sourceMappingURL=index.js.map