@classytic/revenue 0.0.1

package/schemas/subscription/index.js

@@ -0,0 +1,17 @@
+/**
+ * Subscription Schemas
+ * @classytic/revenue
+ *
+ * Re-exports all subscription-related schemas
+ */
+
+export * from './plan.schema.js';
+export * from './info.schema.js';
+
+import planSchemas from './plan.schema.js';
+import infoSchemas from './info.schema.js';
+
+export default {
+  ...planSchemas,
+  ...infoSchemas,
+};

package/schemas/subscription/info.schema.js

@@ -0,0 +1,115 @@
+/**
+ * Subscription Info Schema
+ * @classytic/revenue
+ *
+ * Complete subscription information schema
+ */
+
+import { Schema } from 'mongoose';
+import { subscriptionPlanSchema } from './plan.schema.js';
+
+/**
+ * Subscription Info Schema
+ * Use this in your model: subscription: { type: subscriptionInfoSchema }
+ *
+ * Complete subscription information
+ */
+export const subscriptionInfoSchema = new Schema({
+  isActive: {
+    type: Boolean,
+    default: false,
+    index: true
+  },
+  plan: {
+    type: subscriptionPlanSchema,
+    required: true
+  },
+  startDate: {
+    type: Date,
+    index: true
+  },
+  endDate: {
+    type: Date,
+    index: true
+  },
+  autoRenew: {
+    type: Boolean,
+    default: true
+  },
+  renewalCount: {
+    type: Number,
+    default: 0,
+    min: 0
+  },
+
+  // Cancellation
+  canceledAt: {
+    type: Date
+  },
+  cancelAt: {
+    type: Date
+  },
+  cancellationReason: {
+    type: String
+  },
+
+  // Pause/Resume
+  pausedAt: {
+    type: Date
+  },
+  pauseReason: {
+    type: String
+  },
+
+  // Scheduled Plan Changes (Upgrade/Downgrade)
+  scheduledChange: {
+    type: new Schema({
+      // New plan details
+      newPlan: {
+        type: subscriptionPlanSchema,
+        required: true
+      },
+      // When the change takes effect
+      effectiveDate: {
+        type: Date,
+        required: true
+      },
+      // Type of change
+      changeType: {
+        type: String,
+        enum: ['upgrade', 'downgrade'],
+        required: true
+      },
+      // Scheduled date
+      scheduledAt: {
+        type: Date,
+        default: Date.now
+      },
+      // Optional admin price override (for upgrades)
+      priceOverride: {
+        type: Number,
+        min: 0
+      },
+      // Who scheduled the change
+      scheduledBy: {
+        type: Schema.Types.ObjectId,
+        ref: 'User'
+      },
+      // Calculation details (for audit trail)
+      calculation: {
+        type: Schema.Types.Mixed
+      }
+    }, { _id: false }),
+    default: null
+  },
+
+  // Metadata
+  metadata: {
+    type: Schema.Types.Mixed,
+    default: {}
+  },
+}, { _id: false });
+
+export default {
+  subscriptionInfoSchema,
+};

package/schemas/subscription/plan.schema.js

@@ -0,0 +1,48 @@
+/**
+ * Subscription Plan Schema
+ * @classytic/revenue
+ *
+ * Schema for subscription plan definitions
+ */
+
+import { Schema } from 'mongoose';
+import { PLAN_KEY_VALUES } from '../../enums/index.js';
+
+/**
+ * Subscription Plan Schema
+ * Embedded in subscription info
+ */
+export const subscriptionPlanSchema = new Schema({
+  key: {
+    type: String,
+    required: true,
+    enum: PLAN_KEY_VALUES,
+  },
+  label: {
+    type: String,
+    required: true,
+  },
+  duration: {
+    type: Number,
+    required: true,
+    min: 1,
+  },
+  durationUnit: {
+    type: String,
+    default: 'days',
+  },
+  price: {
+    type: Number,
+    required: true,
+    min: 0,
+  },
+  discount: {
+    type: Number,
+    default: 0,
+    min: 0,
+  },
+}, { _id: false });
+
+export default {
+  subscriptionPlanSchema,
+};

