mongoose 7.4.4 → 7.5.0

package/lib/document.js

@@ -4091,6 +4091,14 @@ function applyGetters(self, json, options) {
       if (ii === last) {
         const val = self.$get(path);
         branch[part] = clone(val, options);
+        if (Array.isArray(branch[part]) && schema.paths[path].$embeddedSchemaType) {
+          for (let i = 0; i < branch[part].length; ++i) {
+            branch[part][i] = schema.paths[path].$embeddedSchemaType.applyGetters(
+              branch[part][i],
+              self
+            );
+          }
+        }
       } else if (v == null) {
         if (part in cur) {
           branch[part] = v;

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

@@ -9,6 +9,7 @@ const MongooseError = require('../../error/mongooseError');
 const Collection = require('mongodb').Collection;
 const ObjectId = require('../../types/objectid');
 const getConstructorName = require('../../helpers/getConstructorName');
+const internalToObjectOptions = require('../../options').internalToObjectOptions;
 const stream = require('stream');
 const util = require('util');
 
@@ -377,7 +378,7 @@ function format(obj, sub, color, shell) {
   }
 
   const clone = require('../../helpers/clone');
-  let x = clone(obj, { transform: false });
+  let x = clone(obj, internalToObjectOptions);
   const constructorName = getConstructorName(x);
 
   if (constructorName === 'Binary') {

package/lib/helpers/query/castUpdate.js

@@ -14,6 +14,24 @@ const schemaMixedSymbol = require('../../schema/symbols').schemaMixedSymbol;
 const setDottedPath = require('../path/setDottedPath');
 const utils = require('../../utils');
 
+const mongodbUpdateOperators = new Set([
+  '$currentDate',
+  '$inc',
+  '$min',
+  '$max',
+  '$mul',
+  '$rename',
+  '$set',
+  '$setOnInsert',
+  '$unset',
+  '$addToSet',
+  '$pop',
+  '$pull',
+  '$push',
+  '$pullAll',
+  '$bit'
+]);
+
 /**
  * Casts an update op based on the given schema
  *
@@ -58,7 +76,7 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
   while (i--) {
     const op = ops[i];
     // if overwrite is set, don't do any of the special $set stuff
-    if (op[0] !== '$' && !overwrite) {
+    if (!mongodbUpdateOperators.has(op) && !overwrite) {
       // fix up $set sugar
       if (!ret.$set) {
         if (obj.$set) {
@@ -88,7 +106,7 @@ module.exports = function castUpdate(schema, obj, options, context, filter) {
     if (val &&
         typeof val === 'object' &&
         !Buffer.isBuffer(val) &&
-        (!overwrite || hasDollarKey)) {
+        (!overwrite || mongodbUpdateOperators.has(op))) {
       walkUpdatePath(schema, val, op, options, context, filter);
     } else if (overwrite && ret && typeof ret === 'object') {
       walkUpdatePath(schema, ret, '$set', options, context, filter);
@@ -540,7 +558,7 @@ function castUpdateVal(schema, val, op, $conditional, context, path) {
     return Boolean(val);
   }
 
-  if (/^\$/.test($conditional)) {
+  if (mongodbUpdateOperators.has($conditional)) {
     return schema.castForQuery(
       $conditional,
       val,

package/lib/model.js

@@ -1481,9 +1481,7 @@ Model.syncIndexes = async function syncIndexes(options) {
 };
 
 /**
- * Does a dry-run of Model.syncIndexes(), meaning that
- * the result of this function would be the result of
- * Model.syncIndexes().
+ * Does a dry-run of `Model.syncIndexes()`, returning the indexes that `syncIndexes()` would drop and create if you were to run `syncIndexes()`.
  *
  * @param {Object} [options]
  * @returns {Promise} which contains an object, {toDrop, toCreate}, which
@@ -3498,6 +3496,10 @@ Model.bulkWrite = async function bulkWrite(ops, options) {
       const validOpIndexes = validOps;
       validOps = validOps.sort().map(index => ops[index]);
 
+      if (validOps.length === 0) {
+        return resolve(getDefaultBulkwriteResult());
+      }
+
       this.$__collection.bulkWrite(validOps, options, (error, res) => {
         if (error) {
           if (validationErrors.length > 0) {
@@ -4081,13 +4083,13 @@ Model.aggregate = function aggregate(pipeline, options) {
  *     }
  *
  * @param {Object} obj
- * @param {Array|String} pathsToValidate
+ * @param {Object|Array|String} pathsOrOptions
  * @param {Object} [context]
  * @return {Promise|undefined}
  * @api public
  */
 
-Model.validate = async function validate(obj, pathsToValidate, context) {
+Model.validate = async function validate(obj, pathsOrOptions, context) {
   if ((arguments.length < 3) || (arguments.length === 3 && typeof arguments[2] === 'function')) {
     // For convenience, if we're validating a document or an object, make `context` default to
     // the model so users don't have to always pass `context`, re: gh-10132, gh-10346
@@ -4104,9 +4106,20 @@ Model.validate = async function validate(obj, pathsToValidate, context) {
   }
   let paths = Object.keys(schema.paths);
 
-  if (pathsToValidate != null) {
-    const _pathsToValidate = typeof pathsToValidate === 'string' ? new Set(pathsToValidate.split(' ')) : new Set(pathsToValidate);
+  if (pathsOrOptions != null) {
+    const _pathsToValidate = typeof pathsOrOptions === 'string' ? new Set(pathsOrOptions.split(' ')) : Array.isArray(pathsOrOptions) ? new Set(pathsOrOptions) : new Set(paths);
     paths = paths.filter(p => {
+      if (pathsOrOptions.pathsToSkip) {
+        if (Array.isArray(pathsOrOptions.pathsToSkip)) {
+          if (pathsOrOptions.pathsToSkip.find(x => x == p)) {
+            return false;
+          }
+        } else if (typeof pathsOrOptions.pathsToSkip == 'string') {
+          if (pathsOrOptions.pathsToSkip.includes(p)) {
+            return false;
+          }
+        }
+      }
       const pieces = p.split('.');
       let cur = pieces[0];
 

package/lib/query.js

@@ -1683,6 +1683,15 @@ const printRawResultDeprecationWarning = util.deprecate(
   'The `rawResult` option for Mongoose queries is deprecated. Use `includeResultMetadata: false` as a replacement for `rawResult: true`.'
 );
 
+/*!
+ * ignore
+ */
+
+const printOverwriteDeprecationWarning = util.deprecate(
+  function printOverwriteDeprecationWarning() {},
+  'The `overwrite` option for `findOneAndUpdate()` is deprecated. use `findOneAndReplace()` instead.'
+);
+
 /**
  * Sets the [`explain` option](https://www.mongodb.com/docs/manual/reference/method/cursor.explain/),
  * which makes this query return detailed execution stats instead of the actual
@@ -3283,6 +3292,10 @@ Query.prototype.findOneAndUpdate = function(filter, doc, options) {
 
 Query.prototype._findOneAndUpdate = async function _findOneAndUpdate() {
   // For backwards compability with Mongoose 6 re: #13550
+
+  if (this._mongooseOptions.overwrite != null) {
+    printOverwriteDeprecationWarning();
+  }
   if (this._mongooseOptions.overwrite) {
     this.op = 'findOneAndReplace';
     return this._findOneAndReplace();
@@ -3587,9 +3600,6 @@ Query.prototype.findOneAndReplace = function(filter, replacement, options) {
   }
 
   if (replacement != null) {
-    if (hasDollarKeys(replacement)) {
-      throw new Error('The replacement document must not contain atomic operators.');
-    }
     this._mergeUpdate(replacement);
   }
 

package/lib/schema/SubdocumentPath.js

@@ -17,6 +17,7 @@ const geospatial = require('./operators/geospatial');
 const getConstructor = require('../helpers/discriminator/getConstructor');
 const handleIdOption = require('../helpers/schema/handleIdOption');
 const internalToObjectOptions = require('../options').internalToObjectOptions;
+const isExclusive = require('../helpers/projection/isExclusive');
 const utils = require('../utils');
 const InvalidSchemaOptionError = require('../error/invalidSchemaOption');
 
@@ -178,7 +179,8 @@ SubdocumentPath.prototype.cast = function(val, doc, init, priorVal, options) {
     subdoc = new Constructor(void 0, selected, doc, false, { defaults: false });
     delete subdoc.$__.defaults;
     subdoc.$init(val);
-    applyDefaults(subdoc, selected);
+    const exclude = isExclusive(selected);
+    applyDefaults(subdoc, selected, exclude);
   } else {
     options = Object.assign({}, options, { priorDoc: priorVal });
     if (Object.keys(val).length === 0) {

package/lib/schema/array.js

@@ -289,13 +289,6 @@ SchemaArray.prototype.applyGetters = function(value, scope) {
   }
 
   const ret = SchemaType.prototype.applyGetters.call(this, value, scope);
-  if (Array.isArray(ret)) {
-    const rawValue = utils.isMongooseArray(ret) ? ret.__array : ret;
-    const len = rawValue.length;
-    for (let i = 0; i < len; ++i) {
-      rawValue[i] = this.caster.applyGetters(rawValue[i], scope);
-    }
-  }
   return ret;
 };
 

package/lib/schema.js

@@ -2045,6 +2045,12 @@ Schema.prototype.index = function(fields, options) {
   if (options.expires) {
     utils.expires(options);
   }
+  for (const key in fields) {
+    if (this.aliases[key]) {
+      fields[this.aliases[key]] = fields[key];
+      delete fields[key];
+    }
+  }
 
   for (const field of Object.keys(fields)) {
     if (fields[field] === 'ascending' || fields[field] === 'asc') {

package/lib/types/array/index.js

@@ -90,6 +90,9 @@ function MongooseArray(values, path, doc, schematype) {
       if (mongooseArrayMethods.hasOwnProperty(prop)) {
         return mongooseArrayMethods[prop];
       }
+      if (typeof prop === 'string' && numberRE.test(prop) && schematype?.$embeddedSchemaType != null) {
+        return schematype.$embeddedSchemaType.applyGetters(__array[prop], doc);
+      }
 
       return __array[prop];
     },

package/lib/utils.js

@@ -640,7 +640,10 @@ exports.getValue = function(path, obj, map) {
 const mapGetterOptions = Object.freeze({ getters: false });
 
 function getValueLookup(obj, part) {
-  const _from = obj?._doc || obj;
+  let _from = obj?._doc || obj;
+  if (_from != null && _from.isMongooseArrayProxy) {
+    _from = _from.__array;
+  }
   return _from instanceof Map ?
     _from.get(part, mapGetterOptions) :
     _from[part];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "7.4.4",
+  "version": "7.5.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -21,7 +21,7 @@
   "dependencies": {
     "bson": "^5.4.0",
     "kareem": "2.5.1",
-    "mongodb": "5.7.0",
+    "mongodb": "5.8.1",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",

package/types/inferschematype.d.ts

@@ -215,14 +215,16 @@ type ResolvePathType<PathValueType, Options extends SchemaTypeOptions<PathValueT
                                   PathValueType extends 'decimal128' | 'Decimal128' | typeof Schema.Types.Decimal128 ? Types.Decimal128 :
                                     IfEquals<PathValueType, Schema.Types.Decimal128> extends true ? Types.Decimal128 :
                                       IfEquals<PathValueType, Types.Decimal128> extends true ? Types.Decimal128 :
-                                        PathValueType extends 'uuid' | 'UUID' | typeof Schema.Types.UUID ? Buffer :
-                                          IfEquals<PathValueType, Schema.Types.UUID> extends true ? Buffer :
-                                            PathValueType extends MapConstructor ? Map<string, ResolvePathType<Options['of']>> :
-                                              IfEquals<PathValueType, typeof Schema.Types.Map> extends true ? Map<string, ResolvePathType<Options['of']>> :
-                                                PathValueType extends ArrayConstructor ? any[] :
-                                                  PathValueType extends typeof Schema.Types.Mixed ? any:
-                                                    IfEquals<PathValueType, ObjectConstructor> extends true ? any:
-                                                      IfEquals<PathValueType, {}> extends true ? any:
-                                                        PathValueType extends typeof SchemaType ? PathValueType['prototype'] :
-                                                          PathValueType extends Record<string, any> ? ObtainDocumentType<PathValueType, any, { typeKey: TypeKey }> :
-                                                            unknown;
+                                        IfEquals<PathValueType, Schema.Types.BigInt> extends true ? bigint :
+                                          PathValueType extends 'bigint' | 'BigInt' | typeof Schema.Types.BigInt ? bigint :
+                                            PathValueType extends 'uuid' | 'UUID' | typeof Schema.Types.UUID ? Buffer :
+                                              IfEquals<PathValueType, Schema.Types.UUID> extends true ? Buffer :
+                                                PathValueType extends MapConstructor ? Map<string, ResolvePathType<Options['of']>> :
+                                                  IfEquals<PathValueType, typeof Schema.Types.Map> extends true ? Map<string, ResolvePathType<Options['of']>> :
+                                                    PathValueType extends ArrayConstructor ? any[] :
+                                                      PathValueType extends typeof Schema.Types.Mixed ? any:
+                                                        IfEquals<PathValueType, ObjectConstructor> extends true ? any:
+                                                          IfEquals<PathValueType, {}> extends true ? any:
+                                                            PathValueType extends typeof SchemaType ? PathValueType['prototype'] :
+                                                              PathValueType extends Record<string, any> ? ObtainDocumentType<PathValueType, any, { typeKey: TypeKey }> :
+                                                                unknown;

package/types/pipelinestage.d.ts

@@ -28,6 +28,7 @@ declare module 'mongoose' {
     | PipelineStage.ReplaceWith
     | PipelineStage.Sample
     | PipelineStage.Search
+    | PipelineStage.SearchMeta
     | PipelineStage.Set
     | PipelineStage.SetWindowFields
     | PipelineStage.Skip
@@ -239,6 +240,20 @@ declare module 'mongoose' {
       }
     }
 
+    export interface SearchMeta {
+      /** [`$searchMeta` reference](https://www.mongodb.com/docs/atlas/atlas-search/query-syntax/#mongodb-pipeline-pipe.-searchMeta) */
+      $searchMeta: {
+        index?: string;
+        highlight?: {
+          /** [`highlightPath` reference](https://docs.atlas.mongodb.com/atlas-search/path-construction/#multiple-field-search) */
+          path: string | string[] | { value: string, multi: string };
+          maxCharsToExamine?: number;
+          maxNumPassages?: number;
+        };
+        [operator: string]: any;
+      }
+    }
+
     export interface Set {
       /** [`$set` reference](https://www.mongodb.com/docs/manual/reference/operator/aggregation/set/) */
       $set: Record<string, AnyExpression | any>

package/types/schematypes.d.ts

@@ -311,6 +311,14 @@ declare module 'mongoose' {
         enum(vals: string[] | number[]): this;
       }
 
+      class BigInt extends SchemaType {
+        /** This schema type's name, to defend against minifiers that mangle function names. */
+        static schemaName: 'BigInt';
+
+        /** Default options for this SchemaType */
+        defaultOptions: Record<string, any>;
+      }
+
       class Boolean extends SchemaType {
         /** This schema type's name, to defend against minifiers that mangle function names. */
         static schemaName: 'Boolean';