database-connector 1.0.6 → 1.1.0

package/models/Policy.js

@@ -1,96 +1,214 @@
 const { Schema, model } = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Policy:
+ *       type: object
+ *       properties:
+ *         workingTime:
+ *           type: object
+ *           properties:
+ *             openTime:
+ *               type: string
+ *               default: ""
+ *             closeTime:
+ *               type: string
+ *               default: ""
+ *         pickup:
+ *           type: object
+ *           properties:
+ *             timeLimit:
+ *               type: number
+ *         delivery:
+ *           type: object
+ *           properties:
+ *             delivery:
+ *               type: boolean
+ *             zone:
+ *               type: object
+ *               properties:
+ *                 centerPoint:
+ *                   type: object
+ *                   properties:
+ *                     latitude:
+ *                       type: number
+ *                     longitude:
+ *                       type: number
+ *                 radius:
+ *                   type: number
+ *             pricing:
+ *               type: object
+ *               properties:
+ *                 fixe:
+ *                   type: number
+ *                 km:
+ *                   type: number
+ *         reservation:
+ *           type: object
+ *           properties:
+ *             duration:
+ *               type: number
+ *             payment:
+ *               type: object
+ *               properties:
+ *                 free:
+ *                   type: boolean
+ *                 partial:
+ *                   type: object
+ *                   properties:
+ *                     fixe:
+ *                       type: number
+ *                     percentage:
+ *                       type: number
+ *                 total:
+ *                   type: boolean
+ *             cancelation:
+ *               type: object
+ *               properties:
+ *                 restrictions:
+ *                   type: object
+ *                   properties:
+ *                     fixe:
+ *                       type: number
+ *                     percentage:
+ *                       type: number
+ *         return:
+ *           type: object
+ *           properties:
+ *             duration:
+ *               type: number
+ *             productStatus:
+ *               type: string
+ *             returnMethod:
+ *               type: string
+ *             refund:
+ *               type: object
+ *               properties:
+ *                 order:
+ *                   type: object
+ *                   properties:
+ *                     fixe:
+ *                       type: number
+ *                     percentage:
+ *                       type: number
+ *                 shipping:
+ *                   type: object
+ *                   properties:
+ *                     fixe:
+ *                       type: number
+ *                     percentage:
+ *                       type: number
+ *         order:
+ *           type: object
+ *           properties:
+ *             notification:
+ *               type: object
+ *               properties:
+ *                 realtime:
+ *                   type: boolean
+ *                 time:
+ *                   type: number
+ *                 perOrdersNbr:
+ *                   type: number
+ *                 sendMode:
+ *                   type: object
+ *                   properties:
+ *                     mail:
+ *                       type: boolean
+ *                     sms:
+ *                       type: boolean
+ *                     popup:
+ *                       type: boolean
+ *                     vibration:
+ *                       type: boolean
+ *                     ringing:
+ *                       type: boolean
+ */
 exports.policySchema = new Schema(
-	{   
-        
-        workingTime : {
-            type : {
-                openTime: { type: String  ,  default : ""},
-                closeTime: { type: String ,  default : ""} ,
-            } , 
-        },
-        pickup: { 
-            type : {
-                timeLimit : { type: Number  ,  default : null} , 
-            } , 
-        },
-        delivery: {
-            type : {
-                    delivery : {type : Boolean,  default : null } , 
-                    zone : {
-                        centerPoint : {
-                            latitude : { type : Number ,  default : null} , 
-                            longitude : { type : Number ,  default : null} , 
-                        } , 
-                        radius : { type : Number ,  default : null } , 
-                    } ,
-                    pricing : {
-                        fixe : {type : Number ,  default : null} ,
-                        km : {type : Number ,  default : null} ,
-                    } ,
-                }
-        
-            } ,
-        
-        reservation : {
-            type : {
-                duration : {type : Number ,  default : null} ,
-                payment : {
-                    free : {type : Boolean ,  default : null} ,
-                    partial : { 
-                        fixe : {type : Number ,  default : null} ,
-                        percentage : {type : Number ,  default : null} ,
-                    } ,
-                    total : {type : Boolean ,  default : null} ,
-                } ,
-                cancelation : {
-                    restrictions : {
-                        fixe : {type : Number ,  default : null} ,
-                        percentage : {type : Number ,  default : null} ,
-                    }
-                } ,
-            } , 
-        } , 
-        return : {
-            type : {
-                duration : {type : Number ,  default : null} ,
-                productStatus : {type : String ,  default : ""} ,
-                returnMethod : {type : String ,  default : ""} ,
-                refund : {
-                    order : {
-                        fixe : {type : Number ,  default : null} ,
-                        percentage : {type : Number ,  default : null} ,
-                    } , 
-                    shipping : {
-                        fixe : {type : Number ,  default : null} ,
-                        percentage : {type : Number ,  default : null} ,
-                    },
-                } , 
-            } , 
-
-        } , 
-        order : {
-            type : {
-            
-            notification : {
-                realtime :{type : Boolean ,  default : null} , 
-                time :{type : Number ,  default : null} , 
-                perOrdersNbr :{type : Number ,  default : null} , 
-                sendMode : {
-                    mail :{type : Boolean ,  default : null} , 
-                    sms :{type : Boolean ,  default : null} , 
-                    popup :{type : Boolean ,  default : null} , 
-                    vibration :{type : Boolean ,  default : null} , 
-                    ringing :{type : Boolean ,  default : null} , 
-                } ,
-            } 
-
-            }
-        }
-    },
 	{
-        
-	}
+		workingTime: {
+			type: {
+				openTime: { type: String, default: '' },
+				closeTime: { type: String, default: '' }
+			}
+		},
+		pickup: {
+			type: {
+				timeLimit: { type: Number, default: null }
+			}
+		},
+		delivery: {
+			type: {
+				delivery: { type: Boolean, default: null },
+				zone: {
+					centerPoint: {
+						latitude: { type: Number, default: null },
+						longitude: { type: Number, default: null }
+					},
+					radius: { type: Number, default: null }
+				},
+				pricing: {
+					fixe: { type: Number, default: null },
+					km: { type: Number, default: null }
+				}
+			}
+		},
+		reservation: {
+			type: {
+				duration: { type: Number, default: null },
+				payment: {
+					free: { type: Boolean, default: null },
+					partial: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null }
+					},
+					total: { type: Boolean, default: null }
+				},
+				cancelation: {
+					restrictions: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null }
+					}
+				}
+			}
+		},
+		return: {
+			type: {
+				duration: { type: Number, default: null },
+				productStatus: { type: String, default: '' },
+				returnMethod: { type: String, default: '' },
+				refund: {
+					order: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null }
+					},
+					shipping: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null }
+					}
+				}
+			}
+		},
+		order: {
+			type: {
+				notification: {
+					realtime: { type: Boolean, default: null },
+					time: { type: Number, default: null },
+					perOrdersNbr: { type: Number, default: null },
+					sendMode: {
+						mail: { type: Boolean, default: null },
+						sms: { type: Boolean, default: null },
+						popup: { type: Boolean, default: null },
+						vibration: { type: Boolean, default: null },
+						ringing: { type: Boolean, default: null }
+					}
+				}
+			}
+		}
+	},
+	{}
 );
 
