mongodb 4.1.1 → 4.2.0

package/mongodb.d.ts

@@ -26,6 +26,7 @@ import { Readable } from 'stream';
 import type { serialize as serialize_2 } from 'bson';
 import type { SerializeOptions } from 'bson';
 import type { Socket } from 'net';
+import type { SrvRecord } from 'dns';
 import type { TcpNetConnectOpts } from 'net';
 import { Timestamp } from 'bson';
 import type { TLSSocket } from 'tls';
@@ -406,8 +407,11 @@ export declare class AggregationCursor<TSchema = Document> extends AbstractCurso
     limit($limit: number): this;
     /** Add a match stage to the aggregation pipeline */
     match($match: Document): this;
-    /** Add a out stage to the aggregation pipeline */
-    out($out: number): this;
+    /** Add an out stage to the aggregation pipeline */
+    out($out: {
+        db: string;
+        coll: string;
+    } | string): this;
     /**
      * Add a project stage to the aggregation pipeline
      *
@@ -525,6 +529,14 @@ export declare const AuthMechanism: Readonly<{
 /** @public */
 export declare type AuthMechanism = typeof AuthMechanism[keyof typeof AuthMechanism];
 
+/** @public */
+export declare interface AuthMechanismProperties extends Document {
+    SERVICE_NAME?: string;
+    SERVICE_REALM?: string;
+    CANONICALIZE_HOST_NAME?: boolean;
+    AWS_SESSION_TOKEN?: string;
+}
+
 /** @public */
 export declare interface AutoEncrypter {
     new (client: MongoClient, options: AutoEncryptionOptions): AutoEncrypter;
@@ -776,8 +788,10 @@ export declare abstract class BulkOperationBase {
     get bsonOptions(): BSONSerializeOptions;
     get writeConcern(): WriteConcern | undefined;
     get 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;
 }
@@ -804,6 +818,7 @@ export declare interface BulkWriteOperationError {
     index: number;
     code: number;
     errmsg: string;
+    errInfo: Document;
     op: Document | UpdateStatement | DeleteStatement;
 }
 
@@ -897,7 +912,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;
@@ -1015,14 +1030,14 @@ export declare interface ChangeStreamDocument<TSchema extends Document = Documen
 }
 
 /** @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;
 
 /**
@@ -1437,12 +1452,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>;
@@ -1453,9 +1468,9 @@ 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<T>(filter: Filter<TSchema>, options?: FindOptions): FindCursor<T>;
+    find(): FindCursor<WithId<TSchema>>;
+    find(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<WithId<TSchema>>;
+    find<T>(filter: Filter<WithId<TSchema>>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the options of the collection.
      *
@@ -1662,10 +1677,10 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param options - Optional settings for the command
      * @param callback - An optional callback, a Promise will be returned if none is provided
      */
-    indexes(): Promise<Document>;
-    indexes(callback: Callback<Document>): void;
-    indexes(options: IndexInformationOptions): Promise<Document>;
-    indexes(options: IndexInformationOptions, callback: Callback<Document>): void;
+    indexes(): Promise<Document[]>;
+    indexes(callback: Callback<Document[]>): void;
+    indexes(options: IndexInformationOptions): Promise<Document[]>;
+    indexes(options: IndexInformationOptions, callback: Callback<Document[]>): void;
     /**
      * Get all the collection statistics.
      *
@@ -1717,7 +1732,7 @@ export declare class Collection<TSchema extends Document = Document> {
      * @param pipeline - An array of aggregation pipelines to execute
      * @param options - Optional settings for the command
      */
-    aggregate<T = TSchema>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
+    aggregate<T = Document>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>;
     /**
      * Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.
      *
@@ -1729,6 +1744,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
@@ -2330,10 +2346,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
      *
@@ -3150,7 +3165,7 @@ export declare interface GridFSBucketOptions extends WriteConcernOptions {
  * Do not instantiate this class directly. Use `openDownloadStream()` instead.
  * @public
  */
