picker-db 4.13.0 → 4.15.0

package/CLAUDE.md

@@ -0,0 +1,87 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+**picker-db** is a JavaScript library that provides Mongoose models and schemas for connecting to Picker MongoDB databases. It abstracts database operations and promotes code reuse across Picker microservices.
+
+**Key Technologies:**
+- Mongoose 8.0.4 for MongoDB schema definition and operations
+- Winston for logging
+- Node v16.13.1 (specified in .nvmrc)
+
+## Architecture
+
+### Core Service (modules/picker/index.js)
+The `PickerMongoDBService` class is the main entry point. It wraps Mongoose operations and provides consistent CRUD and query methods:
+
+- **Connection Management**: `connect()`, `disconnect()` - Initialize and close MongoDB connections
+- **CRUD Operations**: `createData()`, `updateData()`, `updateMultiple()`, `deleteData()`, `deleteMany()`
+- **Query Operations**: `getDataAsync()`, `getFirstMatch()`, `countData()` - Support criteria, projection, and options
+- **Advanced Queries**: `aggregateData()`, `aggregateDataCursor()` with disk allowance for large datasets
+- **Relationships**: `getDataPopulateAsync()`, `getFirstMatchPopulate()` - Support Mongoose population for references
+
+### Models and Schemas
+- **models/index.js**: Registers all 28+ schemas as Mongoose models (User, Bookings, Driver, Customer, etc.) and exports them as a factory function receiving a mongoose connection
+- **schemas/**: Individual schema definitions for domain models. Each schema is a function that receives a mongoose connection and returns a Schema object
+- Schema definitions use Mongoose's nested subdocuments and references for relationships
+
+### Database Connection (lib/Mongo/index.js)
+The `MongoDB` class handles connection setup with three environment types:
+- **"local"**: Local MongoDB (`mongodb://host:port/dbName`)
+- **"atlas"**: MongoDB Atlas (uses `dbUri` directly)
+- **default**: Standard auth (`mongodb://username:password@host:port/dbName`)
+
+Configuration options:
+- `auth`: Connection credentials and environment
+- `dbName`: Database name
+- `isLoggingEnabled`: Enable Winston logging for connection events
+- `isDebugEnabled`: Enable Mongoose debug mode
+- `useNewUrlParser`, `useUnifiedTopology`: Mongoose connection options
+
+## Development Commands
+
+**ESLint**: Check code style (uses standard config)
+```bash
+npx eslint .
+npx eslint path/to/file.js
+```
+
+**Note**: No test command is currently configured. To run tests in the future:
+```bash
+npm test
+```
+
+## Code Style and Conventions
+
+**ESLint Configuration** (.eslintrc.json):
+- Double quotes for strings (not single)
+- Semicolons required at end of statements
+- `const`/`let` required (no `var`)
+- Capitalized comments required
+- Comma-dangle: always-multiline for arrays, objects, imports, exports, functions
+- `no-console` warnings for console usage
+- Follows StandardJS rules with some customizations
+
+**Best Practices**:
+- Schema definitions are functions that receive a Mongoose connection - this allows multiple connections
+- All operations in `PickerMongoDBService` are async and return Promises
+- Methods accept `modelName` (string) as first parameter to select which model to operate on
+- Use `lean()` option in queries for performance when you don't need full Mongoose documents
+- Use `aggregateDataCursor()` for large datasets (batchSize: 2000)
+
+## Important Files
+
+- **index.js**: Exports `PickerMongoDBService` - the main class for library users
+- **modules/picker/index.js**: Core service implementation with all CRUD methods
+- **modules/picker/models/index.js**: Model factory - returns object with all registered models
+- **modules/picker/schemas/**: 28+ individual schema definitions (bookings.js, user.js, driver.js, etc.)
+- **lib/Mongo/index.js**: MongoDB connection management
+- **lib/Mongo/typedef.js**: JSDoc type definitions for configuration objects
+- **constants.js**: Project-wide constants (business enums, API user types, etc.)
+- **playground/testService.js**: Example usage of the library
+
+## Recent Context
+
+The repository is on the `feature/CT-187-index-optimizations` branch with uncommitted changes to `modules/picker/schemas/bookings.js`. This work is focused on database index optimizations.

package/modules/picker/schemas/balanceTransaction.js

@@ -12,7 +12,6 @@ module.exports = (connection) => {
   const BalanceTransactionSchema = new connection.base.Schema({
     transactionID: {
       type: Number,
-      index: true,
     },
     type: {
       type: String,

package/modules/picker/schemas/bill.js

@@ -49,7 +49,6 @@ module.exports = (connection) => {
     },
     contificoId: {
       type: String,
-      index: true,
       default: null,
     },
     error: {
@@ -62,7 +61,6 @@ module.exports = (connection) => {
     },
     contificoNumericId: {
       type: Number,
-      index: true,
     },
   }, { timestamps: true });
 

package/modules/picker/schemas/bookingRequest.js

@@ -6,13 +6,10 @@ module.exports = (connection) => {
     business: {
       type: connection.base.Schema.ObjectId,
       ref: "User",
-      index: true,
     },
     workspaceID: {
       type: connection.base.Schema.ObjectId,
       default: null,
-      index: true,
-      sparse: true,
     },
     bookingID: {
       type: connection.base.Schema.ObjectId,
@@ -21,12 +18,9 @@ module.exports = (connection) => {
     },
     bookingNumericId: {
       type: Number,
-      index: true,
-      sparse: true,
     },
     ipAddress: {
       type: String,
-      index: true,
     },
     status: {
       type: String,

package/modules/picker/schemas/bookings.js

@@ -181,14 +181,12 @@ module.exports = (connection) => {
     },
     customerName: {
       type: String,
-      index: true,
       required: true,
     },
     customerMobile: {
       type: String,
       required: true,
       trim: true,
-      index: true,
     },
     customerCountryCode: {
       type: String,
@@ -237,14 +235,10 @@ module.exports = (connection) => {
     },
     driverName: {
       type: String,
-      index: true,
-      sparse: true,
       default: null,
     },
     driverMobile: {
       type: String,
-      index: true,
-      sparse: true,
       default: null,
     },
     driverImage: {
@@ -342,7 +336,6 @@ module.exports = (connection) => {
         VEHICLE_TYPES.LITE.INDEX,
         VEHICLE_TYPES.BIKE.INDEX,
       ],
-      index: true,
     },
     carName: {
       type: String,
@@ -411,7 +404,7 @@ module.exports = (connection) => {
         default: null,
       },
     },
-    corporateID: { type: String, index: true },
+    corporateID: { type: String },
     corporateChargeStatus: {
       type: String,
       default: "PENDING",
@@ -511,8 +504,6 @@ module.exports = (connection) => {
     massDeliveryID: {
       type: connection.base.Schema.ObjectId,
       ref: "MassDelivery",
-      index: true,
-      sparse: true,
       default: null,
     },
     // #region Pricing Info
@@ -630,15 +621,11 @@ module.exports = (connection) => {
       type: connection.base.Schema.ObjectId,
       ref: "Region",
       default: null,
-      index: true,
-      sparse: true,
     },
     superRegionID: {
       type: connection.base.Schema.ObjectId,
       ref: "SuperRegion",
       default: null,
-      index: true,
-      sparse: true,
     },
     // #endregion Distance Info
     // #region Time info
@@ -746,7 +733,6 @@ module.exports = (connection) => {
       min: 0,
     }, // In milliseconds
     isActive: {
-      index: true,
       type: Boolean,
       default: true,
     },
@@ -779,7 +765,6 @@ module.exports = (connection) => {
     },
     externalBookingId: {
       type: String,
-      index: true,
     },
     userBookingCreator: {
       type: String,
@@ -838,7 +823,7 @@ module.exports = (connection) => {
     rating: {
       type: Number,
     },
-    isWithHack: { type: Boolean, index: true, sparse: true },
+    isWithHack: { type: Boolean },
     // REASIGNMENT COUNTERS
     counters: {
       totalReassignments: { type: Number, default: 0 },

package/modules/picker/schemas/business.js

@@ -68,14 +68,11 @@ module.exports = (connection) => {
   const BusinessSchema = new connection.base.Schema({
     companyMobile: {
       type: String,
-      index: true,
       trim: true,
-      sparse: true,
     },
     companyCountryCode: { type: String },
     companyFullMobile: {
       type: String,
-      index: true,
     },
 
     companyName: { type: String },
@@ -151,8 +148,6 @@ module.exports = (connection) => {
     deviceToken: {
       type: String,
       trim: true,
-      index: true,
-      sparse: true,
     },
     // #endregion Device information
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picker-db",
-  "version": "4.13.0",
+  "version": "4.15.0",
   "description": "Picker DB services",
   "main": "index.js",
   "scripts": {