Skip to content

Commit 66e46ea

Browse files
authored
Merge pull request #344 from cipherstash/rebrand
feat: support cipherstash rebrand
2 parents 0d19d53 + c501bd6 commit 66e46ea

File tree

7 files changed

+31
-22
lines changed

7 files changed

+31
-22
lines changed

.changeset/flat-shirts-marry.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@cipherstash/stack": minor
3+
"@cipherstash/cli": minor
4+
---
5+
6+
Support CipherStash rebrand with new docs links.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
<a href="https://cipherstash.com">
33
<img alt="CipherStash Logo" loading="lazy" width="128" height="128" decoding="async" data-nimg="1" style="color:transparent" src="https://cipherstash.com/assets/cs-github.png">
44
</a>
5-
<h1>Data security Stack for TypeScript</h1>
5+
<h1>CipherStash Stack for TypeScript</h1>
66

77
<a href="https://cipherstash.com"><img alt="Built by CipherStash" src="https://raw.githubusercontent.com/cipherstash/meta/refs/heads/main/csbadge.svg?style=for-the-badge&labelColor=000"></a>
8-
<a href="https://github.com/cipherstash/protectjs/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/@cipherstash/protect.svg?style=for-the-badge&labelColor=000000"></a>
8+
<a href="https://github.com/cipherstash/stack/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/@cipherstash/stack.svg?style=for-the-badge&labelColor=000000"></a>
99
<a href="https://cipherstash.com/docs"><img alt="Docs" src="https://img.shields.io/badge/Docs-333333.svg?style=for-the-badge&logo=readthedocs&labelColor=333"></a>
1010
<a href="https://discord.gg/5qwXUFb6PB"><img alt="Join the community on Discord" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20"></a>
1111

1212
</div>
1313

1414
## What is the stack?
1515

