@sparkvault/sdk 1.0.0

package/dist/vaults/index.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Vaults Module
+ *
+ * Create and manage encrypted vaults and ingots.
+ * Uses Triple Zero-Trust encryption (SVMK + AMK + VMK).
+ */
+import type { ResolvedConfig } from '../config';
+import { HttpClient } from '../http';
+import type { CreateVaultOptions, Vault, UnsealedVault, VaultSummary, Ingot, UploadIngotOptions } from './types';
+export declare class VaultsModule {
+    private readonly http;
+    constructor(_config: ResolvedConfig, http: HttpClient);
+    /**
+     * Create a new encrypted vault.
+     * IMPORTANT: Store the VMK securely - it cannot be recovered!
+     *
+     * @example
+     * const vault = await sv.vaults.create({ name: 'My Vault' });
+     * console.log('Save this VMK:', vault.vmk);
+     */
+    create(options: CreateVaultOptions): Promise<Vault>;
+    /**
+     * Unseal a vault to access its contents.
+     * Returns a short-lived Vault Access Token (VAT).
+     *
+     * @example
+     * const unsealed = await sv.vaults.unseal('vlt_abc', vmk);
+     * console.log('Ingots:', unsealed.ingotCount);
+     */
+    unseal(vaultId: string, vmk: string): Promise<UnsealedVault>;
+    /**
+     * List all vaults for the account.
+     *
+     * @example
+     * const vaults = await sv.vaults.list();
+     * vaults.forEach(v => console.log(v.name));
+     */
+    list(): Promise<VaultSummary[]>;
+    /**
+     * Delete a vault and all its ingots.
+     * This action is irreversible!
+     *
+     * @example
+     * await sv.vaults.delete('vlt_abc', vmk);
+     */
+    delete(vaultId: string, vmk: string): Promise<void>;
+    /**
+     * Upload a file as an ingot to an unsealed vault.
+     *
+     * @example
+     * const ingot = await sv.vaults.uploadIngot(unsealed, {
+     *   file: myFile,
+     *   name: 'document.pdf'
+     * });
+     */
+    uploadIngot(vault: UnsealedVault, options: UploadIngotOptions): Promise<Ingot>;
+    /**
+     * Download an ingot from an unsealed vault.
+     *
+     * @example
+     * const blob = await sv.vaults.downloadIngot(unsealed, 'ing_abc');
+     * const url = URL.createObjectURL(blob);
+     */
+    downloadIngot(vault: UnsealedVault, ingotId: string): Promise<Blob>;
+    /**
+     * List all ingots in an unsealed vault.
+     *
+     * @example
+     * const ingots = await sv.vaults.listIngots(unsealed);
+     * ingots.forEach(i => console.log(i.name, i.size));
+     */
+    listIngots(vault: UnsealedVault): Promise<Ingot[]>;
+    /**
+     * Delete an ingot from an unsealed vault.
+     *
+     * @example
+     * await sv.vaults.deleteIngot(unsealed, 'ing_abc');
+     */
+    deleteIngot(vault: UnsealedVault, ingotId: string): Promise<void>;
+    private validateCreateOptions;
+    private validateUploadOptions;
+}
+export type { CreateVaultOptions, Vault, UnsealedVault, VaultSummary, Ingot, UploadIngotOptions, } from './types';

package/dist/vaults/types.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Vaults Module Types
+ */
+export interface CreateVaultOptions {
+    /** Vault name */
+    name: string;
+    /** Store VMK server-side (less secure, more convenient) */
+    hostedVmk?: boolean;
+}
+export interface Vault {
+    /** Vault ID */
+    id: string;
+    /** Vault name */
+    name: string;
+    /** Vault Master Key (24 chars) - STORE SECURELY! */
+    vmk: string;
+    /** Creation timestamp (Unix seconds) */
+    createdAt: number;
+    /** Whether VMK is hosted server-side */
+    hostedVmk: boolean;
+}
+export interface UnsealVaultOptions {
+    /** Vault ID */
+    vaultId: string;
+    /** Vault Master Key */
+    vmk: string;
+}
+export interface UnsealedVault {
+    /** Vault ID */
+    id: string;
+    /** Vault name */
+    name: string;
+    /** Vault Access Token (short-lived session) */
+    vatToken: string;
+    /** VAT expiry timestamp (Unix seconds) */
+    expiresAt: number;
+    /** Number of ingots in vault */
+    ingotCount: number;
+    /** Total storage used in bytes */
+    storageBytes: number;
+}
+export interface VaultSummary {
+    /** Vault ID */
+    id: string;
+    /** Vault name */
+    name: string;
+    /** Creation timestamp (Unix seconds) */
+    createdAt: number;
+    /** Number of ingots */
+    ingotCount: number;
+    /** Total storage used in bytes */
+    storageBytes: number;
+    /** Whether VMK is hosted server-side */
+    hostedVmk: boolean;
+}
+export interface Ingot {
+    /** Ingot ID */
+    id: string;
+    /** Ingot name */
+    name: string;
+    /** Content type (MIME) */
+    contentType: string;
+    /** Size in bytes */
+    size: number;
+    /** Creation timestamp (Unix seconds) */
+    createdAt: number;
+    /** Ingot type: 'standard' or 'structured' */
+    type: 'standard' | 'structured';
+}
+export interface UploadIngotOptions {
+    /** File to upload */
+    file: File | Blob;
+    /** Optional name (defaults to file name) */
+    name?: string;
+    /** Content type (auto-detected if not provided) */
+    contentType?: string;
+}
+export interface CreateVaultResponse {
+    vault_id: string;
+    name: string;
+    vmk: string;
+    created_at: number;
+    hosted_vmk: boolean;
+}
+export interface UnsealVaultResponse {
+    vault_id: string;
+    name: string;
+    vat_token: string;
+    expires_at: number;
+    ingot_count: number;
+    storage_bytes: number;
+}
+export interface ListVaultsResponse {
+    vaults: {
+        vault_id: string;
+        name: string;
+        created_at: number;
+        ingot_count: number;
+        storage_bytes: number;
+        hosted_vmk: boolean;
+    }[];
+}
+export interface ListIngotsResponse {
+    ingots: {
+        ingot_id: string;
+        name: string;
+        content_type: string;
+        size_bytes: number;
+        created_at: number;
+        ingot_type: 'standard' | 'structured';
+    }[];
+}
+export interface CreateIngotResponse {
+    ingot_id: string;
+    name: string;
+    content_type: string;
+    size_bytes: number;
+    created_at: number;
+    ingot_type: 'standard' | 'structured';
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@sparkvault/sdk",
+  "version": "1.0.0",
+  "description": "SparkVault JavaScript SDK - Identity, Sparks, Vaults, and RNG",
+  "type": "module",
+  "main": "dist/sparkvault.cjs.js",
+  "module": "dist/sparkvault.esm.js",
+  "browser": "dist/sparkvault.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "build:watch": "rollup -c -w",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "sparkvault",
+    "identity",
+    "authentication",
+    "encryption",
+    "cryptography",
+    "passkey",
+    "webauthn",
+    "totp",
+    "vault",
+    "rng"
+  ],
+  "author": "SparkVault",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Spark-Vault/sdk-js.git"
+  },
+  "homepage": "https://sparkvault.com/api/docs/sdk",
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "@rollup/plugin-commonjs": "^28.0.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.0",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "jsdom": "^25.0.0",
+    "rollup": "^4.0.0",
+    "rollup-plugin-dts": "^6.0.0",
+    "tslib": "^2.8.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}