mongoose 7.1.2 → 7.2.0

package/index.js

@@ -46,6 +46,7 @@ module.exports.Mixed = mongoose.Mixed;
 module.exports.Date = mongoose.Date;
 module.exports.Number = mongoose.Number;
 module.exports.Error = mongoose.Error;
+module.exports.MongooseError = mongoose.MongooseError;
 module.exports.now = mongoose.now;
 module.exports.CastError = mongoose.CastError;
 module.exports.SchemaTypeOptions = mongoose.SchemaTypeOptions;

package/lib/document.js

@@ -3676,6 +3676,15 @@ Document.prototype.$toObject = function(options, json) {
     flattenMaps = schemaOptions.flattenMaps;
   }
 
+  let flattenObjectIds;
+  if (options._calledWithOptions.flattenObjectIds != null) {
+    flattenObjectIds = options.flattenObjectIds;
+  } else if (defaultOptions.flattenObjectIds != null) {
+    flattenObjectIds = defaultOptions.flattenObjectIds;
+  } else {
+    flattenObjectIds = schemaOptions.flattenObjectIds;
+  }
+
   // The original options that will be passed to `clone()`. Important because
   // `clone()` will recursively call `$toObject()` on embedded docs, so we
   // need the original options the user passed in, plus `_isNested` and
@@ -3685,6 +3694,7 @@ Document.prototype.$toObject = function(options, json) {
     json: json,
     minimize: _minimize,
     flattenMaps: flattenMaps,
+    flattenObjectIds: flattenObjectIds,
     _seen: (options && options._seen) || new Map()
   });
 
