Sanity Library Reference Docs
    Preparing search index...

    Interface FederatedAssetSourcesConfigBeta

    Config for asset sources provided by federated asset_source views: organization applications published through the hosting workbench (SDK apps exposing views built with defineAssetSourceView). Each brokered view becomes its own Studio asset source on image and file fields.

    Only effective when the Studio runs inside the workbench shell — outside it no views are brokered and the config is inert. The Media Library's own view is not governed by this config: it replaces the built-in Media Library source's dialog and is gated by mediaLibrary.__internal.federatedAssetSource.

    interface FederatedAssetSourcesConfig {
        enabled?: boolean;
        filter?: (view: FederatedAssetSourceViewInfo) => boolean;
        uploads?: (view: FederatedAssetSourceViewInfo) => boolean;
    }
    Index

    Properties

    enabled?: boolean

    Whether brokered asset_source views become Studio asset sources. Defaults to false.

    filter?: (view: FederatedAssetSourceViewInfo) => boolean

    Choose which brokered views become asset sources (defaults to all when omitted). This is a Studio-wide gate — to scope a source to individual fields instead, use options.sources on the schema field (the predicate form matches federated sources without knowing their application id, e.g. (source) => source.name.endsWith(':dropbox')).

    uploads?: (view: FederatedAssetSourceViewInfo) => boolean

    Choose which brokered views accept Studio field uploads (defaults to none when omitted). A view opted in here receives the dropped/picked files on a headless upload mount and owns the transport to its service; views without an upload transport should not be opted in — they would appear as upload destinations only to fail the files. This predicate stands in until view declarations can carry an upload capability flag.