Skip to content

Blobs Docs

GitHub

Select theme

Getting Started
- Introduction
Architecture
- Overview
- Modules
- Data Flow
- Permissions
- Module Deep Dives
Components
- Overview
- Blobs
  - Blob Editor
  - Blob List Item
API Reference
- Interactive Reference
TypeScript SDK
- Overview
- Core
  - Blobs
    
    core/Blobs
    
    classes
    
    BlobsClient
    
    interfaces
    
    BlobsClientConfig
    
    namespaces
    
    Blobs
    
    Blobs
    
    functions
    
    createDefaultNetwork()
    getInstance()
    init()
    setInstance()
    validateNetworkConfig()
    version()
    
    type-aliases
    
    BlobsInstance
    TransportType
  - BlobsContext
    
    core/BlobsContext
    
    functions
    
    cloneContextWithFilter()
    createBlobsContext()
    
    interfaces
    
    BlobsContext
  - ConfigManager
    
    core/ConfigManager
    
    classes
    
    ConfigManager
    
    functions
    
    createConfigManager()
    getDefaultConfig()
    getDefaultGlobalNetwork()
  - EventManager
    
    core/EventManager
    
    classes
    
    EventManager
    
    enumerations
    
    EventTypes
    
    interfaces
    
    EventSubscription
    HideModalEvent
    ModalActionEvent
    ShowModalEvent
    
    type-aliases
    
    EventCallback
    
    variables
    
    eventManager
  - Logger
    
    core/Logger
    
    classes
    
    Logger
    
    enumerations
    
    LogLevel
    
    functions
    
    configureLogger()
    createLogger()
    getLoggerConfig()
    
    interfaces
    
    LoggerConfig
  - NetworkContext
    
    core/NetworkContext
    
    classes
    
    NetworkContextResolver
  - NetworkContextTypes
    
    core/NetworkContextTypes
    
    interfaces
    
    MultiNetworkOptions
    NetworkContext
    NetworkContextState
    Response<T>
    
    type-aliases
    
    NetworkFilter
  - NetworkManager
    
    core/NetworkManager
    
    classes
    
    NetworkManager
    
    interfaces
    
    NetworkConflict
  - OperationProxy
    
    core/OperationProxy
    
    classes
    
    OperationProxy
    
    type-aliases
    
    OperationHandler<T>
  - ServiceProxy
    
    core/ServiceProxy
    
    functions
    
    createServiceWithContext()
    
    interfaces
    
    ContextAwareService
  - SessionManager
    
    core/SessionManager
    
    classes
    
    SessionManager
    
    functions
    
    createSessionManager()
  - storage
    
    core/storage
    
    functions
    
    createStorageAdapter()
    
    interfaces
    
    StorageAdapter
  - types
    
    core/types
    
    interfaces
    
    BlobsConfig
    MergedResults<T>
    NetworkConfig
    NetworkResult<T>
    SerializedSessionData
    SessionData
- Services
- Transport
  - transport
  - classes
    
    Abstract Class: BaseTransport
    EnhancedHttpTransport
    GrpcTransport
    HttpTransport
    HybridTransport
    TransportCoordinator
    WebSocketTransport
  - enumerations
    
    RequestAction
    TransportErrorCode
    TransportStatus
  - functions
    
    actionIsIdempotent()
    actionRequiresBody()
    actionToGrpcMethod()
    actionToHttpMethod()
    actionToWsEvent()
    probeServerCapabilities()
    selectTransport()
  - interfaces
    
    CallHints
    CoordinatedTransport
    GrpcTransportConfig
    HybridTransportConfig
    ProbeOptions
    RequestOptions
    ServerCapabilities
    Transport
    TransportCapabilities
    TransportConfig
    TransportCoordinatorConfig
    WebSocketTransportConfig
  - type-aliases
    
    TransportKind
  - variables
    
    BASELINE_CAPABILITIES
    CAPABILITIES
- Cache
  - cache
  - classes
    
    CacheManager
    LocalStorageCache
    MemoryCache
  - functions
    
    CacheKey()
    createCacheManager()
    NetworkCacheKey()
    parseCacheKey()
  - interfaces
    
    CacheEntry<T>
    CacheOptions
    CacheProvider
  - variables
    
    CacheKeys
    InvalidationPatterns
- Events
  - events
  - classes
    
    WireEventManager
  - functions
    
    matchesPattern()
  - interfaces
    
    EventMeta
    SubscribeOptions
    WireEventManagerOptions
  - type-aliases
    
    ErrorHandler<E>
    EventHandler<T>