@@ -3900,6 +3910,7 @@ Document.prototype.$toObject = function(options, json) {
  * @param {Boolean} [options.depopulate=false] if true, replace any conventionally populated paths with the original id in the output. Has no affect on virtual populated paths.
  * @param {Boolean} [options.versionKey=true] if false, exclude the version key (`__v` by default) from the output
  * @param {Boolean} [options.flattenMaps=false] if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`.
+ * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
  * @param {Boolean} [options.useProjection=false] - If true, omits fields that are excluded in this document's projection. Unless you specified a projection, this will omit any field that has `select: false` in the schema.
  * @return {Object} js object (not a POJO)
  * @see mongodb.Binary https://mongodb.github.io/node-mongodb-native/4.9/classes/Binary.html
@@ -3968,8 +3979,7 @@ function applyVirtuals(self, json, options, toObjectOptions) {
   let virtualsToApply = null;
   if (Array.isArray(options.virtuals)) {
     virtualsToApply = new Set(options.virtuals);
-  }
-  else if (options.virtuals && options.virtuals.pathsToSkip) {
+  } else if (options.virtuals && options.virtuals.pathsToSkip) {
     virtualsToApply = new Set(paths);
     for (let i = 0; i < options.virtuals.pathsToSkip.length; i++) {
       if (virtualsToApply.has(options.virtuals.pathsToSkip[i])) {
@@ -4181,6 +4191,7 @@ function omitDeselectedFields(self, json) {
  *
  * @param {Object} options
  * @param {Boolean} [options.flattenMaps=true] if true, convert Maps to [POJOs](https://masteringjs.io/tutorials/fundamentals/pojo). Useful if you want to `JSON.stringify()` the result.
+ * @param {Boolean} [options.flattenObjectIds=false] if true, convert any ObjectIds in the result to 24 character hex strings.
  * @return {Object}
  * @see Document#toObject https://mongoosejs.com/docs/api/document.html#Document.prototype.toObject()
  * @see JSON.stringify() in JavaScript https://thecodebarbarian.com/the-80-20-guide-to-json-stringify-in-javascript.html
@@ -4193,6 +4204,9 @@ Document.prototype.toJSON = function(options) {
   return this.$toObject(options, true);
 };
 
+/*!
+ * ignore
+ */
 
 Document.prototype.ownerDocument = function() {
   return this;

package/lib/error/bulkWriteError.js

@@ -0,0 +1,41 @@
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./');
+
+
+/**
+ * If `bulkWrite()` or `insertMany()` has validation errors, but
+ * all valid operations succeed, and 'throwOnValidationError' is true,
+ * Mongoose will throw this error.
+ *
+ * @api private
+ */
+
+class MongooseBulkWriteError extends MongooseError {
+  constructor(validationErrors, results, rawResult, operation) {
+    let preview = validationErrors.map(e => e.message).join(', ');
+    if (preview.length > 200) {
+      preview = preview.slice(0, 200) + '...';
+    }
+    super(`${operation} failed with ${validationErrors.length} Mongoose validation errors: ${preview}`);
+
+    this.validationErrors = validationErrors;
+    this.results = results;
+    this.rawResult = rawResult;
+    this.operation = operation;
+  }
+}
+
+Object.defineProperty(MongooseBulkWriteError.prototype, 'name', {
+  value: 'MongooseBulkWriteError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = MongooseBulkWriteError;

package/lib/error/invalidSchemaOption.js

@@ -0,0 +1,30 @@
+
+/*!
+ * Module dependencies.
+ */
+
+'use strict';
+
+const MongooseError = require('./');
+
+class InvalidSchemaOptionError extends MongooseError {
+  /**
+   * InvalidSchemaOption Error constructor.
+   * @param {String} name
+   * @api private
+   */
+  constructor(name, option) {
+    const msg = `Cannot create use schema for property "${name}" because the schema has the ${option} option enabled.`;
+    super(msg);
+  }
+}
+
+Object.defineProperty(InvalidSchemaOptionError.prototype, 'name', {
+  value: 'InvalidSchemaOptionError'
+});
+
+/*!
+ * exports
+ */
+
+module.exports = InvalidSchemaOptionError;

package/lib/helpers/clone.js

@@ -78,6 +78,9 @@ function clone(obj, options, isArrayChild) {
   }
 
   if (isBsonType(obj, 'ObjectId')) {
+    if (options && options.flattenObjectIds) {
+      return obj.toJSON();
+    }
     return new ObjectId(obj.id);
   }
 

package/lib/index.js

@@ -1140,6 +1140,7 @@ Mongoose.prototype.Number = SchemaTypes.Number;
  */
 
 Mongoose.prototype.Error = require('./error/index');
+Mongoose.prototype.MongooseError = require('./error/mongooseError');
 
 /**
  * Mongoose uses this function to get the current time when setting

package/lib/model.js

@@ -64,6 +64,7 @@ const setDottedPath = require('./helpers/path/setDottedPath');
 const STATES = require('./connectionstate');
 const util = require('util');
 const utils = require('./utils');
+const MongooseBulkWriteError = require('./error/bulkWriteError');
 
 const VERSION_WHERE = 1;
 const VERSION_INC = 2;
@@ -1855,20 +1856,24 @@ Model.discriminators;
  *
  * #### Example:
  *
- *     Character
- *       .find(Character.translateAliases({
- *         '名': 'Eddard Stark' // Alias for 'name'
- *       })
- *       .exec(function(err, characters) {})
+ *     await Character.find(Character.translateAliases({
+ *        '名': 'Eddard Stark' // Alias for 'name'
+ *     });
+ *
+ * By default, `translateAliases()` overwrites raw fields with aliased fields.
+ * So if `n` is an alias for `name`, `{ n: 'alias', name: 'raw' }` will resolve to `{ name: 'alias' }`.
+ * However, you can set the `errorOnDuplicates` option to throw an error if there are potentially conflicting paths.
+ * The `translateAliases` option for queries uses `errorOnDuplicates`.
  *
  * #### Note:
  *
  * Only translate arguments of object type anything else is returned raw
  *
  * @param {Object} fields fields/conditions that may contain aliased keys
+ * @param {Boolean} [errorOnDuplicates] if true, throw an error if there's both a key and an alias for that key in `fields`
  * @return {Object} the translated 'pure' fields/conditions
  */
-Model.translateAliases = function translateAliases(fields) {
+Model.translateAliases = function translateAliases(fields, errorOnDuplicates) {
   _checkContext(this, 'translateAliases');
 
   const translate = (key, value) => {
@@ -1880,6 +1885,9 @@ Model.translateAliases = function translateAliases(fields) {
       const name = fieldKeys[i];
       if (currentSchema && currentSchema.aliases[name]) {
         alias = currentSchema.aliases[name];
+        if (errorOnDuplicates && alias in fields) {
+          throw new MongooseError(`Provided object has both field "${name}" and its alias "${alias}"`);
+        }
         // Alias found,
         translated.push(alias);
       } else {
@@ -1932,6 +1940,8 @@ Model.translateAliases = function translateAliases(fields) {
               // Recursively translate nested queries
               fields[key][i] = this.translateAliases(fields[key][i]);
             }
+          } else {
+            this.translateAliases(fields[key]);
           }
         }
       }
@@ -1961,6 +1971,7 @@ Model.translateAliases = function translateAliases(fields) {
  *
  * @param {Object} conditions
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @api public
  */
@@ -1995,6 +2006,7 @@ Model.deleteOne = function deleteOne(conditions, options) {
  *
  * @param {Object} conditions
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @api public
  */
@@ -2036,6 +2048,7 @@ Model.deleteMany = function deleteMany(conditions, options) {
  * @param {Object|ObjectId} filter
  * @param {Object|String|String[]} [projection] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.select())
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see field selection https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
  * @see query casting https://mongoosejs.com/docs/tutorials/query_casting.html
@@ -2124,6 +2137,7 @@ Model.findById = function findById(id, projection, options) {
  * @param {Object} [conditions]
  * @param {Object|String|String[]} [projection] optional fields to return, see [`Query.prototype.select()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.select())
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see field selection https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
  * @see lean queries https://mongoosejs.com/docs/tutorials/lean.html
