@cipherstash/protect-ffi 0.16.0-0 → 0.16.0-2

package/lib/index.cjs

@@ -1,27 +1,11 @@
 "use strict";
 // This module is the CJS entry point for the library.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.decryptBulk = exports.newClient = exports.encryptBulk = exports.encrypt = void 0;
-exports.decrypt = decrypt;
-exports.decryptBulkFallible = decryptBulkFallible;
+exports.decryptBulkFallible = exports.decryptBulk = exports.decrypt = exports.encryptBulk = exports.encrypt = exports.newClient = void 0;
 var load_cjs_1 = require("./load.cjs");
+Object.defineProperty(exports, "newClient", { enumerable: true, get: function () { return load_cjs_1.newClient; } });
 Object.defineProperty(exports, "encrypt", { enumerable: true, get: function () { return load_cjs_1.encrypt; } });
 Object.defineProperty(exports, "encryptBulk", { enumerable: true, get: function () { return load_cjs_1.encryptBulk; } });
-Object.defineProperty(exports, "newClient", { enumerable: true, get: function () { return load_cjs_1.newClient; } });
+Object.defineProperty(exports, "decrypt", { enumerable: true, get: function () { return load_cjs_1.decrypt; } });
 Object.defineProperty(exports, "decryptBulk", { enumerable: true, get: function () { return load_cjs_1.decryptBulk; } });
-const load_cjs_2 = require("./load.cjs");
-function decrypt(client, ciphertext, lockContext, ctsToken) {
-    if (ctsToken) {
-        return (0, load_cjs_2.decrypt)(client, ciphertext, lockContext, ctsToken);
-    }
-    if (lockContext) {
-        return (0, load_cjs_2.decrypt)(client, ciphertext, lockContext);
-    }
-    return (0, load_cjs_2.decrypt)(client, ciphertext);
-}
-function decryptBulkFallible(client, ciphertexts, ctsToken) {
-    if (ctsToken) {
-        return (0, load_cjs_2.decryptBulkFallible)(client, ciphertexts, ctsToken);
-    }
-    return (0, load_cjs_2.decryptBulkFallible)(client, ciphertexts);
-}
+Object.defineProperty(exports, "decryptBulkFallible", { enumerable: true, get: function () { return load_cjs_1.decryptBulkFallible; } });

package/lib/index.d.cts

@@ -1,18 +1,16 @@
-export { encrypt, encryptBulk, newClient, decryptBulk } from './load.cjs';
+export { newClient, encrypt, encryptBulk, decrypt, decryptBulk, decryptBulkFallible, } from './load.cjs';
 declare const sym: unique symbol;
 export type Client = {
     readonly [sym]: unknown;
 };
 declare module './load.cjs' {
-    function newClient(encryptSchema: string, clientOpts?: string): Promise<Client>;
-    function encrypt(client: Client, plaintext: EncryptPayload, ctsToken?: CtsToken): Promise<Encrypted>;
-    function decrypt(client: Client, ciphertext: string, context?: Context, ctsToken?: CtsToken): Promise<string>;
-    function encryptBulk(client: Client, plaintextTargets: EncryptPayload[], ctsToken?: CtsToken): Promise<Encrypted[]>;
-    function decryptBulk(client: Client, ciphertexts: BulkDecryptPayload[], ctsToken?: CtsToken): Promise<string[]>;
-    function decryptBulkFallible(client: Client, ciphertexts: BulkDecryptPayload[], ctsToken?: CtsToken): Promise<DecryptResult[]>;
+    function newClient(opts: NewClientOptions): Promise<Client>;
+    function encrypt(client: Client, opts: EncryptOptions): Promise<Encrypted>;
+    function decrypt(client: Client, opts: DecryptOptions): Promise<string>;
+    function encryptBulk(client: Client, opts: EncryptBulkOptions): Promise<Encrypted[]>;
+    function decryptBulk(client: Client, opts: DecryptBulkOptions): Promise<string[]>;
+    function decryptBulkFallible(client: Client, opts: DecryptBulkOptions): Promise<DecryptResult[]>;
 }
