mongodb 4.5.0 → 4.7.0

package/mongodb.d.ts

@@ -41,7 +41,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     /* Excluded from this release type: [kServer] */
     /* Excluded from this release type: [kNamespace] */
     /* Excluded from this release type: [kDocuments] */
-    /* Excluded from this release type: [kTopology] */
+    /* Excluded from this release type: [kClient] */
     /* Excluded from this release type: [kTransform] */
     /* Excluded from this release type: [kInitialized] */
     /* Excluded from this release type: [kClosed] */
@@ -51,7 +51,7 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     static readonly CLOSE: "close";
     /* Excluded from this release type: __constructor */
     get id(): Long | undefined;
-    /* Excluded from this release type: topology */
+    /* Excluded from this release type: client */
     /* Excluded from this release type: server */
     get namespace(): MongoDBNamespace;
     get readPreference(): ReadPreference;
@@ -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
@@ -555,7 +555,8 @@ 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: {
+    /** @experimental */
+    readonly cryptSharedLibVersionInfo: {
         version: bigint;
         versionStr: string;
     } | null;
@@ -652,8 +653,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;
@@ -671,15 +676,39 @@ export declare interface AutoEncryptionOptions {
         /** 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)
-         * @experimental
+         * Full path to a MongoDB Crypt 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 MongoDB Crypt shared library files from different
+         * MongoClients in the same process is not supported.
+         *
+         * If this option is provided and no MongoDB Crypt shared library could be loaded
+         * from the specified location, creating the MongoClient will fail.
+         *
+         * If this option is not provided and `cryptSharedLibRequired` 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.
+         *
+         * @experimental Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.
          */
-        csflePath?: string;
+        cryptSharedLibPath?: string;
         /**
-         * Search paths for a CSFLE shared library to be used (instead of mongocryptd)
-         * @experimental
+         * If specified, never use mongocryptd and instead fail when the MongoDB Crypt
+         * shared library could not be loaded.
+         *
+         * This is always true when `cryptSharedLibPath` is specified.
+         *
+         * @experimental Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.
          */
-        csfleSearchPaths?: string[];
+        cryptSharedLibRequired?: boolean;
+        /* Excluded from this release type: cryptSharedLibSearchPaths */
     };
     proxyOptions?: ProxyOptions;
     /** The TLS options to use connecting to the KMS provider */
@@ -985,7 +1014,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;
@@ -1029,8 +1058,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 */
@@ -1039,100 +1068,381 @@ 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 */
+
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamCollModDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'modify';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamCreateDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'create';
+}
+
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'createIndexes';
 }
 
 /* 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>, ChangeStreamDocumentCollectionUUID {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'delete';
+    /** Namespace the delete event occured on */
+    ns: ChangeStreamNameSpace;
+    /**
+     * Contains the pre-image of the modified or deleted document if the
+     * pre-image is available for the change event and either 'required' or
+     * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+     * when creating the change stream. If 'whenAvailable' was specified but the
+     * pre-image is unavailable, this will be explicitly set to null.
+     */
+    fullDocumentBeforeChange?: TSchema;
+}
+
+/** @public */
+export declare type ChangeStreamDocument<TSchema extends Document = Document> = ChangeStreamInsertDocument<TSchema> | ChangeStreamUpdateDocument<TSchema> | ChangeStreamReplaceDocument<TSchema> | ChangeStreamDeleteDocument<TSchema> | ChangeStreamDropDocument | ChangeStreamRenameDocument | ChangeStreamDropDatabaseDocument | ChangeStreamInvalidateDocument | ChangeStreamCreateIndexDocument | ChangeStreamCreateDocument | ChangeStreamCollModDocument | ChangeStreamDropIndexDocument | ChangeStreamShardCollectionDocument | ChangeStreamReshardCollectionDocument | ChangeStreamRefineCollectionShardKeyDocument;
+
+/** @public */
+export declare interface ChangeStreamDocumentCollectionUUID {
+    /**
+     * The UUID (Binary subtype 4) of the collection that the operation was performed on.
+     *
+     * Only present when the `showExpandedEvents` flag is enabled.
+     *
+     * **NOTE:** collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers
+     *    flag is enabled.
+     *
+     * @since 6.1.0
+     */
+    collectionUUID: Binary;
+}
+
 /** @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>;
+    _id: ResumeToken;
     /**
-     * Describes the type of operation represented in this change notification.
+     * 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.
      */
