mongodb 4.4.1 → 4.6.0

package/mongodb.d.ts

@@ -67,7 +67,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     /** Returns current buffered documents */
     readBufferedDocuments(number?: number): TSchema[];
     [Symbol.asyncIterator](): AsyncIterator<TSchema, void>;
-    stream(options?: CursorStreamOptions): Readable;
+    stream(options?: CursorStreamOptions): Readable & AsyncIterable<TSchema>;
     hasNext(): Promise<boolean>;
     hasNext(callback: Callback<boolean>): void;
     /** Get the next available document from the cursor, returns null if no more documents are available. */
@@ -87,7 +87,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
      */
     forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>;
     forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void;
-    close(): void;
+    close(): Promise<void>;
     close(callback: Callback): void;
     /**
      * @deprecated options argument is deprecated
@@ -170,6 +170,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     abstract clone(): AbstractCursor<TSchema>;
     /* Excluded from this release type: _initialize */
     /* Excluded from this release type: _getMore */
+    /* Excluded from this release type: [kInit] */
 }
 
 /** @public */
@@ -184,7 +185,15 @@ export declare interface AbstractCursorOptions extends BSONSerializeOptions {
     readConcern?: ReadConcernLike;
     batchSize?: number;
     maxTimeMS?: number;
-    comment?: Document | string;
+    /**
+     * Comment to apply to the operation.
+     *
+     * In server versions pre-4.4, 'comment' must be string.  A server
+     * error will be thrown if any other type is provided.
+     *
+     * In server versions 4.4 and above, 'comment' can be any valid BSON type.
+     */
+    comment?: unknown;
     tailable?: boolean;
     awaitData?: boolean;
     noCursorTimeout?: boolean;
@@ -390,7 +399,7 @@ export declare interface AggregateOptions extends CommandOperationOptions {
  * or higher stream
  * @public
  */
-export declare class AggregationCursor<TSchema = Document> extends AbstractCursor<TSchema> {
+export declare class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
     /* Excluded from this release type: [kPipeline] */
     /* Excluded from this release type: [kOptions] */
     /* Excluded from this release type: __constructor */
@@ -546,6 +555,10 @@ export declare interface AutoEncrypter {
     teardown(force: boolean, callback: Callback): void;
     encrypt(ns: string, cmd: Document, options: any, callback: Callback<Document>): void;
     decrypt(cmd: Document, options: any, callback: Callback<Document>): void;
+    readonly csfleVersionInfo: {
+        version: bigint;
+        versionStr: string;
+    } | null;
 }
 
 /** @public */
@@ -639,8 +652,12 @@ export declare interface AutoEncryptionOptions {
      * Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.
      */
     schemaMap?: Document;
+    /** @experimental */
+    encryptedFieldsMap?: Document;
     /** Allows the user to bypass auto encryption, maintaining implicit decryption */
     bypassAutoEncryption?: boolean;
+    /** @experimental */
+    bypassQueryAnalysis?: boolean;
     options?: {
         /** An optional hook to catch logging messages from the underlying encryption engine */
         logger?: (level: AutoEncryptionLoggerLevel, message: string) => void;
@@ -657,6 +674,36 @@ export declare interface AutoEncryptionOptions {
         mongocryptdSpawnPath?: string;
         /** Command line arguments to use when auto-spawning a mongocryptd */
         mongocryptdSpawnArgs?: string[];
+        /**
+         * Full path to a CSFLE shared library to be used (instead of mongocryptd).
+         *
+         * This needs to be the path to the file itself, not a directory.
+         * It can be an absolute or relative path. If the path is relative and
+         * its first component is `$ORIGIN`, it will be replaced by the directory
+         * containing the mongodb-client-encryption native addon file. Otherwise,
+         * the path will be interpreted relative to the current working directory.
+         *
+         * Currently, loading different CSFLE shared library files from different
+         * MongoClients in the same process is not supported.
+         *
+         * If this option is provided and no CSFLE shared library could be loaded
+         * from the specified location, creating the MongoClient will fail.
+         *
+         * If this option is not provided and `csfleRequired` is not specified,
+         * the AutoEncrypter will attempt to spawn and/or use mongocryptd according
+         * to the mongocryptd-specific `extraOptions` options.
+         *
+         * Specifying a path prevents mongocryptd from being used as a fallback.
+         */
+        csflePath?: string;
+        /**
+         * If specified, never use mongocryptd and instead fail when the CSFLE shared library
+         * could not be loaded.
+         *
+         * This is always true when `csflePath` is specified.
+         */
+        csfleRequired?: boolean;
+        /* Excluded from this release type: csfleSearchPaths */
     };
     proxyOptions?: ProxyOptions;
     /** The TLS options to use connecting to the KMS provider */
@@ -720,6 +767,8 @@ export declare type BatchType = typeof BatchType[keyof typeof BatchType];
 
 export { Binary }
 
+/* Excluded from this release type: BinMsg */
+
 /** @public */
 export declare type BitwiseFilter = number /** numeric bit mask */ | Binary /** BinData bit mask */ | ReadonlyArray<number>;
 
@@ -878,6 +927,8 @@ export declare interface BulkWriteOptions extends CommandOperationOptions {
     keepGoing?: boolean;
     /** Force server to assign _id values instead of driver. */
     forceServerObjectId?: boolean;
+    /** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
+    let?: Document;
 }
 
 /**
@@ -958,7 +1009,7 @@ export declare class CancellationToken extends TypedEventEmitter<{
  * Creates a new Change Stream instance. Normally created using {@link Collection#watch|Collection.watch()}.
  * @public
  */
-export declare class ChangeStream<TSchema extends Document = Document> extends TypedEventEmitter<ChangeStreamEvents<TSchema>> {
+export declare class ChangeStream<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>> extends TypedEventEmitter<ChangeStreamEvents<TSchema, TChange>> {
     pipeline: Document[];
     options: ChangeStreamOptions;
     parent: MongoClient | Db | Collection;
@@ -1002,8 +1053,8 @@ export declare class ChangeStream<TSchema extends Document = Document> extends T
     hasNext(): Promise<boolean>;
     hasNext(callback: Callback<boolean>): void;
     /** Get the next available document from the Change Stream. */
-    next(): Promise<ChangeStreamDocument<TSchema>>;
-    next(callback: Callback<ChangeStreamDocument<TSchema>>): void;
+    next(): Promise<TChange>;
+    next(callback: Callback<TChange>): void;
     /** Is the cursor closed */
     get closed(): boolean;
     /** Close the Change Stream */
@@ -1012,102 +1063,231 @@ export declare class ChangeStream<TSchema extends Document = Document> extends T
      * Return a modified Readable stream including a possible transform method.
      * @throws MongoDriverError if this.cursor is undefined
      */
-    stream(options?: CursorStreamOptions): Readable;
+    stream(options?: CursorStreamOptions): Readable & AsyncIterable<TChange>;
     /**
      * 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(callback: Callback<Document | null>): void;
+    /* Excluded from this release type: _setIsEmitter */
+    /* Excluded from this release type: _setIsIterator */
+    /* Excluded from this release type: _createChangeStreamCursor */
+    /* Excluded from this release type: _waitForTopologyConnected */
+    /* Excluded from this release type: _closeWithError */
+    /* Excluded from this release type: _streamEvents */
+    /* Excluded from this release type: _endStream */
+    /* Excluded from this release type: _processNewChange */
+    /* Excluded from this release type: _processError */
+    /* Excluded from this release type: _getCursor */
+    /* Excluded from this release type: _processResumeQueue */
 }
 
+/* Excluded from this release type: ChangeStreamAggregateRawResult */
+
 /* Excluded from this release type: ChangeStreamCursor */
 
 /* Excluded from this release type: ChangeStreamCursorOptions */
 
+/**
+ * @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> {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'delete';
+    /** Namespace the delete event occured on */
+    ns: ChangeStreamNameSpace;
+}
+
+/** @public */
+export declare type ChangeStreamDocument<TSchema extends Document = Document> = ChangeStreamInsertDocument<TSchema> | ChangeStreamUpdateDocument<TSchema> | ChangeStreamReplaceDocument<TSchema> | ChangeStreamDeleteDocument<TSchema> | ChangeStreamDropDocument | ChangeStreamRenameDocument | ChangeStreamDropDatabaseDocument | ChangeStreamInvalidateDocument;
+
 /** @public */
-export declare interface ChangeStreamDocument<TSchema extends Document = Document> {
+export declare interface ChangeStreamDocumentCommon {
     /**
      * The id functions as an opaque token for use when resuming an interrupted
      * change stream.
      */
-    _id: InferIdType<TSchema>;
-    /**
-     * Describes the type of operation represented in this change notification.
-     */
-    operationType: 'insert' | 'update' | 'replace' | 'delete' | 'invalidate' | 'drop' | 'dropDatabase' | 'rename';
+    _id: ResumeToken;
     /**
-     * Contains two fields: “db” and “coll” containing the database and
-     * collection name in which the change happened.
+     * The timestamp from the oplog entry associated with the event.
+     * For events that happened as part of a multi-document transaction, the associated change stream
+     * notifications will have the same clusterTime value, namely the time when the transaction was committed.
+     * On a sharded cluster, events that occur on different shards can have the same clusterTime but be
+     * associated with different transactions or even not be associated with any transaction.
+     * To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.
      */
-    ns: {
-        db: string;
-        coll: string;
-    };
+    clusterTime?: Timestamp;
     /**
-     * Only present for ops of type ‘insert’, ‘update’, ‘replace’, and
-     * ‘delete’.
+     * The transaction number.
+     * Only present if the operation is part of a multi-document transaction.
      *
-     * For unsharded collections this contains a single field, _id, with the
-     * value of the _id of the document updated.  For sharded collections,
-     * this will contain all the components of the shard key in order,
-     * followed by the _id if the _id isn’t part of the shard key.
+     * **NOTE:** txnNumber can be a Long if promoteLongs is set to false
      */
-    documentKey?: {
-        _id: InferIdType<TSchema>;
-    };
+    txnNumber?: number;
     /**
-     * Only present for ops of type ‘update’.
-     *
-     * Contains a description of updated and removed fields in this
-     * operation.
+     * The identifier for the session associated with the transaction.
+     * Only present if the operation is part of a multi-document transaction.
      */
-    updateDescription?: UpdateDescription<TSchema>;
+    lsid?: ServerSessionId;
+}
+
+/** @public */
+export declare interface ChangeStreamDocumentKey<TSchema extends Document = Document> {
     /**
-     * Always present for operations of type ‘insert’ and ‘replace’. Also
-     * present for operations of type ‘update’ if the user has specified ‘updateLookup’
-     * in the ‘fullDocument’ arguments to the ‘$changeStream’ stage.
-     *
-     * For operations of type ‘insert’ and ‘replace’, this key will contain the
-     * document being inserted, or the new version of the document that is replacing
-     * the existing document, respectively.
-     *
-     * For operations of type ‘update’, this key will contain a copy of the full
-     * version of the document from some point after the update occurred. If the
-     * document was deleted since the updated happened, it will be null.
+     * For unsharded collections this contains a single field `_id`.
+     * For sharded collections, this will contain all the components of the shard key
      */
-    fullDocument?: TSchema;
+    documentKey: {
+        _id: InferIdType<TSchema>;
+        [shardKey: string]: any;
+    };
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event
+ */
+export declare interface ChangeStreamDropDatabaseDocument extends ChangeStreamDocumentCommon {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'dropDatabase';
+    /** The database dropped */
+    ns: {
+        db: string;
+    };
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/#drop-event
+ */
+export declare interface ChangeStreamDropDocument extends ChangeStreamDocumentCommon {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'drop';
+    /** Namespace the drop event occured on */
+    ns: ChangeStreamNameSpace;
 }
 
 /** @public */
-export declare type ChangeStreamEvents<TSchema extends Document = Document> = {
+export declare type ChangeStreamEvents<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>> = {
     resumeTokenChanged(token: ResumeToken): void;
-    init(response: TSchema): void;
-    more(response?: TSchema | undefined): void;
+    init(response: any): void;
+    more(response?: any): void;
     response(): void;
     end(): void;
     error(error: Error): void;
-    change(change: ChangeStreamDocument<TSchema>): void;
+    change(change: TChange): void;
 } & AbstractCursorEvents;
 
+/**
+ * @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> {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'insert';
+    /** This key will contain the document being inserted */
+    fullDocument: TSchema;
+    /** Namespace the insert event occured on */
+    ns: ChangeStreamNameSpace;
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event
+ */
+export declare interface ChangeStreamInvalidateDocument extends ChangeStreamDocumentCommon {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'invalidate';
+}
+
+/** @public */
+export declare interface ChangeStreamNameSpace {
+    db: string;
+    coll: string;
+}
+
 /**
  * Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.
  * @public
  */
 export declare interface ChangeStreamOptions extends AggregateOptions {
-    /** Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred. */
+    /**
+     * Allowed values: 'updateLookup'. When set to 'updateLookup',
+     * the change stream will include both a delta describing the changes to the document,
+     * as well as a copy of the entire document that was changed from some time after the change occurred.
+     */
     fullDocument?: string;
     /** The maximum amount of time for the server to wait on new documents to satisfy a change stream query. */
     maxAwaitTimeMS?: number;
-    /** Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}. */
+    /**
+     * Allows you to start a changeStream after a specified event.
+     * @see https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams
+     */
     resumeAfter?: ResumeToken;
-    /** Similar to resumeAfter, but will allow you to start after an invalidated event. See {@link https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams|ChangeStream documentation}. */
+    /**
+     * Similar to resumeAfter, but will allow you to start after an invalidated event.
+     * @see https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams
+     */
     startAfter?: ResumeToken;
     /** Will start the changeStream after the specified operationTime. */
     startAtOperationTime?: OperationTime;
-    /** The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/aggregate|aggregation documentation}. */
+    /**
+     * The number of documents to return per batch.
+     * @see https://docs.mongodb.com/manual/reference/command/aggregate
+     */
     batchSize?: number;
 }
 
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/#rename-event
+ */
+export declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'rename';
+    /** The new name for the `ns.coll` collection */
+    to: {
+        db: string;
+        coll: string;
+    };
+    /** The "from" namespace that the rename occured on */
+    ns: ChangeStreamNameSpace;
+}
+
+/**
+ * @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> {
+    /** 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 */
+    fullDocument: TSchema;
+    /** Namespace the replace event occured on */
+    ns: ChangeStreamNameSpace;
+}
+
+/**
+ * @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> {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'update';
+    /**
+     * This is only set if `fullDocument` is set to `'updateLookup'`
+     * The fullDocument document represents the most current majority-committed version of the updated document.
+     * The fullDocument document may vary from the document at the time of the update operation depending on the
+     * number of interleaving majority-committed operations that occur between the update operation and the document lookup.
+     */
+    fullDocument?: TSchema;
+    /** Contains a description of updated and removed fields in this operation */
+    updateDescription: UpdateDescription<TSchema>;
+    /** Namespace the update event occured on */
+    ns: ChangeStreamNameSpace;
+}
+
 /** @public */
 export declare interface ClientMetadata {
     driver: {
@@ -1161,6 +1341,7 @@ export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents
     /* Excluded from this release type: [kSnapshotTime] */
     /* Excluded from this release type: [kSnapshotEnabled] */
     /* Excluded from this release type: [kPinnedConnection] */
+    /* Excluded from this release type: [kTxnNumberIncrement] */
     /* Excluded from this release type: __constructor */
     /** The server id associated with this session */
     get id(): ServerSessionId | undefined;
@@ -1200,7 +1381,14 @@ export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents
      * @param session - The session to compare to
      */
     equals(session: ClientSession): boolean;
-    /** Increment the transaction number on the internal ServerSession */
+    /**
+     * Increment the transaction number on the internal ServerSession
+     *
+     * @privateRemarks
+     * This helper increments a value stored on the client session that will be
+     * added to the serverSession's txnNumber upon applying it to a command.
+     * This is because the serverSession is lazily acquired after a connection is obtained
+     */
     incrementTransactionNumber(): void;
     /** @returns whether this session is currently in a transaction or not */
     inTransaction(): boolean;
@@ -1265,6 +1453,17 @@ export declare interface CloseOptions {
     force?: boolean;
 }
 
+/** @public
+ * Configuration options for clustered collections
+ * TODO: NODE-4230 replace with normal manual link once it is on there.
+ * @see https://www.mongodb.com/docs/v5.3/core/clustered-collections/
+ */
+export declare interface ClusteredCollectionOptions extends Document {
+    name?: string;
+    key: Document;
+    unique: boolean;
+}
+
 /** @public */
 export declare interface ClusterTime {
     clusterTime: Timestamp;
@@ -1519,7 +1718,7 @@ export declare class Collection<TSchema extends Document = Document> {
      */
     find(): FindCursor<WithId<TSchema>>;
     find(filter: Filter<TSchema>, options?: FindOptions): FindCursor<WithId<TSchema>>;
-    find<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
+    find<T extends Document>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the options of the collection.
      *
@@ -1781,15 +1980,46 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param pipeline - An array of aggregation pipelines to execute
      * @param options - Optional settings for the command
      */
-    aggregate<T = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
+    aggregate<T extends Document = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
     /**
      * Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
      *
-     * @since 3.0.0
+     * @remarks
+     * watch() accepts two generic arguments for distinct usecases:
+     * - The first is to override the schema that may be defined for this specific collection
+     * - The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
+     * @example
+     * By just providing the first argument I can type the change to be `ChangeStreamDocument<{ _id: number }>`
+     * ```ts
+     * collection.watch<{ _id: number }>()
+     *   .on('change', change => console.log(change._id.toFixed(4)));
+     * ```
+     *
+     * @example
+     * Passing a second argument provides a way to reflect the type changes caused by an advanced pipeline.
+     * Here, we are using a pipeline to have MongoDB filter for insert changes only and add a comment.
+     * No need start from scratch on the ChangeStreamInsertDocument type!
+     * By using an intersection we can save time and ensure defaults remain the same type!
+     * ```ts
+     * collection
+     *   .watch<Schema, ChangeStreamInsertDocument<Schema> & { comment: string }>([
+     *     { $addFields: { comment: 'big changes' } },
+     *     { $match: { operationType: 'insert' } }
+     *   ])
+     *   .on('change', change => {
+     *     change.comment.startsWith('big');
+     *     change.operationType === 'insert';
+     *     // No need to narrow in code because the generics did that for us!
+     *     expectType<Schema>(change.fullDocument);
+     *   });
+     * ```
+     *
      * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
      * @param options - Optional settings for the command
+     * @typeParam TLocal - Type of the data being detected by the change stream
+     * @typeParam TChange - Type of the whole change stream document emitted
      */
-    watch<TLocal = TSchema>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TLocal>;
+    watch<TLocal extends Document = TSchema, TChange extends Document = ChangeStreamDocument<TLocal>>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TLocal, TChange>;
     /**
      * Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.
      *
@@ -1974,8 +2204,15 @@ export declare interface CommandOperationOptions extends OperationOptions, Write
     /** Collation */
     collation?: CollationOptions;
     maxTimeMS?: number;
-    /** A user-provided comment to attach to this command */
-    comment?: string | Document;
+    /**
+     * Comment to apply to the operation.
+     *
+     * In server versions pre-4.4, 'comment' must be string.  A server
+     * error will be thrown if any other type is provided.
+     *
+     * In server versions 4.4 and above, 'comment' can be any valid BSON type.
+     */
+    comment?: unknown;
     /** Should retry failed writes */
     retryWrites?: boolean;
     dbName?: string;
@@ -2283,8 +2520,12 @@ export declare interface CreateCollectionOptions extends CommandOperationOptions
     pkFactory?: PkFactory;
     /** A document specifying configuration options for timeseries collections. */
     timeseries?: TimeSeriesCollectionOptions;
-    /** The number of seconds after which a document in a timeseries collection expires. */
+    /** A document specifying configuration options for clustered collections. For MongoDB 5.3 and above. */
+    clusteredIndex?: ClusteredCollectionOptions;
+    /** The number of seconds after which a document in a timeseries or clustered collection expires. */
     expireAfterSeconds?: number;
+    /** @experimental */
+    encryptedFields?: Document;
 }
 
 /** @public */
@@ -2429,7 +2670,7 @@ export declare class Db {
      * @param pipeline - An array of aggregation stages to be executed
      * @param options - Optional settings for the command
      */
-    aggregate<T = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
+    aggregate<T extends Document = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
     /** Return the Admin db instance */
     admin(): Admin;
     /**
@@ -2589,10 +2830,17 @@ export declare class Db {
      * replacements, deletions, and invalidations) in this database. Will ignore all
      * changes to system collections.
      *
+     * @remarks
+     * watch() accepts two generic arguments for distinct usecases:
+     * - The first is to provide the schema that may be defined for all the collections within this database
+     * - The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
+     *
      * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
      * @param options - Optional settings for the command
+     * @typeParam TSchema - Type of the data being detected by the change stream
+     * @typeParam TChange - Type of the whole change stream document emitted
      */
-    watch<TSchema = Document>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema>;
+    watch<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema, TChange>;
     /** Return the db logger */
     getLogger(): Logger;
     get logger(): Logger;
@@ -2651,8 +2899,6 @@ export declare interface DeleteOneModel<TSchema extends Document = Document> {
 export declare interface DeleteOptions extends CommandOperationOptions, WriteConcernOptions {
     /** If true, when an insert fails, don't execute the remaining writes. If false, continue with remaining inserts when one fails. */
     ordered?: boolean;
-    /** A user-provided comment to attach to this command */
-    comment?: string | Document;
     /** Specifies the collation to use for the operation */
     collation?: CollationOptions;
     /** Specify that the update query should only consider plans using the hinted index */
@@ -2681,8 +2927,6 @@ export declare interface DeleteStatement {
     collation?: CollationOptions;
     /** A document or string that specifies the index to use to support the query predicate. */
     hint?: Hint;
-    /** A user-provided comment to attach to this command */
-    comment?: string | Document;
 }
 
 /* Excluded from this release type: deserialize */
@@ -2708,7 +2952,10 @@ export declare interface DriverInfo {
 }
 
 /** @public */
-export declare type DropCollectionOptions = CommandOperationOptions;
+export declare interface DropCollectionOptions extends CommandOperationOptions {
+    /** @experimental */
+    encryptedFields?: Document;
+}
 
 /** @public */
 export declare type DropDatabaseOptions = CommandOperationOptions;
@@ -2847,7 +3094,7 @@ export declare interface FilterOperators<TValue> extends NonObjectIdLikeDocument
 export declare type FinalizeFunction<TKey = ObjectId, TValue = Document> = (key: TKey, reducedValue: TValue) => TValue;
 
 /** @public */
-export declare class FindCursor<TSchema = Document> extends AbstractCursor<TSchema> {
+export declare class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
     /* Excluded from this release type: [kFilter] */
     /* Excluded from this release type: [kNumReturned] */
     /* Excluded from this release type: [kBuiltOptions] */
@@ -2984,7 +3231,7 @@ export declare class FindCursor<TSchema = Document> extends AbstractCursor<TSche
      * @remarks
      * {@link https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
      */
-    allowDiskUse(): this;
+    allowDiskUse(allow?: boolean): this;
     /**
      * Set the collation options for the cursor.
      *
@@ -3111,8 +3358,6 @@ export declare interface FindOptions<TSchema extends Document = Document> extend
     min?: Document;
     /** The exclusive upper bound for a specific index */
     max?: Document;
-    /** You can put a $comment field on a query to make looking in the profiler logs simpler. */
-    comment?: string | Document;
     /** Number of milliseconds to wait before aborting the query. */
     maxTimeMS?: number;
     /** The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Requires `tailable` and `awaitData` to be true */
@@ -3181,7 +3426,7 @@ export declare class GridFSBucket extends TypedEventEmitter<GridFSBucketEvents>
      *
      * @param id - The id of the file doc
      */
-    delete(id: ObjectId): Promise<undefined>;
+    delete(id: ObjectId): Promise<void>;
     delete(id: ObjectId, callback: Callback<void>): void;
     /** Convenience wrapper around find on the files collection */
     find(filter?: Filter<GridFSFile>, options?: FindOptions): FindCursor<GridFSFile>;
@@ -3566,6 +3811,8 @@ export declare type Join<T extends unknown[], D extends string> = T extends [] ?
 
 /* Excluded from this release type: kCursorStream */
 
+/* Excluded from this release type: kDelayedTimeoutId */
+
 /* Excluded from this release type: kDescription */
 
 /* Excluded from this release type: kDocuments */
@@ -3596,6 +3843,8 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 
 /* Excluded from this release type: KillCursor */
 
+/* Excluded from this release type: kInit */
+
 /* Excluded from this release type: kInitialized */
 
 /* Excluded from this release type: kInternalClient */
@@ -3670,6 +3919,8 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 
 /* Excluded from this release type: kTransform */
 
+/* Excluded from this release type: kTxnNumberIncrement */
+
 /* Excluded from this release type: kWaitQueue */
 
 /* Excluded from this release type: kWaitQueue_2 */
@@ -3878,6 +4129,8 @@ export declare type MatchKeysAndValues<TSchema> = Readonly<Partial<TSchema>> & R
 
 export { MaxKey }
 
+/* Excluded from this release type: MessageHeader */
+
 /* Excluded from this release type: MessageStream */
 
 /* Excluded from this release type: MessageStreamOptions */
@@ -3908,7 +4161,19 @@ export declare class MongoAPIError extends MongoDriverError {
 }
 
 /**
- * An error generated when a batch command is reexecuted after one of the commands in the batch
+ * A error generated when the user attempts to authenticate
+ * via AWS, but fails
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoAWSError extends MongoRuntimeError {
+    constructor(message: string);
+    get name(): string;
+}
+
+/**
+ * An error generated when a batch command is re-executed after one of the commands in the batch
  * has failed
  *
  * @public
@@ -4076,10 +4341,17 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> {
      * replacements, deletions, and invalidations) in this cluster. Will ignore all
      * changes to system collections, as well as the local, admin, and config databases.
      *
+     * @remarks
+     * watch() accepts two generic arguments for distinct usecases:
+     * - The first is to provide the schema that may be defined for all the data within the current cluster
+     * - The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
+     *
      * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
      * @param options - Optional settings for the command
+     * @typeParam TSchema - Type of the data being detected by the change stream
+     * @typeParam TChange - Type of the whole change stream document emitted
      */
-    watch<TSchema = Document>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema>;
+    watch<TSchema extends Document = Document, TChange extends Document = ChangeStreamDocument<TSchema>>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema, TChange>;
     /** Return the mongo client logger */
     getLogger(): Logger;
 }
@@ -4245,6 +4517,7 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     proxyPassword?: string;
     /* Excluded from this release type: srvPoller */
     /* Excluded from this release type: connectionType */
+    /* Excluded from this release type: __index */
 }
 
 /* Excluded from this release type: MongoClientPrivate */
@@ -4394,6 +4667,18 @@ export declare class MongoError extends Error {
     get errorLabels(): string[];
 }
 
+/** @public */
+export declare const MongoErrorLabel: Readonly<{
+    readonly RetryableWriteError: "RetryableWriteError";
+    readonly TransientTransactionError: "TransientTransactionError";
+    readonly UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
+    readonly ResumableChangeStreamError: "ResumableChangeStreamError";
+    readonly HandshakeError: "HandshakeError";
+}>;
+
+/** @public */
+export declare type MongoErrorLabel = typeof MongoErrorLabel[keyof typeof MongoErrorLabel];
+
 /**
  * An error generated when the user attempts to operate
  * on a session that has expired or has been closed.
@@ -4562,10 +4847,7 @@ export declare interface MongoOptions extends Required<Pick<MongoClientOptions,
      *
      */
     tls: boolean;
-    /**
-     * Turn these options into a reusable connection URI
-     */
-    toURI(): string;
+    /* Excluded from this release type: __index */
 }
 
 /**
@@ -4678,6 +4960,27 @@ export declare class MongoTransactionError extends MongoAPIError {
     get name(): string;
 }
 
+/**
+ * An error generated when a **parsable** unexpected response comes from the server.
+ * This is generally an error where the driver in a state expecting a certain behavior to occur in
+ * the next message from MongoDB but it receives something else.
+ * This error **does not** represent an issue with wire message formatting.
+ *
+ * #### Example
+ * When an operation fails, it is the driver's job to retry it. It must perform serverSelection
+ * again to make sure that it attempts the operation against a server in a good state. If server
+ * selection returns a server that does not support retryable operations, this error is used.
+ * This scenario is unlikely as retryable support would also have been determined on the first attempt
+ * but it is possible the state change could report a selectable server that does not support retries.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoUnexpectedServerResponseError extends MongoRuntimeError {
+    constructor(message: string);
+    get name(): string;
+}
+
 /**
  * An error thrown when the server reports a writeConcernError
  * @public
@@ -4686,7 +4989,6 @@ export declare class MongoTransactionError extends MongoAPIError {
 export declare class MongoWriteConcernError extends MongoServerError {
     /** The result document (provided if ok: 1) */
     result?: Document;
-    errInfo?: Document;
     constructor(message: ErrorDescription, result?: Document);
     get name(): string;
 }
@@ -4721,7 +5023,7 @@ export declare interface MonitorOptions extends Omit<ConnectionOptions, 'id' | '
  */
 export declare type NestedPaths<Type> = Type extends string | number | boolean | Date | RegExp | Buffer | Uint8Array | ((...args: any[]) => any) | {
     _bsontype: string;
-} ? [] : Type extends ReadonlyArray<infer ArrayType> ? [number, ...NestedPaths<ArrayType>] : Type extends Map<string, any> ? [string] : Type extends object ? {
+} ? [] : Type extends ReadonlyArray<infer ArrayType> ? [] | [number, ...NestedPaths<ArrayType>] : Type extends Map<string, any> ? [string] : Type extends object ? {
     [Key in Extract<keyof Type, string>]: Type[Key] extends Type ? [Key] : Type extends Type[Key] ? [Key] : Type[Key] extends ReadonlyArray<infer ArrayType> ? Type extends ArrayType ? [Key] : ArrayType extends Type ? [Key] : [
     Key,
     ...NestedPaths<Type[Key]>
@@ -4767,7 +5069,7 @@ export declare type OnlyFieldsOfType<TSchema, FieldType = any, AssignableType =
 export declare interface OperationOptions extends BSONSerializeOptions {
     /** Specify ClientSession for this command */
     session?: ClientSession;
-    willRetryWrites?: boolean;
+    willRetryWrite?: boolean;
     /** The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest). */
     readPreference?: ReadPreferenceLike;
     /* Excluded from this release type: bypassPinningCheck */
@@ -4777,17 +5079,20 @@ export declare interface OperationOptions extends BSONSerializeOptions {
 /* Excluded from this release type: OperationParent */
 
 /**
- * Represents a specific point in time on a server. Can be retrieved by using {@link Db#command}
+ * Represents a specific point in time on a server. Can be retrieved by using `db.command()`
  * @public
- * @remarks
- * See {@link https://docs.mongodb.com/manual/reference/method/db.runCommand/#response| Run Command Response}
+ * @see https://docs.mongodb.com/manual/reference/method/db.runCommand/#response
  */
 export declare type OperationTime = Timestamp;
 
 /* Excluded from this release type: OpGetMoreOptions */
 
+/* Excluded from this release type: OpMsgOptions */
+
 /* Excluded from this release type: OpQueryOptions */
 
+/* Excluded from this release type: OpResponseOptions */
+
 /**
  * Add an optional _id field to an object shaped type
  * @public
@@ -5106,6 +5411,8 @@ export declare interface ReplaceOptions extends CommandOperationOptions {
     let?: Document;
 }
 
+/* Excluded from this release type: Response */
+
 /** @public */
 export declare interface ResumeOptions {
     startAtOperationTime?: Timestamp;
@@ -5113,10 +5420,13 @@ export declare interface ResumeOptions {
     maxAwaitTimeMS?: number;
     collation?: CollationOptions;
     readPreference?: ReadPreference;
+    resumeAfter?: ResumeToken;
+    startAfter?: ResumeToken;
 }
 
 /**
- * Represents the logical starting point for a new or resuming {@link https://docs.mongodb.com/manual/changeStreams/#std-label-change-stream-resume| Change Stream} on the server.
+ * Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.
+ * @see https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume
  * @public
  */
 export declare type ResumeToken = unknown;
@@ -5387,6 +5697,7 @@ export declare class ServerSession {
      * @param sessionTimeoutMinutes - The server's "logicalSessionTimeoutMinutes"
      */
     hasTimedOut(sessionTimeoutMinutes: number): boolean;
+    /* Excluded from this release type: clone */
 }
 
 /** @public */
@@ -5469,7 +5780,7 @@ export declare class StreamDescription {
     __nodejs_mock_server__?: boolean;
     zlibCompressionLevel?: number;
     constructor(address: string, options?: StreamDescriptionOptions);
-    receiveResponse(response: Document): void;
+    receiveResponse(response: Document | null): void;
 }
 
 /** @public */
@@ -5624,6 +5935,7 @@ export declare interface TopologyOptions extends BSONSerializeOptions, ServerOpt
     metadata: ClientMetadata;
     /** MongoDB server API version */
     serverApi?: ServerApi;
+    /* Excluded from this release type: __index */
 }
 
 /* Excluded from this release type: TopologyPrivate */
@@ -5737,7 +6049,7 @@ export declare class TypedEventEmitter<Events extends EventsDescription> extends
 /** @public */
 export declare class UnorderedBulkOperation extends BulkOperationBase {
     constructor(collection: Collection, options: BulkWriteOptions);
-    handleWriteError(callback: Callback, writeResult: BulkWriteResult): boolean | undefined;
+    handleWriteError(callback: Callback, writeResult: BulkWriteResult): boolean;
     addToOperationsList(batchType: BatchType, document: Document | UpdateStatement | DeleteStatement): this;
 }
 
@@ -5747,11 +6059,24 @@ export declare interface UpdateDescription<TSchema extends Document = Document>
      * A document containing key:value pairs of names of the fields that were
      * changed, and the new value for those fields.
      */
-    updatedFields: Partial<TSchema>;
+    updatedFields?: Partial<TSchema>;
     /**
      * An array of field names that were removed from the document.
      */
-    removedFields: string[];
+    removedFields?: string[];
+    /**
+     * An array of documents which record array truncations performed with pipeline-based updates using one or more of the following stages:
+     * - $addFields
+     * - $set
+     * - $replaceRoot
+     * - $replaceWith
+     */
+    truncatedArrays?: Array<{
+        /** The name of the truncated field. */
+        field: string;
+        /** The number of elements in the truncated array. */
+        newSize: number;
+    }>;
 }
 
 /** @public */
@@ -6020,7 +6345,7 @@ export declare type WithId<TSchema> = EnhancedOmit<TSchema, '_id'> & {
 export declare type WithoutId<TSchema> = Omit<TSchema, '_id'>;
 
 /** @public */
-export declare type WithSessionCallback = (session: ClientSession) => Promise<any> | void;
+export declare type WithSessionCallback = (session: ClientSession) => Promise<any>;
 
 /** @public */
 export declare type WithTransactionCallback<T = void> = (session: ClientSession) => Promise<T>;