database-connector 2.4.3 → 2.4.5

package/CHANGELOG.md

@@ -3,6 +3,52 @@
 ## [Unreleased]
 
 ### Added
+- **PlanType Model**: Created new `PlanType` model for plan categorization and feature management
+  - Schema includes `name` (unique, required), `endDate` (optional, nullable), `active` (boolean, default: true), and `features` (Map of string keys to Mixed values - boolean or number)
+  - Features can be boolean flags (enabled/disabled) or numeric limits/quotas (e.g., maxProducts: 100)
+  - Used to categorize subscription plans and manage feature sets (lock/unlock features)
+  - Added Swagger documentation for API endpoints
+  - Indexed `active` and `name` fields for performance optimization
+  - Exported PlanType model in `models/index.js`
+  
+- **Plan Model**: Added `additionalStoreReductionPercentage` field
+  - Type: Number (default: 0, range: 0-100)
+  - Represents the percentage of reduction applied when adding additional stores to a subscription
+  - Base price is for one store; this field controls discounts for multi-store subscriptions
+  - Updated Swagger documentation to reflect new field
+
+- **ReductionOffer Model**: Added `additionalStoreReductionPercentage` field
+  - Type: Number (nullable, default: null, range: 0-100)
+  - Allows reduction offers to override the plan's additional store reduction percentage
+  - Null value means no reduction on additional stores for this offer
+  - Updated Swagger documentation to reflect new field
+
+- **User Model**: Added `preferredLang` field
+  - Type: String, enum: ['ar', 'en', 'fr'], default: 'en'
+  - Stores user's preferred language for interface and communications
+  - Updated Swagger documentation to reflect new field
+
+- **Subscription Model**: Added multiple new fields and improvements
+  - **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`
+  - `planTypeId`: ObjectId reference to PlanType model
+  - `numberOfStores`: Number (default: 1, minimum: 1) - tracks number of stores in 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
+    - Makes history tracking consistent and comprehensive
+  - Added `planTypeId` index for performance optimization
+  - Updated history snapshot builder to include all new fields including invoiceLink
+  - Updated Swagger documentation to reflect all new fields
+
+- **Order Model**: Added invoice link field
+  - `invoiceLink`: String (nullable, default: null) - link to the invoice document
+  - Updated Swagger documentation to reflect new field
+
 - **Rayon Model**: Created new independent `Rayon` model for product and store organization
   - Schema includes `name` field and `subRayons` array for hierarchical organization
   - Added `confirmed` boolean on rayon and sub-rayons (default: false)
@@ -20,6 +66,19 @@
   - Now references the `Rayon` model with support for sub-rayons (similar to `productCategorieIds` structure)
   - Structure: `{ rayonId: ObjectId, subRayons: [ObjectId] }`
 - **Database Schema Documentation**: Updated `DATABASE_SCHEMA.md`
+  - Added PlanType entity to ER diagram with relationships to Plan and Subscription models
+  - Updated PlanType to show features support both boolean and number values
+  - Added PlanType model description in Subscription & Payment Models section
+  - Updated Plan model documentation to include `additionalStoreReductionPercentage` field
+  - Updated ReductionOffer model documentation to include `additionalStoreReductionPercentage` field
+  - Updated User entity to include `preferredLang` field
+  - Updated User model description to include `preferredLang` field
+  - Updated Subscription entity to include `planTypeId`, `numberOfStores`, `billingAddress`, and `invoiceRecipient` fields
+  - Updated Subscription model description with comprehensive details on new fields and improved history tracking
+  - Added `planTypeId` to Subscription indexes section
+  - Updated subscription chain relationships to include Plan → PlanType and Subscription → PlanType
+  - Added PlanType indexes section (active, name)
+  - Updated subscription chain relationships to include Plan → PlanType
   - Added Rayon entity to ER diagram
   - Added Rayon model description in Catalog Models section
   - Updated relationship documentation to include Rayon relationships

package/models/Order.js

@@ -237,6 +237,10 @@ const { policySchema } = require('./Policy');
  *               type: string
  *             motif:
  *               type: string
+ *         invoiceLink:
+ *           type: string
+ *           nullable: true
+ *           description: Link to the invoice document
  *         status:
  *           type: string
  *           enum: [Pending, Payed, InPreparation, LoadingDelivery, OnTheWay, Delivered, AwaitingRecovery, Recovered, Reserved, WaitingForReturn, Returned, UnderRefund, Refunded, succeeded]
@@ -460,6 +464,10 @@ const orderSchema = new mongoose.Schema(
 			userId: { type: mongoose.Schema.Types.ObjectId },
 			motif: { type: String },
 		},
+		invoiceLink: {
+			type: String,
+			default: null,
+		},
 		status: {
 			type: String, required: true, enum: [
 				'Pending',

package/models/Plan.js

@@ -22,7 +22,11 @@ const mongoose = require('mongoose');
  *           description: Number of months in the plan
  *         price:
  *           type: number
- *           description: Plan price
+ *           description: Plan price for one store
+ *         additionalStoreReductionPercentage:
+ *           type: number
+ *           description: Percentage of reduction on each new store added to the subscription
+ *           default: 0
  *         reductionOffers:
  *           type: array
  *           items:
@@ -38,6 +42,7 @@ const mongoose = require('mongoose');
  *         type: "Annual"
  *         months: 12
  *         price: 99.99
+ *         additionalStoreReductionPercentage: 10
  *         status: "active"
  */
 const planSchema = new mongoose.Schema(
@@ -63,6 +68,12 @@ const planSchema = new mongoose.Schema(
 			type: Number,
 			required: true,
 		},
+		additionalStoreReductionPercentage: {
+			type: Number,
+			default: 0,
+			min: 0,
+			max: 100,
+		},
 		reductionOffers: [
 			{
 				type: mongoose.Schema.Types.ObjectId,

package/models/PlanType.js

@@ -0,0 +1,85 @@
+const mongoose = require('mongoose');
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     PlanType:
+ *       type: object
+ *       required:
+ *         - name
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The plan type identifier
+ *         name:
+ *           type: string
+ *           description: Unique name for the plan type
+ *         endDate:
+ *           type: string
+ *           format: date-time
+ *           description: Optional end date for the plan type (can be null)
+ *         active:
+ *           type: boolean
+ *           default: true
+ *           description: Whether this plan type is currently active
+ *         features:
+ *           type: object
+ *           additionalProperties:
+ *             oneOf:
+ *               - type: boolean
+ *               - type: number
+ *           description: Object with string keys and boolean or number values representing features to lock/unlock
+ *           example:
+ *             socialMedia: true
+ *             BIanalytics: false
+ *             promotionalSystem: true
+ *             maxProducts: 100
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Premium"
+ *         endDate: null
+ *         active: true
+ *         features:
+ *           socialMedia: true
+ *           BIanalytics: false
+ *           promotionalSystem: true
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
+const planTypeSchema = new mongoose.Schema(
+	{
+		name: {
+			type: String,
+			required: true,
+			unique: true,
+		},
+		endDate: {
+			type: Date,
+			required: false,
+			default: null,
+		},
+		active: {
+			type: Boolean,
+			default: true,
+		},
+		features: {
+			type: Map,
+			of: mongoose.Schema.Types.Mixed,
+			default: () => new Map(),
+		},
+	},
+	{ timestamps: true }
+);
+
+// Index for efficient queries on active plan types
+planTypeSchema.index({ active: 1 });
+planTypeSchema.index({ name: 1 });
+
+module.exports = mongoose.model('PlanType', planTypeSchema);

package/models/ReductionOffer.js

@@ -9,7 +9,6 @@ const mongoose = require('mongoose');
  *       required:
  *         - name
  *         - discount
- *         - storesNumber
  *         - plan
  *       properties:
  *         id:
@@ -21,9 +20,9 @@ const mongoose = require('mongoose');
  *         discount:
  *           type: number
  *           description: Discount amount or percentage
- *         storesNumber:
+ *         additionalStoreReductionPercentage:
  *           type: number
- *           description: Number of stores included
+ *           description: Percentage of reduction on each new store added (can be null for no reduction)
  *         plan:
  *           type: string
  *           description: Reference to the plan
@@ -53,7 +52,6 @@ const mongoose = require('mongoose');
  *         id: "507f1f77bcf86cd799439011"
  *         name: "Holiday Special"
  *         discount: 15
- *         storesNumber: 5
  *         status: "active"
  *         createdAt: "2025-11-01T10:30:00.000Z"
  *         updatedAt: "2025-12-01T15:45:00.000Z"
@@ -69,9 +67,11 @@ const ReductionOfferSchema = new mongoose.Schema(
 			type: Number,
 			required: true,
 		},
-		storesNumber: {
+		additionalStoreReductionPercentage: {
 			type: Number,
-			required: true,
+			default: null,
+			min: 0,
+			max: 100,
 		},
 		plan: {
 			type: mongoose.Schema.Types.ObjectId,

package/models/Subscription.js

@@ -3,13 +3,18 @@ const mongoose = require('mongoose');
 const buildSubscriptionHistorySnapshot = (subscriptionDoc) => ({
 	subscriptionId: subscriptionDoc._id,
 	paymentManagerId: subscriptionDoc.paymentManagerId,
-	storeId: subscriptionDoc.storeId,
+	sellerId: subscriptionDoc.sellerId,
 	planId: subscriptionDoc.planId,
+	planTypeId: subscriptionDoc.planTypeId,
 	subscriptionOfferId: subscriptionDoc.subscriptionOfferId,
 	paymentAmount: subscriptionDoc.paymentAmount,
 	paymentTypeId: subscriptionDoc.paymentTypeId,
 	paymentIntentId: subscriptionDoc.paymentIntentId,
 	reductionOfferId: subscriptionDoc.reductionOfferId,
+	numberOfStores: subscriptionDoc.numberOfStores,
+	billingAddress: subscriptionDoc.billingAddress,
+	invoiceRecipient: subscriptionDoc.invoiceRecipient,
+	invoiceLink: subscriptionDoc.invoiceLink,
 	status: subscriptionDoc.status,
 	startDate: subscriptionDoc.startDate,
 	endDate: subscriptionDoc.endDate,
@@ -48,7 +53,7 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *     Subscription:
  *       type: object
  *       required:
- *         - storeId
+ *         - sellerId
  *         - paymentAmount
  *         - startDate
  *         - endDate
@@ -59,15 +64,34 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *         paymentManagerId:
  *           type: string
  *           description: Reference to the payment manager
- *         storeId:
+ *         sellerId:
  *           type: string
- *           description: Reference to the store
+ *           description: Reference to the seller (user)
  *         planId:
  *           type: string
  *           description: Reference to the plan
+ *         planTypeId:
+ *           type: string
+ *           description: Reference to the plan type
  *         subscriptionOfferId:
  *           type: string
  *           description: Reference to subscription offer
+ *         numberOfStores:
+ *           type: number
+ *           default: 1
+ *           description: Number of stores in this subscription
+ *         billingAddress:
+ *           type: object
+ *           description: Billing address for the subscription
+ *         invoiceRecipient:
+ *           type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [Person, Company]
+ *             name:
+ *               type: string
+ *           description: Invoice recipient information (Person or Company)
  *         paymentAmount:
  *           type: number
  *           description: Payment amount
@@ -99,6 +123,10 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *           items:
  *             type: string
  *           description: Notes about the subscription
+ *         invoiceLink:
+ *           type: string
+ *           nullable: true
+ *           description: Link to the invoice document
  *         histories:
  *           type: array
  *           description: Immutable list of recorded subscription snapshots
@@ -106,7 +134,7 @@ const deleteSubscriptionHistories = async (subscriptionId) => {
  *             $ref: '#/components/schemas/SubscriptionHistory'
  *       example:
  *         id: "507f1f77bcf86cd799439011"
- *         storeId: "507f1f77bcf86cd799439012"
+ *         sellerId: "507f1f77bcf86cd799439012"
  *         planId: "507f1f77bcf86cd799439013"
  *         paymentAmount: 99.99
  *         paymentIntentId: "507f1f77bcf86cd799439099"
@@ -121,21 +149,46 @@ const subscriptionSchema = new mongoose.Schema(
 			required: false,
 			ref: 'User',
 		},
-		storeId: {
+		sellerId: {
 			type: mongoose.Schema.Types.ObjectId,
 			required: true,
-			ref: 'Store',
+			ref: 'User',
 		},
 		planId: {
 			type: mongoose.Schema.Types.ObjectId,
 			required: false,
 			ref: 'Plan',
 		},
+		planTypeId: {
+			type: mongoose.Schema.Types.ObjectId,
+			required: false,
+			ref: 'PlanType',
+		},
 		subscriptionOfferId: {
 			type: mongoose.Schema.Types.ObjectId,
 			required: false,
 			ref: 'SubscriptionOffer',
 		},
+		numberOfStores: {
+			type: Number,
+			default: 1,
+			min: 1,
+		},
+		billingAddress: {
+			type: mongoose.Schema.Types.Mixed,
+			required: false,
+		},
+		invoiceRecipient: {
+			type: {
+				type: String,
+				enum: ['Person', 'Company'],
+				required: false,
+			},
+			name: {
+				type: String,
+				required: false,
+			},
+		},
 		paymentAmount: {
 			type: Number,
 			required: true,
@@ -170,6 +223,10 @@ const subscriptionSchema = new mongoose.Schema(
 			required: true,
 		},
 		notes: [{ type: String }],
+		invoiceLink: {
+			type: String,
+			default: null,
+		},
 		histories: [
 			{
 				type: mongoose.Schema.Types.ObjectId,
@@ -180,14 +237,24 @@ const subscriptionSchema = new mongoose.Schema(
 			{
 				paymentManagerId: {
 					type: mongoose.Schema.Types.ObjectId,
-					required: true,
+					required: false,
+					ref: 'User',
+				},
+				sellerId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
 					ref: 'User',
 				},
 				planId: {
 					type: mongoose.Schema.Types.ObjectId,
-					required: true,
+					required: false,
 					ref: 'Plan',
 				},
+				planTypeId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'PlanType',
+				},
 				subscriptionOfferId: {
 					type: mongoose.Schema.Types.ObjectId,
 					required: false,
@@ -195,7 +262,41 @@ const subscriptionSchema = new mongoose.Schema(
 				},
 				paymentAmount: {
 					type: Number,
-					required: true,
+					required: false,
+				},
+				paymentTypeId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'PaymentType',
+				},
+				paymentIntentId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'Payment',
+				},
+				reductionOfferId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'ReductionOffer',
+				},
+				numberOfStores: {
+					type: Number,
+					default: 1,
+				},
+				billingAddress: {
+					type: mongoose.Schema.Types.Mixed,
+					required: false,
+				},
+				invoiceRecipient: {
+					type: {
+						type: String,
+						enum: ['Person', 'Company'],
+						required: false,
+					},
+					name: {
+						type: String,
+						required: false,
+					},
 				},
 				status: {
 					type: String,
@@ -203,27 +304,41 @@ const subscriptionSchema = new mongoose.Schema(
 				},
 				startDate: {
 					type: Date,
-					required: true,
+					required: false,
 				},
 				endDate: {
 					type: Date,
-					required: true,
+					required: false,
 				},
 				notes: [{ type: String }],
+				invoiceLink: {
+					type: String,
+					default: null,
+				},
 			},
 		],
 		upcomingSubscriptions: [
 			{
 				paymentManagerId: {
 					type: mongoose.Schema.Types.ObjectId,
-					required: true,
+					required: false,
+					ref: 'User',
+				},
+				sellerId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
 					ref: 'User',
 				},
 				planId: {
 					type: mongoose.Schema.Types.ObjectId,
-					required: true,
+					required: false,
 					ref: 'Plan',
 				},
+				planTypeId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'PlanType',
+				},
 				subscriptionOfferId: {
 					type: mongoose.Schema.Types.ObjectId,
 					required: false,
@@ -231,7 +346,41 @@ const subscriptionSchema = new mongoose.Schema(
 				},
 				paymentAmount: {
 					type: Number,
-					required: true,
+					required: false,
+				},
+				paymentTypeId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'PaymentType',
+				},
+				paymentIntentId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'Payment',
+				},
+				reductionOfferId: {
+					type: mongoose.Schema.Types.ObjectId,
+					required: false,
+					ref: 'ReductionOffer',
+				},
+				numberOfStores: {
+					type: Number,
+					default: 1,
+				},
+				billingAddress: {
+					type: mongoose.Schema.Types.Mixed,
+					required: false,
+				},
+				invoiceRecipient: {
+					type: {
+						type: String,
+						enum: ['Person', 'Company'],
+						required: false,
+					},
+					name: {
+						type: String,
+						required: false,
+					},
 				},
 				status: {
 					type: String,
@@ -239,13 +388,17 @@ const subscriptionSchema = new mongoose.Schema(
 				},
 				startDate: {
 					type: Date,
-					required: true,
+					required: false,
 				},
 				endDate: {
 					type: Date,
-					required: true,
+					required: false,
 				},
 				notes: [{ type: String }],
+				invoiceLink: {
+					type: String,
+					default: null,
+				},
 			},
 		],
 	},
@@ -290,13 +443,14 @@ subscriptionSchema.pre('deleteOne', { document: false, query: true }, async func
 });
 
 // Indexes for performance optimization
-subscriptionSchema.index({ storeId: 1 });
+subscriptionSchema.index({ sellerId: 1 });
 subscriptionSchema.index({ status: 1 });
 subscriptionSchema.index({ endDate: 1 });
 subscriptionSchema.index({ startDate: 1 });
 subscriptionSchema.index({ planId: 1 });
+subscriptionSchema.index({ planTypeId: 1 });
 subscriptionSchema.index({ paymentManagerId: 1 });
-subscriptionSchema.index({ storeId: 1, status: 1 });
+subscriptionSchema.index({ sellerId: 1, status: 1 });
 subscriptionSchema.index({ status: 1, endDate: 1 });
 
 module.exports = mongoose.model('Subscription', subscriptionSchema);

package/models/User.js

@@ -99,6 +99,11 @@ const { policySchema } = require('database-connector/models/Policy');
  *           type: number
  *           default: 20
  *           description: Proximity range in kilometers
+ *         preferredLang:
+ *           type: string
+ *           enum: [ar, en, fr]
+ *           default: en
+ *           description: User's preferred language
  *         storeCategorieIds:
  *           type: array
  *           items:
@@ -241,6 +246,11 @@ const userSchema = new mongoose.Schema(
 			type: Number,
 			default: 20,
 		},
+		preferredLang: {
+			type: String,
+			enum: ['ar', 'en', 'fr'],
+			default: 'en',
+		},
 		storeCategorieIds: [
 			{
 				type: mongoose.Schema.Types.ObjectId,

package/models/index.js

@@ -52,6 +52,7 @@ const StoreRate = require('./StoreRate');
 const SubscriptionHistory = require('./SubscriptionHistory');
 const Subscription = require('./Subscription');
 const Plan = require('./Plan');
+const PlanType = require('./PlanType');
 const SubscriptionOffer = require('./SubscriptionOffer');
 const FlashDeal = require('./FlashDeal');
 const Notification = require('./Notification');
@@ -94,6 +95,7 @@ module.exports = {
     SubscriptionHistory,
     Subscription,
     Plan,
+    PlanType,
     SubscriptionOffer,
     UserAction,
     Advertisement,

package/package.json

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