@mongosh/shell-api 3.18.0 → 3.20.0

package/lib/api-processed.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 
 import type { Agent } from 'https';
+import type { AgentConnectOpts } from 'agent-base';
 import { Binary } from 'bson';
 import { BSONRegExp } from 'bson';
 import { BSONSymbol } from 'bson';
@@ -26,6 +27,7 @@ import { ObjectId } from 'bson';
 import type { ObjectIdLike } from 'bson';
 import { Readable } from 'stream';
 import type { RequestOptions } from 'https';
+import type { SecureContextOptions } from 'tls';
 import type { SerializeOptions } from 'bson';
 import type { ServerResponse } from 'http';
 import type { SrvRecord } from 'dns';
@@ -884,6 +886,10 @@ declare interface AutoEncryptionOptions {
   bypassAutoEncryption?: boolean;
   /** Allows users to bypass query analysis */
   bypassQueryAnalysis?: boolean;
+  /**
+   * Sets the expiration time for the DEK in the cache in milliseconds. Defaults to 60000.  0 means no timeout.
+   */
+  keyExpirationMS?: number;
   options?: {
     /** An optional hook to catch logging messages from the underlying encryption engine */
     logger?: (level: AutoEncryptionLoggerLevel, message: string) => void;
@@ -1214,10 +1220,10 @@ declare class BulkFindOp extends ShellApiWithMongoClass {
 
 /** @public */
 declare abstract class BulkOperationBase {
-  private collection;
   isOrdered: boolean;
   /* Excluded from this release type: s */
   operationId?: number;
+  private collection;
   /* Excluded from this release type: __constructor */
   /**
    * Add a single insert document to the bulk operation
@@ -1350,7 +1356,7 @@ declare class BulkWriteResult {
   getRawResponse(): Document_2;
   /** Returns true if the bulk operation contains a write error */
   hasWriteErrors(): boolean;
-  /** Returns the number of write errors off the bulk operation */
+  /** Returns the number of write errors from the bulk operation */
   getWriteErrorCount(): number;
   /** Returns a specific write error object */
   getWriteErrorAt(index: number): WriteError | undefined;
@@ -1386,7 +1392,10 @@ declare type CacheOptions = {
   aggregationSchemaTTL: number;
 };
 
-/** @public */
+/**
+ * @public
+ * @deprecated Will be removed in favor of `AbortSignal` in the next major release.
+ */
 declare class CancellationToken extends TypedEventEmitter<{
   cancel(): void;
 }> {
@@ -1494,7 +1503,7 @@ declare class ChangeStream<TSchema extends Document_2 = Document_2, TChange exte
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/modify/#mongodb-data-modify
  */
-declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'modify';
 }
@@ -1503,7 +1512,7 @@ declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create
  */
-declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'create';
   /**
@@ -1519,7 +1528,7 @@ declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon,
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/createIndexes/#mongodb-data-createIndexes
  */
-declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'createIndexes';
 }
@@ -1575,7 +1584,7 @@ declare class ChangeStreamCursor extends ShellApiWithMongoClass {
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#delete-event
  */
-declare interface ChangeStreamDeleteDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamDeleteDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'delete';
   /** Namespace the delete event occurred on */
@@ -1668,11 +1677,21 @@ declare interface ChangeStreamDocumentOperationDescription {
   operationDescription?: Document_2;
 }
 
+/** @public */
+declare interface ChangeStreamDocumentWallTime {
+  /**
+   * The server date and time of the database operation.
+   * wallTime differs from clusterTime in that clusterTime is a timestamp taken from the oplog entry associated with the database operation event.
+   * @sinceServerVersion 6.0.0
+   */
+  wallTime?: Date;
+}
+
 /**
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event
  */
-declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentCommon {
+declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'dropDatabase';
   /** The database dropped */
@@ -1685,7 +1704,7 @@ declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentC
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#drop-event
  */
-declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'drop';
   /** Namespace the drop event occurred on */
@@ -1697,7 +1716,7 @@ declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon, C
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/dropIndexes/#mongodb-data-dropIndexes
  */
-declare interface ChangeStreamDropIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+declare interface ChangeStreamDropIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'dropIndexes';
 }
@@ -1724,7 +1743,7 @@ declare type ChangeStreamEvents<TSchema extends Document_2 = Document_2, TChange
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#insert-event
  */
-declare interface ChangeStreamInsertDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamInsertDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'insert';
   /** This key will contain the document being inserted */
@@ -1737,7 +1756,7 @@ declare interface ChangeStreamInsertDocument<TSchema extends Document_2 = Docume
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event
  */
-declare interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentCommon {
+declare interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'invalidate';
 }
@@ -1828,7 +1847,7 @@ declare interface ChangeStreamRefineCollectionShardKeyDocument extends ChangeStr
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#rename-event
  */
-declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'rename';
   /** The new name for the `ns.coll` collection */
@@ -1844,7 +1863,7 @@ declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon,
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#replace-event
  */
-declare interface ChangeStreamReplaceDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema> {
+declare interface ChangeStreamReplaceDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'replace';
   /** The fullDocument of a replace event represents the document after the insert of the replacement document */
@@ -1874,7 +1893,7 @@ declare interface ChangeStreamReshardCollectionDocument extends ChangeStreamDocu
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection
  */
-declare interface ChangeStreamShardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+declare interface ChangeStreamShardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'shardCollection';
 }
@@ -1891,7 +1910,7 @@ declare interface ChangeStreamSplitEvent {
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#update-event
  */
-declare interface ChangeStreamUpdateDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+declare interface ChangeStreamUpdateDocument<TSchema extends Document_2 = Document_2> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
   /** Describes the type of operation represented in this change notification */
   operationType: 'update';
   /**
@@ -2491,6 +2510,10 @@ declare interface ClientEncryptionOptions {
    * TLS options for kms providers to use.
    */
   tlsOptions?: CSFLEKMSTlsOptions;
+  /**
+   * Sets the expiration time for the DEK in the cache in milliseconds. Defaults to 60000. 0 means no timeout.
+   */
+  keyExpirationMS?: number;
   /**
    * @experimental
    *
@@ -2568,6 +2591,7 @@ declare type ClientInsertResult = {
 
 /**
  * @public
+ * @deprecated This interface will be made internal in the next major release.
  * @see https://github.com/mongodb/specifications/blob/master/source/mongodb-handshake/handshake.md#hello-command
  */
 declare interface ClientMetadata {
@@ -2611,6 +2635,8 @@ declare interface ClientReplaceOneModel<TSchema> extends ClientWriteModel {
   hint?: Hint;
   /** When true, creates a new document if no document matches the query. */
   upsert?: boolean;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: Sort;
 }
 
 /**
@@ -2632,6 +2658,7 @@ declare class ClientSession extends TypedEventEmitter<ClientSessionEvents> imple
   explicit: boolean;
   /* Excluded from this release type: owner */
   defaultTransactionOptions: TransactionOptions;
+  /** @deprecated - Will be made internal in the next major release */
   transaction: Transaction;
   /* Excluded from this release type: commitAttempted */
   readonly snapshotEnabled: boolean;
@@ -2854,6 +2881,8 @@ declare interface ClientUpdateOneModel<TSchema> extends ClientWriteModel {
   hint?: Hint;
   /** When true, creates a new document if no document matches the query. */
   upsert?: boolean;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: Sort;
 }
 
 /** @public */
@@ -2899,7 +2928,7 @@ declare interface ClientWriteModel {
   namespace: string;
 }
 declare interface Closable {
-  close(force: boolean): Promise<void>;
+  close(): Promise<void>;
   suspend(): Promise<() => Promise<void>>;
 }
 
@@ -3064,7 +3093,9 @@ declare class Collection<M extends GenericServerSideSchema = GenericServerSideSc
   /*
   Updates a single document within the collection based on the filter.
   */
-  updateOne(filter: Document_2, update: Document_2, options?: UpdateOptions): UpdateResult_2 | Document_2;
+  updateOne(filter: Document_2, update: Document_2, options?: UpdateOptions & {
+    sort?: Document_2;
+  }): UpdateResult_2 | Document_2;
   /*
   Compacts structured encryption data
   */
@@ -3382,7 +3413,9 @@ declare class Collection_2<TSchema extends Document_2 = Document_2> {
    * @param update - The modifications to apply
    * @param options - Optional settings for the command
    */
-  updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Document_2[], options?: UpdateOptions): Promise<UpdateResult<TSchema>>;
+  updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Document_2[], options?: UpdateOptions & {
+    sort?: Sort;
+  }): Promise<UpdateResult<TSchema>>;
   /**
    * Replace a document in a collection with another document
    *
@@ -3920,6 +3953,7 @@ declare class CommandFailedEvent {
   commandName: string;
   failure: Error;
   serviceId?: ObjectId;
+  databaseName: string;
   /* Excluded from this release type: name */
   /* Excluded from this release type: __constructor */
   get hasServiceId(): boolean;
@@ -3948,6 +3982,10 @@ declare interface CommandOperationOptions extends OperationOptions, WriteConcern
   retryWrites?: boolean;
   dbName?: string;
   authdb?: string;
+  /**
+   * @deprecated
+   * This option is deprecated and will be removed in an upcoming major version.
+   */
   noResponse?: boolean;
 }
 declare class CommandResult<T = unknown> extends ShellApiValueClass {
@@ -4003,6 +4041,7 @@ declare class CommandSucceededEvent {
   commandName: string;
   reply: unknown;
   serviceId?: ObjectId;
+  databaseName: string;
   /* Excluded from this release type: name */
   /* Excluded from this release type: __constructor */
   get hasServiceId(): boolean;
@@ -5423,7 +5462,7 @@ declare class DevtoolsConnectionState {
   productName: string;
   private stateShareClient;
   private stateShareServer;
-  constructor(options: Pick<DevtoolsConnectOptions, 'productDocsLink' | 'productName' | 'oidc' | 'parentHandle'>, logger: ConnectLogEmitter, ca: string | undefined);
+  constructor(options: Pick<DevtoolsConnectOptions, 'productDocsLink' | 'productName' | 'oidc' | 'parentHandle'>, logger: ConnectLogEmitter);
   getStateShareServer(): Promise<string>;
   destroy(): Promise<void>;
 }
@@ -5434,7 +5473,7 @@ declare interface DevtoolsConnectOptions extends MongoClientOptions {
   parentState?: DevtoolsConnectionState;
   parentHandle?: string;
   proxy?: DevtoolsProxyOptions | AgentWithInitialize;
-  applyProxyToOIDC?: boolean;
+  applyProxyToOIDC?: boolean | DevtoolsProxyOptions | AgentWithInitialize;
 }
 declare interface DevtoolsProxyOptions {
   proxy?: string;
@@ -5445,6 +5484,7 @@ declare interface DevtoolsProxyOptions {
     identityKeyPassphrase?: string;
   };
   ca?: ConnectionOptions['ca'];
+  caExcludeSystemCerts?: boolean;
   env?: Record<string, string | undefined>;
 }
 
@@ -6256,7 +6296,10 @@ declare type HostInformation = {
   is_do_url?: boolean;
 };
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use a custom `fetch` function instead
+ */
 declare type HttpOptions = Partial<Pick<RequestOptions, 'agent' | 'ca' | 'cert' | 'crl' | 'headers' | 'key' | 'lookup' | 'passphrase' | 'pfx' | 'timeout'>>;
 
 /**
@@ -6773,7 +6816,7 @@ declare interface KMSProviders {
 }
 
 /** @public */
-declare const LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"];
+declare const LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "keepAliveInitialDelay", "family", "hints", "localAddress", "localPort", "lookup"];
 
 /** @public */
 declare const LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"];
@@ -6964,7 +7007,7 @@ export declare class Mongo<M extends GenericServerSideSchema = GenericServerSide
   /*
   Closes a Mongo object, disposing of related resources and closing the underlying connection.
   */
-  close(force?: boolean): Promise<void>;
+  close(): Promise<void>;
   _suspend(): Promise<() => Promise<void>>;
   /*
   Returns the ReadPreference Mode set for the connection.
@@ -7047,22 +7090,35 @@ export declare class Mongo<M extends GenericServerSideSchema = GenericServerSide
 declare const MONGO_CLIENT_EVENTS: readonly ["connectionPoolCreated", "connectionPoolReady", "connectionPoolCleared", "connectionPoolClosed", "connectionCreated", "connectionReady", "connectionClosed", "connectionCheckOutStarted", "connectionCheckOutFailed", "connectionCheckedOut", "connectionCheckedIn", "commandStarted", "commandSucceeded", "commandFailed", "serverOpening", "serverClosed", "serverDescriptionChanged", "topologyOpening", "topologyClosed", "topologyDescriptionChanged", "error", "timeout", "close", "serverHeartbeatStarted", "serverHeartbeatSucceeded", "serverHeartbeatFailed"];
 
 /**
- * The **MongoClient** class is a class that allows for making Connections to MongoDB.
  * @public
  *
+ * The **MongoClient** class is a class that allows for making Connections to MongoDB.
+ *
+ * **NOTE:** The programmatically provided options take precedence over the URI options.
+ *
  * @remarks
- * The programmatically provided options take precedence over the URI options.
+ *
+ * A MongoClient is the entry point to connecting to a MongoDB server.
+ *
+ * It handles a multitude of features on your application's behalf:
+ * - **Server Host Connection Configuration**: A MongoClient is responsible for reading TLS cert, ca, and crl files if provided.
+ * - **SRV Record Polling**: A "`mongodb+srv`" style connection string is used to have the MongoClient resolve DNS SRV records of all server hostnames which the driver periodically monitors for changes and adjusts its current view of hosts correspondingly.
+ * - **Server Monitoring**: The MongoClient automatically keeps monitoring the health of server nodes in your cluster to reach out to the correct and lowest latency one available.
+ * - **Connection Pooling**: To avoid paying the cost of rebuilding a connection to the server on every operation the MongoClient keeps idle connections preserved for reuse.
+ * - **Session Pooling**: The MongoClient creates logical sessions that enable retryable writes, causal consistency, and transactions. It handles pooling these sessions for reuse in subsequent operations.
+ * - **Cursor Operations**: A MongoClient's cursors use the health monitoring system to send the request for more documents to the same server the query began on.
+ * - **Mongocryptd process**: When using auto encryption, a MongoClient will launch a `mongocryptd` instance for handling encryption if the mongocrypt shared library isn't in use.
+ *
+ * There are many more features of a MongoClient that are not listed above.
+ *
+ * In order to enable these features, a number of asynchronous Node.js resources are established by the driver: Timers, FS Requests, Sockets, etc.
+ * For details on cleanup, please refer to the MongoClient `close()` documentation.
  *
  * @example
  * ```ts
  * import { MongoClient } from 'mongodb';
- *
  * // Enable command monitoring for debugging
- * const client = new MongoClient('mongodb://localhost:27017', { monitorCommands: true });
- *
- * client.on('commandStarted', started => console.log(started));
- * client.db().collection('pets');
- * await client.insertOne({ name: 'spot', kind: 'dog' });
+ * const client = new MongoClient('mongodb://localhost:27017?appName=mflix', { monitorCommands: true });
  * ```
  */
 declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable_2 {
@@ -7074,10 +7130,15 @@ declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implement
   /**
    * The consolidate, parsed, transformed and merged options.
    */
-  readonly options: Readonly<Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert'>> & Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert'>;
+  readonly options: Readonly<Omit<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo' | 'additionalDriverInfo' | 'metadata' | 'extendedMetadata'>> & Pick<MongoOptions, 'monitorCommands' | 'ca' | 'crl' | 'key' | 'cert' | 'driverInfo' | 'additionalDriverInfo' | 'metadata' | 'extendedMetadata'>;
   constructor(url: string, options?: MongoClientOptions);
   /* Excluded from this release type: [Symbol.asyncDispose] */
   /* Excluded from this release type: asyncDispose */
+  /**
+   * Append metadata to the client metadata after instantiation.
+   * @param driverInfo - Information about the application or library.
+   */
+  appendMetadata(driverInfo: DriverInfo): void;
   /* Excluded from this release type: checkForNonGenuineHosts */
   get serverApi(): Readonly<ServerApi | undefined>;
   /* Excluded from this release type: monitorCommands */
@@ -7114,19 +7175,51 @@ declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implement
   connect(): Promise<this>;
   /* Excluded from this release type: _connect */
   /**
-   * Cleans up client-side resources used by the MongoCLient and .  This includes:
-   *
-   * - Closes all open, unused connections (see note).
-   * - Ends all in-use sessions with {@link ClientSession#endSession|ClientSession.endSession()}.
-   * - Ends all unused sessions server-side.
-   * - Cleans up any resources being used for auto encryption if auto encryption is enabled.
-   *
-   * @remarks Any in-progress operations are not killed and any connections used by in progress operations
-   * will be cleaned up lazily as operations finish.
-   *
-   * @param force - Force close, emitting no events
-   */
-  close(force?: boolean): Promise<void>;
+   * Cleans up resources managed by the MongoClient.
+   *
+   * The close method clears and closes all resources whose lifetimes are managed by the MongoClient.
+   * Please refer to the `MongoClient` class documentation for a high level overview of the client's key features and responsibilities.
+   *
+   * **However,** the close method does not handle the cleanup of resources explicitly created by the user.
+   * Any user-created driver resource with its own `close()` method should be explicitly closed by the user before calling MongoClient.close().
+   * This method is written as a "best effort" attempt to leave behind the least amount of resources server-side when possible.
+   *
+   * The following list defines ideal preconditions and consequent pitfalls if they are not met.
+   * The MongoClient, ClientSession, Cursors and ChangeStreams all support [explicit resource management](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html).
+   * By using explicit resource management to manage the lifetime of driver resources instead of manually managing their lifetimes, the pitfalls outlined below can be avoided.
+   *
+   * The close method performs the following in the order listed:
+   * - Client-side:
+   *   - **Close in-use connections**: Any connections that are currently waiting on a response from the server will be closed.
+   *     This is performed _first_ to avoid reaching the next step (server-side clean up) and having no available connections to check out.
+   *     - _Ideal_: All operations have been awaited or cancelled, and the outcomes, regardless of success or failure, have been processed before closing the client servicing the operation.
+   *     - _Pitfall_: When `client.close()` is called and all connections are in use, after closing them, the client must create new connections for cleanup operations, which comes at the cost of new TLS/TCP handshakes and authentication steps.
+   * - Server-side:
+   *   - **Close active cursors**: All cursors that haven't been completed will have a `killCursor` operation sent to the server they were initialized on, freeing the server-side resource.
+   *     - _Ideal_: Cursors are explicitly closed or completed before `client.close()` is called.
+   *     - _Pitfall_: `killCursors` may have to build a new connection if the in-use closure ended all pooled connections.
+   *   - **End active sessions**: In-use sessions created with `client.startSession()` or `client.withSession()` or implicitly by the driver will have their `.endSession()` method called.
+   *     Contrary to the name of the method, `endSession()` returns the session to the client's pool of sessions rather than end them on the server.
+   *     - _Ideal_: Transaction outcomes are awaited and their corresponding explicit sessions are ended before `client.close()` is called.
+   *     - _Pitfall_: **This step aborts in-progress transactions**. It is advisable to observe the outcome of a transaction before closing your client.
+   *   - **End all pooled sessions**: The `endSessions` command with all session IDs the client has pooled is sent to the server to inform the cluster it can clean them up.
+   *     - _Ideal_: No user intervention is expected.
+   *     - _Pitfall_: None.
+   *
+   * The remaining shutdown is of the MongoClient resources that are intended to be entirely internal but is documented here as their existence relates to the JS event loop.
+   *
+   * - Client-side (again):
+   *   - **Stop all server monitoring**: Connections kept live for detecting cluster changes and roundtrip time measurements are shutdown.
+   *   - **Close all pooled connections**: Each server node in the cluster has a corresponding connection pool and all connections in the pool are closed. Any operations waiting to check out a connection will have an error thrown instead of a connection returned.
+   *   - **Clear out server selection queue**: Any operations that are in the process of waiting for a server to be selected will have an error thrown instead of a server returned.
+   *   - **Close encryption-related resources**: An internal MongoClient created for communicating with `mongocryptd` or other encryption purposes is closed. (Using this same method of course!)
+   *
+   * After the close method completes there should be no MongoClient related resources [ref-ed in Node.js' event loop](https://docs.libuv.org/en/v1.x/handle.html#reference-counting).
+   * This should allow Node.js to exit gracefully if MongoClient resources were the only active handles in the event loop.
+   *
+   * @param _force - currently an unused flag that has no effect. Defaults to `false`.
+   */
+  close(_force?: boolean): Promise<void>;
   private _close;
   /**
    * Create a new Db instance sharing the current socket connections.
@@ -7303,7 +7396,11 @@ declare interface MongoClientOptions extends BSONSerializeOptions, SupportedNode
   minPoolSize?: number;
   /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
   maxConnecting?: number;
-  /** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
+  /**
+   * The maximum amount of time a connection should remain idle in the connection pool before being marked idle, in milliseconds.
+   * If specified, this must be a number greater than or equal to 0, where 0 means there is no limit. Defaults to 0. After this
+   * time passes, the idle collection can be automatically cleaned up in the background.
+   */
   maxIdleTimeMS?: number;
   /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
   waitQueueTimeoutMS?: number;
@@ -7510,14 +7607,14 @@ declare interface MongoDBLogWritable {
 /** @public */
 declare class MongoDBNamespace {
   db: string;
-  collection?: string | undefined;
+  collection?: string;
   /**
    * Create a namespace object
    *
    * @param db - database name
    * @param collection - collection name
    */
-  constructor(db: string, collection?: string | undefined);
+  constructor(db: string, collection?: string);
   toString(): string;
   withCollection(collection: string): MongoDBCollectionNamespace;
   static fromString(namespace?: string): MongoDBNamespace;
@@ -7664,6 +7761,15 @@ declare interface MongoDBOIDCLogEventsMap {
   'mongodb-oidc-plugin:inbound-http-request': (event: {
     url: string;
   }) => void;
+  'mongodb-oidc-plugin:outbound-http-request-failed': (event: {
+    url: string;
+    error: string;
+  }) => void;
+  'mongodb-oidc-plugin:outbound-http-request-completed': (event: {
+    url: string;
+    status: number;
+    statusText: string;
+  }) => void;
   'mongodb-oidc-plugin:received-server-params': (event: {
     params: OIDCCallbackParams_2;
   }) => void;
@@ -7808,8 +7914,16 @@ declare interface MongoDBOIDCPluginOptions {
   throwOnIncompatibleSerializedState?: boolean;
   /**
    * Provide custom HTTP options for individual HTTP calls.
+   *
+   * @deprecated Use a custom `fetch` function instead.
    */
   customHttpOptions?: HttpOptions | ((url: string, options: Readonly<HttpOptions>) => HttpOptions);
+  /**
+   * Provide a custom `fetch` function to be used for HTTP calls.
+   *
+   * Any API that is compatible with the web `fetch` API can be used here.
+   */
+  customFetch?: (url: string, options: Readonly<unknown>) => Promise<Response>;
   /**
    * Pass ID tokens in place of access tokens. For debugging/working around
    * broken identity providers.
@@ -7915,8 +8029,10 @@ declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEn
   compressors: CompressorName[];
   writeConcern: WriteConcern;
   dbName: string;
+  /** @deprecated - Will be made internal in a future major release. */
   metadata: ClientMetadata;
-  /* Excluded from this release type: extendedMetadata */
+  extendedMetadata: Promise<Document_2>;
+  additionalDriverInfo: DriverInfo[];
   /* Excluded from this release type: autoEncrypter */
   /* Excluded from this release type: tokenCache */
   proxyHost?: string;
@@ -8103,6 +8219,8 @@ declare interface OIDCCallbackParams {
   idpInfo?: IdPInfo;
   /** The refresh token, if applicable, to be used by the callback to request a new token from the issuer. */
   refreshToken?: string;
+  /** The token audience for GCP and Azure. */
+  tokenAudience?: string;
 }
 
 /**
@@ -8297,6 +8415,11 @@ declare interface ProxyEventMap {
     retryableError: boolean;
     retriesLeft: number;
   }) => void;
+  'proxy:connect': (ev: {
+    agent: AgentWithInitialize;
+    req: ClientRequest;
+    opts: AgentConnectOpts & Partial<SecureContextOptions>;
+  }) => void;
 }
 declare interface ProxyLogEmitter {
   on<K extends keyof ProxyEventMap>(event: K, listener: ProxyEventMap[K]): this;
@@ -8560,7 +8683,7 @@ declare interface RenameOptions extends CommandOperationOptions {
 
 /** @public */
 declare interface ReplaceOneModel<TSchema extends Document_2 = Document_2> {
-  /** The filter to limit the replaced document. */
+  /** The filter that specifies which document to replace. In the case of multiple matches, the first document matched is replaced. */
   filter: Filter<TSchema>;
   /** The document with which to replace the matched document. */
   replacement: WithoutId<TSchema>;
@@ -8570,6 +8693,8 @@ declare interface ReplaceOneModel<TSchema extends Document_2 = Document_2> {
   hint?: Hint;
   /** When true, creates a new document if no document matches the query. */
   upsert?: boolean;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: Sort;
 }
 
 /** @public */
@@ -8584,6 +8709,8 @@ declare interface ReplaceOptions extends CommandOperationOptions {
   upsert?: boolean;
   /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
   let?: Document_2;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: Sort;
 }
 export declare class ReplicaSet<M extends GenericServerSideSchema = GenericServerSideSchema, D extends GenericDatabaseSchema = GenericDatabaseSchema> extends ShellApiWithMongoClass {
   _database: DatabaseWithSchema<M, D>;
@@ -9642,7 +9769,7 @@ declare class ShellInstanceState {
   constructor(initialServiceProvider: ServiceProvider, messageBus?: any, cliOptions?: ShellCliOptions);
   fetchConnectionInfo(): Promise<ConnectionInfo_2 | undefined>;
   cachedConnectionInfo(): ConnectionInfo_2 | undefined;
-  close(force: boolean): Promise<void>;
+  close(): Promise<void>;
   setPreFetchCollectionAndDatabaseNames(value: boolean): void;
   setDbFunc(newDb: any): DatabaseWithSchema;
   setCtx(contextObject: any): void;
@@ -9762,15 +9889,24 @@ declare interface SnippetsTransformErrorEvent {
 
 /** @public */
 declare type Sort = string | Exclude<SortDirection, {
-  $meta: string;
-}> | string[] | {
-  [key: string]: SortDirection;
-} | Map<string, SortDirection> | [string, SortDirection][] | [string, SortDirection];
+  readonly $meta: string;
+}> | ReadonlyArray<string> | {
+  readonly [key: string]: SortDirection;
+} | ReadonlyMap<string, SortDirection> | ReadonlyArray<readonly [string, SortDirection]> | readonly [string, SortDirection];
 
 /** @public */
 declare type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending' | {
+  readonly $meta: string;
+};
+
+/** Below stricter types were created for sort that correspond with type that the cmd takes  */
+/** @public */
+declare type SortDirectionForCmd = 1 | -1 | {
   $meta: string;
 };
+
+/** @public */
+declare type SortForCmd = Map<string, SortDirectionForCmd>;
 declare type StandardJSONSchema = JSONSchema4;
 declare interface StartLoadingCliScriptsEvent {
   usesShellOption: boolean;
@@ -9859,6 +9995,8 @@ declare type SupportedNodeConnectionOptions = SupportedTLSConnectionOptions & Su
 declare type SupportedSocketOptions = Pick<TcpNetConnectOpts & {
   autoSelectFamily?: boolean;
   autoSelectFamilyAttemptTimeout?: number;
+  /** Node.JS socket option to set the time the first keepalive probe is sent on an idle socket. Defaults to 120000ms */
+  keepAliveInitialDelay?: number;
 }, (typeof LEGAL_TCP_SOCKET_OPTIONS)[number]>;
 
 /** @public */
@@ -10019,23 +10157,32 @@ declare interface TopologyVersion {
 
 /**
  * @public
+ * @deprecated - Will be made internal in a future major release.
  * A class maintaining state related to a server transaction. Internal Only
  */
 declare class Transaction {
   /* Excluded from this release type: state */
+  /** @deprecated - Will be made internal in a future major release. */
   options: TransactionOptions;
   /* Excluded from this release type: _pinnedServer */
   /* Excluded from this release type: _recoveryToken */
   /* Excluded from this release type: __constructor */
   /* Excluded from this release type: server */
+  /** @deprecated - Will be made internal in a future major release. */
   get recoveryToken(): Document_2 | undefined;
+  /** @deprecated - Will be made internal in a future major release. */
   get isPinned(): boolean;
-  /** @returns Whether the transaction has started */
+  /**
+   * @deprecated - Will be made internal in a future major release.
+   * @returns Whether the transaction has started
+   */
   get isStarting(): boolean;
   /**
+   * @deprecated - Will be made internal in a future major release.
    * @returns Whether this session is presently in a transaction
    */
   get isActive(): boolean;
+  /** @deprecated - Will be made internal in a future major release. */
   get isCommitted(): boolean;
   /* Excluded from this release type: transition */
   /* Excluded from this release type: pinServer */
@@ -10216,7 +10363,7 @@ declare interface UpdateManyModel<TSchema extends Document_2 = Document_2> {
 
 /** @public */
 declare interface UpdateOneModel<TSchema extends Document_2 = Document_2> {
-  /** The filter to limit the updated documents. */
+  /** The filter that specifies which document to update. In the case of multiple matches, the first document matched is updated. */
   filter: Filter<TSchema>;
   /**
    * The modifications to apply. The value can be either:
@@ -10232,6 +10379,8 @@ declare interface UpdateOneModel<TSchema extends Document_2 = Document_2> {
   hint?: Hint;
   /** When true, creates a new document if no document matches the query. */
   upsert?: boolean;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: Sort;
 }
 
 /** @public */
@@ -10291,6 +10440,8 @@ declare interface UpdateStatement {
   arrayFilters?: Document_2[];
   /** A document or string that specifies the index to use to support the query predicate. */
   hint?: Hint;
+  /** Specifies the sort order for the documents matched by the filter. */
+  sort?: SortForCmd;
 }
 declare interface UseEvent {
   db: string;
@@ -10337,7 +10488,9 @@ declare interface Writable {
   insertOne(database: string, collection: string, doc: Document_2, options: InsertOneOptions, dbOptions?: DbOptions): Promise<InsertOneResult>;
   replaceOne(database: string, collection: string, filter: Document_2, replacement: Document_2, options?: ReplaceOptions, dbOptions?: DbOptions): Promise<UpdateResult>;
   updateMany(database: string, collection: string, filter: Document_2, update: Document_2, options?: UpdateOptions, dbOptions?: DbOptions): Promise<UpdateResult>;
-  updateOne(database: string, collection: string, filter: Document_2, update: Document_2, options?: UpdateOptions, dbOptions?: DbOptions): Promise<UpdateResult>;
+  updateOne(database: string, collection: string, filter: Document_2, update: Document_2, options?: UpdateOptions & {
+    sort?: Document_2;
+  }, dbOptions?: DbOptions): Promise<UpdateResult>;
   createIndexes(database: string, collection: string, indexSpecs: Document_2[], options?: CreateIndexesOptions, dbOptions?: DbOptions): Promise<string[]>;
   dropCollection(database: string, collection: string, options: DropCollectionOptions, dbOptions?: DbOptions): Promise<boolean>;
   renameCollection(database: string, oldName: string, newName: string, options?: RenameOptions, dbOptions?: DbOptions): Promise<Collection_2>;