@vibr8vault/sdk 0.5.0

package/README.md

@@ -0,0 +1,142 @@
+# @vibr8vault/sdk
+
+TypeScript SDK for [Vibr8Vault](https://vault.vibr8lab.work) — a self-hosted secrets manager.
+
+## Installation
+
+```bash
+npm install @vibr8vault/sdk
+```
+
+## Quick Start
+
+```typescript
+import { Vibr8Vault } from "@vibr8vault/sdk";
+
+const vault = new Vibr8Vault({
+  address: "http://localhost:8200",
+  token: "your-service-token",
+});
+
+// Read a secret
+const secret = await vault.secrets.read("apps/backend/prod");
+console.log(secret.data.DB_PASSWORD);
+
+// List secrets under a prefix
+const listing = await vault.secrets.list("apps/");
+console.log(listing.keys);
+
+// Check vault health
+const health = await vault.sys.health();
+console.log(health.status);
+```
+
+## API Reference
+
+### Secrets
+
+```typescript
+vault.secrets.read(path, { version? })        // Read a secret (optionally a specific version)
+vault.secrets.write(path, data)                // Write key-value pairs to a path
+vault.secrets.delete(path, { hard? })          // Soft-delete (or hard-delete) a secret
+vault.secrets.list(prefix)                     // List secret paths under a prefix
+vault.secrets.versions(path)                   // List all versions of a secret
+```
+
+Namespace-scoped variants: `readNs`, `writeNs`, `deleteNs`, `listNs`, `versionsNs` — each takes `ns` as the first argument.
+
+### Tokens
+
+```typescript
+vault.tokens.create({ type?, ttl?, policies?, max_uses? })
+vault.tokens.revoke(id)
+vault.tokens.list()
+```
+
+### Auth
+
+```typescript
+vault.auth.login(username, password);
+vault.auth.me();
+```
+
+### Users
+
+```typescript
+vault.users.create({ username, password, policies? })
+vault.users.list()
+vault.users.get(id)
+vault.users.update(id, { password?, policies? })
+vault.users.delete(id)
+```
+
+### System
+
+```typescript
+vault.sys.health();
+vault.sys.status();
+vault.sys.init();
+vault.sys.unseal(key);
+vault.sys.seal();
+vault.sys.rotate();
+```
+
+### Namespaces
+
+```typescript
+vault.namespaces.list();
+vault.namespaces.get(name);
+vault.namespaces.create(name);
+vault.namespaces.delete(name);
+```
+
+### Policies
+
+```typescript
+vault.policies.list(ns?)
+vault.policies.get(name, ns?)
+vault.policies.create(yaml, ns?)
+vault.policies.delete(name, ns?)
+```
+
+### Audit
+
+```typescript
+vault.audit.list({ action?, username?, namespace?, severity?, limit?, offset?, ... })
+```
+
+### Client Management
+
+```typescript
+vault.setToken(token); // Change the auth token after construction
+```
+
+Constructor options:
+
+```typescript
+new Vibr8Vault({ address: string, token?: string })
+```
+
+## Error Handling
+
+```typescript
+import { Vibr8Vault, Vibr8VaultError } from "@vibr8vault/sdk";
+
+const vault = new Vibr8Vault({
+  address: "http://localhost:8200",
+  token: "your-token",
+});
+
+try {
+  const secret = await vault.secrets.read("nonexistent/path");
+} catch (e) {
+  if (e instanceof Vibr8VaultError) {
+    console.log(`Error: ${e.message} (HTTP ${e.status})`);
+  }
+}
+```
+
+## Requirements
+
+- Node.js 18+
+- A running Vibr8Vault instance

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@vibr8vault/sdk",
+  "version": "0.5.0",
+  "description": "TypeScript SDK for Vibr8Vault secrets manager",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "author": "Vibr8Soft",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vibr8soft/Vibr8Vault-TypeScript-sdk.git",
+    "directory": "lib/sdk/typescript"
+  },
+  "homepage": "https://github.com/vibr8soft/Vibr8Vault-TypeScript-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/vibr8soft/Vibr8Vault-TypeScript-sdk/issues"
+  },
+  "keywords": [
+    "vibr8vault",
+    "secrets",
+    "vault",
+    "secrets-manager",
+    "sdk",
+    "typescript"
+  ],
+  "sideEffects": false
+}