database-connector 1.0.7 → 2.0.0

package/models/FlashDeal.js

@@ -1,5 +1,78 @@
 
 const mongoose = require('mongoose');
+
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     FlashDeal:
+ *       type: object
+ *       required:
+ *         - name
+ *         - description
+ *         - discountCode
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The flash deal identifier
+ *         name:
+ *           type: string
+ *           description: Flash deal name
+ *         description:
+ *           type: string
+ *           description: Flash deal description
+ *         image:
+ *           type: string
+ *           description: Flash deal image
+ *         startDate:
+ *           type: string
+ *           format: date-time
+ *           description: Start date of the flash deal
+ *         endDate:
+ *           type: string
+ *           format: date-time
+ *           description: End date of the flash deal
+ *         discountType:
+ *           type: string
+ *           enum: [percentage, amount]
+ *           default: percentage
+ *         discount:
+ *           type: number
+ *           default: 0
+ *           description: Discount value
+ *         productIds:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Products in this flash deal
+ *         discountCode:
+ *           type: string
+ *           description: Discount code
+ *         qauntiyFlashDeal:
+ *           type: number
+ *           default: 0
+ *           description: Quantity available for flash deal
+ *         active:
+ *           type: boolean
+ *           default: true
+ *           description: Whether the flash deal is active
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         name: "Black Friday Sale"
+ *         description: "Huge discounts on electronics"
+ *         discountType: "percentage"
+ *         discount: 50
+ *         discountCode: "BF2025"
+ *         active: true
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const FlashDealSchema = new mongoose.Schema(
 	{
 		name: {
@@ -52,11 +125,11 @@ const FlashDealSchema = new mongoose.Schema(
 		active: {
 			type: Boolean,
 			required: true,
-			default: true,
-		},
+			default: true
+		}
 	},
 	{
-		timestamps: true,
+		timestamps: true
 	}
 );
 

package/models/Notification.js

@@ -1,6 +1,65 @@
-const { Timestamp } = require('mongodb');
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     Notification:
+ *       type: object
+ *       required:
+ *         - owner_id
+ *         - title
+ *         - content
+ *         - id
+ *         - type
+ *         - sub_type
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The notification identifier
+ *         owner_id:
+ *           type: string
+ *           description: Reference to the user who owns this notification
+ *         title:
+ *           type: string
+ *           description: Notification title
+ *         content:
+ *           type: string
+ *           description: Notification content
+ *         type:
+ *           type: string
+ *           enum: [order, offer]
+ *           description: Type of notification
+ *         sub_type:
+ *           type: string
+ *           enum: [Delivery, Pickup, Reservation, Return, Refund, Cancel, offer, product]
+ *           default: Cancel
+ *           description: Sub-type of notification
+ *         seend:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the notification has been seen
+ *         seendInList:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the notification has been seen in list
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         owner_id: "507f1f77bcf86cd799439012"
+ *         title: "Order Delivered"
+ *         content: "Your order has been delivered"
+ *         type: "order"
+ *         sub_type: "Delivery"
+ *         seend: false
+ *         createdAt: "2025-12-07T10:30:00.000Z"
+ *         updatedAt: "2025-12-07T10:30:00.000Z"
+ */
 const NotificationSchema = new mongoose.Schema(
 	{
 		owner_id: {
@@ -22,14 +81,14 @@ const NotificationSchema = new mongoose.Schema(
 														'Return', 
 														'Refund', 
 														'Cancel' , 
-														'offer', 
-														'product'
-													], default: 'Cancel' }, 
-		seend : { type : Boolean ,  default : false }  ,
-		seendInList : { type : Boolean ,  default : false }
+											'offer', 
+											'product'
+										], default: 'Cancel'
+		},
+		seend: { type: Boolean, default: false },
+		seendInList: { type: Boolean, default: false }
 	},
-
 	{ timestamps: true }
 );
 
-module.exports = mongoose.model('Notification', NotificationSchema);
+module.exports = mongoose.model('Notification', NotificationSchema);

package/models/Offer.js

@@ -1,6 +1,80 @@
-const { Timestamp } = require('mongodb');
 const mongoose = require('mongoose');
 
+/**
+ * @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: {

package/models/Order.js

@@ -2,6 +2,103 @@ const mongoose = require('mongoose');
 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: {

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: {