database-connector 1.0.7 → 1.1.0

package/models/Product.js

@@ -1,7 +1,100 @@
 const mongoose = require('mongoose');
 const { policySchema } = require('database-connector/models/Policy');
-var ObjectId = require('mongodb').ObjectID;
 
+/**
+ * @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: {
@@ -136,15 +229,19 @@ const productSchema = new mongoose.Schema(
 	},
 	{
 		timestamps: true,
-		toJSON: { virtuals: 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')
-
+		console.log('Discount');
 		return this.offer.discount;
-
 	} else {
 		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);

package/models/Store.js

@@ -1,9 +1,111 @@
 const mongoose = require('mongoose');
-const User = require('database-connector/models/User');
-const Product = require('database-connector/models/Product');
 const { policySchema } = require('database-connector/models/Policy');
-var ObjectId = require('mongodb').ObjectID;
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Store:
+ *       type: object
+ *       required:
+ *         - name
+ *         - sellerId
+ *         - image
+ *         - description
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The store identifier
+ *         name:
+ *           type: string
+ *           description: Store name
+ *         sellerId:
+ *           type: string
+ *           description: Reference to the seller/owner
+ *         address:
+ *           type: object
+ *           properties:
+ *             city:
+ *               type: string
+ *             streetName:
+ *               type: string
+ *             postalCode:
+ *               type: string
+ *             country:
+ *               type: string
+ *             fullAdress:
+ *               type: string
+ *             region:
+ *               type: string
+ *             countryCode:
+ *               type: string
+ *             phone:
+ *               type: string
+ *         location:
+ *           type: object
+ *           properties:
+ *             type:
+ *               type: string
+ *               enum: [Point]
+ *               default: Point
+ *             coordinates:
+ *               type: array
+ *               items:
+ *                 type: number
+ *               description: [longitude, latitude]
+ *         image:
+ *           type: string
+ *           description: Store image URL
+ *         description:
+ *           type: string
+ *           description: Store description
+ *         isActive:
+ *           type: boolean
+ *           default: true
+ *           description: Whether the store is active
+ *         ratingCount:
+ *           type: number
+ *           default: 0
+ *           description: Number of ratings
+ *         ratingSum:
+ *           type: number
+ *           default: 0
+ *           description: Sum of all ratings
+ *         revenue:
+ *           type: number
+ *           default: 0
+ *           description: Store revenue
+ *         templateId:
+ *           type: number
+ *           default: 1
+ *           description: Template identifier
+ *         activated:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the store is activated
+ *         subscriptionId:
+ *           type: string
+ *           description: Reference to subscription
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Tech Store"
+ *         sellerId: "507f1f77bcf86cd799439012"
+ *         description: "Electronics and gadgets store"
+ *         image: "store-image.jpg"
+ *         isActive: true
+ *         ratingCount: 150
+ *         ratingSum: 735
+ *         revenue: 25000
+ *         activated: true
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const storeSchema = new mongoose.Schema(
 	{
 		name: {

package/models/StoreCategory.js

@@ -1,13 +1,44 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     StoreCategory:
+ *       type: object
+ *       required:
+ *         - name
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The store category identifier
+ *         name:
+ *           type: string
+ *           description: Store category name
+ *         confirmed:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the category is confirmed
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Grocery Store"
+ *         confirmed: true
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const storeCategorySchema = new mongoose.Schema(
 	{
 		name: {
 			type: String,
-			required: true,
-		} , 
-		
-		confirmed : { type : Boolean ,  default : false } , 
+			required: true
+		},
+		confirmed: { type: Boolean, default: false }
 	},
 	{ timestamps: true, toJSON: { virtuals: true } }
 );

package/models/StoreRate.js

@@ -1,5 +1,34 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     StoreRate:
+ *       type: object
+ *       required:
+ *         - userId
+ *         - storeId
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The store rate identifier
+ *         userId:
+ *           type: string
+ *           description: Reference to the user
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         rate:
+ *           type: number
+ *           default: 0
+ *           description: Rating value
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         userId: "507f1f77bcf86cd799439012"
+ *         storeId: "507f1f77bcf86cd799439013"
+ *         rate: 4.5
+ */
 const storeRateSchema = new mongoose.Schema(
 	{
 		userId: {
@@ -10,12 +39,12 @@ const storeRateSchema = new mongoose.Schema(
 		storeId: {
 			type: mongoose.Schema.Types.ObjectId,
 			required: true,
-			ref: 'User',
+			ref: 'User'
 		},
 		rate: {
 			type: Number,
-			default: 0,
-		},
+			default: 0
+		}
 	},
 	{ toJSON: { virtuals: true } }
 );

package/models/Subscription.js

@@ -1,5 +1,68 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Subscription:
+ *       type: object
+ *       required:
+ *         - storeId
+ *         - paymentAmount
+ *         - startDate
+ *         - endDate
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The subscription identifier
+ *         paymentManagerId:
+ *           type: string
+ *           description: Reference to the payment manager
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         planId:
+ *           type: string
+ *           description: Reference to the plan
+ *         subscriptionOfferId:
+ *           type: string
+ *           description: Reference to subscription offer
+ *         paymentAmount:
+ *           type: number
+ *           description: Payment amount
+ *         paymentTypeId:
+ *           type: string
+ *           description: Reference to payment type
+ *         reductionOfferId:
+ *           type: string
+ *           description: Reference to reduction offer
+ *         status:
+ *           type: string
+ *           enum: [inactive, active, delayed, suspended, upcoming, deleted]
+ *           default: inactive
+ *           description: Subscription status
+ *         startDate:
+ *           type: string
+ *           format: date-time
+ *           description: Subscription start date
+ *         endDate:
+ *           type: string
+ *           format: date-time
+ *           description: Subscription end date
+ *         notes:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Notes about the subscription
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         storeId: "507f1f77bcf86cd799439012"
+ *         planId: "507f1f77bcf86cd799439013"
+ *         paymentAmount: 99.99
+ *         status: "active"
+ *         startDate: "2025-12-01T00:00:00.000Z"
+ *         endDate: "2026-12-01T00:00:00.000Z"
+ */
 const subscriptionSchema = new mongoose.Schema(
 	{
 		paymentManagerId: {

package/models/SubscriptionOffer.js

@@ -1,5 +1,37 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     SubscriptionOffer:
+ *       type: object
+ *       required:
+ *         - discount
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The subscription offer identifier
+ *         discount:
+ *           type: number
+ *           description: Discount amount or percentage
+ *         isActive:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the offer is active
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         discount: 20
+ *         isActive: true
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const subscriptionOfferSchema = new mongoose.Schema(
 	{
 		discount: {