Skip to content

feat(stack): usability improvements #301

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.

Sign up for GitHub

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

Merged
calvinbrewer merged 6 commits into from
Feb 25, 2026
Merged

feat(stack): usability improvements #301

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b7288b
feat(stack): remove null from Encrypted type
calvinbrewer Feb 24, 2026
5c3f4e7
chore: changeset
calvinbrewer Feb 24, 2026
070c5ea
docs: update
calvinbrewer Feb 24, 2026
02249de
fix: default to text for encrypt config
calvinbrewer Feb 24, 2026
bd192bd
Merge branch 'main' of https://github.com/cipherstash/protectjs into …
calvinbrewer Feb 25, 2026
c447e26
chore: pr feedback
calvinbrewer Feb 25, 2026
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
5 changes: 5 additions & 0 deletions .changeset/fresh-phones-smile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@cipherstash/stack": minor
---

Remove null support from encrypt and bulk encrypt operations to improve typescript support and reduce operation complexity.
185 changes: 2 additions & 183 deletions packages/stack/__tests__/bulk-protect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,66 +96,8 @@ describe('bulk encryption and decryption', () => {
expect(encryptedData.data[2].data).toHaveProperty('c')
}, 30000)

it('should handle null values in bulk encrypt', async () => {
const plaintexts = [
{ id: 'user1', plaintext: 'alice@example.com' },
{ id: 'user2', plaintext: null },
{ id: 'user3', plaintext: 'charlie@example.com' },
]

const encryptedData = await protectClient.bulkEncrypt(plaintexts, {
column: users.email,
table: users,
})

if (encryptedData.failure) {
throw new Error(`[protect]: ${encryptedData.failure.message}`)
}

// Verify structure
expect(encryptedData.data).toHaveLength(3)
expect(encryptedData.data[0]).toHaveProperty('id', 'user1')
expect(encryptedData.data[0]).toHaveProperty('data')
expect(encryptedData.data[0].data).toHaveProperty('c')
expect(encryptedData.data[1]).toHaveProperty('id', 'user2')
expect(encryptedData.data[1]).toHaveProperty('data')
expect(encryptedData.data[1].data).toBeNull()
expect(encryptedData.data[2]).toHaveProperty('id', 'user3')
expect(encryptedData.data[2]).toHaveProperty('data')
expect(encryptedData.data[2].data).toHaveProperty('c')
}, 30000)

it('should handle all null values in bulk encrypt', async () => {
const plaintexts = [
{ id: 'user1', plaintext: null },
{ id: 'user2', plaintext: null },
{ id: 'user3', plaintext: null },
]

const encryptedData = await protectClient.bulkEncrypt(plaintexts, {
column: users.email,
table: users,
})

if (encryptedData.failure) {
throw new Error(`[protect]: ${encryptedData.failure.message}`)
}

// Verify structure
expect(encryptedData.data).toHaveLength(3)
expect(encryptedData.data[0]).toHaveProperty('id', 'user1')
expect(encryptedData.data[0]).toHaveProperty('data')
expect(encryptedData.data[0].data).toBeNull()
expect(encryptedData.data[1]).toHaveProperty('id', 'user2')
expect(encryptedData.data[1]).toHaveProperty('data')
expect(encryptedData.data[1].data).toBeNull()
expect(encryptedData.data[2]).toHaveProperty('id', 'user3')
expect(encryptedData.data[2]).toHaveProperty('data')
expect(encryptedData.data[2].data).toBeNull()
}, 30000)

