mongoose 6.5.3 → 6.5.4

package/.mocharc.yml

@@ -0,0 +1,2 @@
+reporter: spec # better to identify failing / slow tests than "dot"
+ui: bdd # explicitly setting, even though it is mocha default

package/lib/aggregate.js

@@ -1104,12 +1104,13 @@ function isOperator(obj) {
   return k.length === 1 && k[0][0] === '$';
 }
 
-/*!
+/**
  * Adds the appropriate `$match` pipeline step to the top of an aggregate's
  * pipeline, should it's model is a non-root discriminator type. This is
  * analogous to the `prepareDiscriminatorCriteria` function in `lib/query.js`.
  *
  * @param {Aggregate} aggregate Aggregate to prepare
+ * @api private
  */
 
 Aggregate._prepareDiscriminatorPipeline = prepareDiscriminatorPipeline;

package/lib/cast/boolean.js

@@ -2,7 +2,7 @@
 
 const CastError = require('../error/cast');
 
-/*!
+/**
  * Given a value, cast it to a boolean, or throw a `CastError` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast/number.js

@@ -2,7 +2,7 @@
 
 const assert = require('assert');
 
-/*!
+/**
  * Given a value, cast it to a number, or throw an `Error` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast/string.js

@@ -2,7 +2,7 @@
 
 const CastError = require('../error/cast');
 
-/*!
+/**
  * Given a value, cast it to a string, or throw a `CastError` if the value
  * cannot be casted. `null` and `undefined` are considered valid.
  *

package/lib/cast.js

@@ -25,6 +25,9 @@ const ALLOWED_GEOWITHIN_GEOJSON_TYPES = ['Polygon', 'MultiPolygon'];
  * @param {Schema} schema
  * @param {Object} obj Object to cast
  * @param {Object} [options] the query options
+ * @param {Boolean|"throw"} [options.strict] Wheter to enable all strict options
+ * @param {Boolean|"throw"} [options.strictQuery] Enable strict Queries
+ * @param {Boolean} [options.upsert]
  * @param {Query} [context] passed to setters
  * @api private
  */

package/lib/connection.js

@@ -26,7 +26,7 @@ const processConnectionOptions = require('./helpers/processConnectionOptions');
 const arrayAtomicsSymbol = require('./helpers/symbols').arrayAtomicsSymbol;
 const sessionNewDocuments = require('./helpers/symbols').sessionNewDocuments;
 
-/*!
+/**
  * A list of authentication mechanisms that don't require a password for authentication.
  * This is used by the authMechanismDoesNotRequirePassword method.
  *
@@ -1230,6 +1230,14 @@ Connection.prototype.model = function(name, schema, collection, options) {
     return sub;
   }
 
+  if (arguments.length === 1) {
+    model = this.models[name];
+    if (!model) {
+      throw new MongooseError.MissingSchemaError(name);
+    }
+    return model;
+  }
+
   if (!model) {
     throw new MongooseError.MissingSchemaError(name);
   }

package/lib/cursor/AggregationCursor.js

@@ -71,8 +71,12 @@ function _init(model, c, agg) {
   }
 }
 
-/*!
+/**
  * Necessary to satisfy the Readable API
+ * @method _read
+ * @memberOf AggregationCursor
+ * @instance
+ * @api private
  */
 
 AggregationCursor.prototype._read = function() {
@@ -147,8 +151,12 @@ Object.defineProperty(AggregationCursor.prototype, 'map', {
   writable: true
 });
 
-/*!
+/**
  * Marks this cursor as errored
+ * @method _markError
+ * @instance
+ * @memberOf AggregationCursor
+ * @api private
  */
 
 AggregationCursor.prototype._markError = function(error) {
@@ -324,9 +332,12 @@ function _waitForCursor(ctx, cb) {
   });
 }
 
