mongoose 6.3.2 → 6.3.5

package/lib/schema/decimal128.js

@@ -6,9 +6,9 @@
 
 const SchemaType = require('../schematype');
 const CastError = SchemaType.CastError;
-const Decimal128Type = require('../types/decimal128');
 const castDecimal128 = require('../cast/decimal128');
 const utils = require('../utils');
+const isBsonType = require('../helpers/isBsonType');
 
 /**
  * Decimal128 SchemaType constructor.
@@ -105,7 +105,7 @@ Decimal128.cast = function cast(caster) {
  */
 
 Decimal128._defaultCaster = v => {
-  if (v != null && !(v instanceof Decimal128Type)) {
+  if (v != null && !isBsonType(v, 'Decimal128')) {
     throw new Error();
   }
   return v;
@@ -115,7 +115,7 @@ Decimal128._defaultCaster = v => {
  * ignore
  */
 
-Decimal128._checkRequired = v => v instanceof Decimal128Type;
+Decimal128._checkRequired = v => isBsonType(v, 'Decimal128');
 
 /**
  * Override the function the required validator uses to check whether a string
@@ -164,7 +164,7 @@ Decimal128.prototype.checkRequired = function checkRequired(value, doc) {
 
 Decimal128.prototype.cast = function(value, doc, init) {
   if (SchemaType._isRef(this, value, doc, init)) {
-    if (value instanceof Decimal128Type) {
+    if (isBsonType(value, 'Decimal128')) {
       return value;
     }
 

package/lib/schema/string.js

@@ -9,6 +9,7 @@ const MongooseError = require('../error/index');
 const SchemaStringOptions = require('../options/SchemaStringOptions');
 const castString = require('../cast/string');
 const utils = require('../utils');
+const isBsonType = require('../helpers/isBsonType');
 
 const CastError = SchemaType.CastError;
 
@@ -676,7 +677,7 @@ SchemaString.prototype.castForQuery = function($conditional, val) {
     return handler.call(this, val);
   }
   val = $conditional;
-  if (Object.prototype.toString.call(val) === '[object RegExp]') {
+  if (Object.prototype.toString.call(val) === '[object RegExp]' || isBsonType(val, 'BSONRegExp')) {
     return val;
   }
 

package/lib/schema.js

@@ -1235,6 +1235,15 @@ function createMapNestedSchemaType(schema, schemaType, path, obj, options) {
       _mapType = { [schema.options.typeKey]: obj.of };
     }
 
+    if (_mapType[schema.options.typeKey] && _mapType[schema.options.typeKey].instanceOfSchema) {
+      const subdocumentSchema = _mapType[schema.options.typeKey];
+      subdocumentSchema.eachPath((subpath, type) => {
+        if (type.options.select === true || type.options.select === false) {
+          throw new MongooseError('Cannot use schema-level projections (`select: true` or `select: false`) within maps at path "' + path + '.' + subpath + '"');
+        }
+      });
+    }
+
     if (utils.hasUserDefinedProperty(obj, 'ref')) {
       _mapType.ref = obj.ref;
     }

package/lib/types/DocumentArray/methods/index.js

@@ -2,11 +2,11 @@
 
 const ArrayMethods = require('../../array/methods');
 const Document = require('../../../document');
-const ObjectId = require('../../objectid');
 const castObjectId = require('../../../cast/objectid');
 const getDiscriminatorByValue = require('../../../helpers/discriminator/getDiscriminatorByValue');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
 const arrayPathSymbol = require('../../../helpers/symbols').arrayPathSymbol;
@@ -66,7 +66,7 @@ const methods = {
     // only objects are permitted so we can safely assume that
     // non-objects are to be interpreted as _id
     if (Buffer.isBuffer(value) ||
-        value instanceof ObjectId || !utils.isObject(value)) {
+        isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
       value = { _id: value };
     }
 
@@ -134,7 +134,7 @@ const methods = {
         if (sid == _id._id) {
           return val;
         }
-      } else if (!(id instanceof ObjectId) && !(_id instanceof ObjectId)) {
+      } else if (!isBsonType(id, 'ObjectID') && !isBsonType(_id, 'ObjectID')) {
         if (id == _id || utils.deepEqual(id, _id)) {
           return val;
         }

package/lib/types/array/methods/index.js

@@ -3,10 +3,10 @@
 const Document = require('../../../document');
 const ArraySubdocument = require('../../ArraySubdocument');
 const MongooseError = require('../../../error/mongooseError');
-const ObjectId = require('../../objectid');
 const cleanModifiedSubpaths = require('../../../helpers/document/cleanModifiedSubpaths');
 const internalToObjectOptions = require('../../../options').internalToObjectOptions;
 const utils = require('../../../utils');
+const isBsonType = require('../../../helpers/isBsonType');
 
 const arrayAtomicsSymbol = require('../../../helpers/symbols').arrayAtomicsSymbol;
 const arrayParentSymbol = require('../../../helpers/symbols').arrayParentSymbol;
@@ -227,7 +227,7 @@ const methods = {
       // only objects are permitted so we can safely assume that
       // non-objects are to be interpreted as _id
       if (Buffer.isBuffer(value) ||
-          value instanceof ObjectId || !utils.isObject(value)) {
+          isBsonType(value, 'ObjectID') || !utils.isObject(value)) {
         value = { _id: value };
       }
 
@@ -469,7 +469,7 @@ const methods = {
    */
 
   indexOf(obj, fromIndex) {
-    if (obj instanceof ObjectId) {
+    if (isBsonType(obj, 'ObjectID')) {
       obj = obj.toString();
     }
 

package/lib/types/map.js

@@ -1,13 +1,13 @@
 'use strict';
 
 const Mixed = require('../schema/mixed');
-const ObjectId = require('./objectid');
 const clone = require('../helpers/clone');
 const deepEqual = require('../utils').deepEqual;
 const getConstructorName = require('../helpers/getConstructorName');
 const handleSpreadDoc = require('../helpers/document/handleSpreadDoc');
 const util = require('util');
 const specialProperties = require('../helpers/specialProperties');
+const isBsonType = require('../helpers/isBsonType');
 
 const populateModelSymbol = require('../helpers/symbols').populateModelSymbol;
 
@@ -43,7 +43,7 @@ class MongooseMap extends Map {
   }
 
   get(key, options) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -55,7 +55,7 @@ class MongooseMap extends Map {
   }
 
   set(key, value) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 
@@ -117,7 +117,7 @@ class MongooseMap extends Map {
   }
 
   delete(key) {
-    if (key instanceof ObjectId) {
+    if (isBsonType(key, 'ObjectID')) {
       key = key.toString();
     }
 

package/lib/utils.js

@@ -6,7 +6,6 @@
 
 const ms = require('ms');
 const mpath = require('mpath');
-const Decimal = require('./types/decimal128');
 const ObjectId = require('./types/objectid');
 const PopulateOptions = require('./options/PopulateOptions');
 const clone = require('./helpers/clone');
@@ -307,7 +306,7 @@ exports.merge = function merge(to, from, options, path) {
             to[key] = from[key].clone();
           }
           continue;
-        } else if (from[key] instanceof ObjectId) {
+        } else if (isBsonType(from[key], 'ObjectID')) {
           to[key] = new ObjectId(from[key]);
           continue;
         }
@@ -481,7 +480,7 @@ exports.tick = function tick(callback) {
  */
 
 exports.isMongooseType = function(v) {
-  return v instanceof ObjectId || v instanceof Decimal || v instanceof Buffer;
+  return isBsonType(v, 'ObjectID') || isBsonType(v, 'Decimal128') || v instanceof Buffer;
 };
 
 exports.isMongooseObject = isMongooseObject;
@@ -516,6 +515,10 @@ exports.populate = function populate(path, select, model, match, options, subPop
   let obj = null;
   if (arguments.length === 1) {
     if (path instanceof PopulateOptions) {
+      // If reusing old populate docs, avoid reusing `_docs` because that may
+      // lead to bugs and memory leaks. See gh-11641
+      path._docs = [];
+      path._childDocs = [];
       return [path];
     }
 
@@ -791,7 +794,7 @@ exports.array.unique = function(arr) {
       }
       ret.push(item);
       primitives.add(item);
-    } else if (item instanceof ObjectId) {
+    } else if (isBsonType(item, 'ObjectID')) {
       if (ids.has(item.toString())) {
         continue;
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose",
   "description": "Mongoose MongoDB ODM",
-  "version": "6.3.2",
+  "version": "6.3.5",
   "author": "Guillermo Rauch <guillermo@learnboost.com>",
   "keywords": [
     "mongodb",
@@ -23,7 +23,7 @@
     "kareem": "2.3.5",
     "mongodb": "4.5.0",
     "mpath": "0.9.0",
-    "mquery": "4.0.2",
+    "mquery": "4.0.3",
     "ms": "2.1.3",
     "sift": "16.0.0"
   },
@@ -40,7 +40,7 @@
     "babel-loader": "8.2.5",
     "benchmark": "2.1.4",
     "bluebird": "3.7.2",
-    "buffer": "6.0.3",
+    "buffer": "^5.6.0",
     "cheerio": "1.0.0-rc.10",
     "crypto-browserify": "3.12.0",
     "dox": "0.3.1",
@@ -50,15 +50,18 @@
     "lodash.isequal": "4.5.0",
     "lodash.isequalwith": "4.4.0",
     "marked": "4.0.14",
+    "mkdirp": "^1.0.4",
     "mocha": "10.0.0",
     "moment": "2.x",
     "mongodb-memory-server": "8.5.2",
+    "ncp": "^2.0.0",
     "nyc": "15.1.0",
     "pug": "3.0.2",
     "q": "1.5.1",
     "serve-handler": "6.1.3",
     "sinon": "13.0.2",
     "stream-browserify": "3.0.0",
+    "ts-benchmark": "^1.0.2",
     "tsd": "0.20.0",
     "typescript": "4.6.4",
     "uuid": "8.3.2",
@@ -68,6 +71,21 @@
     "lib": "./lib/mongoose"
   },
   "scripts": {
+    "docs:clean": "npm run docs:clean:stable",
+    "docs:clean:stable": "rimraf index.html && rimraf -rf ./docs/*.html  && rimraf -rf ./docs/api && rimraf -rf ./docs/tutorials/*.html && rimraf -rf ./docs/typescript/*.html && rimraf -rf ./docs/*.html && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:clean:legacy": "rimraf index.html && rimraf -rf ./docs/5.x && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:copy:tmp": "mkdirp ./tmp/docs/css && mkdirp ./tmp/docs/js && mkdirp ./tmp/docs/images && mkdirp ./tmp/docs/tutorials && mkdirp ./tmp/docs/typescript && ncp ./docs/css ./tmp/docs/css --filter=.css$ && ncp ./docs/js ./tmp/docs/js --filter=.js$ && ncp ./docs/images ./tmp/docs/images && ncp ./docs/tutorials ./tmp/docs/tutorials && ncp ./docs/typescript ./tmp/docs/typescript && cp index.html ./tmp",
+    "docs:copy:tmp:legacy": "rimraf ./docs/5.x && ncp ./tmp ./docs/5.x",
+    "docs:checkout:gh-pages": "git checkout gh-pages",
+    "docs:checkout:legacy": "git checkout 5.x",
+    "docs:generate": "node website.js",
+    "docs:generate:search": "node docs/search.js",
+    "docs:merge:stable": "git merge master",
+    "docs:merge:legacy": "git merge 5.x",
+    "docs:test": "npm run docs:generate && npm run docs:generate:search",
+    "docs:view": "node website.js && node static.js",
+    "docs:prepare:publish:stable": "npm run docs:checkout:gh-pages && npm run docs:merge:stable && npm run docs:clean:stable && npm run docs:generate && npm run docs:generate:search",
+    "docs:prepare:publish:legacy": "npm run docs:checkout:legacy && npm run docs:merge:legacy && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && docs:checkout:gh-pages && docs:copy:tmp:legacy",
     "lint": "eslint .",
     "lint-js": "eslint . --ext .js",
     "lint-ts": "eslint . --ext .ts",
@@ -80,7 +98,9 @@
     "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
     "test-tsd": "node ./test/types/check-types-filename && tsd",
     "tdd": "mocha ./test/*.test.js ./test/typescript/main.test.js --inspect --watch --recursive --watch-files ./**/*.js",
-    "test-coverage": "nyc --reporter=html --reporter=text npm test"
+    "test-coverage": "nyc --reporter=html --reporter=text npm test",
+    "ts-benchmark": "ts-benchmark -p ./benchmarks/typescript/simple -f 17 18 29 32",
+    "ts-benchmark-watch": "ts-benchmark -p ./benchmarks/typescript/simple -w ./types -i -s -f 17 18 29 32 -b master"
   },
   "main": "./index.js",
   "types": "./types/index.d.ts",

package/types/aggregate.d.ts

@@ -1,7 +1,8 @@
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  interface AggregateOptions {
+  interface AggregateOptions extends
+    SessionOption {
     /**
      * If true, the MongoDB server will use the hard drive to store data during this aggregation.
      */
@@ -56,8 +57,6 @@ declare module 'mongoose' {
      * The preferred read preference.
      */
     readPreference?: mongodb.ReadPreferenceLike;
-    /** The ClientSession for this aggregation */
-    session?: mongodb.ClientSession;
     /**
      * Specifies the write concern.
      */
@@ -65,7 +64,7 @@ declare module 'mongoose' {
     [key: string]: any;
   }
 
-  class Aggregate<R> {
+  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
      * You do not need to call this function explicitly, the JavaScript runtime

package/types/callback.d.ts

@@ -0,0 +1,8 @@
+declare module 'mongoose' {
+  type CallbackError = NativeError | null;
+
+  type Callback<T = any> = (error: CallbackError, result: T) => void;
+
+  type CallbackWithoutResult = (error: CallbackError) => void;
+  type CallbackWithoutResultAndOptionalError = (error?: CallbackError) => void;
+}

package/types/collection.d.ts

@@ -0,0 +1,46 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /*
+   * section collection.js
+   * http://mongoosejs.com/docs/api.html#collection-js
+   */
+  interface CollectionBase<T extends mongodb.Document> extends mongodb.Collection<T> {
+    /*
+     * Abstract methods. Some of these are already defined on the
+     * mongodb.Collection interface so they've been commented out.
+     */
+    ensureIndex(...args: any[]): any;
+    findAndModify(...args: any[]): any;
+    getIndexes(...args: any[]): any;
+
+    /** The collection name */
+    collectionName: string;
+    /** The Connection instance */
+    conn: Connection;
+    /** The collection name */
+    name: string;
+  }
+
+  /*
+   * section drivers/node-mongodb-native/collection.js
+   * http://mongoosejs.com/docs/api.html#drivers-node-mongodb-native-collection-js
+   */
+  interface Collection<T extends mongodb.Document = mongodb.Document> extends CollectionBase<T> {
+    /**
+     * Collection constructor
+     * @param name name of the collection
+     * @param conn A MongooseConnection instance
+     * @param opts optional collection options
+     */
+    // eslint-disable-next-line @typescript-eslint/no-misused-new
+    new(name: string, conn: Connection, opts?: any): Collection<T>;
+    /** Formatter for debug print args */
+    $format(arg: any, color?: boolean, shell?: boolean): string;
+    /** Debug print helper */
+    $print(name: string, i: string | number, args: any[], color?: boolean, shell?: boolean): void;
+    /** Retrieves information about this collections indexes. */
+    getIndexes(): ReturnType<mongodb.Collection<T>['indexInformation']>;
+  }
+  let Collection: Collection;
+}

package/types/connection.d.ts

@@ -2,16 +2,36 @@ declare module 'mongoose' {
   import mongodb = require('mongodb');
   import events = require('events');
 
+  /** The Mongoose module's default connection. Equivalent to `mongoose.connections[0]`, see [`connections`](#mongoose_Mongoose-connections). */
+  const connection: Connection;
+
+  /** An array containing all connections associated with this Mongoose instance. */
+  const connections: Connection[];
+
+  /** Opens Mongoose's default connection to MongoDB, see [connections docs](https://mongoosejs.com/docs/connections.html) */
+  function connect(uri: string, options: ConnectOptions, callback: CallbackWithoutResult): void;
+  function connect(uri: string, callback: CallbackWithoutResult): void;
+  function connect(uri: string, options?: ConnectOptions): Promise<Mongoose>;
+
+  /** Creates a Connection instance. */
+  function createConnection(uri: string, options: ConnectOptions, callback: Callback<Connection>): void;
+  function createConnection(uri: string, callback: Callback<Connection>): void;
+  function createConnection(uri: string, options?: ConnectOptions): Connection;
+  function createConnection(): Connection;
+
+  function disconnect(callback: CallbackWithoutResult): void;
+  function disconnect(): Promise<void>;
+
   /**
-     * Connection ready state
-     *
-     * - 0 = disconnected
-     * - 1 = connected
-     * - 2 = connecting
-     * - 3 = disconnecting
-     * - 99 = uninitialized
-     */
-  export enum ConnectionStates {
+   * Connection ready state
+   *
+   * - 0 = disconnected
+   * - 1 = connected
+   * - 2 = connecting
+   * - 3 = disconnecting
+   * - 99 = uninitialized
+   */
+  enum ConnectionStates {
     disconnected = 0,
     connected = 1,
     connecting = 2,
@@ -20,7 +40,7 @@ declare module 'mongoose' {
   }
 
   /** Expose connection states for user-land */
-  export const STATES: typeof ConnectionStates;
+  const STATES: typeof ConnectionStates;
 
   interface ConnectOptions extends mongodb.MongoClientOptions {
     /** Set to false to [disable buffering](http://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection. */
@@ -37,7 +57,7 @@ declare module 'mongoose' {
     autoCreate?: boolean;
   }
 
-  class Connection extends events.EventEmitter {
+  class Connection extends events.EventEmitter implements SessionStarter {
     /** Returns a promise that resolves when this connection successfully connects to MongoDB */
     asPromise(): Promise<this>;
 
@@ -59,32 +79,32 @@ declare module 'mongoose' {
     readonly db: mongodb.Db;
 
     /**
-       * Helper for `createCollection()`. Will explicitly create the given collection
-       * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
-       * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
-       */
+     * Helper for `createCollection()`. Will explicitly create the given collection
+     * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
+     * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
+     */
     createCollection<T extends AnyObject = AnyObject>(name: string, options: mongodb.CreateCollectionOptions, callback: Callback<mongodb.Collection<T>>): void;
     createCollection<T extends AnyObject = AnyObject>(name: string, callback: Callback<mongodb.Collection<T>>): void;
     createCollection<T extends AnyObject = AnyObject>(name: string, options?: mongodb.CreateCollectionOptions): Promise<mongodb.Collection<T>>;
 
     /**
-       * Removes the model named `name` from this connection, if it exists. You can
-       * use this function to clean up any models you created in your tests to
-       * prevent OverwriteModelErrors.
-       */
-    deleteModel(name: string): this;
+     * Removes the model named `name` from this connection, if it exists. You can
+     * use this function to clean up any models you created in your tests to
+     * prevent OverwriteModelErrors.
+     */
+    deleteModel(name: string | RegExp): this;
 
     /**
-       * Helper for `dropCollection()`. Will delete the given collection, including
-       * all documents and indexes.
-       */
+     * Helper for `dropCollection()`. Will delete the given collection, including
+     * all documents and indexes.
+     */
     dropCollection(collection: string, callback: CallbackWithoutResult): void;
     dropCollection(collection: string): Promise<void>;
 
     /**
-       * Helper for `dropDatabase()`. Deletes the given database, including all
-       * collections, documents, and indexes.
-       */
+     * Helper for `dropDatabase()`. Deletes the given database, including all
+     * collections, documents, and indexes.
+     */
     dropDatabase(callback: CallbackWithoutResult): void;
     dropDatabase(): Promise<void>;
 
@@ -92,28 +112,28 @@ declare module 'mongoose' {
     get(key: string): any;
 
     /**
-       * Returns the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
-       * that this connection uses to talk to MongoDB.
-       */
+     * Returns the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
+     * that this connection uses to talk to MongoDB.
+     */
     getClient(): mongodb.MongoClient;
 
     /**
-       * 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
-       */
+     * 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
+     */
     readonly host: string;
 
     /**
-       * A number identifier for this connection. Used for debugging when
-       * you have [multiple connections](/docs/connections.html#multiple_connections).
-       */
+     * A number identifier for this connection. Used for debugging when
+     * you have [multiple connections](/docs/connections.html#multiple_connections).
+     */
     readonly id: number;
 
     /**
-       * A [POJO](https://masteringjs.io/tutorials/fundamentals/pojo) containing
-       * 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).
-       */
+     * A [POJO](https://masteringjs.io/tutorials/fundamentals/pojo) containing
+     * 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).
+     */
     readonly models: Readonly<{ [index: string]: Model<any> }>;
 
     /** Defines or retrieves a model. */
@@ -140,9 +160,9 @@ declare module 'mongoose' {
     readonly pass: string;
 
     /**
-       * 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.
-       */
+     * 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.
+     */
     readonly port: number;
 
     /** Declares a plugin executed on all schemas you pass to `conn.model()` */
@@ -152,51 +172,51 @@ declare module 'mongoose' {
     plugins: Array<any>;
 
     /**
-       * Connection ready state
-       *
-       * - 0 = disconnected
-       * - 1 = connected
-       * - 2 = connecting
-       * - 3 = disconnecting
-       * - 99 = uninitialized
-       */
+     * Connection ready state
+     *
+     * - 0 = disconnected
+     * - 1 = connected
+     * - 2 = connecting
+     * - 3 = disconnecting
+     * - 99 = uninitialized
+     */
     readonly readyState: ConnectionStates;
 
     /** Sets the value of the option `key`. */
     set(key: string, value: any): any;
 
     /**
-       * Set the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
-       * that this connection uses to talk to MongoDB. This is useful if you already have a MongoClient instance, and want to
-       * reuse it.
-       */
+     * Set the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
+     * that this connection uses to talk to MongoDB. This is useful if you already have a MongoClient instance, and want to
+     * reuse it.
+     */
     setClient(client: mongodb.MongoClient): this;
 
     /**
-       * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
-       * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
-       * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
-       */
-    startSession(options: mongodb.ClientSessionOptions | undefined | null, callback: Callback<mongodb.ClientSession>): void;
-    startSession(callback: Callback<mongodb.ClientSession>): void;
-    startSession(options?: mongodb.ClientSessionOptions): Promise<mongodb.ClientSession>;
+     * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
+     * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
+     * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
+     */
+    startSession(options: ClientSessionOptions | undefined | null, callback: Callback<ClientSession>): void;
+    startSession(callback: Callback<ClientSession>): void;
+    startSession(options?: ClientSessionOptions): Promise<ClientSession>;
 
     /**
-       * Makes the indexes in MongoDB match the indexes defined in every model's
-       * schema. This function will drop any indexes that are not defined in
-       * the model's schema except the `_id` index, and build any indexes that
-       * are in your schema but not in MongoDB.
-       */
+     * Makes the indexes in MongoDB match the indexes defined in every model's
+     * schema. This function will drop any indexes that are not defined in
+     * the model's schema except the `_id` index, and build any indexes that
+     * are in your schema but not in MongoDB.
+     */
     syncIndexes(options: SyncIndexesOptions | undefined | null, callback: Callback<ConnectionSyncIndexesResult>): void;
     syncIndexes(options?: SyncIndexesOptions): Promise<ConnectionSyncIndexesResult>;
 
     /**
-       * _Requires MongoDB >= 3.6.0._ Executes the wrapped async function
-       * in a transaction. Mongoose will commit the transaction if the
-       * async function executes successfully and attempt to retry if
-       * there was a retryable error.
-       */
-    transaction(fn: (session: mongodb.ClientSession) => Promise<any>): Promise<void>;
+     * _Requires MongoDB >= 3.6.0._ Executes the wrapped async function
+     * in a transaction. Mongoose will commit the transaction if the
+     * async function executes successfully and attempt to retry if
+     * there was a retryable error.
+     */
+    transaction(fn: (session: mongodb.ClientSession) => Promise<any>, options?: mongodb.TransactionOptions): Promise<void>;
 
     /** Switches to a different database using the same connection pool. */
     useDb(name: string, options?: { useCache?: boolean, noListener?: boolean }): Connection;