database-connector 2.2.1 → 2.2.3

package/models/Store.js

@@ -87,6 +87,22 @@ const { getBaseURL, getDefaultStoreImagePath } = require('../config');
  *         subscriptionId:
  *           type: string
  *           description: Reference to subscription
+ *         reports:
+ *           type: array
+ *           items:
+ *             type: object
+ *             properties:
+ *               idUser:
+ *                 type: string
+ *                 description: Reference to user who reported
+ *               message:
+ *                 type: string
+ *                 description: Report message
+ *               date:
+ *                 type: string
+ *                 format: date-time
+ *                 description: Report date
+ *           description: Store reports
  *         createdAt:
  *           type: string
  *           format: date-time
@@ -339,6 +355,19 @@ const storeSchema = new mongoose.Schema(
 			type: mongoose.Schema.Types.ObjectId,
 			ref: 'Subscription',
 		},
+		reports: [
+			{
+				idUser: {
+					type: mongoose.Schema.Types.ObjectId,
+					ref: 'User',
+				},
+				message: { type: String },
+				date: {
+					type: Date,
+					required: true,
+				},
+			},
+		],
 	},
 
 	{ timestamps: true, toJSON: { virtuals: true } }

package/models/Subscription.js

@@ -1,5 +1,46 @@
 const mongoose = require('mongoose');
 
