mongoose 9.7.1 → 9.7.3

package/eslint.config.mjs

@@ -15,7 +15,10 @@ export default defineConfig([
     '!**/.*',
     '**/node_modules',
     '**/.git',
-    '**/data'
+    '**/data',
+    '**/docs/3.*/**',
+    '**/docs/5.*/**',
+    '**/docs/vendor/*'
   ]),
   js.configs.recommended,
   // general options

package/lib/document.js

@@ -1948,7 +1948,9 @@ Document.prototype.get = function(path, type, options) {
 
   // Fast path if we know we're just accessing top-level path on the document:
   // just get the schema path, avoid `$__path()` because that does string manipulation
-  let schema = noDottedPath ? this.$__schema.paths[path] : this.$__path(path);
+  let schema = noDottedPath ?
+    Object.hasOwn(this.$__schema.paths, path) ? this.$__schema.paths[path] : undefined :
+    this.$__path(path);
   if (schema == null) {
     schema = this.$__schema.virtualpath(path);
 
@@ -1958,7 +1960,7 @@ Document.prototype.get = function(path, type, options) {
   }
 
   if (noDottedPath) {
-    let obj = this._doc[path];
+    let obj = Object.hasOwn(this._doc, path) ? this._doc[path] : undefined;
     if (adhoc) {
       obj = adhoc.cast(obj);
     }
@@ -1985,6 +1987,10 @@ Document.prototype.get = function(path, type, options) {
   }
 
   for (let i = 0, l = pieces.length; i < l; i++) {
+    if (specialProperties.has(pieces[i])) {
+      return undefined;
+    }
+
     if (obj?._doc) {
       obj = obj._doc;
     }
@@ -2006,7 +2012,7 @@ Document.prototype.get = function(path, type, options) {
 
   if (schema != null && options.getters !== false) {
     obj = schema.applyGetters(obj, this);
-  } else if (this.$__schema.nested[path] && options.virtuals) {
+  } else if (Object.hasOwn(this.$__schema.nested, path) && options.virtuals) {
     // Might need to apply virtuals if this is a nested path
     return applyVirtuals(this, clone(obj) || {}, { path: path });
   }

package/lib/schema.js

@@ -1268,7 +1268,7 @@ reserved.collection = 1;
 
 Schema.prototype.path = function(path, obj) {
   if (obj === undefined) {
-    if (this.paths[path] != null) {
+    if (Object.hasOwn(this.paths, path)) {
       return this.paths[path];
     }
     // Convert to '.$' to check subpaths re: gh-6405
@@ -1296,9 +1296,15 @@ Schema.prototype.path = function(path, obj) {
       : undefined;
   }
 
+  const subpaths = path.indexOf('.') === -1 ? [path] : path.split('.');
+  const last = subpaths.pop();
+  if (utils.specialProperties.has(last)) {
+    throw new MongooseError('Cannot set special property `' + last + '` on a schema');
+  }
+
   // some path names conflict with document methods
-  const firstPieceOfPath = path.split('.')[0];
-  if (reserved[firstPieceOfPath] && !this.options.suppressReservedKeysWarning) {
+  const firstPieceOfPath = subpaths.length === 0 ? last : subpaths[0];
+  if (Object.hasOwn(reserved, firstPieceOfPath) && !this.options.suppressReservedKeysWarning) {
     const errorMessage = `\`${firstPieceOfPath}\` is a reserved schema pathname and may break some functionality. ` +
       'You are allowed to use it, but use at your own risk. ' +
       'To disable this warning pass `suppressReservedKeysWarning` as a schema option.';
@@ -1311,8 +1317,6 @@ Schema.prototype.path = function(path, obj) {
   }
 
   // update the tree
-  const subpaths = path.split(/\./);
-  const last = subpaths.pop();
   let branch = this.tree;
   let fullPath = '';
 
@@ -1536,7 +1540,7 @@ function getMapPath(schema, path) {
     } else if (val.schema && path.startsWith(cleanPath + '.')) {
       let remnant = path.slice(cleanPath.length + 1);
       remnant = remnant.slice(remnant.indexOf('.') + 1);
-      return val.schema.paths[remnant];
+      return val.schema.path(remnant);
     } else if (val.$isSchemaMap && path.startsWith(cleanPath + '.')) {
       let remnant = path.slice(cleanPath.length + 1);
       remnant = remnant.slice(remnant.indexOf('.') + 1);
@@ -3026,7 +3030,7 @@ Schema.prototype._getPathType = function(path) {
           };
         }
         return { schema: foundschema, pathType: 'real' };
-      } else if (p === parts.length && schema.nested[trypath]) {
+      } else if (p === parts.length && Object.hasOwn(schema.nested, trypath)) {
         return { schema: schema, pathType: 'nested' };
       }
     }

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

@@ -12,6 +12,7 @@ const arrayPathSymbol = require('../../../helpers/symbols').arrayPathSymbol;
 const arraySchemaSymbol = require('../../../helpers/symbols').arraySchemaSymbol;
 const documentArrayParent = require('../../../helpers/symbols').documentArrayParent;
 
+const _baseReverse = Array.prototype.reverse;
 const _baseToString = Array.prototype.toString;
 
 const methods = {
@@ -211,7 +212,7 @@ const methods = {
   },
 
   /**
-   * Wraps [`Array#push`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
+   * Wraps [`Array#push`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/push) with proper change tracking.
    *
    * @param {...object} [args]
    * @api public
@@ -220,8 +221,37 @@ const methods = {
    */
 
   push() {
+    const shouldReindex = _shouldReindexAfterPush(arguments);
     const ret = ArrayMethods.push.apply(this, arguments);
 
+    if (shouldReindex) {
+      _updateSubdocIndexes(this);
+    }
+    _updateParentPopulated(this);
+
+    return ret;
+  },
+
+  /**
+   * Wraps [`Array#pop`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/pop) with proper change tracking.
+   * @api private
+   */
+
+  pop() {
+    const ret = ArrayMethods.pop.apply(this, arguments);
+
+    _updateParentPopulated(this);
+
+    return ret;
+  },
+
+  /*!
+   * ignore
+   */
+
+  $pop() {
+    const ret = ArrayMethods.$pop.apply(this, arguments);
+
     _updateParentPopulated(this);
 
     return ret;
@@ -239,32 +269,96 @@ const methods = {
   pull() {
     const ret = ArrayMethods.pull.apply(this, arguments);
 
+    _updateSubdocIndexes(this);
     _updateParentPopulated(this);
 
     return ret;
   },
 
   /**
-   * Wraps [`Array#shift`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/unshift) with proper change tracking.
+   * Wraps [`Array#shift`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/shift) with proper change tracking.
    * @api private
    */
 
   shift() {
     const ret = ArrayMethods.shift.apply(this, arguments);
 
+    _updateSubdocIndexes(this);
+    _updateParentPopulated(this);
+
+    return ret;
+  },
+
+  /*!
+   * ignore
+   */
+
+  $shift() {
+    const ret = ArrayMethods.$shift.apply(this, arguments);
+
+    _updateSubdocIndexes(this);
     _updateParentPopulated(this);
 
     return ret;
   },
 
   /**
-   * Wraps [`Array#splice`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice) with proper change tracking and casting.
+   * Wraps [`Array#splice`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice) with proper change tracking and casting.
    * @api private
    */
 
   splice() {
     const ret = ArrayMethods.splice.apply(this, arguments);
 
+    _updateSubdocIndexes(this);
+    _updateParentPopulated(this);
+
+    return ret;
+  },
+
+  /**
+   * Wraps [`Array#reverse`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reverse)
+   * with proper change tracking.
+   * @api private
+   */
+
+  reverse() {
+    _baseReverse.call(this.__array);
+    this._registerAtomic('$set', this);
+
+    _updateSubdocIndexes(this);
+    _updateParentPopulated(this);
+
+    return this;
+  },
+
+  /**
+   * Wraps [`Array#sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)
+   * with proper change tracking.
+   *
+   * @param {Function} [compareFunction]
+   * @api private
+   */
+
+  sort() {
+    const ret = ArrayMethods.sort.apply(this, arguments);
+
+    _updateSubdocIndexes(this);
+    _updateParentPopulated(this);
+
+    return ret;
+  },
+
+  /**
+   * Wraps [`Array#unshift`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift)
+   * with proper change tracking.
+   * @api private
+   */
+
+  unshift() {
+    const ret = ArrayMethods.unshift.apply(this, arguments);
+
+    _updateSubdocIndexes(this);
     _updateParentPopulated(this);
 
     return ret;
@@ -389,6 +483,26 @@ const methods = {
 
 module.exports = methods;
 
+/*!
+ * ignore
+ */
+
+function _updateSubdocIndexes(arr) {
+  const rawArray = utils.isMongooseArray(arr) ? arr.__array : arr;
+
+  for (let i = 0; i < rawArray.length; ++i) {
+    if (typeof rawArray[i]?.$setIndex === 'function') {
+      rawArray[i].$setIndex(i);
+    }
+  }
+}
+
+function _shouldReindexAfterPush(args) {
+  return args[0] != null &&
+    utils.hasUserDefinedProperty(args[0], '$each') &&
+    args[0].$position != null;
+}
+
 /**
  * If this is a document array, each element may contain single
  * populated paths, so we need to modify the top-level document's

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "9.7.1",
+  "version": "9.7.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -20,6 +20,7 @@
   "type": "commonjs",
   "license": "MIT",
   "dependencies": {
+    "@standard-schema/spec": "^1.1.0",
     "kareem": "3.3.0",
     "mongodb": "~7.2",
     "mpath": "0.9.0",
@@ -43,8 +44,8 @@
     "eslint-plugin-mocha-no-only": "1.2.0",
     "express": "5.2.1",
     "fs-extra": "~11.3.0",
-    "globals": "^17.4.0",
     "glob": "^13.0.6",
+    "globals": "^17.4.0",
     "highlight.js": "11.11.1",
     "linkinator": "7.x",
     "lodash.isequal": "4.5.0",
@@ -86,7 +87,7 @@
     "docs:prepare:publish:6x": "git checkout 6.x && git merge 6.x && npm run docs:clean:stable && env DOCS_DEPLOY=true npm run docs:generate && mv ./docs/6.x ./tmp && git checkout gh-pages && npm run docs:copy:tmp:6x",
     "docs:prepare:publish:7x": "env DOCS_DEPLOY=true npm run docs:generate && git checkout gh-pages && rm -rf ./docs/7.x && mv ./tmp ./docs/7.x",
     "docs:prepare:publish:8x": "env DOCS_DEPLOY=true npm run docs:generate && git checkout gh-pages && rm -rf ./docs/8.x && mv ./tmp ./docs/8.x",
-    "docs:check-links": "linkinator http://127.0.0.1:8089 --silent --recurse --skip cdn.carbonads.com --skip m.servedby-buysellads.com --skip \"127\\.0\\.0\\.1:8089\/docs\/\\d+.x\"",
+    "docs:check-links": "linkinator http://127.0.0.1:8089 --silent --recurse --skip cdn.carbonads.com --skip m.servedby-buysellads.com --skip \"127\\.0\\.0\\.1:8089/docs/\\d+.x\"",
     "docs:update-mongodb-links": "node ./scripts/update-mongodb-links.js",
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js --ext .cjs",

package/types/models.d.ts

@@ -1,5 +1,6 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
+  import { StandardSchemaV1 as StandardSchemaV1Spec, StandardTypedV1 as StandardTypedV1Spec } from '@standard-schema/spec';
 
   export interface DiscriminatorOptions {
     value?: string | number | ObjectId;
@@ -108,40 +109,8 @@ declare module 'mongoose' {
    */
   type pathsToValidate = PathsToValidate;
 
-  export namespace StandardSchemaV1 {
-    export interface Props<Output = unknown> {
-      readonly version: 1;
-      readonly vendor: 'mongoose';
-      readonly validate: (
-        value: unknown,
-        options?: Options | undefined
-      ) => Result<Output> | Promise<Result<Output>>;
-    }
-
-    export interface Options {
-      readonly libraryOptions?: Record<string, unknown> | undefined;
-    }
-
-    export type Result<Output> = SuccessResult<Output> | FailureResult;
-
-    export interface SuccessResult<Output> {
-      readonly value: Output;
-      readonly issues?: undefined;
-    }
-
-    export interface FailureResult {
-      readonly issues: ReadonlyArray<Issue>;
-    }
-
-    export interface Issue {
-      readonly message: string;
-      readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
-    }
-
-    export interface PathSegment {
-      readonly key: PropertyKey;
-    }
-  }
+  export import StandardTypedV1 = StandardTypedV1Spec;
+  export import StandardSchemaV1 = StandardSchemaV1Spec;
 
   interface SaveOptions extends
     SessionOption {
@@ -270,7 +239,7 @@ declare module 'mongoose' {
     base: Mongoose;
 
     /** Standard Schema adapter for validating input with this model's schema. */
-    readonly '~standard': StandardSchemaV1.Props<TRawDocType>;
+    readonly '~standard': StandardSchemaV1.Props<Default__v<Require_id<TRawDocType>, ObtainSchemaGeneric<TSchema, 'TSchemaOptions'>>>;
 
     /**
      * If this is a discriminator model, `baseModelName` is the name of
@@ -684,11 +653,11 @@ declare module 'mongoose' {
      */
     useConnection(connection: Connection): this;
 
-    /** Casts and validates the given object against this model's schema, passing the given `context` to custom validators. */
-    validate(): Promise<void>;
-    validate(obj: any): Promise<void>;
-    validate(obj: any, pathsOrOptions: PathsToValidate): Promise<void>;
-    validate(obj: any, pathsOrOptions: { pathsToSkip?: pathsToSkip }): Promise<void>;
+    /** Casts and validates the given object against this model's schema, returning the casted-and-validated copy of `obj`, passing the given `context` to custom validators. */
+    validate(): Promise<TRawDocType>;
+    validate(obj: any): Promise<TRawDocType>;
+    validate(obj: any, pathsOrOptions: PathsToValidate): Promise<TRawDocType>;
+    validate(obj: any, pathsOrOptions: { pathsToSkip?: pathsToSkip }): Promise<TRawDocType>;
 
     /** Watches the underlying collection for changes using [MongoDB change streams](https://www.mongodb.com/docs/manual/changeStreams/). */
     watch<ResultType extends mongodb.Document = any, ChangeType extends mongodb.ChangeStreamDocument = any>(pipeline?: Array<Record<string, unknown>>, options?: mongodb.ChangeStreamOptions & { hydrate?: boolean }): mongodb.ChangeStream<ResultType, ChangeType>;