- Errors
  - errors
  - classes
    
    ApiError
    ConflictError
    NotFoundError
    PermissionError
    RateLimitError
    TransportError
    UnauthorizedError
    ValidationError
  - functions
    
    normalizeError()
  - interfaces
    
    ApiErrorShape
  - type-aliases
    
    ErrorCode
  - variables
    
    ErrorCode
- Actions (undo/redo)
  - ActionManager
    
    actions/ActionManager
    
    classes
    
    ActionManager
    
    functions
    
    createActionManager()
    getActionManager()
  - application
    
    actions/application
    
    classes
    
    CreateApplicationAction
    DeleteApplicationAction
    UpdateApplicationAction
    
    functions
    
    createCreateApplicationAction()
    createDeleteApplicationAction()
    createUpdateApplicationAction()
    
    interfaces
    
    ApplicationActionContext
    CreateApplicationPayload
    CreateApplicationUndoState
    DeleteApplicationPayload
    DeleteApplicationUndoState
    UpdateApplicationPayload
    UpdateApplicationUndoState
  - BaseAction
    
    actions/BaseAction
    
    classes
    
    Abstract Class: BaseAction<TPayload, TResult, TUndoState>
  - blob
    
    actions/blob
    
    classes
    
    BulkDeleteBlobsAction
    CreateBlobAction
    DeleteBlobAction
    MoveBlobAction
    RemoveChildAction
    UpdateBlobAction
    
    functions
    
    createBulkDeleteBlobsAction()
    createCreateBlobAction()
    createDeleteBlobAction()
    createMoveBlobAction()
    createRemoveChildAction()
    createUpdateBlobAction()
    
    interfaces
    
    BulkDeleteResult
  - settings
    
    actions/settings
  - storage
    
    actions/storage
    
    classes
    
    CreateStorageProviderAction
    DeleteStorageProviderAction
    UpdateStorageProviderAction
    
    functions
    
    createCreateStorageProviderAction()
    createDeleteStorageProviderAction()
    createUpdateStorageProviderAction()
    
    interfaces
    
    CreateStorageProviderPayload
    CreateStorageProviderUndoState
    DeleteStorageProviderPayload
    DeleteStorageProviderUndoState
    StorageActionContext
    UpdateStorageProviderPayload
    UpdateStorageProviderUndoState
  - theme
    
    actions/theme
  - types
    
    actions/types
    
    interfaces
    
    Action<TPayload, TResult, TUndoState>
    ActionContext
    ActionEvent<T>
    ActionHistoryState
    ActionManagerConfig
    ActionResult<T>
    ActionState<T>
    BlobActionContext
    DeleteBlobPayload
    DeleteBlobUndoState
    MoveBlobPayload
    MoveBlobUndoState
    UpdateBlobPayload
    UpdateBlobUndoState
    
    type-aliases
    
    ActionEventCallback<T>
    ActionEventType
    ActionStatus
    BlobActionType
  - user
    
    actions/user
    
    classes
    
    UpdateUserAction
    
    functions
    
    createUpdateUserAction()
    
    interfaces
    
    UpdateUserPayload
    UpdateUserUndoState
    UserActionContext
- Serializers
  - serializers
  - classes
    
    Abstract Class: BaseSerializer
    CodeSerializer
    JSONSerializer
    MarkdownSerializer
    PlainTextSerializer
    SerializerFactory
  - functions
    
    contentTypeToFormat()
    getSerializer()
  - interfaces
    
    IContentSerializer
    ISerializerFactory
    ParsedContent
    RenderedHTML
    SerializerConfig
  - type-aliases
    
    ContentFormat
  - variables
    
    serializerFactory
- SSO
  - sso
  - classes
    
    SSOManager
    SSOStorage
  - enumerations
    
    SSOMessageType
  - functions
    
    buildPopupFeatures()
    buildSSOUrl()
    calculatePopupPosition()
    generateRequestId()
    mergeConfig()
  - interfaces
    
    SSOCandidate
    SSOConfig
    SSOError
    SSOMessage
    SSOPopupOptions
    SSOResult
    SSOState
  - type-aliases
    
    SSOStatus
  - variables
    
    DEFAULT_POPUP_OPTIONS
    DEFAULT_SSO_CONFIG
- Middleware
  - middleware
  - classes
    
    MiddlewareManager
  - functions
    
    authTokenMiddleware()
    loggingMiddleware()
    retryMiddleware()
  - interfaces
    
    Middleware
  - type-aliases
    
    RequestMiddleware
    ResponseMiddleware
