Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(NODE-4136): revise FLE shared library typings for spec changes #3206

Merged
merged 3 commits into from
Apr 25, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions src/deps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -296,13 +296,38 @@ export interface AutoEncryptionOptions {
/** Command line arguments to use when auto-spawning a mongocryptd */
mongocryptdSpawnArgs?: string[];
/**
* Full path to a CSFLE shared library to be used (instead of mongocryptd)
* @experimental
* Full path to a CSFLE shared library to be used (instead of mongocryptd).
*
* This needs to be the path to the file itself, not a directory.
* It can be an absolute or relative path. If the path is relative and
* its first component is `$ORIGIN`, it will be replaced by the directory
* containing the mongodb-client-encryption native addon file. Otherwise,
* the path will be interpreted relative to the current working directory.
*
* Currently, loading different CSFLE shared library files from different
* MongoClients in the same process is not supported.
*
* If this option is provided and no CSFLE shared library could be loaded
* from the specified location, creating the MongoClient will fail.
nbbeeken marked this conversation as resolved.
Show resolved Hide resolved
*
* If this option is not provided and `csfleRequired` is not specified,
* the AutoEncrypter will attempt to spawn and/or use mongocryptd according
* to the mongocryptd-specific `extraOptions` options.
*
* Specifying a path prevents mongocryptd from being used as a fallback.
*/
csflePath?: string;
/**
* If specified, never use mongocryptd and instead fail when the CSFLE shared library
* could not be loaded.
*
* This is always true when `csflePath` is specified.
*/
csfleRequired?: boolean;
/**
* Search paths for a CSFLE shared library to be used (instead of mongocryptd)
* @experimental
* Only for driver testing!
* @internal
*/
csfleSearchPaths?: string[];
nbbeeken marked this conversation as resolved.
Show resolved Hide resolved
};
Expand Down