16-
- [Encryption](https://cipherstash.com/docs/stack/encryption): Field-level encryption for TypeScript apps with searchable encrypted queries, zero-knowledge key management, and first-class ORM support.
17-
- [Secrets](https://cipherstash.com/docs/stack/secrets): Zero-trust secrets management with end-to-end encryption. Plaintext never leaves your application.
16+
- [Encryption](https://cipherstash.com/docs/stack/cipherstash/encryption): Field-level encryption for TypeScript apps with searchable encrypted queries, zero-knowledge key management, and first-class ORM support.
17+
- [Secrets](https://cipherstash.com/docs/stack/cipherstash/secrets): Zero-trust secrets management with end-to-end encryption. Plaintext never leaves your application.
1818

1919
## Quick look at the stack in action
2020

@@ -78,21 +78,21 @@ bun add @cipherstash/stack
7878
> [!IMPORTANT]
7979
> **You need to opt out of bundling when using `@cipherstash/stack`.**
8080
> It uses Node.js specific features and requires the native Node.js `require`.
81-
> Read more about bundling in the [documentation](https://cipherstash.com/docs/stack/encryption/bundling).
81+
> Read more about bundling in the [documentation](https://cipherstash.com/docs/stack/deploy/bundling).
8282
8383
## Features
8484

85-
- **[Searchable encryption](https://cipherstash.com/docs/stack/platform/searchable-encryption)**: query encrypted data with equality, free text search, range, and [JSONB queries](https://cipherstash.com/docs/stack/encryption/searchable-encryption#jsonb-queries-with-searchablejson).
86-
- **[Type-safe schema](https://cipherstash.com/docs/stack/encryption/schema)**: define encrypted tables and columns with `encryptedTable` / `encryptedColumn`
87-
- **[Model & bulk operations](https://cipherstash.com/docs/stack/encryption/encrypt-decrypt#model-operations)**: encrypt and decrypt entire objects or batches with `encryptModel` / `bulkEncryptModels`.
88-
- **[Identity-aware encryption](https://cipherstash.com/docs/stack/encryption/identity)**: bind encryption to user identity with lock contexts for policy-based access control.
89-
- **[Secrets management](https://cipherstash.com/docs/stack/secrets)**: store and retrieve encrypted secrets via the Secrets SDK and CLI.
85+
- **[Searchable encryption](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption)**: query encrypted data with equality, free text search, range, and [JSONB queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption#jsonb-queries-with-searchablejson).
86+
- **[Type-safe schema](https://cipherstash.com/docs/stack/cipherstash/encryption/schema)**: define encrypted tables and columns with `encryptedTable` / `encryptedColumn`
87+
- **[Model & bulk operations](https://cipherstash.com/docs/stack/cipherstash/encryption/encrypt-decrypt#model-operations)**: encrypt and decrypt entire objects or batches with `encryptModel` / `bulkEncryptModels`.
88+
- **[Identity-aware encryption](https://cipherstash.com/docs/stack/cipherstash/encryption/identity)**: bind encryption to user identity with lock contexts for policy-based access control.
89+
- **[Secrets management](https://cipherstash.com/docs/stack/cipherstash/secrets)**: store and retrieve encrypted secrets via the Secrets SDK and CLI.
9090

9191
## Integrations
9292

93-
- [Encryption + Drizzle](https://cipherstash.com/docs/stack/encryption/drizzle)
94-
- [Encryption + Supabase](https://cipherstash.com/docs/stack/encryption/supabase)
95-
- [Encryption + DynamoDB](https://cipherstash.com/docs/stack/encryption/dynamodb)
93+
- [Encryption + Drizzle](https://cipherstash.com/docs/stack/cipherstash/encryption/drizzle)
94+
- [Encryption + Supabase](https://cipherstash.com/docs/stack/cipherstash/encryption/supabase)
95+
- [Encryption + DynamoDB](https://cipherstash.com/docs/stack/cipherstash/encryption/dynamodb)
9696

9797
## Use cases
9898

@@ -103,8 +103,8 @@ bun add @cipherstash/stack
103103
## Documentation
104104

105105
- [Documentation](https://cipherstash.com/docs)
106-
- [Encryption getting started guide](https://cipherstash.com/docs/stack/encryption/getting-started)
107-
- [Secrets getting started guide](https://cipherstash.com/docs/stack/secrets/getting-started)
106+
- [Encryption getting started guide](https://cipherstash.com/docs/stack/quickstart)
107+
- [Secrets getting started guide](https://cipherstash.com/docs/stack/cipherstash/secrets/getting-started)
108108
- [SDK and API reference](https://cipherstash.com/docs/stack/reference)
109109

110110
## Contributing

packages/cli/src/commands/init/providers/base.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ export function createBaseProvider(): InitProvider {
2020
`Customize your schema: npx @cipherstash/cli wizard (AI-guided, automated) — or ${manualEdit}`,
2121
)
2222

23-
steps.push('Read the docs: https://cipherstash.com/docs')
23+
steps.push('Quickstart: https://cipherstash.com/docs/stack/quickstart')
24+
steps.push('Dashboard: https://dashboard.cipherstash.com/workspaces')
2425

2526
return steps
2627
},

packages/cli/src/commands/init/providers/drizzle.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ export function createDrizzleProvider(): InitProvider {
2121
)
2222

2323
steps.push(
24-
'Drizzle guide: https://cipherstash.com/docs/stack/encryption/drizzle',
24+
'Drizzle guide: https://cipherstash.com/docs/stack/cipherstash/encryption/drizzle',
25+
'Dashboard: https://dashboard.cipherstash.com/workspaces',
2526
'Need help? Discord or support@cipherstash.com',
2627
)
2728

packages/cli/src/commands/init/providers/supabase.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ export function createSupabaseProvider(): InitProvider {
2525
)
2626

2727
steps.push(
28-
'Supabase guide: https://cipherstash.com/docs/stack/encryption/supabase',
28+
'Supabase guide: https://cipherstash.com/docs/stack/cipherstash/supabase',
29+
'Dashboard: https://dashboard.cipherstash.com/workspaces',
2930
'Need help? #supabase in Discord or support@cipherstash.com',
3031
)
3132

packages/stack/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ For production, CI/CD, and deployed environments, you'll need to set up machine
507507
| `CS_CLIENT_KEY` | Client key material used with ZeroKMS for encryption |
508508
| `CS_CLIENT_ACCESS_KEY` | API key for authenticating with the CipherStash API |
509509

510-
See the [Going to Production](https://cipherstash.com/docs/stack/going-to-production) guide for full details on creating machine clients, setting up access keys, and configuring CI/CD pipelines.
510+
See the [Going to Production](https://cipherstash.com/docs/stack/deploy/going-to-production) guide for full details on creating machine clients, setting up access keys, and configuring CI/CD pipelines.
511511

512512
### Programmatic Config
513513

packages/stack/src/types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,9 @@ export type DecryptionResult<T> = DecryptionSuccess<T> | DecryptionError<T>
200200
/**
201201
* User-facing query type names for encrypting query values.
202202
*
203-
* - `'equality'`: Exact match. [Exact Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/exact)
204-
* - `'freeTextSearch'`: Text search. [Match Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/match)
205-
* - `'orderAndRange'`: Comparison and range. [Range Queries](https://cipherstash.com/docs/platform/searchable-encryption/supported-queries/range)
203+
* - `'equality'`: Exact match. [Exact Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption)
204+
* - `'freeTextSearch'`: Text search. [Match Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption)
205+
* - `'orderAndRange'`: Comparison and range. [Range Queries](https://cipherstash.com/docs/stack/cipherstash/encryption/searchable-encryption)
206206
* - `'steVecSelector'`: JSONPath selector (e.g. `'$.user.email'`)
207207
* - `'steVecTerm'`: Containment (e.g. `{ role: 'admin' }`)
208208
* - `'searchableJson'`: Auto-infers selector or term from plaintext type (recommended)

0 commit comments

Comments
 (0)