mongoose 6.5.5 → 6.6.0

package/index.js

@@ -1,4 +1,3 @@
-
 /**
  * Export lib/mongoose
  *
@@ -11,3 +10,54 @@ const mongoose = require('./lib/');
 module.exports = mongoose;
 module.exports.default = mongoose;
 module.exports.mongoose = mongoose;
+
+// Re-export for ESM support
+module.exports.cast = mongoose.cast;
+module.exports.STATES = mongoose.STATES;
+module.exports.setDriver = mongoose.setDriver;
+module.exports.set = mongoose.set;
+module.exports.get = mongoose.get;
+module.exports.createConnection = mongoose.createConnection;
+module.exports.connect = mongoose.connect;
+module.exports.disconnect = mongoose.disconnect;
+module.exports.startSession = mongoose.startSession;
+module.exports.pluralize = mongoose.pluralize;
+module.exports.model = mongoose.model;
+module.exports.deleteModel = mongoose.deleteModel;
+module.exports.modelNames = mongoose.modelNames;
+module.exports.plugin = mongoose.plugin;
+module.exports.connections = mongoose.connections;
+module.exports.version = mongoose.version;
+module.exports.Mongoose = mongoose.Mongoose;
+module.exports.Schema = mongoose.Schema;
+module.exports.SchemaType = mongoose.SchemaType;
+module.exports.SchemaTypes = mongoose.SchemaTypes;
+module.exports.VirtualType = mongoose.VirtualType;
+module.exports.Types = mongoose.Types;
+module.exports.Query = mongoose.Query;
+module.exports.Promise = mongoose.Promise;
+module.exports.Model = mongoose.Model;
+module.exports.Document = mongoose.Document;
+module.exports.ObjectId = mongoose.ObjectId;
+module.exports.isValidObjectId = mongoose.isValidObjectId;
+module.exports.isObjectIdOrHexString = mongoose.isObjectIdOrHexString;
+module.exports.syncIndexes = mongoose.syncIndexes;
+module.exports.Decimal128 = mongoose.Decimal128;
+module.exports.Mixed = mongoose.Mixed;
+module.exports.Date = mongoose.Date;
+module.exports.Number = mongoose.Number;
+module.exports.Error = mongoose.Error;
+module.exports.now = mongoose.now;
+module.exports.CastError = mongoose.CastError;
+module.exports.SchemaTypeOptions = mongoose.SchemaTypeOptions;
+module.exports.mongo = mongoose.mongo;
+module.exports.mquery = mongoose.mquery;
+module.exports.sanitizeFilter = mongoose.sanitizeFilter;
+module.exports.trusted = mongoose.trusted;
+module.exports.skipMiddlewareFunction = mongoose.skipMiddlewareFunction;
+module.exports.overwriteMiddlewareResult = mongoose.overwriteMiddlewareResult;
+
+// The following properties are not exported using ESM because `setDriver()` can mutate these
+// module.exports.connection = mongoose.connection;
+// module.exports.Collection = mongoose.Collection;
+// module.exports.Connection = mongoose.Connection;

package/lib/aggregate.js

@@ -304,6 +304,30 @@ Aggregate.prototype.project = function(arg) {
  * @api public
  */
 
+
+/**
+ * Appends a new $densify operator to this aggregate pipeline.
+ *
+ * #### Examples:
+ *
+ *      aggregate.densify({
+ *        field: 'timestamp',
+ *        range: {
+ *          step: 1,
+ *          unit: 'hour',
+ *          bounds: [new Date('2021-05-18T00:00:00.000Z'), new Date('2021-05-18T08:00:00.000Z')]
+ *        }
+ *      });
+ *
+ * @see $densify https://www.mongodb.com/docs/manual/reference/operator/aggregation/densify/
+ * @method densify
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg $densify operator contents
+ * @return {Aggregate}
+ * @api public
+ */
+
 /**
  * Appends a new $geoNear operator to this aggregate pipeline.
  *
@@ -342,7 +366,7 @@ Aggregate.prototype.near = function(arg) {
  * define methods
  */
 