-export declare class GridFSBucketReadStream extends Readable {
+export declare class GridFSBucketReadStream extends Readable implements NodeJS.ReadableStream {
     /* Excluded from this release type: s */
     /**
      * An error occurred
@@ -3231,7 +3246,7 @@ export declare interface GridFSBucketReadStreamOptionsWithRevision extends GridF
  * Do not instantiate this class directly. Use `openUploadStream()` instead.
  * @public
  */
-export declare class GridFSBucketWriteStream extends Writable {
+export declare class GridFSBucketWriteStream extends Writable implements NodeJS.WritableStream {
     bucket: GridFSBucket;
     chunks: Collection<GridFSChunk>;
     filename: string;
@@ -3269,10 +3284,10 @@ export declare class GridFSBucketWriteStream extends Writable {
      * @param callback - Function to call when the chunk was added to the buffer, or if the entire chunk was persisted to MongoDB if this chunk caused a flush.
      * @returns False if this write required flushing a chunk to MongoDB. True otherwise.
      */
-    write(chunk: Buffer): boolean;
-    write(chunk: Buffer, callback: Callback<void>): boolean;
-    write(chunk: Buffer, encoding: BufferEncoding | undefined): boolean;
-    write(chunk: Buffer, encoding: BufferEncoding | undefined, callback: Callback<void>): boolean;
+    write(chunk: Buffer | string): boolean;
+    write(chunk: Buffer | string, callback: Callback<void>): boolean;
+    write(chunk: Buffer | string, encoding: BufferEncoding | undefined): boolean;
+    write(chunk: Buffer | string, encoding: BufferEncoding | undefined, callback: Callback<void>): boolean;
     /**
      * Places this write stream into an aborted state (all future writes fail)
      * and deletes all chunks that have already been written.
@@ -3348,11 +3363,13 @@ 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 fromSrvRecord({ name, port }: SrvRecord): HostAddress;
 }
 
 /** @public */
@@ -3590,6 +3607,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;
 }
@@ -3605,7 +3624,16 @@ export declare interface ListDatabasesOptions extends CommandOperationOptions {
 }
 
 /** @public */
-export declare type ListDatabasesResult = string[] | Document[];
+export declare interface ListDatabasesResult {
+    databases: ({
+        name: string;
+        sizeOnDisk?: number;
+        empty?: boolean;
+    } & Document)[];
+    totalSize?: number;
+    totalSizeMb?: number;
+    ok: 1 | 0;
+}
 
 /** @public */
 export declare class ListIndexesCursor extends AbstractCursor {
@@ -3988,7 +4016,7 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     ssl?: boolean;
     /** Specifies the location of a local TLS Certificate */
     tlsCertificateFile?: string;
-    /** Specifies the location of a local .pem file that contains either the client’s TLS/SSL certificate or the client’s TLS/SSL certificate and key. */
+    /** Specifies the location of a local .pem file that contains either the client's TLS/SSL certificate and key or only the client's TLS/SSL key when tlsCertificateFile is used to provide the certificate. */
     tlsCertificateKeyFile?: string;
     /** Specifies the password to de-crypt the tlsCertificateKeyFile. */
     tlsCertificateKeyFilePassword?: string;
@@ -4004,10 +4032,20 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     connectTimeoutMS?: number;
     /** The time in milliseconds to attempt a send or receive on a socket before the attempt times out. */
     socketTimeoutMS?: number;
-    /** Comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance. */
-    compressors?: CompressorName[];
+    /** An array or comma-delimited string of compressors to enable network compression for communication between this client and a mongod/mongos instance. */
+    compressors?: CompressorName[] | string;
     /** An integer that specifies the compression level if using zlib for network compression. */
     zlibCompressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | undefined;
+    /** The maximum number of 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. */
@@ -4033,12 +4071,7 @@ export declare interface MongoClientOptions extends BSONSerializeOptions, Suppor
     /** Specify the authentication mechanism that MongoDB will use to authenticate the connection. */
     authMechanism?: AuthMechanism;
     /** Specify properties for the specified authMechanism as a comma-separated list of colon-separated key-value pairs. */
-    authMechanismProperties?: {
-        SERVICE_NAME?: string;
-        CANONICALIZE_HOST_NAME?: boolean;
-        SERVICE_REALM?: string;
-        [key: string]: any;
-    };
+    authMechanismProperties?: AuthMechanismProperties;
     /** The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances. */
     localThresholdMS?: number;
     /** Specifies how long (in milliseconds) to block for server selection before throwing an exception.  */
@@ -4148,7 +4181,7 @@ export declare class MongoCredentials {
     /** The method used to authenticate */
     readonly mechanism: AuthMechanism;
     /** Special properties used by some types of auth mechanisms */
-    readonly mechanismProperties: Document;
+    readonly mechanismProperties: AuthMechanismProperties;
     constructor(options: MongoCredentialsOptions);
     /** Determines if two MongoCredentials objects are equivalent */
     equals(other: MongoCredentials): boolean;
@@ -4170,7 +4203,7 @@ export declare interface MongoCredentialsOptions {
     source: string;
     db?: string;
     mechanism?: AuthMechanism;
-    mechanismProperties: Document;
+    mechanismProperties: AuthMechanismProperties;
 }
 
 /**
@@ -4395,7 +4428,7 @@ export declare class MongoNotConnectedError extends MongoAPIError {
  * Mongo Client Options
  * @public
  */
-export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'compressors' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'logger' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
+export declare interface MongoOptions extends Required<Pick<MongoClientOptions, 'autoEncryption' | 'connectTimeoutMS' | 'directConnection' | 'driverInfo' | 'forceServerObjectId' | 'minHeartbeatFrequencyMS' | 'heartbeatFrequencyMS' | 'keepAlive' | 'keepAliveInitialDelay' | 'localThresholdMS' | 'logger' | 'maxIdleTimeMS' | 'maxPoolSize' | 'minPoolSize' | 'monitorCommands' | 'noDelay' | 'pkFactory' | 'promiseLibrary' | 'raw' | 'replicaSet' | 'retryReads' | 'retryWrites' | 'serverSelectionTimeoutMS' | 'socketTimeoutMS' | 'srvMaxHosts' | 'srvServiceName' | 'tlsAllowInvalidCertificates' | 'tlsAllowInvalidHostnames' | 'tlsInsecure' | 'waitQueueTimeoutMS' | 'zlibCompressionLevel'>>, SupportedNodeConnectionOptions {
     hosts: HostAddress[];
     srvHost?: string;
     credentials?: MongoCredentials;
@@ -4403,6 +4436,7 @@ export declare interface MongoOptions extends Required<Pick<MongoClientOptions,
     readConcern: ReadConcern;
     loadBalanced: boolean;
     serverApi: ServerApi;
+    compressors: CompressorName[];
     writeConcern: WriteConcern;
     dbName: string;
     metadata: ClientMetadata;
@@ -4578,6 +4612,12 @@ export declare type NotAcceptedFields<TSchema, FieldType> = {
 /** @public */
 export declare type NumericType = IntegerType | Decimal128 | Double;
 
+/**
+ * @public
+ * @deprecated Please use `ObjectId`
+ */
+export declare const ObjectID: typeof ObjectId;
+
 export { ObjectId }
 
 /** @public */
@@ -4596,6 +4636,7 @@ export declare interface OperationOptions extends BSONSerializeOptions {
     /** 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 */
@@ -4621,11 +4662,13 @@ export declare type OperationTime = Timestamp;
  * `TSchema['_id'] extends ObjectId` which translated to "Is the _id property ObjectId?"
  * we instead ask "Does ObjectId look like (have the same shape) as the _id?"
  */
-export declare type OptionalId<TSchema extends {
+export declare type OptionalId<TSchema> = TSchema extends {
     _id?: any;
-}> = ObjectId extends TSchema['_id'] ? EnhancedOmit<TSchema, '_id'> & {
+} ? ObjectId extends TSchema['_id'] ? EnhancedOmit<TSchema, '_id'> & {
+    _id?: InferIdType<TSchema>;
+} : WithId<TSchema> : EnhancedOmit<TSchema, '_id'> & {
     _id?: InferIdType<TSchema>;
-} : WithId<TSchema>;
+};
 
 /** @public */
 export declare class OrderedBulkOperation extends BulkOperationBase {
@@ -5303,7 +5346,7 @@ export declare type TagSet = {
 export declare interface TimeSeriesCollectionOptions extends Document {
     timeField: string;
     metaField?: string;
-    granularity?: string;
+    granularity?: 'seconds' | 'minutes' | 'hours' | string;
 }
 
 export { Timestamp }
@@ -5405,6 +5448,8 @@ export declare class TopologyOpeningEvent {
 
 /** @public */
 export declare interface TopologyOptions extends BSONSerializeOptions, ServerOptions {
+    srvMaxHosts: number;
+    srvServiceName: string;
     hosts: HostAddress[];
     retryWrites: boolean;
     retryReads: boolean;
@@ -5477,7 +5522,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 */
@@ -5912,6 +5957,8 @@ export declare class WriteError {
     get index(): number;
     /** WriteError message. */
     get errmsg(): string | undefined;
+    /** WriteError details. */
+    get errInfo(): Document | undefined;
     /** Returns the underlying operation that caused the error */
     getOperation(): Document;
     toJSON(): {