-export declare function decrypt(client: Client, ciphertext: string, lockContext?: Context, ctsToken?: CtsToken): Promise<string>;
-export declare function decryptBulkFallible(client: Client, ciphertexts: BulkDecryptPayload[], ctsToken?: CtsToken): Promise<DecryptResult[]>;
 export type DecryptResult = {
     data: string;
 } | {
@@ -47,3 +45,75 @@ export type Encrypted = {
     };
     v: number;
 };
+export type EncryptConfig = {
+    v: number;
+    tables: Record<string, Record<string, Column>>;
+};
+export type Column = {
+    cast_as?: CastAs;
+    indexes?: Indexes;
+};
+export type CastAs = 'big_int' | 'boolean' | 'date' | 'real' | 'double' | 'int' | 'small_int' | 'text' | 'jsonb';
+export type Indexes = {
+    ore?: OreIndexOpts;
+    unique?: UniqueIndexOpts;
+    match?: MatchIndexOpts;
+    ste_vec?: SteVecIndexOpts;
+};
+export type OreIndexOpts = Record<string, never>;
+export type UniqueIndexOpts = {
+    token_filters?: TokenFilter[];
+};
+export type MatchIndexOpts = {
+    tokenizer?: Tokenizer;
+    token_filters?: TokenFilter[];
+    k?: number;
+    m?: number;
+    include_original?: boolean;
+};
+export type SteVecIndexOpts = {
+    prefix: string;
+};
+export type Tokenizer = {
+    kind: 'standard';
+} | {
+    kind: 'ngram';
+    token_length: number;
+};
+export type TokenFilter = {
+    kind: 'downcase';
+};
+export type NewClientOptions = {
+    encryptConfig: EncryptConfig;
+    clientOpts?: ClientOpts;
+};
+export type ClientOpts = {
+    workspaceCrn?: string;
+    accessKey?: string;
+    clientId?: string;
+    clientKey?: string;
+};
+export type EncryptOptions = {
+    plaintext: string;
+    column: string;
+    table: string;
+    lockContext?: Context;
+    serviceToken?: CtsToken;
+    unverifiedContext?: Record<string, unknown>;
+};
+export type EncryptBulkOptions = {
+    plaintexts: EncryptPayload[];
+    serviceToken?: CtsToken;
+    unverifiedContext?: Record<string, unknown>;
+};
+export type DecryptOptions = {
+    ciphertext: string;
+    lockContext?: Context;
+    serviceToken?: CtsToken;
+    unverifiedContext?: Record<string, unknown>;
+};
+export type DecryptBulkOptions = {
+    ciphertexts: BulkDecryptPayload[];
+    serviceToken?: CtsToken;
+    unverifiedContext?: Record<string, unknown>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cipherstash/protect-ffi",
-  "version": "0.16.0-0",
+  "version": "0.16.0-2",
   "description": "",
   "main": "./lib/index.cjs",
   "scripts": {
@@ -61,10 +61,10 @@
     "@neon-rs/load": "^0.1.82"
   },
   "optionalDependencies": {
-    "@cipherstash/protect-ffi-win32-x64-msvc": "0.16.0-0",
-    "@cipherstash/protect-ffi-darwin-x64": "0.16.0-0",
-    "@cipherstash/protect-ffi-darwin-arm64": "0.16.0-0",
-    "@cipherstash/protect-ffi-linux-x64-gnu": "0.16.0-0",
-    "@cipherstash/protect-ffi-linux-arm64-gnu": "0.16.0-0"
+    "@cipherstash/protect-ffi-win32-x64-msvc": "0.16.0-2",
+    "@cipherstash/protect-ffi-darwin-x64": "0.16.0-2",
+    "@cipherstash/protect-ffi-darwin-arm64": "0.16.0-2",
+    "@cipherstash/protect-ffi-linux-x64-gnu": "0.16.0-2",
+    "@cipherstash/protect-ffi-linux-arm64-gnu": "0.16.0-2"
   }
 }