@haex-space/vault-sdk 2.5.56 → 2.5.60

package/dist/index.d.mts

@@ -82,67 +82,6 @@ declare function installBaseTag(): void;
  */
 declare function installPolyfills(): void;
 
-/**
- * Central request method name definitions for HaexHub SDK
- *
- * Request Naming Schema: haextension:{subject}:{action}
- *
- * These are used for client.request() calls between extensions and HaexHub
- */
-declare const HAEXTENSION_METHODS: {
-    readonly context: {
-        readonly get: "haextension:context:get";
-    };
-    readonly database: {
-        readonly query: "haextension:database:query";
-        readonly execute: "haextension:database:execute";
-        readonly transaction: "haextension:database:transaction";
-        readonly registerMigrations: "haextension:database:register-migrations";
-    };
-    readonly filesystem: {
-        readonly saveFile: "haextension:filesystem:save-file";
-        readonly openFile: "haextension:filesystem:open-file";
-        readonly showImage: "haextension:filesystem:show-image";
-        readonly readFile: "haextension:filesystem:read-file";
-        readonly writeFile: "haextension:filesystem:write-file";
-        readonly readDir: "haextension:filesystem:read-dir";
-        readonly mkdir: "haextension:filesystem:mkdir";
-        readonly remove: "haextension:filesystem:remove";
-        readonly exists: "haextension:filesystem:exists";
-        readonly stat: "haextension:filesystem:stat";
-        readonly selectFolder: "haextension:filesystem:select-folder";
-        readonly selectFile: "haextension:filesystem:select-file";
-        readonly rename: "haextension:filesystem:rename";
-        readonly copy: "haextension:filesystem:copy";
-    };
-    readonly storage: {
-        readonly getItem: "haextension:storage:get-item";
-        readonly setItem: "haextension:storage:set-item";
-        readonly removeItem: "haextension:storage:remove-item";
-        readonly clear: "haextension:storage:clear";
-        readonly keys: "haextension:storage:keys";
-    };
-    readonly remoteStorage: {
-        readonly listBackends: "haextension:remote-storage:list-backends";
-        readonly addBackend: "haextension:remote-storage:add-backend";
-        readonly updateBackend: "haextension:remote-storage:update-backend";
-        readonly removeBackend: "haextension:remote-storage:remove-backend";
-        readonly testBackend: "haextension:remote-storage:test-backend";
-        readonly upload: "haextension:remote-storage:upload";
-        readonly download: "haextension:remote-storage:download";
-        readonly delete: "haextension:remote-storage:delete";
-        readonly list: "haextension:remote-storage:list";
-    };
-    readonly web: {
-        readonly fetch: "haextension:web:fetch";
-    };
-    readonly application: {
-        readonly open: "haextension:application:open";
-    };
-};
-type DeepValues<T> = T extends object ? T[keyof T] extends string ? T[keyof T] : T[keyof T] extends object ? DeepValues<T[keyof T]> : never : never;
-type HaextensionMethod = DeepValues<typeof HAEXTENSION_METHODS>;
-
 /**
  * Central message type definitions for HaexSpace SDK
  *
@@ -158,44 +97,278 @@ declare const HAEXSPACE_MESSAGE_TYPES: {
 };
 type HaexspaceMessageType = (typeof HAEXSPACE_MESSAGE_TYPES)[keyof typeof HAEXSPACE_MESSAGE_TYPES];
 
+/**
+ * Database Commands
+ *
+ * Commands for extension database operations.
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Current naming: `webview_extension_db_<action>` (legacy)
+ * Target naming: `extension_database_<action>` (unified)
+ */
+declare const DATABASE_COMMANDS: {
+    /** Execute a SELECT query */
+    readonly query: "extension_database_query";
+    /** Execute INSERT/UPDATE/DELETE statement */
+    readonly execute: "extension_database_execute";
+    /** Execute multiple statements in a transaction */
+    readonly transaction: "extension_database_transaction";
+    /** Register and apply database migrations */
+    readonly registerMigrations: "extension_database_register_migrations";
+};
+
+/**
+ * Permissions Commands
+ *
+ * Commands for checking extension permissions.
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_permissions_<action>`
+ */
+declare const PERMISSIONS_COMMANDS: {
+    /** Check web/fetch permission */
+    readonly checkWeb: "extension_permissions_check_web";
+    /** Check database permission */
+    readonly checkDatabase: "extension_permissions_check_database";
+    /** Check filesystem permission */
+    readonly checkFilesystem: "extension_permissions_check_filesystem";
+};
+
+/**
+ * Web Commands
+ *
+ * Commands for web operations (fetch, open URLs).
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_web_<action>`
+ */
+declare const WEB_COMMANDS: {
+    /** Open URL in external browser */
+    readonly open: "extension_web_open";
+    /** Make HTTP request (bypasses CORS) */
+    readonly fetch: "extension_web_fetch";
+};
+
+/**
+ * Web Storage Commands
+ *
+ * Commands for extension local storage (key-value, similar to localStorage).
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_web_storage_<action>`
+ */
+declare const WEB_STORAGE_COMMANDS: {
+    /** Get item from storage */
+    readonly getItem: "extension_web_storage_get_item";
+    /** Set item in storage */
+    readonly setItem: "extension_web_storage_set_item";
+    /** Remove item from storage */
+    readonly removeItem: "extension_web_storage_remove_item";
+    /** Clear all storage */
+    readonly clear: "extension_web_storage_clear";
+    /** Get all storage keys */
+    readonly keys: "extension_web_storage_keys";
+};
+
+/**
+ * Filesystem Commands
+ *
+ * Commands for filesystem operations.
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_filesystem_<action>`
+ */
+declare const FILESYSTEM_COMMANDS: {
+    /** Show save file dialog */
+    readonly saveFile: "extension_filesystem_save_file";
+    /** Show open file dialog */
+    readonly openFile: "extension_filesystem_open_file";
+    /** Show image in native viewer */
+    readonly showImage: "extension_filesystem_show_image";
+    /** Read file contents as base64 */
+    readonly readFile: "extension_filesystem_read_file";
+    /** Write base64 data to file */
+    readonly writeFile: "extension_filesystem_write_file";
+    /** List directory contents */
+    readonly readDir: "extension_filesystem_read_dir";
+    /** Create directory */
+    readonly mkdir: "extension_filesystem_mkdir";
+    /** Remove file or directory */
+    readonly remove: "extension_filesystem_remove";
+    /** Check if path exists */
+    readonly exists: "extension_filesystem_exists";
+    /** Get file/directory metadata */
+    readonly stat: "extension_filesystem_stat";
+    /** Show folder selection dialog */
+    readonly selectFolder: "extension_filesystem_select_folder";
+    /** Show file selection dialog */
+    readonly selectFile: "extension_filesystem_select_file";
+    /** Rename file or directory */
+    readonly rename: "extension_filesystem_rename";
+    /** Copy file or directory */
+    readonly copy: "extension_filesystem_copy";
+};
+
+/**
+ * External Bridge Commands
+ *
+ * Commands for the external bridge (browser extension communication).
+ *
+ * Uses two prefixes:
+ * - `webview_extension_external_` - WebView-specific (respond to requests)
+ * - `external_` - Bridge management commands
+ *
+ * TODO: Migrate all to `extension_external_bridge_` prefix for consistency.
+ */
+declare const EXTERNAL_BRIDGE_COMMANDS: {
+    /** Respond to an external request */
+    readonly respond: "webview_extension_external_respond";
+    /** Start the external bridge server */
+    readonly bridgeStart: "external_bridge_start";
+    /** Stop the external bridge server */
+    readonly bridgeStop: "external_bridge_stop";
+    /** Get bridge server status */
+    readonly bridgeGetStatus: "external_bridge_get_status";
+    /** Allow a client connection */
+    readonly clientAllow: "external_client_allow";
+    /** Block a client connection */
+    readonly clientBlock: "external_client_block";
+    /** Get list of authorized clients */
+    readonly getAuthorizedClients: "external_get_authorized_clients";
+    /** Revoke client authorization */
+    readonly revokeClient: "external_revoke_client";
+    /** Get session authorizations */
+    readonly getSessionAuthorizations: "external_get_session_authorizations";
+    /** Revoke session authorization */
+    readonly revokeSessionAuthorization: "external_revoke_session_authorization";
+    /** Get list of blocked clients */
+    readonly getBlockedClients: "external_get_blocked_clients";
+    /** Unblock a client */
+    readonly unblockClient: "external_unblock_client";
+    /** Check if client is blocked */
+    readonly isClientBlocked: "external_is_client_blocked";
+    /** Get pending authorization requests */
+    readonly getPendingAuthorizations: "external_get_pending_authorizations";
+};
+
+/**
+ * Extension Commands
+ *
+ * Commands for extension info and context.
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_<action>`
+ */
+declare const EXTENSION_COMMANDS: {
+    /** Get extension info (manifest, id, etc.) */
+    readonly getInfo: "extension_get_info";
+    /** Get application context (theme, locale, etc.) */
+    readonly getContext: "extension_get_context";
+};
+
+/**
+ * Remote Storage Commands
+ *
+ * Commands for remote storage operations (S3-compatible backends).
+ * These commands are used for both:
+ * - Tauri invoke (WebView extensions)
+ * - postMessage (iframe extensions)
+ *
+ * Naming convention: `extension_remote_storage_<action>`
+ */
+declare const REMOTE_STORAGE_COMMANDS: {
+    /** List all storage backends */
+    readonly listBackends: "extension_remote_storage_list_backends";
+    /** Add a new storage backend */
+    readonly addBackend: "extension_remote_storage_add_backend";
+    /** Update storage backend configuration */
+    readonly updateBackend: "extension_remote_storage_update_backend";
+    /** Remove a storage backend */
+    readonly removeBackend: "extension_remote_storage_remove_backend";
+    /** Test storage backend connection */
+    readonly testBackend: "extension_remote_storage_test_backend";
+    /** Upload data to storage backend */
+    readonly upload: "extension_remote_storage_upload";
+    /** Download data from storage backend */
+    readonly download: "extension_remote_storage_download";
+    /** Delete object from storage backend */
+    readonly delete: "extension_remote_storage_delete";
+    /** List objects in storage backend */
+    readonly list: "extension_remote_storage_list";
+};
+
 /**
  * Tauri Command Names
  *
  * Central definition of all Tauri invoke command names.
  * These must match the #[tauri::command] function names in Rust.
+ *
+ * ## Naming Convention
+ *
+ * Commands follow the pattern: `<context>_<module>_<action>`
+ *
+ * ### Contexts:
+ * - `extension_` - Commands called by extensions (permission-checked)
+ * - `webview_extension_` - Legacy WebView-specific commands (being migrated to extension_)
+ *
+ * ### Examples:
+ * - `extension_remote_storage_list_backends` - Extension remote storage command
+ * - `extension_database_query` - Extension database query
+ * - `extension_filesystem_read_file` - Extension filesystem read
  */