- Plugins
  - plugins
  - classes
    
    OfflineManager
    PluginManager
  - functions
    
    getOfflineManager()
  - interfaces
    
    OfflinePluginConfig
    Plugin
    QueuedAction
  - variables
    
    OfflinePlugin
- Interfaces
  - interfaces
  - interfaces
    
    IAuthService
    IBlobsClient
    IBlobsService
    IMediaService
    IOrganizationsService
    IPermissionsService
    IThemeService
    IUsersService
- Types
  - api
    
    Applications
    
    types/api/Applications
    
    type-aliases
    
    ApplicationSchema
    CreateApplicationRequest
    UpdateApplicationRequest
    
    Auth
    
    types/api/Auth
    
    type-aliases
    
    AuthResponse
    
    Blobs
    
    types/api/Blobs
    
    type-aliases
    
    BlobSchema
    CreateBlobInput
    CreateBlobRequest
    UpdateBlobInput
    UpdateBlobRequest
    
    Common
    
    types/api/Common
    
    type-aliases
    
    BulkDeleteResponse
    Schemas
    
    Media
    
    types/api/Media
    
    type-aliases
    
    MediaSchema
    PrepareUploadRequest
    PrepareUploadResponse
    
    Settings
    
    types/api/Settings
    
    type-aliases
    
    UserSettingsSchema
    
    Storage
    
    types/api/Storage
    
    type-aliases
    
    CreateStorageProviderRequest
    InitiateOAuthRequest
    InitiateOAuthResponse
    StorageProviderSchema
    StorageProviderType
    StorageUsage
    UpdateStorageProviderRequest
    
    Themes
    
    types/api/Themes
    
    type-aliases
    
    CreateThemeInput
    CreateThemeRequest
    ThemeSchema
    UpdateThemeInput
    UpdateThemeRequest
    
    Users
    
    types/api/Users
    
    type-aliases
    
    CreateUserRequest
    UpdateProfileRequest
    UserSchema
  - Auth
    
    types/Auth
    
    interfaces
    
    AuthResponse
    AuthTokens
    LoginRequest
    RefreshTokenRequest
    RegisterRequest
  - Blobs
    
    types/Blobs
    
    functions
    
    canDeleteBlob()
    canEditBlob()
    canShareBlob()
    isOwnerOfBlob()
    
    interfaces
    
    Blob
    BlobAuthor
    BlobListParams
    BlobPermissions
    CreateBlobInput
    UpdateBlobInput
    
    type-aliases
    
    BlobSortField
    SortDirection
  - Common
    
    types/Common
    
    interfaces
    
    ApiResponse<T>
  - events
    
    types/events
    
    interfaces
    
    BaseEvent
    BlobCreatedEvent
    BlobDeletedEvent
    BlobPermissionGrantedEvent
    BlobPermissionRevokedEvent
    BlobUpdatedEvent
    EventEnvelope
    MediaDeletedEvent
    MediaUploadCompletedEvent
    MediaUploadFailedEvent
    MediaUploadPreparedEvent
    RefreshTokenMessage
    SetFiltersMessage
    SubscribeMessage
    SubscriptionOptions
    UnsubscribeMessage
    UserCreatedEvent
    UserDeletedEvent
    UserProfileUpdatedEvent
    UserUpdatedEvent
    
    type-aliases
    
    BlobEvent
    BlobEventCallback
    EventType
    MediaEvent
    MediaEventCallback
    PlatformEvent
    PlatformEventCallback<T>
    UserEvent
    UserEventCallback
    WebSocketMessage
  - Media
    
    types/Media
    
    interfaces
    
    Media
    
    type-aliases
    
    MediaStatus
  - Organization
    
    types/Organization
    
    interfaces
    
    CreateOrganizationInput
    Organization
    OrganizationMember
    UpdateOrganizationInput
  - Permission
    
    types/Permission
    
    interfaces
    
    CheckPermissionInput
    CreatePermissionInput
    Permission
    
    type-aliases
    
    PermissionType
  - Storage
    
    types/Storage
    
    interfaces
    
    CreateStorageProviderInput
    InitiateOAuthInput
    InitiateOAuthResponse
    ListProvidersResponse
    StorageProvider
    StorageUsageInfo
    UpdateProviderOrderInput
    UpdateStorageProviderInput
    
    type-aliases
    
    StorageProviderStatus
    StorageProviderType
  - Themes
    
    types/Themes
    
    interfaces
    
    CreateThemeInput
    PublishThemeInput
    Theme
    UpdateThemeInput
  - Users
    
    types/Users
    
    interfaces
    
    UpdateUserInput
    User
  - UserSettings
    
    types/UserSettings
    
    interfaces
    
    BlobSettings
    GeneralSettings
    NetworkSettings
    NotificationSettings
    PrivacySettings
    SettingsData
    StyleSettings
    UpdateUserSettingsInput
    UserSettings