-    operationType: 'insert' | 'update' | 'replace' | 'delete' | 'invalidate' | 'drop' | 'dropDatabase' | 'rename';
+    clusterTime?: Timestamp;
     /**
-     * Contains two fields: “db” and “coll” containing the database and
-     * collection name in which the change happened.
+     * The transaction number.
+     * Only present if the operation is part of a multi-document transaction.
+     *
+     * **NOTE:** txnNumber can be a Long if promoteLongs is set to false
      */
-    ns: {
-        db: string;
-        coll: string;
-    };
+    txnNumber?: number;
     /**
-     * Only present for ops of type ‘insert’, ‘update’, ‘replace’, and
-     * ‘delete’.
-     *
-     * 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.
+     * The identifier for the session associated with the transaction.
+     * Only present if the operation is part of a multi-document transaction.
      */
-    documentKey?: {
-        _id: InferIdType<TSchema>;
-    };
+    lsid?: ServerSessionId;
+}
+
+/** @public */
+export declare interface ChangeStreamDocumentKey<TSchema extends Document = Document> {
     /**
-     * Only present for ops of type ‘update’.
-     *
-     * Contains a description of updated and removed fields in this
-     * operation.
+     * For unsharded collections this contains a single field `_id`.
+     * For sharded collections, this will contain all the components of the shard key
      */
-    updateDescription?: UpdateDescription<TSchema>;
+    documentKey: {
+        _id: InferIdType<TSchema>;
+        [shardKey: string]: any;
+    };
+}
+
+/** @public */
+export declare interface ChangeStreamDocumentOperationDescription {
     /**
-     * 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.
+     * An description of the operation.
      *
-     * 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.
+     * Only present when the `showExpandedEvents` flag is enabled.
      *
-     * 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.
+     * @since 6.1.0
      */
-    fullDocument?: TSchema;
+    operationDescription?: Document;
+}
+
+/**
+ * @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, ChangeStreamDocumentCollectionUUID {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'drop';
+    /** Namespace the drop event occured on */
+    ns: ChangeStreamNameSpace;
+}
+
+/**
+ * Only present when the `showExpandedEvents` flag is enabled.
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamDropIndexDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'dropIndexes';
 }
 
 /** @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>, ChangeStreamDocumentCollectionUUID {
+    /** 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: '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', 'whenAvailable', 'required'.
+     *
+     * When set to 'updateLookup', the change notification for partial updates
+     * 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.
+     *
+     * When set to 'whenAvailable', configures the change stream to return the
+     * post-image of the modified document for replace and update change events
+     * if the post-image for this event is available.
+     *
+     * When set to 'required', the same behavior as 'whenAvailable' except that
+     * an error is raised if the post-image is not available.
+     */
     fullDocument?: string;
+    /**
+     * Allowed values: 'whenAvailable', 'required', 'off'.
+     *
+     * The default is to not send a value, which is equivalent to 'off'.
+     *
+     * When set to 'whenAvailable', configures the change stream to return the
+     * pre-image of the modified document for replace, update, and delete change
+     * events if it is available.
+     *
+     * When set to 'required', the same behavior as 'whenAvailable' except that
+     * an error is raised if the pre-image is not available.
+     */
+    fullDocumentBeforeChange?: 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;
+    /**
+     * When enabled, configures the change stream to include extra change events.
+     *
+     * - createIndexes
+     * - dropIndexes
+     * - modify
+     * - create
+     * - shardCollection
+     * - reshardCollection
+     * - refineCollectionShardKey
+     */
+    showExpandedEvents?: boolean;
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamRefineCollectionShardKeyDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'refineCollectionShardKey';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/#rename-event
+ */
+export declare interface ChangeStreamRenameDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID {
+    /** 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;
+    /**
+     * Contains the pre-image of the modified or deleted document if the
+     * pre-image is available for the change event and either 'required' or
+     * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+     * when creating the change stream. If 'whenAvailable' was specified but the
+     * pre-image is unavailable, this will be explicitly set to null.
+     */
+    fullDocumentBeforeChange?: TSchema;
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamReshardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'reshardCollection';
+}
+
+/**
+ * @public
+ * @see https://www.mongodb.com/docs/manual/reference/change-events/
+ */
+export declare interface ChangeStreamShardCollectionDocument extends ChangeStreamDocumentCommon, ChangeStreamDocumentCollectionUUID, ChangeStreamDocumentOperationDescription {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'shardCollection';
+}
+
+/**
+ * @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 {
+    /** Describes the type of operation represented in this change notification */
+    operationType: 'update';
+    /**
+     * This is only set if `fullDocument` is set to `'updateLookup'`
+     * Contains the point-in-time post-image of the modified document if the
+     * post-image is available and either 'required' or 'whenAvailable' was
+     * specified for the 'fullDocument' option when creating the change stream.
+     */
+    fullDocument?: TSchema;
+    /** Contains a description of updated and removed fields in this operation */
+    updateDescription: UpdateDescription<TSchema>;
+    /** Namespace the update event occured on */
+    ns: ChangeStreamNameSpace;
+    /**
+     * Contains the pre-image of the modified or deleted document if the
+     * pre-image is available for the change event and either 'required' or
+     * 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option
+     * when creating the change stream. If 'whenAvailable' was specified but the
+     * pre-image is unavailable, this will be explicitly set to null.
+     */
+    fullDocumentBeforeChange?: TSchema;
 }
 
 /** @public */
