mongoose 7.0.4 → 7.1.0

package/lib/query.js

@@ -26,6 +26,7 @@ const helpers = require('./queryhelpers');
 const immediate = require('./helpers/immediate');
 const isExclusive = require('./helpers/projection/isExclusive');
 const isInclusive = require('./helpers/projection/isInclusive');
+const isPathSelectedInclusive = require('./helpers/projection/isPathSelectedInclusive');
 const isSubpath = require('./helpers/projection/isSubpath');
 const mpath = require('mpath');
 const mquery = require('mquery');
@@ -67,7 +68,7 @@ const queryOptionMethods = new Set([
 /**
  * Query constructor used for building queries. You do not need
  * to instantiate a `Query` directly. Instead use Model functions like
- * [`Model.find()`](/docs/api/model.html#model_Model-find).
+ * [`Model.find()`](https://mongoosejs.com/docs/api/model.html#Model.find()).
  *
  * #### Example:
  *
@@ -812,7 +813,7 @@ Query.prototype.mod = function() {
  *
  * #### Note:
  *
- * As of Mongoose 3.7, `$geoWithin` is always used for queries. To change this behavior, see [Query.use$geoWithin](#query_Query-use%2524geoWithin).
+ * As of Mongoose 3.7, `$geoWithin` is always used for queries. To change this behavior, see [Query.use$geoWithin](https://mongoosejs.com/docs/api/query.html#Query.prototype.use$geoWithin).
  *
  * #### Note:
  *
@@ -999,7 +1000,7 @@ Query.prototype.projection = function(arg) {
 /**
  * Specifies which document fields to include or exclude (also known as the query "projection")
  *
- * When using string syntax, prefixing a path with `-` will flag that path as excluded. When a path does not have the `-` prefix, it is included. Lastly, if a path is prefixed with `+`, it forces inclusion of the path, which is useful for paths excluded at the [schema level](/docs/api/schematype.html#schematype_SchemaType-select).
+ * When using string syntax, prefixing a path with `-` will flag that path as excluded. When a path does not have the `-` prefix, it is included. Lastly, if a path is prefixed with `+`, it forces inclusion of the path, which is useful for paths excluded at the [schema level](https://mongoosejs.com/docs/api/schematype.html#SchemaType.prototype.select()).
  *
  * A projection _must_ be either inclusive or exclusive. In other words, you must
  * either list the fields to include (which excludes all others), or list the fields
@@ -1040,7 +1041,7 @@ Query.prototype.projection = function(arg) {
  * @instance
  * @param {Object|String|String[]} arg
  * @return {Query} this
- * @see SchemaType /docs/api/schematype.html
+ * @see SchemaType https://mongoosejs.com/docs/api/schematype.html
  * @api public
  */
 
@@ -1227,7 +1228,7 @@ Query.prototype.toString = function toString() {
 /**
  * Sets the [MongoDB session](https://www.mongodb.com/docs/manual/reference/server-sessions/)
  * associated with this query. Sessions are how you mark a query as part of a
- * [transaction](/docs/transactions.html).
+ * [transaction](https://mongoosejs.com/docs/transactions.html).
  *
  * Calling `session(null)` removes the session from this query.
  *
@@ -1240,8 +1241,8 @@ Query.prototype.toString = function toString() {
  * @memberOf Query
  * @instance
  * @param {ClientSession} [session] from `await conn.startSession()`
- * @see Connection.prototype.startSession() /docs/api/connection.html#connection_Connection-startSession
- * @see mongoose.startSession() /docs/api/mongoose.html#mongoose_Mongoose-startSession
+ * @see Connection.prototype.startSession() https://mongoosejs.com/docs/api/connection.html#Connection.prototype.startSession()
+ * @see mongoose.startSession() https://mongoosejs.com/docs/api/mongoose.html#Mongoose.prototype.startSession()
  * @return {Query} this
  * @api public
  */
@@ -1259,7 +1260,7 @@ Query.prototype.session = function session(v) {
  *
  * - `w`: Sets the specified number of `mongod` servers, or tag set of `mongod` servers, that must acknowledge this write before this write is considered successful.
  * - `j`: Boolean, set to `true` to request acknowledgement that this operation has been persisted to MongoDB's on-disk journal.
- * - `wtimeout`: If [`w > 1`](#query_Query-w), the maximum amount of time to wait for this write to propagate through the replica set before this operation fails. The default is `0`, which means no timeout.
+ * - `wtimeout`: If [`w > 1`](https://mongoosejs.com/docs/api/query.html#Query.prototype.w()), the maximum amount of time to wait for this write to propagate through the replica set before this operation fails. The default is `0`, which means no timeout.
  *
  * This option is only valid for operations that write to the database:
  *
@@ -1271,7 +1272,7 @@ Query.prototype.session = function session(v) {
  * - `updateOne()`
  * - `updateMany()`
  *
- * Defaults to the schema's [`writeConcern` option](/docs/guide.html#writeConcern)
+ * Defaults to the schema's [`writeConcern` option](https://mongoosejs.com/docs/guide.html#writeConcern)
  *
  * #### Example:
  *
@@ -1312,7 +1313,7 @@ Query.prototype.writeConcern = function writeConcern(val) {
  * - `updateOne()`
  * - `updateMany()`
  *
- * Defaults to the schema's [`writeConcern.w` option](/docs/guide.html#writeConcern)
+ * Defaults to the schema's [`writeConcern.w` option](https://mongoosejs.com/docs/guide.html#writeConcern)
  *
  * #### Example:
  *
@@ -1356,7 +1357,7 @@ Query.prototype.w = function w(val) {
  * - `updateOne()`
  * - `updateMany()`
  *
- * Defaults to the schema's [`writeConcern.j` option](/docs/guide.html#writeConcern)
+ * Defaults to the schema's [`writeConcern.j` option](https://mongoosejs.com/docs/guide.html#writeConcern)
  *
  * #### Example:
  *
@@ -1384,7 +1385,7 @@ Query.prototype.j = function j(val) {
 };
 
 /**
- * If [`w > 1`](#query_Query-w), the maximum amount of time to
+ * If [`w > 1`](https://mongoosejs.com/docs/api/query.html#Query.prototype.w()), the maximum amount of time to
  * wait for this write to propagate through the replica set before this
  * operation fails. The default is `0`, which means no timeout.
  *
@@ -1398,7 +1399,7 @@ Query.prototype.j = function j(val) {
  * - `updateOne()`
  * - `updateMany()`
  *
- * Defaults to the schema's [`writeConcern.wtimeout` option](/docs/guide.html#writeConcern)
+ * Defaults to the schema's [`writeConcern.wtimeout` option](https://mongoosejs.com/docs/guide.html#writeConcern)
  *
  * #### Example:
  *
@@ -1508,7 +1509,6 @@ Query.prototype.getOptions = function() {
  * The following options are only for `find()`:
  *
  * - [tailable](https://www.mongodb.com/docs/manual/core/tailable-cursors/)
- * - [sort](https://www.mongodb.com/docs/manual/reference/method/cursor.sort/)
  * - [limit](https://www.mongodb.com/docs/manual/reference/method/cursor.limit/)
  * - [skip](https://www.mongodb.com/docs/manual/reference/method/cursor.skip/)
  * - [allowDiskUse](https://www.mongodb.com/docs/manual/reference/method/cursor.allowDiskUse/)
@@ -1524,24 +1524,29 @@ Query.prototype.getOptions = function() {
  * - [timestamps](https://mongoosejs.com/docs/guide.html#timestamps): If `timestamps` is set in the schema, set this option to `false` to skip timestamps for that particular update. Has no effect if `timestamps` is not enabled in the schema options.
  * - overwriteDiscriminatorKey: allow setting the discriminator key in the update. Will use the correct discriminator schema if the update changes the discriminator key.
  *
- * The following options are only for `find()`, `findOne()`, `findById()`, `findOneAndUpdate()`, and `findByIdAndUpdate()`:
+ * The following options are only for `find()`, `findOne()`, `findById()`, `findOneAndUpdate()`, `findOneAndReplace()`, `findOneAndDelete()`, and `findByIdAndUpdate()`:
  *
- * - [lean](#query_Query-lean)
- * - [populate](/docs/populate.html)
- * - [projection](#query_Query-projection)
+ * - [lean](https://mongoosejs.com/docs/api/query.html#Query.prototype.lean())
+ * - [populate](https://mongoosejs.com/docs/populate.html)
+ * - [projection](https://mongoosejs.com/docs/api/query.html#Query.prototype.projection())
  * - sanitizeProjection
+ * - useBigInt64
  *
  * The following options are only for all operations **except** `updateOne()`, `updateMany()`, `deleteOne()`, and `deleteMany()`:
  *
  * - [maxTimeMS](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/)
  *
+ * The following options are for `find()`, `findOne()`, `findOneAndUpdate()`, `findOneAndRemove()`, `findOneAndDelete()`, `updateOne()`, and `deleteOne()`:
+ *
+ * - [sort](https://www.mongodb.com/docs/manual/reference/method/cursor.sort/)
+ *
  * The following options are for `findOneAndUpdate()` and `findOneAndRemove()`
  *
  * - rawResult
  *
  * The following options are for all operations:
  *
- * - [strict](/docs/guide.html#strict)
+ * - [strict](https://mongoosejs.com/docs/guide.html#strict)
  * - [collation](https://www.mongodb.com/docs/manual/reference/collation/)
  * - [session](https://www.mongodb.com/docs/manual/reference/server-sessions/)
  * - [explain](https://www.mongodb.com/docs/manual/reference/method/cursor.explain/)
@@ -1967,7 +1972,7 @@ Query.prototype._optionsForExec = function(model) {
  * Sets the lean option.
  *
  * Documents returned from queries with the `lean` option enabled are plain
- * javascript objects, not [Mongoose Documents](/docs/api/document.html). They have no
+ * javascript objects, not [Mongoose Documents](https://mongoosejs.com/docs/api/document.html). They have no
  * `save` method, getters/setters, virtuals, or other Mongoose features.
  *
  * #### Example:
@@ -1979,9 +1984,9 @@ Query.prototype._optionsForExec = function(model) {
  *     const docs = await Model.find().lean();
  *     docs[0] instanceof mongoose.Document; // false
  *
- * [Lean is great for high-performance, read-only cases](/docs/tutorials/lean.html),
+ * [Lean is great for high-performance, read-only cases](https://mongoosejs.com/docs/tutorials/lean.html),
  * especially when combined
- * with [cursors](/docs/queries.html#streaming).
+ * with [cursors](https://mongoosejs.com/docs/queries.html#streaming).
  *
  * If you need virtuals, getters/setters, or defaults with `lean()`, you need
  * to use a plugin. See:
@@ -2129,11 +2134,11 @@ Query.prototype._unsetCastError = function _unsetCastError() {
  * Getter/setter around the current mongoose-specific options for this query
  * Below are the current Mongoose-specific options.
  *
- * - `populate`: an array representing what paths will be populated. Should have one entry for each call to [`Query.prototype.populate()`](#query_Query-populate)
- * - `lean`: if truthy, Mongoose will not [hydrate](/docs/api/model.html#model_Model-hydrate) any documents that are returned from this query. See [`Query.prototype.lean()`](#query_Query-lean) for more information.
- * - `strict`: controls how Mongoose handles keys that aren't in the schema for updates. This option is `true` by default, which means Mongoose will silently strip any paths in the update that aren't in the schema. See the [`strict` mode docs](/docs/guide.html#strict) for more information.
- * - `strictQuery`: controls how Mongoose handles keys that aren't in the schema for the query `filter`. This option is `false` by default, which means Mongoose will allow `Model.find({ foo: 'bar' })` even if `foo` is not in the schema. See the [`strictQuery` docs](/docs/guide.html#strictQuery) for more information.
- * - `nearSphere`: use `$nearSphere` instead of `near()`. See the [`Query.prototype.nearSphere()` docs](#query_Query-nearSphere)
+ * - `populate`: an array representing what paths will be populated. Should have one entry for each call to [`Query.prototype.populate()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.populate())
+ * - `lean`: if truthy, Mongoose will not [hydrate](https://mongoosejs.com/docs/api/model.html#Model.hydrate()) any documents that are returned from this query. See [`Query.prototype.lean()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.lean()) for more information.
+ * - `strict`: controls how Mongoose handles keys that aren't in the schema for updates. This option is `true` by default, which means Mongoose will silently strip any paths in the update that aren't in the schema. See the [`strict` mode docs](https://mongoosejs.com/docs/guide.html#strict) for more information.
+ * - `strictQuery`: controls how Mongoose handles keys that aren't in the schema for the query `filter`. This option is `false` by default, which means Mongoose will allow `Model.find({ foo: 'bar' })` even if `foo` is not in the schema. See the [`strictQuery` docs](https://mongoosejs.com/docs/guide.html#strictQuery) for more information.
+ * - `nearSphere`: use `$nearSphere` instead of `near()`. See the [`Query.prototype.nearSphere()` docs](https://mongoosejs.com/docs/api/query.html#Query.prototype.nearSphere())
  *
  * Mongoose maintains a separate object for internal options because
  * Mongoose sends `Query.prototype.options` to the MongoDB server, and the
@@ -2268,7 +2273,7 @@ Query.prototype._find = async function _find() {
  * Find all documents that match `selector`. The result will be an array of documents.
  *
  * If there are too many documents in the result to fit in memory, use
- * [`Query.prototype.cursor()`](#query_Query-cursor)
+ * [`Query.prototype.cursor()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.cursor())
  *
  * #### Example:
  *
@@ -2509,10 +2514,10 @@ Query.prototype._findOne = async function _findOne() {
  *
  * @param {Object} [filter] mongodb selector
  * @param {Object} [projection] optional fields to return
- * @param {Object} [options] see [`setOptions()`](#query_Query-setOptions)
+ * @param {Object} [options] see [`setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
  * @return {Query} this
  * @see findOne https://www.mongodb.com/docs/manual/reference/method/db.collection.findOne/
- * @see Query.select #query_Query-select
+ * @see Query.select https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
  * @api public
  */
 
@@ -2626,8 +2631,8 @@ Query.prototype._estimatedDocumentCount = async function _estimatedDocumentCount
  * Specifies this query as a `count` query.
  *
  * This method is deprecated. If you want to count the number of documents in
- * a collection, e.g. `count({})`, use the [`estimatedDocumentCount()` function](#query_Query-estimatedDocumentCount)
- * instead. Otherwise, use the [`countDocuments()`](#query_Query-countDocuments) function instead.
+ * a collection, e.g. `count({})`, use the [`estimatedDocumentCount()` function](https://mongoosejs.com/docs/api/query.html#Query.prototype.estimatedDocumentCount())
+ * instead. Otherwise, use the [`countDocuments()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.countDocuments()) function instead.
  *
  * This function triggers the following middleware.
  *
@@ -2899,7 +2904,7 @@ Query.prototype.sort = function(arg) {
  *     res.deletedCount;
  *
  * @param {Object|Query} [filter] mongodb selector
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](#query_Query-setOptions)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
  * @return {Query} this
  * @see DeleteResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/DeleteResult.html
  * @see deleteOne https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteOne
@@ -2975,7 +2980,7 @@ Query.prototype._deleteOne = async function _deleteOne() {
  *     res.deletedCount;
  *
  * @param {Object|Query} [filter] mongodb selector
- * @param {Object} [options] optional see [`Query.prototype.setOptions()`](#query_Query-setOptions)
+ * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
  * @return {Query} this
  * @see DeleteResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/DeleteResult.html
  * @see deleteMany https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteMany
@@ -3106,7 +3111,7 @@ function prepareDiscriminatorCriteria(query) {
  * - `fields`: {Object|String} - Field selection. Equivalent to `.select(fields).findOneAndUpdate()`
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
+ * - `runValidators`: if true, runs [update validators](https://mongoosejs.com/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
  * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  *
@@ -3125,15 +3130,15 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Object} [options]
  * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean} [options.new=false] By default, `findOneAndUpdate()` returns the document as it was **before** `update` was applied. If you set `new: true`, `findOneAndUpdate()` will instead give you the object after `update` was applied.
- * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](#query_Query-lean) and [the Mongoose lean tutorial](/docs/tutorials/lean.html).
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.lean()) and [the Mongoose lean tutorial](https://mongoosejs.com/docs/tutorials/lean.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
- * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.returnOriginal=null] An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
- * @see Tutorial /docs/tutorials/findoneandupdate.html
+ * @see Tutorial https://mongoosejs.com/docs/tutorials/findoneandupdate.html
  * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @see ModifyResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html
  * @see findOneAndUpdate https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#findOneAndUpdate
@@ -3309,7 +3314,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
  * @param {Object} [conditions]
  * @param {Object} [options]
  * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @return {Query} this
  * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -3369,7 +3374,7 @@ Query.prototype.findOneAndRemove = function(conditions, options) {
  * @param {Object} [conditions]
  * @param {Object} [options]
  * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @return {Query} this
  * @see findAndModify command https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -3474,13 +3479,13 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
  * @param {Object} [replacement]
  * @param {Object} [options]
  * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.9/interfaces/ModifyResult.html)
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.new=false] By default, `findOneAndUpdate()` returns the document as it was **before** `update` was applied. If you set `new: true`, `findOneAndUpdate()` will instead give you the object after `update` was applied.
- * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](#query_Query-lean) and [the Mongoose lean tutorial](/docs/tutorials/lean.html).
- * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
+ * @param {Object} [options.lean] if truthy, mongoose will return the document as a plain JavaScript object rather than a mongoose document. See [`Query.lean()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.lean()) and [the Mongoose lean tutorial](https://mongoosejs.com/docs/tutorials/lean.html).
+ * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](https://mongoosejs.com/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
- * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Boolean} [options.returnOriginal=null] An alias for the `new` option. `returnOriginal: false` is equivalent to `new: true`.
  * @return {Query} this
  * @api public
@@ -3858,7 +3863,7 @@ Query.prototype.validate = async function validate(castedDoc, options, isOverwri
 /**
  * Execute an updateMany query
  *
- * @see Model.update #model_Model-update
+ * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @method _updateMany
  * @memberOf Query
  * @instance
@@ -3871,7 +3876,7 @@ Query.prototype._updateMany = async function _updateMany() {
 /**
  * Execute an updateOne query
  *
- * @see Model.update #model_Model-update
+ * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @method _updateOne
  * @memberOf Query
  * @instance
@@ -3884,7 +3889,7 @@ Query.prototype._updateOne = async function _updateOne() {
 /**
  * Execute a replaceOne query
  *
- * @see Model.replaceOne #model_Model-replaceOne
+ * @see Model.replaceOne https://mongoosejs.com/docs/api/model.html#Model.replaceOne()
  * @method _replaceOne
  * @memberOf Query
  * @instance
@@ -3917,11 +3922,11 @@ Query.prototype._replaceOne = async function _replaceOne() {
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
- * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
- * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](https://mongoosejs.com/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model-update
+ * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://www.mongodb.com/docs/manual/reference/method/db.collection.update/
  * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
@@ -3985,11 +3990,11 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
- * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
- * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](https://mongoosejs.com/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Note that this allows you to overwrite timestamps. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model-update
+ * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://www.mongodb.com/docs/manual/reference/method/db.collection.update/
  * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
@@ -4051,11 +4056,11 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
- * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](/docs/guide.html#writeConcern)
- * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
+ * @param {Object} [options.writeConcern=null] sets the [write concern](https://www.mongodb.com/docs/manual/reference/write-concern/) for replica sets. Overrides the [schema-level write concern](https://mongoosejs.com/docs/guide.html#writeConcern)
+ * @param {Boolean} [options.timestamps=null] If set to `false` and [schema-level timestamps](https://mongoosejs.com/docs/guide.html#timestamps) are enabled, skip timestamps for this update. Does nothing if schema-level timestamps are not set.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
- * @see Model.update #model_Model-update
+ * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see update https://www.mongodb.com/docs/manual/reference/method/db.collection.update/
  * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html
@@ -4265,6 +4270,17 @@ function _orFailError(err, query) {
   return err;
 }
 
+/**
+ * Wrapper function to call isPathSelectedInclusive on a query.
+ * @param {String} path
+ * @return {Boolean}
+ * @api public
+ */
+
+Query.prototype.isPathSelectedInclusive = function(path) {
+  return isPathSelectedInclusive(this._fields, path);
+};
+
 /**
  * Executes the query
  *
@@ -4500,7 +4516,7 @@ Query.prototype[Symbol.toStringTag] = function toString() {
 };
 
 /**
- * Add pre [middleware](/docs/middleware.html) to this query instance. Doesn't affect
+ * Add pre [middleware](https://mongoosejs.com/docs/middleware.html) to this query instance. Doesn't affect
  * other queries.
  *
  * #### Example:
@@ -4526,7 +4542,7 @@ Query.prototype.pre = function(fn) {
 };
 
 /**
- * Add post [middleware](/docs/middleware.html) to this query instance. Doesn't affect
+ * Add post [middleware](https://mongoosejs.com/docs/middleware.html) to this query instance. Doesn't affect
  * other queries.
  *
  * #### Example:
@@ -4645,14 +4661,14 @@ Query.prototype._castUpdate = function _castUpdate(obj, overwrite) {
  * @param {Object} [options] Options for the population query (sort, etc)
  * @param {String} [options.path=null] The path to populate.
  * @param {boolean} [options.retainNullValues=false] by default, Mongoose removes null and undefined values from populated arrays. Use this option to make `populate()` retain `null` and `undefined` array entries.
- * @param {boolean} [options.getters=false] if true, Mongoose will call any getters defined on the `localField`. By default, Mongoose gets the raw value of `localField`. For example, you would need to set this option to `true` if you wanted to [add a `lowercase` getter to your `localField`](/docs/schematypes.html#schematype-options).
+ * @param {boolean} [options.getters=false] if true, Mongoose will call any getters defined on the `localField`. By default, Mongoose gets the raw value of `localField`. For example, you would need to set this option to `true` if you wanted to [add a `lowercase` getter to your `localField`](https://mongoosejs.com/docs/schematypes.html#schematype-options).
  * @param {boolean} [options.clone=false] When you do `BlogPost.find().populate('author')`, blog posts with the same author will share 1 copy of an `author` doc. Enable this option to make Mongoose clone populated docs before assigning them.
  * @param {Object|Function} [options.match=null] Add an additional filter to the populate query. Can be a filter object containing [MongoDB query syntax](https://www.mongodb.com/docs/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 /docs/populate.html
- * @see Query#select #query_Query-select
- * @see Model.populate #model_Model-populate
+ * @see population https://mongoosejs.com/docs/populate.html
+ * @see Query#select https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
+ * @see Model.populate https://mongoosejs.com/docs/api/model.html#Model.populate()
  * @return {Query} this
  * @api public
  */
@@ -4920,7 +4936,7 @@ Query.prototype._applyPaths = function applyPaths() {
  *
  * @return {QueryCursor}
  * @param {Object} [options]
- * @see QueryCursor /docs/api/querycursor.html
+ * @see QueryCursor https://mongoosejs.com/docs/api/querycursor.html
  * @api public
  */
 
@@ -5171,7 +5187,7 @@ Query.prototype.near = function() {
  *     query.where('loc').near({ center: [10, 10], spherical: true });
  *
  * @deprecated
- * @see near() #query_Query-near
+ * @see near() https://mongoosejs.com/docs/api/query.html#Query.prototype.near()
  * @see $near https://www.mongodb.com/docs/manual/reference/operator/near/
  * @see $nearSphere https://www.mongodb.com/docs/manual/reference/operator/nearSphere/
  * @see $maxDistance https://www.mongodb.com/docs/manual/reference/operator/maxDistance/
@@ -5226,7 +5242,7 @@ if (Symbol.asyncIterator != null) {
  * @memberOf Query
  * @instance
  * @param {String|Array} [path]
- * @param {Array|Object} [coordinatePairs...]
+ * @param {...Array|Object} [coordinatePairs]
  * @return {Query} this
  * @see $polygon https://www.mongodb.com/docs/manual/reference/operator/polygon/
  * @see MongoDB Geospatial Indexing https://www.mongodb.com/docs/manual/core/geospatial-indexes/
@@ -5248,7 +5264,7 @@ if (Symbol.asyncIterator != null) {
  * @memberOf Query
  * @instance
  * @see $box https://www.mongodb.com/docs/manual/reference/operator/box/
- * @see within() Query#within #query_Query-within
+ * @see within() Query#within https://mongoosejs.com/docs/api/query.html#Query.prototype.within()
  * @see MongoDB Geospatial Indexing https://www.mongodb.com/docs/manual/core/geospatial-indexes/
  * @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
@@ -5305,9 +5321,9 @@ Query.prototype.box = function(ll, ur) {
  */
 
 /**
- * _DEPRECATED_ Alias for [circle](#query_Query-circle)
+ * _DEPRECATED_ Alias for [circle](https://mongoosejs.com/docs/api/query.html#Query.prototype.circle())
  *
- * **Deprecated.** Use [circle](#query_Query-circle) instead.
+ * **Deprecated.** Use [circle](https://mongoosejs.com/docs/api/query.html#Query.prototype.circle()) instead.
  *
  * @deprecated
  * @method center
@@ -5321,7 +5337,7 @@ Query.prototype.center = Query.base.circle;
 /**
  * _DEPRECATED_ Specifies a `$centerSphere` condition
  *
- * **Deprecated.** Use [circle](#query_Query-circle) instead.
+ * **Deprecated.** Use [circle](https://mongoosejs.com/docs/api/query.html#Query.prototype.circle()) instead.
  *
  * #### Example:
  *

package/lib/schema/SubdocumentPath.js

@@ -296,7 +296,7 @@ SubdocumentPath.prototype.doValidateSync = function(value, scope, options) {
  * @param {String} [options.value] the string stored in the `discriminatorKey` property. If not specified, Mongoose uses the `name` parameter.
  * @param {Boolean} [options.clone=true] By default, `discriminator()` clones the given `schema`. Set to `false` to skip cloning.
  * @return {Function} the constructor Mongoose will use for creating instances of this discriminator model
- * @see discriminators /docs/discriminators.html
+ * @see discriminators https://mongoosejs.com/docs/discriminators.html
  * @api public
  */