database-connector 2.5.15 → 2.5.17

package/CHANGELOG.md

@@ -1,111 +1,9 @@
 # Changelog - Database Connector Models Refactoring
 
-## [Unreleased]
-
-### Changed
-- **Categorization Hierarchy Restructure**: Refactored category models to implement new hierarchy: StoreCategory → Rayon → Sub-rayon → Category → Sub-category
-  - **StoreCategory Model**: Removed `rayonId` field as StoreCategory is now the top-level category
-  - **Rayon Model**: Added `storeCategoryId` field (required) to associate rayons with store categories
-  - **Category Model**: Added `rayonId` field (required) to associate categories with rayons or sub-rayons
-  - **Product Model**: Maintains `storeCategoryId`, `categoryId`, `subCategoryId`, `rayonId`, and `subRayonId` for full hierarchy tracking
-  - Updated Swagger documentation for all affected models
-  - Updated DATABASE_SCHEMA.md to reflect new relationships in ER diagram
-
-### 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`
-  - **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, 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
-  - 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)
-  - Added Swagger documentation for API endpoints
-  - Indexed `name` field for performance optimization
-  - Exported Rayon model in `models/index.js`
-
-### Changed
-- **Product Model**: Updated `rayonId` field to reference the new `Rayon` model
-  - Changed from untyped ObjectId to proper `ref: 'Rayon'` reference
-  - Updated Swagger documentation to reflect model reference
-  - Added `subRayonId` field (ObjectId, nullable) to reference sub-rayons within Rayon model
-- **Store Model**: Refactored `storeRayons` field from embedded objects to ObjectId references
-  - Changed from array of embedded objects with `name` field to structured array with `rayonId` and `subRayons`
-  - 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
-  - Added Rayon relationships section showing connections to Product and Store models
-
 ## Database Indexes Optimization
 
 ### Added
 
-#### Added Transaction method to all models
-- Added a static `withTransaction(fn)` method to all models to facilitate running operations within MongoDB transactions. This method accepts a function `fn` that contains the operations to be executed in a transaction.
-
 #### Database Indexes for Performance Optimization
 
 After comprehensive analysis of model usage across all microservices (AuthService, CartService, CategoryService, NotificationService, OfferService, OrderService, ProductService, SalesAnalyticsService, SearchExplorationService, StoreService, SubscriptionService, and UserService), the following database indexes have been added to optimize query performance:
@@ -234,8 +132,7 @@ 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
-  - `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.
+- **Justification:** SubscriptionService queries subscriptions by store, status, and expiration dates. Compound indexes optimize active subscription monitoring and store subscription management.
 
 **13. UserAction Model** (`UserAction.js`)
 - **Indexes Added:**

package/models/Payment.js

@@ -32,6 +32,7 @@ const mongoose = require('mongoose');
  *           type: string
  *           description: Status of the payment
  *           enum:
+ *             - requested
  *             - pending
  *             - processing
  *             - completed
@@ -94,7 +95,7 @@ const paymentSchema = new mongoose.Schema(
 		paymentStatus: {
 			type: String,
 			required: true,
-			enum: ['pending', 'processing', 'completed', 'failed', 'refunded'],
+			enum: ['requested', 'pending', 'processing', 'completed', 'failed', 'refunded'],
 			default: 'pending',
 		},
 		paymentAmount: {

package/models/Settings.js

@@ -22,6 +22,13 @@ const mongoose = require('mongoose');
  *           type: number
  *           default: 10
  *           description: Maximum number of stores allowed in a plan
+ *         contact_number:
+ *           type: string
+ *           description: Contact phone number for support
+ *         email:
+ *           type: string
+ *           format: email
+ *           description: Contact email address for support
  *         createdAt:
  *           type: string
  *           format: date-time
@@ -33,6 +40,8 @@ const mongoose = require('mongoose');
  *         max_pollution_threshold: 20
  *         max_targeted_users: 15
  *         max_stores_in_plan: 10
+ *         contact_number: "+213555123456"
+ *         email: "support@example.com"
  *         createdAt: "2025-11-01T10:30:00.000Z"
  *         updatedAt: "2025-12-01T15:45:00.000Z"
  */
@@ -50,6 +59,14 @@ const SettingsSchema = new mongoose.Schema(
 			type: Number,
 			default: 10,
 		},
+		contact_number: {
+			type: String,
+			default: null,
+		},
+		email: {
+			type: String,
+			default: null,
+		},
 	},
 	{
 		timestamps: true,

package/package.json

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