mongodb 6.16.0 → 6.17.0-dev.20250605.sha.57ef31be

package/mongodb.d.ts

@@ -770,6 +770,10 @@ export 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;
@@ -1002,10 +1006,10 @@ export declare type BSONTypeAlias = keyof typeof BSONType;
 
 /** @public */
 export 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
@@ -1142,7 +1146,7 @@ export declare class BulkWriteResult {
     getRawResponse(): Document;
     /** 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;
@@ -1268,7 +1272,7 @@ export declare class ChangeStream<TSchema extends Document = Document, TChange e
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/modify/#mongodb-data-modify
  */
-export declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+export declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'modify';
 }
@@ -1277,7 +1281,7 @@ export declare interface ChangeStreamCollModDocument extends ChangeStreamDocumen
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/create/#mongodb-data-create
  */
-export declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+export declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'create';
     /**
@@ -1293,7 +1297,7 @@ export declare interface ChangeStreamCreateDocument extends ChangeStreamDocument
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/createIndexes/#mongodb-data-createIndexes
  */
-export declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+export declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'createIndexes';
 }
@@ -1306,7 +1310,7 @@ export declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDoc
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#delete-event
  */
-export declare interface ChangeStreamDeleteDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+export declare interface ChangeStreamDeleteDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'delete';
     /** Namespace the delete event occurred on */
@@ -1399,11 +1403,21 @@ export declare interface ChangeStreamDocumentOperationDescription {
     operationDescription?: Document;
 }
 
+/** @public */
+export 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
  */
-export declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentCommon {
+export declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'dropDatabase';
     /** The database dropped */
@@ -1416,7 +1430,7 @@ export declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDo
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#drop-event
  */
-export declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+export 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 */
@@ -1428,7 +1442,7 @@ export declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCo
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/dropIndexes/#mongodb-data-dropIndexes
  */
-export declare interface ChangeStreamDropIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+export declare interface ChangeStreamDropIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'dropIndexes';
 }
@@ -1455,7 +1469,7 @@ export declare type ChangeStreamEvents<TSchema extends Document = Document, TCha
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#insert-event
  */
-export declare interface ChangeStreamInsertDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+export declare interface ChangeStreamInsertDocument<TSchema extends Document = Document> 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 */
@@ -1468,7 +1482,7 @@ export declare interface ChangeStreamInsertDocument<TSchema extends Document = D
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event
  */
-export declare interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentCommon {
+export declare interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'invalidate';
 }
@@ -1559,7 +1573,7 @@ export declare interface ChangeStreamRefineCollectionShardKeyDocument extends Ch
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#rename-event
  */
-export declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+export 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 */
@@ -1575,7 +1589,7 @@ export declare interface ChangeStreamRenameDocument extends ChangeStreamDocument
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#replace-event
  */
-export declare interface ChangeStreamReplaceDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema> {
+export declare interface ChangeStreamReplaceDocument<TSchema extends Document = Document> 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 */
@@ -1605,7 +1619,7 @@ export declare interface ChangeStreamReshardCollectionDocument extends ChangeStr
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection
  */
-export declare interface ChangeStreamShardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+export declare interface ChangeStreamShardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'shardCollection';
 }
