mongodb 6.7.0 → 6.8.0

package/mongodb.d.ts

@@ -10,20 +10,27 @@ import type { ConnectionOptions as ConnectionOptions_2 , TLSSocket , TLSSocketOp
 
 /** @public */
 export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends AbstractCursorEvents = AbstractCursorEvents> extends TypedEventEmitter<CursorEvents> {
-    /* Excluded from this release type: [kId] */
-    /* Excluded from this release type: [kSession] */
-    /* Excluded from this release type: [kServer] */
-    /* Excluded from this release type: [kNamespace] */
-    /* Excluded from this release type: [kDocuments] */
-    /* Excluded from this release type: [kClient] */
-    /* Excluded from this release type: [kTransform] */
-    /* Excluded from this release type: [kInitialized] */
-    /* Excluded from this release type: [kClosed] */
-    /* Excluded from this release type: [kKilled] */
-    /* Excluded from this release type: [kOptions] */
+    /* Excluded from this release type: cursorId */
+    /* Excluded from this release type: cursorSession */
+    /* Excluded from this release type: selectedServer */
+    /* Excluded from this release type: cursorNamespace */
+    /* Excluded from this release type: documents */
+    /* Excluded from this release type: cursorClient */
+    /* Excluded from this release type: transform */
+    /* Excluded from this release type: initialized */
+    /* Excluded from this release type: isClosed */
+    /* Excluded from this release type: isKilled */
+    /* Excluded from this release type: cursorOptions */
     /** @event */
     static readonly CLOSE: "close";
     /* Excluded from this release type: __constructor */
+    /**
+     * The cursor has no id until it receives a response from the initial cursor creating command.
+     *
+     * It is non-zero for as long as the database has an open cursor.
+     *
+     * The initiating command may receive a zero id if the entire result is in the `firstBatch`.
+     */
     get id(): Long | undefined;
     /* Excluded from this release type: isDead */
     /* Excluded from this release type: client */
@@ -33,8 +40,14 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     get readConcern(): ReadConcern | undefined;
     /* Excluded from this release type: session */
     /* Excluded from this release type: session */
-    /* Excluded from this release type: cursorOptions */
+    /**
+     * The cursor is closed and all remaining locally buffered documents have been iterated.
+     */
     get closed(): boolean;
+    /**
+     * A `killCursors` command was attempted on this cursor.
+     * This is performed if the cursor id is non zero.
+     */
     get killed(): boolean;
     get loadBalanced(): boolean;
     /** Returns current buffered documents length */
@@ -153,7 +166,13 @@ export declare abstract class AbstractCursor<TSchema = any, CursorEvents extends
     abstract clone(): AbstractCursor<TSchema>;
     /* Excluded from this release type: _initialize */
     /* Excluded from this release type: getMore */
-    /* Excluded from this release type: [kInit] */
+    /* Excluded from this release type: cursorInit */
+    /* Excluded from this release type: fetchBatch */
+    /* Excluded from this release type: cleanup */
+    /* Excluded from this release type: hasEmittedClose */
+    /* Excluded from this release type: emitClose */
+    /* Excluded from this release type: transformDocument */
+    /* Excluded from this release type: throwIfInitialized */
 }
 
 /** @public */
@@ -351,10 +370,9 @@ export declare interface AggregateOptions extends CommandOperationOptions {
  * @public
  */
 export declare class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
-    /* Excluded from this release type: [kPipeline] */
-    /* Excluded from this release type: [kOptions] */
+    readonly pipeline: Document[];
+    /* Excluded from this release type: aggregateOptions */
     /* Excluded from this release type: __constructor */
-    get pipeline(): Document[];
     clone(): AggregationCursor<TSchema>;
     map<T>(transform: (doc: TSchema) => T): AggregationCursor<T>;
     /* Excluded from this release type: _initialize */
@@ -731,6 +749,23 @@ export declare interface AWSEncryptionKeyOptions {
     endpoint?: string | undefined;
 }
 
+/** @public */
+export declare interface AWSKMSProviderConfiguration {
+    /**
+     * The access key used for the AWS KMS provider
+     */
+    accessKeyId: string;
+    /**
+     * The secret access key used for the AWS KMS provider
+     */
+    secretAccessKey: string;
+    /**
+     * An optional AWS session token that will be used as the
+     * X-Amz-Security-Token header for AWS requests.
+     */
+    sessionToken?: string;
+}
+
 /**
  * @public
  * Configuration options for making an Azure encryption key
@@ -750,6 +785,34 @@ export declare interface AzureEncryptionKeyOptions {
     keyVersion?: string | undefined;
 }
 
+/** @public */
+export declare type AzureKMSProviderConfiguration = {
+    /**
+     * The tenant ID identifies the organization for the account
+     */
+    tenantId: string;
+    /**
+     * The client ID to authenticate a registered application
+     */
+    clientId: string;
+    /**
+     * The client secret to authenticate a registered application
+     */
+    clientSecret: string;
+    /**
+     * If present, a host with optional port. E.g. "example.com" or "example.com:443".
+     * This is optional, and only needed if customer is using a non-commercial Azure instance
+     * (e.g. a government or China account, which use different URLs).
+     * Defaults to "login.microsoftonline.com"
+     */
+    identityPlatformEndpoint?: string | undefined;
+} | {
+    /**
+     * If present, an access token to authenticate with Azure.
+     */
+    accessToken: string;
+};
+
 /**
  * Keeps the state of a unordered batch so we can rewrite the results
  * correctly after command execution
@@ -784,6 +847,7 @@ export declare type BitwiseFilter = number /** numeric bit mask */ | Binary /**
 
 export { BSON }
 
+/* Excluded from this release type: BSONElement */
 export { BSONRegExp }
 
 /**
@@ -1074,8 +1138,6 @@ export declare class ChangeStream<TSchema extends Document = Document, TChange e
     /* Excluded from this release type: _processErrorIteratorMode */
 }
 
-/* Excluded from this release type: ChangeStreamAggregateRawResult */
-
 /**
  * Only present when the `showExpandedEvents` flag is enabled.
  * @public
@@ -1754,7 +1816,7 @@ export declare interface ClientEncryptionCreateDataKeyProviderOptions {
     /**
      * Identifies a new KMS-specific key used to encrypt the new data key
      */
-    masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | undefined;
+    masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | KMIPEncryptionKeyOptions | undefined;
     /**
      * An optional list of string alternate names used to reference a key.
      * If a key is created with alternate names, then encryption may refer to the key by the unique alternate name instead of by _id.
@@ -1766,8 +1828,15 @@ export declare interface ClientEncryptionCreateDataKeyProviderOptions {
 
 /**
  * @public
+ *
+ * A data key provider.  Allowed values:
+ *
+ * - aws, gcp, local, kmip or azure
+ * - (`mongodb-client-encryption>=6.0.1` only) a named key, in the form of:
+ *    `aws:<name>`, `gcp:<name>`, `local:<name>`, `kmip:<name>`, `azure:<name>`
+ *  where `name` is an alphanumeric string, underscores allowed.
  */
-export declare type ClientEncryptionDataKeyProvider = 'aws' | 'azure' | 'gcp' | 'local' | 'kmip';
+export declare type ClientEncryptionDataKeyProvider = keyof KMSProviders;
 
 /**
  * @public
@@ -1860,16 +1929,7 @@ export declare interface ClientEncryptionOptions {
  */
 export declare interface ClientEncryptionRewrapManyDataKeyProviderOptions {
     provider: ClientEncryptionDataKeyProvider;
-    masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | undefined;
-}
-
-/**
- * @public
- * @experimental
- */
-export declare interface ClientEncryptionRewrapManyDataKeyProviderOptions {
-    provider: ClientEncryptionDataKeyProvider;
-    masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | undefined;
+    masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | KMIPEncryptionKeyOptions | undefined;
 }
 
 /**
@@ -3064,7 +3124,7 @@ export declare interface ConnectOptions {
 export declare interface CountDocumentsOptions extends AggregateOptions {
     /** The number of documents to skip. */
     skip?: number;
-    /** The maximum amounts to count before aborting. */
+    /** The maximum amount of documents to consider. */
     limit?: number;
 }
 