- File Manager
  - FileManager
    
    managers/FileManager
    
    classes
    
    FileManager
    
    enumerations
    
    FileManagerError
    
    interfaces
    
    FileDropEvent
    FileManagerEvent
    FileValidationOptions
    
    type-aliases
    
    FileManagerEventType
- Utils
  - blobUtils
    
    utils/blobUtils
    
    functions
    
    buildBlobTree()
    calculateBlobStats()
    extractBlobPreview()
    filterBlobs()
    findBlobById()
    formatBlobSize()
    formatRelativeTime()
    getBlobAncestors()
    getBlobDescendants()
    getBlobThumbnail()
    getBlobThumbnailUrl()
    getMediaType()
    getMediaUrl()
    getThumbnailUrl()
    groupBlobsByParent()
    isAudioMedia()
    isImageMedia()
    isVideoMedia()
    sortBlobs()
    truncateText()
    
    interfaces
    
    BlobFilterOptions
    BlobNode
    BlobSortOptions
    BlobStats
    MediaUrlOptions
  - environment
    
    utils/environment
    
    functions
    
    detectEnvironment()
    getFetch()
    getStorageAvailability()
    getWebSocket()
    isBrowser()
    isLocalhost()
    isNode()
    shouldBypassAuth()
    shouldShowBypassAuthButton()
    
    type-aliases
    
    Environment
  - networkUtils
    
    utils/networkUtils
    
    functions
    
    executeParallel()
    mergeBlobs()
    mergeResults()
    sortBlobsByField()
    sortByDate()
    sortByNumber()
    sortByString()
  - oauthHelpers
    
    utils/oauthHelpers
    
    functions
    
    clearOAuthResult()
    clearOAuthState()
    completeOAuthFlow()
    extractOAuthParams()
    getOAuthResult()
    getOAuthState()
    handleOAuthCallback()
    openOAuthPopup()
    saveOAuthResult()
    saveOAuthState()
    validateOAuthState()
    
    interfaces
    
    OAuthPopupOptions
    OAuthResult
    OAuthState
  - query
    
    utils/query
    
    functions
    
    buildQuery()
    buildUri()
    
    type-aliases
    
    QueryRecord
    QueryValue
  - themeUtils
    
    utils/themeUtils
    
    functions
    
    applyGrainyTexture()
    applyTheme()
    getCurrentThemeId()
    loadSavedTheme()
    removeGrainyTexture()
    resetTheme()
  - types
    
    utils/types
    
    type-aliases
    
    ApiResponseType<T>
    CacheEntryType<T>
    DeepOmit<T, K>
    DeepPartial<T>
    ErrorResponse
    ExtendedRequestOptions
    GenericEventCallback<T>
    NonNullableFields<T>
    PaginatedResponse<T>
    QueryParams<T>
    RequireFields<T, K>
    ResourceState<T>
    SuccessResponse<T>
    Unsubscribe
- Themes
  - themes
    
    constants/themes
    
    functions
    
    getAllPredefinedThemes()
    getPredefinedTheme()
    getPredefinedThemeIds()
    
    interfaces
    
    ThemeConfig
    
    variables
    
    DEEP_SPACE_THEME
    OCEAN_DEEP_THEME
    PREDEFINED_THEMES
- File Preview
  - FilePreview
    
    models/FilePreview
    
    classes
    
    FilePreview
    
    enumerations
    
    FileUploadStatus
    
    interfaces
    
    FilePreviewOptions
    FileUploadProgress

GitHub

Select theme

On this page

Overview
Interfaces

types/Common

@blobs/sdk v0.1.0

@blobs/sdk / types/Common

Interfaces

ApiResponse

Previous
SortDirection Next
ApiResponse<T>

Blobs Platform

Hierarchical blob storage with permissions, multi-tenancy, and pluggable backends.

Docs

Getting started
API reference
Architecture
TypeScript SDK

Project

GitHub
Issues
Releases

Community

Discussions
Contributing