database-connector 1.0.7 → 2.0.0

package/models/Store.js

@@ -1,9 +1,112 @@
 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;
+const { getBaseURL, getDefaultStoreImagePath } = require('../config');
 
+/**
+ * @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: {
@@ -240,12 +343,12 @@ const storeSchema = new mongoose.Schema(
 
 	{ timestamps: true, toJSON: { virtuals: true } }
 );
-//virtual image url
+// Virtual: image URL with base path
 storeSchema.virtual('imageUrl').get(function () {
 	if (this.image != null) {
-		return `${process.env.APP_URL}/${this.image}`;
+		return `${getBaseURL()}/${this.image}`;
 	}
-	return `${process.env.APP_URL}/images/stores/default.jpg`;
+	return `${getBaseURL()}${getDefaultStoreImagePath()}`;
 });
 //virtual rating
 storeSchema.virtual('rating').get(function () {

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

package/models/User.js

@@ -1,7 +1,124 @@
 const mongoose = require('mongoose');
 const { policySchema } = require('database-connector/models/Policy');
-var ObjectId = require('mongodb').ObjectID;
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     User:
+ *       type: object
+ *       required:
+ *         - password
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The user identifier
+ *         password:
+ *           type: string
+ *           minLength: 8
+ *           description: User password (must contain at least one letter and one number)
+ *         username:
+ *           type: string
+ *           description: Unique username
+ *         role:
+ *           type: string
+ *           enum: [user, admin, seller, paymentManager, manager, SuperManager]
+ *           default: user
+ *           description: User role
+ *         isAdmin:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the user is an admin
+ *         companyName:
+ *           type: string
+ *           description: Company name
+ *         phone:
+ *           type: string
+ *           description: User phone number
+ *         verificationCode:
+ *           type: string
+ *           description: Verification code for account
+ *         isVerified:
+ *           type: boolean
+ *           default: false
+ *           description: Whether the user is verified
+ *         welcome:
+ *           type: boolean
+ *           default: false
+ *           description: Welcome status
+ *         profileImage:
+ *           type: string
+ *           description: Profile image URL
+ *         discountCode:
+ *           type: string
+ *           description: Discount code
+ *         email:
+ *           type: string
+ *           description: User email address
+ *         favouritsProductst:
+ *           type: array
+ *           items:
+ *             type: object
+ *             properties:
+ *               productId:
+ *                 type: string
+ *           description: List of favorite products
+ *         adresse:
+ *           type: object
+ *           properties:
+ *             latitude:
+ *               type: number
+ *             longitude:
+ *               type: number
+ *             countryCode:
+ *               type: string
+ *             country:
+ *               type: string
+ *             city:
+ *               type: string
+ *             postalCode:
+ *               type: string
+ *             locality:
+ *               type: string
+ *             apartmentNumber:
+ *               type: string
+ *             streetName:
+ *               type: string
+ *             region:
+ *               type: string
+ *             fullAddress:
+ *               type: string
+ *         proximityRange:
+ *           type: number
+ *           default: 20
+ *           description: Proximity range in kilometers
+ *         storeCategorieIds:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Store category references
+ *         storeSubs:
+ *           type: array
+ *           items:
+ *             type: string
+ *           description: Subscribed stores
+ *         createdAt:
+ *           type: string
+ *           format: date-time
+ *         updatedAt:
+ *           type: string
+ *           format: date-time
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         username: "john_doe"
+ *         role: "user"
+ *         email: "john.doe@example.com"
+ *         phone: "+1234567890"
+ *         isVerified: true
+ *         proximityRange: 25
+ *         createdAt: "2025-11-01T10:30:00.000Z"
+ *         updatedAt: "2025-12-01T15:45:00.000Z"
+ */
 const userSchema = new mongoose.Schema(
 	{
 		password: {

package/models/UserAction.js

@@ -1,5 +1,44 @@
 const mongoose = require("mongoose");
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     UserAction:
+ *       type: object
+ *       required:
+ *         - type
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The user action identifier
+ *         userId:
+ *           type: string
+ *           description: Reference to the user
+ *         type:
+ *           type: string
+ *           description: Type of action
+ *         deviceId:
+ *           type: string
+ *           description: Device identifier
+ *         sessionId:
+ *           type: string
+ *           description: Session identifier
+ *         details:
+ *           type: object
+ *           description: Additional details about the action
+ *         timestamp:
+ *           type: string
+ *           format: date-time
+ *           description: When the action occurred
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         userId: "507f1f77bcf86cd799439012"
+ *         type: "product_view"
+ *         deviceId: "device123"
+ *         sessionId: "session456"
+ *         timestamp: "2025-12-07T10:30:00.000Z"
+ */
 const UserActionSchema = new mongoose.Schema({
     userId: {
         type: mongoose.Schema.Types.ObjectId,

package/models/View.js

@@ -1,12 +1,52 @@
 const mongoose = require('mongoose');
 
+/**
+ * @swagger
+ * components:
+ *   schemas:
+ *     View:
+ *       type: object
+ *       required:
+ *         - date
+ *       properties:
+ *         id:
+ *           type: string
+ *           description: The view identifier
+ *         sellerId:
+ *           type: string
+ *           description: Reference to the seller
+ *         clientId:
+ *           type: string
+ *           description: Reference to the client
+ *         storeId:
+ *           type: string
+ *           description: Reference to the store
+ *         productId:
+ *           type: string
+ *           description: Reference to the product
+ *         date:
+ *           type: string
+ *           format: date-time
+ *           description: The date of the view
+ *         region:
+ *           type: string
+ *           description: Region where the view occurred
+ *       example:
+ *         id: "507f1f77bcf86cd799439011"
+ *         sellerId: "507f1f77bcf86cd799439012"
+ *         clientId: "507f1f77bcf86cd799439013"
+ *         storeId: "507f1f77bcf86cd799439014"
+ *         productId: "507f1f77bcf86cd799439015"
+ *         date: "2025-12-07T10:30:00.000Z"
+ *         region: "North Region"
+ */
 const viewsSchema = new mongoose.Schema({
-  sellerId: { type: mongoose.Schema.Types.ObjectId, ref: 'Seller' },
-  clientId: { type: mongoose.Schema.Types.ObjectId, ref: 'Client' },
-  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 view
+	sellerId: { type: mongoose.Schema.Types.ObjectId, ref: 'Seller' },
+	clientId: { type: mongoose.Schema.Types.ObjectId, ref: 'Client' },
+	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('View', viewsSchema);

package/models/index.js

@@ -1,4 +1,5 @@
 const mongoose = require('mongoose');
+const config = require('../config');
 
 const connectToDatabase = async (databaseUrl) => {
     try {
@@ -31,7 +32,7 @@ const SubscriptionOffer = require('./SubscriptionOffer');
 const FlashDeal = require('./FlashDeal');
 const Notification = require('./Notification');
 const PaymentType = require('./PaymentType');
-const { policySchema } = require('./Policy');
+const Policy = require('./Policy');
 const ReductionOffer = require('./ReductionOffer');
 const Sale = require('./Sale');
 const StoreCategory = require('./StoreCategory');
@@ -40,8 +41,10 @@ const UserAction = require('./UserAction.js');
 
 module.exports = {
     connectToDatabase,
+    configure: config.configure,
+    getConfig: config.getConfig,
     PaymentType,
-    policySchema,
+    Policy,
     ReductionOffer,
     Sale,
     StoreCategory,

package/package.json

@@ -1,15 +1,36 @@
 {
   "name": "database-connector",
-  "version": "1.0.7",
+  "version": "2.0.0",
+  "description": "MongoDB models package with Mongoose schemas for e-commerce applications. Includes User, Product, Store, Order and more with built-in validation and virtual properties.",
   "main": "models/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": [],
+  "keywords": [
+    "mongoose",
+    "mongodb",
+    "models",
+    "schemas",
+    "ecommerce",
+    "database",
+    "user",
+    "product",
+    "store",
+    "order"
+  ],
   "author": "",
   "license": "ISC",
-  "description": "",
   "dependencies": {
-		"mongoose": "^6.2.10"
+    "mongoose": "^6.2.10"
+  },
+  "files": [
+    "models/",
+    "config.js",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": ""
   }
 }