@haex-space/vault-sdk 2.5.100 → 2.5.101

package/dist/index.d.mts

@@ -82,6 +82,120 @@ declare function installBaseTag(): void;
  */
 declare function installPolyfills(): void;
 
+/**
+ * Sync Server API Types
+ *
+ * Types for communicating with the haex-sync-server authentication endpoints.
+ * Used by haex-vault and extensions that need to interact with the sync server.
+ */
+/**
+ * S3-compatible storage configuration provided by the sync server.
+ * This contains all credentials needed to access the user's storage bucket.
+ */
+interface StorageConfig {
+    /** S3 endpoint URL (e.g., "https://supabase.haex.space/storage/v1/s3") */
+    endpoint: string;
+    /** Access Key ID (Supabase project reference) */
+    accessKeyId: string;
+    /** Secret Access Key (Supabase anon key) */
+    secretAccessKey: string;
+    /** User's bucket name (e.g., "storage-{user_id}") */
+    bucket: string;
+    /** S3 region (usually "auto" for Supabase) */
+    region: string;
+}
+/**
+ * User info returned from auth endpoints
+ */
+interface AuthUser {
+    /** User's unique ID (UUID) */
+    id: string;
+    /** User's email address */
+    email: string;
+}
+/**
+ * Response from POST /auth/login and POST /auth/refresh endpoints.
+ *
+ * Contains:
+ * - Session tokens for vault sync (access_token, refresh_token)
+ * - Storage-only token for S3 operations (storage_token)
+ * - Pre-configured S3 storage settings (storage_config)
+ *
+ * The storage_token is scoped to only allow S3 storage access.
+ * It cannot be used to access vault data or other sensitive resources.
+ */
+interface LoginResponse {
+    /** JWT access token for vault sync operations */
+    access_token: string;
+    /** Refresh token for obtaining new access tokens */
+    refresh_token: string;
+    /** Token validity in seconds */
+    expires_in: number;
+    /** Token expiration timestamp (Unix epoch) */
+    expires_at: number;
+    /** Authenticated user info */
+    user: AuthUser;
+    /**
+     * Storage-only JWT token for S3 operations.
+     * This token is scoped to only allow storage access (scope: "storage").
+     * It cannot be used to access vault_keys, sync_changes, or other sensitive data.
+     * Only present if SUPABASE_JWT_SECRET is configured on the server.
+     */
+    storage_token?: string;
+    /**
+     * Storage token expiration timestamp (Unix epoch).
+     * Same as expires_at since both tokens expire at the same time.
+     */
+    storage_token_expires_at?: number;
+    /**
+     * Pre-configured S3 storage settings.
+     * Contains all credentials needed to access the user's storage bucket.
+     * Only present if storage_token is available.
+     */
+    storage_config?: StorageConfig;
+}
+/**
+ * Request body for POST /auth/login
+ */
+interface LoginRequest {
+    /** User's email address */
+    email: string;
+    /** User's password */
+    password: string;
+}
+/**
+ * Request body for POST /auth/refresh
+ */
+interface RefreshRequest {
+    /** Refresh token from previous login/refresh response */
+    refresh_token: string;
+}
+/**
+ * Server health check response from GET /
+ * Contains server info and Supabase configuration.
+ */
+interface ServerInfo {
+    /** Server name (e.g., "haex-sync-server") */
+    name: string;
+    /** Server version (e.g., "0.2.7") */
+    version: string;
+    /** Server status (should be "ok") */
+    status: string;
+    /** Environment (e.g., "development", "production") */
+    env: string;
+    /** Supabase URL for client initialization */
+    supabaseUrl: string;
+    /** Supabase anon key for client initialization */
+    supabaseAnonKey: string;
+}
+/**
+ * Error response from sync server endpoints
+ */
+interface ErrorResponse {
+    /** Error message */
+    error: string;
+}
+
 /**
  * Central message type definitions for HaexSpace SDK
  *
@@ -690,4 +804,4 @@ declare function exportKeyPairAsync(keyPair: PasskeyKeyPair): Promise<ExportedPa
 
 declare function createHaexVaultSdk(config?: HaexHubConfig): HaexVaultSdk;
 
-export { COSE_ALGORITHM, type CoseAlgorithm, type ExportedPasskeyKeyPair, ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, type PasskeyKeyPair, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, generateCredentialId, generatePasskeyPairAsync, generateVaultKey, hexToBytes, importPrivateKeyAsync, importPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, signWithPasskeyAsync, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, verifyWithPasskeyAsync, wrapKey };
+export { type AuthUser, COSE_ALGORITHM, type CoseAlgorithm, type ExportedPasskeyKeyPair, ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, type PasskeyKeyPair, type StorageConfig, type ErrorResponse as SyncServerErrorResponse, type ServerInfo as SyncServerInfo, type LoginRequest as SyncServerLoginRequest, type LoginResponse as SyncServerLoginResponse, type RefreshRequest as SyncServerRefreshRequest, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, generateCredentialId, generatePasskeyPairAsync, generateVaultKey, hexToBytes, importPrivateKeyAsync, importPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, signWithPasskeyAsync, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, verifyWithPasskeyAsync, wrapKey };

package/dist/index.d.ts

@@ -82,6 +82,120 @@ declare function installBaseTag(): void;
  */
 declare function installPolyfills(): void;
 
