mongoose 6.3.1 → 6.3.4

package/lib/schema/documentarray.js

@@ -113,10 +113,12 @@ function _createConstructor(schema, options, baseClass) {
   Subdocument || (Subdocument = require('../types/ArraySubdocument'));
 
   // compile an embedded document for this schema
-  function EmbeddedDocument() {
+  function EmbeddedDocument(_value, parentArray) {
     Subdocument.apply(this, arguments);
-
-    this.$session(this.ownerDocument().$session());
+    if (parentArray == null || parentArray.getArrayParent() == null) {
+      return;
+    }
+    this.$session(parentArray.getArrayParent().$session());
   }
 
   schema._preCompile();

package/lib/schema/number.js

@@ -353,11 +353,7 @@ SchemaNumber.prototype.enum = function(values, message) {
  */
 
 SchemaNumber.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
-    if (typeof value === 'number') {
-      return value;
-    }
-
+  if (typeof value !== 'number' && SchemaType._isRef(this, value, doc, init)) {
     if (value == null || utils.isNonBuiltinObject(value)) {
       return this._castRef(value, doc, init);
     }

package/lib/schema/objectid.js

@@ -221,11 +221,9 @@ ObjectId.prototype.checkRequired = function checkRequired(value, doc) {
  */
 
 ObjectId.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
+  if (!(value instanceof oid) && SchemaType._isRef(this, value, doc, init)) {
     // wait! we may need to cast this to a document
-    if (value instanceof oid) {
-      return value;
-    } else if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
+    if ((getConstructorName(value) || '').toLowerCase() === 'objectid') {
       return new oid(value.toHexString());
     }
 

package/lib/schema/string.js

@@ -4,6 +4,7 @@
  * Module dependencies.
  */
 
+const { BSONRegExp } = require('bson');
 const SchemaType = require('../schematype');
 const MongooseError = require('../error/index');
 const SchemaStringOptions = require('../options/SchemaStringOptions');
@@ -580,11 +581,7 @@ SchemaString.prototype.checkRequired = function checkRequired(value, doc) {
  */
 
 SchemaString.prototype.cast = function(value, doc, init) {
-  if (SchemaType._isRef(this, value, doc, init)) {
-    if (typeof value === 'string') {
-      return value;
-    }
-
+  if (typeof value !== 'string' && SchemaType._isRef(this, value, doc, init)) {
     return this._castRef(value, doc, init);
   }
 
@@ -680,7 +677,7 @@ SchemaString.prototype.castForQuery = function($conditional, val) {
     return handler.call(this, val);
   }
   val = $conditional;
-  if (Object.prototype.toString.call(val) === '[object RegExp]') {
+  if (Object.prototype.toString.call(val) === '[object RegExp]' || val instanceof BSONRegExp) {
     return val;
   }
 

package/lib/schema.js

@@ -1235,6 +1235,15 @@ function createMapNestedSchemaType(schema, schemaType, path, obj, options) {
       _mapType = { [schema.options.typeKey]: obj.of };
     }
 
+    if (_mapType[schema.options.typeKey] && _mapType[schema.options.typeKey].instanceOfSchema) {
+      const subdocumentSchema = _mapType[schema.options.typeKey];
+      subdocumentSchema.eachPath((subpath, type) => {
+        if (type.options.select === true || type.options.select === false) {
+          throw new MongooseError('Cannot use schema-level projections (`select: true` or `select: false`) within maps at path "' + path + '.' + subpath + '"');
+        }
+      });
+    }
+
     if (utils.hasUserDefinedProperty(obj, 'ref')) {
       _mapType.ref = obj.ref;
     }

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

@@ -22,6 +22,14 @@ const methods = {
     return this.toObject(internalToObjectOptions);
   },
 
+  /*!
+   * ignore
+   */
+
+  getArrayParent() {
+    return this[arrayParentSymbol];
+  },
+
   /**
    * Overrides MongooseArray#cast
    *

package/lib/utils.js

@@ -516,6 +516,10 @@ exports.populate = function populate(path, select, model, match, options, subPop
   let obj = null;
   if (arguments.length === 1) {
     if (path instanceof PopulateOptions) {
+      // If reusing old populate docs, avoid reusing `_docs` because that may
+      // lead to bugs and memory leaks. See gh-11641
+      path._docs = [];
+      path._childDocs = [];
       return [path];
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.1",
+  "version": "6.3.4",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -22,51 +22,69 @@
     "bson": "^4.6.2",
     "kareem": "2.3.5",
     "mongodb": "4.5.0",
-    "mpath": "0.8.4",
-    "mquery": "4.0.2",
+    "mpath": "0.9.0",
+    "mquery": "4.0.3",
     "ms": "2.1.3",
     "sift": "16.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.8",
-    "@babel/preset-env": "7.16.11",
-    "@typescript-eslint/eslint-plugin": "5.17.0",
-    "@typescript-eslint/parser": "5.17.0",
+    "@babel/core": "7.17.10",
+    "@babel/preset-env": "7.17.10",
+    "@typescript-eslint/eslint-plugin": "5.21.0",
+    "@typescript-eslint/parser": "5.21.0",
     "acquit": "1.2.1",
     "acquit-ignore": "0.2.0",
     "acquit-require": "0.1.1",
-    "assert-browserify": "npm:assert@^2.0.0",
-    "axios": "0.26.1",
-    "babel-loader": "8.2.4",
+    "assert-browserify": "2.0.0",
+    "axios": "0.27.2",
+    "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
+    "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.10",
     "crypto-browserify": "3.12.0",
     "dox": "0.3.1",
-    "eslint": "8.12.0",
+    "eslint": "8.14.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
-    "highlight.js": "11.5.0",
+    "highlight.js": "11.5.1",
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
-    "marked": "4.0.12",
-    "mocha": "9.2.2",
+    "marked": "4.0.14",
+    "mkdirp": "^1.0.4",
+    "mocha": "10.0.0",
     "moment": "2.x",
-    "mongodb-memory-server": "8.3.0",
+    "mongodb-memory-server": "8.5.2",
+    "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
     "serve-handler": "6.1.3",
-    "sinon": "13.0.0",
+    "sinon": "13.0.2",
     "stream-browserify": "3.0.0",
-    "tsd": "0.19.1",
-    "typescript": "4.6.3",
+    "tsd": "0.20.0",
+    "typescript": "4.6.4",
     "uuid": "8.3.2",
-    "webpack": "5.70.0"
+    "webpack": "5.72.0"
   },
   "directories": {
     "lib": "./lib/mongoose"
   },
   "scripts": {
+    "docs:clean": "npm run docs:clean:stable",
+    "docs:clean:stable": "rimraf index.html && rimraf -rf ./docs/*.html  && rimraf -rf ./docs/api && rimraf -rf ./docs/tutorials/*.html && rimraf -rf ./docs/typescript/*.html && rimraf -rf ./docs/*.html && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:clean:legacy": "rimraf index.html && rimraf -rf ./docs/5.x && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:copy:tmp": "mkdirp ./tmp/docs/css && mkdirp ./tmp/docs/js && mkdirp ./tmp/docs/images && mkdirp ./tmp/docs/tutorials && mkdirp ./tmp/docs/typescript && ncp ./docs/css ./tmp/docs/css --filter=.css$ && ncp ./docs/js ./tmp/docs/js --filter=.js$ && ncp ./docs/images ./tmp/docs/images && ncp ./docs/tutorials ./tmp/docs/tutorials && ncp ./docs/typescript ./tmp/docs/typescript && cp index.html ./tmp",
+    "docs:copy:tmp:legacy": "rimraf ./docs/5.x && ncp ./tmp ./docs/5.x",
+    "docs:checkout:gh-pages": "git checkout gh-pages",
+    "docs:checkout:legacy": "git checkout 5.x",
+    "docs:generate": "node website.js",
+    "docs:generate:search": "node docs/search.js",
+    "docs:merge:stable": "git merge master",
+    "docs:merge:legacy": "git merge 5.x",
+    "docs:test": "npm run docs:generate && npm run docs:generate:search",
+    "docs:view": "node website.js && node static.js",
+    "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && npm run docs:merge:stable && npm run docs:clean:stable && npm run docs:generate && npm run docs:generate:search",
+    "docs:prepare:publish:legacy": "npm run docs:checkout:legacy && npm run docs:merge:legacy && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && docs:checkout:gh-pages && docs:copy:tmp:legacy",
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js",
     "lint-ts": "eslint . --ext .ts",
@@ -76,6 +94,7 @@
     "release-legacy": "git pull origin 5.x && git push origin 5.x --tags && npm publish --tag legacy",
     "mongo": "node ./tools/repl.js",
     "test": "mocha --exit ./test/*.test.js",
+    "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
     "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
     "test-coverage": "nyc --reporter=html --reporter=text npm test"
@@ -119,6 +138,7 @@
       "allowSyntheticDefaultImports": true,
       "strictPropertyInitialization": false,
       "noImplicitAny": false,
+      "strictNullChecks": true,
       "module": "commonjs",
       "target": "ES2017"
     }

package/tsconfig.json

@@ -4,6 +4,5 @@
     "paths": {
       "mongoose" : ["./types/index.d.ts"]
     }
-  },
-  "include": ["types/*"]
+  }
 }

package/types/aggregate.d.ts

@@ -1,6 +1,5 @@
-import mongodb = require('mongodb');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
 
   interface AggregateOptions {
     /**

package/types/connection.d.ts

@@ -1,7 +1,6 @@
-import mongodb = require('mongodb');
-import events = require('events');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
+  import events = require('events');
 
   /**
      * Connection ready state
@@ -73,7 +72,7 @@ declare module 'mongoose' {
        * use this function to clean up any models you created in your tests to
        * prevent OverwriteModelErrors.
        */
-    deleteModel(name: string): this;
+    deleteModel(name: string | RegExp): this;
 
     /**
        * Helper for `dropCollection()`. Will delete the given collection, including

package/types/cursor.d.ts

@@ -1,6 +1,7 @@
-import stream = require('stream');
-
 declare module 'mongoose' {
+
+  import stream = require('stream');
+
   type CursorFlag = 'tailable' | 'oplogReplay' | 'noCursorTimeout' | 'awaitData' | 'partial';
 
   interface EachAsyncOptions {

package/types/document.d.ts

@@ -1,10 +1,15 @@
-import mongodb = require('mongodb');
-
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
 
   /** A list of paths to skip. If set, Mongoose will validate every modified path that is not in this list. */
   type pathsToSkip = string[] | string;
 
+  /**
+   * Generic types for Document:
+   * *  T - the type of _id
+   * *  TQueryHelpers - Object with any helpers that should be mixed into the Query type
+   * *  DocType - the type of the actual Document created
+   */
   class Document<T = any, TQueryHelpers = any, DocType = any> {
     constructor(doc?: any);
 
@@ -186,10 +191,10 @@ declare module 'mongoose' {
     $parent(): Document | undefined;
 
     /** Populates document references. */
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, names: string, callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, names: string): Promise<this & Paths>;
     populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<this & Paths>;
+    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<unknown>, match?: AnyObject, options?: PopulateOptions): Promise<this & Paths>;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<unknown>, match?: AnyObject, options?: PopulateOptions, callback?: Callback<this & Paths>): void;
 
     /** Gets _id(s) used during population of the given `path`. If the path was not populated, returns `undefined`. */
     populated(path: string): any;
@@ -216,13 +221,11 @@ declare module 'mongoose' {
     set(value: any): this;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON(options: ToObjectOptions & { flattenMaps: false }): LeanDocument<this>;
-    toJSON(options?: ToObjectOptions): FlattenMaps<LeanDocument<this>>;
-    toJSON<T = FlattenMaps<DocType>>(options?: ToObjectOptions): T;
+    toJSON<T = LeanDocument<DocType>>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<T>;
+    toJSON<T = LeanDocument<DocType>>(options: ToObjectOptions & { flattenMaps: false }): T;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject(options?: ToObjectOptions): LeanDocument<this>;
-    toObject<T = DocType>(options?: ToObjectOptions): T;
+    toObject<T = LeanDocument<DocType>>(options?: ToObjectOptions): Require_id<T>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified(path: string): void;
@@ -242,6 +245,6 @@ declare module 'mongoose' {
 
     /** Executes registered validation rules (skipping asynchronous validators) for this document. */
     validateSync(options: { pathsToSkip?: pathsToSkip, [k: string]: any }): Error.ValidationError | null;
-    validateSync(pathsToValidate?: Array<string>, options?: AnyObject): Error.ValidationError | null;
+    validateSync(pathsToValidate?: pathsToValidate, options?: AnyObject): Error.ValidationError | null;
   }
-}
+}

package/types/error.d.ts

@@ -1,129 +1,129 @@
-import mongodb = require('mongodb');
+declare class NativeError extends global.Error { }
 
 declare module 'mongoose' {
+  import mongodb = require('mongodb');
 
-  class NativeError extends global.Error { }
-    type CallbackError = NativeError | null;
-
-    class MongooseError extends global.Error {
-      constructor(msg: string);
-
-      /** The type of error. "MongooseError" for generic errors. */
-      name: string;
-
-      static messages: any;
-
-      static Messages: any;
-    }
-
-    namespace Error {
-      export class CastError extends MongooseError {
-        name: 'CastError';
-        stringValue: string;
-        kind: string;
-        value: any;
-        path: string;
-        reason?: NativeError | null;
-        model?: any;
-
-        constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
-      }
-      export class SyncIndexesError extends MongooseError {
-        name: 'SyncIndexesError';
-        errors?: Record<string, mongodb.MongoServerError>;
-
-        constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
-      }
-
-      export class DisconnectedError extends MongooseError {
-        name: 'DisconnectedError';
-      }
-
-      export class DivergentArrayError extends MongooseError {
-        name: 'DivergentArrayError';
-      }
-
-      export class MissingSchemaError extends MongooseError {
-        name: 'MissingSchemaError';
-      }
-
-      export class DocumentNotFoundError extends MongooseError {
-        name: 'DocumentNotFoundError';
-        result: any;
-        numAffected: number;
-        filter: any;
-        query: any;
-      }
-
-      export class ObjectExpectedError extends MongooseError {
-        name: 'ObjectExpectedError';
-        path: string;
-      }
-
-      export class ObjectParameterError extends MongooseError {
-        name: 'ObjectParameterError';
-      }
-
-      export class OverwriteModelError extends MongooseError {
-        name: 'OverwriteModelError';
-      }
-
-      export class ParallelSaveError extends MongooseError {
-        name: 'ParallelSaveError';
-      }
-
-      export class ParallelValidateError extends MongooseError {
-        name: 'ParallelValidateError';
-      }
-
-      export class MongooseServerSelectionError extends MongooseError {
-        name: 'MongooseServerSelectionError';
-      }
-
-      export class StrictModeError extends MongooseError {
-        name: 'StrictModeError';
-        isImmutableError: boolean;
-        path: string;
-      }
-
-      export class ValidationError extends MongooseError {
-        name: 'ValidationError';
-
-        errors: { [path: string]: ValidatorError | CastError };
-        addError: (path: string, error: ValidatorError | CastError) => void;
-
-        constructor(instance?: MongooseError);
-      }
-
-      export class ValidatorError extends MongooseError {
-        name: 'ValidatorError';
-        properties: {
-          message: string,
-          type?: string,
-          path?: string,
-          value?: any,
-          reason?: any
-        };
-        kind: string;
-        path: string;
-        value: any;
-        reason?: MongooseError | null;
-
-        constructor(properties: {
-          message?: string,
-          type?: string,
-          path?: string,
-          value?: any,
-          reason?: any
-        });
-      }
-
-      export class VersionError extends MongooseError {
-        name: 'VersionError';
-        version: number;
-        modifiedPaths: Array<string>;
-
-        constructor(doc: Document, currentVersion: number, modifiedPaths: Array<string>);
-      }
+  type CallbackError = NativeError | null;
+
+  class MongooseError extends global.Error {
+    constructor(msg: string);
+
+    /** The type of error. "MongooseError" for generic errors. */
+    name: string;
+
+    static messages: any;
+
+    static Messages: any;
+  }
+
+  namespace Error {
+    export class CastError extends MongooseError {
+      name: 'CastError';
+      stringValue: string;
+      kind: string;
+      value: any;
+      path: string;
+      reason?: NativeError | null;
+      model?: any;
+
+      constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
+    }
+    export class SyncIndexesError extends MongooseError {
+      name: 'SyncIndexesError';
+      errors?: Record<string, mongodb.MongoServerError>;
+
+      constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
+    }
+
+    export class DisconnectedError extends MongooseError {
+      name: 'DisconnectedError';
+    }
+
+    export class DivergentArrayError extends MongooseError {
+      name: 'DivergentArrayError';
+    }
+
+    export class MissingSchemaError extends MongooseError {
+      name: 'MissingSchemaError';
+    }
+
+    export class DocumentNotFoundError extends MongooseError {
+      name: 'DocumentNotFoundError';
+      result: any;
+      numAffected: number;
+      filter: any;
+      query: any;
+    }
+
+    export class ObjectExpectedError extends MongooseError {
+      name: 'ObjectExpectedError';
+      path: string;
+    }
+
+    export class ObjectParameterError extends MongooseError {
+      name: 'ObjectParameterError';
+    }
+
+    export class OverwriteModelError extends MongooseError {
+      name: 'OverwriteModelError';
+    }
+
+    export class ParallelSaveError extends MongooseError {
+      name: 'ParallelSaveError';
+    }
+
+    export class ParallelValidateError extends MongooseError {
+      name: 'ParallelValidateError';
+    }
+
+    export class MongooseServerSelectionError extends MongooseError {
+      name: 'MongooseServerSelectionError';
+    }
+
+    export class StrictModeError extends MongooseError {
+      name: 'StrictModeError';
+      isImmutableError: boolean;
+      path: string;
+    }
+
+    export class ValidationError extends MongooseError {
+      name: 'ValidationError';
+
+      errors: { [path: string]: ValidatorError | CastError };
+      addError: (path: string, error: ValidatorError | CastError) => void;
+
+      constructor(instance?: MongooseError);
+    }
+
+    export class ValidatorError extends MongooseError {
+      name: 'ValidatorError';
+      properties: {
+        message: string,
+        type?: string,
+        path?: string,
+        value?: any,
+        reason?: any
+      };
+      kind: string;
+      path: string;
+      value: any;
+      reason?: MongooseError | null;
+
+      constructor(properties: {
+        message?: string,
+        type?: string,
+        path?: string,
+        value?: any,
+        reason?: any
+      });
+    }
+
+    export class VersionError extends MongooseError {
+      name: 'VersionError';
+      version: number;
+      modifiedPaths: Array<string>;
+
+      constructor(doc: Document, currentVersion: number, modifiedPaths: Array<string>);
     }
+  }
 }