-
Notifications
You must be signed in to change notification settings - Fork 3
feat: remove secrets and mark as coming soon #346
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@cipherstash/stack": minor | ||
| "@cipherstash/cli": minor | ||
| --- | ||
|
|
||
| Mark secrets as a coming soon feature and remove existing SDK integration. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,7 +14,6 @@ | |
| ## What is the stack? | ||
|
|
||
| - [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. | ||
| - [Secrets](https://cipherstash.com/docs/stack/cipherstash/secrets): Zero-trust secrets management with end-to-end encryption. Plaintext never leaves your application. | ||
|
|
||
| ## Quick look at the stack in action | ||
|
|
||
|
|
@@ -48,21 +47,6 @@ if (decryptResult.failure) { | |
| // decryptResult.data => "secret@example.com" | ||
| ``` | ||
|
|
||
| **Secrets** | ||
|
|
||
| ```typescript | ||
| import { Secrets } from "@cipherstash/stack"; | ||
|
|
||
| // 1. Initialize the secrets client | ||
| const secrets = new Secrets({ environment: "production" }); | ||
|
|
||
| // 2. Set a secret with the SDK or the CLI | ||
| await secrets.set("DATABASE_URL", "postgres://user:pass@host:5432/db"); | ||
|
|
||
| // 3. Consume the secret in your application | ||
| const secret = await secrets.get("DATABASE_URL"); | ||
| ``` | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
|
|
@@ -86,7 +70,6 @@ bun add @cipherstash/stack | |
| - **[Type-safe schema](https://cipherstash.com/docs/stack/cipherstash/encryption/schema)**: define encrypted tables and columns with `encryptedTable` / `encryptedColumn` | ||
| - **[Model & bulk operations](https://cipherstash.com/docs/stack/cipherstash/encryption/encrypt-decrypt#model-operations)**: encrypt and decrypt entire objects or batches with `encryptModel` / `bulkEncryptModels`. | ||
| - **[Identity-aware encryption](https://cipherstash.com/docs/stack/cipherstash/encryption/identity)**: bind encryption to user identity with lock contexts for policy-based access control. | ||
| - **[Secrets management](https://cipherstash.com/docs/stack/cipherstash/secrets)**: store and retrieve encrypted secrets via the Secrets SDK and CLI. | ||
|
|
||
| ## Integrations | ||
|
|
||
|
|
@@ -97,14 +80,12 @@ bun add @cipherstash/stack | |
| ## Use cases | ||
|
|
||
| - **Trusted data access**: ensure only your end-users can access their sensitive data using identity-bound encryption | ||
| - **Sensitive config management**: store API keys and database credentials with zero-trust encryption and full audit trails | ||
| - **Reduce breach impact**: limit the blast radius of exploited vulnerabilities to only the data the affected user can decrypt | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Documentation](https://cipherstash.com/docs) | ||
| - [Encryption getting started guide](https://cipherstash.com/docs/stack/quickstart) | ||
| - [Secrets getting started guide](https://cipherstash.com/docs/stack/cipherstash/secrets/getting-started) | ||
| - [Quickstart](https://cipherstash.com/docs/stack/quickstart) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Documentation change depends on complete secrets removal. The update to a unified "Quickstart" link is appropriate for removing secrets documentation. However, this change assumes secrets have been fully removed from the SDK and CLI, which may not be the case based on the critical inconsistency identified in the changeset (see comment on Ensure secrets code is actually removed before merging documentation changes that eliminate references to the feature. 🤖 Prompt for AI Agents |
||
| - [SDK and API reference](https://cipherstash.com/docs/stack/reference) | ||
|
|
||
| ## Contributing | ||
|
|
||
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
Repository: cipherstash/stack
Length of output: 878
Critical inconsistency: Changeset claims SDK integration removed, but secrets code remains active in the codebase.
The changeset states "remove existing SDK integration," but the evidence reveals incomplete removal:
packages/protect/src/bin/stash.ts(lines 398, 442) still defines and registerssecretsRouteMapwith all secrets commands in the route map.packages/protect/src/stash/index.tsstill exports theStashclass and multiple secret-related interfaces (SecretMetadata,ListSecretsResponse,GetSecretResponse,DecryptedSecretResponse).While CLI command files appear to have been removed, the route integration and SDK exports remain, making the changeset description misleading. Users reading "remove existing SDK integration" will expect secrets to be unavailable, but the
Stashclient still exposes full secrets management capabilities.Either complete the removal by deleting the route registration and SDK exports, or update the changeset description to reflect the actual state.
🤖 Prompt for AI Agents