+/**
+ * Sync Server API Types
+ *
+ * Types for communicating with the haex-sync-server authentication endpoints.
+ * Used by haex-vault and extensions that need to interact with the sync server.
+ */
+/**
+ * S3-compatible storage configuration provided by the sync server.
+ * This contains all credentials needed to access the user's storage bucket.
+ */
+interface StorageConfig {
+    /** S3 endpoint URL (e.g., "https://supabase.haex.space/storage/v1/s3") */
+    endpoint: string;
+    /** Access Key ID (Supabase project reference) */
+    accessKeyId: string;
+    /** Secret Access Key (Supabase anon key) */
+    secretAccessKey: string;
+    /** User's bucket name (e.g., "storage-{user_id}") */
+    bucket: string;
+    /** S3 region (usually "auto" for Supabase) */
+    region: string;
+}
+/**
+ * User info returned from auth endpoints
+ */
+interface AuthUser {
+    /** User's unique ID (UUID) */
+    id: string;
+    /** User's email address */
+    email: string;
+}
+/**
+ * Response from POST /auth/login and POST /auth/refresh endpoints.
+ *
+ * Contains:
+ * - Session tokens for vault sync (access_token, refresh_token)
+ * - Storage-only token for S3 operations (storage_token)
+ * - Pre-configured S3 storage settings (storage_config)
+ *
+ * The storage_token is scoped to only allow S3 storage access.
+ * It cannot be used to access vault data or other sensitive resources.
+ */
+interface LoginResponse {
+    /** JWT access token for vault sync operations */
+    access_token: string;
+    /** Refresh token for obtaining new access tokens */
+    refresh_token: string;
+    /** Token validity in seconds */
+    expires_in: number;
+    /** Token expiration timestamp (Unix epoch) */
+    expires_at: number;
+    /** Authenticated user info */
+    user: AuthUser;
+    /**
+     * Storage-only JWT token for S3 operations.
+     * This token is scoped to only allow storage access (scope: "storage").
+     * It cannot be used to access vault_keys, sync_changes, or other sensitive data.
+     * Only present if SUPABASE_JWT_SECRET is configured on the server.
+     */
+    storage_token?: string;
+    /**
+     * Storage token expiration timestamp (Unix epoch).
+     * Same as expires_at since both tokens expire at the same time.
+     */
+    storage_token_expires_at?: number;
+    /**
+     * Pre-configured S3 storage settings.
+     * Contains all credentials needed to access the user's storage bucket.
+     * Only present if storage_token is available.
+     */
+    storage_config?: StorageConfig;
+}
+/**
+ * Request body for POST /auth/login
+ */
+interface LoginRequest {
+    /** User's email address */
+    email: string;
+    /** User's password */
+    password: string;
+}
+/**
+ * Request body for POST /auth/refresh
+ */
+interface RefreshRequest {
+    /** Refresh token from previous login/refresh response */
+    refresh_token: string;
+}
+/**
+ * Server health check response from GET /
+ * Contains server info and Supabase configuration.
+ */
+interface ServerInfo {
+    /** Server name (e.g., "haex-sync-server") */
+    name: string;
+    /** Server version (e.g., "0.2.7") */
+    version: string;
+    /** Server status (should be "ok") */
+    status: string;
+    /** Environment (e.g., "development", "production") */
+    env: string;
+    /** Supabase URL for client initialization */
+    supabaseUrl: string;
+    /** Supabase anon key for client initialization */
+    supabaseAnonKey: string;
+}
+/**
+ * Error response from sync server endpoints
+ */
+interface ErrorResponse {
+    /** Error message */
+    error: string;
+}
+
 /**
  * Central message type definitions for HaexSpace SDK
  *
@@ -690,4 +804,4 @@ declare function exportKeyPairAsync(keyPair: PasskeyKeyPair): Promise<ExportedPa
 
 declare function createHaexVaultSdk(config?: HaexHubConfig): HaexVaultSdk;
 
-export { COSE_ALGORITHM, type CoseAlgorithm, type ExportedPasskeyKeyPair, ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, type PasskeyKeyPair, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, generateCredentialId, generatePasskeyPairAsync, generateVaultKey, hexToBytes, importPrivateKeyAsync, importPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, signWithPasskeyAsync, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, verifyWithPasskeyAsync, wrapKey };
+export { type AuthUser, COSE_ALGORITHM, type CoseAlgorithm, type ExportedPasskeyKeyPair, ExtensionManifest, HAEXSPACE_MESSAGE_TYPES, HaexHubConfig, HaexVaultSdk, type HaexspaceMessageType, type PasskeyKeyPair, type StorageConfig, type ErrorResponse as SyncServerErrorResponse, type ServerInfo as SyncServerInfo, type LoginRequest as SyncServerLoginRequest, type LoginResponse as SyncServerLoginResponse, type RefreshRequest as SyncServerRefreshRequest, TAURI_COMMANDS, type TauriCommand, type VerifyResult, type ZipFileEntry, arrayBufferToBase64, base64ToArrayBuffer, createHaexVaultSdk, decryptCrdtData, decryptString, decryptVaultKey, decryptVaultName, deriveKeyFromPassword, encryptCrdtData, encryptString, encryptVaultKey, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, generateCredentialId, generatePasskeyPairAsync, generateVaultKey, hexToBytes, importPrivateKeyAsync, importPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, signWithPasskeyAsync, sortObjectKeysRecursively, unwrapKey, verifyExtensionSignature, verifyWithPasskeyAsync, wrapKey };