chore: type definition improvements for driver internal usage (#675)

Author: baileympearson

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [6.0.0-alpha.1](https://github.com/mongodb/libmongocrypt/compare/node-v2.9.0...node-v6.0.0-alpha.1) (2023-07-27)
+
 ## [6.0.0-alpha.0](https://github.com/mongodb/libmongocrypt/compare/node-v2.9.0...node-v6.0.0-alpha.0) (2023-07-13)
 
 ## [2.9.0](https://github.com/mongodb/libmongocrypt/compare/node-v2.8.0...node-v2.9.0) (2023-07-12)

package-lock.json

@@ -1,9 +1,9 @@
 {
   "name": "mongodb-client-encryption",
-  "version": "6.0.0-alpha.0",
+  "version": "6.0.0-alpha.1",
   "description": "Official client encryption module for the MongoDB Node.js driver",
   "main": "lib/index.js",
-  "types": "index.d.ts",
+  "types": "lib/index.d.ts",
   "files": [
     "README.md",
     "CHANGELOG.md",

package.json

@@ -2,7 +2,7 @@ import bindings = require('bindings');
 
 const mc = bindings('mongocrypt');
 
-interface MongoCryptKMSRequest {
+export interface MongoCryptKMSRequest {
   addResponse(response: Buffer): void;
   readonly status: MongoCryptStatus;
   readonly bytesNeeded: number;
@@ -11,18 +11,18 @@ interface MongoCryptKMSRequest {
   readonly message: Buffer;
 }
 
-interface MongoCryptStatus {
+export interface MongoCryptStatus {
   type: number;
   code: number;
   message?: string;
 }
 
-interface MongoCryptContext {
+export interface MongoCryptContext {
   nextMongoOperation(): Buffer;
-  addMongoOperationResponse(response: Buffer): void;
+  addMongoOperationResponse(response: Uint8Array): void;
   finishMongoOperation(): void;
   nextKMSRequest(): MongoCryptKMSRequest | null;
-  provideKMSProviders(providers: Buffer): void;
+  provideKMSProviders(providers: Uint8Array): void;
   finishKMSRequests(): void;
   finalize(): Buffer;
 
@@ -31,19 +31,28 @@ interface MongoCryptContext {
 }
 
 export interface MongoCryptConstructor {
-  new (): MongoCrypt;
+  new (options: {
+    kmsProviders?: Buffer;
+    schemaMap?: Buffer;
+    encryptedFieldsMap?: Buffer;
+    logger?: unknown;
+    cryptoCallbacks?: Record<string, unknown>;
+    cryptSharedLibSearchPaths?: string[];
+    cryptSharedLibPath?: string;
+    bypassQueryAnalysis?: boolean;
+  }): MongoCrypt;
   libmongocryptVersion: string;
 }
 
 export interface MongoCrypt {
-  makeEncryptionContext(ns: string, command: Buffer): MongoCryptContext;
+  makeEncryptionContext(ns: string, command: Uint8Array): MongoCryptContext;
   makeExplicitEncryptionContext(
-    value: Buffer,
+    value: Uint8Array,
     options?: {
-      keyId?: Buffer;
-      keyAltName?: Buffer;
+      keyId?: Uint8Array;
+      keyAltName?: Uint8Array;
       algorithm?: string;
-      rangeOptions?: Buffer;
+      rangeOptions?: Uint8Array;
       contentionFactor?: bigint | number;
       queryType?: string;
 
@@ -56,21 +65,33 @@ export interface MongoCrypt {
       expressionMode: boolean;
     }
   ): MongoCryptContext;
-  makeDecryptionContext(buffer: Buffer): MongoCryptContext;
-  makeExplicitDecryptionContext(buffer: Buffer): MongoCryptContext;
+  makeDecryptionContext(buffer: Uint8Array): MongoCryptContext;
+  makeExplicitDecryptionContext(buffer: Uint8Array): MongoCryptContext;
   makeDataKeyContext(
-    optionsBuffer: Buffer,
+    optionsBuffer: Uint8Array,
     options: {
-      keyAltNames: Buffer[];
-      keyMaterial: Buffer;
+      keyAltNames?: Uint8Array[];
+      keyMaterial?: Uint8Array;
     }
-  ): void;
-  makeRewrapManyDataKeyContext(filter: Buffer, encryptionKey: Buffer): void;
+  ): MongoCryptContext;
+  makeRewrapManyDataKeyContext(filter: Uint8Array, encryptionKey?: Uint8Array): MongoCryptContext;
   readonly status: MongoCryptStatus;
   readonly cryptSharedLibVersionInfo: {
     version: bigint;
     versionStr: string;
   } | null;
 }
 
+export type ExplicitEncryptionContextOptions = NonNullable<
+  Parameters<MongoCrypt['makeExplicitEncryptionContext']>[1]
+>;
+export type DataKeyContextOptions = NonNullable<Parameters<MongoCrypt['makeDataKeyContext']>[1]>;
+export type MongoCryptOptions = NonNullable<ConstructorParameters<MongoCryptConstructor>[0]>;
+
 export const MongoCrypt: MongoCryptConstructor = mc.MongoCrypt;
+
+/** exported for testing only. */
+interface MongoCryptContextCtor {
+  new (): MongoCryptContext;
+}
+export const MongoCryptContextCtor: MongoCryptContextCtor = mc.MongoCryptContextCtor;