database-connector 2.3.7 → 2.3.8

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog - Database Connector Models Refactoring
 
+## [Unreleased]
+
+### Added
+- **Rayon Model**: Created new independent `Rayon` model for product and store organization
+  - Schema includes `name` field and `subRayons` array for hierarchical organization
+  - 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
+- **Store Model**: Refactored `storeRayons` field from embedded objects to ObjectId references
+  - Changed from array of embedded objects with `name` field to array of ObjectId references
+  - Now references the `Rayon` model for better data normalization
+- **Database Schema Documentation**: Updated `DATABASE_SCHEMA.md`
+  - 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

package/models/Product.js

@@ -41,7 +41,7 @@ const { policySchema } = require('database-connector/models/Policy');
  *           description: Reference to sub-category
  *         rayonId:
  *           type: string
- *           description: Reference to rayon
+ *           description: Reference to Rayon model
  *         images:
  *           type: array
  *           items:
@@ -120,7 +120,8 @@ const productSchema = new mongoose.Schema(
 		},
 		rayonId: {
 			type: mongoose.Schema.Types.ObjectId,
-			required: true,
+			ref: 'Rayon',
+			// required: true,
 		},
 		//customCategory: { type: String, required: true },
 		//customCategoryId: { type: String, required: true },

package/models/Rayon.js

@@ -0,0 +1,67 @@
+const mongoose = require('mongoose');
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Rayon:
+ *       type: object
+ *       required:
+ *         - name
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The rayon identifier
+ *         name:
+ *           type: string
+ *           description: Rayon name
+ *         subRayons:
+ *           type: array
+ *           items:
+ *             type: object
+ *             properties:
+ *               name:
+ *                 type: string
+ *                 description: Sub-rayon name
+ *           description: List of sub-rayons within this rayon
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Electronics"
+ *         subRayons:
+ *           - name: "Mobile Phones"
+ *           - name: "Laptops"
+ *           - name: "Accessories"
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
+const rayonSchema = new mongoose.Schema(
+	{
+		name: {
+			type: String,
+			required: true,
+		},
+		subRayons: [
+			{
+				name: {
+					type: String,
+					required: true,
+				},
+			},
+		],
+	},
+	{
+		timestamps: true,
+		toJSON: { virtuals: true },
+	}
+);
+
+// Indexes for performance optimization
+rayonSchema.index({ name: 1 });
+
+module.exports = mongoose.model('Rayon', rayonSchema);

package/models/Store.js

@@ -342,10 +342,8 @@ const storeSchema = new mongoose.Schema(
 		],
 		storeRayons: [
 			{
-				name: {
-					type: String,
-					required: true,
-				},
+				type: mongoose.Schema.Types.ObjectId,
+				ref: 'Rayon',
 			},
 		],
 		templateId: {

package/models/index.js

@@ -63,6 +63,7 @@ const StoreCategory = require('./StoreCategory');
 const UserAction = require('./UserAction.js');
 const Advertisement = require('./Advertisement');
 const Settings = require('./Settings');
+const Rayon = require('./Rayon');
 
 
 module.exports = {
@@ -97,5 +98,6 @@ module.exports = {
     UserAction,
     Advertisement,
     Settings,
+    Rayon,
     ObjectId: mongoose.Types.ObjectId,
 };

package/package.json

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