@haex-space/vault-sdk 2.5.37 → 2.5.42

package/dist/{client-BF1XJY-3.d.mts → client-BAu3VPE3.d.mts}

@@ -107,7 +107,7 @@ interface LocalFileInfo {
     modifiedAt: string | null;
 }
 type FileSyncState = "synced" | "syncing" | "localOnly" | "remoteOnly" | "conflict" | "error";
-interface StorageBackendInfo {
+interface StorageBackendInfo$1 {
     id: string;
     type: StorageBackendType;
     name: string;
@@ -214,6 +214,96 @@ interface DownloadFileOptions {
     fileId: string;
     localPath: string;
 }
+/** Queue operation type */
+type QueueOperation = 'upload' | 'download';
+/** Queue entry status */
+type QueueStatus = 'pending' | 'inProgress' | 'completed' | 'failed';
+/** Queue operation constants */
+declare const QUEUE_OPERATION: {
+    UPLOAD: "upload";
+    DOWNLOAD: "download";
+};
+/** Queue status constants */
+declare const QUEUE_STATUS: {
+    PENDING: "pending";
+    IN_PROGRESS: "inProgress";
+    COMPLETED: "completed";
+    FAILED: "failed";
+};
+/** A sync queue entry representing a pending or in-progress file operation */
+interface SyncQueueEntry {
+    id: string;
+    /** Device ID this entry belongs to */
+    deviceId: string;
+    /** Sync rule ID */
+    ruleId: string;
+    /** Full local path */
+    localPath: string;
+    /** Relative path from sync root (used as remote path) */
+    relativePath: string;
+    /** Operation type (upload/download) */
+    operation: QueueOperation;
+    /** Current status */
+    status: QueueStatus;
+    /** Priority (lower = higher priority) */
+    priority: number;
+    /** File size in bytes */
+    fileSize: number;
+    /** Error message if failed */
+    errorMessage: string | null;
+    /** Number of retry attempts */
+    retryCount: number;
+    /** When the entry was created */
+    createdAt: string;
+    /** When processing started */
+    startedAt: string | null;
+    /** When processing completed */
+    completedAt: string | null;
+}
+/** Request to add files to the sync queue */
+interface AddToQueueOptions {
+    /** Sync rule ID */
+    ruleId: string;
+    /** Files to add */
+    files: QueueFileEntry[];
+    /** Operation type */
+    operation: QueueOperation;
+    /** Priority (optional, default 100) */
+    priority?: number;
+}
+/** A file entry for adding to the queue */
+interface QueueFileEntry {
+    /** Full local path */
+    localPath: string;
+    /** Relative path from sync root */
+    relativePath: string;
+    /** File size in bytes */
+    fileSize: number;
+}
+/** Request to get queue entries */
+interface GetQueueOptions {
+    /** Filter by rule ID (optional) */
+    ruleId?: string;
+    /** Filter by status (optional) */
+    status?: QueueStatus;
+    /** Include completed entries (default: false) */
+    includeCompleted?: boolean;
+}
+/** Aggregated queue status */
+interface QueueSummary {
+    /** Number of pending items */
+    pendingCount: number;
+    /** Number of in-progress items */
+    inProgressCount: number;
+    /** Number of completed items */
+    completedCount: number;
+    /** Number of failed items */
+    failedCount: number;
+    /** Total bytes pending (sum of file_size for pending items) */
+    pendingBytes: number;
+    /** Currently processing entry (if any) */
+    currentEntry: SyncQueueEntry | null;
+}
 /**
  * File Sync API for E2E encrypted file synchronization
  *
@@ -262,11 +352,11 @@ declare class FileSyncAPI {
     /**
      * List configured storage backends
      */
-    listBackendsAsync(): Promise<StorageBackendInfo[]>;
+    listBackendsAsync(): Promise<StorageBackendInfo$1[]>;
     /**
      * Add a new storage backend
      */
-    addBackendAsync(options: AddBackendOptions): Promise<StorageBackendInfo>;
+    addBackendAsync(options: AddBackendOptions): Promise<StorageBackendInfo$1>;
     /**
      * Remove a storage backend
      */
@@ -315,6 +405,46 @@ declare class FileSyncAPI {
      * Open a folder selection dialog
      */
     selectFolderAsync(): Promise<string | null>;
+    /**
+     * Add files to the sync queue
+     */
+    addToQueueAsync(options: AddToQueueOptions): Promise<SyncQueueEntry[]>;
+    /**
+     * Get queue entries for the current device
+     */
+    getQueueAsync(options?: GetQueueOptions): Promise<SyncQueueEntry[]>;
+    /**
+     * Get aggregated queue summary for the current device
+     */
+    getQueueSummaryAsync(): Promise<QueueSummary>;
+    /**
+     * Mark a queue entry as started (in_progress)
+     */
+    startQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Mark a queue entry as completed
+     */
+    completeQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Mark a queue entry as failed
+     */
+    failQueueEntryAsync(entryId: string, errorMessage: string): Promise<void>;
+    /**
+     * Retry all failed queue entries (reset to pending)
+     */
+    retryFailedQueueAsync(): Promise<void>;
+    /**
+     * Remove a queue entry
+     */
+    removeQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Clear all queue entries for a sync rule
+     */
+    clearQueueAsync(ruleId: string): Promise<void>;
+    /**
+     * Reset in_progress entries to pending (for recovery after crash)
+     */
+    recoverQueueAsync(): Promise<void>;
 }
 
 interface SaveFileOptions {
@@ -458,6 +588,135 @@ declare class PermissionsAPI {
     checkFilesystemAsync(path: string, operation: "read" | "write"): Promise<boolean>;
 }
 
+/**
+ * Storage backend info (public, without credentials)
+ */
+interface StorageBackendInfo {
+    id: string;
+    /** Backend type (e.g., "s3") */
+    type: string;
+    name: string;
+    enabled: boolean;
+    createdAt: string;
+}
+/**
+ * S3-compatible backend configuration
+ */
+interface S3Config {
+    /** Custom endpoint URL (for non-AWS S3-compatible services) */
+    endpoint?: string;
+    /** AWS region or custom region name */
+    region: string;
+    /** Bucket name */
+    bucket: string;
+    /** Access key ID */
+    accessKeyId: string;
+    /** Secret access key */
+    secretAccessKey: string;
+    /** Use path-style URLs instead of virtual-hosted-style */
+    pathStyle?: boolean;
+}
+/**
+ * Request to add a new storage backend
+ */
+interface AddBackendRequest {
+    /** Display name for the backend */
+    name: string;
+    /** Backend type (currently only "s3") */
+    type: "s3";
+    /** Configuration (structure depends on type) */
+    config: S3Config | Record<string, unknown>;
+}
+/**
+ * Object info from list operation
+ */
+interface StorageObjectInfo {
+    /** Object key */
+    key: string;
+    /** Size in bytes */
+    size: number;
+    /** Last modified timestamp (ISO 8601) */
+    lastModified?: string;
+}
+/**
+ * Remote Storage API for S3-compatible (and future WebDAV, FTP) backends.
+ *
+ * This API provides access to external storage backends configured centrally
+ * in haex-vault. Extensions can upload/download files without CORS issues.
+ *
+ * @example
+ * ```typescript
+ * // List available backends
+ * const backends = await sdk.remoteStorage.backends.list();
+ *
+ * // Upload data
+ * const data = new TextEncoder().encode("Hello World");
+ * await sdk.remoteStorage.upload(backendId, "path/to/file.txt", data);
+ *
+ * // Download data
+ * const downloaded = await sdk.remoteStorage.download(backendId, "path/to/file.txt");
+ * ```
+ */
+declare class RemoteStorageAPI {
+    private client;
+    readonly backends: BackendManagement;
+    constructor(client: HaexVaultSdk);
+    /**
+     * Upload data to a storage backend
+     * @param backendId - Backend ID to upload to
+     * @param key - Object key (path in the bucket)
+     * @param data - Data to upload
+     */
+    upload(backendId: string, key: string, data: Uint8Array): Promise<void>;
+    /**
+     * Download data from a storage backend
+     * @param backendId - Backend ID to download from
+     * @param key - Object key (path in the bucket)
+     * @returns Downloaded data as Uint8Array
+     */
+    download(backendId: string, key: string): Promise<Uint8Array>;
+    /**
+     * Delete an object from a storage backend
+     * @param backendId - Backend ID
+     * @param key - Object key to delete
+     */
+    delete(backendId: string, key: string): Promise<void>;
+    /**
+     * List objects in a storage backend
+     * @param backendId - Backend ID
+     * @param prefix - Optional prefix to filter objects
+     * @returns List of objects
+     */
+    list(backendId: string, prefix?: string): Promise<StorageObjectInfo[]>;
+}
+/**
+ * Backend management operations
+ */
+declare class BackendManagement {
+    private client;
+    constructor(client: HaexVaultSdk);
+    /**
+     * List all available storage backends
+     */
+    list(): Promise<StorageBackendInfo[]>;
+    /**
+     * Add a new storage backend
+     * @param request - Backend configuration
+     * @returns Created backend info
+     */
+    add(request: AddBackendRequest): Promise<StorageBackendInfo>;
+    /**
+     * Remove a storage backend
+     * @param backendId - Backend ID to remove
+     */
+    remove(backendId: string): Promise<void>;
+    /**
+     * Test connection to a storage backend
+     * @param backendId - Backend ID to test
+     */
+    test(backendId: string): Promise<void>;
+}
+
 /**
  * HaexVault Client
  *
@@ -488,6 +747,7 @@ declare class HaexVaultSdk {
     readonly filesystem: FilesystemAPI;
     readonly web: WebAPI;
     readonly permissions: PermissionsAPI;
+    readonly remoteStorage: RemoteStorageAPI;
     constructor(config?: HaexHubConfig);
     ready(): Promise<void>;
     get setupCompleted(): boolean;
@@ -531,4 +791,4 @@ declare class HaexVaultSdk {
     private log;
 }
 
-export { type AddBackendOptions as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, FilesystemAPI as F, HaexVaultSdk as H, type ListFilesOptions as L, PermissionsAPI as P, StorageAPI as S, type UpdateSyncRuleOptions as U, WebAPI as W, FileSyncAPI as a, type FileSpace as b, type FileInfo as c, type FileSyncState as d, type StorageBackendInfo as e, type StorageBackendType as f, type S3BackendConfig as g, type SyncRule as h, type SyncDirection as i, type SyncStatus as j, type SyncError as k, type SyncProgress as l, type CreateSpaceOptions as m, type AddSyncRuleOptions as n, type ScanLocalOptions as o, type UploadFileOptions as p, type DownloadFileOptions as q, type LocalFileInfo as r, FILE_SYNC_STATE as s, SYNC_DIRECTION as t, STORAGE_BACKEND_TYPE as u, CONFLICT_STRATEGY as v };
+export { type AddBackendRequest as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, type QueueSummary as E, FilesystemAPI as F, type GetQueueOptions as G, HaexVaultSdk as H, FILE_SYNC_STATE as I, SYNC_DIRECTION as J, STORAGE_BACKEND_TYPE as K, type ListFilesOptions as L, CONFLICT_STRATEGY as M, QUEUE_OPERATION as N, QUEUE_STATUS as O, PermissionsAPI as P, type QueueOperation as Q, RemoteStorageAPI as R, StorageAPI as S, type UpdateSyncRuleOptions as U, WebAPI as W, FileSyncAPI as a, type StorageBackendInfo as b, type S3Config as c, type StorageObjectInfo as d, type FileSpace as e, type FileInfo as f, type FileSyncState as g, type StorageBackendInfo$1 as h, type StorageBackendType as i, type S3BackendConfig as j, type SyncRule as k, type SyncDirection as l, type SyncStatus as m, type SyncError as n, type SyncProgress as o, type CreateSpaceOptions as p, type AddBackendOptions as q, type AddSyncRuleOptions as r, type ScanLocalOptions as s, type UploadFileOptions as t, type DownloadFileOptions as u, type LocalFileInfo as v, type QueueStatus as w, type SyncQueueEntry as x, type AddToQueueOptions as y, type QueueFileEntry as z };

package/dist/{client-D1sxoc42.d.ts → client-CF0wJxT2.d.ts}

@@ -107,7 +107,7 @@ interface LocalFileInfo {
     modifiedAt: string | null;
 }
 type FileSyncState = "synced" | "syncing" | "localOnly" | "remoteOnly" | "conflict" | "error";
-interface StorageBackendInfo {
+interface StorageBackendInfo$1 {
     id: string;
     type: StorageBackendType;
     name: string;
@@ -214,6 +214,96 @@ interface DownloadFileOptions {
     fileId: string;
     localPath: string;
 }
+/** Queue operation type */
+type QueueOperation = 'upload' | 'download';
+/** Queue entry status */
+type QueueStatus = 'pending' | 'inProgress' | 'completed' | 'failed';
+/** Queue operation constants */
+declare const QUEUE_OPERATION: {
+    UPLOAD: "upload";
+    DOWNLOAD: "download";
+};
+/** Queue status constants */
+declare const QUEUE_STATUS: {
+    PENDING: "pending";
+    IN_PROGRESS: "inProgress";
+    COMPLETED: "completed";
+    FAILED: "failed";
+};
+/** A sync queue entry representing a pending or in-progress file operation */
+interface SyncQueueEntry {
+    id: string;
+    /** Device ID this entry belongs to */
+    deviceId: string;
+    /** Sync rule ID */
+    ruleId: string;
+    /** Full local path */
+    localPath: string;
+    /** Relative path from sync root (used as remote path) */
+    relativePath: string;
+    /** Operation type (upload/download) */
+    operation: QueueOperation;
+    /** Current status */
+    status: QueueStatus;
+    /** Priority (lower = higher priority) */
+    priority: number;
+    /** File size in bytes */
+    fileSize: number;
+    /** Error message if failed */
+    errorMessage: string | null;
+    /** Number of retry attempts */
+    retryCount: number;
+    /** When the entry was created */
+    createdAt: string;
+    /** When processing started */
+    startedAt: string | null;
+    /** When processing completed */
+    completedAt: string | null;
+}
+/** Request to add files to the sync queue */
+interface AddToQueueOptions {
+    /** Sync rule ID */
+    ruleId: string;
+    /** Files to add */
+    files: QueueFileEntry[];
+    /** Operation type */
+    operation: QueueOperation;
+    /** Priority (optional, default 100) */
+    priority?: number;
+}
+/** A file entry for adding to the queue */
+interface QueueFileEntry {
+    /** Full local path */
+    localPath: string;
+    /** Relative path from sync root */
+    relativePath: string;
+    /** File size in bytes */
+    fileSize: number;
+}
+/** Request to get queue entries */
+interface GetQueueOptions {
+    /** Filter by rule ID (optional) */
+    ruleId?: string;
+    /** Filter by status (optional) */
+    status?: QueueStatus;
+    /** Include completed entries (default: false) */
+    includeCompleted?: boolean;
+}
+/** Aggregated queue status */
+interface QueueSummary {
+    /** Number of pending items */
+    pendingCount: number;
+    /** Number of in-progress items */
+    inProgressCount: number;
+    /** Number of completed items */
+    completedCount: number;
+    /** Number of failed items */
+    failedCount: number;
+    /** Total bytes pending (sum of file_size for pending items) */
+    pendingBytes: number;
+    /** Currently processing entry (if any) */
+    currentEntry: SyncQueueEntry | null;
+}
 /**
  * File Sync API for E2E encrypted file synchronization
  *
@@ -262,11 +352,11 @@ declare class FileSyncAPI {
     /**
      * List configured storage backends
      */
-    listBackendsAsync(): Promise<StorageBackendInfo[]>;
+    listBackendsAsync(): Promise<StorageBackendInfo$1[]>;
     /**
      * Add a new storage backend
      */
-    addBackendAsync(options: AddBackendOptions): Promise<StorageBackendInfo>;
+    addBackendAsync(options: AddBackendOptions): Promise<StorageBackendInfo$1>;
     /**
      * Remove a storage backend
      */
@@ -315,6 +405,46 @@ declare class FileSyncAPI {
      * Open a folder selection dialog
      */
     selectFolderAsync(): Promise<string | null>;
+    /**
+     * Add files to the sync queue
+     */
+    addToQueueAsync(options: AddToQueueOptions): Promise<SyncQueueEntry[]>;
+    /**
+     * Get queue entries for the current device
+     */
+    getQueueAsync(options?: GetQueueOptions): Promise<SyncQueueEntry[]>;
+    /**
+     * Get aggregated queue summary for the current device
+     */
+    getQueueSummaryAsync(): Promise<QueueSummary>;
+    /**
+     * Mark a queue entry as started (in_progress)
+     */
+    startQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Mark a queue entry as completed
+     */
+    completeQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Mark a queue entry as failed
+     */
+    failQueueEntryAsync(entryId: string, errorMessage: string): Promise<void>;
+    /**
+     * Retry all failed queue entries (reset to pending)
+     */
+    retryFailedQueueAsync(): Promise<void>;
+    /**
+     * Remove a queue entry
+     */
+    removeQueueEntryAsync(entryId: string): Promise<void>;
+    /**
+     * Clear all queue entries for a sync rule
+     */
+    clearQueueAsync(ruleId: string): Promise<void>;
+    /**
+     * Reset in_progress entries to pending (for recovery after crash)
+     */
+    recoverQueueAsync(): Promise<void>;
 }
 
 interface SaveFileOptions {
@@ -458,6 +588,135 @@ declare class PermissionsAPI {
     checkFilesystemAsync(path: string, operation: "read" | "write"): Promise<boolean>;
 }
 
+/**
+ * Storage backend info (public, without credentials)
+ */
+interface StorageBackendInfo {
+    id: string;
+    /** Backend type (e.g., "s3") */
+    type: string;
+    name: string;
+    enabled: boolean;
+    createdAt: string;
+}
+/**
+ * S3-compatible backend configuration
+ */
+interface S3Config {
+    /** Custom endpoint URL (for non-AWS S3-compatible services) */
+    endpoint?: string;
+    /** AWS region or custom region name */
+    region: string;
+    /** Bucket name */
+    bucket: string;
+    /** Access key ID */
+    accessKeyId: string;
+    /** Secret access key */
+    secretAccessKey: string;
+    /** Use path-style URLs instead of virtual-hosted-style */
+    pathStyle?: boolean;
+}
+/**
+ * Request to add a new storage backend
+ */
+interface AddBackendRequest {
+    /** Display name for the backend */
+    name: string;
+    /** Backend type (currently only "s3") */
+    type: "s3";
+    /** Configuration (structure depends on type) */
+    config: S3Config | Record<string, unknown>;
+}
+/**
+ * Object info from list operation
+ */
+interface StorageObjectInfo {
+    /** Object key */
+    key: string;
+    /** Size in bytes */
+    size: number;
+    /** Last modified timestamp (ISO 8601) */
+    lastModified?: string;
+}
+/**
+ * Remote Storage API for S3-compatible (and future WebDAV, FTP) backends.
+ *
+ * This API provides access to external storage backends configured centrally
+ * in haex-vault. Extensions can upload/download files without CORS issues.
+ *
+ * @example
+ * ```typescript
+ * // List available backends
+ * const backends = await sdk.remoteStorage.backends.list();
+ *
+ * // Upload data
+ * const data = new TextEncoder().encode("Hello World");
+ * await sdk.remoteStorage.upload(backendId, "path/to/file.txt", data);
+ *
+ * // Download data
+ * const downloaded = await sdk.remoteStorage.download(backendId, "path/to/file.txt");
+ * ```
+ */
+declare class RemoteStorageAPI {
+    private client;
+    readonly backends: BackendManagement;
+    constructor(client: HaexVaultSdk);
+    /**
+     * Upload data to a storage backend
+     * @param backendId - Backend ID to upload to
+     * @param key - Object key (path in the bucket)
+     * @param data - Data to upload
+     */
+    upload(backendId: string, key: string, data: Uint8Array): Promise<void>;
+    /**
+     * Download data from a storage backend
+     * @param backendId - Backend ID to download from
+     * @param key - Object key (path in the bucket)
+     * @returns Downloaded data as Uint8Array
+     */
+    download(backendId: string, key: string): Promise<Uint8Array>;
+    /**
+     * Delete an object from a storage backend
+     * @param backendId - Backend ID
+     * @param key - Object key to delete
+     */
+    delete(backendId: string, key: string): Promise<void>;
+    /**
+     * List objects in a storage backend
+     * @param backendId - Backend ID
+     * @param prefix - Optional prefix to filter objects
+     * @returns List of objects
+     */
+    list(backendId: string, prefix?: string): Promise<StorageObjectInfo[]>;
+}
+/**
+ * Backend management operations
+ */
+declare class BackendManagement {
+    private client;
+    constructor(client: HaexVaultSdk);
+    /**
+     * List all available storage backends
+     */
+    list(): Promise<StorageBackendInfo[]>;
+    /**
+     * Add a new storage backend
+     * @param request - Backend configuration
+     * @returns Created backend info
+     */
+    add(request: AddBackendRequest): Promise<StorageBackendInfo>;
+    /**
+     * Remove a storage backend
+     * @param backendId - Backend ID to remove
+     */
+    remove(backendId: string): Promise<void>;
+    /**
+     * Test connection to a storage backend
+     * @param backendId - Backend ID to test
+     */
+    test(backendId: string): Promise<void>;
+}
+
 /**
  * HaexVault Client
  *
@@ -488,6 +747,7 @@ declare class HaexVaultSdk {
     readonly filesystem: FilesystemAPI;
     readonly web: WebAPI;
     readonly permissions: PermissionsAPI;
+    readonly remoteStorage: RemoteStorageAPI;
     constructor(config?: HaexHubConfig);
     ready(): Promise<void>;
     get setupCompleted(): boolean;
@@ -531,4 +791,4 @@ declare class HaexVaultSdk {
     private log;
 }
 
-export { type AddBackendOptions as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, FilesystemAPI as F, HaexVaultSdk as H, type ListFilesOptions as L, PermissionsAPI as P, StorageAPI as S, type UpdateSyncRuleOptions as U, WebAPI as W, FileSyncAPI as a, type FileSpace as b, type FileInfo as c, type FileSyncState as d, type StorageBackendInfo as e, type StorageBackendType as f, type S3BackendConfig as g, type SyncRule as h, type SyncDirection as i, type SyncStatus as j, type SyncError as k, type SyncProgress as l, type CreateSpaceOptions as m, type AddSyncRuleOptions as n, type ScanLocalOptions as o, type UploadFileOptions as p, type DownloadFileOptions as q, type LocalFileInfo as r, FILE_SYNC_STATE as s, SYNC_DIRECTION as t, STORAGE_BACKEND_TYPE as u, CONFLICT_STRATEGY as v };
+export { type AddBackendRequest as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, type QueueSummary as E, FilesystemAPI as F, type GetQueueOptions as G, HaexVaultSdk as H, FILE_SYNC_STATE as I, SYNC_DIRECTION as J, STORAGE_BACKEND_TYPE as K, type ListFilesOptions as L, CONFLICT_STRATEGY as M, QUEUE_OPERATION as N, QUEUE_STATUS as O, PermissionsAPI as P, type QueueOperation as Q, RemoteStorageAPI as R, StorageAPI as S, type UpdateSyncRuleOptions as U, WebAPI as W, FileSyncAPI as a, type StorageBackendInfo as b, type S3Config as c, type StorageObjectInfo as d, type FileSpace as e, type FileInfo as f, type FileSyncState as g, type StorageBackendInfo$1 as h, type StorageBackendType as i, type S3BackendConfig as j, type SyncRule as k, type SyncDirection as l, type SyncStatus as m, type SyncError as n, type SyncProgress as o, type CreateSpaceOptions as p, type AddBackendOptions as q, type AddSyncRuleOptions as r, type ScanLocalOptions as s, type UploadFileOptions as t, type DownloadFileOptions as u, type LocalFileInfo as v, type QueueStatus as w, type SyncQueueEntry as x, type AddToQueueOptions as y, type QueueFileEntry as z };