CipherStashDocs
ReferenceStack SDK

Overview

The core @cipherstash/stack package for client-side encryption, searchable schemas, identity controls, and encrypted query operands.

@cipherstash/stack is the core TypeScript SDK for CipherStash. It encrypts and decrypts values in your application, defines the searchable capabilities of encrypted columns, and creates encrypted operands for queries against EQL.

Database and framework wrappers are separate packages. Use the Supabase, Prisma ORM 8, or Drizzle integration when you want encryption built into that library's query flow.

What the package provides

AreaPurpose
Encryption clientEncrypt and decrypt individual values, batches, and models.
Schema buildersDescribe tables, columns, value types, and searchable capabilities.
Query encryptionProduce typed encrypted operands for equality, range, and search queries.
Identity controlsBind encryption and decryption to federated identity claims.
DynamoDB helpersEncrypt and decrypt DynamoDB attributes and expressions.
Error typesInspect operation failures without parsing error messages.

Start here

Usage

Install the package, define an encrypted schema, and encrypt, query, and decrypt a value.

API reference

Browse the generated functions, classes, interfaces, and type aliases exported by the package.

The CipherCell

Understand the CipherCell, the CipherStash JSON format that stores ciphertext, searchable encrypted metadata, and fields for querying encrypted data via EQL.

Usage

Install @cipherstash/stack and use its core encryption client with an EQL v3 encrypted column.

On this page

What the package providesStart here