mongoose 6.5.1 → 6.5.2

package/lib/connection.js

@@ -1117,7 +1117,7 @@ Connection.prototype.collection = function(name, options) {
  * @param {Function} fn plugin callback
  * @param {Object} [opts] optional options
  * @return {Connection} this
- * @see plugins ./plugins.html
+ * @see plugins /docs/plugins
  * @api public
  */
 

package/lib/cursor/ChangeStream.js

@@ -54,7 +54,7 @@ class ChangeStream extends EventEmitter {
 
         ['close', 'change', 'end', 'error'].forEach(ev => {
           this.driverChangeStream.on(ev, data => {
-            if (data.fullDocument != null && this.options && this.options.hydrate) {
+            if (data != null && data.fullDocument != null && this.options && this.options.hydrate) {
               data.fullDocument = this.options.model.hydrate(data.fullDocument);
             }
             this.emit(ev, data);

package/lib/document.js

@@ -4217,6 +4217,7 @@ Document.prototype.equals = function(doc) {
  *
  * #### Example:
  *
+ *     // Given a document, `populate()` lets you pull in referenced docs
  *     await doc.populate([
  *       'stories',
  *       { path: 'fans', sort: { name: -1 } }
@@ -4225,12 +4226,15 @@ Document.prototype.equals = function(doc) {
  *     doc.stories[0].title; // 'Casino Royale'
  *     doc.populated('fans'); // Array of ObjectIds
  *
- *     await doc.populate('fans', '-email');
- *     doc.fans[0].email // not populated
+ *     // If the referenced doc has been deleted, `populate()` will
+ *     // remove that entry from the array.
+ *     await Story.delete({ title: 'Casino Royale' });
+ *     await doc.populate('stories'); // Empty array
  *
- *     await doc.populate('author fans', '-email');
- *     doc.author.email // not populated
- *     doc.fans[0].email // not populated
+ *     // You can also pass additional query options to `populate()`,
+ *     // like projections:
+ *     await doc.populate('fans', '-email');
+ *     doc.fans[0].email // undefined because of 2nd param `select`
  *
  * @param {String|Object|Array} path either the path to populate or an object specifying all parameters, or either an array of those
  * @param {Object|String} [select] Field selection for the population query
@@ -4246,7 +4250,7 @@ Document.prototype.equals = function(doc) {
  * @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
  * @param {Function} [callback] Callback
- * @see population ./populate.html
+ * @see population /docs/populate
  * @see Query#select #query_Query-select
  * @see Model.populate #model_Model-populate
  * @memberOf Document

package/lib/helpers/promiseOrCallback.js

@@ -7,23 +7,32 @@ const emittedSymbol = Symbol('mongoose:emitted');
 
 module.exports = function promiseOrCallback(callback, fn, ee, Promise) {
   if (typeof callback === 'function') {
-    return fn(function(error) {
-      if (error != null) {
-        if (ee != null && ee.listeners != null && ee.listeners('error').length > 0 && !error[emittedSymbol]) {
-          error[emittedSymbol] = true;
-          ee.emit('error', error);
+    try {
+      return fn(function(error) {
+        if (error != null) {
+          if (ee != null && ee.listeners != null && ee.listeners('error').length > 0 && !error[emittedSymbol]) {
+            error[emittedSymbol] = true;
+            ee.emit('error', error);
+          }
+          try {
+            callback(error);
+          } catch (error) {
+            return immediate(() => {
+              throw error;
+            });
+          }
+          return;
         }
-        try {
-          callback(error);
-        } catch (error) {
-          return immediate(() => {
-            throw error;
-          });
-        }
-        return;
+        callback.apply(this, arguments);
+      });
+    } catch (error) {
+      if (ee != null && ee.listeners != null && ee.listeners('error').length > 0 && !error[emittedSymbol]) {
+        error[emittedSymbol] = true;
+        ee.emit('error', error);
       }
-      callback.apply(this, arguments);
-    });
+
+      return callback(error);
+    }
   }
 
   Promise = Promise || PromiseProvider.get();

package/lib/index.js

@@ -688,7 +688,7 @@ Mongoose.prototype._applyPlugins = function(schema, options) {
  * @param {Function} fn plugin callback
  * @param {Object} [opts] optional options
  * @return {Mongoose} this
- * @see plugins ./plugins.html
+ * @see plugins /docs/plugins
  * @api public
  */
 

package/lib/model.js

@@ -3120,10 +3120,9 @@ Model.create = function create(doc, options, callback) {
     }
     const _done = (error, res) => {
       const savedDocs = [];
-      const len = res.length;
-      for (let i = 0; i < len; ++i) {
-        if (res[i].doc) {
-          savedDocs.push(res[i].doc);
+      for (const val of res) {
+        if (val.doc) {
+          savedDocs.push(val.doc);
         }
       }
 
@@ -3575,13 +3574,17 @@ Model.bulkWrite = function(ops, options, callback) {
         return cb(null, getDefaultBulkwriteResult());
       }
 
-      this.$__collection.bulkWrite(ops, options, (error, res) => {
-        if (error) {
-          return cb(error);
-        }
+      try {
+        this.$__collection.bulkWrite(ops, options, (error, res) => {
+          if (error) {
+            return cb(error);
+          }
 
-        cb(null, res);
-      });
+          cb(null, res);
+        });
+      } catch (err) {
+        return cb(err);
+      }
     });
   }, this.events);
 };
@@ -4189,7 +4192,7 @@ function _update(model, op, conditions, doc, options, callback) {
  * @param {String} [opts.out.reduce] add the results to collectionName: if dups are detected, uses the reducer / finalize functions
  * @param {String} [opts.out.merge] add the results to collectionName: if dups exist the new docs overwrite the old
  * @param {Function} [callback] optional callback
- * @see https://www.mongodb.org/display/DOCS/MapReduce
+ * @see MongoDB MapReduce https://www.mongodb.org/display/DOCS/MapReduce
  * @return {Promise}
  * @api public
  */

package/lib/query.js

@@ -166,7 +166,7 @@ Query.base = mquery.prototype;
  *
  * MongoDB 2.4 deprecated the use of `$within`, replacing it with `$geoWithin`. Mongoose uses `$geoWithin` by default (which is 100% backward compatible with `$within`). If you are running an older version of MongoDB, set this flag to `false` so your `within()` queries continue to work.
  *
- * @see https://docs.mongodb.org/manual/reference/operator/geoWithin/
+ * @see geoWithin https://docs.mongodb.org/manual/reference/operator/geoWithin/
  * @default true
  * @property use$geoWithin
  * @memberOf Query
@@ -1072,7 +1072,7 @@ Query.prototype.projection = function(arg) {
  * @instance
  * @param {Object|String|String[]} arg
  * @return {Query} this
- * @see SchemaType
+ * @see SchemaType /docs/api/schematype
  * @api public
  */
 
@@ -1599,6 +1599,8 @@ Query.prototype.setOptions = function(options, overwrite) {
     throw new Error('Options must be an object, got "' + options + '"');
   }
 
+  options = Object.assign({}, options);
+
   if (Array.isArray(options.populate)) {
     const populate = options.populate;
     delete options.populate;
@@ -2042,6 +2044,9 @@ Query.prototype.set = function(path, val) {
   }
 
   this._update = this._update || {};
+  if (path in this._update) {
+    delete this._update[path];
+  }
   this._update.$set = this._update.$set || {};
   this._update.$set[path] = val;
   return this;
@@ -5071,7 +5076,7 @@ function castQuery(query) {
  * @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://docs.mongodb.com/manual/tutorial/query-documents/), or a function that returns a filter object.
  * @param {Function} [options.transform=null] Function that Mongoose will call on every populated document that allows you to transform the populated document.
  * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
- * @see population ./populate.html
+ * @see population /docs/populate
  * @see Query#select #query_Query-select
  * @see Model.populate #model_Model-populate
  * @return {Query} this
@@ -5342,7 +5347,7 @@ Query.prototype._applyPaths = function applyPaths() {
  *
  * @return {QueryCursor}
  * @param {Object} [options]
- * @see QueryCursor
+ * @see QueryCursor /docs/api/querycursor
  * @api public
  */
 
@@ -5498,8 +5503,8 @@ Query.prototype.tailable = function(val, opts) {
  * @param {Object} object Must contain a `type` property which is a String and a `coordinates` property which is an Array. See the examples.
  * @return {Query} this
  * @see $geometry https://docs.mongodb.org/manual/reference/operator/geometry/
- * @see https://docs.mongodb.org/manual/release-notes/2.4/#new-geospatial-indexes-with-geojson-and-improved-spherical-geometry
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see Geospatial Support Enhancements https://www.mongodb.com/docs/manual/release-notes/2.4/#geospatial-support-enhancements
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @api public
  */
 
@@ -5524,7 +5529,7 @@ Query.prototype.tailable = function(val, opts) {
  * @see $near https://docs.mongodb.org/manual/reference/operator/near/
  * @see $nearSphere https://docs.mongodb.org/manual/reference/operator/nearSphere/
  * @see $maxDistance https://docs.mongodb.org/manual/reference/operator/maxDistance/
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @api public
  */
 
@@ -5660,7 +5665,7 @@ if (Symbol.asyncIterator != null) {
  * @param {Array|Object} [coordinatePairs...]
  * @return {Query} this
  * @see $polygon https://docs.mongodb.org/manual/reference/operator/polygon/
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @api public
  */
 
@@ -5680,7 +5685,7 @@ if (Symbol.asyncIterator != null) {
  * @instance
  * @see $box https://docs.mongodb.org/manual/reference/operator/box/
  * @see within() Query#within #query_Query-within
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @param {Object|Array<Number>} val1 Lower Left Coordinates OR a object of lower-left(ll) and upper-right(ur) Coordinates
  * @param {Array<Number>} [val2] Upper Right Coordinates
  * @return {Query} this
@@ -5726,7 +5731,7 @@ Query.prototype.box = function(ll, ur) {
  * @see $center https://docs.mongodb.org/manual/reference/operator/center/
  * @see $centerSphere https://docs.mongodb.org/manual/reference/operator/centerSphere/
  * @see $geoWithin https://docs.mongodb.org/manual/reference/operator/geoWithin/
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @api public
  */
 
@@ -5758,7 +5763,7 @@ Query.prototype.center = Query.base.circle;
  * @param {String} [path]
  * @param {Object} val
  * @return {Query} this
- * @see https://www.mongodb.org/display/DOCS/Geospatial+Indexing
+ * @see MongoDB Geospatial Indexing https://www.mongodb.org/display/DOCS/Geospatial+Indexing
  * @see $centerSphere https://docs.mongodb.org/manual/reference/operator/centerSphere/
  * @api public
  */

package/lib/schema.js

@@ -1868,7 +1868,7 @@ Schema.prototype.index = function(fields, options) {
  *
  * @param {String} key The name of the option to set the value to
  * @param {Object} [value] The value to set the option to, if not passed, the option will be reset to default
- * @see Schema ./
+ * @see Schema #schema_Schema
  * @api public
  */
 

package/lib/types/buffer.js

@@ -177,7 +177,7 @@ utils.each(
  *     bson.BSON_BINARY_SUBTYPE_USER_DEFINED
  *     doc.buffer.toObject(bson.BSON_BINARY_SUBTYPE_USER_DEFINED);
  *
- * @see https://bsonspec.org/#/specification
+ * @see bsonspec https://bsonspec.org/#/specification
  * @param {Hex} [subtype]
  * @return {Binary}
  * @api public
@@ -249,7 +249,7 @@ MongooseBuffer.mixin.equals = function(other) {
  *
  *     doc.buffer.subtype(bson.BSON_BINARY_SUBTYPE_UUID);
  *
- * @see https://bsonspec.org/#/specification
+ * @see bsonspec https://bsonspec.org/#/specification
  * @param {Hex} subtype
  * @api public
  * @method subtype

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.5.1",
+  "version": "6.5.2",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -77,18 +77,18 @@
     "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": "node ./scripts/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:view": "node ./scripts/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",
-    "build-browser": "node build-browser.js",
+    "build-browser": "node ./scripts/build-browser.js",
     "prepublishOnly": "npm run build-browser",
     "release": "git pull && git push origin master --tags && npm publish",
     "release-legacy": "git pull origin 5.x && git push origin 5.x --tags && npm publish --tag legacy",

package/{build-browser.js → scripts/build-browser.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-const config = require('./webpack.config.js');
+const config = require('../webpack.config.js');
 const webpack = require('webpack');
 
 const compiler = webpack(config);

package/types/connection.d.ts

@@ -142,9 +142,15 @@ declare module 'mongoose' {
     readonly models: Readonly<{ [index: string]: Model<any> }>;
 
     /** Defines or retrieves a model. */
+    model<TSchema extends Schema = any>(
+      name: string,
+      schema?: TSchema,
+      collection?: string,
+      options?: CompileModelOptions
+    ): Model<InferSchemaType<TSchema>, ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>, ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>, {}, TSchema> & ObtainSchemaGeneric<TSchema, 'TStaticMethods'>;
     model<T, U, TQueryHelpers = {}>(
       name: string,
-      schema?: Schema<T, any, any, TQueryHelpers, any, any>,
+      schema?: Schema<T, U, any, TQueryHelpers, any, any>,
       collection?: string,
       options?: CompileModelOptions
     ): U;

package/types/index.d.ts

@@ -157,9 +157,20 @@ declare module 'mongoose' {
 
   type QueryResultType<T> = T extends Query<infer ResultType, any> ? ResultType : never;
 
-  type PluginFunction<DocType> = (schema: Schema<DocType>, opts?: any) => void;
-
-  export class Schema<EnforcedDocType = any, M = Model<EnforcedDocType, any, any, any>, TInstanceMethods = {}, TQueryHelpers = {}, TVirtuals = {},
+  type PluginFunction<
+    DocType,
+    M = Model<DocType, any, any, any>,
+    TInstanceMethods = {},
+    TQueryHelpers = {},
+    TVirtuals = {},
+    TStaticMethods = {}> = (schema: Schema<DocType, M, TInstanceMethods, TQueryHelpers, TVirtuals, TStaticMethods>, opts?: any) => void;
+
+  export class Schema<
+    EnforcedDocType = any,
+    M = Model<EnforcedDocType, any, any, any>,
+    TInstanceMethods = {},
+    TQueryHelpers = {},
+    TVirtuals = {},
     TStaticMethods = {},
     TPathTypeKey extends TypeKeyBaseType = DefaultTypeKey,
     DocType extends ObtainDocumentType<DocType, EnforcedDocType, TPathTypeKey> = ObtainDocumentType<any, EnforcedDocType, TPathTypeKey>>
@@ -241,7 +252,7 @@ declare module 'mongoose' {
     pathType(path: string): string;
 
     /** Registers a plugin for this schema. */
-    plugin<PFunc extends PluginFunction<DocType>, POptions extends Parameters<PFunc>[1] = Parameters<PFunc>[1]>(fn: PFunc, opts?: POptions): this;
+    plugin<PFunc extends PluginFunction<DocType, M, TInstanceMethods, TQueryHelpers, TVirtuals, TStaticMethods>, POptions extends Parameters<PFunc>[1] = Parameters<PFunc>[1]>(fn: PFunc, opts?: POptions): this;
 
     /** Defines a post hook for the model. */
     post<T = HydratedDocument<DocType, TInstanceMethods>>(method: MongooseDocumentMiddleware | MongooseDocumentMiddleware[] | RegExp, fn: PostMiddlewareFunction<T, T>): this;
@@ -294,15 +305,16 @@ declare module 'mongoose' {
     set<K extends keyof SchemaOptions>(key: K, value: SchemaOptions[K], _tags?: any): this;
 
     /** Adds static "class" methods to Models compiled from this schema. */
+    static<K extends keyof TStaticMethods>(name: K, fn: TStaticMethods[K]): this;
+    static(obj: { [F in keyof TStaticMethods]: TStaticMethods[F] } & { [name: string]: (this: M, ...args: any[]) => any }): this;
     static(name: string, fn: (this: M, ...args: any[]) => any): this;
-    static(obj: { [name: string]: (this: M, ...args: any[]) => any }): this;
 
     /** Object of currently defined statics on this schema. */
-    statics: { [name: string]: (this: M, ...args: any[]) => any };
+    statics: { [F in keyof TStaticMethods]: TStaticMethods[F] } & { [name: string]: (this: M, ...args: any[]) => any };
 
     /** Creates a virtual type with the given name. */
     virtual<T = HydratedDocument<DocType, TInstanceMethods>>(
-      name: string,
+      name: keyof TVirtuals | string,
       options?: VirtualTypeOptions<T, DocType>
     ): VirtualType<T>;
 

package/types/models.d.ts

@@ -144,9 +144,9 @@ declare module 'mongoose' {
      * if you use `create()`) because with `bulkWrite()` there is only one network
      * round trip to the MongoDB server.
      */
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T extends {} ? T : any>>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
 
     /**
      * Sends multiple `save()` calls in a single `bulkWrite()`. This is faster than