Skip to content

Commit f8e7301

Browse files
authored
chore(NODE-4285): rename csfle shared library references (#3280)
1 parent 4501a1c commit f8e7301

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

src/deps.ts

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -324,40 +324,44 @@ export interface AutoEncryptionOptions {
324324
/** Command line arguments to use when auto-spawning a mongocryptd */
325325
mongocryptdSpawnArgs?: string[];
326326
/**
327-
* Full path to a CSFLE shared library to be used (instead of mongocryptd).
327+
* Full path to a MongoDB Crypt shared library to be used (instead of mongocryptd).
328328
*
329329
* This needs to be the path to the file itself, not a directory.
330330
* It can be an absolute or relative path. If the path is relative and
331331
* its first component is `$ORIGIN`, it will be replaced by the directory
332332
* containing the mongodb-client-encryption native addon file. Otherwise,
333333
* the path will be interpreted relative to the current working directory.
334334
*
335-
* Currently, loading different CSFLE shared library files from different
335+
* Currently, loading different MongoDB Crypt shared library files from different
336336
* MongoClients in the same process is not supported.
337337
*
338-
* If this option is provided and no CSFLE shared library could be loaded
338+
* If this option is provided and no MongoDB Crypt shared library could be loaded
339339
* from the specified location, creating the MongoClient will fail.
340340
*
341-
* If this option is not provided and `csfleRequired` is not specified,
341+
* If this option is not provided and `cryptSharedLibRequired` is not specified,
342342
* the AutoEncrypter will attempt to spawn and/or use mongocryptd according
343343
* to the mongocryptd-specific `extraOptions` options.
344344
*
345345
* Specifying a path prevents mongocryptd from being used as a fallback.
346+
*
347+
* @experimental Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.
346348
*/
347-
csflePath?: string;
349+
cryptSharedLibPath?: string;
348350
/**
349-
* If specified, never use mongocryptd and instead fail when the CSFLE shared library
350-
* could not be loaded.
351+
* If specified, never use mongocryptd and instead fail when the MongoDB Crypt
352+
* shared library could not be loaded.
353+
*
354+
* This is always true when `cryptSharedLibPath` is specified.
351355
*
352-
* This is always true when `csflePath` is specified.
356+
* @experimental Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.
353357
*/
354-
csfleRequired?: boolean;
358+
cryptSharedLibRequired?: boolean;
355359
/**
356-
* Search paths for a CSFLE shared library to be used (instead of mongocryptd)
360+
* Search paths for a MongoDB Crypt shared library to be used (instead of mongocryptd)
357361
* Only for driver testing!
358362
* @internal
359363
*/
360-
csfleSearchPaths?: string[];
364+
cryptSharedLibSearchPaths?: string[];
361365
};
362366
proxyOptions?: ProxyOptions;
363367
/** The TLS options to use connecting to the KMS provider */
@@ -378,5 +382,6 @@ export interface AutoEncrypter {
378382
teardown(force: boolean, callback: Callback): void;
379383
encrypt(ns: string, cmd: Document, options: any, callback: Callback<Document>): void;
380384
decrypt(cmd: Document, options: any, callback: Callback<Document>): void;
381-
readonly csfleVersionInfo: { version: bigint; versionStr: string } | null;
385+
/** @experimental */
386+
readonly cryptSharedLibVersionInfo: { version: bigint; versionStr: string } | null;
382387
}

0 commit comments

Comments
 (0)