mongodb 5.1.0 → 5.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -25,7 +25,7 @@
     "email": "dbx-node@mongodb.com"
   },
   "dependencies": {
-    "bson": "^5.0.1",
+    "bson": "^5.2.0",
     "mongodb-connection-string-url": "^2.6.0",
     "socks": "^2.7.1"
   },
@@ -34,7 +34,7 @@
   },
   "peerDependencies": {
     "@aws-sdk/credential-providers": "^3.201.0",
-    "mongodb-client-encryption": "^2.3.0",
+    "mongodb-client-encryption": ">=2.3.0 <3",
     "snappy": "^7.2.2"
   },
   "peerDependenciesMeta": {
@@ -51,52 +51,51 @@
   "devDependencies": {
     "@iarna/toml": "^2.2.5",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@microsoft/api-extractor": "^7.33.7",
+    "@microsoft/api-extractor": "^7.34.4",
     "@microsoft/tsdoc-config": "^0.16.2",
-    "@mongodb-js/zstd": "^1.0.0",
-    "@types/chai": "^4.3.3",
+    "@mongodb-js/zstd": "^1.1.0",
+    "@types/chai": "^4.3.4",
     "@types/chai-subset": "^1.3.3",
-    "@types/express": "^4.17.14",
+    "@types/express": "^4.17.17",
     "@types/kerberos": "^1.1.1",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.0",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.19",
     "@types/saslprep": "^1.0.1",
-    "@types/semver": "^7.3.12",
+    "@types/semver": "^7.3.13",
     "@types/sinon": "^10.0.13",
-    "@types/sinon-chai": "^3.2.8",
+    "@types/sinon-chai": "^3.2.9",
     "@types/whatwg-url": "^11.0.0",
-    "@typescript-eslint/eslint-plugin": "^5.48.0",
-    "@typescript-eslint/parser": "^5.48.0",
-    "chai": "^4.3.6",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
+    "chai": "^4.3.7",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.2",
-    "eslint": "^8.31.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-simple-import-sort": "^8.0.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "express": "^4.18.2",
     "js-yaml": "^4.1.0",
-    "mocha": "^9.2.2",
+    "mocha": "^10.2.0",
     "mocha-sinon": "^2.1.2",
-    "mongodb-legacy": "^4.0.0",
+    "mongodb-legacy": "^5.0.0",
     "nyc": "^15.1.0",
-    "prettier": "^2.7.1",
-    "rimraf": "^3.0.2",
+    "prettier": "^2.8.4",
     "semver": "^7.3.8",
-    "sinon": "^13.0.1",
+    "sinon": "^15.0.2",
     "sinon-chai": "^3.7.0",
     "snappy": "^7.2.2",
     "source-map-support": "^0.5.21",
     "standard-version": "^9.5.0",
     "ts-node": "^10.9.1",
-    "tsd": "^0.25.0",
-    "typescript": "^4.9.4",
+    "tsd": "^0.27.0",
+    "typescript": "^4.9.5",
     "typescript-cached-transpile": "^0.0.6",
     "v8-heapsnapshot": "^1.2.0",
     "xml2js": "^0.4.23",
-    "yargs": "^17.6.0"
+    "yargs": "^17.7.1"
   },
   "license": "Apache-2.0",
   "engines": {
@@ -109,7 +108,7 @@
   "scripts": {
     "build:evergreen": "node .evergreen/generate_evergreen_tasks.js",
     "build:ts": "node ./node_modules/typescript/bin/tsc",
-    "build:dts": "npm run build:ts && api-extractor run && rimraf 'lib/**/*.d.ts*'",
+    "build:dts": "npm run build:ts && api-extractor run && node etc/clean_definition_files.cjs",
     "build:docs": "./etc/docs/build.ts",
     "build:typedoc": "typedoc",
     "check:bench": "node test/benchmarks/driverBench",
@@ -127,12 +126,12 @@
     "check:ts": "node ./node_modules/typescript/bin/tsc -v && node ./node_modules/typescript/bin/tsc --noEmit",
     "check:atlas": "mocha --config test/manual/mocharc.json test/manual/atlas_connectivity.test.js",
     "check:adl": "mocha --config test/mocha_mongodb.json test/manual/atlas-data-lake-testing",
-    "check:aws": "mocha --config test/mocha_mongodb.json test/integration/auth/mongodb_aws.test.ts",
-    "check:oidc": "mocha --config test/mocha_mongodb.json test/integration/auth/mongodb_oidc.test.ts",
+    "check:aws": "nyc mocha --config test/mocha_mongodb.json test/integration/auth/mongodb_aws.test.ts",
+    "check:oidc": "mocha --config test/manual/mocharc.json test/manual/mongodb_oidc.prose.test.ts",
     "check:ocsp": "mocha --config test/manual/mocharc.json test/manual/ocsp_support.test.js",
-    "check:kerberos": "mocha --config test/manual/mocharc.json test/manual/kerberos.test.js",
+    "check:kerberos": "nyc mocha --config test/manual/mocharc.json test/manual/kerberos.test.ts",
     "check:tls": "mocha --config test/manual/mocharc.json test/manual/tls_support.test.js",
-    "check:ldap": "mocha --config test/manual/mocharc.json test/manual/ldap.test.js",
+    "check:ldap": "nyc mocha --config test/manual/mocharc.json test/manual/ldap.test.js",
     "check:socks5": "mocha --config test/manual/mocharc.json test/manual/socks5.test.ts",
     "check:csfle": "mocha --config test/mocha_mongodb.json test/integration/client-side-encryption",
     "check:snappy": "mocha test/unit/assorted/snappy.test.js",

package/src/admin.ts

@@ -106,6 +106,8 @@ export class Admin {
    * @param username - The username for the new user
    * @param passwordOrOptions - An optional password for the new user, or the options for the command
    * @param options - Optional settings for the command
+   * @deprecated Use the createUser command in `db.command()` instead.
+   * @see https://www.mongodb.com/docs/manual/reference/command/createUser/
    */
   async addUser(
     username: string,

package/src/bulk/common.ts

@@ -39,7 +39,7 @@ export const BatchType = Object.freeze({
 } as const);
 
 /** @public */
-export type BatchType = typeof BatchType[keyof typeof BatchType];
+export type BatchType = (typeof BatchType)[keyof typeof BatchType];
 
 /** @public */
 export interface InsertOneModel<TSchema extends Document = Document> {
@@ -212,37 +212,58 @@ export class BulkWriteResult {
     return this.result.ok;
   }
 
-  /** The number of inserted documents */
+  /**
+   * The number of inserted documents
+   * @deprecated Use insertedCount instead.
+   */
   get nInserted(): number {
     return this.result.nInserted;
   }
 
-  /** Number of upserted documents */
+  /**
+   * Number of upserted documents
+   * @deprecated User upsertedCount instead.
+   */
   get nUpserted(): number {
     return this.result.nUpserted;
   }
 
-  /** Number of matched documents */
+  /**
+   * Number of matched documents
+   * @deprecated Use matchedCount instead.
+   */
   get nMatched(): number {
     return this.result.nMatched;
   }
 
-  /** Number of documents updated physically on disk */
+  /**
+   * Number of documents updated physically on disk
+   * @deprecated Use modifiedCount instead.
+   */
   get nModified(): number {
     return this.result.nModified;
   }
 
-  /** Number of removed documents */
+  /**
+   * Number of removed documents
+   * @deprecated Use deletedCount instead.
+   */
   get nRemoved(): number {
     return this.result.nRemoved;
   }
 
-  /** Returns an array of all inserted ids */
+  /**
+   * Returns an array of all inserted ids
+   * @deprecated Use insertedIds instead.
+   */
   getInsertedIds(): Document[] {
     return this.result.insertedIds;
   }
 
-  /** Returns an array of all upserted ids */
+  /**
+   * Returns an array of all upserted ids
+   * @deprecated Use upsertedIds instead.
+   */
   getUpsertedIds(): Document[] {
     return this.result.upserted;
   }

package/src/change_stream.ts

@@ -74,7 +74,7 @@ export type ResumeToken = unknown;
 /**
  * Represents a specific point in time on a server. Can be retrieved by using `db.command()`
  * @public
- * @see https://docs.mongodb.com/manual/reference/method/db.runCommand/#response
+ * @see https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response
  */
 export type OperationTime = Timestamp;
 
@@ -117,19 +117,19 @@ export interface ChangeStreamOptions extends Omit<AggregateOptions, 'writeConcer
   maxAwaitTimeMS?: number;
   /**
    * Allows you to start a changeStream after a specified event.
-   * @see https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams
+   * @see https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams
    */
   resumeAfter?: ResumeToken;
   /**
    * Similar to resumeAfter, but will allow you to start after an invalidated event.
-   * @see https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams
+   * @see https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams
    */
   startAfter?: ResumeToken;
   /** Will start the changeStream after the specified operationTime. */
   startAtOperationTime?: OperationTime;
   /**
    * The number of documents to return per batch.
-   * @see https://docs.mongodb.com/manual/reference/command/aggregate
+   * @see https://www.mongodb.com/docs/manual/reference/command/aggregate
    */
   batchSize?: number;
 
@@ -583,7 +583,7 @@ export class ChangeStream<
    * @internal
    *
    * @param parent - The parent object that created this change stream
-   * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents
+   * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents
    */
   constructor(
     parent: OperationParent,

package/src/cmap/auth/auth_provider.ts

@@ -1,20 +1,22 @@
 import type { Document } from '../../bson';
 import { MongoRuntimeError } from '../../error';
-import type { Callback, ClientMetadataOptions } from '../../utils';
 import type { HandshakeDocument } from '../connect';
 import type { Connection, ConnectionOptions } from '../connection';
 import type { MongoCredentials } from './mongo_credentials';
 
-export type AuthContextOptions = ConnectionOptions & ClientMetadataOptions;
-
-/** Context used during authentication */
+/**
+ * Context used during authentication
+ * @internal
+ */
 export class AuthContext {
   /** The connection to authenticate */
   connection: Connection;
   /** The credentials to use for authentication */
   credentials?: MongoCredentials;
+  /** If the context is for reauthentication. */
+  reauthenticating = false;
   /** The options passed to the `connect` method */
-  options: AuthContextOptions;
+  options: ConnectionOptions;
 
   /** A response from an initial auth attempt, only some mechanisms use this (e.g, SCRAM) */
   response?: Document;
@@ -24,7 +26,7 @@ export class AuthContext {
   constructor(
     connection: Connection,
     credentials: MongoCredentials | undefined,
-    options: AuthContextOptions
+    options: ConnectionOptions
   ) {
     this.connection = connection;
     this.credentials = credentials;
@@ -32,29 +34,40 @@ export class AuthContext {
   }
 }
 
-export class AuthProvider {
+export abstract class AuthProvider {
   /**
    * Prepare the handshake document before the initial handshake.
    *
    * @param handshakeDoc - The document used for the initial handshake on a connection
    * @param authContext - Context for authentication flow
    */
-  prepare(
+  async prepare(
     handshakeDoc: HandshakeDocument,
-    authContext: AuthContext,
-    callback: Callback<HandshakeDocument>
-  ): void {
-    callback(undefined, handshakeDoc);
+    _authContext: AuthContext
+  ): Promise<HandshakeDocument> {
+    return handshakeDoc;
   }
 
   /**
    * Authenticate
    *
    * @param context - A shared context for authentication flow
-   * @param callback - The callback to return the result from the authentication
    */
-  auth(context: AuthContext, callback: Callback): void {
-    // TODO(NODE-3483): Replace this with MongoMethodOverrideError
-    callback(new MongoRuntimeError('`auth` method must be overridden by subclass'));
+  abstract auth(context: AuthContext): Promise<void>;
+
+  /**
+   * Reauthenticate.
+   * @param context - The shared auth context.
+   */
+  async reauth(context: AuthContext): Promise<void> {
+    if (context.reauthenticating) {
+      throw new MongoRuntimeError('Reauthentication already in progress.');
+    }
+    try {
+      context.reauthenticating = true;
+      await this.auth(context);
+    } finally {
+      context.reauthenticating = false;
+    }
   }
 }