@@ -1622,7 +1636,7 @@ export declare interface ChangeStreamSplitEvent {
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/change-events/#update-event
  */
-export declare interface ChangeStreamUpdateDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID {
+export declare interface ChangeStreamUpdateDocument<TSchema extends Document = Document> extends ChangeStreamDocumentCommon, ChangeStreamDocumentKey<TSchema>, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentWallTime {
     /** Describes the type of operation represented in this change notification */
     operationType: 'update';
     /**
@@ -2164,6 +2178,10 @@ export 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
      *
@@ -2307,6 +2325,8 @@ export 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;
 }
 
 /**
@@ -2539,6 +2559,8 @@ export 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 */
@@ -2739,7 +2761,9 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param update - The modifications to apply
      * @param options - Optional settings for the command
      */
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Document[], options?: UpdateOptions): Promise<UpdateResult<TSchema>>;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Document[], options?: UpdateOptions & {
+        sort?: Sort;
+    }): Promise<UpdateResult<TSchema>>;
     /**
      * Replace a document in a collection with another document
      *
@@ -5364,7 +5388,7 @@ export declare interface KMSProviders {
 /* Excluded from this release type: LegacyTimeoutContextOptions */
 
 /** @public */
-export declare const LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "family", "hints", "localAddress", "localPort", "lookup"];
+export declare const LEGAL_TCP_SOCKET_OPTIONS: readonly ["autoSelectFamily", "autoSelectFamilyAttemptTimeout", "keepAliveInitialDelay", "family", "hints", "localAddress", "localPort", "lookup"];
 
 /** @public */
 export declare const LEGAL_TLS_SOCKET_OPTIONS: readonly ["allowPartialTrustChain", "ALPNProtocols", "ca", "cert", "checkServerIdentity", "ciphers", "crl", "ecdhCurve", "key", "minDHSize", "passphrase", "pfx", "rejectUnauthorized", "secureContext", "secureProtocol", "servername", "session"];
@@ -5674,22 +5698,35 @@ export declare class MongoChangeStreamError extends MongoRuntimeError {
 }
 
 /**
- * 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 });
  * ```
  */
 export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> implements AsyncDisposable_2 {
@@ -5741,19 +5778,51 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> im
     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.
@@ -5946,6 +6015,29 @@ export declare class MongoClientBulkWriteExecutionError extends MongoRuntimeErro
     get name(): string;
 }
 
