mongoose 8.16.5 → 8.17.1

package/lib/helpers/model/discriminator.js

@@ -14,7 +14,8 @@ const CUSTOMIZABLE_DISCRIMINATOR_OPTIONS = {
   _id: true,
   id: true,
   virtuals: true,
-  methods: true
+  methods: true,
+  statics: true
 };
 
 /**

package/lib/model.js

@@ -1099,7 +1099,7 @@ Model.init = function init() {
       return;
     }
 
-    return await this.ensureSearchIndexes();
+    return await this.createSearchIndexes();
   };
   const _createCollection = async() => {
     let autoCreate = utils.getOption(
@@ -2092,9 +2092,7 @@ Model.find = function find(conditions, projection, options) {
 };
 
 /**
- * Finds a single document by its _id field. `findById(id)` is almost*
- * equivalent to `findOne({ _id: id })`. If you want to query by a document's
- * `_id`, use `findById()` instead of `findOne()`.
+ * Finds a single document by its _id field. `findById(id)` is equivalent to `findOne({ _id: id })`.
  *
  * The `id` is cast based on the Schema before sending the command.
  *
@@ -2102,11 +2100,6 @@ Model.find = function find(conditions, projection, options) {
  *
  * - `findOne()`
  *
- * \* Except for how it treats `undefined`. If you use `findOne()`, you'll see
- * that `findOne(undefined)` and `findOne({ _id: undefined })` are equivalent
- * to `findOne({})` and return arbitrary documents. However, mongoose
- * translates `findById(undefined)` into `findOne({ _id: null })`.
- *
  * #### Example:
  *
  *     // Find the adventure with the given `id`, or `null` if not found
@@ -2131,10 +2124,6 @@ Model.findById = function findById(id, projection, options) {
     throw new MongooseError('Model.findById() no longer accepts a callback');
   }
 
-  if (typeof id === 'undefined') {
-    id = null;
-  }
-
   return this.findOne({ _id: id }, projection, options);
 };
 

package/lib/mongoose.js

@@ -855,6 +855,17 @@ Mongoose.prototype.nextConnectionId;
 
 Mongoose.prototype.Aggregate = Aggregate;
 
+/**
+ * The Base Mongoose Collection class. `mongoose.Collection` extends from this class.
+ *
+ * @memberOf Mongoose
+ * @instance
+ * @method Collection
+ * @api public
+ */
+
+Mongoose.prototype.BaseCollection = require('./collection');
+
 /**
  * The Mongoose Collection constructor
  *
@@ -895,6 +906,17 @@ Object.defineProperty(Mongoose.prototype, 'Connection', {
   }
 });
 
+/**
+ * The Base Mongoose Connection class. `mongoose.Connection` extends from this class.
+ *
+ * @memberOf Mongoose
+ * @instance
+ * @method Connection
+ * @api public
+ */
+
+Mongoose.prototype.BaseConnection = require('./connection');
+
 /**
  * The Mongoose version
  *

package/lib/query.js

@@ -2133,6 +2133,29 @@ Query.prototype._optionsForExec = function(model) {
     }
   }
 
+  if (this._mongooseOptions.populate) {
+    if (options.readPreference) {
+      for (const pop of Object.values(this._mongooseOptions.populate)) {
+        if (pop.options?.readPreference === undefined) {
+          if (!pop.options) {
+            pop.options = {};
+          }
+          pop.options.readPreference = options.readPreference;
+        }
+      }
+    }
+    if (options.readConcern) {
+      for (const pop of Object.values(this._mongooseOptions.populate)) {
+        if (pop.options?.readConcern === undefined) {
+          if (!pop.options) {
+            pop.options = {};
+          }
+          pop.options.readConcern = options.readConcern;
+        }
+      }
+    }
+  }
+
   return options;
 };
 
@@ -4918,24 +4941,6 @@ Query.prototype.populate = function() {
 
   const res = utils.populate.apply(null, args);
 
-  // Propagate readConcern and readPreference and lean from parent query,
-  // unless one already specified
-  if (this.options != null) {
-    const readConcern = this.options.readConcern;
-    const readPref = this.options.readPreference;
-
-    for (const populateOptions of res) {
-      if (readConcern != null && (populateOptions && populateOptions.options && populateOptions.options.readConcern) == null) {
-        populateOptions.options = populateOptions.options || {};
-        populateOptions.options.readConcern = readConcern;
-      }
-      if (readPref != null && (populateOptions && populateOptions.options && populateOptions.options.readPreference) == null) {
-        populateOptions.options = populateOptions.options || {};
-        populateOptions.options.readPreference = readPref;
-      }
-    }
-  }
-
   const opts = this._mongooseOptions;
 
   if (opts.lean != null) {

package/lib/schema/array.js

@@ -649,6 +649,14 @@ function cast$elemMatch(val, context) {
   return val;
 }
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$all` is the function Mongoose calls to cast `$all` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 const handle = SchemaArray.prototype.$conditionalHandlers = {};
 
 handle.$all = cast$all;

package/lib/schema/bigint.js

@@ -185,6 +185,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaBigInt.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/boolean.js

@@ -237,6 +237,14 @@ SchemaBoolean.prototype.cast = function(value) {
 
 const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaBoolean.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/buffer.js

@@ -271,6 +271,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaBuffer.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/date.js

@@ -397,6 +397,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$gte` is the function Mongoose calls to cast `$gte` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaDate.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/decimal128.js

@@ -222,6 +222,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$lte` is the function Mongoose calls to cast `$lte` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaDecimal128.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/documentArray.js

@@ -116,7 +116,19 @@ SchemaDocumentArray.options = { castNonArrays: true };
 SchemaDocumentArray.prototype = Object.create(SchemaArray.prototype);
 SchemaDocumentArray.prototype.constructor = SchemaDocumentArray;
 SchemaDocumentArray.prototype.OptionsConstructor = SchemaDocumentArrayOptions;
-SchemaDocumentArray.prototype.$conditionalHandlers = { ...SchemaArray.prototype.$conditionalHandlers };
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$size` is the function Mongoose calls to cast `$size` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
+Object.defineProperty(SchemaDocumentArray.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: { ...SchemaArray.prototype.$conditionalHandlers }
+});
 
 /*!
  * ignore

package/lib/schema/double.js

@@ -205,6 +205,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$lt` is the function Mongoose calls to cast `$lt` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaDouble.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/int32.js

@@ -209,6 +209,14 @@ const $conditionalHandlers = {
   $bitsAnySet: handleBitwiseOperator
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$gt` is the function Mongoose calls to cast `$gt` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaInt32.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/number.js

@@ -413,6 +413,14 @@ const $conditionalHandlers = {
   $mod: handleArray
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$gte` is the function Mongoose calls to cast `$gte` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaNumber.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/objectId.js

@@ -268,6 +268,14 @@ const $conditionalHandlers = {
   $lte: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaObjectId.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/string.js

@@ -381,7 +381,7 @@ SchemaString.prototype.trim = function(shouldTrim) {
  *
  * #### Example:
  *
- *     const schema = new Schema({ postalCode: { type: String, minlength: 5 })
+ *     const schema = new Schema({ postalCode: { type: String, minLength: 5 })
  *     const Address = db.model('Address', schema)
  *     const address = new Address({ postalCode: '9512' })
  *     address.save(function (err) {
@@ -392,8 +392,8 @@ SchemaString.prototype.trim = function(shouldTrim) {
  *
  *     // custom error messages
  *     // We can also use the special {MINLENGTH} token which will be replaced with the minimum allowed length
- *     const minlength = [5, 'The value of path `{PATH}` (`{VALUE}`) is shorter than the minimum allowed length ({MINLENGTH}).'];
- *     const schema = new Schema({ postalCode: { type: String, minlength: minlength })
+ *     const minLength = [5, 'The value of path `{PATH}` (`{VALUE}`) is shorter than the minimum allowed length ({MINLENGTH}).'];
+ *     const schema = new Schema({ postalCode: { type: String, minLength: minLength })
  *     const Address = mongoose.model('Address', schema);
  *     const address = new Address({ postalCode: '9512' });
  *     address.validate(function (err) {
@@ -660,6 +660,14 @@ const $conditionalHandlers = {
   $not: handleSingle
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaString.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schema/subdocument.js

@@ -117,6 +117,11 @@ function _createConstructor(schema, baseClass, options) {
   return _embedded;
 }
 
+/*!
+ * ignore
+ */
+const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
+
 /**
  * Special case for when users use a common location schema to represent
  * locations for use with $geoWithin.
@@ -126,7 +131,7 @@ function _createConstructor(schema, baseClass, options) {
  * @api private
  */
 
