mongodb 4.1.0 → 4.1.4

package/mongodb.ts34.d.ts

@@ -67,24 +67,31 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     hasNext(): Promise<boolean>;
     hasNext(callback: Callback<boolean>): void;
     /** Get the next available document from the cursor, returns null if no more documents are available. */
-    next<T = TSchema>(): Promise<T | null>;
-    next<T = TSchema>(callback: Callback<T | null>): void;
+    next(): Promise<TSchema | null>;
+    next(callback: Callback<TSchema | null>): void;
+    next(callback?: Callback<TSchema | null>): Promise<TSchema | null> | void;
     /**
      * Try to get the next available document from the cursor or `null` if an empty batch is returned
      */
-    tryNext<T = TSchema>(): Promise<T | null>;
-    tryNext<T = TSchema>(callback: Callback<T | null>): void;
+    tryNext(): Promise<TSchema | null>;
+    tryNext(callback: Callback<TSchema | null>): void;
     /**
      * Iterates over all the documents for this cursor using the iterator, callback pattern.
      *
      * @param iterator - The iteration callback.
      * @param callback - The end callback.
      */
-    forEach<T = TSchema>(iterator: (doc: T) => boolean | void): Promise<void>;
-    forEach<T = TSchema>(iterator: (doc: T) => boolean | void, callback: Callback<void>): void;
-    close(): Promise<void>;
+    forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>;
+    forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void;
+    close(): void;
     close(callback: Callback): void;
+    /**
+     * @deprecated options argument is deprecated
+     */
     close(options: CursorCloseOptions): Promise<void>;
+    /**
+     * @deprecated options argument is deprecated
+     */
     close(options: CursorCloseOptions, callback: Callback): void;
     /**
      * Returns an array of documents. The caller is responsible for making sure that there
@@ -94,8 +101,8 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
      *
      * @param callback - The result callback.
      */
-    toArray<T = TSchema>(): Promise<T[]>;
-    toArray<T = TSchema>(callback: Callback<T[]>): void;
+    toArray(): Promise<TSchema[]>;
+    toArray(callback: Callback<TSchema[]>): void;
     /**
      * Add a cursor flag to the cursor
      *
@@ -107,11 +114,12 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
      * Map all documents using the provided function
      * If there is a transform set on the cursor, that will be called first and the result passed to
      * this function's transform.
-     * @remarks
      *
-     * **NOTE:** adding a transform changes the return type of the iteration of this cursor, it **does not** return
-     * a new instance of a cursor. This means when calling map, you should always assign the result to a new
-     * variable. Take note of the following example:
+     * @remarks
+     * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
+     * it **does not** return a new instance of a cursor. This means when calling map,
+     * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+     * Take note of the following example:
      *
      * @example
      * ```typescript
@@ -383,8 +391,11 @@ export declare class AggregationCursor<TSchema = Document> extends AbstractCurso
     limit($limit: number): this;
     /** Add a match stage to the aggregation pipeline */
     match($match: Document): this;
-    /** Add a out stage to the aggregation pipeline */
-    out($out: number): this;
+    /** Add an out stage to the aggregation pipeline */
+    out($out: {
+        db: string;
+        coll: string;
+    } | string): this;
     /**
      * Add a project stage to the aggregation pipeline
      *
@@ -392,18 +403,41 @@ export declare class AggregationCursor<TSchema = Document> extends AbstractCurso
      * In order to strictly type this function you must provide an interface
      * that represents the effect of your projection on the result documents.
      *
-     * **NOTE:** adding a projection changes the return type of the iteration of this cursor,
+     * By default chaining a projection to your cursor changes the returned type to the generic {@link Document} type.
+     * You should specify a parameterized type to have assertions on your final results.
+     *
+     * @example
+     * ```typescript
+     * // Best way
+     * const docs: AggregationCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+     * // Flexible way
+     * const docs: AggregationCursor<Document> = cursor.project({ _id: 0, a: true });
+     * ```
+     *
+     * @remarks
+     * In order to strictly type this function you must provide an interface
+     * that represents the effect of your projection on the result documents.
+     *
+     * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
      * it **does not** return a new instance of a cursor. This means when calling project,
-     * you should always assign the result to a new variable. Take note of the following example:
+     * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+     * Take note of the following example:
      *
      * @example
      * ```typescript
      * const cursor: AggregationCursor<{ a: number; b: string }> = coll.aggregate([]);
-     * const projectCursor = cursor.project<{ a: number }>({ a: true });
+     * const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
      * const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
+     *
+     * // or always use chaining and save the final cursor
+     *
+     * const cursor = coll.aggregate().project<{ a: string }>({
+     *   _id: 0,
+     *   a: { $convert: { input: '$a', to: 'string' }
+     * }});
      * ```
      */