+/**
+ * An error generated when the MongoClient is closed and async
+ * operations are interrupted.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoClientClosedError extends MongoAPIError {
+    /**
+     * **Do not use this constructor!**
+     *
+     * Meant for internal use only.
+     *
+     * @remarks
+     * This class is only meant to be constructed within the driver. This constructor is
+     * not subject to semantic versioning compatibility guarantees and may change at any time.
+     *
+     * @public
+     **/
+    constructor();
+    get name(): string;
+}
+
 /** @public */
 export declare type MongoClientEvents = Pick<TopologyEvents, (typeof MONGO_CLIENT_EVENTS)[number]> & {
     open(mongoClient: MongoClient): void;
@@ -6396,14 +6488,14 @@ export declare interface MongoDBLogWritable {
 /** @public */
 export 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;
@@ -7345,6 +7437,8 @@ export 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;
 }
 
 /**
@@ -7373,6 +7467,8 @@ export declare type OnlyFieldsOfType<TSchema, FieldType = any, AssignableType =
 
 /* Excluded from this release type: OpCompressedRequest */
 
+/* Excluded from this release type: OpCompressesRequestOptions */
+
 /** @public */
 export declare interface OperationOptions extends BSONSerializeOptions {
     /** Specify ClientSession for this command */
@@ -7678,7 +7774,7 @@ export declare interface RenameOptions extends CommandOperationOptions {
 
 /** @public */
 export declare interface ReplaceOneModel<TSchema extends Document = Document> {
-    /** 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>;
@@ -7688,6 +7784,8 @@ export declare interface ReplaceOneModel<TSchema extends Document = Document> {
     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 */
@@ -7702,6 +7800,8 @@ export 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;
+    /** Specifies the sort order for the documents matched by the filter. */
+    sort?: Sort;
 }
 
 /**
@@ -8214,19 +8314,24 @@ export declare type SeverityLevel = (typeof SeverityLevel)[keyof typeof Severity
 
 /** @public */
 export 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 */
 export declare type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending' | {
-    $meta: string;
+    readonly $meta: string;
 };
 
-/* Excluded from this release type: SortDirectionForCmd */
+/** Below stricter types were created for sort that correspond with type that the cmd takes  */
+/** @public */
+export declare type SortDirectionForCmd = 1 | -1 | {
+    $meta: string;
+};
 
-/* Excluded from this release type: SortForCmd */
+/** @public */
+export declare type SortForCmd = Map<string, SortDirectionForCmd>;
 
 /* Excluded from this release type: SrvPoller */
 
@@ -8327,6 +8432,8 @@ export declare type SupportedNodeConnectionOptions = SupportedTLSConnectionOptio
 export 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 */
@@ -8694,7 +8801,7 @@ export declare interface UpdateManyModel<TSchema extends Document = Document> {
 
 /** @public */
 export declare interface UpdateOneModel<TSchema extends Document = Document> {
-    /** 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:
@@ -8710,6 +8817,8 @@ export declare interface UpdateOneModel<TSchema extends Document = Document> {
     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 */
@@ -8761,6 +8870,8 @@ export declare interface UpdateStatement {
     arrayFilters?: Document[];
     /** 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;
 }
 
 export { UUID }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "6.16.0",
+  "version": "6.17.0-dev.20250605.sha.57ef31be",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@mongodb-js/saslprep": "^1.1.9",
-    "bson": "^6.10.3",
+    "bson": "^6.10.4",
     "mongodb-connection-string-url": "^3.0.0"
   },
   "peerDependencies": {
@@ -65,50 +65,50 @@
     "@aws-sdk/credential-providers": "^3.632.0",
     "@iarna/toml": "^2.2.5",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@microsoft/api-extractor": "^7.49.2",
+    "@microsoft/api-extractor": "^7.52.5",
     "@microsoft/tsdoc-config": "^0.17.1",
-    "@mongodb-js/zstd": "^2.0.0",
+    "@mongodb-js/zstd": "^2.0.1",
     "@types/chai": "^4.3.17",
     "@types/chai-subset": "^1.3.5",
-    "@types/express": "^4.17.21",
+    "@types/express": "^5.0.1",
     "@types/kerberos": "^1.1.5",
     "@types/mocha": "^10.0.9",
-    "@types/node": "^22.13.0",
+    "@types/node": "^22.15.3",
     "@types/saslprep": "^1.0.3",
-    "@types/semver": "^7.5.8",
-    "@types/sinon": "^17.0.3",
-    "@types/sinon-chai": "^3.2.12",
-    "@types/whatwg-url": "^11.0.5",
-    "@typescript-eslint/eslint-plugin": "8.4.0",
-    "@typescript-eslint/parser": "8.4.0",
+    "@types/semver": "^7.7.0",
+    "@types/sinon": "^17.0.4",
+    "@types/sinon-chai": "^4.0.0",
+    "@types/whatwg-url": "^13.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.31.1",
+    "@typescript-eslint/parser": "^8.31.1",
     "chai": "^4.4.1",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.2",
-    "eslint": "9.9.0",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint": "^9.25.1",
+    "eslint-config-prettier": "^10.1.2",
     "eslint-plugin-mocha": "^10.4.1",
     "eslint-plugin-prettier": "^5.2.3",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-tsdoc": "^0.4.0",
     "eslint-plugin-unused-imports": "^4.1.4",
-    "express": "^4.21.2",
+    "express": "^5.1.0",
     "gcp-metadata": "^5.3.0",
     "js-yaml": "^4.1.0",
     "mocha": "^10.8.2",
     "mocha-sinon": "^2.1.2",
-    "mongodb-client-encryption": "^6.3.0",
+    "mongodb-client-encryption": "^6.4.0",
     "mongodb-legacy": "^6.1.3",
     "nyc": "^15.1.0",
-    "prettier": "^3.4.2",
+    "prettier": "^3.5.3",
     "semver": "^7.7.0",
-    "sinon": "^18.0.0",
+    "sinon": "^18.0.1",
     "sinon-chai": "^3.7.0",
     "snappy": "^7.2.2",
     "socks": "^2.8.1",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
-    "tsd": "^0.31.2",
-    "typescript": "5.5",
+    "tsd": "^0.32.0",
+    "typescript": "5.8.3",
     "typescript-cached-transpile": "^0.0.6",
     "v8-heapsnapshot": "^1.3.1",
     "yargs": "^17.7.2"
@@ -175,4 +175,4 @@
       "moduleResolution": "node"
     }
   }
-}
+}