-SchemaSubdocument.prototype.$conditionalHandlers.$geoWithin = function handle$geoWithin(val, context) {
+$conditionalHandlers.$geoWithin = function handle$geoWithin(val, context) {
   return { $geometry: this.castForQuery(null, val.$geometry, context) };
 };
 
@@ -134,19 +139,32 @@ SchemaSubdocument.prototype.$conditionalHandlers.$geoWithin = function handle$ge
  * ignore
  */
 
-SchemaSubdocument.prototype.$conditionalHandlers.$near =
-SchemaSubdocument.prototype.$conditionalHandlers.$nearSphere = geospatial.cast$near;
+$conditionalHandlers.$near =
+$conditionalHandlers.$nearSphere = geospatial.cast$near;
 
-SchemaSubdocument.prototype.$conditionalHandlers.$within =
-SchemaSubdocument.prototype.$conditionalHandlers.$geoWithin = geospatial.cast$within;
+$conditionalHandlers.$within =
+$conditionalHandlers.$geoWithin = geospatial.cast$within;
 
-SchemaSubdocument.prototype.$conditionalHandlers.$geoIntersects =
+$conditionalHandlers.$geoIntersects =
   geospatial.cast$geoIntersects;
 
-SchemaSubdocument.prototype.$conditionalHandlers.$minDistance = castToNumber;
-SchemaSubdocument.prototype.$conditionalHandlers.$maxDistance = castToNumber;
+$conditionalHandlers.$minDistance = castToNumber;
+$conditionalHandlers.$maxDistance = castToNumber;
+
+$conditionalHandlers.$exists = $exists;
+
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
 
-SchemaSubdocument.prototype.$conditionalHandlers.$exists = $exists;
+Object.defineProperty(SchemaSubdocument.prototype, '$conditionalHandlers', {
+  enumerable: false,
+  value: $conditionalHandlers
+});
 
 /**
  * Casts contents

package/lib/schema/uuid.js

@@ -258,6 +258,14 @@ const $conditionalHandlers = {
   $nin: handleArray
 };
 
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
+ */
+
 Object.defineProperty(SchemaUUID.prototype, '$conditionalHandlers', {
   enumerable: false,
   value: $conditionalHandlers

package/lib/schemaType.js

@@ -1638,8 +1638,12 @@ function handle$in(val, context) {
   });
 }
 
-/*!
- * ignore
+/**
+ * Contains the handlers for different query operators for this schema type.
+ * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
+ *
+ * @property $conditionalHandlers
+ * @api public
  */
 
 SchemaType.prototype.$conditionalHandlers = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.16.5",
+  "version": "8.17.1",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -22,15 +22,15 @@
   "dependencies": {
     "bson": "^6.10.4",
     "kareem": "2.6.3",
-    "mongodb": "~6.17.0",
+    "mongodb": "~6.18.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",
     "sift": "17.1.3"
   },
   "devDependencies": {
-    "@babel/core": "7.27.7",
-    "@babel/preset-env": "7.27.2",
+    "@babel/core": "7.28.0",
+    "@babel/preset-env": "7.28.0",
     "@mongodb-js/mongodb-downloader": "^0.4.2",
     "@typescript-eslint/eslint-plugin": "^8.19.1",
     "@typescript-eslint/parser": "^8.19.1",
@@ -42,7 +42,7 @@
     "babel-loader": "8.2.5",
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
-    "cheerio": "1.1.0",
+    "cheerio": "1.1.2",
     "crypto-browserify": "3.12.1",
     "dox": "1.0.0",
     "eslint": "8.57.1",
@@ -69,7 +69,7 @@
     "tsd": "0.32.0",
     "typescript": "5.8.3",
     "uuid": "11.1.0",
-    "webpack": "5.99.9"
+    "webpack": "5.101.0"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/aggregate.d.ts

@@ -4,7 +4,7 @@ declare module 'mongoose' {
   /** Extract generic type from Aggregate class */
   type AggregateExtract<P> = P extends Aggregate<infer T> ? T : never;
 
-  interface AggregateOptions extends Omit<mongodb.AggregateOptions, 'session'>, SessionOption {
+  interface AggregateOptions extends Omit<mongodb.AggregateOptions & mongodb.Abortable, 'session'>, SessionOption {
     [key: string]: any;
   }
 

package/types/collection.d.ts

@@ -21,6 +21,8 @@ declare module 'mongoose' {
     name: string;
   }
 
+  export type BaseCollection<T extends mongodb.Document> = CollectionBase<T>;
+
   /*
    * section drivers/node-mongodb-native/collection.js
    */

package/types/connection.d.ts

@@ -71,6 +71,8 @@ declare module 'mongoose' {
       };
   }[keyof SchemaMap];
 
+  export type BaseConnection = Connection;
+
   class Connection extends events.EventEmitter implements SessionStarter {
     /** Runs a [db-level aggregate()](https://www.mongodb.com/docs/manual/reference/method/db.aggregate/) on this connection's underlying `db` */
     aggregate<ResultType = unknown>(pipeline?: PipelineStage[] | null, options?: AggregateOptions): Aggregate<Array<ResultType>>;

package/types/document.d.ts

@@ -18,7 +18,7 @@ declare module 'mongoose' {
    * *  TQueryHelpers - Object with any helpers that should be mixed into the Query type
    * *  DocType - the type of the actual Document created
    */
-  class Document<T = unknown, TQueryHelpers = any, DocType = any, TVirtuals = Record<string, any>> {
+  class Document<T = unknown, TQueryHelpers = any, DocType = any, TVirtuals = Record<string, any>, TSchemaOptions = {}> {
     constructor(doc?: any);
 
     /** This documents _id. */
@@ -256,23 +256,23 @@ declare module 'mongoose' {
     set(value: string | Record<string, any>): this;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>>;
-    toJSON(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<Default__v<Require_id<DocType>>>;
-    toJSON(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<Default__v<Require_id<DocType>>>;
-    toJSON(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType>>>>;
-    toJSON(options: ToObjectOptions & { flattenMaps: false }): Default__v<Require_id<DocType>>;
-    toJSON(options: ToObjectOptions & { flattenMaps: false; flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType>>>;
-
-    toJSON<T = Default__v<Require_id<DocType>>>(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<T>;
-    toJSON<T = Default__v<Require_id<DocType>>>(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<T>;
-    toJSON<T = Default__v<Require_id<DocType>>>(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<T>>;
-    toJSON<T = Default__v<Require_id<DocType>>>(options: ToObjectOptions & { flattenMaps: false }): T;
-    toJSON<T = Default__v<Require_id<DocType>>>(options: ToObjectOptions & { flattenMaps: false; flattenObjectIds: true }): ObjectIdToString<T>;
+    toJSON(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, TSchemaOptions>;
+    toJSON(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<Default__v<Require_id<DocType>, TSchemaOptions>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<Default__v<Require_id<DocType>, TSchemaOptions>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType>, TSchemaOptions>>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false }): Default__v<Require_id<DocType>, TSchemaOptions>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false; flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType>, TSchemaOptions>>;
+
+    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<T>;
+    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<T>;
+    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<T>>;
+    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenMaps: false }): T;
+    toJSON<T = Default__v<Require_id<DocType>, TSchemaOptions>>(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true }): ObjectIdToString<T>;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>>;
-    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>>;
-    toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>>;
+    toObject(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, TSchemaOptions>;
+    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>, TSchemaOptions>;
+    toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>, TSchemaOptions>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified<T extends keyof DocType>(path: T): void;