mongodb 5.2.0 → 5.4.0

package/mongodb.d.ts

@@ -81,6 +81,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
      * If the iterator returns `false`, iteration will stop.
      *
      * @param iterator - The iteration callback.
+     * @deprecated - Will be removed in a future release. Use for await...of instead.
      */
     forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>;
     close(): Promise<void>;
@@ -242,7 +243,10 @@ export declare type AddToSetOperators<Type> = {
     $each?: Array<Flatten<Type>>;
 };
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use the createUser command directly instead.
+ */
 export declare interface AddUserOptions extends CommandOperationOptions {
     /** Roles associated with the created user */
     roles?: string | string[] | RoleSpecification | RoleSpecification[];
@@ -275,6 +279,22 @@ export declare class Admin {
     /**
      * Execute a command
      *
+     * The driver will ensure the following fields are attached to the command sent to the server:
+     * - `lsid` - sourced from an implicit session or options.session
+     * - `$readPreference` - defaults to primary or can be configured by options.readPreference
+     * - `$db` - sourced from the name of this database
+     *
+     * If the client has a serverApi setting:
+     * - `apiVersion`
+     * - `apiStrict`
+     * - `apiDeprecationErrors`
+     *
+     * When in a transaction:
+     * - `readConcern` - sourced from readConcern set on the TransactionOptions
+     * - `writeConcern` - sourced from writeConcern set on the TransactionOptions
+     *
+     * Attaching any of the above fields to the command will have no effect as the driver will overwrite the value.
+     *
      * @param command - The command to execute
      * @param options - Optional settings for the command
      */
@@ -309,6 +329,8 @@ export declare 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/
      */
     addUser(username: string, passwordOrOptions?: string | AddUserOptions, options?: AddUserOptions): Promise<Document>;
     /**
@@ -531,6 +553,8 @@ export declare interface AuthMechanismProperties extends Document {
     REFRESH_TOKEN_CALLBACK?: OIDCRefreshFunction;
     /** @experimental */
     PROVIDER_NAME?: 'aws';
+    /** @experimental */
+    ALLOWED_HOSTS?: string[];
 }
 
 /** @public */
@@ -935,19 +959,40 @@ export declare class BulkWriteResult {
     /* Excluded from this release type: __constructor */
     /** Evaluates to true if the bulk operation correctly executes */
     get ok(): number;
-    /** The number of inserted documents */
+    /**
+     * The number of inserted documents
+     * @deprecated Use insertedCount instead.
+     */
     get nInserted(): number;
-    /** Number of upserted documents */
+    /**
+     * Number of upserted documents
+     * @deprecated User upsertedCount instead.
+     */
     get nUpserted(): number;
-    /** Number of matched documents */
+    /**
+     * Number of matched documents
+     * @deprecated Use matchedCount instead.
+     */
     get nMatched(): number;
-    /** Number of documents updated physically on disk */
+    /**
+     * Number of documents updated physically on disk
+     * @deprecated Use modifiedCount instead.
+     */
     get nModified(): number;
-    /** Number of removed documents */
+    /**
+     * Number of removed documents
+     * @deprecated Use deletedCount instead.
+     */
     get nRemoved(): number;
-    /** Returns an array of all inserted ids */
+    /**
+     * Returns an array of all inserted ids
+     * @deprecated Use insertedIds instead.
+     */
     getInsertedIds(): Document[];
-    /** Returns an array of all upserted ids */
+    /**
+     * Returns an array of all upserted ids
+     * @deprecated Use upsertedIds instead.
+     */
     getUpsertedIds(): Document[];
     /** Returns the upserted id at the given index */
     getUpsertedIdAt(index: number): Document | undefined;
@@ -1038,7 +1083,7 @@ export declare class ChangeStream<TSchema extends Document = Document, TChange e
     /**
      * Try to get the next available document from the Change Stream's cursor or `null` if an empty batch is returned
      */
-    tryNext(): Promise<Document | null>;
+    tryNext(): Promise<TChange | null>;
     [Symbol.asyncIterator](): AsyncGenerator<TChange, void, void>;
     /** Is the cursor closed */
     get closed(): boolean;
@@ -1433,14 +1478,22 @@ export declare interface ClientMetadata {
     };
     os: {
         type: string;
-        name: NodeJS.Platform;
-        architecture: string;
-        version: string;
+        name?: NodeJS.Platform;
+        architecture?: string;
+        version?: string;
     };
     platform: string;
     application?: {
         name: string;
     };
+    /** FaaS environment information */
+    env?: {
+        name: 'aws.lambda' | 'gcp.func' | 'azure.func' | 'vercel';
+        timeout_sec?: Int32;
+        memory_mb?: Int32;
+        region?: string;
+        url?: string;
+    };
 }
 
 /** @public */
@@ -1728,7 +1781,7 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param update - The update operations to be applied to the document
      * @param options - Optional settings for the command
      */
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options?: UpdateOptions): Promise<UpdateResult>;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options?: UpdateOptions): Promise<UpdateResult<TSchema>>;
     /**
      * Replace a document in a collection with another document
      *
@@ -1736,7 +1789,7 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param replacement - The Document that replaces the matching document
      * @param options - Optional settings for the command
      */
