mongoose 7.0.1 → 7.0.2

package/lib/aggregate.js

@@ -1127,7 +1127,7 @@ Aggregate.prototype.catch = function(reject) {
  * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
  * support async iterators.
  *
- * @method Symbol.asyncIterator
+ * @method [Symbol.asyncIterator]
  * @memberOf Aggregate
  * @instance
  * @api public

package/lib/connection.js

@@ -1057,6 +1057,16 @@ Connection.prototype._close = async function _close(force, destroy) {
   return this;
 };
 
+/**
+ * Abstract method that drivers must implement.
+ *
+ * @api private
+ */
+
+Connection.prototype.doClose = function() {
+  throw new Error('Connection#doClose unimplemented by driver');
+};
+
 /**
  * Called when the connection closes
  *

package/lib/cursor/AggregationCursor.js

@@ -263,7 +263,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
  * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
  * support async iterators.
  *
- * @method Symbol.asyncIterator
+ * @method [Symbol.asyncIterator]
  * @memberOf AggregationCursor
  * @instance
  * @api public

package/lib/cursor/QueryCursor.js

@@ -347,7 +347,7 @@ QueryCursor.prototype._transformForAsyncIterator = function() {
  * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
  * support async iterators.
  *
- * @method Symbol.asyncIterator
+ * @method [Symbol.asyncIterator]
  * @memberOf QueryCursor
  * @instance
  * @api public

package/lib/document.js

@@ -2557,7 +2557,7 @@ function _evaluateRequiredFunctions(doc) {
  * ignore
  */
 
-function _getPathsToValidate(doc) {
+function _getPathsToValidate(doc, pathsToValidate, pathsToSkip) {
   const skipSchemaValidators = {};
 
   _evaluateRequiredFunctions(doc);
@@ -2628,6 +2628,22 @@ function _getPathsToValidate(doc) {
     }
   }
 
+  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);
+  } else if (Array.isArray(pathsToSkip)) {
+    paths = _handlePathsToSkip(paths, pathsToSkip);
+  }
+
   // from here on we're not removing items from paths
 
   // gh-661: if a whole array is modified, make sure to run validation on all
@@ -2687,13 +2703,6 @@ function _getPathsToValidate(doc) {
   }
 
   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;
-    }
     const _pathType = doc.$__schema.path(path);
     if (!_pathType || !_pathType.$isSchemaMap) {
       continue;
@@ -2776,7 +2785,7 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
   };
 
   // only validate required fields when necessary
-  const pathDetails = _getPathsToValidate(this);
+  const pathDetails = _getPathsToValidate(this, pathsToValidate, pathsToSkip);
   let paths = shouldValidateModifiedOnly ?
     pathDetails[0].filter((path) => this.$isModified(path)) :
     pathDetails[0];