-
+module.exports = model('Policy', planSchema);

package/models/Product.js

@@ -1,7 +1,100 @@
 const mongoose = require('mongoose');
-const { policySchema } = require('./Policy');
-var ObjectId = require('mongodb').ObjectID;
+const { policySchema } = require('database-connector/models/Policy');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Product:
+ *       type: object
+ *       required:
+ *         - name
+ *         - description
+ *         - price
+ *         - storeCategoryId
+ *         - categoryId
+ *         - rayonId
+ *         - sellerId
+ *         - storeId
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The product identifier
+ *         name:
+ *           type: string
+ *           description: Product name
+ *         description:
+ *           type: string
+ *           description: Product description
+ *         price:
+ *           type: number
+ *           description: Product price
+ *         storeCategoryId:
+ *           type: string
+ *           description: Reference to store category
+ *         categoryId:
+ *           type: string
+ *           description: Reference to category
+ *         subCategoryId:
+ *           type: string
+ *           description: Reference to sub-category
+ *         rayonId:
+ *           type: string
+ *           description: Reference to rayon
+ *         images:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Product images
+ *         tags:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Product tags
+ *         sellerId:
+ *           type: string
+ *           description: Reference to seller
+ *         storeId:
+ *           type: string
+ *           description: Reference to store
+ *         deleted:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the product is deleted
+ *         discount:
+ *           type: number
+ *           default: 0
+ *           description: Product discount
+ *         numberOfSales:
+ *           type: number
+ *           default: 0
+ *           description: Number of sales
+ *         numberOfViews:
+ *           type: number
+ *           default: 0
+ *           description: Number of views
+ *         averageRating:
+ *           type: number
+ *           default: 0
+ *           description: Average rating
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Wireless Headphones"
+ *         description: "High-quality wireless headphones"
+ *         price: 99.99
+ *         discount: 10
+ *         numberOfSales: 50
+ *         numberOfViews: 250
+ *         averageRating: 4.5
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const productSchema = new mongoose.Schema(
 	{
 		name: {
@@ -10,11 +103,11 @@ const productSchema = new mongoose.Schema(
 		},
 		description: { type: String, required: true },
 		price: { type: Number, required: true },
-		storeCategoryId : {
+		storeCategoryId: {
 			type: mongoose.Schema.Types.ObjectId,
 			ref: 'StoreCategory',
 			required: true,
-		} , 
+		},
 		categoryId: {
 			type: mongoose.Schema.Types.ObjectId,
 			ref: 'Category',
@@ -98,24 +191,24 @@ const productSchema = new mongoose.Schema(
 			type: mongoose.Schema.Types.ObjectId,
 			ref: 'Offer',
 		},
-		
-		
+
+
 		numberOfSales: {
 			type: Number,
 			default: 0,
-		  },
-		  numberOfViews: {
+		},
+		numberOfViews: {
 			type: Number,
 			default: 0,
-		  },
-		  numberOfSearches: {
+		},
+		numberOfSearches: {
 			type: Number,
 			default: 0,
-		  },
-		  averageRating: {
+		},
+		averageRating: {
 			type: Number,
 			default: 0,
-		  },
+		},
 
 		reports: [
 			{
@@ -135,16 +228,20 @@ const productSchema = new mongoose.Schema(
 		policy: policySchema,
 	},
 	{
-		timestamp: true,
-		toJSON: { virtuals: true },
+		timestamps: true,
+		toJSON: { virtuals: true }
 	}
-);/*
+);
+
+// Virtual properties for quantity calculations (commented out)
+/*
 productSchema.virtual('quantity').get(function () {
 	const variants = this.variants;
 	return variants.reduce(function (total, currentValue) {
 		return total + currentValue.quantity;
 	}, 0);
 });
+
 productSchema.virtual('PriceMin').get(function () {
 	const variants = this.variants;
 	return variants.reduce(function (prev, curr) {
@@ -157,8 +254,10 @@ productSchema.virtual('PriceMax').get(function () {
 	return variants.reduce(function (prev, curr) {
 		return prev.price > curr.price ? prev : curr;
 	}).price;
-});*/
-//virtual array of all the images of the product
+});
+*/
+
+// Virtual: array of all product images with full URLs
 productSchema.virtual('imagesss').get(function () {
 	if (this.images != null) {
 		const images = this.images;
@@ -169,17 +268,18 @@ productSchema.virtual('imagesss').get(function () {
 		});
 	}
 });
+
+// Virtual: discounted price
 productSchema.virtual('discounted').get(function () {
 	if (this.offer) {
-		console.log('Disount')
-	
-	  return this.offer.discount;
-	  
+		console.log('Discount');
+		return this.offer.discount;
 	} else {
-	  return this.price;
+		return this.price;
 	}
-  });
-//virtual array for all the images of the variants
+});
+
+// Virtual: array of all variant images with full URLs
 productSchema.virtual('variantImages').get(function () {
 	if (this.variants != null) {
 		const variants = this.variants;

package/models/ReductionOffer.js

@@ -1,5 +1,63 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ReductionOffer:
+ *       type: object
+ *       required:
+ *         - name
+ *         - discount
+ *         - storesNumber
+ *         - plan
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The reduction offer identifier
+ *         name:
+ *           type: string
+ *           description: Unique offer name
+ *         discount:
+ *           type: number
+ *           description: Discount amount or percentage
+ *         storesNumber:
+ *           type: number
+ *           description: Number of stores included
+ *         plan:
+ *           type: string
+ *           description: Reference to the plan
+ *         StartDate:
+ *           type: string
+ *           format: date-time
+ *           description: Start date of the offer
+ *         EndDate:
+ *           type: string
+ *           format: date-time
+ *           description: End date of the offer
+ *         description:
+ *           type: string
+ *           description: Offer description
+ *         status:
+ *           type: string
+ *           enum: [inactive, active, expired]
+ *           default: inactive
+ *           description: Offer status
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         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"
+ */
 const ReductionOfferSchema = new mongoose.Schema(
 	{
 		name: {

package/models/ResetPassword.js

@@ -1,5 +1,34 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     ResetPassword:
+ *       type: object
+ *       required:
+ *         - userId
+ *         - token
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The reset password identifier
+ *         userId:
+ *           type: string
+ *           description: Reference to the user
+ *         token:
+ *           type: string
+ *           description: Reset token
+ *         createAt:
+ *           type: string
+ *           format: date-time
+ *           description: Creation timestamp (expires after 1 hour)
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         userId: "507f1f77bcf86cd799439012"
+ *         token: "abc123xyz789"
+ *         createAt: "2025-12-07T10:30:00.000Z"
+ */
 const resetPasswordSchema = new mongoose.Schema(
 	{
 		userId: {
@@ -9,12 +38,12 @@ const resetPasswordSchema = new mongoose.Schema(
 		},
 		token: {
 			type: String,
-			required: true,
+			required: true
 		},
 		createAt: {
 			type: Date,
 			default: Date.now,
-            expires : 3600
+			expires: 3600
 		}
 	},
 	{ toJSON: { virtuals: true } }

package/models/Sale.js

@@ -1,11 +1,47 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Sale:
+ *       type: object
+ *       required:
+ *         - date
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The sale identifier
+ *         sellerId:
+ *           type: string
+ *           description: Reference to the seller
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         productId:
+ *           type: string
+ *           description: Reference to the product
+ *         date:
+ *           type: string
+ *           format: date-time
+ *           description: Date of the sale
+ *         region:
+ *           type: string
+ *           description: Region where the sale occurred
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         sellerId: "507f1f77bcf86cd799439012"
+ *         storeId: "507f1f77bcf86cd799439013"
+ *         productId: "507f1f77bcf86cd799439014"
+ *         date: "2025-12-07T10:30:00.000Z"
+ *         region: "North Region"
+ */
 const Sale = new mongoose.Schema({
-  sellerId: { type: mongoose.Schema.Types.ObjectId, ref: 'Seller' },
-  storeId: { type: mongoose.Schema.Types.ObjectId, ref: 'Store' },
-  productId: { type: mongoose.Schema.Types.ObjectId, ref: 'Product' },
-  date: { type: Date, required: true },
-  region: { type: String }, // If you want to track region for each sale
+	sellerId: { type: mongoose.Schema.Types.ObjectId, ref: 'Seller' },
+	storeId: { type: mongoose.Schema.Types.ObjectId, ref: 'Store' },
+	productId: { type: mongoose.Schema.Types.ObjectId, ref: 'Product' },
+	date: { type: Date, required: true },
+	region: { type: String }
 });
 
 module.exports = mongoose.model('Sale', Sale);