-/*!
+/**
  * Get the next doc from the underlying cursor and mongooseify it
  * (populate, etc.)
+ * @param {Any} ctx
+ * @param {Function} cb
+ * @api private
  */
 
 function _next(ctx, cb) {

package/lib/cursor/QueryCursor.js

@@ -85,8 +85,12 @@ function QueryCursor(query, options) {
 
 util.inherits(QueryCursor, Readable);
 
-/*!
+/**
  * Necessary to satisfy the Readable API
+ * @method _read
+ * @memberOf QueryCursor
+ * @instance
+ * @api private
  */
 
 QueryCursor.prototype._read = function() {
@@ -152,8 +156,12 @@ Object.defineProperty(QueryCursor.prototype, 'map', {
   writable: true
 });
 
-/*!
+/**
  * Marks this cursor as errored
+ * @method _markError
+ * @memberOf QueryCursor
+ * @instance
+ * @api private
  */
 
 QueryCursor.prototype._markError = function(error) {
@@ -340,9 +348,12 @@ function _transformForAsyncIterator(doc) {
   return doc == null ? { done: true } : { value: doc, done: false };
 }
 
-/*!
+/**
  * Get the next doc from the underlying cursor and mongooseify it
  * (populate, etc.)
+ * @param {Any} ctx
+ * @param {Function} cb
+ * @api private
  */
 
 function _next(ctx, cb) {

package/lib/document.js

@@ -696,12 +696,15 @@ Document.prototype.$__init = function(doc, opts) {
   return this;
 };
 
-/*!
+/**
  * Init helper.
  *
  * @param {Object} self document instance
  * @param {Object} obj raw mongodb doc
  * @param {Object} doc object we are initializing
+ * @param {Object} [opts] Optional Options
+ * @param {Boolean} [opts.setters] Call `applySetters` instead of `cast`
+ * @param {String} [prefix] Prefix to add to each path
  * @api private
  */
 
@@ -3815,11 +3818,12 @@ Document.prototype.toObject = function(options) {
   return this.$toObject(options);
 };
 
-/*!
+/**
  * Minimizes an object, removing undefined values and empty objects
  *
  * @param {Object} object to minimize
  * @return {Object}
+ * @api private
  */
 
 function minimize(obj) {
@@ -3925,12 +3929,14 @@ function applyVirtuals(self, json, options, toObjectOptions) {
 }
 
 
-/*!
+/**
  * Applies virtuals properties to `json`.
  *
  * @param {Document} self
  * @param {Object} json
+ * @param {Object} [options]
  * @return {Object} `json`
+ * @api private
  */
 
 function applyGetters(self, json, options) {
@@ -3980,12 +3986,13 @@ function applyGetters(self, json, options) {
   return json;
 }
 
-/*!
+/**
  * Applies schema type transforms to `json`.
  *
  * @param {Document} self
  * @param {Object} json
  * @return {Object} `json`
+ * @api private
  */
 
 function applySchemaTypeTransforms(self, json) {
@@ -4158,10 +4165,7 @@ Document.prototype.inspect = function(options) {
 };
 
 if (inspect.custom) {
-  /*!
-  * Avoid Node deprecation warning DEP0079
-  */
-
+  // Avoid Node deprecation warning DEP0079
   Document.prototype[inspect.custom] = Document.prototype.inspect;
 }
 
@@ -4417,8 +4421,13 @@ Document.prototype.$populated = Document.prototype.populated;
  *     doc.$assertPopulated('author'); // does not throw
  *     doc.$assertPopulated('other path'); // throws an error
  *
+ *     // Manually populate and assert in one call. The following does
+ *     // `doc.$set({ likes })` before asserting.
+ *     doc.$assertPopulated('likes', { likes });
  *
- * @param {String|String[]} paths
+ *
+ * @param {String|String[]} path path or array of paths to check. `$assertPopulated` throws if any of the given paths is not populated.
+ * @param {Object} [values] optional values to `$set()`. Convenient if you want to manually populate a path and assert that the path was populated in 1 call.
  * @return {Document} this
  * @memberOf Document
  * @method $assertPopulated
@@ -4426,14 +4435,18 @@ Document.prototype.$populated = Document.prototype.populated;
  * @api public
  */
 
-Document.prototype.$assertPopulated = function $assertPopulated(paths) {
-  if (Array.isArray(paths)) {
-    paths.forEach(path => this.$assertPopulated(path));
+Document.prototype.$assertPopulated = function $assertPopulated(path, values) {
+  if (Array.isArray(path)) {
+    path.forEach(p => this.$assertPopulated(p, values));
     return this;
   }
 
-  if (!this.$populated(paths)) {
-    throw new MongooseError(`Expected path "${paths}" to be populated`);
+  if (arguments.length > 1) {
+    this.$set(values);
+  }
+
+  if (!this.$populated(path)) {
+    throw new MongooseError(`Expected path "${path}" to be populated`);
   }
 
   return this;

package/lib/drivers/browser/objectid.js

@@ -9,8 +9,9 @@
 
 const ObjectId = require('bson').ObjectID;
 
-/*!
+/**
  * Getter for convenience with populate, see gh-6115
+ * @api private
  */
 
 Object.defineProperty(ObjectId.prototype, '_id', {

package/lib/drivers/node-mongodb-native/ReadPreference.js

@@ -7,7 +7,7 @@
 const mongodb = require('mongodb');
 const ReadPref = mongodb.ReadPreference;
 
-/*!
+/**
  * Converts arguments to ReadPrefs the driver
  * can understand.
  *

package/lib/drivers/node-mongodb-native/collection.js

@@ -66,8 +66,10 @@ NativeCollection.prototype.onClose = function(force) {
 
 const syncCollectionMethods = { watch: true, find: true, aggregate: true };
 
-/*!
+/**
  * Copy the collection methods and make them subject to queues
+ * @param {Number|String} I
+ * @api private
  */
 
 function iter(i) {
@@ -296,8 +298,10 @@ NativeCollection.prototype.$format = function(arg, color, shell) {
   return format(arg, false, color, shell);
 };
 
-/*!
+/**
  * Debug print helper
+ * @param {Any} representation
+ * @api private
  */
 
 function inspectable(representation) {

package/lib/error/browserMissingSchema.js

@@ -8,7 +8,7 @@ const MongooseError = require('./');
 
 
 class MissingSchemaError extends MongooseError {
-  /*!
+  /**
    * MissingSchema Error constructor.
    */
   constructor() {

package/lib/error/cast.js

@@ -56,9 +56,10 @@ class CastError extends MongooseError {
     this.valueType = getValueType(value);
   }
 
-  /*!
+  /**
    * ignore
    * @param {Readonly<CastError>} other
+   * @api private
    */
   copy(other) {
     this.messageFormat = other.messageFormat;

package/lib/error/divergentArray.js

@@ -8,9 +8,10 @@
 const MongooseError = require('./');
 
 class DivergentArrayError extends MongooseError {
-  /*!
+  /**
    * DivergentArrayError constructor.
    * @param {Array<String>} paths
+   * @api private
    */
   constructor(paths) {
     const msg = 'For your own good, using `document.save()` to update an array '

package/lib/error/missingSchema.js

@@ -8,9 +8,10 @@
 const MongooseError = require('./');
 
 class MissingSchemaError extends MongooseError {
-  /*!
+  /**
    * MissingSchema Error constructor.
    * @param {String} name
+   * @api private
    */
   constructor(name) {
     const msg = 'Schema hasn\'t been registered for model "' + name + '".\n'

package/lib/error/notFound.js

@@ -8,8 +8,9 @@ const MongooseError = require('./');
 const util = require('util');
 
 class DocumentNotFoundError extends MongooseError {
-  /*!
+  /**
    * OverwriteModel Error constructor.
+   * @api private
    */
   constructor(filter, model, numAffected, result) {
     let msg;

package/lib/error/overwriteModel.js

@@ -9,9 +9,10 @@ const MongooseError = require('./');
 
 
 class OverwriteModelError extends MongooseError {
-  /*!
+  /**
    * OverwriteModel Error constructor.
    * @param {String} name
+   * @api private
    */
   constructor(name) {
     super('Cannot overwrite `' + name + '` model once compiled.');

package/lib/error/validation.js

@@ -41,15 +41,19 @@ class ValidationError extends MongooseError {
     return this.name + ': ' + _generateMessage(this);
   }
 
-  /*!
+  /**
    * inspect helper
+   * @api private
    */
   inspect() {
     return Object.assign(new Error(this.message), this);
   }
 
-  /*!
+  /**
   * add message
+  * @param {String} path
+  * @param {String|Error} error
+  * @api private
   */
   addError(path, error) {
     if (error instanceof ValidationError) {
@@ -68,16 +72,14 @@ class ValidationError extends MongooseError {
 
 
 if (util.inspect.custom) {
-  /*!
-  * Avoid Node deprecation warning DEP0079
-  */
-
+  // Avoid Node deprecation warning DEP0079
   ValidationError.prototype[util.inspect.custom] = ValidationError.prototype.inspect;
 }
 
-/*!
+/**
  * Helper for JSON.stringify
  * Ensure `name` and `message` show up in toJSON output re: gh-9847
+ * @api private
  */
 Object.defineProperty(ValidationError.prototype, 'toJSON', {
   enumerable: false,

package/lib/error/validator.js

@@ -31,16 +31,18 @@ class ValidatorError extends MongooseError {
     this.reason = properties.reason;
   }
 
-  /*!
+  /**
    * toString helper
    * TODO remove? This defaults to `${this.name}: ${this.message}`
+   * @api private
    */
   toString() {
     return this.message;
   }
 
-  /*!
+  /**
    * Ensure `name` and `message` show up in toJSON output re: gh-9296
+   * @api private
    */
 
   toJSON() {
@@ -53,9 +55,10 @@ Object.defineProperty(ValidatorError.prototype, 'name', {
   value: 'ValidatorError'
 });
 
-/*!
+/**
  * The object used to define this validator. Not enumerable to hide
  * it from `require('util').inspect()` output re: gh-3925
+ * @api private
  */
 
 Object.defineProperty(ValidatorError.prototype, 'properties', {
@@ -67,8 +70,9 @@ Object.defineProperty(ValidatorError.prototype, 'properties', {
 // Exposed for testing
 ValidatorError.prototype.formatMessage = formatMessage;
 
-/*!
+/**
  * Formats error messages
+ * @api private
  */
 
 function formatMessage(msg, properties) {

package/lib/helpers/clone.js

@@ -12,7 +12,7 @@ const trustedSymbol = require('./query/trusted').trustedSymbol;
 const utils = require('../utils');
 
 
-/*!
+/**
  * Object clone with Mongoose natives support.
  *
  * 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.

package/lib/helpers/discriminator/getConstructor.js

@@ -2,8 +2,9 @@
 
 const getDiscriminatorByValue = require('./getDiscriminatorByValue');
 
-/*!
+/**
  * Find the correct constructor, taking into account discriminators
+ * @api private
  */
 
 module.exports = function getConstructor(Constructor, value) {

package/lib/helpers/discriminator/getDiscriminatorByValue.js

@@ -2,12 +2,13 @@
 
 const areDiscriminatorValuesEqual = require('./areDiscriminatorValuesEqual');
 
-/*!
-* returns discriminator by discriminatorMapping.value
-*
-* @param {Model} model
-* @param {string} value
-*/
+/**
+ * returns discriminator by discriminatorMapping.value
+ *
+ * @param {Object} discriminators
+ * @param {string} value
+ * @api private
+ */
 
 module.exports = function getDiscriminatorByValue(discriminators, value) {
   if (discriminators == null) {

package/lib/helpers/discriminator/getSchemaDiscriminatorByValue.js

@@ -2,12 +2,13 @@
 
 const areDiscriminatorValuesEqual = require('./areDiscriminatorValuesEqual');
 
-/*!
-* returns discriminator by discriminatorMapping.value
-*
-* @param {Schema} schema
-* @param {string} value
-*/
+/**
+ * returns discriminator by discriminatorMapping.value
+ *
+ * @param {Schema} schema
+ * @param {string} value
+ * @api private
+ */
 
 module.exports = function getSchemaDiscriminatorByValue(schema, value) {
   if (schema == null || schema.discriminators == null) {

package/lib/helpers/document/compile.js

@@ -24,8 +24,13 @@ const _isEmptyOptions = Object.freeze({
   transform: false
 });
 
-/*!
+/**
  * Compiles schemas.
+ * @param {Object} tree
+ * @param {Any} proto
+ * @param {String} prefix
+ * @param {Object} options
+ * @api private
  */
 
 function compile(tree, proto, prefix, options) {
@@ -44,8 +49,15 @@ function compile(tree, proto, prefix, options) {
   }
 }
 
-/*!
+/**
  * Defines the accessor named prop on the incoming prototype.
+ * @param {Object} options
+ * @param {String} options.prop
+ * @param {Boolean} options.subprops
+ * @param {Any} options.prototype
+ * @param {String} [options.prefix]
+ * @param {Object} options.options
+ * @api private
  */
 
 function defineKey({ prop, subprops, prototype, prefix, options }) {

package/lib/helpers/document/getEmbeddedDiscriminatorPath.js

@@ -3,9 +3,13 @@
 const get = require('../get');
 const getSchemaDiscriminatorByValue = require('../discriminator/getSchemaDiscriminatorByValue');
 
-/*!
+/**
  * Like `schema.path()`, except with a document, because impossible to
  * determine path type without knowing the embedded discriminator key.
+ * @param {Document} doc
+ * @param {String} path
+ * @param {Object} [options]
+ * @api private
  */
 
 module.exports = function getEmbeddedDiscriminatorPath(doc, path, options) {

package/lib/helpers/get.js

@@ -1,8 +1,9 @@
 'use strict';
 
-/*!
+/**
  * Simplified lodash.get to work around the annoying null quirk. See:
  * https://github.com/lodash/lodash/issues/3659
+ * @api private
  */
 
 module.exports = function get(obj, path, def) {

package/lib/helpers/getConstructorName.js

@@ -1,7 +1,8 @@
 'use strict';
 
-/*!
+/**
  * If `val` is an object, returns constructor name, if possible. Otherwise returns undefined.
+ * @api private
  */
 
 module.exports = function getConstructorName(val) {

package/lib/helpers/isBsonType.js

@@ -1,7 +1,8 @@
 'use strict';
 
-/*!
+/**
  * Get the bson type, if it exists
+ * @api private
  */
 
 function isBsonType(obj, typename) {

package/lib/helpers/isMongooseObject.js

@@ -1,12 +1,12 @@
 'use strict';
 
 const isMongooseArray = require('../types/array/isMongooseArray').isMongooseArray;
-/*!
+/**
  * Returns if `v` is a mongoose object that has a `toObject()` method we can use.
  *
  * This is for compatibility with libs like Date.js which do foolish things to Natives.
  *
- * @param {any} v
+ * @param {Any} v
  * @api private
  */
 

package/lib/helpers/isObject.js

@@ -1,6 +1,6 @@
 'use strict';
 
-/*!
+/**
  * Determines if `arg` is an object.
  *
  * @param {Object|Array|String|Function|RegExp|any} arg

package/lib/helpers/isSimpleValidator.js

@@ -1,6 +1,6 @@
 'use strict';
 
-/*!
+/**
  * Determines if `arg` is a flat object.
  *
  * @param {Object|Array|String|Function|RegExp|any} arg