database-connector 2.4.5 → 2.4.7

package/CHANGELOG.md

@@ -32,14 +32,20 @@
   - **BREAKING CHANGE**: Changed `storeId` to `sellerId` - now references User (seller) instead of Store
     - Updated all occurrences in main schema, subscriptionsHistory, and upcomingSubscriptions
     - Updated indexes to use `sellerId` instead of `storeId`
-    - Updated history snapshot builder to track `sellerId`
+  - **BREAKING CHANGE**: Removed `histories` field and SubscriptionHistory collection tracking
+    - Simplified to use only embedded `subscriptionsHistory` array
+    - Automatic history snapshot creation now pushes to embedded subscriptionsHistory array on save/update
+    - History snapshots include all subscription fields (sellerId, planId, planTypeId, paymentTypeId, paymentIntentId, reductionOfferId, numberOfStores, billingAddress, invoiceRecipient, invoiceLink, status, dates, notes)
+    - Removed cascade delete logic (embedded arrays are deleted automatically with parent document)
+    - All history tracking done via embedded subscriptionsHistory and upcomingSubscriptions arrays
   - `planTypeId`: ObjectId reference to PlanType model
   - `numberOfStores`: Number (default: 1, minimum: 1) - tracks number of stores in subscription
+  - `stores`: Array of ObjectIds referencing Store - tracks which specific stores are included in this subscription
   - `billingAddress`: Mixed object for billing address (Adresse de facturation)
   - `invoiceRecipient`: Object with type (Person/Company enum) and name fields (Facture au nom de)
   - `invoiceLink`: String (nullable, default: null) - link to the invoice document
   - Updated `subscriptionsHistory` and `upcomingSubscriptions` arrays to include complete subscription snapshots
-    - Both now include all fields: storeId, planId, planTypeId, paymentTypeId, paymentIntentId, reductionOfferId, numberOfStores, billingAddress, invoiceRecipient, invoiceLink
+    - Both now include all fields: storeId, planId, planTypeId, paymentTypeId, paymentIntentId, reductionOfferId, numberOfStores, stores, billingAddress, invoiceRecipient, invoiceLink
     - Makes history tracking consistent and comprehensive
   - Added `planTypeId` index for performance optimization
   - Updated history snapshot builder to include all new fields including invoiceLink
