@debros/network-ts-sdk 0.6.2 → 0.7.0

package/src/vault/transport/index.ts

@@ -0,0 +1,19 @@
+export { GuardianClient, GuardianError } from './guardian';
+export { fanOut, fanOutIndexed, withTimeout, withRetry } from './fanout';
+export type {
+  GuardianEndpoint,
+  GuardianErrorCode,
+  GuardianInfo,
+  HealthResponse,
+  StatusResponse,
+  PushResponse,
+  PullResponse,
+  StoreSecretResponse,
+  GetSecretResponse,
+  DeleteSecretResponse,
+  ListSecretsResponse,
+  SecretEntry,
+  ChallengeResponse,
+  SessionResponse,
+  FanOutResult,
+} from './types';

package/src/vault/transport/types.ts

@@ -0,0 +1,101 @@
+/** A guardian node endpoint. */
+export interface GuardianEndpoint {
+  address: string;
+  port: number;
+}
+
+/** V1 push response. */
+export interface PushResponse {
+  status: string;
+}
+
+/** V1 pull response. */
+export interface PullResponse {
+  share: string; // base64
+}
+
+/** V2 store response. */
+export interface StoreSecretResponse {
+  status: string;
+  name: string;
+  version: number;
+}
+
+/** V2 get response. */
+export interface GetSecretResponse {
+  share: string; // base64
+  name: string;
+  version: number;
+  created_ns: number;
+  updated_ns: number;
+}
+
+/** V2 delete response. */
+export interface DeleteSecretResponse {
+  status: string;
+  name: string;
+}
+
+/** V2 list response. */
+export interface ListSecretsResponse {
+  secrets: SecretEntry[];
+}
+
+/** An entry in the list secrets response. */
+export interface SecretEntry {
+  name: string;
+  version: number;
+  size: number;
+}
+
+/** Health check response. */
+export interface HealthResponse {
+  status: string;
+  version: string;
+}
+
+/** Status response. */
+export interface StatusResponse {
+  status: string;
+  version: string;
+  data_dir: string;
+  client_port: number;
+  peer_port: number;
+}
+
+/** Guardian info response. */
+export interface GuardianInfo {
+  guardians: Array<{ address: string; port: number }>;
+  threshold: number;
+  total: number;
+}
+
+/** Challenge response from auth endpoint. */
+export interface ChallengeResponse {
+  nonce: string;
+  created_ns: number;
+  tag: string;
+}
+
+/** Session token response from auth endpoint. */
+export interface SessionResponse {
+  identity: string;
+  expiry_ns: number;
+  tag: string;
+}
+
+/** Error body from guardian. */
+export interface GuardianErrorBody {
+  error: string;
+}
+
+/** Error classification codes. */
+export type GuardianErrorCode = 'TIMEOUT' | 'NOT_FOUND' | 'AUTH' | 'SERVER_ERROR' | 'NETWORK' | 'CONFLICT';
+
+/** Fan-out result for a single guardian. */
+export interface FanOutResult<T> {
+  endpoint: GuardianEndpoint;
+  result: T | null;
+  error: string | null;
+  errorCode?: GuardianErrorCode;
+}

package/src/vault/types.ts

@@ -0,0 +1,62 @@
+import type { GuardianEndpoint } from './transport/types';
+
+/** Configuration for VaultClient. */
+export interface VaultConfig {
+  /** Guardian endpoints to connect to. */
+  guardians: GuardianEndpoint[];
+  /** HMAC key for authentication (derived from user's secret). */
+  hmacKey: Uint8Array;
+  /** Identity hash (hex string, 64 chars). */
+  identityHex: string;
+  /** Request timeout in ms (default: 10000). */
+  timeoutMs?: number;
+}
+
+/** Metadata for a stored secret. */
+export interface SecretMeta {
+  name: string;
+  version: number;
+  size: number;
+}
+
+/** Result of a store operation. */
+export interface StoreResult {
+  /** Number of guardians that acknowledged. */
+  ackCount: number;
+  /** Total guardians contacted. */
+  totalContacted: number;
+  /** Number of failures. */
+  failCount: number;
+  /** Whether write quorum was met. */
+  quorumMet: boolean;
+  /** Per-guardian results. */
+  guardianResults: GuardianResult[];
+}
+
+/** Result of a retrieve operation. */
+export interface RetrieveResult {
+  /** The reconstructed secret data. */
+  data: Uint8Array;
+  /** Number of shares collected. */
+  sharesCollected: number;
+}
+
+/** Result of a list operation. */
+export interface ListResult {
+  secrets: SecretMeta[];
+}
+
+/** Result of a delete operation. */
+export interface DeleteResult {
+  /** Number of guardians that acknowledged. */
+  ackCount: number;
+  totalContacted: number;
+  quorumMet: boolean;
+}
+
+/** Per-guardian operation result. */
+export interface GuardianResult {
+  endpoint: string;
+  success: boolean;
+  error?: string;
+}