@haex-space/vault-sdk 2.5.40 → 2.5.43

package/dist/{client-BEWYbywm.d.mts → client-9QruY0rX.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;
@@ -352,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
      */
@@ -502,6 +502,64 @@ interface ShowImageResult {
      */
     success: boolean;
 }
+/**
+ * File/directory metadata
+ */
+interface FileStat {
+    /** File size in bytes */
+    size: number;
+    /** True if this is a file */
+    isFile: boolean;
+    /** True if this is a directory */
+    isDirectory: boolean;
+    /** True if this is a symbolic link */
+    isSymlink: boolean;
+    /** Last modified time (Unix timestamp in milliseconds) */
+    modified?: number;
+    /** Created time (Unix timestamp in milliseconds) */
+    created?: number;
+    /** Whether the file is read-only */
+    readonly: boolean;
+}
+/**
+ * Directory entry
+ */
+interface DirEntry {
+    /** Entry name (not full path) */
+    name: string;
+    /** Full path */
+    path: string;
+    /** True if this is a file */
+    isFile: boolean;
+    /** True if this is a directory */
+    isDirectory: boolean;
+    /** File size in bytes (0 for directories) */
+    size: number;
+    /** Last modified time (Unix timestamp in milliseconds) */
+    modified?: number;
+}
+/**
+ * Options for selecting a folder
+ */
+interface SelectFolderOptions {
+    /** Dialog title */
+    title?: string;
+    /** Default path to open */
+    defaultPath?: string;
+}
+/**
+ * Options for selecting files
+ */
+interface SelectFileOptions {
+    /** Dialog title */
+    title?: string;
+    /** Default path to open */
+    defaultPath?: string;
+    /** File filters (name -> extensions) */
+    filters?: Array<[string, string[]]>;
+    /** Allow multiple file selection */
+    multiple?: boolean;
+}
 declare class FilesystemAPI {
     private client;
     readonly sync: FileSyncAPI;
@@ -528,6 +586,71 @@ declare class FilesystemAPI {
      * @returns The result of the operation
      */
     showImageAsync(options: ShowImageOptions): Promise<ShowImageResult>;
+    /**
+     * Read file contents
+     * @param path Absolute path to the file
+     * @returns File contents as Uint8Array
+     */
+    readFile(path: string): Promise<Uint8Array>;
+    /**
+     * Write file contents
+     * @param path Absolute path to the file
+     * @param data File contents as Uint8Array
+     */
+    writeFile(path: string, data: Uint8Array): Promise<void>;
+    /**
+     * Read directory contents
+     * @param path Absolute path to the directory
+     * @returns Array of directory entries
+     */
+    readDir(path: string): Promise<DirEntry[]>;
+    /**
+     * Create a directory (and parent directories if needed)
+     * @param path Absolute path to create
+     */
+    mkdir(path: string): Promise<void>;
+    /**
+     * Remove a file or directory
+     * @param path Absolute path to remove
+     * @param recursive If true, remove directories recursively
+     */
+    remove(path: string, recursive?: boolean): Promise<void>;
+    /**
+     * Check if a path exists
+     * @param path Absolute path to check
+     * @returns True if the path exists
+     */
+    exists(path: string): Promise<boolean>;
+    /**
+     * Get file/directory metadata
+     * @param path Absolute path
+     * @returns File metadata
+     */
+    stat(path: string): Promise<FileStat>;
+    /**
+     * Open a folder selection dialog
+     * @param options Dialog options
+     * @returns Selected folder path, or null if cancelled
+     */
+    selectFolder(options?: SelectFolderOptions): Promise<string | null>;
+    /**
+     * Open a file selection dialog
+     * @param options Dialog options
+     * @returns Selected file paths, or null if cancelled
+     */
+    selectFile(options?: SelectFileOptions): Promise<string[] | null>;
+    /**
+     * Rename/move a file or directory
+     * @param from Source path
+     * @param to Destination path
+     */
+    rename(from: string, to: string): Promise<void>;
+    /**
+     * Copy a file
+     * @param from Source path
+     * @param to Destination path
+     */
+    copy(from: string, to: string): Promise<void>;
 }
 
 declare class WebAPI {
@@ -588,6 +711,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
  *
@@ -618,6 +870,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;
@@ -661,4 +914,4 @@ declare class HaexVaultSdk {
     private log;
 }
 
-export { type AddBackendOptions as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, CONFLICT_STRATEGY as E, FilesystemAPI as F, type GetQueueOptions as G, HaexVaultSdk as H, QUEUE_OPERATION as I, QUEUE_STATUS as J, type ListFilesOptions as L, PermissionsAPI as P, type QueueOperation as Q, 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, type QueueStatus as s, type SyncQueueEntry as t, type AddToQueueOptions as u, type QueueFileEntry as v, type QueueSummary as w, FILE_SYNC_STATE as x, SYNC_DIRECTION as y, STORAGE_BACKEND_TYPE as z };
+export { type AddBackendRequest as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, type QueueStatus as E, FilesystemAPI as F, type SyncQueueEntry as G, HaexVaultSdk as H, type AddToQueueOptions as I, type QueueFileEntry as J, type GetQueueOptions as K, type ListFilesOptions as L, type QueueSummary as M, FILE_SYNC_STATE as N, SYNC_DIRECTION as O, PermissionsAPI as P, type QueueOperation as Q, RemoteStorageAPI as R, StorageAPI as S, STORAGE_BACKEND_TYPE as T, type UpdateSyncRuleOptions as U, CONFLICT_STRATEGY as V, WebAPI as W, QUEUE_OPERATION as X, QUEUE_STATUS as Y, type FileStat as a, type DirEntry as b, type SelectFolderOptions as c, type SelectFileOptions as d, FileSyncAPI as e, type StorageBackendInfo as f, type S3Config as g, type StorageObjectInfo as h, type FileSpace as i, type FileInfo as j, type FileSyncState as k, type StorageBackendInfo$1 as l, type StorageBackendType as m, type S3BackendConfig as n, type SyncRule as o, type SyncDirection as p, type SyncStatus as q, type SyncError as r, type SyncProgress as s, type CreateSpaceOptions as t, type AddBackendOptions as u, type AddSyncRuleOptions as v, type ScanLocalOptions as w, type UploadFileOptions as x, type DownloadFileOptions as y, type LocalFileInfo as z };

package/dist/{client-CYgMbZKT.d.ts → client-Bp4IqvzW.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;
@@ -352,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
      */
@@ -502,6 +502,64 @@ interface ShowImageResult {
      */
     success: boolean;
 }
+/**
+ * File/directory metadata
+ */
+interface FileStat {
+    /** File size in bytes */
+    size: number;
+    /** True if this is a file */
+    isFile: boolean;
+    /** True if this is a directory */
+    isDirectory: boolean;
+    /** True if this is a symbolic link */
+    isSymlink: boolean;
+    /** Last modified time (Unix timestamp in milliseconds) */
+    modified?: number;
+    /** Created time (Unix timestamp in milliseconds) */
+    created?: number;
+    /** Whether the file is read-only */
+    readonly: boolean;
+}
+/**
+ * Directory entry
+ */
+interface DirEntry {
+    /** Entry name (not full path) */
+    name: string;
+    /** Full path */
+    path: string;
+    /** True if this is a file */
+    isFile: boolean;
+    /** True if this is a directory */
+    isDirectory: boolean;
+    /** File size in bytes (0 for directories) */
+    size: number;
+    /** Last modified time (Unix timestamp in milliseconds) */
+    modified?: number;
+}
+/**
+ * Options for selecting a folder
+ */
+interface SelectFolderOptions {
+    /** Dialog title */
+    title?: string;
+    /** Default path to open */
+    defaultPath?: string;
+}
+/**
+ * Options for selecting files
+ */
+interface SelectFileOptions {
+    /** Dialog title */
+    title?: string;
+    /** Default path to open */
+    defaultPath?: string;
+    /** File filters (name -> extensions) */
+    filters?: Array<[string, string[]]>;
+    /** Allow multiple file selection */
+    multiple?: boolean;
+}
 declare class FilesystemAPI {
     private client;
     readonly sync: FileSyncAPI;
@@ -528,6 +586,71 @@ declare class FilesystemAPI {
      * @returns The result of the operation
      */
     showImageAsync(options: ShowImageOptions): Promise<ShowImageResult>;
+    /**
+     * Read file contents
+     * @param path Absolute path to the file
+     * @returns File contents as Uint8Array
+     */
+    readFile(path: string): Promise<Uint8Array>;
+    /**
+     * Write file contents
+     * @param path Absolute path to the file
+     * @param data File contents as Uint8Array
+     */
+    writeFile(path: string, data: Uint8Array): Promise<void>;
+    /**
+     * Read directory contents
+     * @param path Absolute path to the directory
+     * @returns Array of directory entries
+     */
+    readDir(path: string): Promise<DirEntry[]>;
+    /**
+     * Create a directory (and parent directories if needed)
+     * @param path Absolute path to create
+     */
+    mkdir(path: string): Promise<void>;
+    /**
+     * Remove a file or directory
+     * @param path Absolute path to remove
+     * @param recursive If true, remove directories recursively
+     */
+    remove(path: string, recursive?: boolean): Promise<void>;
+    /**
+     * Check if a path exists
+     * @param path Absolute path to check
+     * @returns True if the path exists
+     */
+    exists(path: string): Promise<boolean>;
+    /**
+     * Get file/directory metadata
+     * @param path Absolute path
+     * @returns File metadata
+     */
+    stat(path: string): Promise<FileStat>;
+    /**
+     * Open a folder selection dialog
+     * @param options Dialog options
+     * @returns Selected folder path, or null if cancelled
+     */
+    selectFolder(options?: SelectFolderOptions): Promise<string | null>;
+    /**
+     * Open a file selection dialog
+     * @param options Dialog options
+     * @returns Selected file paths, or null if cancelled
+     */
+    selectFile(options?: SelectFileOptions): Promise<string[] | null>;
+    /**
+     * Rename/move a file or directory
+     * @param from Source path
+     * @param to Destination path
+     */
+    rename(from: string, to: string): Promise<void>;
+    /**
+     * Copy a file
+     * @param from Source path
+     * @param to Destination path
+     */
+    copy(from: string, to: string): Promise<void>;
 }
 
 declare class WebAPI {
@@ -588,6 +711,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
  *
@@ -618,6 +870,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;
@@ -661,4 +914,4 @@ declare class HaexVaultSdk {
     private log;
 }
 
-export { type AddBackendOptions as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, CONFLICT_STRATEGY as E, FilesystemAPI as F, type GetQueueOptions as G, HaexVaultSdk as H, QUEUE_OPERATION as I, QUEUE_STATUS as J, type ListFilesOptions as L, PermissionsAPI as P, type QueueOperation as Q, 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, type QueueStatus as s, type SyncQueueEntry as t, type AddToQueueOptions as u, type QueueFileEntry as v, type QueueSummary as w, FILE_SYNC_STATE as x, SYNC_DIRECTION as y, STORAGE_BACKEND_TYPE as z };
+export { type AddBackendRequest as A, type BackendConfig as B, type ConflictStrategy as C, DatabaseAPI as D, type QueueStatus as E, FilesystemAPI as F, type SyncQueueEntry as G, HaexVaultSdk as H, type AddToQueueOptions as I, type QueueFileEntry as J, type GetQueueOptions as K, type ListFilesOptions as L, type QueueSummary as M, FILE_SYNC_STATE as N, SYNC_DIRECTION as O, PermissionsAPI as P, type QueueOperation as Q, RemoteStorageAPI as R, StorageAPI as S, STORAGE_BACKEND_TYPE as T, type UpdateSyncRuleOptions as U, CONFLICT_STRATEGY as V, WebAPI as W, QUEUE_OPERATION as X, QUEUE_STATUS as Y, type FileStat as a, type DirEntry as b, type SelectFolderOptions as c, type SelectFileOptions as d, FileSyncAPI as e, type StorageBackendInfo as f, type S3Config as g, type StorageObjectInfo as h, type FileSpace as i, type FileInfo as j, type FileSyncState as k, type StorageBackendInfo$1 as l, type StorageBackendType as m, type S3BackendConfig as n, type SyncRule as o, type SyncDirection as p, type SyncStatus as q, type SyncError as r, type SyncProgress as s, type CreateSpaceOptions as t, type AddBackendOptions as u, type AddSyncRuleOptions as v, type ScanLocalOptions as w, type UploadFileOptions as x, type DownloadFileOptions as y, type LocalFileInfo as z };