mongoose 8.5.1 → 8.5.3

package/lib/document.js

@@ -1393,8 +1393,8 @@ Document.prototype.$set = function $set(path, val, type, options) {
     })();
 
     let didPopulate = false;
-    if (refMatches && val instanceof Document && (!val.$__.wasPopulated || utils.deepEqual(val.$__.wasPopulated.value, val._id))) {
-      const unpopulatedValue = (schema && schema.$isSingleNested) ? schema.cast(val, this) : val._id;
+    if (refMatches && val instanceof Document && (!val.$__.wasPopulated || utils.deepEqual(val.$__.wasPopulated.value, val._doc._id))) {
+      const unpopulatedValue = (schema && schema.$isSingleNested) ? schema.cast(val, this) : val._doc._id;
       this.$populated(path, unpopulatedValue, { [populateModelSymbol]: val.constructor });
       val.$__.wasPopulated = { value: unpopulatedValue };
       didPopulate = true;
@@ -1409,10 +1409,10 @@ Document.prototype.$set = function $set(path, val, type, options) {
         schema.options[typeKey][0].ref &&
         _isManuallyPopulatedArray(val, schema.options[typeKey][0].ref)) {
       popOpts = { [populateModelSymbol]: val[0].constructor };
-      this.$populated(path, val.map(function(v) { return v._id; }), popOpts);
+      this.$populated(path, val.map(function(v) { return v._doc._id; }), popOpts);
 
       for (const doc of val) {
-        doc.$__.wasPopulated = { value: doc._id };
+        doc.$__.wasPopulated = { value: doc._doc._id };
       }
       didPopulate = true;
     }
@@ -1455,7 +1455,7 @@ Document.prototype.$set = function $set(path, val, type, options) {
       if (Array.isArray(val) && this.$__.populated[path]) {
         for (let i = 0; i < val.length; ++i) {
           if (val[i] instanceof Document) {
-            val.set(i, val[i]._id, true);
+            val.set(i, val[i]._doc._id, true);
           }
         }
       }
@@ -1628,7 +1628,7 @@ Document.prototype.$__shouldModify = function(pathToMark, path, options, constru
   // if they have the same _id
   if (this.$populated(path) &&
       val instanceof Document &&
-      deepEqual(val._id, priorVal)) {
+      deepEqual(val._doc._id, priorVal)) {
     return false;
   }
 
@@ -2770,15 +2770,6 @@ function _getPathsToValidate(doc, pathsToValidate, pathsToSkip) {
     }
   }
 
-  for (const path of paths) {
-    // Single nested paths (paths embedded under single nested subdocs) will
-    // be validated on their own when we call `validate()` on the subdoc itself.
-    // Re: gh-8468
-    if (doc.$__schema.singleNestedPaths.hasOwnProperty(path)) {
-      paths.delete(path);
-      continue;
-    }
-  }
 
   if (Array.isArray(pathsToValidate)) {
     paths = _handlePathsToValidate(paths, pathsToValidate);
@@ -2800,7 +2791,10 @@ function _getPathsToValidate(doc, pathsToValidate, pathsToSkip) {
         _v = _v.toObject({ transform: false });
       }
       const flat = flatten(_v, pathToCheck, flattenOptions, doc.$__schema);
-      Object.keys(flat).forEach(addToPaths);
+      // Single nested paths (paths embedded under single nested subdocs) will
+      // be validated on their own when we call `validate()` on the subdoc itself.
+      // Re: gh-8468
+      Object.keys(flat).filter(path => !doc.$__schema.singleNestedPaths.hasOwnProperty(path)).forEach(addToPaths);
     }
   }
 
@@ -3801,7 +3795,7 @@ Document.prototype.$__handleReject = function handleReject(err) {
 };
 
 /**
- * Internal helper for toObject() and toJSON() that doesn't manipulate options
+ * Internal common logic for toObject() and toJSON()
  *
  * @return {Object}
  * @api private
@@ -3834,13 +3828,16 @@ Document.prototype.$toObject = function(options, json) {
   }
 
   const depopulate = options._calledWithOptions.depopulate
-    ?? options._parentOptions?.depopulate
     ?? defaultOptions?.depopulate
+    ?? options.depopulate
     ?? false;
   // _isNested will only be true if this is not the top level document, we
   // should never depopulate the top-level document
   if (depopulate && options._isNested && this.$__.wasPopulated) {
-    return clone(this.$__.wasPopulated.value || this._id, options);
+    return clone(this.$__.wasPopulated.value || this._doc._id, options);
+  }
+  if (depopulate) {
+    options.depopulate = true;
   }
 
   // merge default options with input options.
@@ -3855,7 +3852,9 @@ Document.prototype.$toObject = function(options, json) {
   options.json = json;
   options.minimize = _minimize;
 
-  options._parentOptions = options;
+  const parentOptions = options._parentOptions;
+  // Parent options should only bubble down for subdocuments, not populated docs
+  options._parentOptions = this.$isSubdocument ? options : null;
 
   options._skipSingleNestedGetters = false;
   // remember the root transform function
@@ -3886,6 +3885,7 @@ Document.prototype.$toObject = function(options, json) {
 
   const virtuals = options._calledWithOptions.virtuals
     ?? defaultOptions.virtuals
+    ?? parentOptions?.virtuals
     ?? undefined;
 
   if (virtuals || (getters && virtuals !== false)) {
@@ -4768,7 +4768,23 @@ Document.prototype.depopulate = function(path) {
         continue;
       }
       delete populated[key];
-      utils.setValue(key, populatedIds, this._doc);
+      if (Array.isArray(populatedIds)) {
+        const arr = utils.getValue(key, this._doc);
+        if (arr.isMongooseArray) {
+          const rawArray = arr.__array;
+          for (let i = 0; i < rawArray.length; ++i) {
+            const subdoc = rawArray[i];
+            if (subdoc == null) {
+              continue;
+            }
+            rawArray[i] = subdoc instanceof Document ? subdoc._doc._id : subdoc._id;
+          }
+        } else {
+          utils.setValue(key, populatedIds, this._doc);
+        }
+      } else {
+        utils.setValue(key, populatedIds, this._doc);
+      }
     }
     return this;
   }
@@ -4781,7 +4797,23 @@ Document.prototype.depopulate = function(path) {
       delete this.$$populatedVirtuals[singlePath];
       delete this._doc[singlePath];
     } else if (populatedIds) {
-      utils.setValue(singlePath, populatedIds, this._doc);
+      if (Array.isArray(populatedIds)) {
+        const arr = utils.getValue(singlePath, this._doc);
+        if (arr.isMongooseArray) {
+          const rawArray = arr.__array;
+          for (let i = 0; i < rawArray.length; ++i) {
+            const subdoc = rawArray[i];
+            if (subdoc == null) {
+              continue;
+            }
+            rawArray[i] = subdoc instanceof Document ? subdoc._doc._id : subdoc._id;
+          }
+        } else {
+          utils.setValue(singlePath, populatedIds, this._doc);
+        }
+      } else {
+        utils.setValue(singlePath, populatedIds, this._doc);
+      }
     }
   }
   return this;

package/lib/helpers/clone.js

@@ -17,7 +17,7 @@ const trustedSymbol = require('./query/trusted').trustedSymbol;
  *
  * If options.minimize is true, creates a minimal data object. Empty objects and undefined values will not be cloned. This makes the data payload sent to MongoDB as small as possible.
  *
- * Functions are never cloned.
+ * Functions and primitives are never cloned.
  *
  * @param {Object} obj the object to clone
  * @param {Object} options
@@ -30,6 +30,9 @@ function clone(obj, options, isArrayChild) {
   if (obj == null) {
     return obj;
   }
+  if (typeof obj === 'number' || typeof obj === 'string' || typeof obj === 'boolean' || typeof obj === 'bigint') {
+    return obj;
+  }
 
   if (Array.isArray(obj)) {
     return cloneArray(isMongooseArray(obj) ? obj.__array : obj, options);
@@ -148,13 +151,12 @@ function cloneObject(obj, options, isArrayChild) {
     ret[trustedSymbol] = obj[trustedSymbol];
   }
 
-  let i = 0;
-  let key = '';
   const keys = Object.keys(obj);
   const len = keys.length;
 
-  for (i = 0; i < len; ++i) {
-    if (specialProperties.has(key = keys[i])) {
+  for (let i = 0; i < len; ++i) {
+    const key = keys[i];
+    if (specialProperties.has(key)) {
       continue;
     }
 

package/lib/helpers/query/cast$expr.js

@@ -93,8 +93,12 @@ function _castExpression(val, schema, strictQuery) {
   } else if (val.$ifNull != null) {
     val.$ifNull.map(v => _castExpression(v, schema, strictQuery));
   } else if (val.$switch != null) {
-    val.branches.map(v => _castExpression(v, schema, strictQuery));
-    val.default = _castExpression(val.default, schema, strictQuery);
+    if (Array.isArray(val.$switch.branches)) {
+      val.$switch.branches = val.$switch.branches.map(v => _castExpression(v, schema, strictQuery));
+    }
+    if ('default' in val.$switch) {
+      val.$switch.default = _castExpression(val.$switch.default, schema, strictQuery);
+    }
   }
 
   const keys = Object.keys(val);

package/lib/model.js

@@ -290,9 +290,10 @@ Model.prototype.$__handleSave = function(options, callback) {
 
   const session = this.$session();
   const asyncLocalStorage = this[modelDbSymbol].base.transactionAsyncLocalStorage?.getStore();
-  if (!saveOptions.hasOwnProperty('session') && session != null) {
+  if (session != null) {
     saveOptions.session = session;
-  } else if (asyncLocalStorage?.session != null) {
+  } else if (!options.hasOwnProperty('session') && asyncLocalStorage?.session != null) {
+    // Only set session from asyncLocalStorage if `session` option wasn't originally passed in options
     saveOptions.session = asyncLocalStorage.session;
   }
   if (this.$isNew) {
@@ -3630,7 +3631,7 @@ Model.buildBulkWriteOperations = function buildBulkWriteOperations(documents, op
         const len = paths.length;
 
         for (let i = 0; i < len; ++i) {
-          where[paths[i]] = shardKey[paths[i]];
+          where[paths[i]] = document[paths[i]];
         }
       }
 
@@ -4458,7 +4459,7 @@ function _assign(model, vals, mod, assignmentOpts) {
         }
       } else {
         if (_val instanceof Document) {
-          _val = _val._id;
+          _val = _val._doc._id;
         }
         key = String(_val);
         if (rawDocs[key]) {
@@ -4467,7 +4468,7 @@ function _assign(model, vals, mod, assignmentOpts) {
             rawOrder[key].push(i);
           } else if (isVirtual ||
             rawDocs[key].constructor !== val.constructor ||
-            String(rawDocs[key]._id) !== String(val._id)) {
+            (rawDocs[key] instanceof Document ? String(rawDocs[key]._doc._id) : String(rawDocs[key]._id)) !== (val instanceof Document ? String(val._doc._id) : String(val._id))) {
             // May need to store multiple docs with the same id if there's multiple models
             // if we have discriminators or a ref function. But avoid converting to an array
             // if we have multiple queries on the same model because of `perDocumentLimit` re: gh-9906

package/lib/schema/documentArray.js

@@ -69,7 +69,7 @@ function SchemaDocumentArray(key, schema, options, schemaOptions) {
 
   const fn = this.defaultValue;
 
-  if (!('defaultValue' in this) || fn !== void 0) {
+  if (!('defaultValue' in this) || fn != null) {
     this.default(function() {
       let arr = fn.call(this);
       if (arr != null && !Array.isArray(arr)) {

package/lib/schemaType.js

@@ -1542,7 +1542,7 @@ SchemaType.prototype._castRef = function _castRef(value, doc, init) {
   }
 
   if (value.$__ != null) {
-    value.$__.wasPopulated = value.$__.wasPopulated || { value: value._id };
+    value.$__.wasPopulated = value.$__.wasPopulated || { value: value._doc._id };
     return value;
   }
 
@@ -1568,7 +1568,7 @@ SchemaType.prototype._castRef = function _castRef(value, doc, init) {
     !doc.$__.populated[path].options.options ||
     !doc.$__.populated[path].options.options.lean) {
     ret = new pop.options[populateModelSymbol](value);
-    ret.$__.wasPopulated = { value: ret._id };
+    ret.$__.wasPopulated = { value: ret._doc._id };
   }
 
   return ret;

package/lib/types/array/methods/index.js

@@ -721,6 +721,7 @@ const methods = {
     }
 
     this._registerAtomic('$push', atomic);
+
     return ret;
   },
 

package/lib/types/map.js

@@ -68,10 +68,17 @@ class MongooseMap extends Map {
    * and change tracking. Note that Mongoose maps _only_ support strings and
    * ObjectIds as keys.
    *
+   * Keys also cannot:
+   * - be named after special properties `prototype`, `constructor`, and `__proto__`
+   * - start with a dollar sign (`$`)
+   * - contain any dots (`.`)
+   *
    * #### Example:
    *
    *     doc.myMap.set('test', 42); // works
    *     doc.myMap.set({ obj: 42 }, 42); // Throws "Mongoose maps only support string keys"
+   *     doc.myMap.set(10, 42); // Throws "Mongoose maps only support string keys"
+   *     doc.myMap.set("$test", 42); // Throws "Mongoose maps do not support keys that start with "$", got "$test""
    *
    * @api public
    * @method set
@@ -116,7 +123,7 @@ class MongooseMap extends Map {
             v = new populated.options[populateModelSymbol](v);
           }
           // Doesn't support single nested "in-place" populate
-          v.$__.wasPopulated = { value: v._id };
+          v.$__.wasPopulated = { value: v._doc._id };
           return v;
         });
       } else if (value != null) {
@@ -124,7 +131,7 @@ class MongooseMap extends Map {
           value = new populated.options[populateModelSymbol](value);
         }
         // Doesn't support single nested "in-place" populate
-        value.$__.wasPopulated = { value: value._id };
+        value.$__.wasPopulated = { value: value._doc._id };
       }
     } else {
       try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.5.1",
+  "version": "8.5.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -29,7 +29,7 @@
   },
   "devDependencies": {
     "@babel/core": "7.24.7",
-    "@babel/preset-env": "7.24.7",
+    "@babel/preset-env": "7.25.3",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
     "acquit": "1.3.0",
@@ -49,15 +49,15 @@
     "eslint-plugin-mocha-no-only": "1.2.0",
     "express": "^4.19.2",
     "fs-extra": "~11.2.0",
-    "highlight.js": "11.9.0",
+    "highlight.js": "11.10.0",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
     "markdownlint-cli2": "^0.13.0",
     "marked": "4.3.0",
     "mkdirp": "^3.0.1",
-    "mocha": "10.6.0",
+    "mocha": "10.7.0",
     "moment": "2.30.1",
-    "mongodb-memory-server": "9.4.0",
+    "mongodb-memory-server": "10.0.0",
     "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.3",
@@ -65,9 +65,9 @@
     "sinon": "18.0.0",
     "stream-browserify": "3.0.0",
     "tsd": "0.31.1",
-    "typescript": "5.5.3",
+    "typescript": "5.5.4",
     "uuid": "10.0.0",
-    "webpack": "5.92.1"
+    "webpack": "5.93.0"
   },
   "directories": {
     "lib": "./lib/mongoose"

package/types/connection.d.ts

@@ -72,7 +72,7 @@ declare module 'mongoose' {
     readonly config: any;
 
     /** The mongodb.Db instance, set when the connection is opened */
-    readonly db: mongodb.Db;
+    readonly db: mongodb.Db | undefined;
 
     /**
      * Helper for `createCollection()`. Will explicitly create the given collection

package/types/cursor.d.ts

@@ -51,7 +51,7 @@ declare module 'mongoose' {
      * Get the next document from this cursor. Will return `null` when there are
      * no documents left.
      */
-    next(): Promise<DocType>;
+    next(): Promise<DocType | null>;
 
     options: Options;
   }

package/types/index.d.ts

@@ -157,8 +157,37 @@ declare module 'mongoose' {
         >
       >
   >;
-  export type HydratedSingleSubdocument<DocType, TOverrides = {}> = Types.Subdocument<unknown, Record<string, never>, DocType> & Require_id<DocType> & TOverrides;
-  export type HydratedArraySubdocument<DocType, TOverrides = {}> = Types.ArraySubdocument<unknown, Record<string, never>, DocType> & Require_id<DocType> & TOverrides;
+  export type HydratedSingleSubdocument<
+    DocType,
+    TOverrides = {}
+  > = IfAny<
+  DocType,
+  any,
+  TOverrides extends Record<string, never> ?
+    Types.Subdocument<unknown, Record<string, never>, DocType> & Require_id<DocType> :
+    IfAny<
+      TOverrides,
+      Types.Subdocument<unknown, Record<string, never>, DocType> & Require_id<DocType>,
+      Types.Subdocument<unknown, Record<string, never>, DocType> & MergeType<
+        Require_id<DocType>,
+        TOverrides
+      >
+    >
+  >;
+  export type HydratedArraySubdocument<DocType, TOverrides = {}> = IfAny<
+    DocType,
+    any,
+    TOverrides extends Record<string, never> ?
+      Types.ArraySubdocument<unknown, Record<string, never>, DocType> & Require_id<DocType> :
+      IfAny<
+        TOverrides,
+        Types.ArraySubdocument<unknown, Record<string, never>, DocType> & Require_id<DocType>,
+        Types.ArraySubdocument<unknown, Record<string, never>, DocType> & MergeType<
+          Require_id<DocType>,
+          TOverrides
+        >
+      >
+    >;
 
   export type HydratedDocumentFromSchema<TSchema extends Schema> = HydratedDocument<
   InferSchemaType<TSchema>,

package/types/inferrawdoctype.d.ts

@@ -10,12 +10,12 @@ declare module 'mongoose' {
   export type InferRawDocType<
     DocDefinition,
     TSchemaOptions extends Record<any, any> = DefaultSchemaOptions
-  > = {
+  > = ApplySchemaOptions<{
     [
     K in keyof (RequiredPaths<DocDefinition, TSchemaOptions['typeKey']> &
     OptionalPaths<DocDefinition, TSchemaOptions['typeKey']>)
     ]: ObtainRawDocumentPathType<DocDefinition[K], TSchemaOptions['typeKey']>;
-  };
+  }, TSchemaOptions>;
 
   /**
    * @summary Obtains schema Path type.

package/types/inferschematype.d.ts

@@ -74,14 +74,25 @@ declare module 'mongoose' {
 
   type ApplySchemaOptions<T, O = DefaultSchemaOptions> = ResolveTimestamps<T, O>;
 
-  type ResolveTimestamps<T, O> = O extends { timestamps: true }
+  type ResolveTimestamps<T, O> = O extends { methods: any } | { statics: any } | { virtuals: any } | { timestamps?: false } ? T
     // For some reason, TypeScript sets all the document properties to unknown
     // if we use methods, statics, or virtuals. So avoid inferring timestamps
     // if any of these are set for now. See gh-12807
-    ? O extends { methods: any } | { statics: any } | { virtuals: any }
-      ? T
-      : { createdAt: NativeDate; updatedAt: NativeDate; } & T
-    : T;
+    : O extends { timestamps: infer TimestampOptions } ? TimestampOptions extends true
+      ? { createdAt: NativeDate; updatedAt: NativeDate; } & T
+      : TimestampOptions extends SchemaTimestampsConfig
+        ? {
+          -readonly [K in keyof Pick<
+            TimestampOptions,
+            'createdAt' | 'updatedAt'
+          > as TimestampOptions[K] extends true
+            ? K
+            : TimestampOptions[K] extends string
+              ? TimestampOptions[K]
+              : never]: NativeDate;
+        } & T
+        : T
+      : T;
 }
 
 type IsPathDefaultUndefined<PathType> = PathType extends { default: undefined } ?

package/types/schematypes.d.ts

@@ -220,7 +220,8 @@ declare module 'mongoose' {
     OptionsConstructor: SchemaTypeOptions<T>;
 
     /** Cast `val` to this schema type. Each class that inherits from schema type should implement this function. */
-    cast(val: any, doc: Document<any>, init: boolean, prev?: any, options?: any): any;
+    cast(val: any, doc?: Document<any>, init?: boolean, prev?: any, options?: any): any;
+    cast<ResultType>(val: any, doc?: Document<any>, init?: boolean, prev?: any, options?: any): ResultType;
 
     /** Sets a default value for this SchemaType. */
     default(val: any): any;
@@ -443,7 +444,7 @@ declare module 'mongoose' {
         defaultOptions: Record<string, any>;
       }
 
-      class Subdocument extends SchemaType implements AcceptsDiscriminator {
+      class Subdocument<DocType = unknown> extends SchemaType implements AcceptsDiscriminator {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: string;
 
@@ -455,6 +456,8 @@ declare module 'mongoose' {
 
         discriminator<T, U>(name: string | number, schema: Schema<T, U>, value?: string): U;
         discriminator<D>(name: string | number, schema: Schema, value?: string): Model<D>;
+
+        cast(val: any, doc?: Document<any>, init?: boolean, prev?: any, options?: any): HydratedSingleSubdocument<DocType>;
       }
 
       class String extends SchemaType {