@inkbox/sdk 0.1.3 → 0.2.0

package/dist/vault/types.js

@@ -0,0 +1,225 @@
+/**
+ * inkbox-vault TypeScript SDK — public types.
+ *
+ * Includes API response types, raw JSON shapes, parsers,
+ * and client-side structured secret payloads.
+ */
+// ---- Enums ----
+/**
+ * Category of credential stored in a vault secret.
+ *
+ * Used as a client-side hint for which form to render. The server
+ * does not validate or enforce payload structure (it's opaque ciphertext).
+ */
+export const VaultSecretType = {
+    API_KEY: "api_key",
+    KEY_PAIR: "key_pair",
+    LOGIN: "login",
+    SSH_KEY: "ssh_key",
+    OTHER: "other",
+};
+/**
+ * Discriminator for vault key records.
+ *
+ * - `PRIMARY` — a standard vault key issued to users or agents.
+ * - `RECOVERY` — a recovery code generated at vault initialization.
+ */
+export const VaultKeyType = {
+    PRIMARY: "primary",
+    RECOVERY: "recovery",
+};
+/** @internal */
+export function parseAccessRule(r) {
+    return {
+        id: r.id,
+        vaultSecretId: r.vault_secret_id,
+        identityId: r.identity_id,
+        createdAt: new Date(r.created_at),
+    };
+}
+// ---- Parsers ----
+/** Parse a raw vault info response into a {@link VaultInfo}. @internal */
+export function parseVaultInfo(r) {
+    return {
+        id: r.id,
+        organizationId: r.organization_id,
+        status: r.status,
+        createdAt: new Date(r.created_at),
+        updatedAt: new Date(r.updated_at),
+        keyCount: r.key_count,
+        secretCount: r.secret_count,
+        recoveryKeyCount: r.recovery_key_count,
+    };
+}
+/** Parse a raw vault key response into a {@link VaultKey}. @internal */
+export function parseVaultKey(r) {
+    return {
+        id: r.id,
+        keyType: r.key_type,
+        createdBy: r.created_by,
+        status: r.status,
+        createdAt: new Date(r.created_at),
+        updatedAt: new Date(r.updated_at),
+    };
+}
+/** Parse a raw vault secret response into a {@link VaultSecret}. @internal */
+export function parseVaultSecret(r) {
+    return {
+        id: r.id,
+        name: r.name,
+        description: r.description,
+        secretType: r.secret_type,
+        status: r.status,
+        createdAt: new Date(r.created_at),
+        updatedAt: new Date(r.updated_at),
+    };
+}
+/** Parse a raw vault secret detail response into a {@link VaultSecretDetail}. @internal */
+export function parseVaultSecretDetail(r) {
+    return {
+        ...parseVaultSecret(r),
+        encryptedPayload: r.encrypted_payload,
+    };
+}
+// ---- Payload serialization (camelCase ↔ snake_case for JSON encryption) ----
+/**
+ * Serialize a payload into a plain object for encryption.
+ *
+ * Converts camelCase payload fields to the snake_case wire format
+ * stored inside the encrypted blob.
+ *
+ * @param secretType - The secret type string.
+ * @param payload - The structured payload to serialize.
+ * @returns A plain object ready for JSON stringification.
+ * @throws If `secretType` is unknown.
+ * @internal
+ */
+export function serializePayload(secretType, payload) {
+    switch (secretType) {
+        case "login": {
+            const p = payload;
+            const d = { password: p.password };
+            if (p.username !== undefined)
+                d.username = p.username;
+            if (p.email !== undefined)
+                d.email = p.email;
+            if (p.url !== undefined)
+                d.url = p.url;
+            if (p.notes !== undefined)
+                d.notes = p.notes;
+            return d;
+        }
+        case "other": {
+            const p = payload;
+            const d = { data: p.data };
+            if (p.notes !== undefined)
+                d.notes = p.notes;
+            return d;
+        }
+        case "ssh_key": {
+            const p = payload;
+            const d = { private_key: p.privateKey };
+            if (p.publicKey !== undefined)
+                d.public_key = p.publicKey;
+            if (p.fingerprint !== undefined)
+                d.fingerprint = p.fingerprint;
+            if (p.passphrase !== undefined)
+                d.passphrase = p.passphrase;
+            if (p.notes !== undefined)
+                d.notes = p.notes;
+            return d;
+        }
+        case "api_key": {
+            const p = payload;
+            const d = { api_key: p.apiKey };
+            if (p.endpoint !== undefined)
+                d.endpoint = p.endpoint;
+            if (p.notes !== undefined)
+                d.notes = p.notes;
+            return d;
+        }
+        case "key_pair": {
+            const p = payload;
+            const d = {
+                access_key: p.accessKey,
+                secret_key: p.secretKey,
+            };
+            if (p.endpoint !== undefined)
+                d.endpoint = p.endpoint;
+            if (p.notes !== undefined)
+                d.notes = p.notes;
+            return d;
+        }
+        default:
+            throw new Error(`Unknown secret_type: ${secretType}`);
+    }
+}
+/**
+ * Parse a decrypted plain object into the correct payload type.
+ *
+ * Converts snake_case wire-format fields back to camelCase.
+ *
+ * @param secretType - The secret type string.
+ * @param raw - The decrypted plain object.
+ * @returns The typed payload.
+ * @throws If `secretType` is unknown.
+ * @internal
+ */
+export function parsePayload(secretType, raw) {
+    switch (secretType) {
+        case "login":
+            return {
+                password: raw.password,
+                username: raw.username,
+                email: raw.email,
+                url: raw.url,
+                notes: raw.notes,
+            };
+        case "other":
+            return { data: raw.data, notes: raw.notes };
+        case "ssh_key":
+            return {
+                privateKey: raw.private_key,
+                publicKey: raw.public_key,
+                fingerprint: raw.fingerprint,
+                passphrase: raw.passphrase,
+                notes: raw.notes,
+            };
+        case "api_key":
+            return {
+                apiKey: raw.api_key,
+                endpoint: raw.endpoint,
+                notes: raw.notes,
+            };
+        case "key_pair":
+            return {
+                accessKey: raw.access_key,
+                secretKey: raw.secret_key,
+                endpoint: raw.endpoint,
+                notes: raw.notes,
+            };
+        default:
+            throw new Error(`Unknown secret_type: ${secretType}`);
+    }
+}
+/**
+ * Infer the `secretType` string from a payload's shape.
+ *
+ * @param payload - A secret payload object.
+ * @returns The inferred secret type string.
+ * @throws If the payload shape doesn't match any known type.
+ */
+export function inferSecretType(payload) {
+    if ("password" in payload)
+        return "login";
+    if ("privateKey" in payload)
+        return "ssh_key";
+    if ("apiKey" in payload)
+        return "api_key";
+    if ("accessKey" in payload && "secretKey" in payload)
+        return "key_pair";
+    if ("data" in payload)
+        return "other";
+    throw new Error("Cannot infer secret_type from payload shape");
+}
+//# sourceMappingURL=types.js.map

