@telecrypt-io/storage 0.3.0 → 0.5.7

package/dist/core/operations.d.ts

@@ -11,41 +11,50 @@
  * platform-specific and stays with the caller.
  */
 import { TeleCryptIOStorage } from "../TeleCryptIOStorage.js";
-import type { DownloadedFile, FileDetails, FileInfo, FolderDetails, FolderInfo, DeleteResult, JoinResult, Member, RecoveryRestore, RecoverySetup, RenameResult, ShareResult, UnshareResult } from "./types.js";
-export declare function createFolder(storage: TeleCryptIOStorage, name: string): Promise<FolderInfo>;
-/** Top-level folders only — excludes subdirectories of an existing tree. */
-export declare function listFolders(storage: TeleCryptIOStorage): Promise<FolderInfo[]>;
-/** Current account's effective role for a folder, or null while it is unavailable. */
-export declare function getMyFolderRole(storage: TeleCryptIOStorage, folderId: string): string | null;
-export declare function joinFolder(storage: TeleCryptIOStorage, folderId: string): Promise<JoinResult>;
+import type { DownloadedFile, FolderDetails, FolderInfo, FileDetails, FileInfo, VaultDetails, VaultInfo, DeleteResult, JoinResult, Member, RecoveryRestore, RecoverySetup, RenameResult, ShareResult, UnshareResult } from "./types.js";
+export interface OperationOptions {
+    /** Cancels bounded waits and rate-limit backoff before the next mutation. */
+    signal?: AbortSignal;
+    /** Total wall-clock budget for one mutation, including all descendants. */
+    timeoutMs?: number;
+}
+export declare function createVault(storage: TeleCryptIOStorage, name: string, options?: OperationOptions): Promise<VaultInfo>;
+/** Top-level vaults only — excludes subdirectories of an existing tree. */
+export declare function listVaults(storage: TeleCryptIOStorage, options?: OperationOptions): Promise<VaultInfo[]>;
+/** Current account's effective role for a vault, or null while it is unavailable. */
+export declare function getMyVaultRole(storage: TeleCryptIOStorage, vaultId: string): string | null;
+export declare function joinVault(storage: TeleCryptIOStorage, vaultId: string, options?: OperationOptions): Promise<JoinResult>;
 /** Rooms where this account is invited and the room looks like a file tree. */
