mongoose 8.13.2 → 8.13.3

package/lib/error/index.js

@@ -65,32 +65,32 @@ MongooseError.messages = require('./messages');
 MongooseError.Messages = MongooseError.messages;
 
 /**
- * An instance of this error class will be returned when `save()` fails
- * because the underlying
- * document was not found. The constructor takes one parameter, the
- * conditions that mongoose passed to `updateOne()` when trying to update
- * the document.
+ * An instance of this error class will be thrown when mongoose failed to
+ * cast a value.
  *
  * @api public
  * @memberOf Error
  * @static
  */
 
-MongooseError.DocumentNotFoundError = require('./notFound');
+MongooseError.CastError = require('./cast');
 
 /**
- * An instance of this error class will be returned when mongoose failed to
- * cast a value.
+ * An instance of this error class will be thrown when `save()` fails
+ * because the underlying
+ * document was not found. The constructor takes one parameter, the
+ * conditions that mongoose passed to `updateOne()` when trying to update
+ * the document.
  *
  * @api public
  * @memberOf Error
  * @static
  */
 
-MongooseError.CastError = require('./cast');
+MongooseError.DocumentNotFoundError = require('./notFound');
 
 /**
- * An instance of this error class will be returned when [validation](https://mongoosejs.com/docs/validation.html) failed.
+ * An instance of this error class will be thrown when [validation](https://mongoosejs.com/docs/validation.html) failed.
  * The `errors` property contains an object whose keys are the paths that failed and whose values are
  * instances of CastError or ValidationError.
  *
@@ -137,7 +137,7 @@ MongooseError.ValidationError = require('./validation');
 MongooseError.ValidatorError = require('./validator');
 
 /**
- * An instance of this error class will be returned when you call `save()` after
+ * An instance of this error class will be thrown when you call `save()` after
  * the document in the database was changed in a potentially unsafe way. See
  * the [`versionKey` option](https://mongoosejs.com/docs/guide.html#versionKey) for more information.
  *
@@ -149,7 +149,7 @@ MongooseError.ValidatorError = require('./validator');
 MongooseError.VersionError = require('./version');
 
 /**
- * An instance of this error class will be returned when you call `save()` multiple
+ * An instance of this error class will be thrown when you call `save()` multiple
  * times on the same document in parallel. See the [FAQ](https://mongoosejs.com/docs/faq.html) for more
  * information.
  *
@@ -181,6 +181,16 @@ MongooseError.OverwriteModelError = require('./overwriteModel');
 
 MongooseError.MissingSchemaError = require('./missingSchema');
 
+/**
+ * Thrown when some documents failed to save when calling `bulkSave()`
+ *
+ * @api public
+ * @memberOf Error
+ * @static
+ */
+
+MongooseError.MongooseBulkSaveIncompleteError = require('./bulkSaveIncompleteError');
+
 /**
  * Thrown when the MongoDB Node driver can't connect to a valid server
  * to send an operation to.
@@ -193,7 +203,7 @@ MongooseError.MissingSchemaError = require('./missingSchema');
 MongooseError.MongooseServerSelectionError = require('./serverSelection');
 
 /**
- * An instance of this error will be returned if you used an array projection
+ * An instance of this error will be thrown if you used an array projection
  * and then modified the array in an unsafe way.
  *
  * @api public

package/lib/query.js

@@ -3096,13 +3096,12 @@ function _handleSortValue(val, key) {
  *
  *     await Character.deleteOne({ name: 'Eddard Stark' });
  *
- * This function calls the MongoDB driver's [`Collection#deleteOne()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteOne).
+ * This function calls the MongoDB driver's [`Collection#deleteOne()` function](https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteOne).
  * The returned [promise](https://mongoosejs.com/docs/queries.html) resolves to an
- * object that contains 3 properties:
+ * object that contains 2 properties:
  *
- * - `ok`: `1` if no errors occurred
+ * - `acknowledged`: boolean
  * - `deletedCount`: the number of documents deleted
- * - `n`: the number of documents deleted. Equal to `deletedCount`.
  *
  * #### Example:
  *
@@ -3113,8 +3112,8 @@ function _handleSortValue(val, key) {
  * @param {Object|Query} [filter] mongodb selector
  * @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
+ * @see DeleteResult https://mongodb.github.io/node-mongodb-native/6.15/interfaces/DeleteResult.html
+ * @see deleteOne https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteOne
  * @api public
  */
 
