mongodb 4.1.4 → 4.3.0

package/mongodb.ts34.d.ts

@@ -21,10 +21,12 @@ import { Map as Map_2 } from 'bson';
 import { MaxKey } from 'bson';
 import { MinKey } from 'bson';
 import { ObjectId } from 'bson';
+import { ObjectIdLike } from 'bson';
 import { Readable } from 'stream';
 import { serialize as serialize_2 } from 'bson';
 import { SerializeOptions } from 'bson';
 import { Socket } from 'net';
+import { SrvRecord } from 'dns';
 import { TcpNetConnectOpts } from 'net';
 import { Timestamp } from 'bson';
 import { TLSSocket } from 'tls';
@@ -616,6 +618,7 @@ export declare interface AutoEncryptionOptions {
         /** Command line arguments to use when auto-spawning a mongocryptd */
         mongocryptdSpawnArgs?: string[];
     };
+    proxyOptions?: ProxyOptions;
 }
 /**
  * Keeps the state of a unordered batch so we can rewrite the results
@@ -649,9 +652,11 @@ export { BSONRegExp };
  * BSON Serialization options.
  * @public
  */
-export declare interface BSONSerializeOptions extends Pick<SerializeOptions, Exclude<keyof SerializeOptions, 'index'>>, Pick<DeserializeOptions, Exclude<keyof DeserializeOptions, 'evalFunctions' | 'cacheFunctions' | 'cacheFunctionsCrc32' | 'allowObjectSmallerThanBufferSize' | 'index'>> {
+export declare interface BSONSerializeOptions extends Pick<SerializeOptions, Exclude<keyof SerializeOptions, 'index'>>, Pick<DeserializeOptions, Exclude<keyof DeserializeOptions, 'evalFunctions' | 'cacheFunctions' | 'cacheFunctionsCrc32' | 'allowObjectSmallerThanBufferSize' | 'index' | 'validation'>> {
     /** Return BSON filled buffers from operations */
     raw?: boolean;
+    /** Enable utf8 validation when deserializing BSON documents.  Defaults to true. */
+    enableUtf8Validation?: boolean;
 }
 export { BSONSymbol };
 /** @public */
@@ -746,8 +751,10 @@ export declare abstract class BulkOperationBase {
     readonly bsonOptions: BSONSerializeOptions;
     readonly writeConcern: WriteConcern | undefined;
     readonly batches: Batch[];
-    /** An internal helper method. Do not invoke directly. Will be going away in the future */
-    execute(options?: BulkWriteOptions, callback?: Callback<BulkWriteResult>): Promise<BulkWriteResult> | void;
+    execute(options?: BulkWriteOptions): Promise<BulkWriteResult>;
+    execute(callback: Callback<BulkWriteResult>): void;
+    execute(options: BulkWriteOptions | undefined, callback: Callback<BulkWriteResult>): void;
+    execute(options?: BulkWriteOptions | Callback<BulkWriteResult>, callback?: Callback<BulkWriteResult>): Promise<BulkWriteResult> | void;
     /* Excluded from this release type: handleWriteError */
     abstract addToOperationsList(batchType: BatchType, document: Document | UpdateStatement | DeleteStatement): this;
 }
@@ -860,7 +867,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> {
+export declare class ChangeStream<TSchema extends Document = Document> extends TypedEventEmitter<ChangeStreamEvents<TSchema>> {
     pipeline: Document[];
     options: ChangeStreamOptions;
     parent: MongoClient | Db | Collection;
@@ -901,7 +908,8 @@ export declare class ChangeStream<TSchema extends Document = Document> extends T
     The cached resume token that is used to resume after the most recently returned change. */
     readonly resumeToken: ResumeToken;
     /** Check if there is any document still available in the Change Stream */
-    hasNext(callback?: Callback): Promise<void> | void;
+    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;
@@ -974,14 +982,14 @@ export declare interface ChangeStreamDocument<TSchema extends Document = Documen
     fullDocument?: TSchema;
 }
 /** @public */
-export declare type ChangeStreamEvents = {
+export declare type ChangeStreamEvents<TSchema extends Document = Document> = {
     resumeTokenChanged(token: ResumeToken): void;
-    init(response: Document): void;
-    more(response?: Document | undefined): void;
+    init(response: TSchema): void;
+    more(response?: TSchema | undefined): void;
     response(): void;
     end(): void;
     error(error: Error): void;
-    change(change: ChangeStreamDocument): void;
+    change(change: ChangeStreamDocument<TSchema>): void;
 } & AbstractCursorEvents;
 /**
  * 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.
@@ -1240,10 +1248,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
      */
-    insertOne(doc: OptionalId<TSchema>): Promise<InsertOneResult<TSchema>>;
-    insertOne(doc: OptionalId<TSchema>, callback: Callback<InsertOneResult<TSchema>>): void;
-    insertOne(doc: OptionalId<TSchema>, options: InsertOneOptions): Promise<InsertOneResult<TSchema>>;
-    insertOne(doc: OptionalId<TSchema>, options: InsertOneOptions, callback: Callback<InsertOneResult<TSchema>>): void;
+    insertOne(doc: OptionalUnlessRequiredId<TSchema>): Promise<InsertOneResult<TSchema>>;
+    insertOne(doc: OptionalUnlessRequiredId<TSchema>, callback: Callback<InsertOneResult<TSchema>>): void;
+    insertOne(doc: OptionalUnlessRequiredId<TSchema>, options: InsertOneOptions): Promise<InsertOneResult<TSchema>>;
+    insertOne(doc: OptionalUnlessRequiredId<TSchema>, options: InsertOneOptions, callback: Callback<InsertOneResult<TSchema>>): void;
     /**
      * Inserts an array of documents into MongoDB. If documents passed in do not contain the **_id** field,
      * one will be added to each of the documents missing it by the driver, mutating the document. This behavior
@@ -1253,10 +1261,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
      */
-    insertMany(docs: OptionalId<TSchema>[]): Promise<InsertManyResult<TSchema>>;
-    insertMany(docs: OptionalId<TSchema>[], callback: Callback<InsertManyResult<TSchema>>): void;
-    insertMany(docs: OptionalId<TSchema>[], options: BulkWriteOptions): Promise<InsertManyResult<TSchema>>;
-    insertMany(docs: OptionalId<TSchema>[], options: BulkWriteOptions, callback: Callback<InsertManyResult<TSchema>>): void;
+    insertMany(docs: OptionalUnlessRequiredId<TSchema>[]): Promise<InsertManyResult<TSchema>>;
+    insertMany(docs: OptionalUnlessRequiredId<TSchema>[], callback: Callback<InsertManyResult<TSchema>>): void;
+    insertMany(docs: OptionalUnlessRequiredId<TSchema>[], options: BulkWriteOptions): Promise<InsertManyResult<TSchema>>;
+    insertMany(docs: OptionalUnlessRequiredId<TSchema>[], options: BulkWriteOptions, callback: Callback<InsertManyResult<TSchema>>): void;
     /**
      * Perform a bulkWrite operation without a fluent API
      *
@@ -1312,10 +1320,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
      */
-    replaceOne(filter: Filter<TSchema>, replacement: TSchema): Promise<UpdateResult | Document>;
-    replaceOne(filter: Filter<TSchema>, replacement: TSchema, callback: Callback<UpdateResult | Document>): void;
-    replaceOne(filter: Filter<TSchema>, replacement: TSchema, options: ReplaceOptions): Promise<UpdateResult | Document>;
-    replaceOne(filter: Filter<TSchema>, replacement: TSchema, options: ReplaceOptions, callback: Callback<UpdateResult | Document>): void;
+    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>): Promise<UpdateResult | Document>;
+    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, callback: Callback<UpdateResult | Document>): void;
+    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options: ReplaceOptions): Promise<UpdateResult | Document>;
+    replaceOne(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options: ReplaceOptions, callback: Callback<UpdateResult | Document>): void;
     /**
      * Update multiple documents in a collection
      *
@@ -1381,12 +1389,12 @@ 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 | 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(): Promise<WithId<TSchema> | null>;
+    findOne(callback: Callback<WithId<TSchema> | null>): void;
+    findOne(filter: Filter<TSchema>): Promise<WithId<TSchema> | null>;
+    findOne(filter: Filter<TSchema>, callback: Callback<WithId<TSchema> | null>): void;
+    findOne(filter: Filter<TSchema>, options: FindOptions): Promise<WithId<TSchema> | null>;
+    findOne(filter: Filter<TSchema>, options: FindOptions, callback: Callback<WithId<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>;
@@ -1397,8 +1405,8 @@ export declare class Collection<TSchema extends Document = Document> {
      *
      * @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): FindCursor<TSchema>;
+    find(): FindCursor<WithId<TSchema>>;
+    find(filter: Filter<TSchema>, options?: FindOptions): FindCursor<WithId<TSchema>>;
     find<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the options of the collection.
@@ -1639,10 +1647,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
      */