-    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options?: ReplaceOptions): Promise<UpdateResult | Document>;
+    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options?: ReplaceOptions): Promise<UpdateResult<TSchema> | Document>;
     /**
      * Update multiple documents in a collection
      *
@@ -1744,7 +1797,7 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param update - The update operations to be applied to the documents
      * @param options - Optional settings for the command
      */
-    updateMany(filter: Filter<TSchema>, update: UpdateFilter<TSchema>, options?: UpdateOptions): Promise<UpdateResult>;
+    updateMany(filter: Filter<TSchema>, update: UpdateFilter<TSchema>, options?: UpdateOptions): Promise<UpdateResult<TSchema>>;
     /**
      * Delete a document from a collection
      *
@@ -1962,6 +2015,9 @@ export declare class Collection<TSchema extends Document = Document> {
     /**
      * Get all the collection statistics.
      *
+     * @deprecated the `collStats` operation will be removed in the next major release.  Please
+     * use an aggregation pipeline with the [`$collStats`](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) stage instead
+     *
      * @param options - Optional settings for the command
      */
     stats(options?: CollStatsOptions): Promise<CollStats>;
@@ -2090,6 +2146,8 @@ export declare interface CollectionOptions extends BSONSerializeOptions, WriteCo
 /* Excluded from this release type: CollectionPrivate */
 
 /**
+ * @deprecated the `collStats` operation will be removed in the next major release.  Please
+ * use an aggregation pipeline with the [`$collStats`](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) stage instead
  * @public
  * @see https://www.mongodb.com/docs/manual/reference/command/collStats/
  */
@@ -2142,7 +2200,11 @@ export declare interface CollStats extends Document {
     scaleFactor: number;
 }
 
