mongoose 8.8.0 → 8.8.2

package/lib/helpers/indexes/isTimeseriesIndex.js

@@ -0,0 +1,16 @@
+'use strict';
+
+/**
+ * Returns `true` if the given index matches the schema's `timestamps` options
+ */
+
+module.exports = function isTimeseriesIndex(dbIndex, schemaOptions) {
+  if (schemaOptions.timeseries == null) {
+    return false;
+  }
+  const { timeField, metaField } = schemaOptions.timeseries;
+  if (typeof timeField !== 'string' || typeof metaField !== 'string') {
+    return false;
+  }
+  return Object.keys(dbIndex.key).length === 2 && dbIndex.key[timeField] === 1 && dbIndex.key[metaField] === 1;
+};

package/lib/helpers/isBsonType.js

@@ -7,8 +7,7 @@
 
 function isBsonType(obj, typename) {
   return (
-    typeof obj === 'object' &&
-    obj !== null &&
+    obj != null &&
     obj._bsontype === typename
   );
 }

package/lib/helpers/model/castBulkWrite.js

@@ -103,7 +103,8 @@ module.exports = function castBulkWrite(originalModel, op, options) {
         });
         op['updateOne']['update'] = castUpdate(model.schema, update, {
           strict: strict,
-          upsert: op['updateOne'].upsert
+          upsert: op['updateOne'].upsert,
+          arrayFilters: op['updateOne'].arrayFilters
         }, model, op['updateOne']['filter']);
       } catch (error) {
         return callback(error, null);
@@ -162,7 +163,8 @@ module.exports = function castBulkWrite(originalModel, op, options) {
 
         op['updateMany']['update'] = castUpdate(model.schema, op['updateMany']['update'], {
           strict: strict,
-          upsert: op['updateMany'].upsert
+          upsert: op['updateMany'].upsert,
+          arrayFilters: op['updateMany'].arrayFilters
         }, model, op['updateMany']['filter']);
       } catch (error) {
         return callback(error, null);

package/lib/helpers/query/castUpdate.js

@@ -245,7 +245,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
       }
 
       if (op !== '$setOnInsert' &&
-          handleImmutable(schematype, strict, obj, key, prefix + key, context)) {
+          handleImmutable(schematype, strict, obj, key, prefix + key, options, context)) {
         continue;
       }
 
@@ -353,7 +353,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
 
       // You can use `$setOnInsert` with immutable keys
       if (op !== '$setOnInsert' &&
-          handleImmutable(schematype, strict, obj, key, prefix + key, context)) {
+          handleImmutable(schematype, strict, obj, key, prefix + key, options, context)) {
         continue;
       }
 

package/lib/helpers/query/handleImmutable.js

@@ -2,7 +2,20 @@
 
 const StrictModeError = require('../../error/strict');
 
-module.exports = function handleImmutable(schematype, strict, obj, key, fullPath, ctx) {
+/**
+ * Handle immutable option for a given path when casting updates based on options
+ *
+ * @param {SchemaType} schematype the resolved schematype for this path
+ * @param {Boolean | 'throw' | null} strict whether strict mode is set for this query
+ * @param {Object} obj the object containing the value being checked so we can delete
+ * @param {String} key the key in `obj` which we are checking for immutability
+ * @param {String} fullPath the full path being checked
+ * @param {Object} options the query options
+ * @param {Query} ctx the query. Passed as `this` and first param to the `immutable` option, if `immutable` is a function
+ * @returns true if field was removed, false otherwise
+ */
+
+module.exports = function handleImmutable(schematype, strict, obj, key, fullPath, options, ctx) {
   if (schematype == null || !schematype.options || !schematype.options.immutable) {
     return false;
   }
@@ -15,6 +28,9 @@ module.exports = function handleImmutable(schematype, strict, obj, key, fullPath
     return false;
   }
 
+  if (options && options.overwriteImmutable) {
+    return false;
+  }
   if (strict === false) {
     return false;
   }

package/lib/helpers/schema/applyReadConcern.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const get = require('../get');
-
 module.exports = function applyReadConcern(schema, options) {
   if (options.readConcern !== undefined) {
     return;
@@ -15,7 +13,7 @@ module.exports = function applyReadConcern(schema, options) {
     return;
   }
 
-  const level = get(schema, 'options.readConcern.level', null);
+  const level = schema.options?.readConcern?.level;
   if (level != null) {
     options.readConcern = { level };
   }

package/lib/helpers/schema/applyWriteConcern.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const get = require('../get');
-
 module.exports = function applyWriteConcern(schema, options) {
   if (options.writeConcern != null) {
     return;
@@ -12,7 +10,7 @@ module.exports = function applyWriteConcern(schema, options) {
   if (options && options.session && options.session.transaction) {
     return;
   }
-  const writeConcern = get(schema, 'options.writeConcern', {});
+  const writeConcern = schema.options.writeConcern ?? {};
   if (Object.keys(writeConcern).length != 0) {
     options.writeConcern = {};
     if (!('w' in options) && writeConcern.w != null) {

package/lib/model.js

@@ -51,6 +51,7 @@ const immediate = require('./helpers/immediate');
 const internalToObjectOptions = require('./options').internalToObjectOptions;
 const isDefaultIdIndex = require('./helpers/indexes/isDefaultIdIndex');
 const isIndexEqual = require('./helpers/indexes/isIndexEqual');
+const isTimeseriesIndex = require('./helpers/indexes/isTimeseriesIndex');
 const {
   getRelatedDBIndexes,
   getRelatedSchemaIndexes
@@ -1418,6 +1419,10 @@ function getIndexesToDrop(schema, schemaIndexes, dbIndexes) {
     if (isDefaultIdIndex(dbIndex)) {
       continue;
     }
+    // Timeseries collections have a default index on { timeField: 1, metaField: 1 }.
+    if (isTimeseriesIndex(dbIndex, schema.options)) {
+      continue;
+    }
 
     for (const [schemaIndexKeysObject, schemaIndexOptions] of schemaIndexes) {
       const options = decorateDiscriminatorIndexOptions(schema, clone(schemaIndexOptions));
@@ -1429,9 +1434,11 @@ function getIndexesToDrop(schema, schemaIndexes, dbIndexes) {
       }
     }
 
-    if (!found) {
-      toDrop.push(dbIndex.name);
+    if (found) {
+      continue;
     }
+
+    toDrop.push(dbIndex.name);
   }
 
   return toDrop;

package/lib/mongoose.js

@@ -661,6 +661,8 @@ Mongoose.prototype._model = function(name, schema, collection, options) {
       utils.toCollectionName(name, _mongoose.pluralize());
   }
 
+  applyEmbeddedDiscriminators(schema);
+
   const connection = options.connection || _mongoose.connection;
   model = _mongoose.Model.compile(model || name, schema, collection, connection, _mongoose);
   // Errors handled internally, so safe to ignore error
@@ -678,8 +680,6 @@ Mongoose.prototype._model = function(name, schema, collection, options) {
     }
   }
 
-  applyEmbeddedDiscriminators(schema);
-
   return model;
 };
 

package/lib/query.js

@@ -22,7 +22,6 @@ const castUpdate = require('./helpers/query/castUpdate');
 const clone = require('./helpers/clone');
 const getDiscriminatorByValue = require('./helpers/discriminator/getDiscriminatorByValue');
 const helpers = require('./queryHelpers');
-const immediate = require('./helpers/immediate');
 const internalToObjectOptions = require('./options').internalToObjectOptions;
 const isExclusive = require('./helpers/projection/isExclusive');
 const isInclusive = require('./helpers/projection/isInclusive');
@@ -1626,6 +1625,7 @@ Query.prototype.getOptions = function() {
  * - [writeConcern](https://www.mongodb.com/docs/manual/reference/method/db.collection.update/)
  * - [timestamps](https://mongoosejs.com/docs/guide.html#timestamps): If `timestamps` is set in the schema, set this option to `false` to skip timestamps for that particular update. Has no effect if `timestamps` is not enabled in the schema options.
  * - overwriteDiscriminatorKey: allow setting the discriminator key in the update. Will use the correct discriminator schema if the update changes the discriminator key.
+ * - overwriteImmutable: allow overwriting properties that are set to `immutable` in the schema. Defaults to false.
  *
  * The following options are only for `find()`, `findOne()`, `findById()`, `findOneAndUpdate()`, `findOneAndReplace()`, `findOneAndDelete()`, and `findByIdAndUpdate()`:
  *
@@ -1697,6 +1697,10 @@ Query.prototype.setOptions = function(options, overwrite) {
     this._mongooseOptions.overwriteDiscriminatorKey = options.overwriteDiscriminatorKey;
     delete options.overwriteDiscriminatorKey;
   }
+  if ('overwriteImmutable' in options) {
+    this._mongooseOptions.overwriteImmutable = options.overwriteImmutable;
+    delete options.overwriteImmutable;
+  }
   if ('sanitizeProjection' in options) {
     if (options.sanitizeProjection && !this._mongooseOptions.sanitizeProjection) {
       sanitizeProjection(this._fields);
@@ -2243,6 +2247,9 @@ Query.prototype.error = function error(err) {
  */
 
 Query.prototype._unsetCastError = function _unsetCastError() {
+  if (this._error == null) {
+    return;
+  }
   if (this._error != null && !(this._error instanceof CastError)) {
     return;
   }
@@ -2286,9 +2293,9 @@ Query.prototype.mongooseOptions = function(v) {
 
 Query.prototype._castConditions = function() {
   let sanitizeFilterOpt = undefined;
-  if (this.model != null && utils.hasUserDefinedProperty(this.model.db.options, 'sanitizeFilter')) {
+  if (this.model?.db.options?.sanitizeFilter != null) {
     sanitizeFilterOpt = this.model.db.options.sanitizeFilter;
-  } else if (this.model != null && utils.hasUserDefinedProperty(this.model.base.options, 'sanitizeFilter')) {
+  } else if (this.model?.base.options?.sanitizeFilter != null) {
     sanitizeFilterOpt = this.model.base.options.sanitizeFilter;
   } else {
     sanitizeFilterOpt = this._mongooseOptions.sanitizeFilter;
@@ -2531,13 +2538,12 @@ Query.prototype.collation = function(value) {
  * @api private
  */
 
-Query.prototype._completeOne = function(doc, res, callback) {
+Query.prototype._completeOne = function(doc, res, projection, callback) {
   if (!doc && !this.options.includeResultMetadata) {
     return callback(null, null);
   }
 
   const model = this.model;
-  const projection = clone(this._fields);
   const userProvidedFields = this._userProvidedFields || {};
   // `populate`, `lean`
   const mongooseOptions = this._mongooseOptions;
@@ -2638,7 +2644,7 @@ Query.prototype._findOne = async function _findOne() {
   // don't pass in the conditions because we already merged them in
   const doc = await this.mongooseCollection.findOne(this._conditions, options);
   return new Promise((resolve, reject) => {
-    this._completeOne(doc, null, (err, res) => {
+    this._completeOne(doc, null, options.projection, (err, res) => {
       if (err) {
         return reject(err);
       }
@@ -3233,7 +3239,7 @@ function completeOne(model, doc, res, options, fields, userProvidedFields, pop,
 
   function _init(err, casted) {
     if (err) {
-      return immediate(() => callback(err));
+      return callback(err);
     }
 
 
@@ -3246,12 +3252,12 @@ function completeOne(model, doc, res, options, fields, userProvidedFields, pop,
       } else {
         res.value = null;
       }
-      return immediate(() => callback(null, res));
+      return callback(null, res);
     }
     if (options.session != null) {
       casted.$session(options.session);
     }
-    immediate(() => callback(null, casted));
+    callback(null, casted);
   }
 }
 
@@ -3318,6 +3324,7 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Boolean} [options.returnOriginal=null] An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
  * @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.
  * @see Tutorial https://mongoosejs.com/docs/tutorials/findoneandupdate.html
  * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @see ModifyResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html
@@ -3459,7 +3466,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   const doc = !options.includeResultMetadata ? res : res.value;
 
   return new Promise((resolve, reject) => {
-    this._completeOne(doc, res, (err, res) => {
+    this._completeOne(doc, res, options.projection, (err, res) => {
       if (err) {
         return reject(err);
       }
@@ -3555,7 +3562,7 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
   const doc = !includeResultMetadata ? res : res.value;
 
   return new Promise((resolve, reject) => {
-    this._completeOne(doc, res, (err, res) => {
+    this._completeOne(doc, res, options.projection, (err, res) => {
       if (err) {
         return reject(err);
       }
@@ -3709,7 +3716,7 @@ Query.prototype._findOneAndReplace = async function _findOneAndReplace() {
 
   const doc = !includeResultMetadata ? res : res.value;
   return new Promise((resolve, reject) => {
-    this._completeOne(doc, res, (err, res) => {
+    this._completeOne(doc, res, options.projection, (err, res) => {
       if (err) {
         return reject(err);
       }
@@ -4016,6 +4023,7 @@ Query.prototype._replaceOne = async function _replaceOne() {
  * @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 {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()
@@ -4086,6 +4094,7 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @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. Note that this allows you to overwrite timestamps. 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 {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()
@@ -4424,10 +4433,10 @@ Query.prototype.exec = async function exec(op) {
       str = str.slice(0, 60) + '...';
     }
     const err = new MongooseError('Query was already executed: ' + str);
-    err.originalStack = this._executionStack.stack;
+    err.originalStack = this._executionStack;
     throw err;
   } else {
-    this._executionStack = new Error();
+    this._executionStack = new Error().stack;
   }
 
   let skipWrappedFunction = null;
@@ -4707,7 +4716,8 @@ Query.prototype._castUpdate = function _castUpdate(obj) {
     strict: this._mongooseOptions.strict,
     upsert: upsert,
     arrayFilters: this.options.arrayFilters,
-    overwriteDiscriminatorKey: this._mongooseOptions.overwriteDiscriminatorKey
+    overwriteDiscriminatorKey: this._mongooseOptions.overwriteDiscriminatorKey,
+    overwriteImmutable: this._mongooseOptions.overwriteImmutable
   }, this, this._conditions);
 };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.8.0",
+  "version": "8.8.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -28,8 +28,8 @@
     "sift": "17.1.3"
   },
   "devDependencies": {
-    "@babel/core": "7.24.7",
-    "@babel/preset-env": "7.25.4",
+    "@babel/core": "7.26.0",
+    "@babel/preset-env": "7.26.0",
     "@typescript-eslint/eslint-plugin": "^8.4.0",
     "@typescript-eslint/parser": "^8.4.0",
     "acquit": "1.3.0",
@@ -41,7 +41,7 @@
     "broken-link-checker": "^0.7.8",
     "buffer": "^5.6.0",
     "cheerio": "1.0.0",
-    "crypto-browserify": "3.12.0",
+    "crypto-browserify": "3.12.1",
     "dotenv": "16.4.5",
     "dox": "1.0.0",
     "eslint": "8.57.0",
@@ -53,11 +53,11 @@
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
     "markdownlint-cli2": "^0.14.0",
-    "marked": "14.1.2",
+    "marked": "14.1.3",
     "mkdirp": "^3.0.1",
-    "mocha": "10.7.3",
+    "mocha": "10.8.2",
     "moment": "2.30.1",
-    "mongodb-memory-server": "10.0.1",
+    "mongodb-memory-server": "10.1.2",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.3",
@@ -65,9 +65,9 @@
     "sinon": "19.0.2",
     "stream-browserify": "3.0.0",
     "tsd": "0.31.2",
-    "typescript": "5.6.2",
-    "uuid": "10.0.0",
-    "webpack": "5.95.0"
+    "typescript": "5.6.3",
+    "uuid": "11.0.2",
+    "webpack": "5.96.1"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/cursor.d.ts

@@ -11,8 +11,10 @@ declare module 'mongoose' {
     signal?: AbortSignal;
   }
 
-  class Cursor<DocType = any, Options = never> extends stream.Readable {
-    [Symbol.asyncIterator](): AsyncIterableIterator<DocType>;
+  class Cursor<DocType = any, Options = never, NextResultType = DocType | null> extends stream.Readable {
+    [Symbol.asyncIterator](): Cursor<IteratorResult<DocType>, Options, IteratorResult<DocType>>;
+
+    [Symbol.asyncDispose](): Promise<void>;
 
     /**
      * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html#addCursorFlag).
@@ -58,7 +60,7 @@ declare module 'mongoose' {
      * Get the next document from this cursor. Will return `null` when there are
      * no documents left.
      */
-    next(): Promise<DocType | null>;
+    next(): Promise<NextResultType>;
 
     options: Options;
   }

package/types/query.d.ts

@@ -20,6 +20,7 @@ declare module 'mongoose' {
     | 'context'
     | 'multipleCastError'
     | 'overwriteDiscriminatorKey'
+    | 'overwriteImmutable'
     | 'populate'
     | 'runValidators'
     | 'sanitizeProjection'
@@ -154,6 +155,11 @@ declare module 'mongoose' {
     new?: boolean;
 
     overwriteDiscriminatorKey?: boolean;
+    /**
+     * Mongoose removes updated immutable properties from `update` by default (excluding $setOnInsert).
+     * Set `overwriteImmutable` to `true` to allow updating immutable properties using other update operators.
+     */
+    overwriteImmutable?: boolean;
     projection?: ProjectionType<DocType>;
     /**
      * if true, returns the full ModifyResult rather than just the document