-    findOneAndReplace(filter: Filter<TSchema>, replacement: Document): Promise<ModifyResult<TSchema>>;
-    findOneAndReplace(filter: Filter<TSchema>, replacement: Document, callback: Callback<ModifyResult<TSchema>>): void;
-    findOneAndReplace(filter: Filter<TSchema>, replacement: Document, options: FindOneAndReplaceOptions): Promise<ModifyResult<TSchema>>;
-    findOneAndReplace(filter: Filter<TSchema>, replacement: Document, options: FindOneAndReplaceOptions, callback: Callback<ModifyResult<TSchema>>): void;
+    findOneAndReplace(filter: Filter<TSchema>, replacement: WithoutId<TSchema>): Promise<ModifyResult<TSchema>>;
+    findOneAndReplace(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, callback: Callback<ModifyResult<TSchema>>): void;
+    findOneAndReplace(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options: FindOneAndReplaceOptions): Promise<ModifyResult<TSchema>>;
+    findOneAndReplace(filter: Filter<TSchema>, replacement: WithoutId<TSchema>, options: FindOneAndReplaceOptions, callback: Callback<ModifyResult<TSchema>>): void;
     /**
      * Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation.
      *
@@ -1673,6 +1681,7 @@ export declare class Collection<TSchema extends Document = Document> {
     /**
      * Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.
      *
+     * @deprecated collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.
      * @param map - The mapping function.
      * @param reduce - The reduce function.
      * @param options - Optional settings for the command
@@ -1699,7 +1708,7 @@ 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
      */
