mongoose 6.2.4 → 6.2.5

package/lib/helpers/isSimpleValidator.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/*!
+ * Determines if `arg` is a flat object.
+ *
+ * @param {Object|Array|String|Function|RegExp|any} arg
+ * @api private
+ * @return {Boolean}
+ */
+
+module.exports = function isSimpleValidator(obj) {
+  const keys = Object.keys(obj);
+  let result = true;
+  for (let i = 0, len = keys.length; i < len; ++i) {
+    if (typeof obj[keys[i]] === 'object' && obj[keys[i]] !== null) {
+      result = false;
+      break;
+    }
+  }
+
+  return result;
+};

package/lib/helpers/populate/assignVals.js

@@ -196,10 +196,18 @@ function numDocs(v) {
   if (Array.isArray(v)) {
     // If setting underneath an array of populated subdocs, we may have an
     // array of arrays. See gh-7573
-    if (v.some(el => Array.isArray(el))) {
-      return v.map(el => numDocs(el));
+    if (v.some(el => Array.isArray(el) || el === null)) {
+      return v.map(el => {
+        if (el == null) {
+          return 0;
+        }
+        if (Array.isArray(el)) {
+          return el.filter(el => el != null).length;
+        }
+        return 1;
+      });
     }
-    return v.length;
+    return v.filter(el => el != null).length;
   }
   return v == null ? 0 : 1;
 }

package/lib/helpers/populate/getModelsMapForPopulate.js

@@ -389,7 +389,7 @@ function _virtualPopulate(model, docs, options, _virtualRes) {
       localField = localField.call(doc, doc);
     }
     if (typeof foreignField === 'function') {
-      foreignField = foreignField.call(doc);
+      foreignField = foreignField.call(doc, doc);
     }
 
     data.isRefPath = false;

package/lib/helpers/query/castUpdate.js

@@ -177,6 +177,8 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
 
   let aggregatedError = null;
 
+  const strictMode = strict != null ? strict : schema.options.strict;
+
   while (i--) {
     key = keys[i];
     val = obj[key];
@@ -192,6 +194,17 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
       }
     }
 
+    if (schema.discriminatorMapping != null && key === schema.options.discriminatorKey && !options.overwriteDiscriminatorKey) {
+      if (strictMode === 'throw') {
+        const err = new Error('Can\'t modify discriminator key "' + key + '" on discriminator model');
+        aggregatedError = _appendError(err, context, key, aggregatedError);
+        continue;
+      } else if (strictMode) {
+        delete obj[key];
+        continue;
+      }
+    }
+
     if (getConstructorName(val) === 'Object') {
       // watch for embedded doc schemas
       schematype = schema._getSchema(prefix + key);
@@ -217,7 +230,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
               $each: castUpdateVal(schematype, val.$each, op, key, context, prefix + key)
             };
           } catch (error) {
-            aggregatedError = _handleCastError(error, context, key, aggregatedError);
+            aggregatedError = _appendError(error, context, key, aggregatedError);
           }
 
           if (val.$slice != null) {
@@ -237,13 +250,13 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
             try {
               obj[key] = schematype.castForQuery(val, context, { strict: _strict });
             } catch (error) {
-              aggregatedError = _handleCastError(error, context, key, aggregatedError);
+              aggregatedError = _appendError(error, context, key, aggregatedError);
             }
           } else {
             try {
               obj[key] = castUpdateVal(schematype, val, op, key, context, prefix + key);
             } catch (error) {
-              aggregatedError = _handleCastError(error, context, key, aggregatedError);
+              aggregatedError = _appendError(error, context, key, aggregatedError);
             }
           }
 
