@classytic/revenue 1.1.3 → 2.0.0

package/dist/schemas/index.mjs

@@ -1,717 +0,0 @@
-import { d as SETTLEMENT_STATUS_VALUES, i as HOLD_STATUS_VALUES, n as HOLD_REASON_VALUES, p as SETTLEMENT_TYPE_VALUES, r as HOLD_STATUS } from "../escrow.enums-CZGrrdg7.mjs";
-import { d as PLAN_KEY_VALUES, i as SPLIT_STATUS_VALUES, n as PAYOUT_METHOD_VALUES, o as SPLIT_TYPE_VALUES, p as SUBSCRIPTION_STATUS_VALUES, r as SPLIT_STATUS } from "../split.enums-BrjabxIX.mjs";
-import { o as PAYMENT_STATUS_VALUES } from "../payment.enums-tEFVa-Xp.mjs";
-import mongoose, { Schema } from "mongoose";
-
-//#region src/schemas/transaction/common.schema.ts
-/**
-* Common Transaction Schemas
-* @classytic/revenue
-*
-* Base schemas shared across transaction types
-*/
-/**
-* Base metadata schema for transactions
-*/
-const baseMetadataSchema = new Schema({}, {
-	_id: false,
-	strict: false
-});
-
-//#endregion
-//#region src/schemas/transaction/gateway.schema.ts
-/**
-* Gateway Schema
-* @classytic/revenue
-*
-* Schema for payment gateway information
-*/
-/**
-* Gateway Schema - Embedded in Transaction
-* Tracks payment gateway details
-*/
-const 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 });
-
-//#endregion
-//#region src/schemas/transaction/payment.schema.ts
-/**
-* Payment Schemas for Transaction Model
-* @classytic/revenue
-*
-* Schemas for payment tracking in transactions
-*/
-/**
-* Individual Payment Entry Schema
-* For split/multi-payment scenarios (e.g., cash + bank + mobile wallet)
-*
-* Use in currentPaymentSchema.payments array
-*/
-const 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 }
-}, { _id: false });
-/**
-* Current Payment Schema
-* Use this in your model: currentPayment: { type: currentPaymentSchema }
-*
-* Tracks the latest payment transaction for an entity
-* Supports both single payments and multi-payment (split) scenarios
-*/
-const currentPaymentSchema = new Schema({
-	transactionId: {
-		type: Schema.Types.ObjectId,
-		ref: "Transaction"
-	},
-	amount: {
-		type: Number,
-		min: 0
-	},
-	status: {
-		type: String,
-		enum: PAYMENT_STATUS_VALUES,
-		default: "pending"
-	},
-	method: { type: String },
-	reference: {
-		type: String,
-		trim: true
-	},
-	payments: {
-		type: [paymentEntrySchema],
-		default: void 0
-	},
-	verifiedAt: { type: Date },
-	verifiedBy: {
-		type: Schema.Types.ObjectId,
-		ref: "User"
-	}
-}, { _id: false });
-/**
-* Payment Summary Schema
-* Use this in your model: paymentSummary: { type: paymentSummarySchema }
-*
-* Tracks payment history and totals
-*/
-const 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 });
-/**
-* Payment Details Schema (for manual payments)
-* Embedded in Transaction model
-*/
-const 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 });
-/**
-* Tenant Snapshot Schema
-* Captures organization payment details at transaction time (audit trail)
-*/
-const 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
-};
-
-//#endregion
-//#region src/schemas/transaction/commission.schema.ts
-/**
-* Commission Schema
-* @classytic/revenue
-*
-* Schema for platform commission tracking
-* Embedded in Transaction model
-*/
-/**
-* Commission Schema - Embedded in Transaction
-* Tracks platform commission with gateway fee deduction
-*
-* Usage: commission: commissionSchema
-*/
-const commissionSchema = new Schema({
-	rate: {
-		type: Number,
-		min: 0,
-		max: 1
-	},
-	grossAmount: {
-		type: Number,
-		min: 0
-	},
-	gatewayFeeRate: {
-		type: Number,
-		min: 0,
-		max: 1
-	},
-	gatewayFeeAmount: {
-		type: Number,
-		min: 0
-	},
-	netAmount: {
-		type: Number,
-		min: 0
-	},
-	status: {
-		type: String,
-		enum: [
-			"pending",
-			"paid",
-			"waived",
-			"reversed"
-		],
-		default: "pending"
-	},
-	affiliate: {
-		recipientId: String,
-		recipientType: {
-			type: String,
-			enum: [
-				"user",
-				"organization",
-				"partner"
-			]
-		},
-		rate: Number,
-		grossAmount: Number,
-		netAmount: Number
-	},
-	splits: [{
-		type: String,
-		recipientId: String,
-		rate: Number,
-		grossAmount: Number,
-		netAmount: Number
-	}]
-}, { _id: false });
-
-//#endregion
-//#region src/schemas/transaction/tax.schema.ts
-/**
-* Tax Schema
-* @classytic/revenue
-*
-* Mongoose schema for tax breakdown in transactions
-*/
-/**
-* Tax Breakdown Schema
-* Embed this in Transaction model to track tax
-*
-* @example
-* ```typescript
-* import mongoose from 'mongoose';
-* import { taxBreakdownSchema } from '@classytic/revenue/schemas';
-*
-* const transactionSchema = new mongoose.Schema({
-*   amount: Number,
-*   tax: taxBreakdownSchema,  // Add tax tracking
-*   // ... other fields
-* });
-* ```
-*/
-const taxBreakdownSchema = new Schema({
-	isApplicable: {
-		type: Boolean,
-		default: false
-	},
-	rate: {
-		type: Number,
-		default: 0,
-		min: 0,
-		max: 1
-	},
-	baseAmount: {
-		type: Number,
-		default: 0,
-		min: 0
-	},
-	taxAmount: {
-		type: Number,
-		default: 0,
-		min: 0
-	},
-	totalAmount: {
-		type: Number,
-		default: 0,
-		min: 0
-	},
-	pricesIncludeTax: { type: Boolean },
-	type: {
-		type: String,
-		enum: [
-			"collected",
-			"paid",
-			"exempt"
-		]
-	}
-}, { _id: false });
-
-//#endregion
-//#region src/schemas/transaction/index.ts
-var transaction_default = {
-	baseMetadataSchema,
-	gatewaySchema,
-	commissionSchema,
-	taxBreakdownSchema,
-	...payment_schema_default
-};
-
-//#endregion
-//#region src/schemas/subscription/plan.schema.ts
-/**
-* Plan Schema
-* @classytic/revenue
-*
-* Schema for subscription plans
-*/
-/**
-* Plan Schema - for defining subscription plans
-*/
-const 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 });
-
-//#endregion
-//#region src/schemas/subscription/info.schema.ts
-/**
-* Subscription Info Schema
-* @classytic/revenue
-*
-* Schema for subscription information embedded in entities
-*/
-/**
-* Subscription Info Schema
-* Use this in your entity models that have subscriptions
-*
-* @example
-* const OrganizationSchema = new Schema({
-*   name: String,
-*   subscription: { type: subscriptionInfoSchema },
-* });
-*/
-const 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 });
-
-//#endregion
-//#region src/schemas/subscription/index.ts
-var subscription_default = {
-	planSchema,
-	subscriptionInfoSchema
-};
-
-//#endregion
-//#region src/schemas/escrow/hold.schema.ts
-/**
-* Hold/Escrow Schema
-* @classytic/revenue
-*
-* Schema for platform-as-intermediary escrow flow
-* Spread into transaction schema when needed
-*/
-const 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: {}
-	}
-};
-
-//#endregion
-//#region src/schemas/escrow/index.ts
-var escrow_default = { holdSchema };
-
-//#endregion
-//#region src/schemas/split/split.schema.ts
-/**
-* Split Schema
-* @classytic/revenue
-*
-* Schema for multi-party commission splits
-*/
-/**
-* Split Schema - Embedded in Transaction
-*/
-const 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 });
-
-//#endregion
-//#region src/schemas/split/index.ts
-var split_default = { splitSchema };
-
-//#endregion
-//#region src/schemas/settlement/settlement.schema.ts
-/**
-* Settlement Schema
-* @classytic/revenue
-*
-* Mongoose schema for settlement/payout tracking
-*/
-/**
-* Settlement Schema
-* Tracks payouts from platform to vendors/affiliates/partners
-*
-* Use in your Settlement model:
-* ```typescript
-* import mongoose from 'mongoose';
-* import { settlementSchema } from '@classytic/revenue/schemas';
-*
-* const Settlement = mongoose.model('Settlement', settlementSchema);
-* ```
-*/
-const settlementSchema = new Schema({
-	organizationId: {
-		type: Schema.Types.ObjectId,
-		required: true,
-		index: true
-	},
-	recipientId: {
-		type: Schema.Types.ObjectId,
-		required: true,
-		index: true
-	},
-	recipientType: {
-		type: String,
-		enum: [
-			"platform",
-			"organization",
-			"user",
-			"affiliate",
-			"partner"
-		],
-		required: true
-	},
-	type: {
-		type: String,
-		enum: SETTLEMENT_TYPE_VALUES,
-		required: true
-	},
-	status: {
-		type: String,
-		enum: SETTLEMENT_STATUS_VALUES,
-		default: "pending",
-		index: true
-	},
-	payoutMethod: {
-		type: String,
-		enum: PAYOUT_METHOD_VALUES,
-		required: true
-	},
-	amount: {
-		type: Number,
-		required: true,
-		min: 0
-	},
-	currency: {
-		type: String,
-		required: true,
-		default: "USD"
-	},
-	sourceTransactionIds: [{
-		type: Schema.Types.ObjectId,
-		ref: "Transaction"
-	}],
-	sourceSplitIds: [{ type: String }],
-	bankTransferDetails: {
-		accountNumber: { type: String },
-		accountName: { type: String },
-		bankName: { type: String },
-		routingNumber: { type: String },
-		swiftCode: { type: String },
-		iban: { type: String },
-		transferReference: { type: String },
-		transferredAt: { type: Date }
-	},
-	mobileWalletDetails: {
-		provider: { type: String },
-		phoneNumber: { type: String },
-		accountNumber: { type: String },
-		transactionId: { type: String },
-		transferredAt: { type: Date }
-	},
-	cryptoDetails: {
-		network: { type: String },
-		walletAddress: { type: String },
-		transactionHash: { type: String },
-		transferredAt: { type: Date }
-	},
-	platformBalanceDetails: {
-		balanceId: { type: Schema.Types.ObjectId },
-		appliedAt: { type: Date }
-	},
-	scheduledAt: {
-		type: Date,
-		index: true
-	},
-	processedAt: { type: Date },
-	completedAt: { type: Date },
-	failedAt: { type: Date },
-	cancelledAt: { type: Date },
-	failureReason: { type: String },
-	failureCode: { type: String },
-	retryCount: {
-		type: Number,
-		default: 0,
-		min: 0
-	},
-	notes: { type: String },
-	metadata: {
-		type: Schema.Types.Mixed,
-		default: {}
-	}
-}, { timestamps: true });
-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
-});
-
-//#endregion
-//#region src/schemas/settlement/index.ts
-var settlement_default = { settlementSchema };
-
-//#endregion
-//#region src/schemas/index.ts
-var schemas_default = {
-	...transaction_default,
-	...subscription_default,
-	...escrow_default,
-	...split_default,
-	...settlement_default
-};
-
-//#endregion
-export { baseMetadataSchema, commissionSchema, currentPaymentSchema, schemas_default as default, gatewaySchema, holdSchema, paymentDetailsSchema, paymentEntrySchema, paymentSummarySchema, planSchema, settlementSchema, splitSchema, subscriptionInfoSchema, taxBreakdownSchema, tenantSnapshotSchema };