mongoose 6.5.3 → 6.5.4

package/lib/queryhelpers.js

@@ -12,7 +12,7 @@ const getDiscriminatorByValue =
 const isDefiningProjection = require('./helpers/projection/isDefiningProjection');
 const clone = require('./helpers/clone');
 
-/*!
+/**
  * Prepare a set of path options for query population.
  *
  * @param {Query} query
@@ -38,7 +38,7 @@ exports.preparePopulationOptions = function preparePopulationOptions(query, opti
   return pop;
 };
 
-/*!
+/**
  * Prepare a set of path options for query population. This is the MongooseQuery
  * version
  *
@@ -82,7 +82,7 @@ exports.preparePopulationOptionsMQ = function preparePopulationOptionsMQ(query,
   return pop;
 };
 
-/*!
+/**
  * If the document is a mapped discriminator type, it returns a model instance for that type, otherwise,
  * it returns an instance of the given model.
  *
@@ -321,7 +321,7 @@ exports.applyPaths = function applyPaths(fields, schema) {
   }
 };
 
-/*!
+/**
  * Set each path query option to lean
  *
  * @param {Object} option

package/lib/schema/SubdocumentPath.js

@@ -107,7 +107,7 @@ function _createConstructor(schema, baseClass) {
   return _embedded;
 }
 
-/*!
+/**
  * Special case for when users use a common location schema to represent
  * locations for use with $geoWithin.
  * https://docs.mongodb.org/manual/reference/operator/query/geoWithin/

package/lib/schema/array.js

@@ -448,7 +448,7 @@ SchemaArray.prototype._castForPopulate = function _castForPopulate(value, doc) {
 SchemaArray.prototype.$toObject = SchemaArray.prototype.toObject;
 
 /*!
- * Ignore
+ * ignore
  */
 
 SchemaArray.prototype.discriminator = function(name, schema) {

package/lib/schema/date.js

@@ -355,9 +355,10 @@ SchemaDate.prototype.cast = function(value) {
   }
 };
 
-/*!
+/**
  * Date Query casting.
  *
+ * @param {Any} val
  * @api private
  */
 

package/lib/schema/documentarray.js