@@ -2317,7 +2331,7 @@ Model.$where = function $where() {
 };
 
 /**
- * Issues a mongodb findAndModify update command.
+ * Issues a mongodb findOneAndUpdate command.
  *
  * Finds a matching document, updates it according to the `update` arg, passing any `options`, and returns the found document (if any) to the callback. The query executes if `callback` is passed else a Query object is returned.
  *
@@ -2369,6 +2383,7 @@ Model.$where = function $where() {
  * @param {Boolean} [options.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
  * @param {Boolean} [options.setDefaultsOnInsert=true] 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
  * @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} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Tutorial https://mongoosejs.com/docs/tutorials/findoneandupdate.html
  * @see mongodb https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -2429,7 +2444,7 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
 }
 
 /**
- * Issues a mongodb findAndModify update command by a document's _id field.
+ * Issues a mongodb findOneAndUpdate command by a document's _id field.
  * `findByIdAndUpdate(id, ...)` is equivalent to `findOneAndUpdate({ _id: id }, ...)`.
  *
  * Finds a matching document, updates it according to the `update` arg,
@@ -2487,6 +2502,7 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * @param {Boolean} [options.upsert=false] if true, and no documents found, insert a new document
  * @param {Boolean} [options.new=false] if true, return the modified document rather than the original
  * @param {Object|String} [options.select] sets the document fields to return.
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Model.findOneAndUpdate https://mongoosejs.com/docs/api/model.html#Model.findOneAndUpdate()
  * @see mongodb https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -2547,6 +2563,7 @@ Model.findByIdAndUpdate = function(id, update, options) {
  * @param {Object|String} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @param {Object|String} [options.select] sets the document fields to return.
  * @param {Number} [options.maxTimeMS] puts a time limit on the query - requires mongodb >= 2.6.0
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @api public
  */