@@ -3169,13 +3168,12 @@ Query.prototype._deleteOne = async function _deleteOne() {
  *
  *     await Character.deleteMany({ name: /Stark/, age: { $gte: 18 } });
  *
- * This function calls the MongoDB driver's [`Collection#deleteMany()` function](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#deleteMany).
+ * This function calls the MongoDB driver's [`Collection#deleteMany()` function](https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteMany).
  * The returned [promise](https://mongoosejs.com/docs/queries.html) resolves to an
- * object that contains 3 properties:
+ * object that contains 2 properties:
  *
- * - `ok`: `1` if no errors occurred
+ * - `acknowledged`: boolean
  * - `deletedCount`: the number of documents deleted
- * - `n`: the number of documents deleted. Equal to `deletedCount`.
  *
  * #### Example:
  *
@@ -3186,8 +3184,8 @@ Query.prototype._deleteOne = async function _deleteOne() {
  * @param {Object|Query} [filter] mongodb selector
  * @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
+ * @see DeleteResult https://mongodb.github.io/node-mongodb-native/6.15/interfaces/DeleteResult.html
+ * @see deleteMany https://mongodb.github.io/node-mongodb-native/6.15/classes/Collection.html#deleteMany
  * @api public
  */
 

package/lib/utils.js

@@ -234,6 +234,38 @@ exports.omit = function omit(obj, keys) {
   return ret;
 };
 
+/**
+ * Simplified version of `clone()` that only clones POJOs and arrays. Skips documents, dates, objectids, etc.
+ * @param {*} val
+ * @returns
+*/
+
+exports.clonePOJOsAndArrays = function clonePOJOsAndArrays(val) {
+  if (val == null) {
+    return val;
+  }
+  // Skip documents because we assume they'll be cloned later. See gh-15312 for how documents are handled with `merge()`.
+  if (val.$__ != null) {
+    return val;
+  }
+  if (isPOJO(val)) {
+    val = { ...val };
+    for (const key of Object.keys(val)) {
+      val[key] = exports.clonePOJOsAndArrays(val[key]);
+    }
+    return val;
+  }
+  if (Array.isArray(val)) {
+    val = [...val];
+    for (let i = 0; i < val.length; ++i) {
+      val[i] = exports.clonePOJOsAndArrays(val[i]);
+    }
+    return val;
+  }
+
+  return val;
+};
+
 /**
  * Merges `from` into `to` without overwriting existing properties.
  *
@@ -271,13 +303,7 @@ exports.merge = function merge(to, from, options, path) {
       continue;
     }
     if (to[key] == null) {
-      if (isPOJO(from[key])) {
-        to[key] = { ...from[key] };
-      } else if (Array.isArray(from[key])) {
-        to[key] = [...from[key]];
-      } else {
-        to[key] = from[key];
-      }
+      to[key] = exports.clonePOJOsAndArrays(from[key]);
     } else if (exports.isObject(from[key])) {
       if (!exports.isObject(to[key])) {
         to[key] = {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "8.13.2",
+  "version": "8.13.3",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",

package/types/aggregate.d.ts

@@ -124,7 +124,7 @@ declare module 'mongoose' {
     pipeline(): PipelineStage[];
 
     /** Appends a new $project operator to this aggregate pipeline. */
-    project(arg: PipelineStage.Project['$project']): this;
+    project(arg: PipelineStage.Project['$project'] | string): this;
 
     /** Sets the readPreference option for the aggregation query. */
     read(pref: mongodb.ReadPreferenceLike): this;

package/types/connection.d.ts

@@ -58,12 +58,34 @@ declare module 'mongoose' {
     sanitizeFilter?: boolean;
   }
 
+  export type AnyConnectionBulkWriteModel<TSchema extends AnyObject> = Omit<mongodb.ClientInsertOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientReplaceOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientUpdateOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientUpdateManyModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientDeleteOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientDeleteManyModel<TSchema>, 'namespace'>;
+
+  export type ConnectionBulkWriteModel<SchemaMap extends Record<string, AnyObject> = Record<string, AnyObject>> = {
+      [ModelName in keyof SchemaMap]: AnyConnectionBulkWriteModel<SchemaMap[ModelName]> & {
+          model: ModelName;
+      };
+  }[keyof SchemaMap];
+
   class Connection extends events.EventEmitter implements SessionStarter {
     aggregate<ResultType = unknown>(pipeline?: PipelineStage[] | null, options?: AggregateOptions): Aggregate<Array<ResultType>>;
 
     /** Returns a promise that resolves when this connection successfully connects to MongoDB */
     asPromise(): Promise<this>;
 
+    bulkWrite<TSchemaMap extends Record<string, AnyObject>>(
+      ops: Array<ConnectionBulkWriteModel<TSchemaMap>>,
+      options: mongodb.ClientBulkWriteOptions & { ordered: false }
+    ): Promise<mongodb.ClientBulkWriteResult & { mongoose?: { validationErrors: Error[], results: Array<Error | mongodb.WriteError | null> } }>;
+    bulkWrite<TSchemaMap extends Record<string, AnyObject>>(
+      ops: Array<ConnectionBulkWriteModel<TSchemaMap>>,
+      options?: mongodb.ClientBulkWriteOptions
+    ): Promise<mongodb.ClientBulkWriteResult>;
+
     /** Closes the connection */
     close(force?: boolean): Promise<void>;
 

package/types/error.d.ts

@@ -129,5 +129,12 @@ declare module 'mongoose' {
       name: 'StrictPopulateError';
       path: string;
     }
+
+    export class MongooseBulkSaveIncompleteError extends MongooseError {
+      name: 'MongooseBulkSaveIncompleteError';
+      modelName: string;
+      bulkWriteResult: mongodb.BulkWriteResult;
+      numDocumentsNotUpdated: number;
+    }
   }
 }