-'group match skip limit out'.split(' ').forEach(function($operator) {
+'group match skip limit out densify'.split(' ').forEach(function($operator) {
   Aggregate.prototype[$operator] = function(arg) {
     const op = {};
     op['$' + $operator] = arg;
@@ -1049,7 +1073,7 @@ Aggregate.prototype.catch = function(reject) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *

package/lib/connection.js

@@ -81,7 +81,7 @@ function Connection(base) {
  * Inherit from EventEmitter
  */
 
-Connection.prototype.__proto__ = EventEmitter.prototype;
+Object.setPrototypeOf(Connection.prototype, EventEmitter.prototype);
 
 /**
  * Connection ready state

package/lib/cursor/AggregationCursor.js

@@ -231,7 +231,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
 };
 
 /**
- * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+ * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *

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

@@ -34,7 +34,7 @@ function NativeCollection(name, conn, options) {
  * Inherit from abstract Collection.
  */
 
-NativeCollection.prototype.__proto__ = MongooseCollection.prototype;
+Object.setPrototypeOf(NativeCollection.prototype, MongooseCollection.prototype);
 
 /**
  * Called when the connection opens.

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

@@ -32,7 +32,7 @@ NativeConnection.STATES = STATES;
  * Inherits from Connection.
  */
 
-NativeConnection.prototype.__proto__ = MongooseConnection.prototype;
+Object.setPrototypeOf(NativeConnection.prototype, MongooseConnection.prototype);
 
 /**
  * Switches to a different database using the same connection pool.

package/lib/helpers/cursor/eachAsync.js

@@ -16,6 +16,9 @@ const promiseOrCallback = require('../promiseOrCallback');
  * @param {Function} next the thunk to call to get the next document
  * @param {Function} fn
  * @param {Object} options
+ * @param {Number} [options.batchSize=null] if set, Mongoose will call `fn` with an array of at most `batchSize` documents, instead of a single document
+ * @param {Number} [options.parallel=1] maximum number of `fn` calls that Mongoose will run in parallel
+ * @param {AbortSignal} [options.signal] allow cancelling this eachAsync(). Once the abort signal is fired, `eachAsync()` will immediately fulfill the returned promise (or call the callback) and not fetch any more documents.
  * @param {Function} [callback] executed when all docs have been processed
  * @return {Promise}
  * @api public
@@ -25,11 +28,25 @@ const promiseOrCallback = require('../promiseOrCallback');
 module.exports = function eachAsync(next, fn, options, callback) {
   const parallel = options.parallel || 1;
   const batchSize = options.batchSize;
+  const signal = options.signal;
   const continueOnError = options.continueOnError;
   const aggregatedErrors = [];
   const enqueue = asyncQueue();
 
+  let drained = false;
+
   return promiseOrCallback(callback, cb => {
+    if (signal != null) {
+      if (signal.aborted) {
+        return cb(null);
+      }
+
+      signal.addEventListener('abort', () => {
+        drained = true;
+        return cb(null);
+      }, { once: true });
+    }
+
     if (batchSize != null) {
       if (typeof batchSize !== 'number') {
         throw new TypeError('batchSize must be a number');
@@ -44,7 +61,6 @@ module.exports = function eachAsync(next, fn, options, callback) {
   });
 
   function iterate(finalCallback) {
-    let drained = false;
     let handleResultsInProgress = 0;
     let currentDocumentIndex = 0;
     let documentsBatch = [];

package/lib/index.js

@@ -115,6 +115,7 @@ function Mongoose(options) {
     ]
   });
 }
+
 Mongoose.prototype.cast = cast;
 /**
  * Expose connection states for user-land

package/lib/model.js

@@ -127,7 +127,7 @@ function Model(doc, fields, skipId) {
  * @api private
  */
 
-Model.prototype.__proto__ = Document.prototype;
+Object.setPrototypeOf(Model.prototype, Document.prototype);
 Model.prototype.$isMongooseModelPrototype = true;
 
 /**
@@ -1230,7 +1230,7 @@ Model.discriminator = function(name, schema, options) {
   model = this.db.model(model || name, schema, this.$__collection.name);
   this.discriminators[name] = model;
   const d = this.discriminators[name];
-  d.prototype.__proto__ = this.prototype;
+  Object.setPrototypeOf(d.prototype, this.prototype);
   Object.defineProperty(d, 'baseModelName', {
     value: this.modelName,
     configurable: true,
@@ -3771,12 +3771,15 @@ Model.applyDefaults = function applyDefaults(doc) {
  *     Test.castObject({ num: 'not a number' }); // Throws a ValidationError
  *
  * @param {Object} obj object or document to cast
+ * @param {Object} options options passed to castObject
+ * @param {Boolean} options.ignoreCastErrors If set to `true` will not throw a ValidationError and only return values that were successfully cast.
  * @returns {Object} POJO casted to the model's schema
  * @throws {ValidationError} if casting failed for at least one path
  * @api public
  */
 
-Model.castObject = function castObject(obj) {
+Model.castObject = function castObject(obj, options) {
+  options = options || {};
   const ret = {};
 
   const schema = this.schema;
@@ -3822,8 +3825,10 @@ Model.castObject = function castObject(obj) {
       try {
         val = Model.castObject.call(schemaType.caster, val);
       } catch (err) {
-        error = error || new ValidationError();
-        error.addError(path, err);
+        if (!options.ignoreCastErrors) {
+          error = error || new ValidationError();
+          error.addError(path, err);
+        }
         continue;
       }
 
@@ -3835,8 +3840,10 @@ Model.castObject = function castObject(obj) {
       val = schemaType.cast(val);
       cur[pieces[pieces.length - 1]] = val;
     } catch (err) {
-      error = error || new ValidationError();
-      error.addError(path, err);
+      if (!options.ignoreCastErrors) {
+        error = error || new ValidationError();
+        error.addError(path, err);
+      }
 
       continue;
     }
@@ -5010,8 +5017,8 @@ Model.compile = function compile(name, schema, collectionName, connection, base)
   model.modelName = name;
 
   if (!(model.prototype instanceof Model)) {
-    model.__proto__ = Model;
-    model.prototype.__proto__ = Model.prototype;
+    Object.setPrototypeOf(model, Model);
+    Object.setPrototypeOf(model.prototype, Model.prototype);
   }
   model.model = function model(name) {
     return this.db.model(name);
@@ -5108,8 +5115,8 @@ Model.__subclass = function subclass(conn, schema, collection) {
     _this.call(this, doc, fields, skipId);
   };
 
-  Model.__proto__ = _this;
-  Model.prototype.__proto__ = _this.prototype;
+  Object.setPrototypeOf(Model, _this);
+  Object.setPrototypeOf(Model.prototype, _this.prototype);
   Model.db = conn;
   Model.prototype.db = conn;
   Model.prototype[modelDbSymbol] = conn;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.5.5",
+  "version": "6.6.0",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -21,7 +21,7 @@
   "dependencies": {
     "bson": "^4.6.5",
     "kareem": "2.4.1",
-    "mongodb": "4.8.1",
+    "mongodb": "4.9.1",
     "mpath": "0.9.0",
     "mquery": "4.0.3",
     "ms": "2.1.3",

package/types/aggregate.d.ts

@@ -28,6 +28,7 @@ declare module 'mongoose' {
      *  Specifies the initial batch size for the cursor. The value of the cursor field is a document with the field batchSize.
      */
     cursor?: { batchSize?: number; };
+
     /**
      * Specifies to return the information on the processing of the pipeline. See Return Information on Aggregation Pipeline Operation for an example.
      *
@@ -69,7 +70,7 @@ declare module 'mongoose' {
 
   class Aggregate<R> implements SessionOperation {
     /**
-     * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js
+     * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
      * You do not need to call this function explicitly, the JavaScript runtime
      * will call it for you.
      */
@@ -110,11 +111,15 @@ declare module 'mongoose' {
     /** Appends a new $count operator to this aggregate pipeline. */
     count(fieldName: PipelineStage.Count['$count']): this;
 
+    /** Appends a new $densify operator to this aggregate pipeline */
+    densify(arg: PipelineStage.Densify['$densify']): this;
+
     /**
      * Sets the cursor option for the aggregation query
      */
     cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>;
 
+
     /** Executes the aggregate pipeline on the currently bound Model. */
     exec(callback: Callback<R>): void;
     exec(): Promise<R>;

package/types/models.d.ts

@@ -137,7 +137,7 @@ declare module 'mongoose' {
     baseModelName: string | undefined;
 
     /* Cast the given POJO to the model's schema */
-    castObject(obj: AnyObject): T;
+    castObject(obj: AnyObject, options?: { ignoreCastErrors?: boolean }): T;
 
     /**
      * Sends multiple `insertOne`, `updateOne`, `updateMany`, `replaceOne`,

package/types/pipelinestage.d.ts

@@ -76,6 +76,19 @@ declare module 'mongoose' {
       $count: string;
     }
 
+    export interface Densify{
+      /** [`$densify` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/densify/) */
+      $densify: {
+        field: string,
+        partitionByFields?: string[],
+        range: {
+          step: number,
+          unit?: 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year',
+          bounds: number[] | globalThis.Date[] | 'full' | 'partition'
+        }
+      }
+    }
+
     export interface Facet {
       /** [`$facet` reference](https://docs.mongodb.com/manual/reference/operator/aggregation/facet/) */
       $facet: Record<string, FacetPipelineStage[]>;