@depup/mongoose 9.1.3-depup.0

package/lib/aggregate.js

@@ -0,0 +1,1189 @@
+'use strict';
+
+/*!
+ * Module dependencies
+ */
+
+const AggregationCursor = require('./cursor/aggregationCursor');
+const MongooseError = require('./error/mongooseError');
+const Query = require('./query');
+const { applyGlobalMaxTimeMS, applyGlobalDiskUse } = require('./helpers/query/applyGlobalOption');
+const clone = require('./helpers/clone');
+const getConstructorName = require('./helpers/getConstructorName');
+const prepareDiscriminatorPipeline = require('./helpers/aggregate/prepareDiscriminatorPipeline');
+const stringifyFunctionOperators = require('./helpers/aggregate/stringifyFunctionOperators');
+const utils = require('./utils');
+const { modelSymbol } = require('./helpers/symbols');
+const read = Query.prototype.read;
+const readConcern = Query.prototype.readConcern;
+
+const validRedactStringValues = new Set(['$$DESCEND', '$$PRUNE', '$$KEEP']);
+
+/**
+ * Aggregate constructor used for building aggregation pipelines. Do not
+ * instantiate this class directly, use [Model.aggregate()](https://mongoosejs.com/docs/api/model.html#Model.aggregate()) instead.
+ *
+ * #### Example:
+ *
+ *     const aggregate = Model.aggregate([
+ *       { $project: { a: 1, b: 1 } },
+ *       { $skip: 5 }
+ *     ]);
+ *
+ *     Model.
+ *       aggregate([{ $match: { age: { $gte: 21 }}}]).
+ *       unwind('tags').
+ *       exec();
+ *
+ * #### Note:
+ *
+ * - The documents returned are plain javascript objects, not mongoose documents (since any shape of document can be returned).
+ * - Mongoose does **not** cast pipeline stages. The below will **not** work unless `_id` is a string in the database
+ *
+ *     new Aggregate([{ $match: { _id: '00000000000000000000000a' } }]);
+ *     // Do this instead to cast to an ObjectId
+ *     new Aggregate([{ $match: { _id: new mongoose.Types.ObjectId('00000000000000000000000a') } }]);
+ *
+ * @see MongoDB https://www.mongodb.com/docs/manual/applications/aggregation/
+ * @see driver https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#aggregate
+ * @param {Array} [pipeline] aggregation pipeline as an array of objects
+ * @param {Model|Connection} [modelOrConn] the model or connection to use with this aggregate.
+ * @api public
+ */
+
+function Aggregate(pipeline, modelOrConn) {
+  this._pipeline = [];
+  if (modelOrConn == null || modelOrConn[modelSymbol]) {
+    this._model = modelOrConn;
+  } else {
+    this._connection = modelOrConn;
+  }
+  this.options = {};
+
+  if (arguments.length === 1 && Array.isArray(pipeline)) {
+    this.append.apply(this, pipeline);
+  }
+}
+
+/**
+ * Contains options passed down to the [aggregate command](https://www.mongodb.com/docs/manual/reference/command/aggregate/).
+ * Supported options are:
+ *
+ * - [`allowDiskUse`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.allowDiskUse())
+ * - `bypassDocumentValidation`
+ * - [`collation`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.collation())
+ * - `comment`
+ * - [`cursor`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.cursor())
+ * - [`explain`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.explain())
+ * - `fieldsAsRaw`
+ * - [`hint`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.hint())
+ * - `let`
+ * - `maxTimeMS`
+ * - `raw`
+ * - [`readConcern`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.readConcern())
+ * - `readPreference`
+ * - [`session`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.session())
+ * - `writeConcern`
+ *
+ * @property options
+ * @memberOf Aggregate
+ * @api public
+ */
+
+Aggregate.prototype.options;
+
+/**
+ * Returns default options for this aggregate.
+ *
+ * @param {Model} model
+ * @api private
+ */
+
+Aggregate.prototype._optionsForExec = function() {
+  const options = this.options || {};
+
+  const asyncLocalStorage = this.model()?.db?.base.transactionAsyncLocalStorage?.getStore();
+  if (!Object.hasOwn(options, 'session') && asyncLocalStorage?.session != null) {
+    options.session = asyncLocalStorage.session;
+  }
+
+  return options;
+};
+
+/**
+ * Get/set the model that this aggregation will execute on.
+ *
+ * #### Example:
+ *
+ *     const aggregate = MyModel.aggregate([{ $match: { answer: 42 } }]);
+ *     aggregate.model() === MyModel; // true
+ *
+ *     // Change the model. There's rarely any reason to do this.
+ *     aggregate.model(SomeOtherModel);
+ *     aggregate.model() === SomeOtherModel; // true
+ *
+ * @param {Model} [model] Set the model associated with this aggregate. If not provided, returns the already stored model.
+ * @return {Model}
+ * @api public
+ */
+
+Aggregate.prototype.model = function(model) {
+  if (arguments.length === 0) {
+    return this._model;
+  }
+
+  this._model = model;
+  if (model.schema != null) {
+    if (this.options.readPreference == null &&
+      model.schema.options.read != null) {
+      this.options.readPreference = model.schema.options.read;
+    }
+    if (this.options.collation == null &&
+      model.schema.options.collation != null) {
+      this.options.collation = model.schema.options.collation;
+    }
+  }
+
+  return model;
+};
+
+/**
+ * Appends new operators to this aggregate pipeline
+ *
+ * #### Example:
+ *
+ *     aggregate.append({ $project: { field: 1 }}, { $limit: 2 });
+ *
+ *     // or pass an array
+ *     const pipeline = [{ $match: { daw: 'Logic Audio X' }} ];
+ *     aggregate.append(pipeline);
+ *
+ * @param {...Object|Object[]} ops operator(s) to append. Can either be a spread of objects or a single parameter of a object array.
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.append = function() {
+  const args = (arguments.length === 1 && Array.isArray(arguments[0]))
+    ? arguments[0]
+    : [...arguments];
+
+  if (!args.every(isOperator)) {
+    throw new Error('Arguments must be aggregate pipeline operators');
+  }
+
+  this._pipeline = this._pipeline.concat(args);
+
+  return this;
+};
+
+/**
+ * Appends a new $addFields operator to this aggregate pipeline.
+ * Requires MongoDB v3.4+ to work
+ *
+ * #### Example:
+ *
+ *     // adding new fields based on existing fields
+ *     aggregate.addFields({
+ *         newField: '$b.nested'
+ *       , plusTen: { $add: ['$val', 10]}
+ *       , sub: {
+ *            name: '$a'
+ *         }
+ *     })
+ *
+ *     // etc
+ *     aggregate.addFields({ salary_k: { $divide: [ "$salary", 1000 ] } });
+ *
+ * @param {Object} arg field specification
+ * @see $addFields https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/
+ * @return {Aggregate}
+ * @api public
+ */
+Aggregate.prototype.addFields = function(arg) {
+  if (typeof arg !== 'object' || arg === null || Array.isArray(arg)) {
+    throw new Error('Invalid addFields() argument. Must be an object');
+  }
+  return this.append({ $addFields: Object.assign({}, arg) });
+};
+
+/**
+ * Appends a new $project operator to this aggregate pipeline.
+ *
+ * Mongoose query [selection syntax](https://mongoosejs.com/docs/api/query.html#Query.prototype.select()) is also supported.
+ *
+ * #### Example:
+ *
+ *     // include a, include b, exclude _id
+ *     aggregate.project("a b -_id");
+ *
+ *     // or you may use object notation, useful when
+ *     // you have keys already prefixed with a "-"
+ *     aggregate.project({a: 1, b: 1, _id: 0});
+ *
+ *     // reshaping documents
+ *     aggregate.project({
+ *         newField: '$b.nested'
+ *       , plusTen: { $add: ['$val', 10]}
+ *       , sub: {
+ *            name: '$a'
+ *         }
+ *     })
+ *
+ *     // etc
+ *     aggregate.project({ salary_k: { $divide: [ "$salary", 1000 ] } });
+ *
+ * @param {Object|String} arg field specification
+ * @see projection https://www.mongodb.com/docs/manual/reference/aggregation/project/
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.project = function(arg) {
+  const fields = {};
+
+  if (typeof arg === 'object' && !Array.isArray(arg)) {
+    Object.keys(arg).forEach(function(field) {
+      fields[field] = arg[field];
+    });
+  } else if (arguments.length === 1 && typeof arg === 'string') {
+    arg.split(/\s+/).forEach(function(field) {
+      if (!field) {
+        return;
+      }
+      const include = field[0] === '-' ? 0 : 1;
+      if (include === 0) {
+        field = field.substring(1);
+      }
+      fields[field] = include;
+    });
+  } else {
+    throw new Error('Invalid project() argument. Must be string or object');
+  }
+
+  return this.append({ $project: fields });
+};
+
+/**
+ * Appends a new custom $group operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.group({ _id: "$department" });
+ *
+ * @see $group https://www.mongodb.com/docs/manual/reference/aggregation/group/
+ * @method group
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg $group operator contents
+ * @return {Aggregate}
+ * @api public
+ */
+
+/**
+ * Appends a new custom $match operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.match({ department: { $in: [ "sales", "engineering" ] } });
+ *
+ * @see $match https://www.mongodb.com/docs/manual/reference/aggregation/match/
+ * @method match
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg $match operator contents
+ * @return {Aggregate}
+ * @api public
+ */
+
+/**
+ * Appends a new $skip operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.skip(10);
+ *
+ * @see $skip https://www.mongodb.com/docs/manual/reference/aggregation/skip/
+ * @method skip
+ * @memberOf Aggregate
+ * @instance
+ * @param {Number} num number of records to skip before next stage
+ * @return {Aggregate}
+ * @api public
+ */
+
+/**
+ * Appends a new $limit operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.limit(10);
+ *
+ * @see $limit https://www.mongodb.com/docs/manual/reference/aggregation/limit/
+ * @method limit
+ * @memberOf Aggregate
+ * @instance
+ * @param {Number} num maximum number of records to pass to the next stage
+ * @return {Aggregate}
+ * @api public
+ */
+
+
+/**
+ * Appends a new $densify operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *      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 $fill operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *      aggregate.fill({
+ *        output: {
+ *          bootsSold: { value: 0 },
+ *          sandalsSold: { value: 0 },
+ *          sneakersSold: { value: 0 }
+ *        }
+ *      });
+ *
+ * @see $fill https://www.mongodb.com/docs/manual/reference/operator/aggregation/fill/
+ * @method fill
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg $fill operator contents
+ * @return {Aggregate}
+ * @api public
+ */
+
+/**
+ * Appends a new $geoNear operator to this aggregate pipeline.
+ *
+ * #### Note:
+ *
+ * **MUST** be used as the first operator in the pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.near({
+ *       near: { type: 'Point', coordinates: [40.724, -73.997] },
+ *       distanceField: "dist.calculated", // required
+ *       maxDistance: 0.008,
+ *       query: { type: "public" },
+ *       includeLocs: "dist.location",
+ *       spherical: true,
+ *     });
+ *
+ * @see $geoNear https://www.mongodb.com/docs/manual/reference/aggregation/geoNear/
+ * @method near
+ * @memberOf Aggregate
+ * @instance
+ * @param {Object} arg
+ * @param {Object|Array<Number>} arg.near GeoJSON point or coordinates array
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.near = function(arg) {
+  if (arg == null) {
+    throw new MongooseError('Aggregate `near()` must be called with non-nullish argument');
+  }
+  if (arg.near == null) {
+    throw new MongooseError('Aggregate `near()` argument must have a `near` property');
+  }
+  const coordinates = Array.isArray(arg.near) ? arg.near : arg.near.coordinates;
+  if (typeof arg.near === 'object' && (!Array.isArray(coordinates) || coordinates.length < 2 || coordinates.find(c => typeof c !== 'number'))) {
+    throw new MongooseError(`Aggregate \`near()\` argument has invalid coordinates, got "${coordinates}"`);
+  }
+
+  const op = {};
+  op.$geoNear = arg;
+  return this.append(op);
+};
+
+/*!
+ * define methods
+ */
+
+'group match skip limit out densify fill'.split(' ').forEach(function($operator) {
+  Aggregate.prototype[$operator] = function(arg) {
+    const op = {};
+    op['$' + $operator] = arg;
+    return this.append(op);
+  };
+});
+
+/**
+ * Appends new custom $unwind operator(s) to this aggregate pipeline.
+ *
+ * Note that the `$unwind` operator requires the path name to start with '$'.
+ * Mongoose will prepend '$' if the specified field doesn't start '$'.
+ *
+ * #### Example:
+ *
+ *     aggregate.unwind("tags");
+ *     aggregate.unwind("a", "b", "c");
+ *     aggregate.unwind({ path: '$tags', preserveNullAndEmptyArrays: true });
+ *
+ * @see $unwind https://www.mongodb.com/docs/manual/reference/aggregation/unwind/
+ * @param {String|Object|String[]|Object[]} fields the field(s) to unwind, either as field names or as [objects with options](https://www.mongodb.com/docs/manual/reference/operator/aggregation/unwind/#document-operand-with-options). If passing a string, prefixing the field name with '$' is optional. If passing an object, `path` must start with '$'.
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.unwind = function() {
+  const args = [...arguments];
+
+  const res = [];
+  for (const arg of args) {
+    if (arg && typeof arg === 'object') {
+      res.push({ $unwind: arg });
+    } else if (typeof arg === 'string') {
+      res.push({
+        $unwind: (arg[0] === '$') ? arg : '$' + arg
+      });
+    } else {
+      throw new Error('Invalid arg "' + arg + '" to unwind(), ' +
+        'must be string or object');
+    }
+  }
+
+  return this.append.apply(this, res);
+};
+
+/**
+ * Appends a new $replaceRoot operator to this aggregate pipeline.
+ *
+ * Note that the `$replaceRoot` operator requires field strings to start with '$'.
+ * If you are passing in a string Mongoose will prepend '$' if the specified field doesn't start '$'.
+ * If you are passing in an object the strings in your expression will not be altered.
+ *
+ * #### Example:
+ *
+ *     aggregate.replaceRoot("user");
+ *
+ *     aggregate.replaceRoot({ x: { $concat: ['$this', '$that'] } });
+ *
+ * @see $replaceRoot https://www.mongodb.com/docs/manual/reference/operator/aggregation/replaceRoot
+ * @param {String|Object} newRoot the field or document which will become the new root document
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.replaceRoot = function(newRoot) {
+  let ret;
+
+  if (typeof newRoot === 'string') {
+    ret = newRoot.startsWith('$') ? newRoot : '$' + newRoot;
+  } else {
+    ret = newRoot;
+  }
+
+  return this.append({
+    $replaceRoot: {
+      newRoot: ret
+    }
+  });
+};
+
+/**
+ * Appends a new $count operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.count("userCount");
+ *
+ * @see $count https://www.mongodb.com/docs/manual/reference/operator/aggregation/count
+ * @param {String} fieldName The name of the output field which has the count as its value. It must be a non-empty string, must not start with $ and must not contain the . character.
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.count = function(fieldName) {
+  return this.append({ $count: fieldName });
+};
+
+/**
+ * Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name
+ * or a pipeline object.
+ *
+ * Note that the `$sortByCount` operator requires the new root to start with '$'.
+ * Mongoose will prepend '$' if the specified field name doesn't start with '$'.
+ *
+ * #### Example:
+ *
+ *     aggregate.sortByCount('users');
+ *     aggregate.sortByCount({ $mergeObjects: [ "$employee", "$business" ] })
+ *
+ * @see $sortByCount https://www.mongodb.com/docs/manual/reference/operator/aggregation/sortByCount/
+ * @param {Object|String} arg
+ * @return {Aggregate} this
+ * @api public
+ */
+
+Aggregate.prototype.sortByCount = function(arg) {
+  if (arg && typeof arg === 'object') {
+    return this.append({ $sortByCount: arg });
+  } else if (typeof arg === 'string') {
+    return this.append({
+      $sortByCount: (arg[0] === '$') ? arg : '$' + arg
+    });
+  } else {
+    throw new TypeError('Invalid arg "' + arg + '" to sortByCount(), ' +
+      'must be string or object');
+  }
+};
+
+/**
+ * Appends new custom $lookup operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.lookup({ from: 'users', localField: 'userId', foreignField: '_id', as: 'users' });
+ *
+ * @see $lookup https://www.mongodb.com/docs/manual/reference/operator/aggregation/lookup/#pipe._S_lookup
+ * @param {Object} options to $lookup as described in the above link
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.lookup = function(options) {
+  return this.append({ $lookup: options });
+};
+
+/**
+ * Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection.
+ *
+ * Note that graphLookup can only consume at most 100MB of memory, and does not allow disk use even if `{ allowDiskUse: true }` is specified.
+ *
+ * #### Example:
+ *
+ *      // Suppose we have a collection of courses, where a document might look like `{ _id: 0, name: 'Calculus', prerequisite: 'Trigonometry'}` and `{ _id: 0, name: 'Trigonometry', prerequisite: 'Algebra' }`
+ *      aggregate.graphLookup({ from: 'courses', startWith: '$prerequisite', connectFromField: 'prerequisite', connectToField: 'name', as: 'prerequisites', maxDepth: 3 }) // this will recursively search the 'courses' collection up to 3 prerequisites
+ *
+ * @see $graphLookup https://www.mongodb.com/docs/manual/reference/operator/aggregation/graphLookup/#pipe._S_graphLookup
+ * @param {Object} options to $graphLookup as described in the above link
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.graphLookup = function(options) {
+  const cloneOptions = {};
+  if (options) {
+    if (!utils.isObject(options)) {
+      throw new TypeError('Invalid graphLookup() argument. Must be an object.');
+    }
+
+    utils.mergeClone(cloneOptions, options);
+    const startWith = cloneOptions.startWith;
+
+    if (startWith && typeof startWith === 'string') {
+      cloneOptions.startWith = cloneOptions.startWith.startsWith('$') ?
+        cloneOptions.startWith :
+        '$' + cloneOptions.startWith;
+    }
+
+  }
+  return this.append({ $graphLookup: cloneOptions });
+};
+
+/**
+ * Appends new custom $sample operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.sample(3); // Add a pipeline that picks 3 random documents
+ *
+ * @see $sample https://www.mongodb.com/docs/manual/reference/operator/aggregation/sample/#pipe._S_sample
+ * @param {Number} size number of random documents to pick
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.sample = function(size) {
+  return this.append({ $sample: { size: size } });
+};
+
+/**
+ * Appends a new $sort operator to this aggregate pipeline.
+ *
+ * If an object is passed, values allowed are `asc`, `desc`, `ascending`, `descending`, `1`, and `-1`.
+ *
+ * If a string is passed, it must be a space delimited list of path names. The sort order of each path is ascending unless the path name is prefixed with `-` which will be treated as descending.
+ *
+ * #### Example:
+ *
+ *     // these are equivalent
+ *     aggregate.sort({ field: 'asc', test: -1 });
+ *     aggregate.sort('field -test');
+ *
+ * @see $sort https://www.mongodb.com/docs/manual/reference/aggregation/sort/
+ * @param {Object|String} arg
+ * @return {Aggregate} this
+ * @api public
+ */
+
+Aggregate.prototype.sort = function(arg) {
+  // TODO refactor to reuse the query builder logic
+
+  const sort = {};
+
+  if (getConstructorName(arg) === 'Object') {
+    const desc = ['desc', 'descending', -1];
+    Object.keys(arg).forEach(function(field) {
+      // If sorting by text score, skip coercing into 1/-1
+      if (arg[field] instanceof Object && arg[field].$meta) {
+        sort[field] = arg[field];
+        return;
+      }
+      sort[field] = desc.indexOf(arg[field]) === -1 ? 1 : -1;
+    });
+  } else if (arguments.length === 1 && typeof arg === 'string') {
+    arg.split(/\s+/).forEach(function(field) {
+      if (!field) {
+        return;
+      }
+      const ascend = field[0] === '-' ? -1 : 1;
+      if (ascend === -1) {
+        field = field.substring(1);
+      }
+      sort[field] = ascend;
+    });
+  } else {
+    throw new TypeError('Invalid sort() argument. Must be a string or object.');
+  }
+
+  return this.append({ $sort: sort });
+};
+
+/**
+ * Appends new $unionWith operator to this aggregate pipeline.
+ *
+ * #### Example:
+ *
+ *     aggregate.unionWith({ coll: 'users', pipeline: [ { $match: { _id: 1 } } ] });
+ *
+ * @see $unionWith https://www.mongodb.com/docs/manual/reference/operator/aggregation/unionWith
+ * @param {Object} options to $unionWith query as described in the above link
+ * @return {Aggregate}
+ * @api public
+ */
+
+Aggregate.prototype.unionWith = function(options) {
+  return this.append({ $unionWith: options });
+};
+
+
+/**
+ * Sets the readPreference option for the aggregation query.
+ *
+ * #### Example:
+ *
+ *     await Model.aggregate(pipeline).read('primaryPreferred');
+ *
+ * @param {String|ReadPreference} pref one of the listed preference options or their aliases
+ * @param {Array} [tags] optional tags for this query.
+ * @return {Aggregate} this
+ * @api public
+ * @see mongodb https://www.mongodb.com/docs/manual/applications/replication/#read-preference
+ */
+
+Aggregate.prototype.read = function(pref, tags) {
+  read.call(this, pref, tags);
+  return this;
+};
+
+/**
+ * Sets the readConcern level for the aggregation query.
+ *
+ * #### Example:
+ *
+ *     await Model.aggregate(pipeline).readConcern('majority');
+ *
+ * @param {String} level one of the listed read concern level or their aliases
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/read-concern/
+ * @return {Aggregate} this
+ * @api public
+ */
+
+Aggregate.prototype.readConcern = function(level) {
+  readConcern.call(this, level);
+  return this;
+};
+
+/**
+ * Appends a new $redact operator to this aggregate pipeline.
+ *
+ * If 3 arguments are supplied, Mongoose will wrap them with if-then-else of $cond operator respectively
+ * If `thenExpr` or `elseExpr` is string, make sure it starts with $$, like `$$DESCEND`, `$$PRUNE` or `$$KEEP`.
+ *
+ * #### Example:
+ *
+ *     await Model.aggregate(pipeline).redact({
+ *       $cond: {
+ *         if: { $eq: [ '$level', 5 ] },
+ *         then: '$$PRUNE',
+ *         else: '$$DESCEND'
+ *       }
+ *     });
+ *
+ *     // $redact often comes with $cond operator, you can also use the following syntax provided by mongoose
+ *     await Model.aggregate(pipeline).redact({ $eq: [ '$level', 5 ] }, '$$PRUNE', '$$DESCEND');
+ *
+ * @param {Object} expression redact options or conditional expression
+ * @param {String|Object} [thenExpr] true case for the condition
+ * @param {String|Object} [elseExpr] false case for the condition
+ * @return {Aggregate} this
+ * @see $redact https://www.mongodb.com/docs/manual/reference/operator/aggregation/redact/
+ * @api public
+ */
+
+Aggregate.prototype.redact = function(expression, thenExpr, elseExpr) {
+  if (arguments.length === 3) {
+    if ((typeof thenExpr === 'string' && !validRedactStringValues.has(thenExpr)) ||
+      (typeof elseExpr === 'string' && !validRedactStringValues.has(elseExpr))) {
+      throw new Error('If thenExpr or elseExpr is string, it must be either $$DESCEND, $$PRUNE or $$KEEP');
+    }
+
+    expression = {
+      $cond: {
+        if: expression,
+        then: thenExpr,
+        else: elseExpr
+      }
+    };
+  } else if (arguments.length !== 1) {
+    throw new TypeError('Invalid arguments');
+  }
+
+  return this.append({ $redact: expression });
+};
+
+/**
+ * Execute the aggregation with explain
+ *
+ * #### Example:
+ *
+ *     Model.aggregate(..).explain()
+ *
+ * @param {String} [verbosity]
+ * @return {Promise}
+ */
+
+Aggregate.prototype.explain = async function explain(verbosity) {
+  if (typeof verbosity === 'function' || typeof arguments[1] === 'function') {
+    throw new MongooseError('Aggregate.prototype.explain() no longer accepts a callback');
+  }
+  const model = this._model;
+
+  if (!this._pipeline.length) {
+    throw new Error('Aggregate has empty pipeline');
+  }
+
+  prepareDiscriminatorPipeline(this._pipeline, this._model.schema);
+
+  try {
+    await model.hooks.execPre('aggregate', this);
+  } catch (error) {
+    return await model.hooks.execPost('aggregate', this, [null], { error });
+  }
+
+  const cursor = model.collection.aggregate(this._pipeline, this.options);
+
+  if (verbosity == null) {
+    verbosity = true;
+  }
+
+  let result = null;
+  try {
+    result = await cursor.explain(verbosity);
+  } catch (error) {
+    return await model.hooks.execPost('aggregate', this, [null], { error });
+  }
+
+  await model.hooks.execPost('aggregate', this, [result], { error: null });
+
+  return result;
+};
+
+/**
+ * Sets the allowDiskUse option for the aggregation query
+ *
+ * #### Example:
+ *
+ *     await Model.aggregate([{ $match: { foo: 'bar' } }]).allowDiskUse(true);
+ *
+ * @param {Boolean} value Should tell server it can use hard drive to store data during aggregation.
+ * @return {Aggregate} this
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
+ */
+
+Aggregate.prototype.allowDiskUse = function(value) {
+  this.options.allowDiskUse = value;
+  return this;
+};
+
+/**
+ * Sets the hint option for the aggregation query
+ *
+ * #### Example:
+ *
+ *     Model.aggregate(..).hint({ qty: 1, category: 1 }).exec();
+ *
+ * @param {Object|String} value a hint object or the index name
+ * @return {Aggregate} this
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
+ */
+
+Aggregate.prototype.hint = function(value) {
+  this.options.hint = value;
+  return this;
+};
+
+/**
+ * Sets the session for this aggregation. Useful for [transactions](https://mongoosejs.com/docs/transactions.html).
+ *
+ * #### Example:
+ *
+ *     const session = await Model.startSession();
+ *     await Model.aggregate(..).session(session);
+ *
+ * @param {ClientSession} session
+ * @return {Aggregate} this
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
+ */
+
+Aggregate.prototype.session = function(session) {
+  if (session == null) {
+    delete this.options.session;
+  } else {
+    this.options.session = session;
+  }
+  return this;
+};
+
+/**
+ * Lets you set arbitrary options, for middleware or plugins.
+ *
+ * #### Example:
+ *
+ *     const agg = Model.aggregate(..).option({ allowDiskUse: true }); // Set the `allowDiskUse` option
+ *     agg.options; // `{ allowDiskUse: true }`
+ *
+ * @param {Object} options keys to merge into current options
+ * @param {Number} [options.maxTimeMS] number limits the time this aggregation will run, see [MongoDB docs on `maxTimeMS`](https://www.mongodb.com/docs/manual/reference/operator/meta/maxTimeMS/)
+ * @param {Boolean} [options.allowDiskUse] boolean if true, the MongoDB server will use the hard drive to store data during this aggregation
+ * @param {Object} [options.collation] object see [`Aggregate.prototype.collation()`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.collation())
+ * @param {ClientSession} [options.session] ClientSession see [`Aggregate.prototype.session()`](https://mongoosejs.com/docs/api/aggregate.html#Aggregate.prototype.session())
+ * @see mongodb https://www.mongodb.com/docs/manual/reference/command/aggregate/
+ * @return {Aggregate} this
+ * @api public
+ */
+
+Aggregate.prototype.option = function(value) {
+  for (const key in value) {
+    this.options[key] = value[key];
+  }
+  return this;
+};
+
+/**
+ * Sets the `cursor` option and executes this aggregation, returning an aggregation cursor.
+ * Cursors are useful if you want to process the results of the aggregation one-at-a-time
+ * because the aggregation result is too big to fit into memory.
+ *
+ * #### Example:
+ *
+ *     const cursor = Model.aggregate(..).cursor({ batchSize: 1000 });
+ *     cursor.eachAsync(function(doc, i) {
+ *       // use doc
+ *     });
+ *
+ * @param {Object} options
+ * @param {Number} [options.batchSize] set the cursor batch size
+ * @param {Boolean} [options.useMongooseAggCursor] use experimental mongoose-specific aggregation cursor (for `eachAsync()` and other query cursor semantics)
+ * @return {AggregationCursor} cursor representing this aggregation
+ * @api public
+ * @see mongodb https://mongodb.github.io/node-mongodb-native/4.9/classes/AggregationCursor.html
+ */
+
+Aggregate.prototype.cursor = function(options) {
+  this._optionsForExec();
+  this.options.cursor = options || {};
+  return new AggregationCursor(this); // return this;
+};
+
+/**
+ * Adds a collation
+ *
+ * #### Example:
+ *
+ *     const res = await Model.aggregate(pipeline).collation({ locale: 'en_US', strength: 1 });
+ *
+ * @param {Object} collation options
+ * @return {Aggregate} this
+ * @api public
+ * @see mongodb https://mongodb.github.io/node-mongodb-native/4.9/interfaces/CollationOptions.html
+ */
+
+Aggregate.prototype.collation = function(collation) {
+  this.options.collation = collation;
+  return this;
+};
+
+/**
+ * Combines multiple aggregation pipelines.
+ *
+ * #### Example:
+ *
+ *     const res = await Model.aggregate().facet({
+ *       books: [{ groupBy: '$author' }],
+ *       price: [{ $bucketAuto: { groupBy: '$price', buckets: 2 } }]
+ *     });
+ *
+ *     // Output: { books: [...], price: [{...}, {...}] }
+ *
+ * @param {Object} facet options
+ * @return {Aggregate} this
+ * @see $facet https://www.mongodb.com/docs/manual/reference/operator/aggregation/facet/
+ * @api public
+ */
+
+Aggregate.prototype.facet = function(options) {
+  return this.append({ $facet: options });
+};
+
+/**
+ * Helper for [Atlas Text Search](https://www.mongodb.com/docs/atlas/atlas-search/tutorial/)'s
+ * `$search` stage.
+ *
+ * #### Example:
+ *
+ *     const res = await Model.aggregate().
+ *      search({
+ *        text: {
+ *          query: 'baseball',
+ *          path: 'plot'
+ *        }
+ *      });
+ *
+ *     // Output: [{ plot: '...', title: '...' }]
+ *
+ * @param {Object} $search options
+ * @return {Aggregate} this
+ * @see $search https://www.mongodb.com/docs/atlas/atlas-search/tutorial/
+ * @api public
+ */
+
+Aggregate.prototype.search = function(options) {
+  return this.append({ $search: options });
+};
+
+/**
+ * Returns the current pipeline
+ *
+ * #### Example:
+ *
+ *     MyModel.aggregate().match({ test: 1 }).pipeline(); // [{ $match: { test: 1 } }]
+ *
+ * @return {Array} The current pipeline similar to the operation that will be executed
+ * @api public
+ */
+
+Aggregate.prototype.pipeline = function() {
+  return this._pipeline;
+};
+
+/**
+ * Executes the aggregate pipeline on the currently bound Model.
+ *
+ * #### Example:
+ *     const result = await aggregate.exec();
+ *
+ * @return {Promise}
+ * @api public
+ */
+
+Aggregate.prototype.exec = async function exec() {
+  if (!this._model && !this._connection) {
+    throw new Error('Aggregate not bound to any Model');
+  }
+  if (typeof arguments[0] === 'function') {
+    throw new MongooseError('Aggregate.prototype.exec() no longer accepts a callback');
+  }
+
+  if (this._connection) {
+    if (!this._pipeline.length) {
+      throw new MongooseError('Aggregate has empty pipeline');
+    }
+
+    this._optionsForExec();
+
+    const cursor = await this._connection.client.db().aggregate(this._pipeline, this.options);
+    return await cursor.toArray();
+  }
+
+  const model = this._model;
+  const collection = this._model.collection;
+
+  applyGlobalMaxTimeMS(this.options, model.db.options, model.base.options);
+  applyGlobalDiskUse(this.options, model.db.options, model.base.options);
+
+  this._optionsForExec();
+
+  if (this.options?.cursor) {
+    return new AggregationCursor(this);
+  }
+
+  prepareDiscriminatorPipeline(this._pipeline, this._model.schema);
+  stringifyFunctionOperators(this._pipeline);
+
+  try {
+    await model.hooks.execPre('aggregate', this);
+  } catch (error) {
+    return await model.hooks.execPost('aggregate', this, [null], { error });
+  }
+
+  if (!this._pipeline.length) {
+    throw new MongooseError('Aggregate has empty pipeline');
+  }
+
+  const options = clone(this.options || {});
+
+  let result;
+  try {
+    const cursor = await collection.aggregate(this._pipeline, options);
+    result = await cursor.toArray();
+  } catch (error) {
+    return await model.hooks.execPost('aggregate', this, [null], { error });
+  }
+
+  await model.hooks.execPost('aggregate', this, [result], { error: null });
+
+  return result;
+};
+
+/**
+ * Provides a Promise-like `then` function, which will call `.exec` without a callback
+ * Compatible with `await`.
+ *
+ * #### Example:
+ *
+ *     Model.aggregate(..).then(successCallback, errorCallback);
+ *
+ * @param {Function} [resolve] successCallback
+ * @param {Function} [reject]  errorCallback
+ * @return {Promise}
+ */
+Aggregate.prototype.then = function(resolve, reject) {
+  return this.exec().then(resolve, reject);
+};
+
+/**
+ * Executes the aggregation returning a `Promise` which will be
+ * resolved with either the doc(s) or rejected with the error.
+ * Like [`.then()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.then), but only takes a rejection handler.
+ * Compatible with `await`.
+ *
+ * @param {Function} [reject]
+ * @return {Promise}
+ * @api public
+ */
+
+Aggregate.prototype.catch = function(reject) {
+  return this.exec().then(null, reject);
+};
+
+/**
+ * Executes the aggregate returning a `Promise` which will be
+ * resolved with `.finally()` chained.
+ *
+ * More about [Promise `finally()` in JavaScript](https://thecodebarbarian.com/using-promise-finally-in-node-js.html).
+ *
+ * @param {Function} [onFinally]
+ * @return {Promise}
+ * @api public
+ */
+
+Aggregate.prototype.finally = function(onFinally) {
+  return this.exec().finally(onFinally);
+};
+
+/**
+ * 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.
+ *
+ * #### Example:
+ *
+ *     const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
+ *     for await (const doc of agg) {
+ *       console.log(doc.name);
+ *     }
+ *
+ * @method [Symbol.asyncIterator]
+ * @memberOf Aggregate
+ * @instance
+ * @api public
+ */
+
+Aggregate.prototype[Symbol.asyncIterator] = function() {
+  return this.cursor({ useMongooseAggCursor: true }).transformNull()._transformForAsyncIterator();
+};
+
+/*!
+ * Helpers
+ */
+
+/**
+ * Checks whether an object is likely a pipeline operator
+ *
+ * @param {Object} obj object to check
+ * @return {Boolean}
+ * @api private
+ */
+
+function isOperator(obj) {
+  if (typeof obj !== 'object' || obj === null) {
+    return false;
+  }
+
+  const k = Object.keys(obj);
+
+  return k.length === 1 && k[0][0] === '$';
+}
+
+/**
+ * Adds the appropriate `$match` pipeline step to the top of an aggregate's
+ * pipeline, should it's model is a non-root discriminator type. This is
+ * analogous to the `prepareDiscriminatorCriteria` function in `lib/query.js`.
+ *
+ * @param {Aggregate} aggregate Aggregate to prepare
+ * @api private
+ */
+
+Aggregate._prepareDiscriminatorPipeline = prepareDiscriminatorPipeline;
+
+/*!
+ * Exports
+ */
+
+module.exports = Aggregate;