mongoose 8.12.1 → 8.13.0

package/lib/cursor/aggregationCursor.js

@@ -8,6 +8,7 @@ const MongooseError = require('../error/mongooseError');
 const Readable = require('stream').Readable;
 const eachAsync = require('../helpers/cursor/eachAsync');
 const immediate = require('../helpers/immediate');
+const kareem = require('kareem');
 const util = require('util');
 
 /**
@@ -62,7 +63,11 @@ util.inherits(AggregationCursor, Readable);
 
 function _init(model, c, agg) {
   if (!model.collection.buffer) {
-    model.hooks.execPre('aggregate', agg, function() {
+    model.hooks.execPre('aggregate', agg, function(err) {
+      if (err != null) {
+        _handlePreHookError(c, err);
+        return;
+      }
       if (typeof agg.options?.cursor?.transform === 'function') {
         c._transforms.push(agg.options.cursor.transform);
       }
@@ -72,7 +77,12 @@ function _init(model, c, agg) {
     });
   } else {
     model.collection.emitter.once('queue', function() {
-      model.hooks.execPre('aggregate', agg, function() {
+      model.hooks.execPre('aggregate', agg, function(err) {
+        if (err != null) {
+          _handlePreHookError(c, err);
+          return;
+        }
+
         if (typeof agg.options?.cursor?.transform === 'function') {
           c._transforms.push(agg.options.cursor.transform);
         }
@@ -84,6 +94,38 @@ function _init(model, c, agg) {
   }
 }
 
+/**
+* Handles error emitted from pre middleware. In particular, checks for `skipWrappedFunction`, which allows skipping
+* the actual aggregation and overwriting the function's return value. Because aggregation cursors don't return a value,
+* we need to make sure the user doesn't accidentally set a value in skipWrappedFunction.
+*
+* @param {QueryCursor} queryCursor
+* @param {Error} err
+* @returns
+*/
+
+function _handlePreHookError(queryCursor, err) {
+  if (err instanceof kareem.skipWrappedFunction) {
+    const resultValue = err.args[0];
+    if (resultValue != null && (!Array.isArray(resultValue) || resultValue.length)) {
+      const err = new MongooseError(
+        'Cannot `skipMiddlewareFunction()` with a value when using ' +
+        '`.aggregate().cursor()`, value must be nullish or empty array, got "' +
+        util.inspect(resultValue) +
+        '".'
+      );
+      queryCursor._markError(err);
+      queryCursor.listeners('error').length > 0 && queryCursor.emit('error', err);
+      return;
+    }
+    queryCursor.emit('cursor', null);
+    return;
+  }
+  queryCursor._markError(err);
+  queryCursor.listeners('error').length > 0 && queryCursor.emit('error', err);
+}
+
+
 /**
  * Necessary to satisfy the Readable API
  * @method _read
@@ -424,6 +466,7 @@ function _next(ctx, cb) {
       err => callback(err)
     );
   } else {
+    ctx.once('error', cb);
     ctx.once('cursor', function() {
       _next(ctx, cb);
     });

package/lib/document.js

@@ -747,8 +747,8 @@ function init(self, obj, doc, opts, prefix) {
   for (let index = 0; index < len; ++index) {
     i = keys[index];
     // avoid prototype pollution
-    if (i === '__proto__' || i === 'constructor') {
-      return;
+    if (specialProperties.has(i)) {
+      continue;
     }
     path = prefix ? prefix + i : i;
     schemaType = docSchema.path(path);
@@ -756,7 +756,7 @@ function init(self, obj, doc, opts, prefix) {
     // necessary. This is *only* to catch the case where we queried using the
     // base model and the discriminated model has a projection
     if (docSchema.$isRootDiscriminator && !self.$__isSelected(path)) {
-      return;
+      continue;
     }
 
     const value = obj[i];
@@ -1720,7 +1720,7 @@ Document.prototype.$__set = function(pathToMark, path, options, constructing, pa
     const last = next === l;
     cur += (cur ? '.' + parts[i] : parts[i]);
     if (specialProperties.has(parts[i])) {
-      return;
+      continue;
     }
 
     if (last) {

package/lib/helpers/populate/getSchemaTypes.js

@@ -178,8 +178,8 @@ module.exports = function getSchemaTypes(model, schema, doc, path) {
       }
 
       const fullPath = nestedPath.concat([trypath]).join('.');
-      if (topLevelDoc != null && topLevelDoc.$__ && topLevelDoc.$populated(fullPath) && p < parts.length) {
-        const model = doc.$__.populated[fullPath].options[populateModelSymbol];
+      if (topLevelDoc != null && topLevelDoc.$__ && topLevelDoc.$populated(fullPath, true) && p < parts.length) {
+        const model = topLevelDoc.$populated(fullPath, true).options[populateModelSymbol];
         if (model != null) {
           const ret = search(
             parts.slice(p),

package/lib/model.js

@@ -3603,7 +3603,7 @@ Model.bulkSave = async function bulkSave(documents, options) {
   }
   await Promise.all(successfulDocuments.map(document => handleSuccessfulWrite(document)));
 
-  if (bulkWriteError && bulkWriteError.writeErrors && bulkWriteError.writeErrors.length) {
+  if (bulkWriteError != null) {
     throw bulkWriteError;
   }
 

package/lib/mongoose.js

@@ -179,6 +179,10 @@ Mongoose.prototype.setDriver = function setDriver(driver) {
     }
   }
 
+  if (driver.SchemaTypes != null) {
+    Object.assign(mongoose.Schema.Types, driver.SchemaTypes);
+  }
+
   const Connection = driver.Connection;
   const oldDefaultConnection = _mongoose.connections[0];
   _mongoose.connections = [new Connection(_mongoose)];

package/lib/schema/date.js

@@ -150,7 +150,7 @@ SchemaDate._defaultCaster = v => {
  *     // expire in 24 hours
  *     new Schema({ createdAt: { type: Date, expires: 60*60*24 }});
  *
- * `expires` utilizes the `ms` module from [guille](https://github.com/guille/) allowing us to use a friendlier syntax:
+ * `expires` utilizes the `ms` module from [vercel](https://github.com/vercel/ms) allowing us to use a friendlier syntax:
  *
  * #### Example:
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.12.1",
+  "version": "8.13.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -22,7 +22,7 @@
   "dependencies": {
     "bson": "^6.10.3",
     "kareem": "2.6.3",
-    "mongodb": "~6.14.0",
+    "mongodb": "~6.15.0",
     "mpath": "0.9.0",
     "mquery": "5.0.0",
     "ms": "2.1.3",

package/types/indexes.d.ts

@@ -68,7 +68,7 @@ declare module 'mongoose' {
 
   type IndexOptions = Omit<mongodb.CreateIndexesOptions, 'expires' | 'weights' | 'unique'> & {
     /**
-     * `expires` utilizes the `ms` module from [guille](https://github.com/guille/) allowing us to use a friendlier syntax:
+     * `expires` utilizes the `ms` module from [vercel](https://github.com/vercel/ms) allowing us to use a friendlier syntax:
      *
      * @example
      * ```js

package/types/utility.d.ts

@@ -93,4 +93,12 @@ type AddThisParameter<T, D> = {
     : T[K];
 };
 
+  /**
+   * @summary Adds timestamp fields to a type
+   * @description Adds createdAt and updatedAt fields of type Date, or custom timestamp fields if specified
+   * @param {T} T The type to add timestamp fields to
+   * @param {P} P Optional SchemaTimestampsConfig or boolean to customize timestamp field names
+   * @returns T with timestamp fields added
+   */
+  export type WithTimestamps<T, P extends SchemaTimestampsConfig | boolean = true> = ResolveTimestamps<T, { timestamps: P }>;
 }