package/schemas/transaction/common.schema.js

@@ -0,0 +1,22 @@
+/**
+ * Common Transaction Fields
+ * @classytic/revenue
+ *
+ * Common field definitions for transaction-related models
+ */
+
+/**
+ * Common Field Definitions
+ * Use these for consistent field definitions across models
+ */
+export const commonFields = {
+  isNewRequest: {
+    type: Boolean,
+    default: false,
+    index: true,
+  },
+};
+
+export default {
+  commonFields,
+};

package/schemas/transaction/gateway.schema.js

@@ -0,0 +1,69 @@
+/**
+ * Gateway and Commission Schemas
+ * @classytic/revenue
+ *
+ * Schemas for payment gateway and commission tracking
+ */
+
+import { Schema } from 'mongoose';
+import { PAYMENT_GATEWAY_TYPE_VALUES } from '../../enums/index.js';
+
+/**
+ * Gateway Schema
+ * For payment gateway integration details
+ */
+export const gatewaySchema = new Schema({
+  type: {
+    type: String,
+    enum: PAYMENT_GATEWAY_TYPE_VALUES,
+    default: 'manual'
+  },
+  paymentIntentId: { type: String },
+  sessionId: { type: String },
+  paymentUrl: { type: String },
+  expiresAt: { type: Date },
+  metadata: { type: Schema.Types.Mixed },
+}, { _id: false });
+
+/**
+ * Commission Schema
+ * Commission tracking for marketplace transactions
+ */
+export 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', 'due', 'paid', 'waived'],
+    default: 'pending'
+  },
+  dueDate: { type: Date },
+  paidDate: { type: Date },
+  paidBy: { type: Schema.Types.ObjectId, ref: 'User' },
+  notes: { type: String },
+}, { _id: false });
+
+export default {
+  gatewaySchema,
+  commissionSchema,
+};

package/schemas/transaction/index.js

@@ -0,0 +1,20 @@
+/**
+ * Transaction Schemas
+ * @classytic/revenue
+ *
+ * Re-exports all transaction-related schemas
+ */
+
+export * from './payment.schema.js';
+export * from './gateway.schema.js';
+export * from './common.schema.js';
+
+import paymentSchemas from './payment.schema.js';
+import gatewaySchemas from './gateway.schema.js';
+import commonSchemas from './common.schema.js';
+
+export default {
+  ...paymentSchemas,
+  ...gatewaySchemas,
+  ...commonSchemas,
+};

package/schemas/transaction/payment.schema.js

@@ -0,0 +1,110 @@
+/**
+ * Payment Schemas for Transaction Model
+ * @classytic/revenue
+ *
+ * Schemas for payment tracking in transactions
+ */
+
+import { Schema } from 'mongoose';
+import {
+  PAYMENT_STATUS,
+  PAYMENT_STATUS_VALUES,
+} from '../../enums/index.js';
+
+/**
+ * Current Payment Schema
+ * Use this in your model: currentPayment: { type: currentPaymentSchema }
+ *
+ * Tracks the latest payment transaction for an entity
+ */
+export const currentPaymentSchema = new Schema({
+  transactionId: {
+    type: Schema.Types.ObjectId,
+    ref: 'Transaction',
+    index: true
+  },
+  amount: {
+    type: Number,
+    min: 0
+  },
+  status: {
+    type: String,
+    enum: PAYMENT_STATUS_VALUES,
+    default: 'pending',
+    index: true
+  },
+  method: {
+    type: String,
+    // Users define payment methods in their transaction model
+  },
+  reference: {
+    type: String,
+    trim: true
+  },
+  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
+ */
+export 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
+ */
+export 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)
+ */
+export const tenantSnapshotSchema = new Schema({
+  paymentInstructions: { type: String },
+  bkashNumber: { type: String },
+  nagadNumber: { type: String },
+  bankAccount: { type: String },
+}, { _id: false });
+
+export default {
+  currentPaymentSchema,
+  paymentSummarySchema,
+  paymentDetailsSchema,
+  tenantSnapshotSchema,
+};