mongodb 4.2.1 → 4.4.0

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';
@@ -507,9 +508,10 @@ export declare const AuthMechanism: Readonly<{
 export declare type AuthMechanism = typeof AuthMechanism[keyof typeof AuthMechanism];
 /** @public */
 export declare interface AuthMechanismProperties extends Document {
+    SERVICE_HOST?: string;
     SERVICE_NAME?: string;
     SERVICE_REALM?: string;
-    CANONICALIZE_HOST_NAME?: boolean;
+    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
     AWS_SESSION_TOKEN?: string;
 }
 /** @public */
@@ -588,6 +590,17 @@ export declare interface AutoEncryptionOptions {
              */
             endpoint?: string | undefined;
         };
+        /**
+         * Configuration options for using 'kmip' as your KMS provider
+         */
+        kmip?: {
+            /**
+             * The output endpoint string.
+             * The endpoint consists of a hostname and port separated by a colon.
+             * E.g. "example.com:123". A port is always present.
+             */
+            endpoint?: string;
+        };
     };
     /**
      * A map of namespaces to a local JSON schema for encryption
@@ -617,6 +630,36 @@ export declare interface AutoEncryptionOptions {
         /** Command line arguments to use when auto-spawning a mongocryptd */
         mongocryptdSpawnArgs?: string[];
     };
+    proxyOptions?: ProxyOptions;
+    /** The TLS options to use connecting to the KMS provider */
+    tlsOptions?: {
+        aws?: AutoEncryptionTlsOptions;
+        local?: AutoEncryptionTlsOptions;
+        azure?: AutoEncryptionTlsOptions;
+        gcp?: AutoEncryptionTlsOptions;
+        kmip?: AutoEncryptionTlsOptions;
+    };
+}
+/** @public */
+export declare interface AutoEncryptionTlsOptions {
+    /**
+     * 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;
+    /**
+     * Specifies the location of a local .pem file that contains the
+     * root certificate chain from the Certificate Authority.
+     * This file is used to validate the certificate presented by the
+     * KMS provider.
+     */
+    tlsCAFile?: string;
 }
 /**
  * Keeps the state of a unordered batch so we can rewrite the results
@@ -653,6 +696,8 @@ export { BSONRegExp };
 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 */
@@ -954,7 +999,9 @@ export declare interface ChangeStreamDocument<TSchema extends Document = Documen
      * this will contain all the components of the shard key in order,
      * followed by the _id if the _id isn’t part of the shard key.
      */
-    documentKey?: InferIdType<TSchema>;
+    documentKey?: {
+        _id: InferIdType<TSchema>;
+    };
     /**
      * Only present for ops of type ‘update’.
      *
@@ -996,9 +1043,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;
@@ -1244,10 +1291,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
@@ -1257,10 +1304,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
      *
@@ -1316,10 +1363,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
      *
@@ -1643,10 +1690,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.
      *
@@ -1704,7 +1751,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.
      *
@@ -1757,6 +1804,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;
@@ -1971,7 +2021,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;
@@ -2212,7 +2262,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
@@ -2582,15 +2640,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 WithId<TSchema>]?: Condition<WithId<TSchema>[P]>;
-} & RootFilterOperators<WithId<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;
@@ -2642,10 +2700,16 @@ export declare class FindCursor<TSchema = Document> extends AbstractCursor<TSche
     map<T>(transform: (doc: TSchema) => T): FindCursor<T>;
     /* Excluded from this release type: _initialize */
     /* Excluded from this release type: _getMore */
-    /** Get the count of documents for this cursor */
+    /**
+     * Get the count of documents for this cursor
+     * @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead
+     */
     count(): Promise<number>;
+    /** @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead */
     count(callback: Callback<number>): void;
+    /** @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead */
     count(options: CountOptions): Promise<number>;
+    /** @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead */
     count(options: CountOptions, callback: Callback<number>): void;
     /** Execute the explain for the cursor */
     explain(): Promise<Document>;
@@ -2876,7 +2940,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;
@@ -3133,12 +3197,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 {
@@ -3172,6 +3236,16 @@ export declare interface GridFSFile {
     uploadDate: Date;
 }
 /** @public */
+export declare const GSSAPICanonicalizationValue: Readonly<{
+    readonly on: true;
+    readonly off: false;
+    readonly none: "none";
+    readonly forward: "forward";
+    readonly forwardAndReverse: "forwardAndReverse";
+}>;
+/** @public */
+export declare type GSSAPICanonicalizationValue = typeof GSSAPICanonicalizationValue[keyof typeof GSSAPICanonicalizationValue];
+/** @public */
 export declare interface HedgeOptions {
     /** Explicitly enable or disable hedged reads. */
     enabled?: boolean;
@@ -3191,6 +3265,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 */
@@ -3222,7 +3297,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 */
@@ -3260,6 +3337,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 */
@@ -3291,11 +3379,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 */
@@ -3544,7 +3632,7 @@ export { MaxKey };
 export { MinKey };
 /** @public */
 export declare interface ModifyResult<TSchema = Document> {
-    value: TSchema | null;
+    value: WithId<TSchema> | null;
     lastErrorObject?: Document;
     ok: 0 | 1;
 }
@@ -3560,7 +3648,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
@@ -3691,8 +3793,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
      *
@@ -3898,6 +4000,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 */
 /**
@@ -3934,9 +4044,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;
 }
@@ -4167,6 +4277,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 */
@@ -4315,6 +4429,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;
@@ -4355,19 +4507,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);
@@ -4416,6 +4573,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>>) & {
@@ -4529,11 +4695,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
      *
@@ -4595,7 +4766,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. */
@@ -4623,7 +4794,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;
@@ -4693,7 +4864,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;
@@ -4716,7 +4887,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
@@ -4787,7 +4958,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
  */
@@ -4800,8 +4971,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
@@ -4811,7 +4982,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
  */