@@ -2784,11 +2793,6 @@ Document.prototype.$__validate = function(pathsToValidate, options, callback) {
   if (typeof pathsToValidate === 'string') {
     pathsToValidate = pathsToValidate.split(' ');
   }
-  if (Array.isArray(pathsToValidate)) {
-    paths = _handlePathsToValidate(paths, pathsToValidate);
-  } else if (pathsToSkip) {
-    paths = _handlePathsToSkip(paths, pathsToSkip);
-  }
 
   if (paths.length === 0) {
     return immediate(function() {
@@ -2907,12 +2911,12 @@ function _handlePathsToValidate(paths, pathsToValidate) {
     }
   }
 
-  const ret = [];
+  const ret = new Set();
   for (const path of paths) {
     if (_pathsToValidate.has(path)) {
-      ret.push(path);
+      ret.add(path);
     } else if (parentPaths.has(path)) {
-      ret.push(parentPaths.get(path));
+      ret.add(parentPaths.get(path));
     }
   }
   return ret;
@@ -2924,8 +2928,8 @@ function _handlePathsToValidate(paths, pathsToValidate) {
 
 function _handlePathsToSkip(paths, pathsToSkip) {
   pathsToSkip = new Set(pathsToSkip);
-  paths = paths.filter(p => !pathsToSkip.has(p));
-  return paths;
+  paths = Array.from(paths).filter(p => !pathsToSkip.has(p));
+  return new Set(paths);
 }
 
 /**
@@ -2981,17 +2985,12 @@ Document.prototype.validateSync = function(pathsToValidate, options) {
   }
 
   // only validate required fields when necessary
-  const pathDetails = _getPathsToValidate(this);
+  const pathDetails = _getPathsToValidate(this, pathsToValidate, pathsToSkip);
   let paths = shouldValidateModifiedOnly ?
     pathDetails[0].filter((path) => this.$isModified(path)) :
     pathDetails[0];
   const skipSchemaValidators = pathDetails[1];
 
-  if (Array.isArray(pathsToValidate)) {
-    paths = _handlePathsToValidate(paths, pathsToValidate);
-  } else if (Array.isArray(pathsToSkip)) {
-    paths = _handlePathsToSkip(paths, pathsToSkip);
-  }
   const validating = {};
 
   for (let i = 0, len = paths.length; i < len; ++i) {

package/lib/helpers/document/applyDefaults.js

@@ -32,7 +32,7 @@ module.exports = function applyDefaults(doc, fields, exclude, hasIncludedChildre
         }
       } else if (exclude === false && fields && !included) {
         const hasSubpaths = type.$isSingleNested || type.$isMongooseDocumentArray;
-        if (curPath in fields || (hasSubpaths && hasIncludedChildren != null && hasIncludedChildren[curPath])) {
+        if (curPath in fields || (j === len - 1 && hasSubpaths && hasIncludedChildren != null && hasIncludedChildren[curPath])) {
           included = true;
         } else if (hasIncludedChildren != null && !hasIncludedChildren[curPath]) {
           break;

package/lib/model.js

@@ -1252,9 +1252,11 @@ for (const i in EventEmitter.prototype) {
  * Mongoose calls this function automatically when a model is created using
  * [`mongoose.model()`](/docs/api/mongoose.html#mongoose_Mongoose-model) or
  * [`connection.model()`](/docs/api/connection.html#connection_Connection-model), so you
- * don't need to call it. This function is also idempotent, so you may call it
- * to get back a promise that will resolve when your indexes are finished
- * building as an alternative to [`MyModel.on('index')`](/docs/guide.html#indexes)
+ * don't need to call `init()` to trigger index builds.
+ *
+ * However, you _may_ need to call `init()`  to get back a promise that will resolve when your indexes are finished.
+ * Calling `await Model.init()` is helpful if you need to wait for indexes to build before continuing.
+ * For example, if you want to wait for unique indexes to build before continuing with a test case.
  *
  * #### Example:
  *
@@ -1263,11 +1265,8 @@ for (const i in EventEmitter.prototype) {
  *     // `Event.init()` on your own.
  *     const Event = mongoose.model('Event', eventSchema);
  *
- *     Event.init().then(function(Event) {
- *       // You can also use `Event.on('index')` if you prefer event emitters
- *       // over promises.
- *       console.log('Indexes are done building!');
- *     });
+ *     await Event.init();
+ *     console.log('Indexes are done building!');
  *
  * @api public
  * @returns {Promise}

package/lib/query.js

@@ -4482,7 +4482,8 @@ Query.prototype.finally = function(onFinally) {
  *
  * @return {String}
  * @api public
- * @method toStringTag
+ * @method [Symbol.toStringTag]
+ * @memberOf Query
  */
 
 Query.prototype[Symbol.toStringTag] = function toString() {
@@ -5192,7 +5193,7 @@ Query.prototype.nearSphere = function() {
  * `Symbol.asyncIterator` is undefined, that means your Node.js version does not
  * support async iterators.
  *
- * @method Symbol.asyncIterator
+ * @method [Symbol.asyncIterator]
  * @memberOf Query
  * @instance
  * @api public

package/lib/schema/documentarray.js

@@ -416,6 +416,8 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
 
   options = options || {};
 
+  const path = options.path || this.path;
+
   if (!Array.isArray(value)) {
     if (!init && !DocumentArrayPath.options.castNonArrays) {
       throw new CastError('DocumentArray', value, this.path, null, this);
@@ -423,7 +425,7 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
     // gh-2442 mark whole array as modified if we're initializing a doc from
     // the db and the path isn't an array in the document
     if (!!doc && init) {
-      doc.markModified(this.path);
+      doc.markModified(path);
     }
     return this.cast([value], doc, init, prev, options);
   }
@@ -431,7 +433,7 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
   // We need to create a new array, otherwise change tracking will
   // update the old doc (gh-4449)
   if (!options.skipDocumentArrayCast || utils.isMongooseDocumentArray(value)) {
-    value = new MongooseDocumentArray(value, this.path, doc);
+    value = new MongooseDocumentArray(value, path, doc);
   }
 
   if (prev != null) {
@@ -439,7 +441,7 @@ DocumentArrayPath.prototype.cast = function(value, doc, init, prev, options) {
   }
 
   if (options.arrayPathIndex != null) {
-    value[arrayPathSymbol] = this.path + '.' + options.arrayPathIndex;
+    value[arrayPathSymbol] = path + '.' + options.arrayPathIndex;
   }
 
   const rawArray = utils.isMongooseDocumentArray(value) ? value.__array : value;

package/lib/schema.js

@@ -734,8 +734,15 @@ Schema.prototype.add = function add(obj, prefix) {
         if (prefix) {
           this.nested[prefix.substring(0, prefix.length - 1)] = true;
         }
-        const _schema = new Schema(_typeDef);
-        const schemaWrappedPath = Object.assign({}, val, { type: _schema });
+
+        const childSchemaOptions = {};
+        if (this._userProvidedOptions.typeKey) {
+          childSchemaOptions.typeKey = this._userProvidedOptions.typeKey;
+        }
+
+        const _schema = new Schema(_typeDef, childSchemaOptions);
+        _schema.$implicitlyCreated = true;
+        const schemaWrappedPath = Object.assign({}, val, { [typeKey]: _schema });
         this.path(prefix + key, schemaWrappedPath);
       } else {
         // Either the type is non-POJO or we interpret it as Mixed anyway
@@ -1322,6 +1329,7 @@ Schema.prototype.interpretAsType = function(path, obj, options) {
         } else if (Schema.Types.DocumentArray.defaultOptions._id != null) {
           childSchemaOptions._id = Schema.Types.DocumentArray.defaultOptions._id;
         }
+
         const childSchema = new Schema(castFromTypeKey, childSchemaOptions);
         childSchema.$implicitlyCreated = true;
         return new MongooseTypes.DocumentArray(path, childSchema, obj);
@@ -1365,7 +1373,6 @@ Schema.prototype.interpretAsType = function(path, obj, options) {
   }
 
   if (type && type.instanceOfSchema) {
-
     return new MongooseTypes.Subdocument(type, path, obj);
   }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.0.1",
+  "version": "7.0.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -46,6 +46,7 @@
     "dotenv": "16.0.3",
     "dox": "1.0.0",
     "eslint": "8.35.0",
+    "eslint-plugin-markdown": "^3.0.0",
     "eslint-plugin-mocha-no-only": "1.1.1",
     "express": "^4.18.1",
     "highlight.js": "11.7.0",
@@ -95,6 +96,7 @@
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js",
     "lint-ts": "eslint . --ext .ts",
+    "lint-md": "eslint . --ext .md",
     "build-browser": "(rm ./dist/* || true) && node ./scripts/build-browser.js",
     "prepublishOnly": "npm run build-browser",
     "release": "git pull && git push origin master --tags && npm publish",

package/scripts/generateSearch.js

@@ -1,6 +1,14 @@
 'use strict';
 
-const config = require('../.config');
+let config;
+try {
+  config = require('../.config.js');
+} finally {
+  if (!config || !config.uri) {
+    console.error('No Config or config.URI given, please create a .config.js file with those values in the root of the repository');
+    process.exit(-1);
+  }
+}
 const cheerio = require('cheerio');
 const filemap = require('../docs/source');
 const fs = require('fs');
@@ -30,25 +38,27 @@ const Content = mongoose.model('Content', contentSchema, 'Content');
 
 const contents = [];
 
-for (const [filename, file] of Object.entries(filemap)) {
-  if (file.api) {
-    // API docs are special, raw content is in the `docs` property
-    for (const _class of file.docs) {
-      for (const prop of _class.props) {
-        const content = new Content({
-          title: `API: ${prop.string}`,
-          body: prop.description,
-          url: `api/${_class.fileName}.html#${prop.anchorId}`
-        });
-        const err = content.validateSync();
-        if (err != null) {
-          console.error(content);
-          throw err;
-        }
-        contents.push(content);
-      }
+const api = require('../docs/source/api');
+
+// API docs are special, because they are not added to the file-map individually currently and use different properties
+for (const _class of api.docs) {
+  for (const prop of _class.props) {
+    const content = new Content({
+      title: `API: ${prop.name}`,
+      body: prop.description,
+      url: `api/${_class.fileName}.html#${prop.anchorId}`
+    });
+    const err = content.validateSync();
+    if (err != null) {
+      console.error(content);
+      throw err;
     }
-  } else if (file.markdown) {
+    contents.push(content);
+  }
+}
+
+for (const [filename, file] of Object.entries(filemap)) {
+  if (file.markdown) {
     let text = fs.readFileSync(filename, 'utf8');
     text = markdown.parse(text);
 
@@ -120,11 +130,6 @@ run().catch(async error => {
 });
 
 async function run() {
-  if (!config || !config.uri) {
-    console.error('No Config or config.URI given, please create a .config.js file with those values');
-    process.exit(-1);
-  }
-
   await mongoose.connect(config.uri, { dbName: 'mongoose', serverSelectionTimeoutMS: 5000 });
 
   // wait for the index to be created
@@ -152,5 +157,7 @@ async function run() {
 
   console.log(results.map(res => res.url));
 
+  console.log(`Added ${contents.length} Content`);
+
   process.exit(0);
 }

package/types/cursor.d.ts

@@ -38,8 +38,8 @@ declare module 'mongoose' {
      * will wait for the promise to resolve before iterating on to the next one.
      * Returns a promise that resolves when done.
      */
-    eachAsync(fn: (doc: DocType[]) => any, options: EachAsyncOptions & { batchSize: number }): Promise<void>;
-    eachAsync(fn: (doc: DocType) => any, options?: EachAsyncOptions): Promise<void>;
+    eachAsync(fn: (doc: DocType[], i: number) => any, options: EachAsyncOptions & { batchSize: number }): Promise<void>;
+    eachAsync(fn: (doc: DocType, i: number) => any, options?: EachAsyncOptions): Promise<void>;
 
     /**
      * Registers a transform function which subsequently maps documents retrieved

package/types/query.d.ts

@@ -109,7 +109,7 @@ declare module 'mongoose' {
     /**
      * If truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document.
      */
-    lean?: boolean | any;
+    lean?: boolean | Record<string, any>;
     limit?: number;
     maxTimeMS?: number;
     multi?: boolean;
@@ -532,7 +532,7 @@ declare module 'mongoose' {
     replaceOne(filter?: FilterQuery<DocType>, replacement?: DocType | AnyObject, options?: QueryOptions<DocType> | null): QueryWithHelpers<any, DocType, THelpers, RawDocType>;
 
     /** Specifies which document fields to include or exclude (also known as the query "projection") */
-    select(arg: string | any): this;
+    select(arg: string | string[] | Record<string, number | boolean | object>): this;
 
     /** Determines if field selection has been made. */
     selected(): boolean;

package/types/types.d.ts

@@ -61,7 +61,7 @@ declare module 'mongoose' {
 
     class DocumentArray<T> extends Types.Array<T extends Types.Subdocument ? T : Types.Subdocument<InferId<T>> & T> {
       /** DocumentArray constructor */
-      constructor(values: any[]);
+      constructor(values: (AnyKeys<T> & AnyObject)[]);
 
       isMongooseDocumentArray: true;
 

package/.eslintrc.json

@@ -1,195 +0,0 @@
-{
-  "extends": [
-    "eslint:recommended"
-  ],
-  "ignorePatterns": [
-    "docs",
-    "tools",
-    "dist",
-    "website.js",
-    "test/files/*",
-    "benchmarks"
-  ],
-  "overrides": [
-    {
-      "files": [
-        "**/*.{ts,tsx}"
-      ],
-      "extends": [
-        "plugin:@typescript-eslint/eslint-recommended",
-        "plugin:@typescript-eslint/recommended"
-      ],
-      "plugins": [
-        "@typescript-eslint"
-      ],
-      "rules": {
-        "@typescript-eslint/triple-slash-reference": "off",
-        "@typescript-eslint/no-non-null-assertion": "off",
-        "@typescript-eslint/no-empty-function": "off",
-        "spaced-comment": [
-          "error",
-          "always",
-          {
-            "block": {
-              "markers": [
-                "!"
-              ],
-              "balanced": true
-            },
-            "markers": [
-              "/"
-            ]
-          }
-        ],
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/ban-types": "off",
-        "@typescript-eslint/no-unused-vars": "off",
-        "@typescript-eslint/explicit-module-boundary-types": "off",
-        "@typescript-eslint/indent": [
-          "warn",
-          2,
-          {
-            "SwitchCase": 1,
-            "ignoredNodes": ["TSTypeParameterInstantiation"]
-          }
-        ],
-        "@typescript-eslint/prefer-optional-chain": "error",
-        "@typescript-eslint/brace-style": "error",
-        "@typescript-eslint/no-dupe-class-members": "error",
-        "@typescript-eslint/no-redeclare": "error",
-        "@typescript-eslint/type-annotation-spacing": "error",
-        "@typescript-eslint/object-curly-spacing": [
-          "error",
-          "always"
-        ],
-        "@typescript-eslint/semi": "error",
-        "@typescript-eslint/space-before-function-paren": [
-          "error",
-          "never"
-        ],
-        "@typescript-eslint/space-infix-ops": "off"
-      }
-    }
-  ],
-  "plugins": [
-    "mocha-no-only"
-  ],
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "env": {
-    "node": true,
-    "es6": true
-  },
-  "rules": {
-    "comma-style": "error",
-    "indent": [
-      "error",
-      2,
-      {
-        "SwitchCase": 1,
-        "VariableDeclarator": 2
-      }
-    ],
-    "keyword-spacing": "error",
-    "no-whitespace-before-property": "error",
-    "no-buffer-constructor": "warn",
-    "no-console": "off",
-    "no-constant-condition": "off",
-    "no-multi-spaces": "error",
-    "func-call-spacing": "error",
-    "no-trailing-spaces": "error",
-    "no-undef": "error",
-    "no-unneeded-ternary": "error",
-    "no-const-assign": "error",
-    "no-useless-rename": "error",
-    "no-dupe-keys": "error",
-    "space-in-parens": [
-      "error",
-      "never"
-    ],
-    "spaced-comment": [
-      "error",
-      "always",
-      {
-        "block": {
-          "markers": [
-            "!"
-          ],
-          "balanced": true
-        }
-      }
-    ],
-    "key-spacing": [
-      "error",
-      {
-        "beforeColon": false,
-        "afterColon": true
-      }
-    ],
-    "comma-spacing": [
-      "error",
-      {
-        "before": false,
-        "after": true
-      }
-    ],
-    "array-bracket-spacing": 1,
-    "arrow-spacing": [
-      "error",
-      {
-        "before": true,
-        "after": true
-      }
-    ],
-    "object-curly-spacing": [
-      "error",
-      "always"
-    ],
-    "comma-dangle": [
-      "error",
-      "never"
-    ],
-    "no-unreachable": "error",
-    "quotes": [
-      "error",
-      "single"
-    ],
-    "quote-props": [
-      "error",
-      "as-needed"
-    ],
-    "semi": "error",
-    "no-extra-semi": "error",
-    "semi-spacing": "error",
-    "no-spaced-func": "error",
-    "no-throw-literal": "error",
-    "space-before-blocks": "error",
-    "space-before-function-paren": [
-      "error",
-      "never"
-    ],
-    "space-infix-ops": "error",
-    "space-unary-ops": "error",
-    "no-var": "warn",
-    "prefer-const": "warn",
-    "strict": [
-      "error",
-      "global"
-    ],
-    "no-restricted-globals": [
-      "error",
-      {
-        "name": "context",
-        "message": "Don't use Mocha's global context"
-      }
-    ],
-    "no-prototype-builtins": "off",
-    "mocha-no-only/mocha-no-only": [
-      "error"
-    ],
-    "no-empty": "off",
-    "eol-last": "warn",
-    "no-multiple-empty-lines": ["warn", { "max": 2 }]
-  }
-}