☕ JavaScript & TypeScript clients for CipherStash

This project contains the JavaScript/TypeScript clients for CipherStash. The clients are used for adding CipherStash’s Queryable Application Level Encryption (QuALE) into your backend node applications.

Documentation

• All Usage Documentation
• API Docs

Package list

Clients

Name	Docs	NPM	Description
Stash CLI	Usage		A CLI for working with CipherStash
Stash.js	Usage, TS Doc, Examples		Low level TypeScript/JavaScript client for working with CipherStash
Stash.js TypeORM	TS Doc, Example		Integrate TypeORM with CipherStash
Stash.js Adapter			Migrate types from existing databases (such as Prisma) to a CipherStash collection

Low-level libraries

You probably won't need to use these directly but we'll list them here just in case.

• Stash.js gRPC: Node bindings to the CipherStash gRPC endpoint
• StashRS: Node bindings to the CipherStash ore.rs and cipherstash-client Rust libraries

Utilities:

• Stash TypeDoc: Typedoc generation

Need help?

Head over to our support forum, and we'll get back to you super quick!

Developing

This monorepo uses ASDF to manage required dependencies. You can see the dependencies in the .tool-versions file in the root of the repo.

If you're comfortable with installing ASDF and using it to manage your dependencies, follow the instructions here).

From the root of this repo, run:

# Installs the ASDF plugins and all dependencies in .tool-versions
./build.sh setup

# Build all the components
./build.sh build

This will get you to a state that you can start developing individual components.

How these packages interrelate

This is the dependency graph