@bandeira-tech/b3nd-web 0.2.0

package/dist/types-Bw0Boe0n.d.ts

@@ -0,0 +1,219 @@
+/**
+ * @b3nd/sdk Types
+ * Core types for the universal B3nd protocol interface
+ */
+/**
+ * Persistence record with timestamp
+ */
+interface PersistenceRecord<T = unknown> {
+    ts: number;
+    data: T;
+}
+/**
+ * Result of a write operation
+ */
+interface WriteResult<T = unknown> {
+    success: boolean;
+    record?: PersistenceRecord<T>;
+    error?: string;
+}
+/**
+ * Result of a read operation
+ */
+interface ReadResult<T> {
+    success: boolean;
+    record?: PersistenceRecord<T>;
+    error?: string;
+}
+/**
+ * Result of a delete operation
+ */
+interface DeleteResult {
+    success: boolean;
+    error?: string;
+}
+/**
+ * Item returned from list operations
+ */
+interface ListItem {
+    uri: string;
+    type: "file" | "directory";
+}
+/**
+ * Options for list operations
+ */
+interface ListOptions {
+    page?: number;
+    limit?: number;
+    pattern?: string;
+    sortBy?: "name" | "timestamp";
+    sortOrder?: "asc" | "desc";
+}
+/**
+ * Result of a list operation
+ */
+type ListResult = {
+    success: true;
+    data: ListItem[];
+    pagination: {
+        page: number;
+        limit: number;
+        total?: number;
+    };
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Health status response
+ */
+interface HealthStatus {
+    status: "healthy" | "degraded" | "unhealthy";
+    message?: string;
+    details?: Record<string, unknown>;
+}
+/**
+ * Validation function for write operations
+ * Returns an object with valid boolean and optional error message
+ */
+type ValidationFn = (write: {
+    uri: string;
+    value: unknown;
+    read: <T = unknown>(uri: string) => Promise<ReadResult<T>>;
+}) => Promise<{
+    valid: boolean;
+    error?: string;
+}>;
+/**
+ * Schema mapping program keys to validation functions
+ */
+type Schema = Record<string, ValidationFn>;
+/**
+ * NodeProtocolInterface - The universal interface implemented by all clients
+ *
+ * All B3nd clients (Memory, HTTP, WebSocket, Postgres, IndexedDB, etc.)
+ * implement this interface, enabling recursive composition and uniform usage.
+ */
+interface NodeProtocolWriteInterface {
+    /** Write data to a URI */
+    write<T = unknown>(uri: string, value: T): Promise<WriteResult<T>>;
+    /** Delete data at a URI */
+    delete(uri: string): Promise<DeleteResult>;
+    /** Health status */
+    health(): Promise<HealthStatus>;
+    /** Supported program keys */
+    getSchema(): Promise<string[]>;
+    /** Cleanup resources */
+    cleanup(): Promise<void>;
+}
+interface NodeProtocolReadInterface {
+    /** Read data from a URI */
+    read<T = unknown>(uri: string): Promise<ReadResult<T>>;
+    /** List items at a URI path */
+    list(uri: string, options?: ListOptions): Promise<ListResult>;
+    /** Health status */
+    health(): Promise<HealthStatus>;
+    /** Supported program keys */
+    getSchema(): Promise<string[]>;
+    /** Cleanup resources */
+    cleanup(): Promise<void>;
+}
+type NodeProtocolInterface = NodeProtocolWriteInterface & NodeProtocolReadInterface;
+/**
+ * Configuration for HttpClient
+ */
+interface HttpClientConfig {
+    /**
+     * Base URL of the HTTP API
+     */
+    url: string;
+    /**
+     * Optional custom headers
+     */
+    headers?: Record<string, string>;
+    /**
+     * Request timeout in milliseconds (default: 30000)
+     */
+    timeout?: number;
+}
+/**
+ * Configuration for WebSocketClient
+ */
+interface WebSocketClientConfig {
+    /**
+     * WebSocket server URL
+     */
+    url: string;
+    /**
+     * Optional authentication configuration
+     */
+    auth?: {
+        type: "bearer" | "basic" | "custom";
+        token?: string;
+        username?: string;
+        password?: string;
+        custom?: Record<string, unknown>;
+    };
+    /**
+     * Optional reconnection configuration
+     */
+    reconnect?: {
+        enabled: boolean;
+        maxAttempts?: number;
+        interval?: number;
+        backoff?: "linear" | "exponential";
+    };
+    /**
+     * Request timeout in milliseconds (default: 30000)
+     */
+    timeout?: number;
+}
+/**
+ * Configuration for LocalStorageClient
+ */
+interface LocalStorageClientConfig {
+    /**
+     * Optional prefix for localStorage keys to avoid collisions
+     */
+    keyPrefix?: string;
+    /**
+     * Optional schema for validation (like MemoryClient)
+     */
+    schema?: Schema;
+    /**
+     * Optional serialization functions
+     */
+    serializer?: {
+        serialize?: (data: unknown) => string;
+        deserialize?: (data: string) => unknown;
+    };
+    /**
+     * Optional injectable storage dependency (defaults to global localStorage)
+     */
+    storage?: Storage;
+}
+/**
+ * Error class for client operations
+ * Preserves error context without hiding details
+ */
+declare class ClientError extends Error {
+    readonly code: string;
+    readonly details?: unknown;
+    constructor(message: string, code: string, details?: unknown);
+}
+/**
+ * WebSocket protocol types for request/response communication
+ */
+interface WebSocketRequest {
+    id: string;
+    type: "write" | "read" | "list" | "delete" | "health" | "getSchema";
+    payload: unknown;
+}
+interface WebSocketResponse {
+    id: string;
+    success: boolean;
+    data?: unknown;
+    error?: string;
+}
+
+export { ClientError as C, type DeleteResult as D, type HealthStatus as H, type ListItem as L, type NodeProtocolInterface as N, type PersistenceRecord as P, type ReadResult as R, type Schema as S, type ValidationFn as V, type WebSocketClientConfig as W, type HttpClientConfig as a, type ListOptions as b, type ListResult as c, type LocalStorageClientConfig as d, type WebSocketRequest as e, type WebSocketResponse as f, type WriteResult as g };

package/dist/wallet/mod.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Wallet Client Types
+ *
+ * Type definitions for the B3nd Wallet Client that interacts with wallet servers.
+ */
+/**
+ * Configuration for wallet client
+ */
+interface WalletClientConfig {
+    /**
+     * Wallet server URL (e.g., "http://localhost:3001")
+     */
+    walletServerUrl: string;
+    /**
+     * API base path prefix (e.g., "/api/v1"). Must be provided explicitly.
+     */
+    apiBasePath: string;
+    /**
+     * Optional fetch implementation (for custom HTTP handling)
+     */
+    fetch?: typeof fetch;
+}
+/**
+ * User credentials for authentication
+ */
+interface UserCredentials {
+    username: string;
+    password: string;
+}
+/**
+ * Authenticated session with JWT token
+ */
+interface AuthSession {
+    username: string;
+    token: string;
+    expiresIn: number;
+}
+/**
+ * User's public keys
+ */
+interface UserPublicKeys {
+    accountPublicKeyHex: string;
+    encryptionPublicKeyHex: string;
+}
+/**
+ * Password reset token
+ */
+interface PasswordResetToken {
+    resetToken: string;
+    expiresIn: number;
+}
+/**
+ * Write proxy request
+ */
+interface ProxyWriteRequest {
+    uri: string;
+    data: unknown;
+    encrypt?: boolean;
+}
+/**
+ * Write proxy response
+ */
+interface ProxyWriteResponse {
+    success: boolean;
+    uri: string;
+    resolvedUri?: string;
+    data: unknown;
+    record?: {
+        data: unknown;
+        ts: number;
+    };
+}
+/**
+ * API response wrapper
+ */
+interface ApiResponse<T = unknown> {
+    success: boolean;
+    error?: string;
+    [key: string]: unknown;
+}
+/**
+ * Signup response
+ */
+interface SignupResponse extends ApiResponse {
+    username: string;
+    token: string;
+    expiresIn: number;
+}
+/**
+ * Login response
+ */
+interface LoginResponse extends ApiResponse {
+    username: string;
+    token: string;
+    expiresIn: number;
+}
+/**
+ * Public keys response
+ */
+interface PublicKeysResponse extends ApiResponse {
+    accountPublicKeyHex: string;
+    encryptionPublicKeyHex: string;
+}
+/**
+ * Change password response
+ */
+interface ChangePasswordResponse extends ApiResponse {
+    message: string;
+}
+/**
+ * Request password reset response
+ */
+interface RequestPasswordResetResponse extends ApiResponse {
+    message: string;
+    resetToken: string;
+    expiresIn: number;
+}
+/**
+ * Reset password response
+ */
+interface ResetPasswordResponse extends ApiResponse {
+    message: string;
+    username: string;
+    token: string;
+    expiresIn: number;
+}
+/**
+ * Health check response
+ */
+interface HealthResponse extends ApiResponse {
+    status: string;
+    server: string;
+    timestamp: string;
+}
+
+/**
+ * B3nd Wallet Client
+ *
+ * Client library for interacting with B3nd wallet servers.
+ * Provides authentication, key management, and write proxying functionality.
+ *
+ * Works in both Deno and browser environments.
+ */
+
+/**
+ * B3nd Wallet Client
+ *
+ * Manages authentication with a wallet server and provides methods
+ * for user management, key retrieval, and proxied writes.
+ *
+ * @example
+ * ```typescript
+ * const wallet = new WalletClient({
+ *   walletServerUrl: "http://localhost:3001",
+ *   apiBasePath: "/api/v1",
+ * });
+ *
+ * // Sign up a new user
+ * const session = await wallet.signup({
+ *   username: "alice",
+ *   password: "secure-password-123"
+ * });
+ *
+ * // Activate the session
+ * wallet.setSession(session);
+ *
+ * // Write data through proxy
+ * await wallet.proxyWrite({
+ *   uri: "mutable://data/my-app/profile",
+ *   data: { name: "Alice" },
+ *   encrypt: true
+ * });
+ * ```
+ */
+declare class WalletClient {
+    private walletServerUrl;
+    private apiBasePath;
+    private fetchImpl;
+    private currentSession;
+    constructor(config: WalletClientConfig);
+    /**
+     * Get the current authenticated session
+     */
+    getSession(): AuthSession | null;
+    /**
+     * Set the current session (useful for restoring from storage)
+     */
+    setSession(session: AuthSession | null): void;
+    /**
+     * Check if user is currently authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Get current username (if authenticated)
+     */
+    getUsername(): string | null;
+    /**
+     * Get current JWT token (if authenticated)
+     */
+    getToken(): string | null;
+    /**
+     * Clear current session (logout)
+     */
+    logout(): void;
+    /**
+     * Check wallet server health
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Sign up a new user
+     * Returns session data - call setSession() to activate it
+     */
+    signup(_credentials: UserCredentials): Promise<AuthSession>;
+    /**
+     * Login existing user
+     * Returns session data - call setSession() to activate it
+     */
+    login(_credentials: UserCredentials): Promise<AuthSession>;
+    /**
+     * Change password for current user
+     * Requires active authentication session
+     */
+    changePassword(oldPassword: string, newPassword: string): Promise<void>;
+    /**
+     * Request a password reset token
+     * Does not require authentication
+     */
+    requestPasswordReset(_username: string): Promise<PasswordResetToken>;
+    /**
+     * Reset password using a reset token
+     * Returns session data - call setSession() to activate it
+     */
+    resetPassword(_username: string, _resetToken: string, _newPassword: string): Promise<AuthSession>;
+    /**
+     * Sign up with app token (scoped to an app)
+     */
+    signupWithToken(token: string, credentials: UserCredentials): Promise<AuthSession>;
+    /**
+     * Login with app token and session (scoped to an app)
+     */
+    loginWithTokenSession(token: string, session: string, credentials: UserCredentials): Promise<AuthSession>;
+    /**
+     * Request password reset scoped to app token
+     */
+    requestPasswordResetWithToken(token: string, username: string): Promise<PasswordResetToken>;
+    /**
+     * Reset password scoped to app token
+     */
+    resetPasswordWithToken(token: string, username: string, resetToken: string, newPassword: string): Promise<AuthSession>;
+    /**
+     * Get public keys for the current authenticated user.
+     * Requires an active authentication session.
+     */
+    getPublicKeys(): Promise<UserPublicKeys>;
+    /**
+     * Proxy a write request through the wallet server
+     * The server signs the write with its identity key
+     * Requires active authentication session
+     */
+    proxyWrite(request: ProxyWriteRequest): Promise<ProxyWriteResponse>;
+    /**
+     * Convenience method: Get current user's public keys
+     * Requires active authentication session
+     */
+    getMyPublicKeys(): Promise<UserPublicKeys>;
+    /**
+     * Get server's public keys
+     *
+     * @returns Server's identity and encryption public keys
+     * @throws Error if request fails
+     */
+    getServerKeys(): Promise<{
+        identityPublicKeyHex: string;
+        encryptionPublicKeyHex: string;
+    }>;
+}
+
+export { type ApiResponse, type AuthSession, type ChangePasswordResponse, type HealthResponse, type LoginResponse, type PasswordResetToken, type ProxyWriteRequest, type ProxyWriteResponse, type PublicKeysResponse, type RequestPasswordResetResponse, type ResetPasswordResponse, type SignupResponse, type UserCredentials, type UserPublicKeys, WalletClient, type WalletClientConfig };

package/dist/wallet/mod.js

@@ -0,0 +1,7 @@
+import {
+  WalletClient
+} from "../chunk-2D2RT2DW.js";
+import "../chunk-MLKGABMK.js";
+export {
+  WalletClient
+};

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@bandeira-tech/b3nd-web",
+  "version": "0.2.0",
+  "description": "Browser-focused B3nd SDK bundle",
+  "type": "module",
+  "main": "./dist/src/mod.web.js",
+  "module": "./dist/src/mod.web.js",
+  "types": "./dist/src/mod.web.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/src/mod.web.js",
+      "types": "./dist/src/mod.web.d.ts"
+    },
+    "./encrypt": {
+      "import": "./dist/encrypt/mod.js",
+      "types": "./dist/encrypt/mod.d.ts"
+    },
+    "./clients/http": {
+      "import": "./dist/clients/http/mod.js",
+      "types": "./dist/clients/http/mod.d.ts"
+    },
+    "./clients/local-storage": {
+      "import": "./dist/clients/local-storage/mod.js",
+      "types": "./dist/clients/local-storage/mod.d.ts"
+    },
+    "./clients/websocket": {
+      "import": "./dist/clients/websocket/mod.js",
+      "types": "./dist/clients/websocket/mod.d.ts"
+    },
+    "./wallet": {
+      "import": "./dist/wallet/mod.js",
+      "types": "./dist/wallet/mod.d.ts"
+    },
+    "./apps": {
+      "import": "./dist/apps/mod.js",
+      "types": "./dist/apps/mod.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/mod.web.ts wallet/mod.ts apps/mod.ts encrypt/mod.ts clients/http/mod.ts clients/local-storage/mod.ts clients/websocket/mod.ts --dts --format esm --out-dir dist --clean",
+    "clean": "rm -rf dist",
+    "lint": "deno lint src/",
+    "format": "deno fmt src/"
+  },
+  "keywords": [
+    "persistence",
+    "storage",
+    "universal",
+    "cross-platform",
+    "indexeddb",
+    "localstorage",
+    "memory",
+    "http",
+    "websocket",
+    "wallet",
+    "authentication",
+    "typescript"
+  ],
+  "author": "B3nd",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bandeira-tech/b3nd-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/bandeira-tech/b3nd-sdk/issues"
+  },
+  "homepage": "https://github.com/bandeira-tech/b3nd-sdk#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@types/node": "^22.10.1"
+  },
+  "engines": {
+    "node": ">=24.11.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}