-/** @public */
+/**
+ * @public
+ * @deprecated the `collStats` operation will be removed in the next major release.  Please
+ * use an aggregation pipeline with the [`$collStats`](https://www.mongodb.com/docs/manual/reference/operator/aggregation/collStats/) stage instead
+ */
 export declare interface CollStatsOptions extends CommandOperationOptions {
     /** Divide the returned sizes by scale value. */
     scale?: number;
@@ -2161,6 +2223,7 @@ export declare class CommandFailedEvent {
     commandName: string;
     failure: Error;
     serviceId?: ObjectId;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
     get hasServiceId(): boolean;
 }
@@ -2206,6 +2269,7 @@ export declare class CommandStartedEvent {
     address: string;
     connectionId?: string | number;
     serviceId?: ObjectId;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
     get hasServiceId(): boolean;
 }
@@ -2223,6 +2287,7 @@ export declare class CommandSucceededEvent {
     commandName: string;
     reply: unknown;
     serviceId?: ObjectId;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
     get hasServiceId(): boolean;
 }
@@ -2249,6 +2314,28 @@ export declare type Condition<T> = AlternativeType<T> | FilterOperators<Alternat
 
 /* Excluded from this release type: Connection */
 
+/* Excluded from this release type: CONNECTION_CHECK_OUT_FAILED */
+
+/* Excluded from this release type: CONNECTION_CHECK_OUT_STARTED */
+
+/* Excluded from this release type: CONNECTION_CHECKED_IN */
+
+/* Excluded from this release type: CONNECTION_CHECKED_OUT */
+
+/* Excluded from this release type: CONNECTION_CLOSED */
+
+/* Excluded from this release type: CONNECTION_CREATED */
+
+/* Excluded from this release type: CONNECTION_POOL_CLEARED */
+
+/* Excluded from this release type: CONNECTION_POOL_CLOSED */
+
+/* Excluded from this release type: CONNECTION_POOL_CREATED */
+
+/* Excluded from this release type: CONNECTION_POOL_READY */
+
+/* Excluded from this release type: CONNECTION_READY */
+
 /**
  * An event published when a connection is checked into the connection pool
  * @public
@@ -2257,6 +2344,7 @@ export declare type Condition<T> = AlternativeType<T> | FilterOperators<Alternat
 export declare class ConnectionCheckedInEvent extends ConnectionPoolMonitoringEvent {
     /** The id of the connection */
     connectionId: number | '<monitor>';
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2268,6 +2356,7 @@ export declare class ConnectionCheckedInEvent extends ConnectionPoolMonitoringEv
 export declare class ConnectionCheckedOutEvent extends ConnectionPoolMonitoringEvent {
     /** The id of the connection */
     connectionId: number | '<monitor>';
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2278,7 +2367,9 @@ export declare class ConnectionCheckedOutEvent extends ConnectionPoolMonitoringE
  */
 export declare class ConnectionCheckOutFailedEvent extends ConnectionPoolMonitoringEvent {
     /** The reason the attempt to check out failed */
-    reason: AnyError | string;
+    reason: string;
+    /* Excluded from this release type: error */
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2288,6 +2379,7 @@ export declare class ConnectionCheckOutFailedEvent extends ConnectionPoolMonitor
  * @category Event
  */
 export declare class ConnectionCheckOutStartedEvent extends ConnectionPoolMonitoringEvent {
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2302,6 +2394,8 @@ export declare class ConnectionClosedEvent extends ConnectionPoolMonitoringEvent
     /** The reason the connection was closed */
     reason: string;
     serviceId?: ObjectId;
+    /* Excluded from this release type: name */
+    /* Excluded from this release type: error */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2313,6 +2407,7 @@ export declare class ConnectionClosedEvent extends ConnectionPoolMonitoringEvent
 export declare class ConnectionCreatedEvent extends ConnectionPoolMonitoringEvent {
     /** A monotonically increasing, per-pool id for the newly created connection */
     connectionId: number | '<monitor>';
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2340,7 +2435,9 @@ export declare interface ConnectionOptions extends SupportedNodeConnectionOption
     credentials?: MongoCredentials;
     connectTimeoutMS?: number;
     tls: boolean;
+    /** @deprecated - Will not be able to turn off in the future. */
     keepAlive?: boolean;
+    /** @deprecated - Will not be configurable in the future. */
     keepAliveInitialDelay?: number;
     noDelay?: boolean;
     socketTimeoutMS?: number;
@@ -2358,6 +2455,7 @@ export declare interface ConnectionOptions extends SupportedNodeConnectionOption
 export declare class ConnectionPoolClearedEvent extends ConnectionPoolMonitoringEvent {
     /* Excluded from this release type: serviceId */
     interruptInUseConnections?: boolean;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2367,6 +2465,7 @@ export declare class ConnectionPoolClearedEvent extends ConnectionPoolMonitoring
  * @category Event
  */
 export declare class ConnectionPoolClosedEvent extends ConnectionPoolMonitoringEvent {
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2378,6 +2477,7 @@ export declare class ConnectionPoolClosedEvent extends ConnectionPoolMonitoringE
 export declare class ConnectionPoolCreatedEvent extends ConnectionPoolMonitoringEvent {
     /** The options used to create this connection pool */
     options?: ConnectionPoolOptions;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2403,11 +2503,12 @@ export declare type ConnectionPoolEvents = {
  * @public
  * @category Event
  */
-export declare class ConnectionPoolMonitoringEvent {
+export declare abstract class ConnectionPoolMonitoringEvent {
     /** A timestamp when the event was created  */
     time: Date;
     /** The address (host/port pair) of the pool */
     address: string;
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2434,6 +2535,7 @@ export declare interface ConnectionPoolOptions extends Omit<ConnectionOptions, '
  * @category Event
  */
 export declare class ConnectionPoolReadyEvent extends ConnectionPoolMonitoringEvent {
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2445,6 +2547,7 @@ export declare class ConnectionPoolReadyEvent extends ConnectionPoolMonitoringEv
 export declare class ConnectionReadyEvent extends ConnectionPoolMonitoringEvent {
     /** The id of the connection */
     connectionId: number | '<monitor>';
+    /* Excluded from this release type: name */
     /* Excluded from this release type: __constructor */
 }
 
@@ -2635,6 +2738,22 @@ export declare class Db {
      * @remarks
      * This command does not inherit options from the MongoClient.
      *
+     * The driver will ensure the following fields are attached to the command sent to the server:
+     * - `lsid` - sourced from an implicit session or options.session
+     * - `$readPreference` - defaults to primary or can be configured by options.readPreference
+     * - `$db` - sourced from the name of this database
+     *
+     * If the client has a serverApi setting:
+     * - `apiVersion`
+     * - `apiStrict`
+     * - `apiDeprecationErrors`
+     *
+     * When in a transaction:
+     * - `readConcern` - sourced from readConcern set on the TransactionOptions
+     * - `writeConcern` - sourced from writeConcern set on the TransactionOptions
+     *
+     * Attaching any of the above fields to the command will have no effect as the driver will overwrite the value.
+     *
      * @param command - The command to run
      * @param options - Optional settings for the command
      */
@@ -2718,6 +2837,8 @@ export declare class Db {
      * @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/
      */
     addUser(username: string, passwordOrOptions?: string | AddUserOptions, options?: AddUserOptions): Promise<Document>;
     /**
@@ -3591,6 +3712,30 @@ export declare class HostAddress {
     static fromString(this: void, s: string): HostAddress;
     static fromHostPort(host: string, port: number): HostAddress;
     static fromSrvRecord({ name, port }: SrvRecord): HostAddress;
+    toHostPort(): {
+        host: string;
+        port: number;
+    };
+}
+
+/**
+ * @public
+ * @experimental
+ */
+export declare interface IdPServerInfo {
+    issuer: string;
+    clientId: string;
+    requestScopes?: string[];
+}
+
+/**
+ * @public
+ * @experimental
+ */
+export declare interface IdPServerResponse {
+    accessToken: string;
+    expiresInSeconds?: number;
+    refreshToken?: string;
 }
 
 /** @public */
@@ -3877,6 +4022,13 @@ export declare interface ListIndexesOptions extends Omit<CommandOperationOptions
     batchSize?: number;
 }
 
+/* Excluded from this release type: Log */
+
+/* Excluded from this release type: LogConvertible */
+
+/* Excluded from this release type: Loggable */
+
+/* Excluded from this release type: LoggableEvent */
 export { Long }
 
 /** @public */
@@ -4017,6 +4169,7 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> {
     /* Excluded from this release type: connectionLock */
     /* Excluded from this release type: [kOptions] */
     constructor(url: string, options?: MongoClientOptions);
+    /** @see MongoOptions */
     get options(): Readonly<MongoOptions>;
     get serverApi(): Readonly<ServerApi | undefined>;
     /* Excluded from this release type: monitorCommands */
@@ -4217,9 +4370,12 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     sslCRL?: string;
     /** TCP Connection no delay */
     noDelay?: boolean;
-    /** TCP Connection keep alive enabled */
+    /** @deprecated TCP Connection keep alive enabled. Will not be able to turn off in the future. */
     keepAlive?: boolean;
-    /** The number of milliseconds to wait before initiating keepAlive on the TCP socket */
+    /**
+     * @deprecated The number of milliseconds to wait before initiating keepAlive on the TCP socket.
+     *             Will not be configurable in the future.
+     */
     keepAliveInitialDelay?: number;
     /** Force server to assign `_id` values instead of driver */
     forceServerObjectId?: boolean;
@@ -4306,7 +4462,7 @@ export declare class MongoCredentials {
 
 /** @public */
 export declare interface MongoCredentialsOptions {
-    username: string;
+    username?: string;
     password: string;
     source: string;
     db?: string;
@@ -4337,6 +4493,8 @@ export declare class MongoCursorInUseError extends MongoAPIError {
     get name(): string;
 }
 
+/* Excluded from this release type: MongoDBLogWritable */
+
 /** @public */
 export declare class MongoDBNamespace {
     db: string;
@@ -4560,7 +4718,22 @@ export declare class MongoNotConnectedError extends MongoAPIError {
 }
 
 /**
- * Mongo Client Options
+ * Parsed Mongo Client Options.
+ *
+ * User supplied options are documented by `MongoClientOptions`.
+ *
+ * **NOTE:** The client's options parsing is subject to change to support new features.
+ * This type is provided to aid with inspection of options after parsing, it should not be relied upon programmatically.
+ *
+ * Options are sourced from:
+ * - connection string
+ * - options object passed to the MongoClient constructor
+ * - file system (ex. tls settings)
+ * - environment variables
+ * - DNS SRV records and TXT records
+ *
+ * Not all options may be present after client construction as some are obtained from asynchronous operations.
+ *
  * @public
  */
 export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'maxConnecting' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'srvMaxHosts' | 'srvServiceName' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
@@ -4833,36 +5006,24 @@ export { ObjectId }
  * @public
  * @experimental
  */
-export declare interface OIDCMechanismServerStep1 {
-    authorizationEndpoint?: string;
-    tokenEndpoint?: string;
-    deviceAuthorizationEndpoint?: string;
-    clientId: string;
-    clientSecret?: string;
-    requestScopes?: string[];
+export declare interface OIDCCallbackContext {
+    refreshToken?: string;
+    timeoutSeconds?: number;
+    timeoutContext?: AbortSignal;
+    version: number;
 }
 
 /**
  * @public
  * @experimental
  */
-export declare type OIDCRefreshFunction = (principalName: string, serverResult: OIDCMechanismServerStep1, result: OIDCRequestTokenResult, timeout: AbortSignal | number) => Promise<OIDCRequestTokenResult>;
+export declare type OIDCRefreshFunction = (info: IdPServerInfo, context: OIDCCallbackContext) => Promise<IdPServerResponse>;
 
 /**
  * @public
  * @experimental
  */
-export declare type OIDCRequestFunction = (principalName: string, serverResult: OIDCMechanismServerStep1, timeout: AbortSignal | number) => Promise<OIDCRequestTokenResult>;
-
-/**
- * @public
- * @experimental
- */
-export declare interface OIDCRequestTokenResult {
-    accessToken: string;
-    expiresInSeconds?: number;
-    refreshToken?: string;
-}
+export declare type OIDCRequestFunction = (info: IdPServerInfo, context: OIDCCallbackContext) => Promise<IdPServerResponse>;
 
 /** @public */
 export declare type OneOrMore<T> = T | ReadonlyArray<T>;
@@ -5208,7 +5369,10 @@ export declare const ReturnDocument: Readonly<{
 /** @public */
 export declare type ReturnDocument = (typeof ReturnDocument)[keyof typeof ReturnDocument];
 
-/** @public */
+/**
+ * @public
+ * @deprecated Use the createUser command directly instead.
+ */
 export declare interface RoleSpecification {
     /**
      * A role grants privileges to perform sets of actions on defined resources.
@@ -5239,7 +5403,37 @@ export declare interface RootFilterOperators<TSchema> extends Document {
 /* Excluded from this release type: RTTPingerOptions */
 
 /** @public */
-export declare type RunCommandOptions = CommandOperationOptions;
+export declare type RunCommandOptions = {
+    /** Specify ClientSession for this command */
+    session?: ClientSession;
+    /** The read preference */
+    readPreference?: ReadPreferenceLike;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    willRetryWrite?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    omitReadPreference?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    writeConcern?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    explain?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    readConcern?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    collation?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    maxTimeMS?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    comment?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    retryWrites?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    dbName?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    authdb?: any;
+    /** @deprecated This is an internal option that has undefined behavior for this API */
+    noResponse?: any;
+    /* Excluded from this release type: bypassPinningCheck */
+} & BSONSerializeOptions;
 
 /** @public */
 export declare type SchemaMember<T, V> = {
@@ -5969,8 +6163,11 @@ export declare interface UpdateOptions extends CommandOperationOptions {
     let?: Document;
 }
 
-/** @public */
-export declare interface UpdateResult {
+/**
+ * @public
+ * `TSchema` is the schema of the collection
+ */
+export declare interface UpdateResult<TSchema extends Document = Document> {
     /** Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined */
     acknowledged: boolean;
     /** The number of documents that matched the filter */
@@ -5980,7 +6177,7 @@ export declare interface UpdateResult {
     /** The number of documents that were upserted */
     upsertedCount: number;
     /** The identifier of the inserted document if an upsert took place */
-    upsertedId: ObjectId;
+    upsertedId: InferIdType<TSchema> | null;
 }
 
 /** @public */
@@ -6012,7 +6209,10 @@ export declare type W = number | 'majority';
 
 /* Excluded from this release type: WaitQueueMember */
 
-/** @public */
+/**
+ * @public
+ * @deprecated This type is only used for the deprecated `collStats` operation and will be removed in the next major release.
+ */
 export declare interface WiredTigerData extends Document {
     LSM: {
         'bloom filter false positives': number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "5.2.0",
+  "version": "5.4.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -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": {
@@ -127,7 +127,7 @@
     "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": "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:oidc": "mocha --config test/mocha_mongodb.json test/manual/mongodb_oidc.prose.test.ts",
     "check:ocsp": "mocha --config test/manual/mocharc.json test/manual/ocsp_support.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",

package/src/admin.ts

@@ -54,6 +54,22 @@ export class Admin {
   /**
    * Execute a command
    *
+   * The driver will ensure the following fields are attached to the command sent to the server:
+   * - `lsid` - sourced from an implicit session or options.session
+   * - `$readPreference` - defaults to primary or can be configured by options.readPreference
+   * - `$db` - sourced from the name of this database
+   *
+   * If the client has a serverApi setting:
+   * - `apiVersion`
+   * - `apiStrict`
+   * - `apiDeprecationErrors`
+   *
+   * When in a transaction:
+   * - `readConcern` - sourced from readConcern set on the TransactionOptions
+   * - `writeConcern` - sourced from writeConcern set on the TransactionOptions
+   *
+   * Attaching any of the above fields to the command will have no effect as the driver will overwrite the value.
+   *
    * @param command - The command to execute
    * @param options - Optional settings for the command
    */
@@ -106,6 +122,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,