-    insert(docs: OptionalId<TSchema>[], options: BulkWriteOptions, callback: Callback<InsertManyResult<TSchema>>): Promise<InsertManyResult<TSchema>> | void;
+    insert(docs: OptionalUnlessRequiredId<TSchema>[], options: BulkWriteOptions, callback: Callback<InsertManyResult<TSchema>>): Promise<InsertManyResult<TSchema>> | void;
     /**
      * Updates documents.
      *
@@ -1752,6 +1761,9 @@ export declare interface CollectionInfo extends Document {
 }
 /** @public */
 export declare interface CollectionOptions extends BSONSerializeOptions, WriteConcernOptions, LoggerOptions {
+    /**
+     * @deprecated Use readPreference instead
+     */
     slaveOk?: boolean;
     /** Specify a read concern for the collection. (only MongoDB 3.2 or higher supported) */
     readConcern?: ReadConcernLike;
@@ -1966,7 +1978,7 @@ export declare type ConnectionEvents = {
     unpinned(pinType: string): void;
 };
 /** @public */
-export declare interface ConnectionOptions extends SupportedNodeConnectionOptions, StreamDescriptionOptions {
+export declare interface ConnectionOptions extends SupportedNodeConnectionOptions, StreamDescriptionOptions, ProxyOptions {
     id: number | '<monitor>';
     generation: number;
     hostAddress: HostAddress;
@@ -2207,7 +2219,15 @@ export declare class Db {
     constructor(client: MongoClient, databaseName: string, options?: DbOptions);
     readonly databaseName: string;
     readonly options: DbOptions | undefined;
+    /*
+    * slaveOk specified
+    * @deprecated Use secondaryOk instead
+    */
     readonly slaveOk: boolean;
+    /*
+    * Check if a secondary can be used (because the read preference is *not* set to primary)
+    */
+    readonly secondaryOk: boolean;
     readonly readConcern: ReadConcern | undefined;
     /*
     * The current readPreference of the Db. If not explicitly defined for
@@ -2225,10 +2245,9 @@ export declare class Db {
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
-    createCollection<TSchema extends Document = Document>(name: string): Promise<Collection<TSchema>>;
+    createCollection<TSchema extends Document = Document>(name: string, options?: CreateCollectionOptions): Promise<Collection<TSchema>>;
     createCollection<TSchema extends Document = Document>(name: string, callback: Callback<Collection<TSchema>>): void;
-    createCollection<TSchema extends Document = Document>(name: string, options: CreateCollectionOptions): Promise<Collection<TSchema>>;
-    createCollection<TSchema extends Document = Document>(name: string, options: CreateCollectionOptions, callback: Callback<Collection<TSchema>>): void;
+    createCollection<TSchema extends Document = Document>(name: string, options: CreateCollectionOptions | undefined, callback: Callback<Collection<TSchema>>): void;
     /**
      * Execute a command
      *
@@ -2579,14 +2598,14 @@ export declare type ExplainVerbosity = string;
 export declare type ExplainVerbosityLike = ExplainVerbosity | boolean;
 /** A MongoDB filter can be some portion of the schema or a set of operators @public */
 export declare type Filter<TSchema> = {
-    [P in keyof TSchema]?: Condition<TSchema[P]>;
-} & RootFilterOperators<TSchema>;
+    [Property in Join<NestedPaths<WithId<TSchema>>, '.'>]?: Condition<PropertyType<WithId<TSchema>, Property>>;
+} & RootFilterOperators<WithId<TSchema>>;
 /** @public */
 export declare type FilterOperations<T> = T extends Record<string, any> ? {
     [key in keyof T]?: FilterOperators<T[key]>;
 } : FilterOperators<T>;
 /** @public */
-export declare interface FilterOperators<TValue> extends Document {
+export declare interface FilterOperators<TValue> extends NonObjectIdLikeDocument {
     $eq?: TValue;
     $gt?: TValue;
     $gte?: TValue;
@@ -2872,7 +2891,7 @@ export declare interface FindOptions<TSchema extends Document = Document> extend
     timeout?: boolean;
     /** Specify if the cursor is tailable. */
     tailable?: boolean;
-    /** Specify if the cursor is a a tailable-await cursor. Requires `tailable` to be true */
+    /** Specify if the cursor is a tailable-await cursor. Requires `tailable` to be true */
     awaitData?: boolean;
     /** Set the batchSize for the getMoreCommand when iterating over the query results. */
     batchSize?: number;
@@ -3129,12 +3148,12 @@ export declare class GridFSBucketWriteStream extends Writable implements NodeJS.
      * @param encoding - Optional encoding for the buffer
      * @param callback - Function to call when all files and chunks have been persisted to MongoDB
      */
-    end(): void;
-    end(chunk: Buffer): void;
-    end(callback: Callback<GridFSFile | void>): void;
-    end(chunk: Buffer, callback: Callback<GridFSFile | void>): void;
-    end(chunk: Buffer, encoding: BufferEncoding): void;
-    end(chunk: Buffer, encoding: BufferEncoding | undefined, callback: Callback<GridFSFile | void>): void;
+    end(): this;
+    end(chunk: Buffer): this;
+    end(callback: Callback<GridFSFile | void>): this;
+    end(chunk: Buffer, callback: Callback<GridFSFile | void>): this;
+    end(chunk: Buffer, encoding: BufferEncoding): this;
+    end(chunk: Buffer, encoding: BufferEncoding | undefined, callback: Callback<GridFSFile | void>): this;
 }
 /** @public */
 export declare interface GridFSBucketWriteStreamOptions extends WriteConcernOptions {
@@ -3181,11 +3200,14 @@ export declare class HostAddress {
     socketPath: string | undefined;
     isIPv6: boolean | undefined;
     constructor(hostString: string);
+    inspect(): string;
     /**
      * @param ipv6Brackets - optionally request ipv6 bracket notation required for connection strings
      */
     toString(ipv6Brackets?: boolean): string;
     static fromString(s: string): HostAddress;
+    static fromHostPort(host: string, port: number): HostAddress;
+    static fromSrvRecord({ name, port }: SrvRecord): HostAddress;
 }
 /** @public */
 export declare interface IndexDescription extends Pick<CreateIndexesOptions, 'background' | 'unique' | 'partialFilterExpression' | 'sparse' | 'hidden' | 'expireAfterSeconds' | 'storageEngine' | 'version' | 'weights' | 'default_language' | 'language_override' | 'textIndexVersion' | '2dsphereIndexVersion' | 'bits' | 'min' | 'max' | 'bucketSize' | 'wildcardProjection'> {
@@ -3216,7 +3238,9 @@ export declare type IndexSpecification = OneOrMore<string | [
 /** Given an object shaped type, return the type of the _id field or default to ObjectId @public */
 export declare type InferIdType<TSchema> = TSchema extends {
     _id: infer IdType;
-} ? {} extends IdType ? Exclude<IdType, {}> : unknown extends IdType ? ObjectId : IdType : ObjectId;
+} ? Record<any, never> extends IdType ? never : IdType : TSchema extends {
+    _id?: infer IdType;
+} ? unknown extends IdType ? ObjectId : IdType : ObjectId;
 /** @public */
 export declare interface InsertManyResult<TSchema = Document> {
     /** Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined */
@@ -3254,6 +3278,17 @@ export declare type IntegerType = number | Int32 | Long;
 /* Excluded from this release type: InterruptibleAsyncInterval */
 /** @public */
 export declare type IsAny<Type, ResultIfAny, ResultIfNotAny> = true extends false & Type ? ResultIfAny : ResultIfNotAny;
+/**
+ * Helper types for dot-notation filter attributes
+ */
+/** @public */
+export declare type Join<T extends unknown[], D extends string> = T extends [
+] ? '' : T extends [
+    string | number
+] ? `${T[0]}` : T extends [
+    string | number,
+    ...infer R
+] ? `${T[0]}${D}${Join<R, D>}` : string;
 /* Excluded from this release type: kBeforeHandshake */
 /* Excluded from this release type: kBuffer */
 /* Excluded from this release type: kBuffers */
@@ -3366,6 +3401,8 @@ export declare class ListCollectionsCursor<T extends Pick<CollectionInfo, 'name'
 export declare interface ListCollectionsOptions extends CommandOperationOptions {
     /** Since 4.0: If true, will only return the collection name in the response, and will omit additional info */
     nameOnly?: boolean;
+    /** Since 4.0: If true and nameOnly is true, allows a user without the required privilege (i.e. listCollections action on the database) to run the command when access control is enforced. */
+    authorizedCollections?: boolean;
     /** The batchSize for the returned command cursor or if pre 2.8 the systems batch collection */
     batchSize?: number;
 }
@@ -3552,7 +3589,21 @@ export declare const MONGO_CLIENT_EVENTS: readonly [
     "connectionCheckedOut",
     "connectionCheckedIn",
     "connectionPoolCleared",
-    ...("error" | "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "timeout" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged")[]
+    "commandStarted",
+    "commandSucceeded",
+    "commandFailed",
+    "serverOpening",
+    "serverClosed",
+    "serverDescriptionChanged",
+    "topologyOpening",
+    "topologyClosed",
+    "topologyDescriptionChanged",
+    "error",
+    "timeout",
+    "close",
+    "serverHeartbeatStarted",
+    "serverHeartbeatSucceeded",
+    "serverHeartbeatFailed"
 ];
 /**
  * An error generated when the driver API is used incorrectly
@@ -3683,8 +3734,8 @@ export declare class MongoClient extends TypedEventEmitter<MongoClientEvents> {
      *
      * @see docs.mongodb.org/manual/reference/connection-string/
      */
-    connect(): Promise<MongoClient>;
-    connect(callback: Callback<MongoClient>): void;
+    connect(): Promise<this>;
+    connect(callback: Callback<this>): void;
     /**
      * Close the db and its underlying connections
      *
@@ -3778,6 +3829,16 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     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 hosts to connect to when using an srv connection string, a setting of `0` means unlimited hosts */
+    srvMaxHosts?: number;
+    /**
+     * Modifies the srv URI to look like:
+     *
+     * `_{srvServiceName}._tcp.{hostname}.{domainname}`
+     *
+     * Querying this DNS URI is expected to respond with SRV records
+     */
+    srvServiceName?: string;
     /** The maximum number of connections in the connection pool. */
     maxPoolSize?: number;
     /** The minimum number of connections in the connection pool. */
@@ -3880,6 +3941,14 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     autoEncryption?: AutoEncryptionOptions;
     /** Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver */
     driverInfo?: DriverInfo;
+    /** Configures a Socks5 proxy host used for creating TCP connections. */
+    proxyHost?: string;
+    /** Configures a Socks5 proxy port used for creating TCP connections. */
+    proxyPort?: number;
+    /** Configures a Socks5 proxy username when the proxy in proxyHost requires username/password authentication. */
+    proxyUsername?: string;
+    /** Configures a Socks5 proxy password when the proxy in proxyHost requires username/password authentication. */
+    proxyPassword?: string;
 }
 /* Excluded from this release type: MongoClientPrivate */
 /**
@@ -4136,7 +4205,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' | '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' | 'srvMaxHosts' | 'srvServiceName' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
     hosts: HostAddress[];
     srvHost?: string;
     credentials?: MongoCredentials;
@@ -4149,6 +4218,10 @@ export declare interface MongoOptions extends Required<Pick<MongoClientOptions,
     dbName: string;
     metadata: ClientMetadata;
     autoEncrypter?: AutoEncrypter;
+    proxyHost?: string;
+    proxyPort?: number;
+    proxyUsername?: string;
+    proxyPassword?: string;
     /* Excluded from this release type: connectionType */
     /* Excluded from this release type: encrypter */
     /* Excluded from this release type: userSpecifiedAuthSource */
@@ -4297,6 +4370,29 @@ export declare interface MonitorOptions extends Pick<ConnectionOptions, Exclude<
 }
 /* Excluded from this release type: MonitorPrivate */
 /* Excluded from this release type: Msg */
+/** @public */
+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 ? {
+    [Key in Extract<keyof Type, string>]: [
+        Key,
+        ...NestedPaths<Type[Key]>
+    ];
+}[Extract<keyof Type, string>] : [
+];
+/**
+ * @public
+ * A type that extends Document but forbids anything that "looks like" an object id.
+ */
+export declare type NonObjectIdLikeDocument = {
+    [key in keyof ObjectIdLike]?: never;
+} & Document;
 /** It avoids using fields with not acceptable types @public */
 export declare type NotAcceptedFields<TSchema, FieldType> = {
     readonly [key in KeysOfOtherType<TSchema, FieldType>]?: never;
@@ -4321,6 +4417,8 @@ export declare interface OperationOptions extends BSONSerializeOptions {
     willRetryWrites?: 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 */
+    omitReadPreference?: boolean;
 }
 /* Excluded from this release type: OperationParent */
 /**
@@ -4335,19 +4433,24 @@ export declare type OperationTime = Timestamp;
 /**
  * Add an optional _id field to an object shaped type
  * @public
+ */
+export declare type OptionalId<TSchema> = EnhancedOmit<TSchema, '_id'> & {
+    _id?: InferIdType<TSchema>;
+};
+/**
+ * Adds an optional _id field to an object shaped type, unless the _id field is requried on that type.
+ * In the case _id is required, this method continues to require_id.
+ *
+ * @public
  *
  * @privateRemarks
  * `ObjectId extends TSchema['_id']` is a confusing ordering at first glance. Rather than ask
  * `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> = TSchema extends {
-    _id?: any;
-} ? ObjectId extends TSchema['_id'] ? EnhancedOmit<TSchema, '_id'> & {
-    _id?: InferIdType<TSchema>;
-} : WithId<TSchema> : EnhancedOmit<TSchema, '_id'> & {
-    _id?: InferIdType<TSchema>;
-};
+export declare type OptionalUnlessRequiredId<TSchema> = TSchema extends {
+    _id: any;
+} ? TSchema : OptionalId<TSchema>;
 /** @public */
 export declare class OrderedBulkOperation extends BulkOperationBase {
     constructor(collection: Collection, options: BulkWriteOptions);
@@ -4396,6 +4499,15 @@ declare class Promise_2 {
 }
 export { Promise_2 as Promise };
 /** @public */
+export declare type PropertyType<Type, Property extends string> = string extends Property ? unknown : Property extends keyof Type ? Type[Property] : Property extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? ArrayType : unknown : Property extends `${infer Key}.${infer Rest}` ? Key extends `${number}` ? Type extends ReadonlyArray<infer ArrayType> ? PropertyType<ArrayType, Rest> : unknown : Key extends keyof Type ? Type[Key] extends Map<string, infer MapType> ? MapType : PropertyType<Type[Key], Rest> : unknown : unknown;
+/** @public */
+export declare interface ProxyOptions {
+    proxyHost?: string;
+    proxyPort?: number;
+    proxyUsername?: string;
+    proxyPassword?: string;
+}
+/** @public */
 export declare type PullAllOperator<TSchema> = ({
     readonly [key in KeysOfAType<TSchema, ReadonlyArray<any>>]?: TSchema[key];
 } & NotAcceptedFields<TSchema, ReadonlyArray<any>>) & {
@@ -4509,11 +4621,16 @@ export declare class ReadPreference {
      */
     isValid(mode?: string): boolean;
     /**
-     * Indicates that this readPreference needs the "slaveOk" bit when sent over the wire
-     *
+     * Indicates that this readPreference needs the "secondaryOk" bit when sent over the wire
+     * @deprecated Use secondaryOk instead
      * @see https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#op-query
      */
     slaveOk(): boolean;
+    /**
+     * Indicates that this readPreference needs the "SecondaryOk" bit when sent over the wire
+     * @see https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#op-query
+     */
+    secondaryOk(): boolean;
     /**
      * Check if the two ReadPreferences are equivalent
      *
@@ -4575,7 +4692,7 @@ export declare interface ReplaceOneModel<TSchema extends Document = Document> {
     /** The filter to limit the replaced document. */
     filter: Filter<TSchema>;
     /** The document with which to replace the matched document. */
-    replacement: TSchema;
+    replacement: WithoutId<TSchema>;
     /** Specifies a collation. */
     collation?: CollationOptions;
     /** The index to use. If specified, then the query system will only consider plans using the hinted index. */
@@ -4938,7 +5055,7 @@ export declare type TagSet = {
 export declare interface TimeSeriesCollectionOptions extends Document {
     timeField: string;
     metaField?: string;
-    granularity?: string;
+    granularity?: 'seconds' | 'minutes' | 'hours' | string;
 }
 export { Timestamp };
 /* Excluded from this release type: Topology */
@@ -5027,6 +5144,8 @@ export declare class TopologyOpeningEvent {
 }
 /** @public */
 export declare interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
+    srvMaxHosts: number;
+    srvServiceName: string;
     hosts: HostAddress[];
     retryWrites: boolean;
     retryReads: boolean;
@@ -5090,7 +5209,7 @@ export declare class Transaction {
  */
 export declare interface TransactionOptions extends CommandOperationOptions {
     /** A default read concern for commands in this transaction */
-    readConcern?: ReadConcern;
+    readConcern?: ReadConcernLike;
     /** A default writeConcern for commands in this transaction */
     writeConcern?: WriteConcern;
     /** A default read preference for commands in this transaction */