mongoose 8.5.4 → 8.6.0

package/lib/cursor/changeStream.js

@@ -33,15 +33,18 @@ class ChangeStream extends EventEmitter {
       );
     }
 
-    // This wrapper is necessary because of buffering.
-    changeStreamThunk((err, driverChangeStream) => {
-      if (err != null) {
-        this.emit('error', err);
-        return;
-      }
+    this.$driverChangeStreamPromise = new Promise((resolve, reject) => {
+      // This wrapper is necessary because of buffering.
+      changeStreamThunk((err, driverChangeStream) => {
+        if (err != null) {
+          this.emit('error', err);
+          return reject(err);
+        }
 
-      this.driverChangeStream = driverChangeStream;
-      this.emit('ready');
+        this.driverChangeStream = driverChangeStream;
+        this.emit('ready');
+        resolve();
+      });
     });
   }
 
@@ -53,20 +56,23 @@ class ChangeStream extends EventEmitter {
     this.bindedEvents = true;
 
     if (this.driverChangeStream == null) {
-      this.once('ready', () => {
-        this.driverChangeStream.on('close', () => {
-          this.closed = true;
-        });
+      this.$driverChangeStreamPromise.then(
+        () => {
+          this.driverChangeStream.on('close', () => {
+            this.closed = true;
+          });
 
-        driverChangeStreamEvents.forEach(ev => {
-          this.driverChangeStream.on(ev, data => {
-            if (data != null && data.fullDocument != null && this.options && this.options.hydrate) {
-              data.fullDocument = this.options.model.hydrate(data.fullDocument);
-            }
-            this.emit(ev, data);
+          driverChangeStreamEvents.forEach(ev => {
+            this.driverChangeStream.on(ev, data => {
+              if (data != null && data.fullDocument != null && this.options && this.options.hydrate) {
+                data.fullDocument = this.options.model.hydrate(data.fullDocument);
+              }
+              this.emit(ev, data);
+            });
           });
-        });
-      });
+        },
+        () => {} // No need to register events if opening change stream failed
+      );
 
       return;
     }
@@ -142,8 +148,12 @@ class ChangeStream extends EventEmitter {
     this.closed = true;
     if (this.driverChangeStream) {
       return this.driverChangeStream.close();
+    } else {
+      return this.$driverChangeStreamPromise.then(
+        () => this.driverChangeStream.close(),
+        () => {} // No need to close if opening the change stream failed
+      );
     }
-    return Promise.resolve();
   }
 }
 

package/lib/cursor/queryCursor.js

@@ -10,6 +10,7 @@ const eachAsync = require('../helpers/cursor/eachAsync');
 const helpers = require('../queryHelpers');
 const kareem = require('kareem');
 const immediate = require('../helpers/immediate');
+const { once } = require('node:events');
 const util = require('util');
 
 /**
@@ -42,6 +43,7 @@ function QueryCursor(query) {
   this.cursor = null;
   this.skipped = false;
   this.query = query;
+  this._closed = false;
   const model = query.model;
   this._mongooseOptions = {};
   this._transforms = [];
@@ -135,6 +137,25 @@ QueryCursor.prototype._read = function() {
   });
 };
 
+/**
+ * Returns the underlying cursor from the MongoDB Node driver that this cursor uses.
+ *
+ * @method getDriverCursor
+ * @memberOf QueryCursor
+ * @returns {Cursor} MongoDB Node driver cursor instance
+ * @instance
+ * @api public
+ */
+
+QueryCursor.prototype.getDriverCursor = async function getDriverCursor() {
+  if (this.cursor) {
+    return this.cursor;
+  }
+
+  await once(this, 'cursor');
+  return this.cursor;
+};
+
 /**
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
@@ -209,6 +230,7 @@ QueryCursor.prototype.close = async function close() {
   }
   try {
     await this.cursor.close();
+    this._closed = true;
     this.emit('close');
   } catch (error) {
     this.listeners('error').length > 0 && this.emit('error', error);
@@ -246,6 +268,9 @@ QueryCursor.prototype.next = async function next() {
   if (typeof arguments[0] === 'function') {
     throw new MongooseError('QueryCursor.prototype.next() no longer accepts a callback');
   }
+  if (this._closed) {
+    throw new MongooseError('Cannot call `next()` on a closed cursor');
+  }
   return new Promise((resolve, reject) => {
     _next(this, function(error, doc) {
       if (error) {

package/lib/document.js

@@ -842,7 +842,7 @@ function init(self, obj, doc, opts, prefix) {
  */
 
 Document.prototype.updateOne = function updateOne(doc, options, callback) {
-  const query = this.constructor.updateOne({ _id: this._id }, doc, options);
+  const query = this.constructor.updateOne({ _id: this._doc._id }, doc, options);
   const self = this;
   query.pre(function queryPreUpdateOne(cb) {
     self.constructor._middleware.execPre('updateOne', self, [self], cb);
@@ -883,7 +883,7 @@ Document.prototype.updateOne = function updateOne(doc, options, callback) {
 
 Document.prototype.replaceOne = function replaceOne() {
   const args = [...arguments];
-  args.unshift({ _id: this._id });
+  args.unshift({ _id: this._doc._id });
   return this.constructor.replaceOne.apply(this.constructor, args);
 };
 
@@ -3050,7 +3050,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
       } else if (val != null && val.$__ != null && val.$__.wasPopulated) {
         // Array paths, like `somearray.1`, do not show up as populated with `$populated()`,
         // so in that case pull out the document's id
-        val = val._id;
+        val = val._doc._id;
       }
       const scope = _this.$__.pathsToScopes != null && path in _this.$__.pathsToScopes ?
         _this.$__.pathsToScopes[path] :

package/lib/error/parallelSave.js

@@ -15,7 +15,7 @@ class ParallelSaveError extends MongooseError {
    */
   constructor(doc) {
     const msg = 'Can\'t save() the same doc multiple times in parallel. Document: ';
-    super(msg + doc._id);
+    super(msg + doc._doc._id);
   }
 }
 

package/lib/error/parallelValidate.js

@@ -16,7 +16,7 @@ class ParallelValidateError extends MongooseError {
    */
   constructor(doc) {
     const msg = 'Can\'t validate() the same doc multiple times in parallel. Document: ';
-    super(msg + doc._id);
+    super(msg + doc._doc._id);
   }
 }
 

package/lib/error/version.js

@@ -17,7 +17,7 @@ class VersionError extends MongooseError {
    */
   constructor(doc, currentVersion, modifiedPaths) {
     const modifiedPathsStr = modifiedPaths.join(', ');
-    super('No matching document found for id "' + doc._id +
+    super('No matching document found for id "' + doc._doc._id +
       '" version ' + currentVersion + ' modifiedPaths "' + modifiedPathsStr + '"');
     this.version = currentVersion;
     this.modifiedPaths = modifiedPaths;

package/lib/helpers/model/discriminator.js

@@ -115,6 +115,9 @@ module.exports = function discriminator(model, name, schema, tiedValue, applyPlu
       }
     }
 
+    // Shallow clone `obj` so we can add additional properties without modifying original
+    // schema. `Schema.prototype.clone()` copies `obj` by reference, no cloning.
+    schema.obj = { ...schema.obj };
     mergeDiscriminatorSchema(schema, baseSchema);
 
     // Clean up conflicting paths _after_ merging re: gh-6076

package/lib/helpers/populate/getModelsMapForPopulate.js

@@ -626,7 +626,7 @@ function _getLocalFieldValues(doc, localField, model, options, virtual, schema)
 
 function convertTo_id(val, schema) {
   if (val != null && val.$__ != null) {
-    return val._id;
+    return val._doc._id;
   }
   if (val != null && val._id != null && (schema == null || !schema.$isSchemaMap)) {
     return val._id;
@@ -636,7 +636,7 @@ function convertTo_id(val, schema) {
     const rawVal = val.__array != null ? val.__array : val;
     for (let i = 0; i < rawVal.length; ++i) {
       if (rawVal[i] != null && rawVal[i].$__ != null) {
-        rawVal[i] = rawVal[i]._id;
+        rawVal[i] = rawVal[i]._doc._id;
       }
     }
     if (utils.isMongooseArray(val) && val.$schema()) {

package/lib/helpers/populate/markArraySubdocsPopulated.js

@@ -17,11 +17,11 @@ const utils = require('../../utils');
  */
 
 module.exports = function markArraySubdocsPopulated(doc, populated) {
-  if (doc._id == null || populated == null || populated.length === 0) {
+  if (doc._doc._id == null || populated == null || populated.length === 0) {
     return;
   }
 
-  const id = String(doc._id);
+  const id = String(doc._doc._id);
   for (const item of populated) {
     if (item.isVirtual) {
       continue;

package/lib/model.js

@@ -2115,17 +2115,21 @@ Model.countDocuments = function countDocuments(conditions, options) {
  *
  * @param {String} field
  * @param {Object} [conditions] optional
+ * @param {Object} [options] optional
  * @return {Query}
  * @api public
  */
 
-Model.distinct = function distinct(field, conditions) {
+Model.distinct = function distinct(field, conditions, options) {
   _checkContext(this, 'distinct');
-  if (typeof arguments[0] === 'function' || typeof arguments[1] === 'function') {
+  if (typeof arguments[0] === 'function' || typeof arguments[1] === 'function' || typeof arguments[2] === 'function') {
     throw new MongooseError('Model.distinct() no longer accepts a callback');
   }
 
   const mq = new this.Query({}, {}, this, this.$__collection);
+  if (options != null) {
+    mq.setOptions(options);
+  }
 
   return mq.distinct(field, conditions);
 };
@@ -2345,7 +2349,7 @@ Model.findByIdAndUpdate = function(id, update, options) {
 
   // if a model is passed in instead of an id
   if (id instanceof Document) {
-    id = id._id;
+    id = id._doc._id;
   }
 
   return this.findOneAndUpdate.call(this, { _id: id }, update, options);
@@ -3408,7 +3412,7 @@ Model.bulkSave = async function bulkSave(documents, options) {
     documents.map(async(document) => {
       const documentError = bulkWriteError && bulkWriteError.writeErrors.find(writeError => {
         const writeErrorDocumentId = writeError.err.op._id || writeError.err.op.q._id;
-        return writeErrorDocumentId.toString() === document._id.toString();
+        return writeErrorDocumentId.toString() === document._doc._id.toString();
       });
 
       if (documentError == null) {
@@ -4436,7 +4440,7 @@ function _assign(model, vals, mod, assignmentOpts) {
 
         for (let __val of _val) {
           if (__val instanceof Document) {
-            __val = __val._id;
+            __val = __val._doc._id;
           }
           key = String(__val);
           if (rawDocs[key]) {

package/lib/query.js

@@ -2777,7 +2777,7 @@ Query.prototype.estimatedDocumentCount = function(options) {
   this.op = 'estimatedDocumentCount';
   this._validateOp();
 
-  if (typeof options === 'object' && options != null) {
+  if (options != null) {
     this.setOptions(options);
   }
 
@@ -2836,7 +2836,7 @@ Query.prototype.countDocuments = function(conditions, options) {
     this.merge(conditions);
   }
 
-  if (typeof options === 'object' && options != null) {
+  if (options != null) {
     this.setOptions(options);
   }
 
@@ -2874,21 +2874,24 @@ Query.prototype.__distinct = async function __distinct() {
  *
  * #### Example:
  *
+ *     distinct(field, conditions, options)
  *     distinct(field, conditions)
  *     distinct(field)
  *     distinct()
  *
  * @param {String} [field]
  * @param {Object|Query} [filter]
+ * @param {Object} [options]
  * @return {Query} this
  * @see distinct https://www.mongodb.com/docs/manual/reference/method/db.collection.distinct/
  * @api public
  */
 
-Query.prototype.distinct = function(field, conditions) {
+Query.prototype.distinct = function(field, conditions, options) {
   if (typeof field === 'function' ||
       typeof conditions === 'function' ||
-      typeof arguments[2] === 'function') {
+      typeof options === 'function' ||
+      typeof arguments[3] === 'function') {
     throw new MongooseError('Query.prototype.distinct() no longer accepts a callback');
   }
 
@@ -2907,6 +2910,10 @@ Query.prototype.distinct = function(field, conditions) {
     this._distinct = field;
   }
 
+  if (options != null) {
+    this.setOptions(options);
+  }
+
   return this;
 };
 
@@ -3380,9 +3387,9 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   if (!this._update || Object.keys(this._update).length === 0) {
     if (options.upsert) {
       // still need to do the upsert to empty doc
-      const doc = clone(this._update);
-      delete doc._id;
-      this._update = { $set: doc };
+      const $set = clone(this._update);
+      delete $set._id;
+      this._update = { $set };
     } else {
       this._executionStack = null;
       const res = await this._findOne();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.5.4",
+  "version": "8.6.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -21,7 +21,7 @@
   "dependencies": {
     "bson": "^6.7.0",
     "kareem": "2.6.3",
-    "mongodb": "6.7.0",
+    "mongodb": "6.8.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",
@@ -67,7 +67,7 @@
     "tsd": "0.31.1",
     "typescript": "5.5.4",
     "uuid": "10.0.0",
-    "webpack": "5.93.0"
+    "webpack": "5.94.0"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/document.d.ts

@@ -22,7 +22,7 @@ declare module 'mongoose' {
     constructor(doc?: any);
 
     /** This documents _id. */
-    _id?: T;
+    _id: T;
 
     /** This documents __v. */
     __v?: any;
@@ -259,11 +259,14 @@ 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 & { flattenMaps?: true }): FlattenMaps<Require_id<DocType>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false }): Require_id<DocType>;
     toJSON<T = Require_id<DocType>>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<T>;
     toJSON<T = Require_id<DocType>>(options: ToObjectOptions & { flattenMaps: false }): T;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject<T = Require_id<DocType>>(options?: ToObjectOptions): Require_id<T>;
+    toObject(options?: ToObjectOptions): Require_id<DocType>;
+    toObject<T>(options?: ToObjectOptions): Require_id<T>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified<T extends keyof DocType>(path: T): void;

package/types/inferrawdoctype.d.ts

@@ -1,4 +1,5 @@
 import {
+  IsPathRequired,
   IsSchemaTypeFromBuiltinClass,
   RequiredPaths,
   OptionalPaths,
@@ -14,7 +15,9 @@ declare module 'mongoose' {
     [
     K in keyof (RequiredPaths<DocDefinition, TSchemaOptions['typeKey']> &
     OptionalPaths<DocDefinition, TSchemaOptions['typeKey']>)
-    ]: ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']>;
+    ]: IsPathRequired<DocDefinition[K], TSchemaOptions['typeKey']> extends true
+      ? ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']>
+      : ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']> | null;
   }, TSchemaOptions>;
 
   /**

package/types/inferschematype.d.ts

@@ -87,8 +87,8 @@ declare module 'mongoose' {
             'createdAt' | 'updatedAt'
           > as TimestampOptions[K] extends true
             ? K
-            : TimestampOptions[K] extends string
-              ? TimestampOptions[K]
+            : TimestampOptions[K] extends `${infer TimestampValue}`
+              ? TimestampValue
               : never]: NativeDate;
         } & T
         : T