wolfronix-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,238 @@
+/**
+ * Wolfronix SDK for JavaScript/TypeScript
+ * Zero-knowledge encryption made simple
+ *
+ * @package @wolfronix/sdk
+ * @version 1.0.0
+ */
+interface WolfronixConfig {
+    /** Wolfronix server base URL */
+    baseUrl: string;
+    /** Your enterprise client ID (optional for self-hosted) */
+    clientId?: string;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Retry failed requests (default: 3) */
+    retries?: number;
+    /** Skip SSL verification for self-signed certs (default: false) */
+    insecure?: boolean;
+}
+interface AuthResponse {
+    success: boolean;
+    user_id: string;
+    token: string;
+    message: string;
+}
+interface EncryptResponse {
+    success: boolean;
+    file_id: string;
+    original_name: string;
+    encrypted_size: number;
+    message: string;
+}
+interface FileInfo {
+    file_id: string;
+    original_name: string;
+    encrypted_size: number;
+    created_at: string;
+}
+interface ListFilesResponse {
+    success: boolean;
+    files: FileInfo[];
+    total: number;
+}
+interface DeleteResponse {
+    success: boolean;
+    message: string;
+}
+interface MetricsResponse {
+    success: boolean;
+    total_encryptions: number;
+    total_decryptions: number;
+    total_bytes_encrypted: number;
+    total_bytes_decrypted: number;
+}
+interface StreamToken {
+    token: string;
+    expires_at: string;
+}
+declare class WolfronixError extends Error {
+    readonly code: string;
+    readonly statusCode?: number;
+    readonly details?: Record<string, unknown>;
+    constructor(message: string, code: string, statusCode?: number, details?: Record<string, unknown>);
+}
+declare class AuthenticationError extends WolfronixError {
+    constructor(message?: string);
+}
+declare class FileNotFoundError extends WolfronixError {
+    constructor(fileId: string);
+}
+declare class PermissionDeniedError extends WolfronixError {
+    constructor(message?: string);
+}
+declare class NetworkError extends WolfronixError {
+    constructor(message?: string);
+}
+declare class ValidationError extends WolfronixError {
+    constructor(message: string);
+}
+declare class Wolfronix {
+    private readonly config;
+    private token;
+    private userId;
+    private tokenExpiry;
+    /**
+     * Create a new Wolfronix client
+     *
+     * @example
+     * ```typescript
+     * const wfx = new Wolfronix({
+     *   baseUrl: 'https://wolfronix-server:5002',
+     *   clientId: 'your-client-id'
+     * });
+     * ```
+     */
+    constructor(config: WolfronixConfig | string);
+    private getHeaders;
+    private request;
+    private sleep;
+    private ensureAuthenticated;
+    /**
+     * Register a new user
+     *
+     * @example
+     * ```typescript
+     * const { user_id, token } = await wfx.register('user@example.com', 'password123');
+     * ```
+     */
+    register(email: string, password: string): Promise<AuthResponse>;
+    /**
+     * Login with existing credentials
+     *
+     * @example
+     * ```typescript
+     * await wfx.login('user@example.com', 'password123');
+     * ```
+     */
+    login(email: string, password: string): Promise<AuthResponse>;
+    /**
+     * Set authentication token directly (useful for server-side apps)
+     *
+     * @example
+     * ```typescript
+     * wfx.setToken('jwt-token-here', 'user-id-here');
+     * ```
+     */
+    setToken(token: string, userId?: string): void;
+    /**
+     * Clear authentication state (logout)
+     */
+    logout(): void;
+    /**
+     * Check if client is authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Get current user ID
+     */
+    getUserId(): string | null;
+    /**
+     * Encrypt and store a file
+     *
+     * @example
+     * ```typescript
+     * // Browser
+     * const fileInput = document.querySelector('input[type="file"]');
+     * const result = await wfx.encrypt(fileInput.files[0]);
+     *
+     * // Node.js
+     * const buffer = fs.readFileSync('document.pdf');
+     * const result = await wfx.encrypt(buffer, 'document.pdf');
+     * ```
+     */
+    encrypt(file: File | Blob | ArrayBuffer | Uint8Array, filename?: string): Promise<EncryptResponse>;
+    /**
+     * Encrypt a file using streaming (for large files)
+     *
+     * @example
+     * ```typescript
+     * const result = await wfx.encryptStream(largeFile, (progress) => {
+     *   console.log(`Progress: ${progress}%`);
+     * });
+     * ```
+     */
+    encryptStream(file: File | Blob, onProgress?: (percent: number) => void): Promise<EncryptResponse>;
+    /**
+     * Decrypt and retrieve a file
+     *
+     * @example
+     * ```typescript
+     * // Get as Blob (browser)
+     * const blob = await wfx.decrypt('file-id');
+     * const url = URL.createObjectURL(blob);
+     *
+     * // Get as Buffer (Node.js)
+     * const buffer = await wfx.decryptToBuffer('file-id');
+     * fs.writeFileSync('decrypted.pdf', buffer);
+     * ```
+     */
+    decrypt(fileId: string): Promise<Blob>;
+    /**
+     * Decrypt and return as ArrayBuffer
+     */
+    decryptToBuffer(fileId: string): Promise<ArrayBuffer>;
+    /**
+     * Decrypt using streaming (for large files)
+     */
+    decryptStream(fileId: string, onProgress?: (percent: number) => void): Promise<Blob>;
+    /**
+     * List all encrypted files for current user
+     *
+     * @example
+     * ```typescript
+     * const { files } = await wfx.listFiles();
+     * files.forEach(f => console.log(f.original_name, f.file_id));
+     * ```
+     */
+    listFiles(): Promise<ListFilesResponse>;
+    /**
+     * Delete an encrypted file
+     *
+     * @example
+     * ```typescript
+     * await wfx.deleteFile('file-id');
+     * ```
+     */
+    deleteFile(fileId: string): Promise<DeleteResponse>;
+    /**
+     * Get encryption/decryption metrics
+     *
+     * @example
+     * ```typescript
+     * const metrics = await wfx.getMetrics();
+     * console.log(`Total encryptions: ${metrics.total_encryptions}`);
+     * ```
+     */
+    getMetrics(): Promise<MetricsResponse>;
+    /**
+     * Check if server is healthy
+     */
+    healthCheck(): Promise<boolean>;
+}
+/**
+ * Create a new Wolfronix client
+ *
+ * @example
+ * ```typescript
+ * import { createClient } from '@wolfronix/sdk';
+ *
+ * const wfx = createClient({
+ *   baseUrl: 'https://wolfronix-server:5002',
+ *   clientId: 'your-client-id'
+ * });
+ * ```
+ */
+declare function createClient(config: WolfronixConfig | string): Wolfronix;
+
+export { type AuthResponse, AuthenticationError, type DeleteResponse, type EncryptResponse, type FileInfo, FileNotFoundError, type ListFilesResponse, type MetricsResponse, NetworkError, PermissionDeniedError, type StreamToken, ValidationError, Wolfronix, type WolfronixConfig, WolfronixError, createClient, Wolfronix as default };