Hiyve Components - v1.0.0
    Preparing search index...

    Interface FileCacheContextValue

    File cache context value

    interface FileCacheContextValue {
        _isProvided?: boolean;
        cacheError: string | null;
        cacheState: CacheState;
        createFolder: (name: string, parentPath?: string) => Promise<boolean>;
        deleteFile: (fileId: string) => Promise<boolean>;
        deleteFolder: (path: string) => Promise<boolean>;
        folderMigrationState: "complete" | "pending" | null;
        getFilesByType: (types: string[]) => Promise<FileEntry[]>;
        getFileTree: (path?: string) => Promise<FileTree | null>;
        getFileUrl: (file: FileEntry) => Promise<string | null>;
        isReady: boolean;
        isSwitching: boolean;
        loadFolder: (path: string) => Promise<FileTree | null>;
        moveFile: (fileId: string, newPath: string) => Promise<boolean>;
        refreshCache: () => Promise<void>;
        renameFile: (fileId: string, newName: string) => Promise<boolean>;
        renameFolder: (folderId: string, newName: string) => Promise<boolean>;
        resourceTypes: string[];
        shareFile: (files: FileEntry[], userIds: string[]) => Promise<boolean>;
        syncWithServer: () => Promise<void>;
        uploadFile: (file: File, path?: string) => Promise<FileEntry | null>;
    }
    Index

    Properties

    _isProvided? cacheError cacheState createFolder deleteFile deleteFolder folderMigrationState getFilesByType getFileTree getFileUrl isReady isSwitching loadFolder moveFile refreshCache renameFile renameFolder resourceTypes shareFile syncWithServer uploadFile

    Properties

    Optional Internal_isProvided

    _isProvided?: boolean

    Sentinel to distinguish a real provider from the default context value.

    cacheError: string | null
    cacheState: CacheState
    createFolder: (name: string, parentPath?: string) => Promise<boolean>
    deleteFile: (fileId: string) => Promise<boolean>
    deleteFolder: (path: string) => Promise<boolean>
    folderMigrationState: "complete" | "pending" | null

    Which folder model this user is on. 'complete' unlocks id-based folder operations (rename); null = unknown (not fetched / not wired), treated as 'pending' by the UI.

    getFilesByType: (types: string[]) => Promise<FileEntry[]>
    getFileTree: (path?: string) => Promise<FileTree | null>
    getFileUrl: (file: FileEntry) => Promise<string | null>

    Get a URL for viewing/downloading a file. Uses client API methods for different resource types:

    • Regular files: client.getFileURL
    • Recordings: client.getRecordingUrls
    • Compositions: client.getCompositionUrl
    isReady: boolean
    isSwitching: boolean
    loadFolder: (path: string) => Promise<FileTree | null>
    moveFile: (fileId: string, newPath: string) => Promise<boolean>
    refreshCache: () => Promise<void>
    renameFile: (fileId: string, newName: string) => Promise<boolean>
    renameFolder: (folderId: string, newName: string) => Promise<boolean>

    Rename a folder by its stable id — offered by the UI only when folderMigrationState is 'complete' (the id-model flip), the caller owns the folder, and it is not a system folder. Resolves false when no capability is wired.

    resourceTypes: string[]

    All distinct resource types present in the cached files

    shareFile: (files: FileEntry[], userIds: string[]) => Promise<boolean>

    Share files with specified users.

    Accepts FileEntry[] (not just fileIds) because cascade resolution needs the resourceType to determine which files contain references to other files (e.g. clip-compositions referencing audio clips).

    Sharing is two-phase:

    1. Share the explicitly selected files
    2. Best-effort cascade: discover and share referenced files (failures in cascade do not fail the overall operation)
    syncWithServer: () => Promise<void>
    uploadFile: (file: File, path?: string) => Promise<FileEntry | null>

    Settings

    Member Visibility

    On This Page

    Properties