it('should handle empty array in bulk encrypt', async () => {
const plaintexts: Array<{ id?: string; plaintext: string | null }> = []
const plaintexts: Array<{ id?: string; plaintext: string }> = []

const encryptedData = await protectClient.bulkEncrypt(plaintexts, {
column: users.email,
Expand Down Expand Up @@ -245,77 +187,6 @@ describe('bulk encryption and decryption', () => {
)
}, 30000)

it('should handle null values in bulk decrypt', async () => {
// First encrypt some data with nulls
const plaintexts = [
{ id: 'user1', plaintext: 'alice@example.com' },
{ id: 'user2', plaintext: null },
{ id: 'user3', plaintext: 'charlie@example.com' },
]

const encryptedData = await protectClient.bulkEncrypt(plaintexts, {
column: users.email,
table: users,
})

if (encryptedData.failure) {
throw new Error(`[protect]: ${encryptedData.failure.message}`)
}

// Now decrypt the data
const decryptedData = await protectClient.bulkDecrypt(encryptedData.data)

if (decryptedData.failure) {
throw new Error(`[protect]: ${decryptedData.failure.message}`)
}

// Verify structure
expect(decryptedData.data).toHaveLength(3)
expect(decryptedData.data[0]).toHaveProperty('id', 'user1')
expect(decryptedData.data[0]).toHaveProperty('data', 'alice@example.com')
expect(decryptedData.data[1]).toHaveProperty('id', 'user2')
expect(decryptedData.data[1]).toHaveProperty('data', null)
expect(decryptedData.data[2]).toHaveProperty('id', 'user3')
expect(decryptedData.data[2]).toHaveProperty(
'data',
'charlie@example.com',
)
}, 30000)

it('should handle all null values in bulk decrypt', async () => {
// First encrypt some data with all nulls
const plaintexts = [
{ id: 'user1', plaintext: null },
{ id: 'user2', plaintext: null },
{ id: 'user3', plaintext: null },
]

const encryptedData = await protectClient.bulkEncrypt(plaintexts, {
column: users.email,
table: users,
})

if (encryptedData.failure) {
throw new Error(`[protect]: ${encryptedData.failure.message}`)
}

// Now decrypt the data
const decryptedData = await protectClient.bulkDecrypt(encryptedData.data)

if (decryptedData.failure) {
throw new Error(`[protect]: ${decryptedData.failure.message}`)
}

// Verify structure
expect(decryptedData.data).toHaveLength(3)
expect(decryptedData.data[0]).toHaveProperty('id', 'user1')
expect(decryptedData.data[0]).toHaveProperty('data', null)
expect(decryptedData.data[1]).toHaveProperty('id', 'user2')
expect(decryptedData.data[1]).toHaveProperty('data', null)
expect(decryptedData.data[2]).toHaveProperty('id', 'user3')
expect(decryptedData.data[2]).toHaveProperty('data', null)
}, 30000)

it('should handle empty array in bulk decrypt', async () => {
const encryptedPayloads: Array<{ id?: string; data: Encrypted }> = []

Expand Down Expand Up @@ -399,57 +270,6 @@ describe('bulk encryption and decryption', () => {
)
}, 30000)

it('should handle null values with lock context', async () => {
const userJwt = process.env.USER_JWT

if (!userJwt) {
console.log('Skipping lock context test - no USER_JWT provided')
return
}

const lc = new LockContext()
const lockContext = await lc.identify(userJwt)

if (lockContext.failure) {
throw new Error(`[protect]: ${lockContext.failure.message}`)
}

const plaintexts = [
{ id: 'user1', plaintext: 'alice@example.com' },
{ id: 'user2', plaintext: null },
{ id: 'user3', plaintext: 'charlie@example.com' },
]

// Encrypt with lock context
const encryptedData = await protectClient
.bulkEncrypt(plaintexts, {
column: users.email,
table: users,
})
.withLockContext(lockContext.data)

if (encryptedData.failure) {
throw new Error(`[protect]: ${encryptedData.failure.message}`)
}

// Verify null is preserved
expect(encryptedData.data[1]).toHaveProperty('data')
expect(encryptedData.data[1].data).toBeNull()

// Decrypt with lock context
const decryptedData = await protectClient
.bulkDecrypt(encryptedData.data)
.withLockContext(lockContext.data)

if (decryptedData.failure) {
throw new Error(`[protect]: ${decryptedData.failure.message}`)
}

// Verify null is preserved
expect(decryptedData.data[1]).toHaveProperty('data')
expect(decryptedData.data[1].data).toBeNull()
}, 30000)

it('should decrypt mixed lock context payloads with specific lock context', async () => {
const userJwt = process.env.USER_JWT
const user2Jwt = process.env.USER_2_JWT
Expand Down Expand Up @@ -533,8 +353,7 @@ describe('bulk encryption and decryption', () => {
const originalData = [
{ id: 'user1', plaintext: 'alice@example.com' },
{ id: 'user2', plaintext: 'bob@example.com' },
{ id: 'user3', plaintext: null },
{ id: 'user4', plaintext: 'dave@example.com' },
{ id: 'user3', plaintext: 'dave@example.com' },
]

// Encrypt
Expand Down
Loading