mongoose 8.17.0 → 8.17.2

package/lib/document.js

@@ -4070,15 +4070,17 @@ Document.prototype.$__toObjectShallow = function $__toObjectShallow(schemaFields
  *
  * If you want to skip transformations, use `transform: false`:
  *
- *     schema.options.toObject.hide = '_id';
- *     schema.options.toObject.transform = function (doc, ret, options) {
- *       if (options.hide) {
- *         options.hide.split(' ').forEach(function (prop) {
- *           delete ret[prop];
- *         });
+ *     schema.options.toObject = {
+ *       hide: '_id',
+ *       transform: function(doc, ret, options) {
+ *         if (options.hide) {
+ *           options.hide.split(' ').forEach(function(prop) {
+ *             delete ret[prop];
+ *           });
+ *         }
+ *         return ret;
  *       }
- *       return ret;
- *     }
+ *     };
  *
  *     const doc = new Doc({ _id: 'anId', secret: 47, name: 'Wreck-it Ralph' });
  *     doc.toObject();                                        // { secret: 47, name: 'Wreck-it Ralph' }

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);
 };
 
@@ -4315,6 +4304,10 @@ Model.validate = async function validate(obj, pathsOrOptions, context) {
   let remaining = paths.size;
 
   return new Promise((resolve, reject) => {
+    if (remaining === 0) {
+      return settle();
+    }
+
     for (const path of paths) {
       const schemaType = schema.path(path);
       if (schemaType == null) {
@@ -4339,13 +4332,17 @@ Model.validate = async function validate(obj, pathsOrOptions, context) {
       }, context, { path: path });
     }
 
+    function settle() {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(obj);
+      }
+    }
+
     function _checkDone() {
       if (--remaining <= 0) {
-        if (error) {
-          reject(error);
-        } else {
-          resolve(obj);
-        }
+        return settle();
       }
     }
   });

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

