mongoose 8.9.0 → 8.9.2

package/lib/query.js

@@ -2247,10 +2247,7 @@ Query.prototype.error = function error(err) {
  */
 
 Query.prototype._unsetCastError = function _unsetCastError() {
-  if (this._error == null) {
-    return;
-  }
-  if (this._error != null && !(this._error instanceof CastError)) {
+  if (this._error == null || !(this._error instanceof CastError)) {
     return;
   }
   return this.error(null);
@@ -3197,7 +3194,6 @@ Query.prototype.deleteMany = function(filter, options) {
 /**
  * Execute a `deleteMany()` query
  *
- * @param {Function} callback
  * @method _deleteMany
  * @instance
  * @memberOf Query
@@ -3490,13 +3486,6 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  *
- * #### Callback Signature
- *
- *     function(error, doc) {
- *       // error: any errors that occurred
- *       // doc: the document before updates are applied if `new: false`, or after updates if `new = true`
- *     }
- *
  * #### Example:
  *
  *     A.where().findOneAndDelete(conditions, options)  // return Query
@@ -3587,13 +3576,6 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `includeResultMetadata`: if true, returns the full [ModifyResult from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html) rather than just the document
  *
- * #### Callback Signature
- *
- *     function(error, doc) {
- *       // error: any errors that occurred
- *       // doc: the document before updates are applied if `new: false`, or after updates if `new = true`
- *     }
- *
  * #### Example:
  *
  *     A.where().findOneAndReplace(filter, replacement, options); // return Query
@@ -4025,7 +4007,6 @@ Query.prototype._replaceOne = async function _replaceOne() {
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {Boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @param {Boolean} [options.overwriteImmutable=false] Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert). Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
- * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
@@ -4096,7 +4077,6 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @param {Boolean} [options.overwriteDiscriminatorKey=false] Mongoose removes discriminator key updates from `update` by default, set `overwriteDiscriminatorKey` to `true` to allow updating the discriminator key
  * @param {Boolean} [options.overwriteImmutable=false] Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert). Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
- * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
@@ -4163,7 +4143,6 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](https://mongoosejs.com/docs/guide.html#writeConcern)
  * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
- * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html

package/lib/schema/string.js

@@ -181,11 +181,11 @@ SchemaString.checkRequired = SchemaType.checkRequired;
  *     const s = new Schema({ state: { type: String, enum: states }})
  *     const M = db.model('M', s)
  *     const m = new M({ state: 'invalid' })
- *     m.save(function (err) {
- *       console.error(String(err)) // ValidationError: `invalid` is not a valid enum value for path `state`.
- *       m.state = 'open'
- *       m.save(callback) // success
- *     })
+ *     await m.save()
+ *       .catch((err) => console.error(err)); // ValidationError: `invalid` is not a valid enum value for path `state`.
+ *     m.state = 'open';
+ *     await m.save();
+ *     // success
  *
  *     // or with custom error messages
  *     const enum = {
@@ -195,11 +195,11 @@ SchemaString.checkRequired = SchemaType.checkRequired;
  *     const s = new Schema({ state: { type: String, enum: enum })
  *     const M = db.model('M', s)
  *     const m = new M({ state: 'invalid' })
- *     m.save(function (err) {
- *       console.error(String(err)) // ValidationError: enum validator failed for path `state` with value `invalid`
- *       m.state = 'open'
- *       m.save(callback) // success
- *     })
+ *     await m.save()
+ *       .catch((err) => console.error(err)); // ValidationError: enum validator failed for path `state` with value `invalid`
+ *     m.state = 'open';
+ *     await m.save();
+ *     // success
  *
  * @param {...String|Object} [args] enumeration values
  * @return {SchemaType} this

package/lib/schema.js

@@ -18,13 +18,13 @@ const getConstructorName = require('./helpers/getConstructorName');
 const getIndexes = require('./helpers/schema/getIndexes');
 const handleReadPreferenceAliases = require('./helpers/query/handleReadPreferenceAliases');
 const idGetter = require('./helpers/schema/idGetter');
+const isIndexSpecEqual = require('./helpers/indexes/isIndexSpecEqual');
 const merge = require('./helpers/schema/merge');
 const mpath = require('mpath');
 const setPopulatedVirtualValue = require('./helpers/populate/setPopulatedVirtualValue');
 const setupTimestamps = require('./helpers/timestamps/setupTimestamps');
 const utils = require('./utils');
 const validateRef = require('./helpers/populate/validateRef');
-const util = require('util');
 
 const hasNumericSubpathRegex = /\.\d+(\.|$)/;
 
@@ -441,7 +441,7 @@ Schema.prototype._clone = function _clone(Constructor) {
       }
     }
   }
-  s.childSchemas = gatherChildSchemas(s);
+  s._gatherChildSchemas();
 
   s.virtuals = clone(this.virtuals);
   s.$globalPluginsApplied = this.$globalPluginsApplied;
@@ -899,7 +899,7 @@ Schema.prototype.removeIndex = function removeIndex(index) {
 
   if (typeof index === 'object') {
     for (let i = this._indexes.length - 1; i >= 0; --i) {
-      if (util.isDeepStrictEqual(this._indexes[i][0], index)) {
+      if (isIndexSpecEqual(this._indexes[i][0], index)) {
         this._indexes.splice(i, 1);
       }
     }
@@ -1238,20 +1238,32 @@ Schema.prototype.path = function(path, obj) {
  * ignore
  */
 
-function gatherChildSchemas(schema) {
+Schema.prototype._gatherChildSchemas = function _gatherChildSchemas() {
   const childSchemas = [];
 
-  for (const path of Object.keys(schema.paths)) {
-    const schematype = schema.paths[path];
+  for (const path of Object.keys(this.paths)) {
+    if (typeof path !== 'string') {
+      continue;
+    }
+    const schematype = this.paths[path];
     if (schematype.$isMongooseDocumentArray || schematype.$isSingleNested) {
-      childSchemas.push({ schema: schematype.schema, model: schematype.caster, path: path });
+      childSchemas.push({
+        schema: schematype.schema,
+        model: schematype.caster,
+        path: path
+      });
     } else if (schematype.$isSchemaMap && schematype.$__schemaType.$isSingleNested) {
-      childSchemas.push({ schema: schematype.$__schemaType.schema, model: schematype.$__schemaType.caster, path: path });
+      childSchemas.push({
+        schema: schematype.$__schemaType.schema,
+        model: schematype.$__schemaType.caster,
+        path: path
+      });
     }
   }
 
+  this.childSchemas = childSchemas;
   return childSchemas;
-}
+};
 
 /*!
  * ignore
@@ -2134,6 +2146,12 @@ Schema.prototype.index = function(fields, options) {
     }
   }
 
+  for (const existingIndex of this.indexes()) {
+    if (options.name == null && existingIndex[1].name == null && isIndexSpecEqual(existingIndex[0], fields)) {
+      throw new MongooseError(`Schema already has an index on ${JSON.stringify(fields)}`);
+    }
+  }
+
   this._indexes.push([fields, options]);
   return this;
 };

package/lib/types/map.js

@@ -9,6 +9,7 @@ const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const util = require('util');
 const specialProperties = require('../helpers/specialProperties');
 const isBsonType = require('../helpers/isBsonType');
+const cleanModifiedSubpaths = require('../helpers/document/cleanModifiedSubpaths');
 
 const populateModelSymbol = require('../helpers/symbols').populateModelSymbol;
 
@@ -157,7 +158,13 @@ class MongooseMap extends Map {
     super.set(key, value);
 
     if (parent != null && parent.$__ != null && !deepEqual(value, priorVal)) {
-      parent.markModified(fullPath.call(this));
+      const path = fullPath.call(this);
+      parent.markModified(path);
+      // If overwriting the full document array or subdoc, make sure to clean up any paths that were modified
+      // before re: #15108
+      if (this.$__schemaType.$isMongooseDocumentArray || this.$__schemaType.$isSingleNested) {
+        cleanModifiedSubpaths(parent, path);
+      }
     }
 
     // Delay calculating full path unless absolutely necessary, because string

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.9.0",
+  "version": "8.9.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -30,8 +30,8 @@
   "devDependencies": {
     "@babel/core": "7.26.0",
     "@babel/preset-env": "7.26.0",
-    "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@typescript-eslint/parser": "^8.4.0",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
     "acquit": "1.3.0",
     "acquit-ignore": "0.2.1",
     "acquit-require": "0.1.1",

package/types/index.d.ts

@@ -572,7 +572,8 @@ declare module 'mongoose' {
     | typeof Schema.Types.Number
     | typeof Schema.Types.String
     | typeof Schema.Types.Buffer
-    | typeof Schema.Types.ObjectId;
+    | typeof Schema.Types.ObjectId
+    | typeof Schema.Types.UUID;
 
 
   export type InferId<T> = T extends { _id?: any } ? T['_id'] : Types.ObjectId;
@@ -712,76 +713,82 @@ declare module 'mongoose' {
   /**
    * Converts any Buffer properties into mongodb.Binary instances, which is what `lean()` returns
    */
-  export type BufferToBinary<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends Buffer
-      ? mongodb.Binary
-      : T[K] extends (Buffer | null | undefined)
-        ? mongodb.Binary | null | undefined
-        : T[K] extends Types.DocumentArray<infer ItemType>
+  export type BufferToBinary<T> = T extends Buffer
+    ? mongodb.Binary
+    : T extends TreatAsPrimitives
+      ? T
+      : T extends Record<string, any> ? {
+        [K in keyof T]: T[K] extends Buffer
+          ? mongodb.Binary
+          : T[K] extends Types.DocumentArray<infer ItemType>
             ? Types.DocumentArray<BufferToBinary<ItemType>>
             : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
               ? HydratedSingleSubdocument<SubdocType>
               : BufferToBinary<T[K]>;
-  } : T;
+      } : T;
 
   /**
    * Converts any Buffer properties into { type: 'buffer', data: [1, 2, 3] } format for JSON serialization
    */
-  export type BufferToJSON<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends Buffer
-      ? { type: 'buffer', data: number[] }
-      : T[K] extends (Buffer | null | undefined)
-        ? { type: 'buffer', data: number[] } | null | undefined
-        : T[K] extends Types.DocumentArray<infer ItemType>
-            ? Types.DocumentArray<BufferToBinary<ItemType>>
-            : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-              ? HydratedSingleSubdocument<SubdocType>
-              : BufferToBinary<T[K]>;
-  } : T;
+  export type BufferToJSON<T> = T extends Buffer
+    ? { type: 'buffer', data: number[] }
+    : T extends TreatAsPrimitives
+      ? T
+      : T extends Record<string, any> ? {
+        [K in keyof T]: T[K] extends Buffer
+          ? { type: 'buffer', data: number[] }
+          : T[K] extends Types.DocumentArray<infer ItemType>
+              ? Types.DocumentArray<BufferToBinary<ItemType>>
+              : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                ? HydratedSingleSubdocument<SubdocType>
+                : BufferToBinary<T[K]>;
+      } : T;
 
   /**
    * Converts any ObjectId properties into strings for JSON serialization
    */
-  export type ObjectIdToString<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends mongodb.ObjectId
-      ? string
-      : T[K] extends (mongodb.ObjectId | null | undefined)
-        ? string | null | undefined
-        : T[K] extends Types.DocumentArray<infer ItemType>
-            ? Types.DocumentArray<ObjectIdToString<ItemType>>
-            : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-              ? HydratedSingleSubdocument<ObjectIdToString<SubdocType>>
-              : ObjectIdToString<T[K]>;
-  } : T;
+  export type ObjectIdToString<T> = T extends mongodb.ObjectId
+    ? string
+    : T extends TreatAsPrimitives
+      ? T
+      : T extends Record<string, any> ? {
+        [K in keyof T]: T[K] extends mongodb.ObjectId
+          ? string
+          : T[K] extends Types.DocumentArray<infer ItemType>
+              ? Types.DocumentArray<ObjectIdToString<ItemType>>
+              : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                ? HydratedSingleSubdocument<ObjectIdToString<SubdocType>>
+                : ObjectIdToString<T[K]>;
+      } : T;
 
   /**
    * Converts any Date properties into strings for JSON serialization
    */
-  export type DateToString<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends NativeDate
-      ? string
-      : T[K] extends (NativeDate | null | undefined)
-        ? string | null | undefined
-        : T[K] extends Types.DocumentArray<infer ItemType>
-            ? Types.DocumentArray<DateToString<ItemType>>
-            : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-              ? HydratedSingleSubdocument<DateToString<SubdocType>>
-              : DateToString<T[K]>;
-  } : T;
+  export type DateToString<T> = T extends NativeDate
+    ? string
+    : T extends TreatAsPrimitives
+      ? T
+      : T extends Record<string, any> ? {
+        [K in keyof T]: T[K] extends NativeDate
+          ? string
+          : T[K] extends (NativeDate | null | undefined)
+            ? string | null | undefined
+            : T[K] extends Types.DocumentArray<infer ItemType>
+                ? Types.DocumentArray<DateToString<ItemType>>
+                : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+                  ? HydratedSingleSubdocument<DateToString<SubdocType>>
+                  : DateToString<T[K]>;
+      } : T;
 
   /**
    * Converts any Mongoose subdocuments (single nested or doc arrays) into POJO equivalents
    */
   export type SubdocsToPOJOs<T> = T extends TreatAsPrimitives ? T : T extends Record<string, any> ? {
-    [K in keyof T]: T[K] extends NativeDate
-      ? string
-      : T[K] extends (NativeDate | null | undefined)
-        ? string | null | undefined
-        : T[K] extends Types.DocumentArray<infer ItemType>
-            ? ItemType[]
-            : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
-              ? SubdocType
-              : SubdocsToPOJOs<T[K]>;
+    [K in keyof T]: T[K] extends Types.DocumentArray<infer ItemType>
+      ? ItemType[]
+      : T[K] extends Types.Subdocument<unknown, unknown, infer SubdocType>
+        ? SubdocType
+        : SubdocsToPOJOs<T[K]>;
   } : T;
 
   export type JSONSerialized<T> = SubdocsToPOJOs<