-    project<T = TSchema>($project: Projection<T>): AggregationCursor<T>;
+    project<T extends Document = Document>($project: Document): AggregationCursor<T>;
     /** Add a lookup stage to the aggregation pipeline */
     lookup($lookup: Document): this;
     /** Add a redact stage to the aggregation pipeline */
@@ -471,6 +505,13 @@ export declare const AuthMechanism: Readonly<{
 /** @public */
 export declare type AuthMechanism = typeof AuthMechanism[keyof typeof AuthMechanism];
 /** @public */
+export declare interface AuthMechanismProperties extends Document {
+    SERVICE_NAME?: string;
+    SERVICE_REALM?: string;
+    CANONICALIZE_HOST_NAME?: boolean;
+    AWS_SESSION_TOKEN?: string;
+}
+/** @public */
 export declare interface AutoEncrypter {
     new (client: MongoClient, options: AutoEncryptionOptions): AutoEncrypter;
     init(cb: Callback): void;
@@ -730,6 +771,7 @@ export declare interface BulkWriteOperationError {
     index: number;
     code: number;
     errmsg: string;
+    errInfo: Document;
     op: Document | UpdateStatement | DeleteStatement;
 }
 /** @public */
@@ -1258,10 +1300,10 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>): Promise<UpdateResult | Document>;
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, callback: Callback<UpdateResult | Document>): void;
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options: UpdateOptions): Promise<UpdateResult | Document>;
-    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options: UpdateOptions, callback: Callback<UpdateResult | Document>): void;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>): Promise<UpdateResult>;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, callback: Callback<UpdateResult>): void;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options: UpdateOptions): Promise<UpdateResult>;
+    updateOne(filter: Filter<TSchema>, update: UpdateFilter<TSchema> | Partial<TSchema>, options: UpdateOptions, callback: Callback<UpdateResult>): void;
     /**
      * Replace a document in a collection with another document
      *
@@ -1339,25 +1381,25 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
-    findOne(): Promise<TSchema | undefined>;
-    findOne(callback: Callback<TSchema | undefined>): void;
-    findOne(filter: Filter<TSchema>): Promise<TSchema | undefined>;
-    findOne(filter: Filter<TSchema>, callback: Callback<TSchema | undefined>): void;
-    findOne(filter: Filter<TSchema>, options: FindOptions<TSchema>): Promise<TSchema | undefined>;
-    findOne(filter: Filter<TSchema>, options: FindOptions<TSchema>, callback: Callback<TSchema | undefined>): void;
-    findOne<T = TSchema>(): Promise<T | undefined>;
-    findOne<T = TSchema>(callback: Callback<T | undefined>): void;
-    findOne<T = TSchema>(filter: Filter<T>): Promise<T | undefined>;
-    findOne<T = TSchema>(filter: Filter<T>, options?: FindOptions<T>): Promise<T | undefined>;
-    findOne<T = TSchema>(filter: Filter<T>, options?: FindOptions<T>, callback?: Callback<T | undefined>): void;
+    findOne(): Promise<TSchema | null>;
+    findOne(callback: Callback<TSchema | null>): void;
+    findOne(filter: Filter<TSchema>): Promise<TSchema | null>;
+    findOne(filter: Filter<TSchema>, callback: Callback<TSchema | null>): void;
+    findOne(filter: Filter<TSchema>, options: FindOptions): Promise<TSchema | null>;
+    findOne(filter: Filter<TSchema>, options: FindOptions, callback: Callback<TSchema | null>): void;
+    findOne<T = TSchema>(): Promise<T | null>;
+    findOne<T = TSchema>(callback: Callback<T | null>): void;
+    findOne<T = TSchema>(filter: Filter<TSchema>): Promise<T | null>;
+    findOne<T = TSchema>(filter: Filter<TSchema>, options?: FindOptions): Promise<T | null>;
+    findOne<T = TSchema>(filter: Filter<TSchema>, options?: FindOptions, callback?: Callback<T | null>): void;
     /**
      * Creates a cursor for a filter that can be used to iterate over results from MongoDB
      *
      * @param filter - The filter predicate. If unspecified, then all documents in the collection will match the predicate
      */
     find(): FindCursor<TSchema>;
