@cipherstash/protect-ffi 0.16.0 → 0.17.0

package/README.md

@@ -143,13 +143,22 @@ PGHOST=localhost
 ```
 
 To run integration tests:
+```sh
+mise setup
+mise test:integration
+```
+
+You can also run the integration tests in "watch" mode:
+
+```sh
+mise test:integration --watch
 ```
-npm run debug
-cd integration-tests
-docker compose up --detach --wait
-npm run eql:download
-npm run eql:install
-npm run test
+
+By default lock context tests are not included because invalid lock contexts fire security warnings in ZeroKMS.
+To include these, run:
+
+```sh
+mise test:integration:all
 ```
 
 ## Releasing

package/lib/index.d.cts

@@ -6,9 +6,9 @@ export type Client = {
 declare module './load.cjs' {
     function newClient(opts: NewClientOptions): Promise<Client>;
     function encrypt(client: Client, opts: EncryptOptions): Promise<Encrypted>;
-    function decrypt(client: Client, opts: DecryptOptions): Promise<string>;
+    function decrypt(client: Client, opts: DecryptOptions): Promise<JsPlaintext>;
     function encryptBulk(client: Client, opts: EncryptBulkOptions): Promise<Encrypted[]>;
-    function decryptBulk(client: Client, opts: DecryptBulkOptions): Promise<string[]>;
+    function decryptBulk(client: Client, opts: DecryptBulkOptions): Promise<JsPlaintext[]>;
     function decryptBulkFallible(client: Client, opts: DecryptBulkOptions): Promise<DecryptResult[]>;
 }
 export type DecryptResult = {
@@ -17,13 +17,13 @@ export type DecryptResult = {
     error: string;
 };
 export type EncryptPayload = {
-    plaintext: string;
+    plaintext: JsPlaintext;
     column: string;
     table: string;
     lockContext?: Context;
 };
 export type BulkDecryptPayload = {
-    ciphertext: string;
+    ciphertext: Encrypted;
     lockContext?: Context;
 };
 export type CtsToken = {
@@ -54,6 +54,15 @@ export type Column = {
     indexes?: Indexes;
 };
 export type CastAs = 'big_int' | 'boolean' | 'date' | 'real' | 'double' | 'int' | 'small_int' | 'text' | 'jsonb';
+type TablesOf<C extends EncryptConfig> = C['tables'];
+export type Identifier<C extends EncryptConfig> = {
+    [T in keyof TablesOf<C>]: {
+        [CName in keyof TablesOf<C>[T]]: {
+            table: T;
+            column: CName;
+        };
+    }[keyof TablesOf<C>[T]];
+}[keyof TablesOf<C>];
 export type Indexes = {
     ore?: OreIndexOpts;
     unique?: UniqueIndexOpts;
@@ -93,8 +102,9 @@ export type ClientOpts = {
     clientId?: string;
     clientKey?: string;
 };
+export type JsPlaintext = string | number | Record<string, unknown> | JsPlaintext[];
 export type EncryptOptions = {
-    plaintext: string;
+    plaintext: JsPlaintext;
     column: string;
     table: string;
     lockContext?: Context;
@@ -107,7 +117,7 @@ export type EncryptBulkOptions = {
     unverifiedContext?: Record<string, unknown>;
 };
 export type DecryptOptions = {
-    ciphertext: string;
+    ciphertext: Encrypted;
     lockContext?: Context;
     serviceToken?: CtsToken;
     unverifiedContext?: Record<string, unknown>;

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@cipherstash/protect-ffi",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "",
   "main": "./lib/index.cjs",
   "scripts": {
     "test": "npm run test:typecheck && npm run test:lint && npm run test:format && npm run test:rust",
     "test:typecheck": "tsc",
     "test:rust": "cargo test",
-    "test:lint": "npm run test:lint:rust && npm run test:lint:ts",
+    "test:lint": "npm run test:lint:ts",
     "test:lint:ts": "biome lint",
-    "test:lint:rust": "cargo clippy --all --no-deps --all-targets --all-features -- -D warnings",
-    "test:format": "npm run test:format:rust && npm run test:format:ts",
+    "test:format": "npm run test:format:ts",
     "test:format:ts": "biome format",
     "test:format:rust": "cargo fmt --check",
     "cargo-build": "tsc &&cargo build --message-format=json-render-diagnostics > cargo.log",
@@ -61,10 +60,10 @@
     "@neon-rs/load": "^0.1.82"
   },
   "optionalDependencies": {
-    "@cipherstash/protect-ffi-win32-x64-msvc": "0.16.0",
-    "@cipherstash/protect-ffi-darwin-x64": "0.16.0",
-    "@cipherstash/protect-ffi-darwin-arm64": "0.16.0",
-    "@cipherstash/protect-ffi-linux-x64-gnu": "0.16.0",
-    "@cipherstash/protect-ffi-linux-arm64-gnu": "0.16.0"
+    "@cipherstash/protect-ffi-win32-x64-msvc": "0.17.0",
+    "@cipherstash/protect-ffi-darwin-x64": "0.17.0",
+    "@cipherstash/protect-ffi-darwin-arm64": "0.17.0",
+    "@cipherstash/protect-ffi-linux-x64-gnu": "0.17.0",
+    "@cipherstash/protect-ffi-linux-arm64-gnu": "0.17.0"
   }
 }