fix: default to text for encrypt config

Author: calvinbrewer

packages/stack/__tests__/schema-builders.test.ts

@@ -23,12 +23,12 @@ describe('schema builders', () => {
     it('defaults castAs to string', () => {
       const col = encryptedColumn('name')
       const built = col.build()
-      expect(built.cast_as).toBe('string')
+      expect(built.cast_as).toBe('text')
     })
 
     it('.dataType("string") sets castAs to string', () => {
       const col = encryptedColumn('name').dataType('string')
-      expect(col.build().cast_as).toBe('string')
+      expect(col.build().cast_as).toBe('text')
     })
 
     it('.dataType("number") sets castAs to number', () => {
@@ -140,7 +140,7 @@ describe('schema builders', () => {
       const built = col.build()
 
       expect(built).toEqual({
-        cast_as: 'string',
+        cast_as: 'text',
         indexes: {
           unique: { token_filters: [] },
           ore: {},
@@ -152,7 +152,7 @@ describe('schema builders', () => {
       const col = encryptedColumn('raw')
       const built = col.build()
       expect(built).toEqual({
-        cast_as: 'string',
+        cast_as: 'text',
         indexes: {},
       })
     })
@@ -199,7 +199,7 @@ describe('schema builders', () => {
       expect(built.tableName).toBe('users')
       expect(built.columns).toEqual({
         email: {
-          cast_as: 'string',
+          cast_as: 'text',
           indexes: {
             unique: { token_filters: [] },
           },
@@ -253,7 +253,7 @@ describe('schema builders', () => {
         tables: {
           users: {
             email: {
-              cast_as: 'string',
+              cast_as: 'text',
               indexes: {
                 unique: { token_filters: [] },
               },
@@ -317,7 +317,7 @@ describe('schema builders', () => {
     it('defaults castAs to string', () => {
       const value = encryptedField('field')
       const built = value.build()
-      expect(built.cast_as).toBe('string')
+      expect(built.cast_as).toBe('text')
     })
 
     it('.dataType("json").build() produces correct shape', () => {
@@ -362,7 +362,7 @@ describe('schema builders', () => {
       expect(built.columns).toHaveProperty('firstName')
       expect(built.columns).toHaveProperty('lastName')
       expect(built.columns.firstName).toEqual({
-        cast_as: 'string',
+        cast_as: 'text',
         indexes: {},
       })
     })

packages/stack/package.json

@@ -180,7 +180,7 @@
 	},
 	"dependencies": {
 		"@byteslice/result": "^0.2.0",
-		"@cipherstash/protect-ffi": "0.20.1",
+		"@cipherstash/protect-ffi": "0.20.2",
 		"evlog": "^1.9.0",
 		"zod": "3.24.2"
 	},

packages/stack/src/encryption/index.ts

@@ -178,10 +178,7 @@ export class EncryptionClient {
    * @see {@link LockContext}
    * @see {@link EncryptOperation}
    */
-  encrypt(
-    plaintext: JsPlaintext,
-    opts: EncryptOptions,
-  ): EncryptOperation {
+  encrypt(plaintext: JsPlaintext, opts: EncryptOptions): EncryptOperation {
     return new EncryptOperation(this.client, plaintext, opts)
   }
 

packages/stack/src/schema/index.ts

@@ -15,6 +15,7 @@ import { z } from 'zod'
  * - `"number"`
  * - `"string"`
  * - `"json"`
+ * - `"text"`
  *
  * @remarks
  * This is a Zod enum used at runtime to validate schema definitions.
@@ -23,8 +24,8 @@ import { z } from 'zod'
  * @internal
  */
 export const castAsEnum = z
-  .enum(['bigint', 'boolean', 'date', 'number', 'string', 'json'])
-  .default('string')
+  .enum(['bigint', 'boolean', 'date', 'number', 'string', 'json', 'text'])
+  .default('text')
 
 const tokenFilterSchema = z.object({
   kind: z.literal('downcase'),
@@ -141,7 +142,7 @@ export class EncryptedField {
 
   constructor(valueName: string) {
     this.valueName = valueName
-    this.castAsValue = 'string'
+    this.castAsValue = 'text'
   }
 
   /**
@@ -162,13 +163,13 @@ export class EncryptedField {
    * ```
    */
   dataType(castAs: CastAs) {
-    this.castAsValue = castAs
+    this.castAsValue = castAs === 'string' ? 'text' : castAs
     return this
   }
 
   build() {
     return {
-      cast_as: this.castAsValue,
+      cast_as: this.castAsValue === 'string' ? 'text' : this.castAsValue,
       indexes: {},
     }
   }
@@ -211,7 +212,7 @@ export class EncryptedColumn {
    * ```
    */
   dataType(castAs: CastAs) {
-    this.castAsValue = castAs
+    this.castAsValue = castAs === 'string' ? 'text' : castAs
     return this
   }
 
@@ -337,7 +338,7 @@ export class EncryptedColumn {
 
   build() {
     return {
-      cast_as: this.castAsValue,
+      cast_as: this.castAsValue === 'string' ? 'text' : this.castAsValue,
       indexes: this.indexesValue,
     }
   }
@@ -595,11 +596,28 @@ export function encryptedField(valueName: string) {
   return new EncryptedField(valueName)
 }
 
-// ------------------------
-// Internal functions
-// ------------------------
-
-/** @internal */
+/**
+ * Build an encrypt config from a list of encrypted tables.
+ *
+ * @param ...tables - The list of encrypted tables to build the config from.
+ * @returns An encrypt config object.
+ *
+ * @example
+ * ```typescript
+ * import { buildEncryptConfig } from "@cipherstash/stack/schema"
+ *
+ * const users = encryptedTable("users", {
+ *   email: encryptedColumn("email").equality(),
+ * })
+ *
+ * const orders = encryptedTable("orders", {
+ *   amount: encryptedColumn("amount").dataType("number"),
+ * })
+ *
+ * const config = buildEncryptConfig(users, orders)
+ * console.log(config)
+ * ```
+ */
 export function buildEncryptConfig(
   ...protectTables: Array<EncryptedTable<EncryptedTableColumn>>
 ): EncryptConfig {