package/dist/vault/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/vault/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,kBAAkB;AAElB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;CACN,CAAC;AAGX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAqEX,gBAAgB;AAChB,MAAM,UAAU,eAAe,CAAC,CAAgB;IAC9C,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,aAAa,EAAE,CAAC,CAAC,eAAe;QAChC,UAAU,EAAE,CAAC,CAAC,WAAW;QACzB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AA4HD,oBAAoB;AAEpB,0EAA0E;AAC1E,MAAM,UAAU,cAAc,CAAC,CAAe;IAC5C,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,cAAc,EAAE,CAAC,CAAC,eAAe;QACjC,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,WAAW,EAAE,CAAC,CAAC,YAAY;QAC3B,gBAAgB,EAAE,CAAC,CAAC,kBAAkB;KACvC,CAAC;AACJ,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,aAAa,CAAC,CAAc;IAC1C,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,SAAS,EAAE,CAAC,CAAC,UAAU;QACvB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,gBAAgB,CAAC,CAAiB;IAChD,OAAO;QACL,EAAE,EAAE,CAAC,CAAC,EAAE;QACR,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,WAAW;QACzB,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;QACjC,SAAS,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,sBAAsB,CAAC,CAAuB;IAC5D,OAAO;QACL,GAAG,gBAAgB,CAAC,CAAC,CAAC;QACtB,gBAAgB,EAAE,CAAC,CAAC,iBAAiB;KACtC,CAAC;AACJ,CAAC;AAED,+EAA+E;AAE/E;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,gBAAgB,CAC9B,UAAkB,EAClB,OAAsB;IAEtB,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,CAAC,GAAG,OAAuB,CAAC;YAClC,MAAM,CAAC,GAA4B,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC5D,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;gBAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;YACtD,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,IAAI,CAAC,CAAC,GAAG,KAAK,SAAS;gBAAE,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;YACvC,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,CAAC,GAAG,OAAuB,CAAC;YAClC,MAAM,CAAC,GAA4B,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACpD,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,MAAM,CAAC,GAAG,OAAwB,CAAC;YACnC,MAAM,CAAC,GAA4B,EAAE,WAAW,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC;YACjE,IAAI,CAAC,CAAC,SAAS,KAAK,SAAS;gBAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC;YAC1D,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS;gBAAE,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;YAC/D,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS;gBAAE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;YAC5D,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD,KAAK,SAAS,CAAC,CAAC,CAAC;YACf,MAAM,CAAC,GAAG,OAAwB,CAAC;YACnC,MAAM,CAAC,GAA4B,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACzD,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;gBAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;YACtD,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,CAAC,GAAG,OAAyB,CAAC;YACpC,MAAM,CAAC,GAA4B;gBACjC,UAAU,EAAE,CAAC,CAAC,SAAS;gBACvB,UAAU,EAAE,CAAC,CAAC,SAAS;aACxB,CAAC;YACF,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS;gBAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;YACtD,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS;gBAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YAC7C,OAAO,CAAC,CAAC;QACX,CAAC;QACD;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,YAAY,CAC1B,UAAkB,EAClB,GAA4B;IAE5B,QAAQ,UAAU,EAAE,CAAC;QACnB,KAAK,OAAO;YACV,OAAO;gBACL,QAAQ,EAAE,GAAG,CAAC,QAAkB;gBAChC,QAAQ,EAAE,GAAG,CAAC,QAA8B;gBAC5C,KAAK,EAAE,GAAG,CAAC,KAA2B;gBACtC,GAAG,EAAE,GAAG,CAAC,GAAyB;gBAClC,KAAK,EAAE,GAAG,CAAC,KAA2B;aAChB,CAAC;QAC3B,KAAK,OAAO;YACV,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAc,EAAE,KAAK,EAAE,GAAG,CAAC,KAA2B,EAAyB,CAAC;QACrG,KAAK,SAAS;YACZ,OAAO;gBACL,UAAU,EAAE,GAAG,CAAC,WAAqB;gBACrC,SAAS,EAAE,GAAG,CAAC,UAAgC;gBAC/C,WAAW,EAAE,GAAG,CAAC,WAAiC;gBAClD,UAAU,EAAE,GAAG,CAAC,UAAgC;gBAChD,KAAK,EAAE,GAAG,CAAC,KAA2B;aACf,CAAC;QAC5B,KAAK,SAAS;YACZ,OAAO;gBACL,MAAM,EAAE,GAAG,CAAC,OAAiB;gBAC7B,QAAQ,EAAE,GAAG,CAAC,QAA8B;gBAC5C,KAAK,EAAE,GAAG,CAAC,KAA2B;aACf,CAAC;QAC5B,KAAK,UAAU;YACb,OAAO;gBACL,SAAS,EAAE,GAAG,CAAC,UAAoB;gBACnC,SAAS,EAAE,GAAG,CAAC,UAAoB;gBACnC,QAAQ,EAAE,GAAG,CAAC,QAA8B;gBAC5C,KAAK,EAAE,GAAG,CAAC,KAA2B;aACd,CAAC;QAC7B;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,EAAE,CAAC,CAAC;IAC1D,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,OAAsB;IACpD,IAAI,UAAU,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAC1C,IAAI,YAAY,IAAI,OAAO;QAAE,OAAO,SAAS,CAAC;IAC9C,IAAI,QAAQ,IAAI,OAAO;QAAE,OAAO,SAAS,CAAC;IAC1C,IAAI,WAAW,IAAI,OAAO,IAAI,WAAW,IAAI,OAAO;QAAE,OAAO,UAAU,CAAC;IACxE,IAAI,MAAM,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IACtC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;AACjE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkbox/sdk",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "TypeScript SDK for the Inkbox API",
   "license": "MIT",
   "type": "module",
@@ -13,7 +13,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
     "build": "tsc",
@@ -21,6 +22,9 @@
     "test:coverage": "vitest run --coverage",
     "prepublishOnly": "npm run build"
   },
+  "dependencies": {
+    "hash-wasm": "^4.11.0"
+  },
   "devDependencies": {
     "@types/node": "^25.5.0",
     "@vitest/coverage-v8": "^2.0.0",