@@ -1171,7 +1481,7 @@ export declare interface ClientMetadataOptions {
  * @public
  */
 export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents> {
-    /* Excluded from this release type: topology */
+    /* Excluded from this release type: client */
     /* Excluded from this release type: sessionPool */
     hasEnded: boolean;
     clientOptions?: MongoOptions;
@@ -1264,17 +1574,27 @@ export declare class ClientSession extends TypedEventEmitter<ClientSessionEvents
      */
     toBSON(): never;
     /**
-     * Runs a provided lambda within a transaction, retrying either the commit operation
+     * Runs a provided callback within a transaction, retrying either the commitTransaction operation
      * or entire transaction as needed (and when the error permits) to better ensure that
      * the transaction can complete successfully.
      *
-     * IMPORTANT: This method requires the user to return a Promise, all lambdas that do not
-     * return a Promise will result in undefined behavior.
+     * **IMPORTANT:** This method requires the user to return a Promise, and `await` all operations.
+     * Any callbacks that do not return a Promise will result in undefined behavior.
      *
-     * @param fn - A lambda to run within a transaction
-     * @param options - Optional settings for the transaction
+     * @remarks
+     * This function:
+     * - Will return the command response from the final commitTransaction if every operation is successful (can be used as a truthy object)
+     * - Will return `undefined` if the transaction is explicitly aborted with `await session.abortTransaction()`
+     * - Will throw if one of the operations throws or `throw` statement is used inside the `withTransaction` callback
+     *
+     * Checkout a descriptive example here:
+     * @see https://www.mongodb.com/developer/quickstart/node-transactions/
+     *
+     * @param fn - callback to run within a transaction
+     * @param options - optional settings for the transaction
+     * @returns A raw command response or undefined
      */
-    withTransaction<T = void>(fn: WithTransactionCallback<T>, options?: TransactionOptions): ReturnType<typeof fn>;
+    withTransaction<T = void>(fn: WithTransactionCallback<T>, options?: TransactionOptions): Promise<Document | undefined>;
 }
 
 /** @public */
@@ -1300,6 +1620,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;
@@ -1694,7 +2025,15 @@ export declare class Collection<TSchema extends Document = Document> {
     indexInformation(options: IndexInformationOptions, callback: Callback<Document>): void;
     /**
      * Gets an estimate of the count of documents in a collection using collection metadata.
+     * This will always run a count command on all server versions.
      *
+     * due to an oversight in versions 5.0.0-5.0.8 of MongoDB, the count command,
+     * which estimatedDocumentCount uses in its implementation, was not included in v1 of
+     * the Stable API, and so users of the Stable API with estimatedDocumentCount are
+     * recommended to upgrade their server version to 5.0.9+ or set apiStrict: false to avoid
+     * encountering errors.
+     *
+     * @see {@link https://www.mongodb.com/docs/manual/reference/command/count/#behavior|Count: Behavior}
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
@@ -1820,11 +2159,42 @@ export declare class Collection<TSchema extends Document = Document> {
     /**
      * 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 extends Document = 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.
      *
@@ -2070,6 +2440,7 @@ export declare const Compressor: Readonly<{
     readonly none: 0;
     readonly snappy: 1;
     readonly zlib: 2;
+    readonly zstd: 3;
 }>;
 
 /** @public */
@@ -2249,6 +2620,8 @@ export declare interface ConnectionPoolOptions extends Omit<ConnectionOptions, '
     maxPoolSize: number;
     /** The minimum number of connections that MUST exist at any moment in a single connection pool. */
     minPoolSize: number;
+    /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
+    maxConnecting: number;
     /** The maximum amount of time a connection should remain idle in the connection pool before being marked idle. */
     maxIdleTimeMS: number;
     /** The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit. */
@@ -2325,8 +2698,19 @@ 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;
+    /**
+     * If set, enables pre-update and post-update document events to be included for any
+     * change streams that listen on this collection.
+     */
+    changeStreamPreAndPostImages?: {
+        enabled: boolean;
+    };
 }
 
 /** @public */
@@ -2631,10 +3015,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 extends Document = 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;
@@ -2746,7 +3137,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;
@@ -3022,7 +3416,7 @@ export declare class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
      * @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.
      *
@@ -3588,6 +3982,8 @@ export declare type Join<T extends unknown[], D extends string> = T extends [] ?
 
 /* Excluded from this release type: kCheckedOut */
 
+/* Excluded from this release type: kClient */
+
 /* Excluded from this release type: kClosed */
 
 /* Excluded from this release type: kClosed_2 */
@@ -3670,7 +4066,7 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 
 /* Excluded from this release type: kOptions_3 */
 
-/* Excluded from this release type: kPermits */
+/* Excluded from this release type: kPending */
 
 /* Excluded from this release type: kPinnedConnection */
 
@@ -3706,8 +4102,6 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 
 /* Excluded from this release type: kStream */
 
-/* Excluded from this release type: kTopology */
-
 /* Excluded from this release type: kTransform */
 
 /* Excluded from this release type: kTxnNumberIncrement */
@@ -3951,6 +4345,18 @@ export declare class MongoAPIError extends MongoDriverError {
     get name(): string;
 }
 
+/**
+ * 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
@@ -4120,10 +4526,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 extends Document = 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;
 }
@@ -4181,6 +4594,8 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     maxPoolSize?: number;
     /** The minimum number of connections in the connection pool. */
     minPoolSize?: number;
+    /** The maximum number of connections that may be in the process of being established concurrently by the connection pool. */
+    maxConnecting?: number;
     /** The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed. */
     maxIdleTimeMS?: number;
     /** The maximum time in milliseconds that a thread can wait for a connection to become available. */
@@ -4289,6 +4704,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 */
@@ -4444,6 +4860,7 @@ export declare const MongoErrorLabel: Readonly<{
     readonly TransientTransactionError: "TransientTransactionError";
     readonly UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
     readonly ResumableChangeStreamError: "ResumableChangeStreamError";
+    readonly HandshakeError: "HandshakeError";
 }>;
 
 /** @public */
@@ -4578,7 +4995,7 @@ export declare class MongoNotConnectedError extends MongoAPIError {
  * Mongo Client Options
  * @public
  */
-export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'logger' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'srvMaxHosts' | 'srvServiceName' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
+export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'logger' | 'maxConnecting' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'srvMaxHosts' | 'srvServiceName' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
     hosts: HostAddress[];
     srvHost?: string;
     credentials?: MongoCredentials;
@@ -4617,10 +5034,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 */
 }
 
 /**
@@ -4796,7 +5210,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]>
@@ -4852,10 +5266,9 @@ 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;
 
@@ -5187,7 +5600,10 @@ export declare interface ReplaceOptions extends CommandOperationOptions {
 
 /* Excluded from this release type: Response */
 
-/** @public */
+/**
+ * @public
+ * @deprecated Please use the ChangeStreamCursorOptions type instead.
+ */
 export declare interface ResumeOptions {
     startAtOperationTime?: Timestamp;
     batchSize?: number;
@@ -5196,10 +5612,12 @@ export declare interface ResumeOptions {
     readPreference?: ReadPreference;
     resumeAfter?: ResumeToken;
     startAfter?: ResumeToken;
+    fullDocument?: string;
 }
 
 /**
- * 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;
@@ -5708,6 +6126,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 */
@@ -5770,6 +6189,7 @@ export declare interface TransactionOptions extends CommandOperationOptions {
     writeConcern?: WriteConcern;
     /** A default read preference for commands in this transaction */
     readPreference?: ReadPreference;
+    /** Specifies the maximum amount of time to allow a commit action on a transaction to run in milliseconds */
     maxCommitTimeMS?: number;
 }
 
@@ -5831,11 +6251,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 */