@@ -259,7 +272,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
         try {
           obj[key] = castUpdateVal(schematype, val, op, key, context, prefix + key);
         } catch (error) {
-          aggregatedError = _handleCastError(error, context, key, aggregatedError);
+          aggregatedError = _appendError(error, context, key, aggregatedError);
         }
 
         if (obj[key] === void 0) {
@@ -350,7 +363,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
             delete obj[key];
           }
         } catch (error) {
-          aggregatedError = _handleCastError(error, context, key, aggregatedError);
+          aggregatedError = _appendError(error, context, key, aggregatedError);
         }
 
         if (Array.isArray(obj[key]) && (op === '$addToSet' || op === '$push') && key !== '$each') {
@@ -383,7 +396,7 @@ function walkUpdatePath(schema, obj, op, options, context, filter, pref) {
  * ignore
  */
 
-function _handleCastError(error, query, key, aggregatedError) {
+function _appendError(error, query, key, aggregatedError) {
   if (typeof query !== 'object' || !query.options.multipleCastError) {
     throw error;
   }
@@ -455,6 +468,8 @@ function castUpdateVal(schema, val, op, $conditional, context, path) {
     return val;
   }
 
+  // console.log('CastUpdateVal', path, op, val, schema);
+
   const cond = schema.caster && op in castOps &&
       (utils.isObject(val) || Array.isArray(val));
   if (cond && !overwriteOps[op]) {

package/lib/index.js

@@ -40,6 +40,8 @@ const defaultMongooseSymbol = Symbol.for('mongoose:default');
 
 require('./helpers/printJestWarning');
 
+const objectIdHexRegexp = /^[0-9A-Fa-f]{24}$/;
+
 /**
  * Mongoose constructor.
  *
@@ -945,11 +947,13 @@ Mongoose.prototype.ObjectId = SchemaTypes.ObjectId;
  *     mongoose.isValidObjectId(new mongoose.Types.ObjectId()); // true
  *     mongoose.isValidObjectId('0123456789ab'); // true
  *     mongoose.isValidObjectId(6); // true
+ *     mongoose.isValidObjectId(new User({ name: 'test' })); // true
+ *
  *     mongoose.isValidObjectId({ test: 42 }); // false
  *
  * @method isValidObjectId
- * @param {Any} value
- * @returns {boolean} true if it is a valid ObjectId
+ * @param {Any} v
+ * @returns {boolean} true if `v` is something Mongoose can coerce to an ObjectId
  * @api public
  */
 
@@ -958,6 +962,38 @@ Mongoose.prototype.isValidObjectId = function(v) {
   return _mongoose.Types.ObjectId.isValid(v);
 };
 
+/**
+ * Returns true if the given value is a Mongoose ObjectId (using `instanceof`) or if the
+ * given value is a 24 character hex string, which is the most commonly used string representation
+ * of an ObjectId.
+ *
+ * This function is similar to `isValidObjectId()`, but considerably more strict, because
+ * `isValidObjectId()` will return `true` for _any_ value that Mongoose can convert to an
+ * ObjectId. That includes Mongoose documents, any string of length 12, and any number.
+ * `isObjectIdOrHexString()` returns true only for `ObjectId` instances or 24 character hex
+ * strings, and will return false for numbers, documents, and strings of length 12.
+ *
+ * ####Example:
+ *
+ *     mongoose.isObjectIdOrHexString(new mongoose.Types.ObjectId()); // true
+ *     mongoose.isObjectIdOrHexString('62261a65d66c6be0a63c051f'); // true
+ *
+ *     mongoose.isObjectIdOrHexString('0123456789ab'); // false
+ *     mongoose.isObjectIdOrHexString(6); // false
+ *     mongoose.isObjectIdOrHexString(new User({ name: 'test' })); // false
+ *     mongoose.isObjectIdOrHexString({ test: 42 }); // false
+ *
+ * @method isObjectIdOrHexString
+ * @param {Any} v
+ * @returns {boolean} true if `v` is an ObjectId instance _or_ a 24 char hex string
+ * @api public
+ */
+
+Mongoose.prototype.isObjectIdOrHexString = function(v) {
+  const _mongoose = this instanceof Mongoose ? this : mongoose;
+  return v instanceof _mongoose.Types.ObjectId || (typeof v === 'string' && objectIdHexRegexp.test(v));
+};
+
 /**
  *
  * Syncs all the indexes for the models registered with this connection.

package/lib/model.js

@@ -2481,7 +2481,7 @@ Model.$where = function $where() {
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
@@ -2617,7 +2617,7 @@ function _decorateUpdateWithVersionKey(update, options, versionKey) {
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `select`: sets the document fields to return
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
@@ -2718,7 +2718,7 @@ Model.findByIdAndUpdate = function(id, update, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return, ex. `{ projection: { _id: 0 } }`
  * - `projection`: equivalent to `select`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
@@ -2831,7 +2831,7 @@ Model.findByIdAndDelete = function(id, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return
  * - `projection`: like select, it determines which fields to return, ex. `{ projection: { _id: 0 } }`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
@@ -2908,7 +2908,7 @@ Model.findOneAndReplace = function(filter, replacement, options, callback) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `select`: sets the document fields to return
  * - `projection`: like select, it determines which fields to return, ex. `{ projection: { _id: 0 } }`
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:
@@ -2986,7 +2986,7 @@ Model.findOneAndRemove = function(conditions, options, callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `select`: sets the document fields to return
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * - `strict`: overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict) for this update
  *
  * ####Examples:

package/lib/query.js

@@ -3244,7 +3244,7 @@ function prepareDiscriminatorCriteria(query) {
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
  * - `runValidators`: if true, runs [update validators](/docs/validation.html#update-validators) on this command. Update validators validate the update operation against the model's schema.
  * - `setDefaultsOnInsert`: `true` by default. If `setDefaultsOnInsert` and `upsert` are true, mongoose will apply the [defaults](https://mongoosejs.com/docs/defaults.html) specified in the model's schema if a new document is created.
- * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  *
  * ####Callback Signature
  *     function(error, doc) {
@@ -3269,7 +3269,7 @@ function prepareDiscriminatorCriteria(query) {
  * @param {Object|Query} [filter]
  * @param {Object} [doc]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean} [options.multipleCastError] by default, mongoose only returns the first error that occurred in casting the query. Turn on this option to aggregate all the cast errors.
@@ -3386,7 +3386,7 @@ Query.prototype._findOneAndUpdate = wrapThunk(function(callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  *
  * ####Callback Signature
  *     function(error, doc) {
@@ -3408,7 +3408,7 @@ Query.prototype._findOneAndUpdate = wrapThunk(function(callback) {
  * @instance
  * @param {Object} [conditions]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback] optional params are (error, document)
@@ -3473,7 +3473,7 @@ Query.prototype.findOneAndRemove = function(conditions, options, callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  *
  * ####Callback Signature
  *     function(error, doc) {
@@ -3494,7 +3494,7 @@ Query.prototype.findOneAndRemove = function(conditions, options, callback) {
  * @memberOf Query
  * @param {Object} [conditions]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Function} [callback] optional params are (error, document)
@@ -3592,7 +3592,7 @@ Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
  *
  * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
  * - `maxTimeMS`: puts a time limit on the query - requires mongodb >= 2.6.0
- * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * - `rawResult`: if true, resolves to the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  *
  * ####Callback Signature
  *     function(error, doc) {
@@ -3614,7 +3614,7 @@ Query.prototype._findOneAndDelete = wrapThunk(function(callback) {
  * @param {Object} [filter]
  * @param {Object} [replacement]
  * @param {Object} [options]
- * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/2.0/api/Collection.html#findAndModify)
+ * @param {Boolean} [options.rawResult] if true, returns the [raw result from the MongoDB driver](https://mongodb.github.io/node-mongodb-native/4.3/interfaces/ModifyResult.html)
  * @param {ClientSession} [options.session=null] The session associated with this query. See [transactions docs](/docs/transactions.html).
  * @param {Boolean|String} [options.strict] overwrites the schema's [strict mode option](https://mongoosejs.com/docs/guide.html#strict)
  * @param {Boolean} [options.new=false] By default, `findOneAndUpdate()` returns the document as it was **before** `update` was applied. If you set `new: true`, `findOneAndUpdate()` will instead give you the object after `update` was applied.

package/lib/schema/array.js

@@ -646,6 +646,7 @@ handle.$gte =
 handle.$lt =
 handle.$lte =
 handle.$ne =
+handle.$not =
 handle.$regex = SchemaArray.prototype.castForQuery;
 
 // `$in` is special because you can also include an empty array in the query

package/lib/schematype.js

@@ -10,6 +10,7 @@ const $exists = require('./schema/operators/exists');
 const $type = require('./schema/operators/type');
 const handleImmutable = require('./helpers/schematype/handleImmutable');
 const isAsyncFunction = require('./helpers/isAsyncFunction');
+const isSimpleValidator = require('./helpers/isSimpleValidator');
 const immediate = require('./helpers/immediate');
 const schemaTypeSymbol = require('./helpers/symbols').schemaTypeSymbol;
 const utils = require('./utils');
@@ -886,7 +887,7 @@ SchemaType.prototype.validate = function(obj, message, type) {
       properties = { validator: obj, message: message };
       properties.type = type || 'user defined';
     } else if (message instanceof Object && !type) {
-      properties = utils.clone(message);
+      properties = isSimpleValidator(message) ? Object.assign({}, message) : utils.clone(message);
       if (!properties.message) {
         properties.message = properties.msg;
       }
@@ -914,8 +915,8 @@ SchemaType.prototype.validate = function(obj, message, type) {
     arg = arguments[i];
     if (!utils.isPOJO(arg)) {
       const msg = 'Invalid validator. Received (' + typeof arg + ') '
-          + arg
-          + '. See https://mongoosejs.com/docs/api.html#schematype_SchemaType-validate';
+        + arg
+        + '. See https://mongoosejs.com/docs/api.html#schematype_SchemaType-validate';
 
       throw new Error(msg);
     }
@@ -1242,7 +1243,7 @@ SchemaType.prototype.doValidate = function(value, fn, scope, options) {
 
   // Avoid non-object `validators`
   const validators = this.validators.
-    filter(v => v != null && typeof v === 'object');
+    filter(v => typeof v === 'object' && v !== null);
 
   let count = validators.length;
 
@@ -1251,15 +1252,15 @@ SchemaType.prototype.doValidate = function(value, fn, scope, options) {
   }
 
   for (let i = 0, len = validators.length; i < len; ++i) {
-    const v = validators[i];
     if (err) {
       break;
     }
 
+    const v = validators[i];
     const validator = v.validator;
     let ok;
 
-    const validatorProperties = utils.clone(v);
+    const validatorProperties = isSimpleValidator(v) ? Object.assign({}, v) : utils.clone(v);
     validatorProperties.path = options && options.path ? options.path : path;
     validatorProperties.value = value;
 
@@ -1373,12 +1374,12 @@ SchemaType.prototype.doValidateSync = function(value, scope, options) {
 
     const v = validators[i];
 
-    if (v == null || typeof v !== 'object') {
+    if (v === null || typeof v !== 'object') {
       continue;
     }
 
     const validator = v.validator;
-    const validatorProperties = utils.clone(v);
+    const validatorProperties = isSimpleValidator(v) ? Object.assign({}, v) : utils.clone(v);
     validatorProperties.path = options && options.path ? options.path : path;
     validatorProperties.value = value;
     let ok = false;
@@ -1453,8 +1454,8 @@ SchemaType._isRef = function(self, value, doc, init) {
       return true;
     }
     if (!Buffer.isBuffer(value) && // buffers are objects too
-        value._bsontype !== 'Binary' // raw binary value from the db
-        && utils.isObject(value) // might have deselected _id in population query
+      value._bsontype !== 'Binary' // raw binary value from the db
+      && utils.isObject(value) // might have deselected _id in population query
     ) {
       return true;
     }
@@ -1495,10 +1496,10 @@ SchemaType.prototype._castRef = function _castRef(value, doc, init) {
   const pop = owner.$populated(path, true);
   let ret = value;
   if (!doc.$__.populated ||
-      !doc.$__.populated[path] ||
-      !doc.$__.populated[path].options ||
-      !doc.$__.populated[path].options.options ||
-      !doc.$__.populated[path].options.options.lean) {
+    !doc.$__.populated[path] ||
+    !doc.$__.populated[path].options ||
+    !doc.$__.populated[path].options.options ||
+    !doc.$__.populated[path].options.options.lean) {
     ret = new pop.options[populateModelSymbol](value);
     ret.$__.wasPopulated = true;
   }

package/package.json

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

package/types/cursor.ts

@@ -0,0 +1,48 @@
+import stream = require('stream');
+
+declare module 'mongoose' {
+  type CursorFlag = 'tailable' | 'oplogReplay' | 'noCursorTimeout' | 'awaitData' | 'partial';
+
+  class Cursor<DocType = any, Options = never> extends stream.Readable {
+    [Symbol.asyncIterator](): AsyncIterableIterator<DocType>;
+
+    /**
+     * Adds a [cursor flag](http://mongodb.github.io/node-mongodb-native/2.2/api/Cursor.html#addCursorFlag).
+     * Useful for setting the `noCursorTimeout` and `tailable` flags.
+     */
+    addCursorFlag(flag: CursorFlag, value: boolean): this;
+
+    /**
+     * Marks this cursor as closed. Will stop streaming and subsequent calls to
+     * `next()` will error.
+     */
+    close(callback: CallbackWithoutResult): void;
+    close(): Promise<void>;
+
+    /**
+     * Execute `fn` for every document(s) in the cursor. If batchSize is provided
+     * `fn` will be executed for each batch of documents. If `fn` returns a promise,
+     * will wait for the promise to resolve before iterating on to the next one.
+     * Returns a promise that resolves when done.
+     */
+    eachAsync(fn: (doc: DocType[]) => any, options: { parallel?: number, batchSize: number }, callback: CallbackWithoutResult): void;
+    eachAsync(fn: (doc: DocType) => any, options: { parallel?: number }, callback: CallbackWithoutResult): void;
+    eachAsync(fn: (doc: DocType[]) => any, options: { parallel?: number, batchSize: number }): Promise<void>;
+    eachAsync(fn: (doc: DocType) => any, options?: { parallel?: number }): Promise<void>;
+
+    /**
+     * Registers a transform function which subsequently maps documents retrieved
+     * via the streams interface or `.next()`
+     */
+    map<ResultType>(fn: (res: DocType) => ResultType): Cursor<ResultType, Options>;
+
+    /**
+     * Get the next document from this cursor. Will return `null` when there are
+     * no documents left.
+     */
+    next(callback: Callback<DocType | null>): void;
+    next(): Promise<DocType>;
+
+    options: Options;
+  }
+}