mongodb 4.2.0 → 4.3.1

package/mongodb.ts34.d.ts

@@ -21,6 +21,7 @@ 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';
@@ -617,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
@@ -650,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 */
@@ -904,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;
@@ -995,9 +1000,9 @@ export declare interface ChangeStreamOptions extends AggregateOptions {
     fullDocument?: string;
     /** The maximum amount of time for the server to wait on new documents to satisfy a change stream query. */
     maxAwaitTimeMS?: number;
-    /** Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/master/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}. */
+    /** Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}. */
     resumeAfter?: ResumeToken;
-    /** Similar to resumeAfter, but will allow you to start after an invalidated event. See {@link https://docs.mongodb.com/master/changeStreams/#startafter-for-change-streams|ChangeStream documentation}. */
+    /** 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}. */
     startAfter?: ResumeToken;
     /** Will start the changeStream after the specified operationTime. */
     startAtOperationTime?: OperationTime;
@@ -1243,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
@@ -1256,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
      *
@@ -1315,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
      *
@@ -1401,8 +1406,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<WithId<TSchema>>;
-    find(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<WithId<TSchema>>;
-    find<T>(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<T>;
+    find(filter: Filter<TSchema>, options?: FindOptions): FindCursor<WithId<TSchema>>;
+    find<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the options of the collection.
      *
@@ -1642,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.
      *
@@ -1703,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.
      *
@@ -1756,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;
@@ -1970,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;
@@ -2211,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
@@ -2581,15 +2597,15 @@ 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>;
+export declare type Filter<TSchema> = Partial<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;
@@ -2875,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;
@@ -3132,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 {
@@ -3190,6 +3206,7 @@ export declare class HostAddress {
      */
     toString(ipv6Brackets?: boolean): string;
     static fromString(s: string): HostAddress;
+    static fromHostPort(host: string, port: number): HostAddress;
     static fromSrvRecord({ name, port }: SrvRecord): HostAddress;
 }
 /** @public */
@@ -3221,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 */
@@ -3259,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 */
@@ -3290,11 +3320,11 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 /* Excluded from this release type: kFullResult */
 /* Excluded from this release type: kGeneration */
 /* Excluded from this release type: kGeneration_2 */
+/* Excluded from this release type: kHello */
 /* Excluded from this release type: kId */
 /* Excluded from this release type: KillCursor */
 /* Excluded from this release type: kInitialized */
 /* Excluded from this release type: kInternalClient */
-/* Excluded from this release type: kIsMaster */
 /* Excluded from this release type: kKilled */
 /* Excluded from this release type: kLastUseTime */
 /* Excluded from this release type: kLength */
@@ -3543,7 +3573,7 @@ export { MaxKey };
 export { MinKey };
 /** @public */
 export declare interface ModifyResult<TSchema = Document> {
-    value: TSchema | null;
+    value: WithId<TSchema> | null;
     lastErrorObject?: Document;
     ok: 0 | 1;
 }
@@ -3559,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
@@ -3690,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
      *
@@ -3897,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 */
 /**
@@ -3933,9 +3985,9 @@ export declare class MongoCredentials {
      * If the authentication mechanism is set to "default", resolves the authMechanism
      * based on the server version and server supported sasl mechanisms.
      *
-     * @param ismaster - An ismaster response from the server
+     * @param hello - A hello response from the server
      */
-    resolveAuthMechanism(ismaster?: Document): MongoCredentials;
+    resolveAuthMechanism(hello?: Document): MongoCredentials;
     validate(): void;
     static merge(creds: MongoCredentials | undefined, options: Partial<MongoCredentialsOptions>): MongoCredentials;
 }
@@ -4166,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 */
@@ -4314,6 +4370,44 @@ export declare interface MonitorOptions extends Pick<ConnectionOptions, Exclude<
 }
 /* Excluded from this release type: MonitorPrivate */
 /* Excluded from this release type: Msg */
+/**
+ * @public
+ * returns tuple of strings (keys to be joined on '.') that represent every path into a schema
+ * https://docs.mongodb.com/manual/tutorial/query-embedded-documents/
+ */
+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>]: 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]>
+    ] : [
+        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;
@@ -4354,19 +4448,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);
@@ -4415,6 +4514,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>>) & {
@@ -4528,11 +4636,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
      *
@@ -4594,7 +4707,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. */
@@ -4622,7 +4735,7 @@ export declare interface ResumeOptions {
     readPreference?: ReadPreference;
 }
 /**
- * Represents the logical starting point for a new or resuming {@link https://docs.mongodb.com/master/changeStreams/#change-stream-resume-token| Change Stream} on the server.
+ * 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.
  * @public
  */
 export declare type ResumeToken = unknown;
@@ -4692,7 +4805,7 @@ export declare type ServerApiVersion = typeof ServerApiVersion[keyof typeof Serv
 export declare class ServerCapabilities {
     maxWireVersion: number;
     minWireVersion: number;
-    constructor(ismaster: Document);
+    constructor(hello: Document);
     readonly hasAggregationCursor: boolean;
     readonly hasWriteCommands: boolean;
     readonly hasTextSearch: boolean;
@@ -4715,7 +4828,7 @@ export declare class ServerClosedEvent {
     address: string;
 }
 /**
- * The client's view of a single server, based on the most recent ismaster outcome.
+ * The client's view of a single server, based on the most recent hello outcome.
  *
  * Internal type, not meant to be directly instantiated
  * @public
@@ -4786,7 +4899,7 @@ export declare type ServerEvents = {
     ended(): void;
 } & ConnectionPoolEvents & EventEmitterWithState;
 /**
- * Emitted when the server monitor’s ismaster fails, either with an “ok: 0” or a socket exception.
+ * Emitted when the server monitor’s hello fails, either with an “ok: 0” or a socket exception.
  * @public
  * @category Event
  */
@@ -4799,8 +4912,8 @@ export declare class ServerHeartbeatFailedEvent {
     failure: Error;
 }
 /**
- * Emitted when the server monitor’s ismaster command is started - immediately before
- * the ismaster command is serialized into raw BSON and written to the socket.
+ * Emitted when the server monitor’s hello command is started - immediately before
+ * the hello command is serialized into raw BSON and written to the socket.
  *
  * @public
  * @category Event
@@ -4810,7 +4923,7 @@ export declare class ServerHeartbeatStartedEvent {
     connectionId: string;
 }
 /**
- * Emitted when the server monitor’s ismaster succeeds.
+ * Emitted when the server monitor’s hello succeeds.
  * @public
  * @category Event
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "4.2.0",
+  "version": "4.3.1",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -32,55 +32,55 @@
     "email": "dbx-node@mongodb.com"
   },
   "dependencies": {
-    "bson": "^4.5.4",
+    "bson": "^4.6.1",
     "denque": "^2.0.1",
-    "mongodb-connection-string-url": "^2.2.0"
+    "mongodb-connection-string-url": "^2.4.1",
+    "socks": "^2.6.1"
   },
   "devDependencies": {
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@microsoft/api-extractor": "^7.18.14",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
+    "@microsoft/api-extractor": "^7.19.4",
     "@microsoft/tsdoc-config": "^0.15.2",
-    "@types/chai": "^4.2.22",
+    "@types/chai": "^4.3.0",
     "@types/chai-subset": "^1.3.3",
     "@types/kerberos": "^1.1.1",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.3",
+    "@types/node": "^17.0.10",
     "@types/saslprep": "^1.0.1",
-    "@types/semver": "^7.3.8",
+    "@types/semver": "^7.3.9",
     "@types/sinon": "^10.0.6",
     "@types/whatwg-url": "^8.2.1",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^5.10.0",
     "bluebird": "^3.7.2",
     "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
     "chalk": "^4.1.2",
-    "co": "4.6.0",
-    "downlevel-dts": "^0.7.0",
-    "eslint": "^7.32.0",
+    "downlevel-dts": "^0.8.0",
+    "eslint": "^8.7.0",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
     "js-yaml": "^4.1.0",
     "lodash.camelcase": "^4.3.0",
-    "mocha": "^9.1.2",
+    "mocha": "^9.1.4",
     "mocha-sinon": "^2.1.2",
-    "mongodb-mock-server": "^2.0.1",
     "nyc": "^15.1.0",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "semver": "^7.3.5",
     "sinon": "^12.0.1",
     "sinon-chai": "^3.7.0",
-    "source-map-support": "^0.5.20",
-    "standard-version": "^9.3.1",
-    "ts-node": "^10.2.1",
-    "tsd": "^0.17.0",
-    "typedoc": "^0.22.5",
-    "typescript": "4.4.3",
+    "source-map-support": "^0.5.21",
+    "standard-version": "^9.3.2",
+    "ts-node": "^10.4.0",
+    "tsd": "^0.19.1",
+    "typescript": "^4.5.4",
     "typescript-cached-transpile": "^0.0.6",
     "xml2js": "^0.4.23",
-    "yargs": "^17.2.1"
+    "yargs": "^17.3.1"
   },
   "license": "Apache-2.0",
   "engines": {
@@ -104,18 +104,19 @@
     "check:eslint": "eslint -v && eslint --max-warnings=0 --ext '.js,.ts' src test",
     "check:tsd": "tsd --version && tsd",
     "check:dts": "./node_modules/typescript/bin/tsc --noEmit mongodb.d.ts && tsd",
-    "check:test": "mocha --file test/tools/runner --recursive test/functional test/integration",
-    "check:unit": "mocha --recursive test/unit/",
+    "check:test": "mocha --file test/tools/runner test/integration",
+    "check:unit": "mocha test/unit/",
     "check:ts": "./node_modules/typescript/bin/tsc -v && ./node_modules/typescript/bin/tsc --noEmit",
     "check:atlas": "mocha --config \"test/manual/mocharc.json\" test/manual/atlas_connectivity.test.js",
     "check:adl": "mocha --file test/tools/runner test/manual/data_lake.test.js",
-    "check:aws": "mocha --file test/tools/runner test/functional/mongodb_aws.test.js",
+    "check:aws": "mocha --file test/tools/runner test/integration/auth/mongodb_aws.test.js",
     "check:ocsp": "mocha --config \"test/manual/mocharc.json\" test/manual/ocsp_support.test.js",
     "check:kerberos": "mocha --config \"test/manual/mocharc.json\" test/manual/kerberos.test.js",
     "check:tls": "mocha --config \"test/manual/mocharc.json\" test/manual/tls_support.test.js",
     "check:ldap": "mocha --config \"test/manual/mocharc.json\" test/manual/ldap.test.js",
-    "check:csfle": "mocha --file test/tools/runner test/functional/client_side_encryption",
-    "check:snappy": "mocha --file test/tools/runner test/functional/unit_snappy.test.js",
+    "check:socks5": "mocha --config \"test/manual/mocharc.json\" test/manual/socks5.test.ts",
+    "check:csfle": "mocha --file test/tools/runner test/integration/client-side-encryption",
+    "check:snappy": "mocha test/unit/assorted/snappy.test.js",
     "prepare": "node etc/prepare.js",
     "release": "standard-version -i HISTORY.md",
     "test": "npm run check:lint && npm run test:all",

package/src/admin.ts

@@ -1,20 +1,20 @@
+import type { Document } from './bson';
+import type { Db } from './db';
 import { AddUserOperation, AddUserOptions } from './operations/add_user';
-import { RemoveUserOperation, RemoveUserOptions } from './operations/remove_user';
-import {
-  ValidateCollectionOperation,
-  ValidateCollectionOptions
-} from './operations/validate_collection';
+import type { CommandOperationOptions } from './operations/command';
+import { executeOperation } from './operations/execute_operation';
 import {
   ListDatabasesOperation,
   ListDatabasesOptions,
   ListDatabasesResult
 } from './operations/list_databases';
-import { executeOperation } from './operations/execute_operation';
+import { RemoveUserOperation, RemoveUserOptions } from './operations/remove_user';
 import { RunCommandOperation, RunCommandOptions } from './operations/run_command';
+import {
+  ValidateCollectionOperation,
+  ValidateCollectionOptions
+} from './operations/validate_collection';
 import { Callback, getTopology } from './utils';
-import type { Document } from './bson';
-import type { CommandOperationOptions } from './operations/command';
-import type { Db } from './db';
 
 /** @internal */
 export interface AdminPrivate {