@@ -3168,6 +3228,7 @@ export declare type CSFLEKMSTlsOptions = {
     kmip?: ClientEncryptionTlsOptions;
     local?: ClientEncryptionTlsOptions;
     azure?: ClientEncryptionTlsOptions;
+    [key: string]: ClientEncryptionTlsOptions | undefined;
 };
 
 /** @public */
@@ -3582,8 +3643,6 @@ export declare type EventEmitterWithState = {
  */
 export declare type EventsDescription = Record<string, GenericListener>;
 
-/* Excluded from this release type: ExecutionResult */
-
 /* Excluded from this release type: Explain */
 
 /** @public */
@@ -3662,9 +3721,9 @@ export declare interface FilterOperators<TValue> extends NonObjectIdLikeDocument
 
 /** @public */
 export declare class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
-    /* Excluded from this release type: [kFilter] */
-    /* Excluded from this release type: [kNumReturned] */
-    /* Excluded from this release type: [kBuiltOptions] */
+    /* Excluded from this release type: cursorFilter */
+    /* Excluded from this release type: numReturned */
+    /* Excluded from this release type: findOptions */
     /* Excluded from this release type: __constructor */
     clone(): FindCursor<TSchema>;
     map<T>(transform: (doc: TSchema) => T): FindCursor<T>;
@@ -3990,6 +4049,28 @@ export declare interface GCPEncryptionKeyOptions {
     endpoint?: string | undefined;
 }
 
+/** @public */
+export declare type GCPKMSProviderConfiguration = {
+    /**
+     * The service account email to authenticate
+     */
+    email: string;
+    /**
+     * A PKCS#8 encrypted key. This can either be a base64 string or a binary representation
+     */
+    privateKey: string | Buffer;
+    /**
+     * If present, a host with optional port. E.g. "example.com" or "example.com:443".
+     * Defaults to "oauth2.googleapis.com"
+     */
+    endpoint?: string | undefined;
+} | {
+    /**
+     * If present, an access token to authenticate with GCP.
+     */
+    accessToken: string;
+};
+
 /** @public */
 export declare type GenericListener = (...args: any[]) => void;
 
@@ -4381,6 +4462,8 @@ export declare type InferIdType<TSchema> = TSchema extends {
     _id?: infer IdType;
 } ? unknown extends IdType ? ObjectId : IdType : ObjectId;
 
+/* Excluded from this release type: InitialCursorResponse */
+
 /** @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 */
@@ -4435,8 +4518,6 @@ export declare type Join<T extends unknown[], D extends string> = T extends [] ?
 
 /* Excluded from this release type: kBeforeHandshake */
 
-/* Excluded from this release type: kBuiltOptions */
-
 /* Excluded from this release type: kCancellationToken */
 
 /* Excluded from this release type: kCancellationToken_2 */
@@ -4447,12 +4528,8 @@ export declare type Join<T extends unknown[], D extends string> = T extends [] ?
 
 /* Excluded from this release type: kCheckedOut */
 
-/* Excluded from this release type: kClient */
-
 /* Excluded from this release type: kClosed */
 
-/* Excluded from this release type: kClosed_2 */
-
 /* Excluded from this release type: kConnectionCounter */
 
 /* Excluded from this release type: kConnections */
@@ -4461,8 +4538,6 @@ export declare type Join<T extends unknown[], D extends string> = T extends [] ?
 
 /* Excluded from this release type: kDecorateResult */
 
-/* Excluded from this release type: kDocuments */
-
 /* Excluded from this release type: kErrorLabels */
 
 /** @public */
@@ -4475,24 +4550,47 @@ export declare type KeysOfOtherType<TSchema, Type> = {
     [key in keyof TSchema]: NonNullable<TSchema[key]> extends Type ? never : key;
 }[keyof TSchema];
 
-/* Excluded from this release type: kFilter */
-
 /* Excluded from this release type: kGeneration */
 
-/* Excluded from this release type: kId */
-
-/* Excluded from this release type: kInit */
-
-/* Excluded from this release type: kInitialized */
-
 /* Excluded from this release type: kInternalClient */
 
-/* Excluded from this release type: kKilled */
-
 /* Excluded from this release type: kMetrics */
 
 /* Excluded from this release type: kMinPoolSizeTimer */
 
+/**
+ * @public
+ * Configuration options for making a KMIP encryption key
+ */
+export declare interface KMIPEncryptionKeyOptions {
+    /**
+     * keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret Data managed object.
+     *
+     * If keyId is omitted, a random 96 byte KMIP Secret Data managed object will be created.
+     */
+    keyId?: string;
+    /**
+     * Host with optional port.
+     */
+    endpoint?: string;
+    /**
+     * If true, this key should be decrypted by the KMIP server.
+     *
+     * Requires `mongodb-client-encryption>=6.0.1`.
+     */
+    delegated?: boolean;
+}
+
+/** @public */
+export declare interface KMIPKMSProviderConfiguration {
+    /**
+     * 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;
+}
+
 /* Excluded from this release type: kMode */
 
 /* Excluded from this release type: kMonitorId */
@@ -4500,117 +4598,43 @@ export declare type KeysOfOtherType<TSchema, Type> = {
 /**
  * @public
  * Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.
+ *
+ * Named KMS providers _are not supported_ for automatic KMS credential fetching.
  */
 export declare interface KMSProviders {
     /**
      * Configuration options for using 'aws' as your KMS provider
      */
-    aws?: {
-        /**
-         * The access key used for the AWS KMS provider
-         */
-        accessKeyId: string;
-        /**
-         * The secret access key used for the AWS KMS provider
-         */
-        secretAccessKey: string;
-        /**
-         * An optional AWS session token that will be used as the
-         * X-Amz-Security-Token header for AWS requests.
-         */
-        sessionToken?: string;
-    } | Record<string, never>;
+    aws?: AWSKMSProviderConfiguration | Record<string, never>;
+    [key: `aws:${string}`]: AWSKMSProviderConfiguration;
     /**
      * Configuration options for using 'local' as your KMS provider
      */
-    local?: {
-        /**
-         * The master key used to encrypt/decrypt data keys.
-         * A 96-byte long Buffer or base64 encoded string.
-         */
-        key: Buffer | string;
-    };
+    local?: LocalKMSProviderConfiguration;
+    [key: `local:${string}`]: LocalKMSProviderConfiguration;
     /**
      * 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;
-    };
+    kmip?: KMIPKMSProviderConfiguration;
+    [key: `kmip:${string}`]: KMIPKMSProviderConfiguration;
     /**
      * Configuration options for using 'azure' as your KMS provider
      */
-    azure?: {
-        /**
-         * The tenant ID identifies the organization for the account
-         */
-        tenantId: string;
-        /**
-         * The client ID to authenticate a registered application
-         */
-        clientId: string;
-        /**
-         * The client secret to authenticate a registered application
-         */
-        clientSecret: string;
-        /**
-         * If present, a host with optional port. E.g. "example.com" or "example.com:443".
-         * This is optional, and only needed if customer is using a non-commercial Azure instance
-         * (e.g. a government or China account, which use different URLs).
-         * Defaults to "login.microsoftonline.com"
-         */
-        identityPlatformEndpoint?: string | undefined;
-    } | {
-        /**
-         * If present, an access token to authenticate with Azure.
-         */
-        accessToken: string;
-    } | Record<string, never>;
+    azure?: AzureKMSProviderConfiguration | Record<string, never>;
+    [key: `azure:${string}`]: AzureKMSProviderConfiguration;
     /**
      * Configuration options for using 'gcp' as your KMS provider
      */
-    gcp?: {
-        /**
-         * The service account email to authenticate
-         */
-        email: string;
-        /**
-         * A PKCS#8 encrypted key. This can either be a base64 string or a binary representation
-         */
-        privateKey: string | Buffer;
-        /**
-         * If present, a host with optional port. E.g. "example.com" or "example.com:443".
-         * Defaults to "oauth2.googleapis.com"
-         */
-        endpoint?: string | undefined;
-    } | {
-        /**
-         * If present, an access token to authenticate with GCP.
-         */
-        accessToken: string;
-    } | Record<string, never>;
+    gcp?: GCPKMSProviderConfiguration | Record<string, never>;
+    [key: `gcp:${string}`]: GCPKMSProviderConfiguration;
 }
 
-/* Excluded from this release type: kNamespace */
-
-/* Excluded from this release type: kNumReturned */
-
 /* Excluded from this release type: kOptions */
 
-/* Excluded from this release type: kOptions_2 */
-
-/* Excluded from this release type: kOptions_3 */
-
 /* Excluded from this release type: kPending */
 
 /* Excluded from this release type: kPinnedConnection */
 
-/* Excluded from this release type: kPipeline */
-
 /* Excluded from this release type: kPoolState */
 
 /* Excluded from this release type: kProcessingWaitQueue */
@@ -4619,8 +4643,6 @@ export declare interface KMSProviders {
 
 /* Excluded from this release type: kServer_2 */
 
-/* Excluded from this release type: kServer_3 */
-
 /* Excluded from this release type: kServerError */
 
 /* Excluded from this release type: kServerSession */
@@ -4629,14 +4651,10 @@ export declare interface KMSProviders {
 
 /* Excluded from this release type: kSession */
 
-/* Excluded from this release type: kSession_2 */
-
 /* Excluded from this release type: kSnapshotEnabled */
 
 /* Excluded from this release type: kSnapshotTime */
 
-/* Excluded from this release type: kTransform */
-
 /* Excluded from this release type: kTxnNumberIncrement */
 
 /* Excluded from this release type: kWaitQueue */
@@ -4715,6 +4733,15 @@ export declare class ListSearchIndexesCursor extends AggregationCursor<{
 /** @public */
 export declare type ListSearchIndexesOptions = Omit<AggregateOptions, 'readConcern' | 'writeConcern'>;
 
+/** @public */
+export declare interface LocalKMSProviderConfiguration {
+    /**
+     * The master key used to encrypt/decrypt data keys.
+     * A 96-byte long Buffer or base64 encoded string.
+     */
+    key: Binary | Uint8Array | string;
+}
+
 /* Excluded from this release type: Log */
 
 /* Excluded from this release type: LogComponentSeveritiesClientOptions */
@@ -6191,7 +6218,9 @@ export declare class MongoUnexpectedServerResponseError extends MongoRuntimeErro
      *
      * @public
      **/
-    constructor(message: string);
+    constructor(message: string, options?: {
+        cause?: Error;
+    });
     get name(): string;
 }
 
@@ -6201,8 +6230,8 @@ export declare class MongoUnexpectedServerResponseError extends MongoRuntimeErro
  * @category Error
  */
 export declare class MongoWriteConcernError extends MongoServerError {
-    /** The result document (provided if ok: 1) */
-    result?: Document;
+    /** The result document */
+    result: Document;
     /**
      * **Do not use this constructor!**
      *
@@ -6214,7 +6243,15 @@ export declare class MongoWriteConcernError extends MongoServerError {
      *
      * @public
      **/
-    constructor(message: ErrorDescription, result?: Document);
+    constructor(result: {
+        writeConcernError: {
+            code: number;
+            errmsg: string;
+            codeName?: string;
+            errInfo?: Document;
+        };
+        errorLabels?: string[];
+    });
     get name(): string;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "The official MongoDB driver for Node.js",
   "main": "lib/index.js",
   "files": [
@@ -98,7 +98,7 @@
     "js-yaml": "^4.1.0",
     "mocha": "^10.4.0",
     "mocha-sinon": "^2.1.2",
-    "mongodb-client-encryption": "^6.0.0",
+    "mongodb-client-encryption": "^6.0.1",
     "mongodb-legacy": "^6.0.1",
     "nyc": "^15.1.0",
     "prettier": "^2.8.8",

package/src/bson.ts

@@ -27,6 +27,7 @@ export {
   UUID
 } from 'bson';
 
+/** @internal */
 export type BSONElement = BSON.OnDemand['BSONElement'];
 
 export function parseToElementsToArray(bytes: Uint8Array, offset?: number): BSONElement[] {