+
 declare const TAURI_COMMANDS: {
     readonly database: {
-        readonly query: "webview_extension_db_query";
-        readonly execute: "webview_extension_db_execute";
-        readonly registerMigrations: "webview_extension_db_register_migrations";
+        readonly query: "extension_database_query";
+        readonly execute: "extension_database_execute";
+        readonly transaction: "extension_database_transaction";
+        readonly registerMigrations: "extension_database_register_migrations";
     };
     readonly permissions: {
-        readonly checkWeb: "webview_extension_check_web_permission";
-        readonly checkDatabase: "webview_extension_check_database_permission";
-        readonly checkFilesystem: "webview_extension_check_filesystem_permission";
+        readonly checkWeb: "extension_permissions_check_web";
+        readonly checkDatabase: "extension_permissions_check_database";
+        readonly checkFilesystem: "extension_permissions_check_filesystem";
     };
     readonly web: {
-        readonly open: "webview_extension_web_open";
-        readonly fetch: "webview_extension_web_request";
+        readonly open: "extension_web_open";
+        readonly fetch: "extension_web_fetch";
+    };
+    readonly webStorage: {
+        readonly getItem: "extension_web_storage_get_item";
+        readonly setItem: "extension_web_storage_set_item";
+        readonly removeItem: "extension_web_storage_remove_item";
+        readonly clear: "extension_web_storage_clear";
+        readonly keys: "extension_web_storage_keys";
     };
     readonly filesystem: {
-        readonly saveFile: "webview_extension_fs_save_file";
-        readonly openFile: "webview_extension_fs_open_file";
-        readonly showImage: "webview_extension_fs_show_image";
-        readonly readFile: "filesystem_read_file";
-        readonly writeFile: "filesystem_write_file";
-        readonly readDir: "filesystem_read_dir";
-        readonly mkdir: "filesystem_mkdir";
-        readonly remove: "filesystem_remove";
-        readonly exists: "filesystem_exists";
-        readonly stat: "filesystem_stat";
-        readonly selectFolder: "filesystem_select_folder";
-        readonly selectFile: "filesystem_select_file";
-        readonly rename: "filesystem_rename";
-        readonly copy: "filesystem_copy";
+        readonly saveFile: "extension_filesystem_save_file";
+        readonly openFile: "extension_filesystem_open_file";
+        readonly showImage: "extension_filesystem_show_image";
+        readonly readFile: "extension_filesystem_read_file";
+        readonly writeFile: "extension_filesystem_write_file";
+        readonly readDir: "extension_filesystem_read_dir";
+        readonly mkdir: "extension_filesystem_mkdir";
+        readonly remove: "extension_filesystem_remove";
+        readonly exists: "extension_filesystem_exists";
+        readonly stat: "extension_filesystem_stat";
+        readonly selectFolder: "extension_filesystem_select_folder";
+        readonly selectFile: "extension_filesystem_select_file";
+        readonly rename: "extension_filesystem_rename";
+        readonly copy: "extension_filesystem_copy";
     };
-    readonly external: {
+    readonly externalBridge: {
         readonly respond: "webview_extension_external_respond";
         readonly bridgeStart: "external_bridge_start";
         readonly bridgeStop: "external_bridge_stop";
@@ -212,22 +385,22 @@ declare const TAURI_COMMANDS: {
         readonly getPendingAuthorizations: "external_get_pending_authorizations";
     };
     readonly extension: {
-        readonly getInfo: "webview_extension_get_info";
-        readonly getContext: "webview_extension_context_get";
+        readonly getInfo: "extension_get_info";
+        readonly getContext: "extension_get_context";
     };
-    readonly storage: {
-        readonly listBackends: "storage_list_backends";
-        readonly addBackend: "storage_add_backend";
-        readonly updateBackend: "storage_update_backend";
-        readonly removeBackend: "storage_remove_backend";
-        readonly testBackend: "storage_test_backend";
-        readonly upload: "storage_upload";
-        readonly download: "storage_download";
-        readonly delete: "storage_delete";
-        readonly list: "storage_list";
+    readonly remoteStorage: {
+        readonly listBackends: "extension_remote_storage_list_backends";
+        readonly addBackend: "extension_remote_storage_add_backend";
+        readonly updateBackend: "extension_remote_storage_update_backend";
+        readonly removeBackend: "extension_remote_storage_remove_backend";
+        readonly testBackend: "extension_remote_storage_test_backend";
+        readonly upload: "extension_remote_storage_upload";
+        readonly download: "extension_remote_storage_download";
+        readonly delete: "extension_remote_storage_delete";
+        readonly list: "extension_remote_storage_list";
     };
 };
-type TauriCommand = (typeof TAURI_COMMANDS.database)[keyof typeof TAURI_COMMANDS.database] | (typeof TAURI_COMMANDS.permissions)[keyof typeof TAURI_COMMANDS.permissions] | (typeof TAURI_COMMANDS.web)[keyof typeof TAURI_COMMANDS.web] | (typeof TAURI_COMMANDS.filesystem)[keyof typeof TAURI_COMMANDS.filesystem] | (typeof TAURI_COMMANDS.external)[keyof typeof TAURI_COMMANDS.external] | (typeof TAURI_COMMANDS.extension)[keyof typeof TAURI_COMMANDS.extension] | (typeof TAURI_COMMANDS.storage)[keyof typeof TAURI_COMMANDS.storage];
+type TauriCommand = (typeof DATABASE_COMMANDS)[keyof typeof DATABASE_COMMANDS] | (typeof PERMISSIONS_COMMANDS)[keyof typeof PERMISSIONS_COMMANDS] | (typeof WEB_COMMANDS)[keyof typeof WEB_COMMANDS] | (typeof WEB_STORAGE_COMMANDS)[keyof typeof WEB_STORAGE_COMMANDS] | (typeof FILESYSTEM_COMMANDS)[keyof typeof FILESYSTEM_COMMANDS] | (typeof EXTERNAL_BRIDGE_COMMANDS)[keyof typeof EXTERNAL_BRIDGE_COMMANDS] | (typeof EXTENSION_COMMANDS)[keyof typeof EXTENSION_COMMANDS] | (typeof REMOTE_STORAGE_COMMANDS)[keyof typeof REMOTE_STORAGE_COMMANDS];
 
 interface VerifyResult {
     valid: boolean;
@@ -357,4 +530,4 @@ declare function base64ToArrayBuffer(base64: string): Uint8Array;
 
 declare function createHaexVaultSdk(config?: HaexHubConfig): HaexVaultSdk;
 
-export { ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HAEXTENSION_METHODS, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, type HaextensionMethod, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, generateVaultKey, hexToBytes, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, wrapKey };
+export { ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, generateVaultKey, hexToBytes, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, wrapKey };