@@ -123,7 +123,7 @@ DocumentArrayPath.prototype.constructor = DocumentArrayPath;
 DocumentArrayPath.prototype.OptionsConstructor = SchemaDocumentArrayOptions;
 
 /*!
- * Ignore
+ * ignore
  */
 
 function _createConstructor(schema, options, baseClass) {
@@ -545,13 +545,14 @@ DocumentArrayPath.prototype.applyGetters = function(value, scope) {
   return SchemaType.prototype.applyGetters.call(this, value, scope);
 };
 
-/*!
+/**
  * Scopes paths selected in a query to this array.
  * Necessary for proper default application of subdocument values.
  *
  * @param {DocumentArrayPath} array the array to scope `fields` paths
  * @param {Object|undefined} fields the root fields selected in the query
  * @param {Boolean|undefined} init if we are being created part of a query result
+ * @api private
  */
 
 function scopePaths(array, fields, init) {

package/lib/schema/operators/helpers.js

@@ -7,14 +7,14 @@
 const SchemaNumber = require('../number');
 
 /*!
- * @ignore
+ * ignore
  */
 
 exports.castToNumber = castToNumber;
 exports.castArraysOfNumbers = castArraysOfNumbers;
 
 /*!
- * @ignore
+ * ignore
  */
 
 function castToNumber(val) {

package/lib/schema/operators/text.js

@@ -4,7 +4,7 @@ const CastError = require('../../error/cast');
 const castBoolean = require('../../cast/boolean');
 const castString = require('../../cast/string');
 
-/*!
+/**
  * Casts val to an object suitable for `$text`. Throws an error if the object
  * can't be casted.
  *

package/lib/schema.js

@@ -165,8 +165,9 @@ function Schema(obj, options) {
   this.setupTimestamp(this.options.timestamps);
 }
 
-/*!
+/**
  * Create virtual properties with alias field
+ * @api private
  */
 function aliasFields(schema, paths) {
   paths = paths || Object.keys(schema.paths);
@@ -1482,8 +1483,11 @@ Schema.prototype.setupTimestamp = function(timestamps) {
   return setupTimestamps(this, timestamps);
 };
 
-/*!
+/**
  * ignore. Deprecated re: #6405
+ * @param {Any} self
+ * @param {String} path
+ * @api private
  */
 
 function getPositionalPathType(self, path) {
@@ -2427,9 +2431,13 @@ function isArrayFilter(piece) {
   return piece.startsWith('$[') && piece.endsWith(']');
 }
 
-/*!
+/**
  * Called by `compile()` _right before_ compiling. Good for making any changes to
  * the schema that should respect options set by plugins, like `id`
+ * @method _preCompile
+ * @memberOf Schema
+ * @instance
+ * @api private
  */
 
 Schema.prototype._preCompile = function _preCompile() {

package/lib/schematype.js

@@ -124,8 +124,11 @@ function SchemaType(path, options, instance) {
   });
 }
 
-/*!
+/**
  * The class that Mongoose uses internally to instantiate this SchemaType's `options` property.
+ * @memberOf SchemaType
+ * @instance
+ * @api private
  */
 
 SchemaType.prototype.OptionsConstructor = SchemaTypeOptions;
@@ -1144,9 +1147,15 @@ SchemaType.prototype.getDefault = function(scope, init, options) {
   return ret;
 };
 
-/*!
+/**
  * Applies setters without casting
  *
+ * @param {Any} value
+ * @param {Any} scope
+ * @param {Boolean} init
+ * @param {Any} priorVal
+ * @param {Object} [options]
+ * @instance
  * @api private
  */
 
@@ -1547,9 +1556,10 @@ function handleArray(val) {
   });
 }
 
-/*!
+/**
  * Just like handleArray, except also allows `[]` because surprisingly
  * `$in: [1, []]` works fine
+ * @api private
  */
 
 function handle$in(val) {
@@ -1579,8 +1589,11 @@ SchemaType.prototype.$conditionalHandlers = {
   $type: $type
 };
 
-/*!
+/**
  * Wraps `castForQuery` to handle context
+ * @param {Object} params
+ * @instance
+ * @api private
  */
 
 SchemaType.prototype.castForQueryWrapper = function(params) {

package/lib/statemachine.js

@@ -7,7 +7,7 @@
 
 const utils = require('./utils'); // eslint-disable-line no-unused-vars
 
-/*!
+/**
  * StateMachine represents a minimal `interface` for the
  * constructors it builds via StateMachine.ctor(...).
  *
@@ -17,7 +17,7 @@ const utils = require('./utils'); // eslint-disable-line no-unused-vars
 const StateMachine = module.exports = exports = function StateMachine() {
 };
 
-/*!
+/**
  * StateMachine.ctor('state1', 'state2', ...)
  * A factory method for subclassing StateMachine.
  * The arguments are a list of states. For each state,
@@ -28,7 +28,7 @@ const StateMachine = module.exports = exports = function StateMachine() {
  * @param {String} state
  * @param {String} [state]
  * @return {Function} subclass constructor
- * @private
+ * @api private
  */
 
 StateMachine.ctor = function() {
@@ -54,7 +54,7 @@ StateMachine.ctor = function() {
   return ctor;
 };
 
-/*!
+/**
  * This function is wrapped by the state change functions:
  *
  * - `require(path)`
@@ -105,8 +105,9 @@ StateMachine.prototype.clearPath = function clearPath(path) {
   delete this.states[state][path];
 };
 
-/*!
+/**
  * Gets the paths for the given state, or empty object `{}` if none.
+ * @api private
  */
 
 StateMachine.prototype.getStatePaths = function getStatePaths(state) {
@@ -116,12 +117,12 @@ StateMachine.prototype.getStatePaths = function getStatePaths(state) {
   return {};
 };
 
-/*!
+/**
  * Checks to see if at least one path is in the states passed in via `arguments`
  * e.g., this.some('required', 'inited')
  *
  * @param {String} state that we want to check for.
- * @private
+ * @api private
  */
 
 StateMachine.prototype.some = function some() {
@@ -135,7 +136,7 @@ StateMachine.prototype.some = function some() {
   });
 };
 
-/*!
+/**
  * This function builds the functions that get assigned to `forEach` and `map`,
  * since both of those methods share a lot of the same logic.
  *
@@ -166,7 +167,7 @@ StateMachine.prototype._iter = function _iter(iterMethod) {
   };
 };
 
-/*!
+/**
  * Iterates over the paths that belong to one of the parameter states.
  *
  * The function profile can look like:
@@ -177,7 +178,7 @@ StateMachine.prototype._iter = function _iter(iterMethod) {
  * @param {String} [state]
  * @param {String} [state]
  * @param {Function} callback
- * @private
+ * @api private
  */
 
 StateMachine.prototype.forEach = function forEach() {
@@ -185,7 +186,7 @@ StateMachine.prototype.forEach = function forEach() {
   return this.forEach.apply(this, arguments);
 };
 
-/*!
+/**
  * Maps over the paths that belong to one of the parameter states.
  *
  * The function profile can look like:
@@ -197,7 +198,7 @@ StateMachine.prototype.forEach = function forEach() {
  * @param {String} [state]
  * @param {Function} callback
  * @return {Array}
- * @private
+ * @api private
  */
 
 StateMachine.prototype.map = function map() {

package/lib/types/ArraySubdocument.js

@@ -10,12 +10,14 @@ const utils = require('../utils');
 
 const documentArrayParent = require('../helpers/symbols').documentArrayParent;
 
-/*!
+/**
  * A constructor.
  *
  * @param {Object} obj js object returned from the db
  * @param {MongooseDocumentArray} parentArr the parent array of this document
  * @param {Boolean} skipId
+ * @param {Object} fields
+ * @param {Number} index
  * @inherits Document
  * @api private
  */
@@ -125,9 +127,13 @@ ArraySubdocument.prototype.$__fullPath = function(path, skipIndex) {
     this.$__.fullPath + '.' + this.__index;
 };
 
-/*!
+/**
  * Given a path relative to this document, return the path relative
  * to the top-level document.
+ * @method $__pathRelativeToParent
+ * @memberOf ArraySubdocument
+ * @instance
+ * @api private
  */
 
 ArraySubdocument.prototype.$__pathRelativeToParent = function(path, skipIndex) {
@@ -143,8 +149,12 @@ ArraySubdocument.prototype.$__pathRelativeToParent = function(path, skipIndex) {
   return this.__parentArray.$path() + '.' + this.__index + '.' + path;
 };
 
-/*!
+/**
  * Returns this sub-documents parent document.
+ * @method $parent
+ * @memberOf ArraySubdocument
+ * @instance
+ * @api public
  */
 
 ArraySubdocument.prototype.$parent = function() {

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

@@ -212,8 +212,9 @@ const methods = {
     return ret;
   },
 
-  /*!
+  /**
    * Wraps [`Array#shift`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/unshift) with proper change tracking.
+   * @api private
    */
 
   shift() {
@@ -224,8 +225,9 @@ const methods = {
     return ret;
   },
 
-  /*!
+  /**
    * Wraps [`Array#splice`](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice) with proper change tracking and casting.
+   * @api private
    */
 
   splice() {
@@ -355,10 +357,12 @@ const methods = {
 
 module.exports = methods;
 
-/*!
+/**
  * If this is a document array, each element may contain single
  * populated paths, so we need to modify the top-level document's
  * populated cache. See gh-8247, gh-8265.
+ * @param {Array} arr
+ * @api private
  */
 
 function _updateParentPopulated(arr) {

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

@@ -805,6 +805,7 @@ const methods = {
     let ret;
     const arr = utils.isMongooseArray(this) ? this.__array : this;
 
+    this._markModified();
     _checkManualPopulation(this, Array.prototype.slice.call(arguments, 2));
 
     if (arguments.length) {

package/lib/types/map.js

@@ -295,9 +295,11 @@ Object.defineProperty(MongooseMap.prototype, '$__deferredCalls', {
   value: true
 });
 
-/*!
+/**
  * Since maps are stored as objects under the hood, keys must be strings
  * and can't contain any invalid characters
+ * @param {String} key
+ * @api private
  */
 
 function checkValidKey(key) {

package/lib/types/objectid.js

@@ -13,8 +13,9 @@
 const ObjectId = require('../driver').get().ObjectId;
 const objectIdSymbol = require('../helpers/symbols').objectIdSymbol;
 
-/*!
+/**
  * Getter for convenience with populate, see gh-6115
+ * @api private
  */
 
 Object.defineProperty(ObjectId.prototype, '_id', {
@@ -29,7 +30,6 @@ Object.defineProperty(ObjectId.prototype, '_id', {
  * Convenience `valueOf()` to allow comparing ObjectIds using double equals re: gh-7299
  */
 
-
 if (!ObjectId.prototype.hasOwnProperty('valueOf')) {
   ObjectId.prototype.valueOf = function objectIdValueOf() {
     return this.toString();

package/lib/types/subdocument.js

@@ -86,9 +86,15 @@ Subdocument.prototype.save = function(options, fn) {
   });
 };
 
-/*!
+/**
  * Given a path relative to this document, return the path relative
  * to the top-level document.
+ * @param {String} path
+ * @method $__fullPath
+ * @memberOf Subdocument
+ * @instance
+ * @returns {String}
+ * @api private
  */
 
 Subdocument.prototype.$__fullPath = function(path) {
@@ -101,9 +107,15 @@ Subdocument.prototype.$__fullPath = function(path) {
     this.$__.fullPath;
 };
 
-/*!
+/**
  * Given a path relative to this document, return the path relative
  * to the top-level document.
+ * @param {String} p
+ * @returns {String}
+ * @method $__pathRelativeToParent
+ * @memberOf Subdocument
+ * @instance
+ * @api private
  */
 
 Subdocument.prototype.$__pathRelativeToParent = function(p) {
@@ -317,8 +329,13 @@ Subdocument.prototype.parent = function() {
 
 Subdocument.prototype.$parent = Subdocument.prototype.parent;
 
-/*!
+/**
  * no-op for hooks
+ * @param {Function} cb
+ * @method $__remove
+ * @memberOf Subdocument
+ * @instance
+ * @api private
  */
 
 Subdocument.prototype.$__remove = function(cb) {
@@ -328,6 +345,14 @@ Subdocument.prototype.$__remove = function(cb) {
   return cb(null, this);
 };
 
+/**
+ * ignore
+ * @method $__removeFromParent
+ * @memberOf Subdocument
+ * @instance
+ * @api private
+ */
+
 Subdocument.prototype.$__removeFromParent = function() {
   this.$__parent.set(this.$basePath, null);
 };
@@ -379,14 +404,11 @@ Subdocument.prototype.inspect = function() {
 };
 
 if (util.inspect.custom) {
-  /*!
-  * Avoid Node deprecation warning DEP0079
-  */
-
+  // Avoid Node deprecation warning DEP0079
   Subdocument.prototype[util.inspect.custom] = Subdocument.prototype.inspect;
 }
 
-/*!
+/**
  * Registers remove event listeners for triggering
  * on subdocuments.
  *