@@ -2582,6 +2599,7 @@ Model.findOneAndDelete = function(conditions, options) {
  * @param {Object|Number|String} id value of `_id` to query by
  * @param {Object} [options] optional see [`Query.prototype.setOptions()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.setOptions())
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Model.findOneAndRemove https://mongoosejs.com/docs/api/model.html#Model.findOneAndRemove()
  * @see mongodb https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -2625,6 +2643,7 @@ Model.findByIdAndDelete = function(id, 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 {Object|String} [options.select] sets the document fields to return.
  * @param {Number} [options.maxTimeMS] puts a time limit on the query - requires mongodb >= 2.6.0
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @api public
  */
@@ -2649,7 +2668,7 @@ Model.findOneAndReplace = function(filter, replacement, options) {
 };
 
 /**
- * Issue a mongodb findAndModify remove command.
+ * Issue a mongodb findOneAndRemove command.
  *
  * Finds a matching document, removes it, and returns the found document (if any).
  *
@@ -2682,6 +2701,7 @@ Model.findOneAndReplace = function(filter, replacement, 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 {Object|String} [options.select] sets the document fields to return.
  * @param {Number} [options.maxTimeMS] puts a time limit on the query - requires mongodb >= 2.6.0
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see mongodb https://www.mongodb.com/docs/manual/reference/command/findAndModify/
  * @api public
@@ -2707,7 +2727,7 @@ Model.findOneAndRemove = function(conditions, options) {
 };
 
 /**
- * Issue a mongodb findAndModify remove command by a document's _id field. `findByIdAndRemove(id, ...)` is equivalent to `findOneAndRemove({ _id: id }, ...)`.
+ * Issue a mongodb findOneAndRemove command by a document's _id field. `findByIdAndRemove(id, ...)` is equivalent to `findOneAndRemove({ _id: id }, ...)`.
  *
  * Finds a matching document, removes it, and returns the found document (if any).
  *
@@ -2729,6 +2749,7 @@ Model.findOneAndRemove = function(conditions, options) {
  * @param {Object|String} [options.sort] if multiple docs are found by the conditions, sets the sort order to choose which doc to update.
  * @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 {Object|String} [options.select] sets the document fields to return.
+ * @param {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Model.findOneAndRemove https://mongoosejs.com/docs/api/model.html#Model.findOneAndRemove()
  * @see mongodb https://www.mongodb.com/docs/manual/reference/command/findAndModify/
@@ -2962,6 +2983,7 @@ Model.startSession = function() {
  * @param {Boolean} [options.lean=false] if `true`, skips hydrating and validating the documents. This option is useful if you need the extra performance, but Mongoose won't validate the documents before inserting.
  * @param {Number} [options.limit=null] this limits the number of documents being processed (validation/casting) by mongoose in parallel, this does **NOT** send the documents in batches to MongoDB. Use this option if you're processing a large number of documents and your app is running out of memory.
  * @param {String|Object|Array} [options.populate=null] populates the result documents. This option is a no-op if `rawResult` is set.
+ * @param {Boolean} [options.throwOnValidationError=false] If true and `ordered: false`, throw an error if one of the operations failed validation, but all valid operations completed successfully.
  * @return {Promise} resolving to the raw result from the MongoDB driver if `options.rawResult` was `true`, or the documents that passed validation, otherwise
  * @api public
  */
@@ -3007,6 +3029,7 @@ Model.$__insertMany = function(arr, options, callback) {
   const limit = options.limit || 1000;
   const rawResult = !!options.rawResult;
   const ordered = typeof options.ordered === 'boolean' ? options.ordered : true;
+  const throwOnValidationError = typeof options.throwOnValidationError === 'boolean' ? options.throwOnValidationError : false;
   const lean = !!options.lean;
 
   if (!Array.isArray(arr)) {
@@ -3113,6 +3136,20 @@ Model.$__insertMany = function(arr, options, callback) {
           _setIsNew(attribute, false);
         }
 
+        if (ordered === false && throwOnValidationError && validationErrors.length > 0) {
+          for (let i = 0; i < results.length; ++i) {
+            if (results[i] === void 0) {
+              results[i] = docs[i];
+            }
+          }
+          return callback(new MongooseBulkWriteError(
+            validationErrors,
+            results,
+            res,
+            'insertMany'
+          ));
+        }
+
         if (rawResult) {
           if (ordered === false) {
             for (let i = 0; i < results.length; ++i) {
@@ -3308,6 +3345,7 @@ function _setIsNew(doc, val) {
  * @param {Boolean} [options.j=true] If false, disable [journal acknowledgement](https://www.mongodb.com/docs/manual/reference/write-concern/#j-option)
  * @param {Boolean} [options.skipValidation=false] Set to true to skip Mongoose schema validation on bulk write operations. Mongoose currently runs validation on `insertOne` and `replaceOne` operations by default.
  * @param {Boolean} [options.bypassDocumentValidation=false] If true, disable [MongoDB server-side schema validation](https://www.mongodb.com/docs/manual/core/schema-validation/) for all writes in this bulk.
+ * @param {Boolean} [options.throwOnValidationError=false] If true and `ordered: false`, throw an error if one of the operations failed validation, but all valid operations completed successfully.
  * @param {Boolean} [options.strict=null] Overwrites the [`strict` option](https://mongoosejs.com/docs/guide.html#strict) on schema. If false, allows filtering and writing fields not defined in the schema for all writes in this bulk.
  * @return {Promise} resolves to a [`BulkWriteOpResult`](https://mongodb.github.io/node-mongodb-native/4.9/classes/BulkWriteResult.html) if the operation succeeds
  * @api public
@@ -3355,12 +3393,14 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
     let remaining = validations.length;
     let validOps = [];
     let validationErrors = [];
+    const results = [];
     for (let i = 0; i < validations.length; ++i) {
       validations[i]((err) => {
         if (err == null) {
           validOps.push(i);
         } else {
           validationErrors.push({ index: i, error: err });
+          results[i] = err;
         }
         if (--remaining <= 0) {
           completeUnorderedValidation.call(this);
@@ -3373,6 +3413,7 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
       map(v => v.error);
 
     function completeUnorderedValidation() {
+      const validOpIndexes = validOps;
       validOps = validOps.sort().map(index => ops[index]);
 
       this.$__collection.bulkWrite(validOps, options, (error, res) => {
@@ -3385,9 +3426,22 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
           return reject(error);
         }
 
+        for (let i = 0; i < validOpIndexes.length; ++i) {
+          results[validOpIndexes[i]] = null;
+        }
         if (validationErrors.length > 0) {
-          res.mongoose = res.mongoose || {};
-          res.mongoose.validationErrors = validationErrors;
+          if (options.throwOnValidationError) {
+            return reject(new MongooseBulkWriteError(
+              validationErrors,
+              results,
+              res,
+              'bulkWrite'
+            ));
+          } else {
+            res.mongoose = res.mongoose || {};
+            res.mongoose.validationErrors = validationErrors;
+            res.mongoose.results = results;
+          }
         }
 
         resolve(res);
@@ -3739,6 +3793,7 @@ Model.hydrate = function(obj, projection, options) {
  * @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](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 {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://www.mongodb.com/docs/manual/reference/command/update/#update-command-output
@@ -3777,6 +3832,7 @@ Model.updateMany = function updateMany(conditions, doc, options) {
  * @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](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 {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see MongoDB docs https://www.mongodb.com/docs/manual/reference/command/update/#update-command-output
@@ -3813,6 +3869,7 @@ Model.updateOne = function updateOne(conditions, doc, options) {
  * @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](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 {Boolean} [options.translateAliases=null] If set to `true`, translates any schema-defined aliases in `filter`, `projection`, `update`, and `distinct`. Throws an error if there are any conflicts where both alias and raw property are defined on the same object.
  * @return {Query}
  * @see Query docs https://mongoosejs.com/docs/queries.html
  * @see UpdateResult https://mongodb.github.io/node-mongodb-native/4.9/interfaces/UpdateResult.html