-    find(filter: Filter<TSchema>, options?: FindOptions<TSchema>): FindCursor<TSchema>;
-    find<T = TSchema>(filter: Filter<T>, options?: FindOptions<T>): FindCursor<T>;
+    find(filter: Filter<TSchema>, options?: FindOptions): FindCursor<TSchema>;
+    find<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the options of the collection.
      *
@@ -1564,10 +1606,10 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
-    indexes(): Promise<Document>;
-    indexes(callback: Callback<Document>): void;
-    indexes(options: IndexInformationOptions): Promise<Document>;
-    indexes(options: IndexInformationOptions, callback: Callback<Document>): void;
+    indexes(): Promise<Document[]>;
+    indexes(callback: Callback<Document[]>): void;
+    indexes(options: IndexInformationOptions): Promise<Document[]>;
+    indexes(options: IndexInformationOptions, callback: Callback<Document[]>): void;
     /**
      * Get all the collection statistics.
      *
@@ -1619,7 +1661,7 @@ 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 = TSchema>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
+    aggregate<T = 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.
      *
@@ -1793,7 +1835,7 @@ export declare class CommandFailedEvent {
 /* Excluded from this release type: CommandOperation */
 /** @public */
 export declare interface CommandOperationOptions extends OperationOptions, WriteConcernOptions, ExplainOptions {
-    /** Return the full server response for the command */
+    /** @deprecated This option does nothing */
     fullResponse?: boolean;
     /** Specify a read concern and level for the collection. (only MongoDB 3.2 or higher supported) */
     readConcern?: ReadConcernLike;
@@ -1808,23 +1850,7 @@ export declare interface CommandOperationOptions extends OperationOptions, Write
     authdb?: string;
     noResponse?: boolean;
 }
-/** @public */
-export declare interface CommandOptions extends BSONSerializeOptions {
-    command?: boolean;
-    slaveOk?: boolean;
-    /** Specify read preference if command supports it */
-    readPreference?: ReadPreferenceLike;
-    raw?: boolean;
-    monitoring?: boolean;
-    fullResult?: boolean;
-    socketTimeoutMS?: number;
-    /** Session to use for the operation */
-    session?: ClientSession;
-    documentsReturnedIn?: string;
-    noResponse?: boolean;
-    willRetryWrite?: boolean;
-    writeConcern?: WriteConcernOptions | WriteConcern | W;
-}
+/* Excluded from this release type: CommandOptions */
 /**
  * An event indicating the start of a given
  * @public
@@ -2130,9 +2156,11 @@ export declare const CURSOR_FLAGS: readonly [
     "exhaust",
     "partial"
 ];
-/** @public */
+/** @public
+ * @deprecated This interface is deprecated */
 export declare interface CursorCloseOptions {
     /** Bypass calling killCursors when closing the cursor. */
+    /** @deprecated  the skipKillCursors option is deprecated */
     skipKillCursors?: boolean;
 }
 /** @public */
