@getsecret/sdk
v2.0.2
Published
TypeScript client for the getsecret secure secrets HTTP API
Readme
@getsecret/sdk
TypeScript client for the GetSecret HTTP API.
Install
npm install @getsecret/sdk
pnpm add @getsecret/sdkMonorepo workspace:
{
"dependencies": {
"@getsecret/sdk": "workspace:*"
}
}Usage
import { createSecretClient } from "@getsecret/sdk";
const client = createSecretClient({
baseUrl: "https://api.getsecret.visionly.dev",
});
const created = await client.createSecret({
content: "my secret",
maxViews: 1,
});
const note = await client.getSecret(created.slug);
// created: { slug, expiresAt, maxViews }Browser apps should pass baseUrl from import.meta.env.VITE_API_URL. Same-origin dev can use baseUrl: "".
CLI
Install the separate @getsecret/cli package for terminal usage:
npm install -g @getsecret/cli
getsecret create "hello"API contract
Create responses: { slug, expiresAt, maxViews }. Website share links are built by each client app (not the SDK).
Legacy names
createNote / getNote and CreateNoteInput remain as aliases for createSecret / getSecret.
Releasing
Releases use Changesets from the monorepo root (not CI):
pnpm changeset— add a changeset after SDK changes merge.pnpm changeset:version— apply version bump and updateCHANGELOG.md.pnpm changeset:publish— build and publish to npm.
See .changeset/README.md for details.
