database-connector 1.0.7 → 1.1.0

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

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);