mongoose 6.2.9 → 6.2.10

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+6.2.10 / 2022-04-04
+===================
+ * fix(types): improve lastErrorObject typing for rawResults #11602 [simllll](https://github.com/simllll)
+ * docs(typescript): add note about deprecating extends Document #11619 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+ * docs: consistent syntax highlighting with upgraded highlight.js #11579 [AbdelrahmanHafez](https://github.com/AbdelrahmanHafez)
+
 6.2.9 / 2022-03-28
 ==================
  * perf(document+model): make a few small optimizations #11380

package/dist/browser.umd.js

@@ -1590,7 +1590,7 @@ function n(t){return(n="function"==typeof Symbol&&"symbol"==typeof Symbol.iterat
  * Creates an object that precomputes whether a given path has child fields in
  * the projection.
  *
- * ####Example:
+ * #### Example:
  *     const res = hasIncludedChildren({ 'a.b.c': 0 });
  *     res.a; // 1
  *     res['a.b']; // 1
@@ -1624,7 +1624,7 @@ t.exports=function t(e,r,o){for(var s=(o=o||{}).typeOnly,a=-1===r.indexOf(".")?[
  * If populating a path within a document array, make sure each
  * subdoc within the array knows its subpaths are populated.
  *
- * ####Example:
+ * #### Example:
  *     const doc = await Article.findOne().populate('comments.author');
  *     doc.comments[0].populated('author'); // Should be set
  */t.exports=function(t,e){if(null!=t._id&&null!=e&&0!==e.length){var r,i=String(t._id),s=n(e);try{for(s.s();!(r=s.n()).done;){var a=r.value;if(!a.isVirtual)for(var u=a.path.split("."),h=0;h<u.length-1;++h){var f=u.slice(0,h+1).join("."),c=u.slice(h+1).join("."),l=t.get(f);if(null!=l&&o.isMongooseDocumentArray(l)){for(var d=0;d<l.length;++d)l[d].populated(c,null==a._docs[i]?void 0:a._docs[i][d],a);break}}}}catch(t){s.e(t)}finally{s.f()}}}},function(t,e,r){"use strict";

package/lib/aggregate.js

@@ -19,7 +19,7 @@ const readConcern = Query.prototype.readConcern;
  * Aggregate constructor used for building aggregation pipelines. Do not
  * instantiate this class directly, use [Model.aggregate()](/docs/api.html#model_Model.aggregate) instead.
  *
- * ####Example:
+ * #### Example:
  *
  *     const aggregate = Model.aggregate([
  *       { $project: { a: 1, b: 1 } },
@@ -31,7 +31,7 @@ const readConcern = Query.prototype.readConcern;
  *       unwind('tags').
  *       exec(callback);
  *
- * ####Note:
+ * #### 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
@@ -87,7 +87,7 @@ Aggregate.prototype.options;
 /**
  * Get/set the model that this aggregation will execute on.
  *
- * ####Example:
+ * #### Example:
  *     const aggregate = MyModel.aggregate([{ $match: { answer: 42 } }]);
  *     aggregate.model() === MyModel; // true
  *
@@ -123,7 +123,7 @@ Aggregate.prototype.model = function(model) {
 /**
  * Appends new operators to this aggregate pipeline
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.append({ $project: { field: 1 }}, { $limit: 2 });
  *
@@ -154,7 +154,7 @@ Aggregate.prototype.append = function() {
  * Appends a new $addFields operator to this aggregate pipeline.
  * Requires MongoDB v3.4+ to work
  *
- * ####Examples:
+ * #### Examples:
   *
  *     // adding new fields based on existing fields
  *     aggregate.addFields({
@@ -185,7 +185,7 @@ Aggregate.prototype.addFields = function(arg) {
  *
  * Mongoose query [selection syntax](#query_Query-select) is also supported.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     // include a, include b, exclude _id
  *     aggregate.project("a b -_id");
@@ -240,7 +240,7 @@ Aggregate.prototype.project = function(arg) {
 /**
  * Appends a new custom $group operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.group({ _id: "$department" });
  *
@@ -256,7 +256,7 @@ Aggregate.prototype.project = function(arg) {
 /**
  * Appends a new custom $match operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.match({ department: { $in: [ "sales", "engineering" ] } });
  *
@@ -272,7 +272,7 @@ Aggregate.prototype.project = function(arg) {
 /**
  * Appends a new $skip operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.skip(10);
  *
@@ -288,7 +288,7 @@ Aggregate.prototype.project = function(arg) {
 /**
  * Appends a new $limit operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.limit(10);
  *
@@ -304,11 +304,11 @@ Aggregate.prototype.project = function(arg) {
 /**
  * Appends a new $geoNear operator to this aggregate pipeline.
  *
- * ####NOTE:
+ * #### Note:
  *
  * **MUST** be used as the first operator in the pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.near({
  *       near: [40.724, -73.997],
@@ -353,7 +353,7 @@ Aggregate.prototype.near = function(arg) {
  * Note that the `$unwind` operator requires the path name to start with '$'.
  * Mongoose will prepend '$' if the specified field doesn't start '$'.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.unwind("tags");
  *     aggregate.unwind("a", "b", "c");
@@ -392,7 +392,7 @@ Aggregate.prototype.unwind = function() {
  * 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.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.replaceRoot("user");
  *
@@ -423,7 +423,7 @@ Aggregate.prototype.replaceRoot = function(newRoot) {
 /**
  * Appends a new $count operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.count("userCount");
  *
@@ -444,7 +444,7 @@ Aggregate.prototype.count = function(countName) {
  * Note that the `$sortByCount` operator requires the new root to start with '$'.
  * Mongoose will prepend '$' if the specified field name doesn't start with '$'.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.sortByCount('users');
  *     aggregate.sortByCount({ $mergeObjects: [ "$employee", "$business" ] })
@@ -471,7 +471,7 @@ Aggregate.prototype.sortByCount = function(arg) {
 /**
  * Appends new custom $lookup operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.lookup({ from: 'users', localField: 'userId', foreignField: '_id', as: 'users' });
  *
@@ -522,7 +522,7 @@ Aggregate.prototype.graphLookup = function(options) {
 /**
  * Appends new custom $sample operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.sample(3); // Add a pipeline that picks 3 random documents
  *
@@ -543,7 +543,7 @@ Aggregate.prototype.sample = function(size) {
  *
  * 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.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     // these are equivalent
  *     aggregate.sort({ field: 'asc', test: -1 });
@@ -591,7 +591,7 @@ Aggregate.prototype.sort = function(arg) {
 /**
  * Appends new $unionWith operator to this aggregate pipeline.
  *
- * ####Examples:
+ * #### Examples:
  *
  *     aggregate.unionWith({ coll: 'users', pipeline: [ { $match: { _id: 1 } } ] });
  *
@@ -608,7 +608,7 @@ Aggregate.prototype.unionWith = function(options) {
 /**
  * Sets the readPreference option for the aggregation query.
  *
- * ####Example:
+ * #### Example:
  *
  *     await Model.aggregate(pipeline).read('primaryPreferred');
  *
@@ -631,7 +631,7 @@ Aggregate.prototype.read = function(pref, tags) {
 /**
  * Sets the readConcern level for the aggregation query.
  *
- * ####Example:
+ * #### Example:
  *
  *     await Model.aggregate(pipeline).readConcern('majority');
  *
@@ -655,7 +655,7 @@ Aggregate.prototype.readConcern = function(level) {
  * 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:
+ * #### Example:
  *
  *     await Model.aggregate(pipeline).redact({
  *       $cond: {
@@ -700,7 +700,7 @@ Aggregate.prototype.redact = function(expression, thenExpr, elseExpr) {
 /**
  * Execute the aggregation with explain
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.aggregate(..).explain(callback)
  *
@@ -768,7 +768,7 @@ Aggregate.prototype.explain = function(verbosity, callback) {
 /**
  * Sets the allowDiskUse option for the aggregation query (ignored for < 2.6.0)
  *
- * ####Example:
+ * #### Example:
  *
  *     await Model.aggregate([{ $match: { foo: 'bar' } }]).allowDiskUse(true);
  *
@@ -785,7 +785,7 @@ Aggregate.prototype.allowDiskUse = function(value) {
 /**
  * Sets the hint option for the aggregation query (ignored for < 3.6.0)
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.aggregate(..).hint({ qty: 1, category: 1 }).exec(callback)
  *
@@ -801,7 +801,7 @@ Aggregate.prototype.hint = function(value) {
 /**
  * Sets the session for this aggregation. Useful for [transactions](/docs/transactions.html).
  *
- * ####Example:
+ * #### Example:
  *
  *     const session = await Model.startSession();
  *     await Model.aggregate(..).session(session);
@@ -822,7 +822,7 @@ Aggregate.prototype.session = function(session) {
 /**
  * Lets you set arbitrary options, for middleware or plugins.
  *
- * ####Example:
+ * #### Example:
  *
  *     const agg = Model.aggregate(..).option({ allowDiskUse: true }); // Set the `allowDiskUse` option
  *     agg.options; // `{ allowDiskUse: true }`
@@ -849,7 +849,7 @@ Aggregate.prototype.option = function(value) {
  * 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:
+ * #### Example:
  *
  *     const cursor = Model.aggregate(..).cursor({ batchSize: 1000 });
  *     cursor.eachAsync(function(doc, i) {
@@ -875,7 +875,7 @@ Aggregate.prototype.cursor = function(options) {
 /**
  * Adds a collation
  *
- * ####Example:
+ * #### Example:
  *
  *     const res = await Model.aggregate(pipeline).collation({ locale: 'en_US', strength: 1 });
  *
@@ -896,7 +896,7 @@ Aggregate.prototype.collation = function(collation) {
 /**
  * Combines multiple aggregation pipelines.
  *
- * ####Example:
+ * #### Example:
  *
  *     const res = await Model.aggregate().facet({
  *       books: [{ groupBy: '$author' }],
@@ -919,7 +919,7 @@ Aggregate.prototype.facet = function(options) {
  * Helper for [Atlas Text Search](https://docs.atlas.mongodb.com/reference/atlas-search/tutorial/)'s
  * `$search` stage.
  *
- * ####Example:
+ * #### Example:
  *
  *     const res = await Model.aggregate().
  *      search({
@@ -944,7 +944,7 @@ Aggregate.prototype.search = function(options) {
 /**
  * Returns the current pipeline
  *
- * ####Example:
+ * #### Example:
  *
  *     MyModel.aggregate().match({ test: 1 }).pipeline(); // [{ $match: { test: 1 } }]
  *
@@ -960,7 +960,7 @@ Aggregate.prototype.pipeline = function() {
 /**
  * Executes the aggregate pipeline on the currently bound Model.
  *
- * ####Example:
+ * #### Example:
  *
  *     aggregate.exec(callback);
  *
@@ -1027,7 +1027,7 @@ Aggregate.prototype.exec = function(callback) {
 /**
  * Provides promise for aggregate.
  *
- * ####Example:
+ * #### Example:
  *
  *     Model.aggregate(..).then(successCallback, errorCallback);
  *
@@ -1059,7 +1059,7 @@ Aggregate.prototype.catch = function(reject) {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * ####Example
+ * #### Example
  *
  *     const agg = Model.aggregate([{ $match: { age: { $gte: 25 } } }]);
  *     for await (const doc of agg) {

package/lib/browser.js

@@ -46,7 +46,7 @@ exports.Error = require('./error/index');
 /**
  * The Mongoose [Schema](#schema_Schema) constructor
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     const Schema = mongoose.Schema;
@@ -61,12 +61,12 @@ exports.Schema = require('./schema');
 /**
  * The various Mongoose Types.
  *
- * ####Example:
+ * #### Example:
  *
  *     const mongoose = require('mongoose');
  *     const array = mongoose.Types.Array;
  *
- * ####Types:
+ * #### Types:
  *
  * - [Array](/docs/schematypes.html#arrays)
  * - [Buffer](/docs/schematypes.html#buffers)
@@ -98,7 +98,7 @@ exports.VirtualType = require('./virtualtype');
 /**
  * The various Mongoose SchemaTypes.
  *
- * ####Note:
+ * #### Note:
  *
  * _Alias of mongoose.Schema.Types for backwards compatibility._
  *

package/lib/connection.js

@@ -92,7 +92,7 @@ Connection.prototype.__proto__ = EventEmitter.prototype;
  *
  * Each state change emits its associated event name.
  *
- * ####Example
+ * #### Example
  *
  *     conn.on('connected', callback);
  *     conn.on('disconnected', callback);
@@ -131,7 +131,7 @@ Object.defineProperty(Connection.prototype, 'readyState', {
 /**
  * Gets the value of the option `key`. Equivalent to `conn.options[key]`
  *
- * ####Example:
+ * #### Example:
  *
  *     conn.get('test'); // returns the 'test' value
  *
@@ -155,7 +155,7 @@ Connection.prototype.get = function(key) {
  *
  * - `maxTimeMS`: Set [`maxTimeMS`](/docs/api.html#query_Query-maxTimeMS) for all queries on this connection.
  *
- * ####Example:
+ * #### Example:
  *
  *     conn.set('test', 'foo');
  *     conn.get('test'); // 'foo'
@@ -192,7 +192,7 @@ Connection.prototype.collections;
 /**
  * The name of the database this connection points to.
  *
- * ####Example
+ * #### Example
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').name; // "mydb"
  *
@@ -209,7 +209,7 @@ Connection.prototype.name;
  * a map from model names to models. Contains all models that have been
  * added to this connection using [`Connection#model()`](/docs/api/connection.html#connection_Connection-model).
  *
- * ####Example
+ * #### Example
  *
  *     const conn = mongoose.createConnection();
  *     const Test = conn.model('Test', mongoose.Schema({ name: String }));
@@ -229,7 +229,7 @@ Connection.prototype.models;
  * A number identifier for this connection. Used for debugging when
  * you have [multiple connections](/docs/connections.html#multiple_connections).
  *
- * ####Example
+ * #### Example
  *
  *     // The default connection has `id = 0`
  *     mongoose.connection.id; // 0
@@ -249,7 +249,7 @@ Connection.prototype.id;
 /**
  * The plugins that will be applied to all models created on this connection.
  *
- * ####Example:
+ * #### Example:
  *
  *     const db = mongoose.createConnection('mongodb://localhost:27017/mydb');
  *     db.plugin(() => console.log('Applied'));
@@ -273,7 +273,7 @@ Object.defineProperty(Connection.prototype, 'plugins', {
  * The host name portion of the URI. If multiple hosts, such as a replica set,
  * this will contain the first host name in the URI
  *
- * ####Example
+ * #### Example
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').host; // "localhost"
  *
@@ -293,7 +293,7 @@ Object.defineProperty(Connection.prototype, 'host', {
  * The port portion of the URI. If multiple hosts, such as a replica set,
  * this will contain the port from the first host name in the URI.
  *
- * ####Example
+ * #### Example
  *
  *     mongoose.createConnection('mongodb://localhost:27017/mydb').port; // 27017
  *
@@ -312,7 +312,7 @@ Object.defineProperty(Connection.prototype, 'port', {
 /**
  * The username specified in the URI
  *
- * ####Example
+ * #### Example
  *
  *     mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').user; // "val"
  *
@@ -331,7 +331,7 @@ Object.defineProperty(Connection.prototype, 'user', {
 /**
  * The password specified in the URI
  *
- * ####Example
+ * #### Example
  *
  *     mongoose.createConnection('mongodb://val:psw@localhost:27017/mydb').pass; // "psw"
  *
@@ -409,7 +409,7 @@ Connection.prototype.createCollection = _wrapConnHelper(function createCollectio
  * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
  * and [transactions](https://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
  *
- * ####Example:
+ * #### Example:
  *
  *     const session = await conn.startSession();
  *     let doc = await Person.findOne({ name: 'Ned Stark' }, null, { session });
@@ -447,7 +447,7 @@ Connection.prototype.startSession = _wrapConnHelper(function startSession(option
  * Calls the MongoDB driver's [`session.withTransaction()`](https://mongodb.github.io/node-mongodb-native/3.5/api/ClientSession.html#withTransaction),
  * but also handles resetting Mongoose document state as shown below.
  *
- * ####Example:
+ * #### Example:
  *
  *     const doc = new Person({ name: 'Will Riker' });
  *     await db.transaction(async function setRank(session) {
@@ -532,7 +532,7 @@ Connection.prototype.dropCollection = _wrapConnHelper(function dropCollection(co
  * Helper for `dropDatabase()`. Deletes the given database, including all
  * collections, documents, and indexes.
  *
- * ####Example:
+ * #### Example:
  *
  *     const conn = mongoose.createConnection('mongodb://localhost:27017/mydb');
  *     // Deletes the entire 'mydb' database
@@ -1037,7 +1037,7 @@ Connection.prototype.collection = function(name, options) {
  *
  * Equivalent to calling `.plugin(fn)` on each schema you create.
  *
- * ####Example:
+ * #### Example:
  *     const db = mongoose.createConnection('mongodb://localhost:27017/mydb');
  *     db.plugin(() => console.log('Applied'));
  *     db.plugins.length; // 1
@@ -1067,7 +1067,7 @@ Connection.prototype.plugin = function(fn, opts) {
  *
  * _When no `collection` argument is passed, Mongoose produces a collection name by passing the model `name` to the [utils.toCollectionName](#utils_exports.toCollectionName) method. This method pluralizes the name. If you don't like this behavior, either pass a collection name or set your schemas collection name option._
  *
- * ####Example:
+ * #### Example:
  *
  *     const schema = new Schema({ name: String }, { collection: 'actor' });
  *
@@ -1185,7 +1185,7 @@ Connection.prototype.model = function(name, schema, collection, options) {
  * use this function to clean up any models you created in your tests to
  * prevent OverwriteModelErrors.
  *
- * ####Example:
+ * #### Example:
  *
  *     conn.model('User', new Schema({ name: String }));
  *     console.log(conn.model('User')); // Model object
@@ -1243,7 +1243,7 @@ Connection.prototype.deleteModel = function(name) {
  * - 'end': Emitted if the underlying stream is closed
  * - 'close': Emitted if the underlying stream is closed
  *
- * ####Example:
+ * #### Example:
  *
  *     const User = conn.model('User', new Schema({ name: String }));
  *
@@ -1287,7 +1287,7 @@ Connection.prototype.watch = function(pipeline, options) {
  * successfully connects to MongoDB, or rejects if this connection failed
  * to connect.
  *
- * ####Example:
+ * #### Example:
  *     const conn = await mongoose.createConnection('mongodb://localhost:27017/test').
  *       asPromise();
  *     conn.readyState; // 1, means Mongoose is connected
@@ -1356,7 +1356,7 @@ Connection.prototype.optionsProvideAuthenticationData = function(options) {
  * Returns the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
  * that this connection uses to talk to MongoDB.
  *
- * ####Example:
+ * #### Example:
  *     const conn = await mongoose.createConnection('mongodb://localhost:27017/test');
  *
  *     conn.getClient(); // MongoClient { ... }
@@ -1374,7 +1374,7 @@ Connection.prototype.getClient = function getClient() {
  * that this connection uses to talk to MongoDB. This is useful if you already have a MongoClient instance, and want to
  * reuse it.
  *
- * ####Example:
+ * #### Example:
  *     const client = await mongodb.MongoClient.connect('mongodb://localhost:27017/test');
  *
  *     const conn = mongoose.createConnection().setClient(client);

package/lib/cursor/AggregationCursor.js

@@ -107,7 +107,7 @@ if (Symbol.asyncIterator != null) {
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
  *
- * ####Example
+ * #### Example
  *
  *     // Map documents returned by `data` events
  *     Thing.
@@ -226,7 +226,7 @@ AggregationCursor.prototype.eachAsync = function(fn, opts, callback) {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * ####Example
+ * #### Example
  *
  *     // Async iterator without explicitly calling `cursor()`. Mongoose still
  *     // creates an AggregationCursor instance internally.

package/lib/cursor/QueryCursor.js

@@ -112,7 +112,7 @@ QueryCursor.prototype._read = function() {
  * Registers a transform function which subsequently maps documents retrieved
  * via the streams interface or `.next()`
  *
- * ####Example
+ * #### Example
  *
  *     // Map documents returned by `data` events
  *     Thing.
@@ -211,7 +211,7 @@ QueryCursor.prototype.next = function(callback) {
  * will wait for the promise to resolve before iterating on to the next one.
  * Returns a promise that resolves when done.
  *
- * ####Example
+ * #### Example
  *
  *     // Iterate over documents asynchronously
  *     Thing.
@@ -298,7 +298,7 @@ QueryCursor.prototype._transformForAsyncIterator = function() {
  * You do not need to call this function explicitly, the JavaScript runtime
  * will call it for you.
  *
- * ####Example
+ * #### Example
  *
  *     // Works without using `cursor()`
  *     for await (const doc of Model.find([{ $sort: { name: 1 } }])) {