+const buildSubscriptionHistorySnapshot = (subscriptionDoc) => ({
+	subscriptionId: subscriptionDoc._id,
+	paymentManagerId: subscriptionDoc.paymentManagerId,
+	storeId: subscriptionDoc.storeId,
+	planId: subscriptionDoc.planId,
+	subscriptionOfferId: subscriptionDoc.subscriptionOfferId,
+	paymentAmount: subscriptionDoc.paymentAmount,
+	paymentTypeId: subscriptionDoc.paymentTypeId,
+	paymentIntentId: subscriptionDoc.paymentIntentId,
+	reductionOfferId: subscriptionDoc.reductionOfferId,
+	status: subscriptionDoc.status,
+	startDate: subscriptionDoc.startDate,
+	endDate: subscriptionDoc.endDate,
+	notes: subscriptionDoc.notes,
+});
+
+const recordSubscriptionHistory = async (subscriptionDoc) => {
+	if (!subscriptionDoc) return;
+
+	// Lazy-load to avoid require ordering issues
+	// eslint-disable-next-line global-require
+	const SubscriptionHistory = require('./SubscriptionHistory');
+
+	const history = await SubscriptionHistory.create(
+		buildSubscriptionHistorySnapshot(subscriptionDoc)
+	);
+
+	await subscriptionDoc.updateOne(
+		{ $push: { histories: history._id } },
+		{ skipHistory: true }
+	);
+};
+
+const deleteSubscriptionHistories = async (subscriptionId) => {
+	if (!subscriptionId) return;
+	// Lazy-load to avoid require ordering issues
+	// eslint-disable-next-line global-require
+	const SubscriptionHistory = require('./SubscriptionHistory');
+	await SubscriptionHistory.deleteMany({ subscriptionId });
+};
+
 /**
  * @swagger
  * components:
@@ -58,6 +99,11 @@ const mongoose = require('mongoose');
  *           items:
  *             type: string
  *           description: Notes about the subscription
+ *         histories:
+ *           type: array
+ *           description: Immutable list of recorded subscription snapshots
+ *           items:
+ *             $ref: '#/components/schemas/SubscriptionHistory'
  *       example:
  *         id: "507f1f77bcf86cd799439011"
  *         storeId: "507f1f77bcf86cd799439012"
@@ -124,6 +170,12 @@ const subscriptionSchema = new mongoose.Schema(
 			required: true,
 		},
 		notes: [{ type: String }],
+		histories: [
+			{
+				type: mongoose.Schema.Types.ObjectId,
+				ref: 'SubscriptionHistory',
+			},
+		],
 		subscriptionsHistory: [
 			{
 				paymentManagerId: {
@@ -200,6 +252,43 @@ const subscriptionSchema = new mongoose.Schema(
 	{ toJSON: { virtuals: true } }
 );
 
+// Auto-record history snapshots
+subscriptionSchema.post('save', async function (doc) {
+	await recordSubscriptionHistory(doc);
+});
+
+subscriptionSchema.post('findOneAndUpdate', async function () {
+	if (this.getOptions && this.getOptions().skipHistory) return;
+	const updatedDoc = await this.model.findOne(this.getQuery());
+	await recordSubscriptionHistory(updatedDoc);
+});
+
+subscriptionSchema.post('updateOne', async function () {
+	if (this.getOptions && this.getOptions().skipHistory) return;
+	const updatedDoc = await this.model.findOne(this.getQuery());
+	await recordSubscriptionHistory(updatedDoc);
+});
+
+// Cascade delete: remove all histories when a subscription is deleted
+subscriptionSchema.pre('deleteOne', { document: true, query: false }, async function () {
+	await deleteSubscriptionHistories(this._id);
+});
+
+subscriptionSchema.post('findOneAndDelete', async function (doc) {
+	if (!doc) return;
+	await deleteSubscriptionHistories(doc._id);
+});
+
+subscriptionSchema.pre('deleteOne', { document: false, query: true }, async function () {
+	const filter = this.getFilter();
+	const docs = await this.model.find(filter).select('_id');
+	if (!docs || docs.length === 0) return;
+	const ids = docs.map((d) => d._id);
+	// eslint-disable-next-line global-require
+	const SubscriptionHistory = require('./SubscriptionHistory');
+	await SubscriptionHistory.deleteMany({ subscriptionId: { $in: ids } });
+});
+
 // Indexes for performance optimization
 subscriptionSchema.index({ storeId: 1 });
 subscriptionSchema.index({ status: 1 });

package/models/SubscriptionHistory.js

@@ -0,0 +1,152 @@
+const mongoose = require('mongoose');
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     SubscriptionHistory:
+ *       type: object
+ *       required:
+ *         - subscriptionId
+ *         - storeId
+ *         - paymentAmount
+ *         - startDate
+ *         - endDate
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The subscription history identifier
+ *         subscriptionId:
+ *           type: string
+ *           description: Reference to the subscription
+ *         paymentManagerId:
+ *           type: string
+ *           description: Reference to the payment manager
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         planId:
+ *           type: string
+ *           description: Reference to the plan
+ *         subscriptionOfferId:
+ *           type: string
+ *           description: Reference to subscription offer
+ *         paymentAmount:
+ *           type: number
+ *           description: Payment amount
+ *         paymentTypeId:
+ *           type: string
+ *           description: Reference to payment type
+ *         paymentIntentId:
+ *           type: string
+ *           nullable: true
+ *           description: Reference to payment intent (can be null)
+ *         reductionOfferId:
+ *           type: string
+ *           description: Reference to reduction offer
+ *         status:
+ *           type: string
+ *           enum: [inactive, active, delayed, suspended, upcoming, deleted]
+ *           description: Subscription status at this point in time
+ *         startDate:
+ *           type: string
+ *           format: date-time
+ *           description: Subscription start date
+ *         endDate:
+ *           type: string
+ *           format: date-time
+ *           description: Subscription end date
+ *         notes:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Notes about the subscription
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *           description: When this history snapshot was recorded
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439111"
+ *         subscriptionId: "507f1f77bcf86cd799439011"
+ *         storeId: "507f1f77bcf86cd799439012"
+ *         planId: "507f1f77bcf86cd799439013"
+ *         paymentAmount: 99.99
+ *         status: "active"
+ *         startDate: "2025-12-01T00:00:00.000Z"
+ *         endDate: "2026-12-01T00:00:00.000Z"
+ *         createdAt: "2025-12-05T10:30:00.000Z"
+ */
+
+const subscriptionHistorySchema = new mongoose.Schema(
+	{
+		subscriptionId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: true,
+			ref: 'Subscription',
+			index: true,
+		},
+		paymentManagerId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'User',
+		},
+		storeId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: true,
+			ref: 'Store',
+		},
+		planId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'Plan',
+		},
+		subscriptionOfferId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'SubscriptionOffer',
+		},
+		paymentAmount: {
+			type: Number,
+			required: true,
+		},
+		paymentTypeId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'PaymentType',
+		},
+		paymentIntentId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'Payment',
+			default: null,
+		},
+		reductionOfferId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'ReductionOffer',
+		},
+		status: {
+			type: String,
+			enum: ['inactive', 'active', 'delayed', 'suspended', 'upcoming', 'deleted'],
+			required: false,
+		},
+		startDate: {
+			type: Date,
+			required: true,
+		},
+		endDate: {
+			type: Date,
+			required: true,
+		},
+		notes: [{ type: String }],
+	},
+	{ timestamps: true, toJSON: { virtuals: true } }
+);
+
+subscriptionHistorySchema.index({ subscriptionId: 1, createdAt: -1 });
+subscriptionHistorySchema.index({ storeId: 1, createdAt: -1 });
+
+module.exports = mongoose.model('SubscriptionHistory', subscriptionHistorySchema);

package/models/index.js

@@ -28,6 +28,7 @@ const Offer = require('./Offer');
 const Category = require('./Category');
 const ResetPassword = require('./ResetPassword');
 const StoreRate = require('./StoreRate');
+const SubscriptionHistory = require('./SubscriptionHistory');
 const Subscription = require('./Subscription');
 const Plan = require('./Plan');
 const SubscriptionOffer = require('./SubscriptionOffer');
@@ -65,6 +66,7 @@ module.exports = {
     Category,
     ResetPassword,
     StoreRate,
+    SubscriptionHistory,
     Subscription,
     Plan,
     SubscriptionOffer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "database-connector",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "MongoDB models package with Mongoose schemas for e-commerce applications. Includes User, Product, Store, Order and more with built-in validation and virtual properties.",
   "main": "models/index.js",
   "scripts": {