-export declare function listPendingInvites(storage: TeleCryptIOStorage): Promise<FolderInfo[]>;
-/** Decline a folder invite (same as leaving before join). */
-export declare function declineInvite(storage: TeleCryptIOStorage, folderId: string): Promise<{
-    folderId: string;
+export declare function listPendingInvites(storage: TeleCryptIOStorage, options?: OperationOptions): Promise<VaultInfo[]>;
+/** Decline a vault invite (same as leaving before join). */
+export declare function declineInvite(storage: TeleCryptIOStorage, vaultId: string, options?: OperationOptions): Promise<{
+    vaultId: string;
     declined: boolean;
 }>;
-/**
- * Invites `userId` to the folder at `role` and applies the role's
- * permissions. Doubles as "change an existing participant's role" (call
- * again with a different role): inviting someone who's already a member is
- * a 403 from the server, not a real failure — that specific error is
- * swallowed and the role change still applies. Any other invite failure
- * (e.g. unknown user) propagates.
- */
-export declare function shareFolder(storage: TeleCryptIOStorage, folderId: string, userId: string, role: string): Promise<ShareResult>;
-export declare function unshareFolder(storage: TeleCryptIOStorage, folderId: string, userId: string): Promise<UnshareResult>;
-export declare function listMembers(storage: TeleCryptIOStorage, folderId: string): Promise<Member[]>;
-export declare function listFiles(storage: TeleCryptIOStorage, folderId: string): Promise<FileInfo[]>;
-export declare function listSubfolders(storage: TeleCryptIOStorage, folderId: string): Promise<FolderInfo[]>;
-export declare function createSubfolder(storage: TeleCryptIOStorage, folderId: string, name: string): Promise<FolderInfo>;
-export declare function renameFolder(storage: TeleCryptIOStorage, folderId: string, name: string): Promise<RenameResult>;
-export declare function deleteFolder(storage: TeleCryptIOStorage, folderId: string): Promise<DeleteResult>;
-export declare function renameFile(storage: TeleCryptIOStorage, folderId: string, fileId: string, name: string): Promise<RenameResult>;
-export declare function deleteFile(storage: TeleCryptIOStorage, folderId: string, fileId: string): Promise<DeleteResult>;
-export declare function uploadFile(storage: TeleCryptIOStorage, folderId: string, name: string, bytes: Uint8Array, mimetype: string): Promise<FileInfo>;
-export declare function downloadFile(storage: TeleCryptIOStorage, folderId: string, fileId: string): Promise<DownloadedFile>;
-export declare function setupRecovery(storage: TeleCryptIOStorage): Promise<RecoverySetup>;
-export declare function restoreRecovery(storage: TeleCryptIOStorage, recoveryKey: string): Promise<RecoveryRestore>;
-export declare function getFileDetails(storage: TeleCryptIOStorage, folderId: string, fileId: string): Promise<FileDetails>;
-export declare function getFolderDetails(storage: TeleCryptIOStorage, folderId: string): Promise<FolderDetails>;
+/** Invites `userId` to the vault and applies the requested role. */
+export declare function shareVault(storage: TeleCryptIOStorage, vaultId: string, userId: string, role: string, options?: OperationOptions): Promise<ShareResult>;
+export declare function unshareVault(storage: TeleCryptIOStorage, vaultId: string, userId: string, options?: OperationOptions): Promise<UnshareResult>;
+export declare function listMembers(storage: TeleCryptIOStorage, vaultId: string, options?: OperationOptions): Promise<Member[]>;
+export declare function listFiles(storage: TeleCryptIOStorage, treeId: string, options?: OperationOptions): Promise<FileInfo[]>;
+/** Lists the direct child folders of a vault or folder. */
+export declare function listSubfolders(storage: TeleCryptIOStorage, parentId: string, options?: OperationOptions): Promise<FolderInfo[]>;
+export declare function createSubfolder(storage: TeleCryptIOStorage, parentId: string, name: string, options?: OperationOptions): Promise<FolderInfo>;
+/** Renames a top-level Vault. */
+export declare function renameVault(storage: TeleCryptIOStorage, vaultId: string, name: string, options?: OperationOptions): Promise<RenameResult>;
+/** Renames a nested folder. */
+export declare function renameFolder(storage: TeleCryptIOStorage, folderId: string, name: string, options?: OperationOptions): Promise<RenameResult>;
+/** Deletes a top-level Vault. */
+export declare function deleteVault(storage: TeleCryptIOStorage, vaultId: string, options?: OperationOptions): Promise<DeleteResult>;
+/** Deletes a nested folder. */
+export declare function deleteFolder(storage: TeleCryptIOStorage, folderId: string, options?: OperationOptions): Promise<DeleteResult>;
+export declare function renameFile(storage: TeleCryptIOStorage, treeId: string, fileId: string, name: string, options?: OperationOptions): Promise<RenameResult>;
+export declare function deleteFile(storage: TeleCryptIOStorage, treeId: string, fileId: string, options?: OperationOptions): Promise<DeleteResult>;
+export declare function uploadFile(storage: TeleCryptIOStorage, treeId: string, name: string, bytes: Uint8Array, mimetype: string, options?: OperationOptions): Promise<FileInfo>;
+export declare function downloadFile(storage: TeleCryptIOStorage, treeId: string, fileId: string, options?: OperationOptions): Promise<DownloadedFile>;
+export declare function setupRecovery(storage: TeleCryptIOStorage, options?: OperationOptions): Promise<RecoverySetup>;
+export declare function restoreRecovery(storage: TeleCryptIOStorage, recoveryKey: string, options?: OperationOptions): Promise<RecoveryRestore>;
+export declare function getFileDetails(storage: TeleCryptIOStorage, treeId: string, fileId: string, options?: OperationOptions): Promise<FileDetails>;
+/** Returns details for a top-level Vault. */
+export declare function getVaultDetails(storage: TeleCryptIOStorage, vaultId: string, options?: OperationOptions): Promise<VaultDetails>;
+/** Returns details for a nested folder. */
+export declare function getFolderDetails(storage: TeleCryptIOStorage, folderId: string, options?: OperationOptions): Promise<FolderDetails>;