@cipherstash/stack 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @cipherstash/stack
 
+## 0.4.0
+
+### Minor Changes
+
+- 5c3f4e7: Remove null support from encrypt and bulk encrypt operations to improve typescript support and reduce operation complexity.
+
 ## 0.3.0
 
 ### Minor Changes

package/README.md

@@ -170,7 +170,7 @@ All bulk methods make a single call to ZeroKMS regardless of the number of recor
 const plaintexts = [
   { id: "u1", plaintext: "alice@example.com" },
   { id: "u2", plaintext: "bob@example.com" },
-  { id: "u3", plaintext: null },  // null values are preserved
+  { id: "u3", plaintext: "charlie@example.com" },
 ]
 
 const encrypted = await client.bulkEncrypt(plaintexts, {

package/dist/bin/stash.js

@@ -1470,15 +1470,9 @@ function encryptedToPgComposite(obj) {
   };
 }
 function encryptedToCompositeLiteral(obj) {
-  if (obj === null) {
-    throw new Error("encryptedToCompositeLiteral: obj cannot be null");
-  }
   return `(${JSON.stringify(JSON.stringify(obj))})`;
 }
 function encryptedToEscapedCompositeLiteral(obj) {
-  if (obj === null) {
-    throw new Error("encryptedToEscapedCompositeLiteral: obj cannot be null");
-  }
   return JSON.stringify(encryptedToCompositeLiteral(obj));
 }
 function formatEncryptedResult(encrypted, returnType) {
@@ -1518,7 +1512,7 @@ var EncryptionErrorTypes = {
 
 // src/schema/index.ts
 import { z as z2 } from "zod";
-var castAsEnum = z2.enum(["bigint", "boolean", "date", "number", "string", "json"]).default("string");
+var castAsEnum = z2.enum(["bigint", "boolean", "date", "number", "string", "json", "text"]).default("text");
 var tokenFilterSchema = z2.object({
   kind: z2.literal("downcase")
 });
@@ -1566,7 +1560,7 @@ var EncryptedField = class {
   castAsValue;
   constructor(valueName) {
     this.valueName = valueName;
-    this.castAsValue = "string";
+    this.castAsValue = "text";
   }
   /**
    * Set or override the plaintext data type for this field.
@@ -1575,7 +1569,7 @@ var EncryptedField = class {
    * a different type so the encryption layer knows how to encode the plaintext
    * before encrypting.
    *
-   * @param castAs - The plaintext data type: `'string'`, `'number'`, `'boolean'`, `'date'`, `'bigint'`, or `'json'`.
+   * @param castAs - The plaintext data type: `'string'`, `'number'`, `'boolean'`, `'date'`, `'text'`, `'bigint'`, or `'json'`.
    * @returns This `EncryptedField` instance for method chaining.
    *
    * @example
@@ -1591,7 +1585,7 @@ var EncryptedField = class {
   }
   build() {
     return {
-      cast_as: this.castAsValue,
+      cast_as: this.castAsValue === "string" ? "text" : this.castAsValue,
       indexes: {}
     };
   }
@@ -1745,7 +1739,7 @@ var EncryptedColumn = class {
   }
   build() {
     return {
-      cast_as: this.castAsValue,
+      cast_as: this.castAsValue === "string" ? "text" : this.castAsValue,
       indexes: this.indexesValue
     };
   }
@@ -2120,18 +2114,6 @@ var EncryptionOperation = class {
 };
 
 // src/encryption/operations/batch-encrypt-query.ts
-function filterNullTerms(terms) {
-  const nullIndices = /* @__PURE__ */ new Set();
-  const nonNullTerms = [];
-  terms.forEach((term, index) => {
-    if (term.value === null || term.value === void 0) {
-      nullIndices.add(index);
-    } else {
-      nonNullTerms.push({ term, originalIndex: index });
-    }
-  });
-  return { nullIndices, nonNullTerms };
-}
 function buildQueryPayload(term, lockContext) {
   assertValidNumericValue(term.value);
   const { indexType, queryOp } = resolveIndexType(
@@ -2152,13 +2134,10 @@ function buildQueryPayload(term, lockContext) {
   }
   return payload;
 }
-function assembleResults(totalLength, encryptedValues, nonNullTerms) {
-  const results = new Array(totalLength).fill(null);
-  nonNullTerms.forEach(({ term, originalIndex }, i) => {
-    const encrypted = encryptedValues[i];
-    results[originalIndex] = formatEncryptedResult(encrypted, term.returnType);
-  });
-  return results;
+function assembleResults(terms, encryptedValues) {
+  return terms.map(
+    (term, i) => formatEncryptedResult(encryptedValues[i], term.returnType)
+  );
 }
 var BatchEncryptQueryOperation = class extends EncryptionOperation {
   constructor(client, terms) {
@@ -2185,23 +2164,18 @@ var BatchEncryptQueryOperation = class extends EncryptionOperation {
       log.emit();
       return { data: [] };
     }
-    const { nullIndices, nonNullTerms } = filterNullTerms(this.terms);
-    if (nonNullTerms.length === 0) {
-      log.emit();
-      return { data: this.terms.map(() => null) };
-    }
     const result = await withResult(
       async () => {
         if (!this.client) throw noClientError();
         const { metadata } = this.getAuditData();
-        const queries = nonNullTerms.map(
-          ({ term }) => buildQueryPayload(term)
+        const queries = this.terms.map(
+          (term) => buildQueryPayload(term)
         );
         const encrypted = await ffiEncryptQueryBulk(this.client, {
           queries,
           unverifiedContext: metadata
         });
-        return assembleResults(this.terms.length, encrypted, nonNullTerms);
+        return assembleResults(this.terms, encrypted);
       },
       (error) => {
         log.set({ errorCode: getErrorCode(error) ?? "unknown" });
@@ -2235,11 +2209,6 @@ var BatchEncryptQueryOperationWithLockContext = class extends EncryptionOperatio
       log.emit();
       return { data: [] };
     }
-    const { nullIndices, nonNullTerms } = filterNullTerms(this.terms);
-    if (nonNullTerms.length === 0) {
-      log.emit();
-      return { data: this.terms.map(() => null) };
-    }
     const lockContextResult = await this.lockContext.getLockContext();
     if (lockContextResult.failure) {
       log.emit();
@@ -2250,15 +2219,15 @@ var BatchEncryptQueryOperationWithLockContext = class extends EncryptionOperatio
       async () => {
         if (!this.client) throw noClientError();
         const { metadata } = this.getAuditData();
-        const queries = nonNullTerms.map(
-          ({ term }) => buildQueryPayload(term, context)
+        const queries = this.terms.map(
+          (term) => buildQueryPayload(term, context)
         );
         const encrypted = await ffiEncryptQueryBulk(this.client, {
           queries,
           serviceToken: ctsToken,
           unverifiedContext: metadata
         });
-        return assembleResults(this.terms.length, encrypted, nonNullTerms);
+        return assembleResults(this.terms, encrypted);
       },
       (error) => {
         log.set({ errorCode: getErrorCode(error) ?? "unknown" });
@@ -2280,42 +2249,25 @@ import {
   decryptBulkFallible
 } from "@cipherstash/protect-ffi";
 var createDecryptPayloads = (encryptedPayloads, lockContext) => {
-  return encryptedPayloads.map((item, index) => ({ ...item, originalIndex: index })).filter(({ data }) => data !== null).map(({ id, data, originalIndex }) => ({
+  return encryptedPayloads.map(({ id, data }) => ({
     id,
     ciphertext: data,
-    originalIndex,
     ...lockContext && { lockContext }
   }));
 };
-var createNullResult = (encryptedPayloads) => {
-  return encryptedPayloads.map(({ id }) => ({
-    id,
-    data: null
-  }));
-};
 var mapDecryptedDataToResult = (encryptedPayloads, decryptedData) => {
-  const result = new Array(encryptedPayloads.length);
-  let decryptedIndex = 0;
-  for (let i = 0; i < encryptedPayloads.length; i++) {
-    if (encryptedPayloads[i].data === null) {
-      result[i] = { id: encryptedPayloads[i].id, data: null };
-    } else {
-      const decryptResult = decryptedData[decryptedIndex];
-      if ("error" in decryptResult) {
-        result[i] = {
-          id: encryptedPayloads[i].id,
-          error: decryptResult.error
-        };
-      } else {
-        result[i] = {
-          id: encryptedPayloads[i].id,
-          data: decryptResult.data
-        };
-      }
-      decryptedIndex++;
+  return decryptedData.map((decryptResult, i) => {
+    if ("error" in decryptResult) {
+      return {
+        id: encryptedPayloads[i].id,
+        error: decryptResult.error
+      };
     }
-  }
-  return result;
+    return {
+      id: encryptedPayloads[i].id,
+      data: decryptResult.data
+    };
+  });
 };
 var BulkDecryptOperation = class extends EncryptionOperation {
   client;
@@ -2340,13 +2292,10 @@ var BulkDecryptOperation = class extends EncryptionOperation {
         if (!this.client) throw noClientError();
         if (!this.encryptedPayloads || this.encryptedPayloads.length === 0)
           return [];
-        const nonNullPayloads = createDecryptPayloads(this.encryptedPayloads);
-        if (nonNullPayloads.length === 0) {
-          return createNullResult(this.encryptedPayloads);
-        }
+        const payloads = createDecryptPayloads(this.encryptedPayloads);
         const { metadata } = this.getAuditData();
         const decryptedData = await decryptBulkFallible(this.client, {
-          ciphertexts: nonNullPayloads,
+          ciphertexts: payloads,
           unverifiedContext: metadata
         });
         return mapDecryptedDataToResult(this.encryptedPayloads, decryptedData);
@@ -2398,16 +2347,13 @@ var BulkDecryptOperationWithLockContext = class extends EncryptionOperation {
         if (context.failure) {
           throw new Error(`[encryption]: ${context.failure.message}`);
         }
-        const nonNullPayloads = createDecryptPayloads(
+        const payloads = createDecryptPayloads(
           encryptedPayloads,
           context.data.context
         );
-        if (nonNullPayloads.length === 0) {
-          return createNullResult(encryptedPayloads);
-        }
         const { metadata } = this.getAuditData();
         const decryptedData = await decryptBulkFallible(client, {
-          ciphertexts: nonNullPayloads,
+          ciphertexts: payloads,
           serviceToken: context.data.ctsToken,
           unverifiedContext: metadata
         });
@@ -3049,34 +2995,14 @@ var BulkDecryptModelsOperationWithLockContext = class extends EncryptionOperatio
 import { withResult as withResult4 } from "@byteslice/result";
 import { encryptBulk as encryptBulk2 } from "@cipherstash/protect-ffi";
 var createEncryptPayloads = (plaintexts, column, table, lockContext) => {
-  return plaintexts.map((item, index) => ({ ...item, originalIndex: index })).filter(({ plaintext }) => plaintext !== null).map(({ id, plaintext, originalIndex }) => ({
+  return plaintexts.map(({ id, plaintext }) => ({
     id,
     plaintext,
     column: column.getName(),
     table: table.tableName,
-    originalIndex,
     ...lockContext && { lockContext }
   }));
 };
-var createNullResult2 = (plaintexts) => {
-  return plaintexts.map(({ id }) => ({ id, data: null }));
-};
-var mapEncryptedDataToResult = (plaintexts, encryptedData) => {
-  const result = new Array(plaintexts.length);
-  let encryptedIndex = 0;
-  for (let i = 0; i < plaintexts.length; i++) {
-    if (plaintexts[i].plaintext === null) {
-      result[i] = { id: plaintexts[i].id, data: null };
-    } else {
-      result[i] = {
-        id: plaintexts[i].id,
-        data: encryptedData[encryptedIndex]
-      };
-      encryptedIndex++;
-    }
-  }
-  return result;
-};
 var BulkEncryptOperation = class extends EncryptionOperation {
   client;
   plaintexts;
@@ -3109,20 +3035,20 @@ var BulkEncryptOperation = class extends EncryptionOperation {
         if (!this.plaintexts || this.plaintexts.length === 0) {
           return [];
         }
-        const nonNullPayloads = createEncryptPayloads(
+        const payloads = createEncryptPayloads(
           this.plaintexts,
           this.column,
           this.table
         );
-        if (nonNullPayloads.length === 0) {
-          return createNullResult2(this.plaintexts);
-        }
         const { metadata } = this.getAuditData();
         const encryptedData = await encryptBulk2(this.client, {
-          plaintexts: nonNullPayloads,
+          plaintexts: payloads,
           unverifiedContext: metadata
         });
-        return mapEncryptedDataToResult(this.plaintexts, encryptedData);
+        return encryptedData.map((data, i) => ({
+          id: this.plaintexts[i].id,
+          data
+        }));
       },
       (error) => {
         log.set({ errorCode: getErrorCode(error) ?? "unknown" });
@@ -3179,22 +3105,22 @@ var BulkEncryptOperationWithLockContext = class extends EncryptionOperation {
         if (context.failure) {
           throw new Error(`[encryption]: ${context.failure.message}`);
         }
-        const nonNullPayloads = createEncryptPayloads(
+        const payloads = createEncryptPayloads(
           plaintexts,
           column,
           table,
           context.data.context
         );
-        if (nonNullPayloads.length === 0) {
-          return createNullResult2(plaintexts);
-        }
         const { metadata } = this.getAuditData();
         const encryptedData = await encryptBulk2(client, {
-          plaintexts: nonNullPayloads,
+          plaintexts: payloads,
           serviceToken: context.data.ctsToken,
           unverifiedContext: metadata
         });
-        return mapEncryptedDataToResult(plaintexts, encryptedData);
+        return encryptedData.map((data, i) => ({
+          id: plaintexts[i].id,
+          data
+        }));
       },
       (error) => {
         log.set({ errorCode: getErrorCode(error) ?? "unknown" });
@@ -3346,9 +3272,6 @@ var DecryptOperation = class extends EncryptionOperation {
         if (!this.client) {
           throw noClientError();
         }
-        if (this.encryptedData === null) {
-          return null;
-        }
         const { metadata } = this.getAuditData();
         return await ffiDecrypt(this.client, {
           ciphertext: this.encryptedData,
@@ -3399,9 +3322,6 @@ var DecryptOperationWithLockContext = class extends EncryptionOperation {
         if (!client) {
           throw noClientError();
         }
-        if (encryptedData === null) {
-          return null;
-        }
         const { metadata } = this.getAuditData();
         const context = await this.lockContext.getLockContext();
         if (context.failure) {
@@ -3557,9 +3477,6 @@ var EncryptOperation = class extends EncryptionOperation {
         if (!this.client) {
           throw noClientError();
         }
-        if (this.plaintext === null) {
-          return null;
-        }
         if (typeof this.plaintext === "number" && Number.isNaN(this.plaintext)) {
           throw new Error("[encryption]: Cannot encrypt NaN value");
         }
@@ -3621,9 +3538,6 @@ var EncryptOperationWithLockContext = class extends EncryptionOperation {
         if (!client) {
           throw noClientError();
         }
-        if (plaintext === null) {
-          return null;
-        }
         const { metadata } = this.getAuditData();
         const context = await this.lockContext.getLockContext();
         if (context.failure) {
@@ -3789,10 +3703,6 @@ var EncryptQueryOperation = class extends EncryptionOperation {
       queryType: this.opts.queryType,
       lockContext: false
     });
-    if (this.plaintext === null || this.plaintext === void 0) {
-      log.emit();
-      return { data: null };
-    }
     const validationError = validateNumericValue(this.plaintext);
     if (validationError?.failure) {
       log.emit();
@@ -3856,10 +3766,6 @@ var EncryptQueryOperationWithLockContext = class extends EncryptionOperation {
       queryType: this.opts.queryType,
       lockContext: true
     });
-    if (this.plaintext === null || this.plaintext === void 0) {
-      log.emit();
-      return { data: null };
-    }
     const validationError = validateNumericValue(this.plaintext);
     if (validationError?.failure) {
       log.emit();
@@ -3964,7 +3870,7 @@ var EncryptionClient = class {
   /**
    * Encrypt a value - returns a promise which resolves to an encrypted value.
    *
-   * @param plaintext - The plaintext value to be encrypted. Can be null.
+   * @param plaintext - The plaintext value to be encrypted.
    * @param opts - Options specifying the column (or nested field) and table for encryption. See {@link EncryptOptions}.
    * @returns An EncryptOperation that can be awaited or chained with additional methods.
    *
@@ -4265,7 +4171,7 @@ var EncryptionClient = class {
    *
    * Each value is encrypted with its own unique key via a single call to ZeroKMS.
    * Values can include optional `id` fields for correlating results back to
-   * your application data. Null plaintext values are preserved as null.
+   * your application data.
    *
    * @param plaintexts - An array of objects with `plaintext` (and optional `id`) fields.
    * @param opts - Options specifying the target column (or nested {@link encryptedField}) and table. See {@link EncryptOptions}.
@@ -4286,7 +4192,6 @@ var EncryptionClient = class {
    *   [
    *     { id: "u1", plaintext: "alice@example.com" },
    *     { id: "u2", plaintext: "bob@example.com" },
-   *     { id: "u3", plaintext: null },
    *   ],
    *   { column: users.email, table: users },
    * )