mongoose 7.1.1 → 7.2.0

package/lib/query.js

@@ -154,6 +154,18 @@ Query.prototype = new mquery();
 Query.prototype.constructor = Query;
 Query.base = mquery.prototype;
 
+/*!
+ * Overwrite mquery's `_distinct`, because Mongoose uses that name
+ * to store the field to apply distinct on.
+ */
+
+Object.defineProperty(Query.prototype, '_distinct', {
+  configurable: true,
+  writable: true,
+  enumerable: true,
+  value: undefined
+});
+
 /**
  * Flag to opt out of using `$geoWithin`.
  *
@@ -1618,6 +1630,11 @@ Query.prototype.setOptions = function(options, overwrite) {
     this._mongooseOptions.defaults = options.defaults;
     // deleting options.defaults will cause 7287 to fail
   }
+  if ('translateAliases' in options) {
+    this._mongooseOptions.translateAliases = options.translateAliases;
+    delete options.translateAliases;
+  }
+
   if (options.lean == null && this.schema && 'lean' in this.schema.options) {
     this._mongooseOptions.lean = this.schema.options.lean;
   }
@@ -2237,6 +2254,9 @@ Query.prototype._find = async function _find() {
   });
 
   const options = this._optionsForExec();
+
+  this._applyTranslateAliases(options);
+
   const filter = this._conditions;
   const fields = options.projection;
 
@@ -2486,6 +2506,8 @@ Query.prototype._findOne = async function _findOne() {
 
   const options = this._optionsForExec();
 
+  this._applyTranslateAliases(options);
+
   // don't pass in the conditions because we already merged them in
   const doc = await this._collection.collection.findOne(this._conditions, options);
   return new Promise((resolve, reject) => {
@@ -2520,6 +2542,7 @@ Query.prototype._findOne = async function _findOne() {
  * @param {Object} [filter] mongodb selector
  * @param {Object} [projection] optional fields to return
  * @param {Object} [options] see [`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} this
  * @see findOne https://www.mongodb.com/docs/manual/reference/method/db.collection.findOne/
  * @see Query.select https://mongoosejs.com/docs/api/query.html#Query.prototype.select()
@@ -2582,9 +2605,12 @@ Query.prototype._count = async function _count() {
   applyGlobalMaxTimeMS(this.options, this.model);
   applyGlobalDiskUse(this.options, this.model);
 
-  const conds = this._conditions;
   const options = this._optionsForExec();
 
+  this._applyTranslateAliases(options);
+
+  const conds = this._conditions;
+
   return this._collection.collection.count(conds, options);
 };
 
@@ -2609,12 +2635,43 @@ Query.prototype._countDocuments = async function _countDocuments() {
   applyGlobalMaxTimeMS(this.options, this.model);
   applyGlobalDiskUse(this.options, this.model);
 
-  const conds = this._conditions;
   const options = this._optionsForExec();
 
+  this._applyTranslateAliases(options);
+
+  const conds = this._conditions;
+
   return this._collection.collection.countDocuments(conds, options);
 };
 
+/*!
+ * If `translateAliases` option is set, call `Model.translateAliases()`
+ * on the following query properties: filter, projection, update, distinct.
+ */
+
+Query.prototype._applyTranslateAliases = function _applyTranslateAliases(options) {
+  let applyTranslateAliases = false;
+  if ('translateAliases' in this._mongooseOptions) {
+    applyTranslateAliases = this._mongooseOptions.translateAliases;
+  } else if (this.model?.schema?._userProvidedOptions?.translateAliases != null) {
+    applyTranslateAliases = this.model.schema._userProvidedOptions.translateAliases;
+  } else if (this.model?.base?.options?.translateAliases != null) {
+    applyTranslateAliases = this.model.base.options.translateAliases;
+  }
+  if (!applyTranslateAliases) {
+    return;
+  }
+
+  if (this.model?.schema?.aliases && Object.keys(this.model.schema.aliases).length > 0) {
+    this.model.translateAliases(this._conditions, true);
+    this.model.translateAliases(options.projection, true);
+    this.model.translateAliases(this._update, true);
+    if (this._distinct != null && this.model.schema.aliases[this._distinct] != null) {
+      this._distinct = this.model.schema.aliases[this._distinct];
+    }
+  }
+};
+
 /**
  * Execute a estimatedDocumentCount() query
  *
@@ -2796,6 +2853,7 @@ Query.prototype.__distinct = async function __distinct() {
   applyGlobalDiskUse(this.options, this.model);
 
   const options = this._optionsForExec();
+  this._applyTranslateAliases(options);
 
   return this._collection.collection.
     distinct(this._distinct, this._conditions, options);
@@ -2955,6 +3013,7 @@ Query.prototype._deleteOne = async function _deleteOne() {
   }
 
   const options = this._optionsForExec();
+  this._applyTranslateAliases(options);
 
   return this._collection.collection.deleteOne(this._conditions, options);
 };
@@ -3032,6 +3091,7 @@ Query.prototype._deleteMany = async function _deleteMany() {
   }
 
   const options = this._optionsForExec();
+  this._applyTranslateAliases(options);
 
   return this._collection.collection.deleteMany(this._conditions, options);
 };
@@ -3143,6 +3203,7 @@ function prepareDiscriminatorCriteria(query) {
  * @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](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`.
+ * @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.
  * @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
@@ -3234,6 +3295,7 @@ Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   applyGlobalDiskUse(this.options, this.model);
 
   const opts = this._optionsForExec(this.model);
+  this._applyTranslateAliases(opts);
 
   if ('strict' in opts) {
     this._mongooseOptions.strict = opts.strict;
@@ -3427,6 +3489,7 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
 
   const filter = this._conditions;
   const options = this._optionsForExec();
+  this._applyTranslateAliases(options);
   let fields = null;
 
   this._applyPaths();
@@ -3496,6 +3559,7 @@ Query.prototype._findOneAndDelete = async function _findOneAndDelete() {
  * @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](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`.
+ * @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} this
  * @api public
  */
