database-connector 1.0.6 → 1.1.0

package/models/Offer.js

@@ -1,7 +1,80 @@
-const { Timestamp } = require('mongodb');
 const mongoose = require('mongoose');
-const User = require('./User');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Offer:
+ *       type: object
+ *       required:
+ *         - sellerId
+ *         - storeId
+ *         - productId
+ *         - discountType
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The offer 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
+ *         offerDiscount:
+ *           type: number
+ *           default: 0
+ *           description: Discount amount or percentage
+ *         offerStock:
+ *           type: number
+ *           default: 0
+ *           description: Stock available for this offer
+ *         offerExpiration:
+ *           type: string
+ *           format: date-time
+ *           description: Offer expiration date
+ *         offerStatus:
+ *           type: string
+ *           enum: [pending, active, rejected, expired]
+ *           default: active
+ *           description: Status of the offer
+ *         offerDeleted:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the offer is deleted
+ *         offerName:
+ *           type: string
+ *           description: Offer name
+ *         offerImage:
+ *           type: string
+ *           description: Offer image
+ *         offerDescription:
+ *           type: string
+ *           description: Offer description
+ *         discountType:
+ *           type: string
+ *           enum: [percentage, amount]
+ *           description: Type of discount
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         sellerId: "507f1f77bcf86cd799439012"
+ *         storeId: "507f1f77bcf86cd799439013"
+ *         productId: "507f1f77bcf86cd799439014"
+ *         offerDiscount: 25
+ *         discountType: "percentage"
+ *         offerStatus: "active"
+ *         createdAt: "2025-12-07T10:30:00.000Z"
+ *         updatedAt: "2025-12-07T10:30:00.000Z"
+ */
 const OfferSchema = new mongoose.Schema(
 	{
 		sellerId: {
@@ -31,12 +104,12 @@ const OfferSchema = new mongoose.Schema(
 		},
 		offerExpiration: {
 			type: Date,
-			
+
 			default: Date.now() + 86400000,
 		},
 		offerStatus: {
 			type: String,
-			default:'active',
+			default: 'active',
 
 			enum: ['pending', 'active', 'rejected', 'expired'],
 		},
@@ -47,7 +120,7 @@ const OfferSchema = new mongoose.Schema(
 		},
 		offerName: {
 			type: String,
-			
+
 		},
 		offerImage: {
 			type: String,
@@ -55,7 +128,7 @@ const OfferSchema = new mongoose.Schema(
 		},
 		offerDescription: {
 			type: String,
-		
+
 		},
 		discountType: {
 			type: String,

package/models/Order.js

@@ -1,8 +1,104 @@
 const mongoose = require('mongoose');
-var ObjectId = require('mongodb').ObjectID;
 const Sale = require('./Sale');
 
 const { policySchema } = require('./Policy');
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Order:
+ *       type: object
+ *       required:
+ *         - clientId
+ *         - storeId
+ *         - items
+ *         - paymentInfos
+ *         - pickUp
+ *         - delivery
+ *         - status
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The order identifier
+ *         clientId:
+ *           type: string
+ *           description: Reference to the client
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         pickupPerson:
+ *           type: object
+ *           properties:
+ *             name:
+ *               type: string
+ *         deliveryAddresse:
+ *           type: object
+ *           properties:
+ *             city:
+ *               type: string
+ *             streetName:
+ *               type: string
+ *             postalCode:
+ *               type: string
+ *             country:
+ *               type: string
+ *             region:
+ *               type: string
+ *         items:
+ *           type: array
+ *           items:
+ *             type: object
+ *             properties:
+ *               productId:
+ *                 type: string
+ *               variantId:
+ *                 type: string
+ *               name:
+ *                 type: string
+ *               price:
+ *                 type: number
+ *               quantity:
+ *                 type: number
+ *               discount:
+ *                 type: number
+ *         paymentInfos:
+ *           type: object
+ *           properties:
+ *             totalAmount:
+ *               type: number
+ *             paymentMethodeId:
+ *               type: number
+ *         pickUp:
+ *           type: boolean
+ *           description: Whether order is pickup
+ *         delivery:
+ *           type: boolean
+ *           description: Whether order is delivery
+ *         canceled:
+ *           type: boolean
+ *           description: Whether order is canceled
+ *         status:
+ *           type: string
+ *           enum: [Pending, InPreparation, LoadingDelivery, OnTheWay, Delivered, AwaitingRecovery, Recovered, Reserved, WaitingForReturn, Returned, UnderRefund, Refunded, succeeded]
+ *           default: Pending
+ *           description: Order status
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         clientId: "507f1f77bcf86cd799439012"
+ *         storeId: "507f1f77bcf86cd799439013"
+ *         status: "Pending"
+ *         pickUp: false
+ *         delivery: true
+ *         createdAt: "2025-12-07T10:30:00.000Z"
+ *         updatedAt: "2025-12-07T10:30:00.000Z"
+ */
 const orderSchema = new mongoose.Schema(
 	{
 		clientId: {
@@ -15,13 +111,13 @@ const orderSchema = new mongoose.Schema(
 			required: true,
 			ref: 'Store',
 		},
-		pickupPerson : {
-			type : {
-				name : {type : String, required: true } ,
-			} , 
-			default : null
-		} ,
-		deliveryLocation : {
+		pickupPerson: {
+			type: {
+				name: { type: String, required: true },
+			},
+			default: null
+		},
+		deliveryLocation: {
 			type: {
 				type: String,
 				enum: ['Point'],
@@ -35,7 +131,7 @@ const orderSchema = new mongoose.Schema(
 				},
 			],
 		},
-		deliveryAddresse : {
+		deliveryAddresse: {
 			city: {
 				type: String,
 				// required: true,
@@ -69,9 +165,9 @@ const orderSchema = new mongoose.Schema(
 				//required: true,
 			},
 		},
-		distance : {
-			type : Number , default : null 
-		} ,
+		distance: {
+			type: Number, default: null
+		},
 		items: [
 			{
 				productId: { type: String, required: true },
@@ -80,29 +176,29 @@ const orderSchema = new mongoose.Schema(
 				image: { type: String, required: true },
 				price: { type: Number, required: true },
 				discount: { type: Number, required: true },
-				reservation: { type: Number},
+				reservation: { type: Number },
 				quantity: { type: Number, required: true, default: 1 },
 				policy: policySchema,
 
-				refund : {
-					order : {
-						fixe : {type : Number ,  default : null} ,
-						percentage : {type : Number ,  default : null} ,
-					} , 
-					shipping : {
-						fixe : {type : Number ,  default : null} ,
-						percentage : {type : Number ,  default : null} ,
+				refund: {
+					order: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null },
+					},
+					shipping: {
+						fixe: { type: Number, default: null },
+						percentage: { type: Number, default: null },
 					},
-				} , 
-				
+				},
+
 			},
 			{
 				timestamps: true,
 			},
 		],
 
-		
-		return : { type : Boolean ,  default : null } , 
+
+		return: { type: Boolean, default: null },
 
 		returnItems: [
 			{
@@ -114,7 +210,7 @@ const orderSchema = new mongoose.Schema(
 				discount: { type: Number, required: true },
 				quantity: { type: Number, required: true, default: 1 },
 				orderQuantity: { type: Number, required: true, default: 1 },
-				policy: policySchema,	
+				policy: policySchema,
 			},
 			{
 				timestamps: true,
@@ -131,88 +227,91 @@ const orderSchema = new mongoose.Schema(
 				discount: { type: Number, required: true },
 				quantity: { type: Number, required: true, default: 1 },
 				orderQuantity: { type: Number, required: true, default: 1 },
-				policy: policySchema,	
+				policy: policySchema,
 			},
 			{
 				timestamps: true,
 			},
 		],
 
-		refundPaymentInfos : {
-			type : {
+		refundPaymentInfos: {
+			type: {
 				totalAmount: { type: Number, required: true },
-			} ,   
-			
-			default : null 
-		} ,
-		returnMotif :{ type: String ,  default : null },
-		
-		waitingforReturn :{ type: Boolean ,  default : null },
-		
-		returned :{ type: Boolean ,  default : null },
-		
-
-		paymentInfos : {
+			},
+
+			default: null
+		},
+		returnMotif: { type: String, default: null },
+
+		waitingforReturn: { type: Boolean, default: null },
+
+		returned: { type: Boolean, default: null },
+
+
+		paymentInfos: {
 			totalAmount: { type: Number, required: true },
 			paymentMethodeId: { type: Number, required: true, },
-			card : {
-				cardNumber : { type: String,  default : null },
-				ccv: { type: String, default : null },
-				expdate: { type: String, default : null},
+			card: {
+				cardNumber: { type: String, default: null },
+				ccv: { type: String, default: null },
+				expdate: { type: String, default: null },
 				name: { type: String, required: true },
 				phone: { type: String, required: true },
 				postalCode: { type: String, required: true },
 				address_city: { type: String, required: true },
 				address_line1: { type: String, required: true },
-				address_line2: { type: String, default: ""},
-			} ,
-		} ,
-		pickUp : { type : Boolean , required : true , default : null } , 
-		delivery : { type : Boolean , required : true , default : null } , 
-		
-		refund : { type : Boolean ,  default : null } , 
-
-		timeLimit :  { type : Number ,  default : null }  ,
-
-		canceled : { type : Boolean ,  default : null } , 
-		canceledBy : {
+				address_line2: { type: String, default: "" },
+			},
+		},
+		pickUp: { type: Boolean, required: true, default: null },
+		delivery: { type: Boolean, required: true, default: null },
+
+		refund: { type: Boolean, default: null },
+
+		timeLimit: { type: Number, default: null },
+
+		canceled: { type: Boolean, default: null },
+		canceledBy: {
 			userId: { type: mongoose.Schema.Types.ObjectId },
 			motif: { type: String },
-		} ,
-		status: { type: String, required: true, enum: [
-														'Pending', 
-														'InPreparation',  
-														'LoadingDelivery', 
-														'OnTheWay', 
-														'Delivered', 
-														'AwaitingRecovery', 
-														'Recovered', 
-														'Reserved', 
-														'WaitingForReturn', 
-														'Returned', 	
-														'UnderRefund' ,
-														'Refunded', 
-														'succeeded'
-													], default: 'Pending' }, 
+		},
+		status: {
+			type: String, required: true, enum: [
+				'Pending',
+				'InPreparation',
+				'LoadingDelivery',
+				'OnTheWay',
+				'Delivered',
+				'AwaitingRecovery',
+				'Recovered',
+				'Reserved',
+				'WaitingForReturn',
+				'Returned',
+				'UnderRefund',
+				'Refunded',
+				'succeeded'
+			], default: 'Pending'
+		},
 	},
 	{ timestamps: true }
 );
 orderSchema.post('save', async function (doc) {
 	try {
-	  // Create a new Sale document for each item in the order
-	  for (const item of doc.items) {
-		const newSale = new Sale({
-		  sellerId: doc.sellerId, // Replace with the actual sellerId
-		  storeId: doc.storeId,   // Replace with the actual storeId
-		  productId: item.productId,
-		  date: doc.createdAt,
-		  region: doc.deliveryAddresse.city} // Replace with the actual region field from the order
-		);
-  
-		await newSale.save();
-	  }
+		// Create a new Sale document for each item in the order
+		for (const item of doc.items) {
+			const newSale = new Sale({
+				sellerId: doc.sellerId, // Replace with the actual sellerId
+				storeId: doc.storeId,   // Replace with the actual storeId
+				productId: item.productId,
+				date: doc.createdAt,
+				region: doc.deliveryAddresse.city
+			} // Replace with the actual region field from the order
+			);
+
+			await newSale.save();
+		}
 	} catch (error) {
-	  console.error('Error creating sale records:', error);
+		console.error('Error creating sale records:', error);
 	}
-  });
+});
 module.exports = mongoose.model('Order', orderSchema);

package/models/Payment.js

@@ -1,6 +1,82 @@
 const mongoose = require('mongoose');
-var ObjectId = require('mongodb').ObjectID;
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Payment:
+ *       type: object
+ *       required:
+ *         - userId
+ *         - sellerId
+ *         - gateway
+ *         - paymentStatus
+ *         - paymentAmount
+ *         - paymentCurrency
+ *         - paymentMethod
+ *         - paymentDate
+ *         - paymentTime
+ *         - paymentDetails
+ *         - token
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The payment identifier
+ *         userId:
+ *           type: string
+ *           description: Reference to the user
+ *         sellerId:
+ *           type: string
+ *           description: Reference to the seller
+ *         gateway:
+ *           type: string
+ *           description: Payment gateway used
+ *         paymentStatus:
+ *           type: string
+ *           description: Status of the payment
+ *         paymentAmount:
+ *           type: number
+ *           description: Payment amount
+ *         paymentCurrency:
+ *           type: string
+ *           description: Currency of payment
+ *         paymentMethod:
+ *           type: string
+ *           description: Payment method
+ *         paymentDate:
+ *           type: string
+ *           format: date
+ *           description: Date of payment
+ *         paymentTime:
+ *           type: string
+ *           format: date-time
+ *           description: Time of payment
+ *         totalPrice:
+ *           type: number
+ *           default: 0
+ *           description: Total price
+ *         token:
+ *           type: string
+ *           description: Payment token
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         userId: "507f1f77bcf86cd799439012"
+ *         sellerId: "507f1f77bcf86cd799439013"
+ *         gateway: "Stripe"
+ *         paymentStatus: "succeeded"
+ *         paymentAmount: 150.00
+ *         paymentCurrency: "USD"
+ *         paymentMethod: "card"
+ *         totalPrice: 150.00
+ *         createdAt: "2025-12-07T10:30:00.000Z"
+ *         updatedAt: "2025-12-07T10:30:00.000Z"
+ */
 const paymentSchema = new mongoose.Schema(
 	{
 		userId: {
@@ -99,19 +175,20 @@ const paymentSchema = new mongoose.Schema(
 			},
 			ccv: {
 				type: String,
-				required: true,
-			},
+				required: true
+			}
 		},
 		timestamps: {
 			type: Date,
 			required: true,
-			default: Date.now(),
+			default: Date.now()
 		},
 		token: {
 			type: String,
-			required: true,
-		},
+			required: true
+		}
 	},
 	{ timestamps: true }
 );
+
 module.exports = mongoose.model('Payment', paymentSchema);

package/models/PaymentType.js

@@ -1,5 +1,24 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     PaymentType:
+ *       type: object
+ *       required:
+ *         - type
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The payment type identifier
+ *         type:
+ *           type: string
+ *           description: Payment type (unique)
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         type: "Credit Card"
+ */
 const paymentTypeSchema = new mongoose.Schema(
 	{
 		type: {

package/models/Plan.js

@@ -1,5 +1,45 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Plan:
+ *       type: object
+ *       required:
+ *         - type
+ *         - months
+ *         - price
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The plan identifier
+ *         type:
+ *           type: string
+ *           description: Plan type (Annual, Semi-annual, Quarterly, Monthly, or custom)
+ *         months:
+ *           type: number
+ *           description: Number of months in the plan
+ *         price:
+ *           type: number
+ *           description: Plan price
+ *         reductionOffers:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: References to reduction offers
+ *         status:
+ *           type: string
+ *           enum: [active, suspended]
+ *           default: active
+ *           description: Plan status
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         type: "Annual"
+ *         months: 12
+ *         price: 99.99
+ *         status: "active"
+ */
 const planSchema = new mongoose.Schema(
 	{
 		type: {