@@ -654,6 +654,8 @@ function cast$elemMatch(val, context) {
  * For example, `$conditionalHandlers.$all` is the function Mongoose calls to cast `$all` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaArray
+ * @instance
  * @api public
  */
 

package/lib/schema/bigint.js

@@ -100,7 +100,7 @@ SchemaBigInt.get = SchemaType.get;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -190,6 +190,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBigInt
+ * @instance
  * @api public
  */
 

package/lib/schema/boolean.js

@@ -105,7 +105,7 @@ SchemaBoolean.get = SchemaType.get;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -242,6 +242,8 @@ const $conditionalHandlers = { ...SchemaType.prototype.$conditionalHandlers };
  * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBoolean
+ * @instance
  * @api public
  */
 

package/lib/schema/buffer.js

@@ -276,6 +276,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaBuffer
+ * @instance
  * @api public
  */
 

package/lib/schema/date.js

@@ -111,7 +111,7 @@ SchemaDate.get = SchemaType.get;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -402,6 +402,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$gte` is the function Mongoose calls to cast `$gte` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaDate
+ * @instance
  * @api public
  */
 

package/lib/schema/decimal128.js

@@ -227,6 +227,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$lte` is the function Mongoose calls to cast `$lte` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaDecimal128
+ * @instance
  * @api public
  */
 

package/lib/schema/documentArray.js

@@ -122,6 +122,8 @@ SchemaDocumentArray.prototype.OptionsConstructor = SchemaDocumentArrayOptions;
  * For example, `$conditionalHandlers.$size` is the function Mongoose calls to cast `$size` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaDocumentArray
+ * @instance
  * @api public
  */
 

package/lib/schema/double.js

@@ -115,7 +115,7 @@ SchemaDouble._defaultCaster = v => {
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -210,6 +210,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$lt` is the function Mongoose calls to cast `$lt` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaDouble
+ * @instance
  * @api public
  */
 

package/lib/schema/int32.js

@@ -119,7 +119,7 @@ SchemaInt32._defaultCaster = v => {
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -214,6 +214,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$gt` is the function Mongoose calls to cast `$gt` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaInt32
+ * @instance
  * @api public
  */
 

package/lib/schema/number.js

@@ -93,7 +93,7 @@ SchemaNumber._cast = castNumber;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -418,6 +418,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$gte` is the function Mongoose calls to cast `$gte` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaNumber
+ * @instance
  * @api public
  */
 

package/lib/schema/objectId.js

@@ -143,7 +143,7 @@ SchemaObjectId._cast = castObjectId;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -273,6 +273,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$in` is the function Mongoose calls to cast `$in` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaObjectId
+ * @instance
  * @api public
  */
 
@@ -310,6 +312,7 @@ function resetId(v) {
  * @param [options]
  * @param [options.useBsonType=false] If true, return a representation with `bsonType` for use with MongoDB's `$jsonSchema`.
  * @returns {Object} JSON schema properties
+ * @api public
  */
 
 SchemaObjectId.prototype.toJSONSchema = function toJSONSchema(options) {

package/lib/schema/string.js

@@ -75,7 +75,7 @@ SchemaString._cast = castString;
  *
  * @param {Function} caster
  * @return {Function}
- * @function get
+ * @function cast
  * @static
  * @api public
  */
@@ -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) {
@@ -665,6 +665,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaString
+ * @instance
  * @api public
  */
 

package/lib/schema/subdocument.js

@@ -158,6 +158,8 @@ $conditionalHandlers.$exists = $exists;
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaSubdocument
+ * @instance
  * @api public
  */
 

package/lib/schema/uuid.js

@@ -263,6 +263,8 @@ const $conditionalHandlers = {
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaUUID
+ * @instance
  * @api public
  */
 

package/lib/schemaType.js

@@ -1643,6 +1643,8 @@ function handle$in(val, context) {
  * For example, `$conditionalHandlers.$exists` is the function Mongoose calls to cast `$exists` filter operators.
  *
  * @property $conditionalHandlers
+ * @memberOf SchemaType
+ * @instance
  * @api public
  */
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.17.0",
+  "version": "8.17.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -29,8 +29,8 @@
     "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/document.d.ts

@@ -256,12 +256,17 @@ 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>, 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(options: ToObjectOptions & { versionKey: false, virtuals: true, flattenObjectIds: true }): Omit<ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>, '__v'>;
+    toJSON(options: ToObjectOptions & { virtuals: true, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Omit<Require_id<DocType>, '__v'>>>;
+    toJSON(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>;
+    toJSON(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toJSON(options?: ToObjectOptions & { flattenMaps?: true, flattenObjectIds?: false }): FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: false }): FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false }): Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType>, ResolveSchemaOptions<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>;
@@ -270,9 +275,15 @@ declare module 'mongoose' {
     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>, TSchemaOptions>;
-    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>, TSchemaOptions>;
-    toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>, TSchemaOptions>;
+    toObject(options: ToObjectOptions & { versionKey: false, virtuals: true, flattenObjectIds: true }): Omit<ObjectIdToString<Require_id<DocType & TVirtuals>>, '__v'>;
+    toObject(options: ToObjectOptions & { virtuals: true, flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): Omit<ObjectIdToString<Require_id<DocType & TVirtuals>>, '__v'>;
+    toObject(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toObject(options: ToObjectOptions & { virtuals: true }): Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>;
+    toObject(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toObject(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<Default__v<Require_id<DocType & TVirtuals>, ResolveSchemaOptions<TSchemaOptions>>>;
+    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>, ResolveSchemaOptions<TSchemaOptions>>;
+    toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>, ResolveSchemaOptions<TSchemaOptions>>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified<T extends keyof DocType>(path: T): void;

package/types/index.d.ts

@@ -140,9 +140,21 @@ declare module 'mongoose' {
     ? IfAny<U, T & { _id: Types.ObjectId }, T & Required<{ _id: U }>>
     : T & { _id: Types.ObjectId };
 
-  export type Default__v<T, TSchemaOptions = {}> = TSchemaOptions extends { versionKey: false } ? T : T extends { __v?: infer U }
+  export type Default__v<T, TSchemaOptions = {}> = TSchemaOptions extends { versionKey: false }
     ? T
-    : T & { __v: number };
+    : TSchemaOptions extends { versionKey: infer VK }
+      ? (
+          // If VK is a *literal* string, add that property
+          T & {
+            [K in VK as K extends string
+              ? (string extends K ? never : K) // drop if wide string
+              : never
+            ]: number
+          }
+        )
+      : T extends { __v?: infer U }
+        ? T
+        : T & { __v: number };
 
   /** Helper type for getting the hydrated document type from the raw document type. The hydrated document type is what `new MyModel()` returns. */
   export type HydratedDocument<
@@ -704,9 +716,9 @@ declare module 'mongoose' {
           [K in keyof T]?: T[K] extends Record<string, any> ? Projector<T[K], Element> | Element : Element;
         }
         : Element;
-  type _IDType = { _id?: boolean | 1 | 0 };
+  type _IDType = { _id?: boolean | number };
   export type InclusionProjection<T> = IsItRecordAndNotAny<T> extends true
-    ? Omit<Projector<WithLevel1NestedPaths<T>, true | 1>, '_id'> & _IDType
+    ? Omit<Projector<WithLevel1NestedPaths<T>, boolean | number>, '_id'> & _IDType
     : AnyObject;
   export type ExclusionProjection<T> = IsItRecordAndNotAny<T> extends true
     ? Omit<Projector<WithLevel1NestedPaths<T>, false | 0>, '_id'> & _IDType

package/types/schematypes.d.ts

@@ -207,9 +207,11 @@ declare module 'mongoose' {
 
     /** If set, Mongoose will add a custom validator that ensures the given string's `length` is at least the given number. */
     minlength?: number | [number, string] | readonly [number, string];
+    minLength?: number | [number, string] | readonly [number, string];
 
     /** If set, Mongoose will add a custom validator that ensures the given string's `length` is at most the given number. */
     maxlength?: number | [number, string] | readonly [number, string];
+    maxLength?: number | [number, string] | readonly [number, string];
 
     [other: string]: any;