@@ -3560,6 +3624,7 @@ Query.prototype._findOneAndReplace = async function _findOneAndReplace() {
 
   const filter = this._conditions;
   const options = this._optionsForExec();
+  this._applyTranslateAliases(options);
   convertNewToReturnDocument(options);
 
   const runValidators = _getOption(this, 'runValidators', false);
@@ -3787,6 +3852,7 @@ async function _updateThunk(op) {
 
   const castedQuery = this._conditions;
   const options = this._optionsForExec(this.model);
+  this._applyTranslateAliases(options);
 
   this._update = clone(this._update, options);
   const isOverwriting = this._mongooseOptions.overwrite && !hasDollarKeys(this._update);
@@ -3927,6 +3993,7 @@ Query.prototype._replaceOne = async function _replaceOne() {
  * @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.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
@@ -3995,6 +4062,7 @@ Query.prototype.updateMany = function(conditions, doc, options, callback) {
  * @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.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()
@@ -4061,6 +4129,7 @@ Query.prototype.updateOne = function(conditions, doc, options, callback) {
  * @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.
  * @param {Function} [callback] params are (error, writeOpResult)
  * @return {Query} this
  * @see Model.update https://mongoosejs.com/docs/api/model.html#Model.update()

package/lib/schema/SubdocumentPath.js

@@ -18,6 +18,7 @@ const getConstructor = require('../helpers/discriminator/getConstructor');
 const handleIdOption = require('../helpers/schema/handleIdOption');
 const internalToObjectOptions = require('../options').internalToObjectOptions;
 const utils = require('../utils');
+const InvalidSchemaOptionError = require('../error/invalidSchemaOption');
 
 let Subdocument;
 
@@ -34,6 +35,9 @@ module.exports = SubdocumentPath;
  */
 
 function SubdocumentPath(schema, path, options) {
+  if (schema.options.timeseries) {
+    throw new InvalidSchemaOptionError(path, 'timeseries');
+  }
   const schemaTypeIdOption = SubdocumentPath.defaultOptions &&
     SubdocumentPath.defaultOptions._id;
   if (schemaTypeIdOption != null) {
@@ -84,6 +88,7 @@ function _createConstructor(schema, baseClass) {
   _embedded.prototype = Object.create(proto);
   _embedded.prototype.$__setSchema(schema);
   _embedded.prototype.constructor = _embedded;
+  _embedded.base = schema.base;
   _embedded.schema = schema;
   _embedded.$isSingleNested = true;
   _embedded.events = new EventEmitter();

package/lib/schema/documentarray.js

@@ -16,6 +16,7 @@ const handleIdOption = require('../helpers/schema/handleIdOption');
 const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const utils = require('../utils');
 const getConstructor = require('../helpers/discriminator/getConstructor');
+const InvalidSchemaOptionError = require('../error/invalidSchemaOption');
 
 const arrayAtomicsSymbol = require('../helpers/symbols').arrayAtomicsSymbol;
 const arrayPathSymbol = require('../helpers/symbols').arrayPathSymbol;
@@ -36,6 +37,9 @@ let Subdocument;
  */
 
 function DocumentArrayPath(key, schema, options, schemaOptions) {
+  if (schema.options.timeseries) {
+    throw new InvalidSchemaOptionError(key, 'timeseries');
+  }
   const schemaTypeIdOption = DocumentArrayPath.defaultOptions &&
     DocumentArrayPath.defaultOptions._id;
   if (schemaTypeIdOption != null) {

package/lib/schema.js

@@ -78,6 +78,7 @@ let id = 0;
  * - [skipVersioning](https://mongoosejs.com/docs/guide.html#skipVersioning): object - paths to exclude from versioning
  * - [timestamps](https://mongoosejs.com/docs/guide.html#timestamps): object or boolean - defaults to `false`. If true, Mongoose adds `createdAt` and `updatedAt` properties to your schema and manages those properties for you.
  * - [pluginTags](https://mongoosejs.com/docs/guide.html#pluginTags): array of strings - defaults to `undefined`. If set and plugin called with `tags` option, will only apply that plugin to schemas with a matching tag.
+ * - [virtuals](https://mongoosejs.com/docs/tutorials/virtuals.html#virtuals-via-schema-options): object - virtuals to define, alias for [`.virtual`](https://mongoosejs.com/docs/api/schema.html#Schema.prototype.virtual())
  *
  * #### Options for Nested Schemas:
  *
@@ -743,6 +744,12 @@ Schema.prototype.add = function add(obj, prefix) {
         if (this._userProvidedOptions.strict != null) {
           childSchemaOptions.strict = this._userProvidedOptions.strict;
         }
+        if (this._userProvidedOptions.toObject != null) {
+          childSchemaOptions.toObject = this._userProvidedOptions.toObject;
+        }
+        if (this._userProvidedOptions.toJSON != null) {
+          childSchemaOptions.toJSON = this._userProvidedOptions.toJSON;
+        }
 
         const _schema = new Schema(_typeDef, childSchemaOptions);
         _schema.$implicitlyCreated = true;
@@ -1327,6 +1334,12 @@ Schema.prototype.interpretAsType = function(path, obj, options) {
         if (options.hasOwnProperty('strictQuery')) {
           childSchemaOptions.strictQuery = options.strictQuery;
         }
+        if (options.hasOwnProperty('toObject')) {
+          childSchemaOptions.toObject = options.toObject;
+        }
+        if (options.hasOwnProperty('toJSON')) {
+          childSchemaOptions.toJSON = options.toJSON;
+        }
 
         if (this._userProvidedOptions.hasOwnProperty('_id')) {
           childSchemaOptions._id = this._userProvidedOptions._id;

package/lib/validoptions.js

@@ -30,7 +30,8 @@ const VALID_OPTIONS = Object.freeze([
   'strictPopulate',
   'strictQuery',
   'toJSON',
-  'toObject'
+  'toObject',
+  'translateAliases'
 ]);
 
 module.exports = VALID_OPTIONS;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -19,9 +19,9 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "bson": "^5.2.0",
+    "bson": "^5.3.0",
     "kareem": "2.5.1",
-    "mongodb": "5.3.0",
+    "mongodb": "5.5.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",
@@ -118,7 +118,7 @@
   "main": "./index.js",
   "types": "./types/index.d.ts",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=14.20.1"
   },
   "bugs": {
     "url": "https://github.com/Automattic/mongoose/issues/new"

package/types/error.d.ts

@@ -6,7 +6,7 @@ declare module 'mongoose' {
   type CastError = Error.CastError;
   type SyncIndexesError = Error.SyncIndexesError;
 
-  class MongooseError extends global.Error {
+  export class MongooseError extends global.Error {
     constructor(msg: string);
 
     /** The type of error. "MongooseError" for generic errors. */

package/types/index.d.ts

@@ -178,6 +178,8 @@ declare module 'mongoose' {
     versionKey?: boolean;
     /** if true, convert Maps to POJOs. Useful if you want to `JSON.stringify()` the result of `toObject()`. */
     flattenMaps?: boolean;
+    /** if true, convert any ObjectIds in the result to 24 character hex strings. */
+    flattenObjectIds?: boolean;
     /** 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. */
     useProjection?: boolean;
   }

package/types/models.d.ts

@@ -25,6 +25,7 @@ declare module 'mongoose' {
 
   interface MongooseBulkWriteOptions {
     skipValidation?: boolean;
+    throwOnValidationError?: boolean;
   }
 
   interface InsertManyOptions extends
@@ -34,6 +35,7 @@ declare module 'mongoose' {
     rawResult?: boolean;
     ordered?: boolean;
     lean?: boolean;
+    throwOnValidationError?: boolean;
   }
 
   type InsertManyResult<T> = mongodb.InsertManyResult<T> & {

package/types/mongooseoptions.d.ts

@@ -202,5 +202,11 @@ declare module 'mongoose' {
      * @default { transform: true, flattenDecimals: true }
      */
     toObject?: ToObjectOptions;
+
+    /**
+     * If `true`, convert any aliases in filter, projection, update, and distinct
+     * to their database property names. Defaults to false.
+     */
+    translateAliases?: boolean;
   }
 }

package/types/query.d.ts

@@ -161,6 +161,11 @@ declare module 'mongoose' {
      * timestamps. Does nothing if schema-level timestamps are not set.
      */
     timestamps?: boolean | QueryTimestampsConfig;
+    /**
+     * If `true`, convert any aliases in filter, projection, update, and distinct
+     * to their database property names. Defaults to false.
+     */
+    translateAliases?: boolean;
     upsert?: boolean;
     useBigInt64?: boolean;
     writeConcern?: mongodb.WriteConcern;