@@ -2221,7 +2249,7 @@ export declare class Db {
      * @param pipeline - An array of aggregation stages to be executed
      * @param options - Optional settings for the command
      */
-    aggregate(pipeline?: Document[], options?: AggregateOptions): AggregationCursor;
+    aggregate<T = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
     /** Return the Admin db instance */
     admin(): Admin;
     /**
@@ -2230,7 +2258,7 @@ export declare class Db {
      * @param name - the collection name we wish to access.
      * @returns return the new Collection instance
      */
-    collection<TSchema extends Document = Document>(name: string): Collection<TSchema>;
+    collection<TSchema extends Document = Document>(name: string, options?: CollectionOptions): Collection<TSchema>;
     /**
      * Get all the db statistics.
      *
@@ -2371,7 +2399,10 @@ export declare class Db {
     indexInformation(name: string, callback: Callback<Document>): void;
     indexInformation(name: string, options: IndexInformationOptions): Promise<Document>;
     indexInformation(name: string, options: IndexInformationOptions, callback: Callback<Document>): void;
-    /** Unref all sockets */
+    /**
+     * Unref all sockets
+     * @deprecated This function is deprecated and will be removed in the next major version.
+     */
     unref(): void;
     /**
      * Create a new Change Stream, watching for new changes (insertions, updates,
@@ -2496,12 +2527,12 @@ export declare interface EndSessionOptions {
 /** TypeScript Omit (Exclude to be specific) does not work for objects with an "any" indexed type, and breaks discriminated unions @public */
 export declare type EnhancedOmit<TRecordOrUnion, KeyUnion> = string extends keyof TRecordOrUnion ? TRecordOrUnion : TRecordOrUnion extends any ? Pick<TRecordOrUnion, Exclude<keyof TRecordOrUnion, KeyUnion>> : never;
 /** @public */
-export declare interface ErrorDescription {
+export declare interface ErrorDescription extends Document {
     message?: string;
     errmsg?: string;
     $err?: string;
     errorLabels?: string[];
-    [key: string]: any;
+    errInfo?: Document;
 }
 /** @public */
 export declare interface EstimatedDocumentCountOptions extends CommandOperationOptions {
@@ -2682,18 +2713,40 @@ export declare class FindCursor<TSchema = Document> extends AbstractCursor<TSche
      * In order to strictly type this function you must provide an interface
      * that represents the effect of your projection on the result documents.
      *
-     * **NOTE:** adding a projection changes the return type of the iteration of this cursor,
+     * By default chaining a projection to your cursor changes the returned type to the generic
+     * {@link Document} type.
+     * You should specify a parameterized type to have assertions on your final results.
+     *
+     * @example
+     * ```typescript
+     * // Best way
+     * const docs: FindCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+     * // Flexible way
+     * const docs: FindCursor<Document> = cursor.project({ _id: 0, a: true });
+     * ```
+     *
+     * @remarks
+     *
+     * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
      * it **does not** return a new instance of a cursor. This means when calling project,
-     * you should always assign the result to a new variable. Take note of the following example:
+     * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+     * Take note of the following example:
      *
      * @example
      * ```typescript
      * const cursor: FindCursor<{ a: number; b: string }> = coll.find();
-     * const projectCursor = cursor.project<{ a: number }>({ a: true });
+     * const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
      * const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
+     *
+     * // or always use chaining and save the final cursor
+     *
+     * const cursor = coll.find().project<{ a: string }>({
+     *   _id: 0,
+     *   a: { $convert: { input: '$a', to: 'string' }
+     * }});
      * ```
      */
-    project<T = TSchema>(value: Projection<T>): FindCursor<T>;
+    project<T extends Document = Document>(value: Document): FindCursor<T>;
     /**
      * Sets the sort order of the cursor query.
      *
@@ -2800,14 +2853,17 @@ export declare class FindOperators {
     /** Specifies arrayFilters for UpdateOne or UpdateMany bulk operations. */
     arrayFilters(arrayFilters: Document[]): this;
 }
-/** @public */
-export declare interface FindOptions<TSchema = Document> extends CommandOperationOptions {
+/**
+ * @public
+ * @typeParam TSchema - Unused schema definition, deprecated usage, only specify `FindOptions` with no generic
+ */
+export declare interface FindOptions<TSchema extends Document = Document> extends CommandOperationOptions {
     /** Sets the limit of documents returned in the query. */
     limit?: number;
     /** Set to sort the documents coming back from the query. Array of indexes, `[['a', 1]]` etc. */
     sort?: Sort;
     /** The fields to return in the query. Object of fields to either include or exclude (one of, not both), `{'a':1, 'b': 1}` **or** `{'a': 0, 'b': 0}` */
-    projection?: Projection<TSchema>;
+    projection?: Document;
     /** Set to skip N documents ahead in your query (useful for pagination). */
     skip?: number;
     /** Tell the query to use specific indexes in the query. Object of indexes to use, `{'_id':1}` */
@@ -2937,7 +2993,7 @@ export declare interface GridFSBucketOptions extends WriteConcernOptions {
  * Do not instantiate this class directly. Use `openDownloadStream()` instead.
  * @public
  */
-export declare class GridFSBucketReadStream extends Readable {
+export declare class GridFSBucketReadStream extends Readable implements NodeJS.ReadableStream {
     /* Excluded from this release type: s */
     /**
      * An error occurred
@@ -3014,7 +3070,7 @@ export declare interface GridFSBucketReadStreamOptionsWithRevision extends GridF
  * Do not instantiate this class directly. Use `openUploadStream()` instead.
  * @public
  */
-export declare class GridFSBucketWriteStream extends Writable {
+export declare class GridFSBucketWriteStream extends Writable implements NodeJS.WritableStream {
     bucket: GridFSBucket;
     chunks: Collection<GridFSChunk>;
     filename: string;
@@ -3052,10 +3108,10 @@ export declare class GridFSBucketWriteStream extends Writable {
      * @param callback - Function to call when the chunk was added to the buffer, or if the entire chunk was persisted to MongoDB if this chunk caused a flush.
      * @returns False if this write required flushing a chunk to MongoDB. True otherwise.
      */
-    write(chunk: Buffer): boolean;
-    write(chunk: Buffer, callback: Callback<void>): boolean;
-    write(chunk: Buffer, encoding: BufferEncoding | undefined): boolean;
-    write(chunk: Buffer, encoding: BufferEncoding | undefined, callback: Callback<void>): boolean;
+    write(chunk: Buffer | string): boolean;
+    write(chunk: Buffer | string, callback: Callback<void>): boolean;
+    write(chunk: Buffer | string, encoding: BufferEncoding | undefined): boolean;
+    write(chunk: Buffer | string, encoding: BufferEncoding | undefined, callback: Callback<void>): boolean;
     /**
      * Places this write stream into an aborted state (all future writes fail)
      * and deletes all chunks that have already been written.
@@ -3226,6 +3282,7 @@ export declare type KeysOfOtherType<TSchema, Type> = {
     [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? never : key;
 }[keyof TSchema];
 /* Excluded from this release type: kFilter */
+/* Excluded from this release type: kFullResult */
 /* Excluded from this release type: kGeneration */
 /* Excluded from this release type: kGeneration_2 */
 /* Excluded from this release type: kId */
@@ -3258,6 +3315,7 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 /* Excluded from this release type: kRTTPinger */
 /* Excluded from this release type: kServer */
 /* Excluded from this release type: kServer_2 */
+/* Excluded from this release type: kServerError */
 /* Excluded from this release type: kServerSession */
 /* Excluded from this release type: kServiceGenerations */
 /* Excluded from this release type: kSession */
@@ -3297,7 +3355,7 @@ export declare const LEGAL_TLS_SOCKET_OPTIONS: readonly [
     "session"
 ];
 /** @public */
-export declare class ListCollectionsCursor<T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo = CollectionInfo> extends AbstractCursor<T> {
+export declare class ListCollectionsCursor<T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo = Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo> extends AbstractCursor<T> {
     parent: Db;
     filter: Document;
     options?: ListCollectionsOptions;
@@ -3321,7 +3379,16 @@ export declare interface ListDatabasesOptions extends CommandOperationOptions {
     authorizedDatabases?: boolean;
 }
 /** @public */
-export declare type ListDatabasesResult = string[] | Document[];
+export declare interface ListDatabasesResult {
+    databases: ({
+        name: string;
+        sizeOnDisk?: number;
+        empty?: boolean;
+    } & Document)[];
+    totalSize?: number;
+    totalSizeMb?: number;
+    ok: 1 | 0;
+}
 /** @public */
 export declare class ListIndexesCursor extends AbstractCursor {
     parent: Collection;
@@ -3469,7 +3536,7 @@ export { MaxKey };
 export { MinKey };
 /** @public */
 export declare interface ModifyResult<TSchema = Document> {
-    value?: TSchema;
+    value: TSchema | null;
     lastErrorObject?: Document;
     ok: 0 | 1;
 }
@@ -3497,7 +3564,18 @@ export declare const MONGO_CLIENT_EVENTS: readonly [
  * @category Error
  */
 export declare class MongoAPIError extends MongoDriverError {
-    protected constructor(message: string);
+    constructor(message: string);
+    readonly name: string;
+}
+/**
+ * An error generated when a batch command is reexecuted after one of the commands in the batch
+ * has failed
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoBatchReExecutionError extends MongoAPIError {
+    constructor(message?: string);
     readonly name: string;
 }
 /**
@@ -3507,8 +3585,14 @@ export declare class MongoAPIError extends MongoDriverError {
  */
 export declare class MongoBulkWriteError extends MongoServerError {
     result: BulkWriteResult;
+    writeErrors: OneOrMore<WriteError>;
+    err?: WriteConcernError;
     /** Creates a new MongoBulkWriteError */
-    constructor(error: AnyError, result: BulkWriteResult);
+    constructor(error: {
+        message: string;
+        code: number;
+        writeErrors?: WriteError[];
+    } | WriteConcernError | AnyError, result: BulkWriteResult);
     readonly name: string;
     /*Number of documents inserted. */
     readonly insertedCount: number;
@@ -3529,6 +3613,16 @@ export declare class MongoBulkWriteError extends MongoServerError {
         [key: number]: any;
     };
 }
+/**
+ * An error generated when a ChangeStream operation fails to execute.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoChangeStreamError extends MongoRuntimeError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * The **MongoClient** class is a class that allows for making Connections to MongoDB.
  * @public
@@ -3664,7 +3758,7 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     ssl?: boolean;
     /** Specifies the location of a local TLS Certificate */
     tlsCertificateFile?: string;
-    /** Specifies the location of a local .pem file that contains either the client’s TLS/SSL certificate or the client’s TLS/SSL certificate and key. */
+    /** Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate. */
     tlsCertificateKeyFile?: string;
     /** Specifies the password to de-crypt the tlsCertificateKeyFile. */
     tlsCertificateKeyFilePassword?: string;
@@ -3680,8 +3774,8 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     connectTimeoutMS?: number;
     /** The time in milliseconds to attempt a send or receive on a socket before the attempt times out. */
     socketTimeoutMS?: number;
-    /** Comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance. */
-    compressors?: CompressorName[];
+    /** An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance. */
+    compressors?: CompressorName[] | string;
     /** An integer that specifies the compression level if using zlib for network compression. */
     zlibCompressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined;
     /** The maximum number of connections in the connection pool. */
@@ -3709,12 +3803,7 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     /** Specify the authentication mechanism that MongoDB will use to authenticate the connection. */
     authMechanism?: AuthMechanism;
     /** Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs. */
-    authMechanismProperties?: {
-        SERVICE_NAME?: string;
-        CANONICALIZE_HOST_NAME?: boolean;
-        SERVICE_REALM?: string;
-        [key: string]: any;
-    };
+    authMechanismProperties?: AuthMechanismProperties;
     /** The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances. */
     localThresholdMS?: number;
     /** Specifies how long (in milliseconds) to block for server selection before throwing an exception.  */
@@ -3819,7 +3908,7 @@ export declare class MongoCredentials {
     /** The method used to authenticate */
     readonly mechanism: AuthMechanism;
     /** Special properties used by some types of auth mechanisms */
-    readonly mechanismProperties: Document;
+    readonly mechanismProperties: AuthMechanismProperties;
     constructor(options: MongoCredentialsOptions);
     /** Determines if two MongoCredentials objects are equivalent */
     equals(other: MongoCredentials): boolean;
@@ -3840,7 +3929,28 @@ export declare interface MongoCredentialsOptions {
     source: string;
     db?: string;
     mechanism?: AuthMechanism;
-    mechanismProperties: Document;
+    mechanismProperties: AuthMechanismProperties;
+}
+/**
+ * An error thrown when an attempt is made to read from a cursor that has been exhausted
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoCursorExhaustedError extends MongoAPIError {
+    constructor(message?: string);
+    readonly name: string;
+}
+/**
+ * An error thrown when the user attempts to add options to a cursor that has already been
+ * initialized
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoCursorInUseError extends MongoAPIError {
+    constructor(message?: string);
+    readonly name: string;
 }
 /** @public */
 export declare class MongoDBNamespace {
@@ -3857,6 +3967,17 @@ export declare class MongoDBNamespace {
     withCollection(collection: string): MongoDBNamespace;
     static fromString(namespace?: string): MongoDBNamespace;
 }
+/**
+ * An error generated when the driver fails to decompress
+ * data received from the server.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoDecompressionError extends MongoRuntimeError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * An error generated by the driver
  *
@@ -3864,7 +3985,6 @@ export declare class MongoDBNamespace {
  * @category Error
  */
 export declare class MongoDriverError extends MongoError {
-    code?: string;
     constructor(message: string);
     readonly name: string;
 }
@@ -3877,6 +3997,11 @@ export declare class MongoDriverError extends MongoError {
  */
 export declare class MongoError extends Error {
     /* Excluded from this release type: [kErrorLabels] */
+    /**
+     * This is a number in MongoServerError and a string in MongoDriverError
+     * @privateRemarks
+     * Define the type override on the subclasses when we can use the override keyword
+     */
     code?: number | string;
     topologyVersion?: TopologyVersion;
     constructor(message: string | Error);
@@ -3893,6 +4018,37 @@ export declare class MongoError extends Error {
     addErrorLabel(label: string): void;
     readonly errorLabels: string[];
 }
+/**
+ * An error generated when the user attempts to operate
+ * on a session that has expired or has been closed.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoExpiredSessionError extends MongoAPIError {
+    constructor(message?: string);
+    readonly name: string;
+}
+/**
+ * An error generated when a malformed or invalid chunk is
+ * encountered when reading from a GridFSStream.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoGridFSChunkError extends MongoRuntimeError {
+    constructor(message: string);
+    readonly name: string;
+}
+/** An error generated when a GridFSStream operation fails to execute.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoGridFSStreamError extends MongoRuntimeError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * An error generated when the user supplies malformed or unexpected arguments
  * or when a required argument or field is not provided.
@@ -3905,6 +4061,17 @@ export declare class MongoInvalidArgumentError extends MongoAPIError {
     constructor(message: string);
     readonly name: string;
 }
+/**
+ * A error generated when the user attempts to authenticate
+ * via Kerberos, but fails to connect to the Kerberos client.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoKerberosError extends MongoRuntimeError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * An error generated when the user fails to provide authentication credentials before attempting
  * to connect to a mongo server instance.
@@ -3954,11 +4121,22 @@ export declare class MongoNetworkTimeoutError extends MongoNetworkError {
     constructor(message: string, options?: MongoNetworkErrorOptions);
     readonly name: string;
 }
+/**
+ * An error thrown when the user attempts to operate on a database or collection through a MongoClient
+ * that has not yet successfully called the "connect" method
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoNotConnectedError extends MongoAPIError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * Mongo Client Options
  * @public
  */
-export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'compressors' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'logger' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | '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' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
     hosts: HostAddress[];
     srvHost?: string;
     credentials?: MongoCredentials;
@@ -3966,6 +4144,7 @@ export declare interface MongoOptions extends Required<Pick<MongoClientOptions,
     readConcern: ReadConcern;
     loadBalanced: boolean;
     serverApi: ServerApi;
+    compressors: CompressorName[];
     writeConcern: WriteConcern;
     dbName: string;
     metadata: ClientMetadata;
@@ -4006,6 +4185,31 @@ export declare class MongoParseError extends MongoDriverError {
     constructor(message: string);
     readonly name: string;
 }
+/**
+ * An error generated when the driver encounters unexpected input
+ * or reaches an unexpected/invalid internal state
+ *
+ * @privateRemarks
+ * Should **never** be directly instantiated.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoRuntimeError extends MongoDriverError {
+    constructor(message: string);
+    readonly name: string;
+}
+/**
+ * An error generated when an attempt is made to operate
+ * on a closed/closing server.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoServerClosedError extends MongoAPIError {
+    constructor(message?: string);
+    readonly name: string;
+}
 /**
  * An error coming from the mongo server
  *
@@ -4013,10 +4217,12 @@ export declare class MongoParseError extends MongoDriverError {
  * @category Error
  */
 export declare class MongoServerError extends MongoError {
-    code?: number;
     codeName?: string;
     writeConcernError?: Document;
-    constructor(message: Error | ErrorDescription);
+    errInfo?: Document;
+    ok?: number;
+    [key: string]: any;
+    constructor(message: ErrorDescription);
     readonly name: string;
 }
 /**
@@ -4039,6 +4245,28 @@ export declare class MongoSystemError extends MongoError {
     constructor(message: string, reason: TopologyDescription);
     readonly name: string;
 }
+/**
+ * An error generated when an attempt is made to operate on a
+ * dropped, or otherwise unavailable, database.
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoTopologyClosedError extends MongoAPIError {
+    constructor(message?: string);
+    readonly name: string;
+}
+/**
+ * An error generated when the user makes a mistake in the usage of transactions.
+ * (e.g. attempting to commit a transaction with a readPreference other than primary)
+ *
+ * @public
+ * @category Error
+ */
+export declare class MongoTransactionError extends MongoAPIError {
+    constructor(message: string);
+    readonly name: string;
+}
 /**
  * An error thrown when the server reports a writeConcernError
  * @public
@@ -4047,7 +4275,8 @@ export declare class MongoSystemError extends MongoError {
 export declare class MongoWriteConcernError extends MongoServerError {
     /** The result document (provided if ok: 1) */
     result?: Document;
-    constructor(message: ErrorDescription, result: Document);
+    errInfo?: Document;
+    constructor(message: ErrorDescription, result?: Document);
     readonly name: string;
 }
 /* Excluded from this release type: Monitor */
@@ -4074,6 +4303,11 @@ export declare type NotAcceptedFields<TSchema, FieldType> = {
 };
 /** @public */
 export declare type NumericType = IntegerType | Decimal128 | Double;
+/**
+ * @public
+ * @deprecated Please use `ObjectId`
+ */
+export declare const ObjectID: typeof ObjectId;
 export { ObjectId };
 /** @public */
 export declare type OneOrMore<T> = T | ReadonlyArray<T>;
@@ -4107,11 +4341,13 @@ export declare type OperationTime = Timestamp;
  * `TSchema['_id'] extends ObjectId` which translated to "Is the _id property ObjectId?"
  * we instead ask "Does ObjectId look like (have the same shape) as the _id?"
  */
-export declare type OptionalId<TSchema extends {
+export declare type OptionalId<TSchema> = TSchema extends {
     _id?: any;
-}> = ObjectId extends TSchema['_id'] ? EnhancedOmit<TSchema, '_id'> & {
+} ? ObjectId extends TSchema['_id'] ? EnhancedOmit<TSchema, '_id'> & {
+    _id?: InferIdType<TSchema>;
+} : WithId<TSchema> : EnhancedOmit<TSchema, '_id'> & {
     _id?: InferIdType<TSchema>;
-} : WithId<TSchema>;
+};
 /** @public */
 export declare class OrderedBulkOperation extends BulkOperationBase {
     constructor(collection: Collection, options: BulkWriteOptions);
@@ -4135,21 +4371,17 @@ export declare const ProfilingLevel: Readonly<{
 export declare type ProfilingLevel = typeof ProfilingLevel[keyof typeof ProfilingLevel];
 /** @public */
 export declare type ProfilingLevelOptions = CommandOperationOptions;
-/** @public */
-export declare type Projection<TSchema> = {
-    [Key in keyof TSchema]?: ProjectionOperators | 0 | 1 | boolean;
-} & Partial<Record<string, ProjectionOperators | 0 | 1 | boolean>>;
-/** @public */
-export declare interface ProjectionOperators extends Document {
-    $elemMatch?: Document;
-    $slice?: number | [
-        number,
-        number
-    ];
-    $meta?: string;
-    /** @deprecated Since MongoDB 3.2, Use FindCursor#max */
-    $max?: any;
-}
+/**
+ * @public
+ * Projection is flexible to permit the wide array of aggregation operators
+ * @deprecated since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further
+ */
+export declare type Projection<TSchema extends Document = Document> = Document;
+/**
+ * @public
+ * @deprecated since v4.1.0: Since projections support all aggregation operations we have no plans to narrow this type further
+ */
+export declare type ProjectionOperators = Document;
 /**
  * Global promise store allowing user-provided promises
  * @public
@@ -5214,19 +5446,26 @@ export declare class WriteConcern {
  * @category Error
  */
 export declare class WriteConcernError {
-    err: MongoServerError;
-    constructor(err: MongoServerError);
+    /* Excluded from this release type: [kServerError] */
+    constructor(error: WriteConcernErrorData);
     /*Write concern error code. */
     readonly code: number | undefined;
     /*Write concern error message. */
-    readonly errmsg: string;
-    toJSON(): {
-        code?: number;
-        errmsg: string;
-    };
+    readonly errmsg: string | undefined;
+    /*Write concern error info. */
+    readonly errInfo: Document | undefined;
+    /*@deprecated The `err` prop that contained a MongoServerError has been deprecated. */
+    readonly err: WriteConcernErrorData;
+    toJSON(): WriteConcernErrorData;
     toString(): string;
 }
 /** @public */
+export declare interface WriteConcernErrorData {
+    code: number;
+    errmsg: string;
+    errInfo?: Document;
+}
+/** @public */
 export declare interface WriteConcernOptions {
     /** Write Concern as an object */
     writeConcern?: WriteConcern | WriteConcernSettings;
@@ -5260,6 +5499,8 @@ export declare class WriteError {
     readonly index: number;
     /*WriteError message. */
     readonly errmsg: string | undefined;
+    /*WriteError details. */
+    readonly errInfo: Document | undefined;
     /** Returns the underlying operation that caused the error */
     getOperation(): Document;
     toJSON(): {