@@ -219,7 +225,8 @@ After comprehensive analysis of model usage across all microservices (AuthServic
   - `paymentManagerId`: For payment manager tracking
   - `storeId, status` (compound): For store subscription status
   - `status, endDate` (compound): For active subscription expiration monitoring
-- **Justification:** SubscriptionService queries subscriptions by store, status, and expiration dates. Compound indexes optimize active subscription monitoring and store subscription management.
+  - `stores`: For queries filtering by specific stores in the subscription
+- **Justification:** SubscriptionService queries subscriptions by store, status, and expiration dates. Compound indexes optimize active subscription monitoring and store subscription management. The stores index enables efficient queries to find subscriptions containing specific stores.
 
 **13. UserAction Model** (`UserAction.js`)
 - **Indexes Added:**

package/models/Subscription.js

@@ -1,7 +1,6 @@
 const mongoose = require('mongoose');
 
 const buildSubscriptionHistorySnapshot = (subscriptionDoc) => ({
-	subscriptionId: subscriptionDoc._id,
 	paymentManagerId: subscriptionDoc.paymentManagerId,
 	sellerId: subscriptionDoc.sellerId,
 	planId: subscriptionDoc.planId,
@@ -12,6 +11,7 @@ const buildSubscriptionHistorySnapshot = (subscriptionDoc) => ({
 	paymentIntentId: subscriptionDoc.paymentIntentId,
 	reductionOfferId: subscriptionDoc.reductionOfferId,
 	numberOfStores: subscriptionDoc.numberOfStores,
+	stores: subscriptionDoc.stores,
 	billingAddress: subscriptionDoc.billingAddress,
 	invoiceRecipient: subscriptionDoc.invoiceRecipient,
 	invoiceLink: subscriptionDoc.invoiceLink,
@@ -24,28 +24,14 @@ const buildSubscriptionHistorySnapshot = (subscriptionDoc) => ({
 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)
-	);
+	const historySnapshot = buildSubscriptionHistorySnapshot(subscriptionDoc);
 
 	await subscriptionDoc.updateOne(
-		{ $push: { histories: history._id } },
+		{ $push: { subscriptionsHistory: historySnapshot } },
 		{ 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:
@@ -80,6 +66,11 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *           type: number
  *           default: 1
  *           description: Number of stores in this subscription
+ *         stores:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Array of store IDs included in this subscription
  *         billingAddress:
  *           type: object
  *           description: Billing address for the subscription
@@ -127,11 +118,16 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *           type: string
  *           nullable: true
  *           description: Link to the invoice document
- *         histories:
+ *         subscriptionsHistory:
+ *           type: array
+ *           description: Embedded array of historical subscription snapshots
+ *           items:
+ *             type: object
+ *         upcomingSubscriptions:
  *           type: array
- *           description: Immutable list of recorded subscription snapshots
+ *           description: Embedded array of upcoming subscription configurations
  *           items:
- *             $ref: '#/components/schemas/SubscriptionHistory'
+ *             type: object
  *       example:
  *         id: "507f1f77bcf86cd799439011"
  *         sellerId: "507f1f77bcf86cd799439012"
@@ -174,6 +170,15 @@ const subscriptionSchema = new mongoose.Schema(
 			default: 1,
 			min: 1,
 		},
+		stores: {
+			type: [
+				{
+					type: mongoose.Schema.Types.ObjectId,
+					ref: 'Store',
+				},
+			],
+			default: [],
+		},
 		billingAddress: {
 			type: mongoose.Schema.Types.Mixed,
 			required: false,
@@ -227,12 +232,6 @@ const subscriptionSchema = new mongoose.Schema(
 			type: String,
 			default: null,
 		},
-		histories: [
-			{
-				type: mongoose.Schema.Types.ObjectId,
-				ref: 'SubscriptionHistory',
-			},
-		],
 		subscriptionsHistory: [
 			{
 				paymentManagerId: {
@@ -283,6 +282,15 @@ const subscriptionSchema = new mongoose.Schema(
 					type: Number,
 					default: 1,
 				},
+				stores: {
+					type: [
+						{
+							type: mongoose.Schema.Types.ObjectId,
+							ref: 'Store',
+						},
+					],
+					default: [],
+				},
 				billingAddress: {
 					type: mongoose.Schema.Types.Mixed,
 					required: false,
@@ -367,6 +375,15 @@ const subscriptionSchema = new mongoose.Schema(
 					type: Number,
 					default: 1,
 				},
+				stores: {
+					type: [
+						{
+							type: mongoose.Schema.Types.ObjectId,
+							ref: 'Store',
+						},
+					],
+					default: [],
+				},
 				billingAddress: {
 					type: mongoose.Schema.Types.Mixed,
 					required: false,
@@ -405,7 +422,7 @@ const subscriptionSchema = new mongoose.Schema(
 	{ toJSON: { virtuals: true } }
 );
 
-// Auto-record history snapshots
+// Auto-record history snapshots to embedded subscriptionsHistory array
 subscriptionSchema.post('save', async function (doc) {
 	await recordSubscriptionHistory(doc);
 });
@@ -422,26 +439,6 @@ subscriptionSchema.post('updateOne', async function () {
 	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({ sellerId: 1 });
 subscriptionSchema.index({ status: 1 });
@@ -452,5 +449,6 @@ subscriptionSchema.index({ planTypeId: 1 });
 subscriptionSchema.index({ paymentManagerId: 1 });
 subscriptionSchema.index({ sellerId: 1, status: 1 });
 subscriptionSchema.index({ status: 1, endDate: 1 });
+subscriptionSchema.index({ stores: 1 });
 
 module.exports = mongoose.model('Subscription', subscriptionSchema);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "database-connector",
-  "version": "2.4.5",
+  "version": "2.4.7",
   "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": {