Interface Cache

Per-platform offline cache for third-party plugin assets.

Implementations live alongside their platform glue (composer-app's asset-cache/{tauri,service-worker}.ts); the no-op default is for tests and unsupported environments.

interface Cache {
    cache(
        pluginId: string,
        urls: readonly string[],
    ): Effect<void, PluginAssetCacheError>;
    evict(pluginId: string): Effect<void, PluginAssetCacheError>;
    list(): Effect<readonly string[], PluginAssetCacheError>;
    resolve(
        pluginId: string,
        url: string,
    ): Effect<string, PluginAssetCacheError>;
}

Index

Methods

cache evict list resolve

Methods

cache

cache(
pluginId: string,
urls: readonly string[],
): Effect<void, PluginAssetCacheError>
Persist all listed URLs under the namespace of pluginId. Idempotent. The order of urls is significant — the first entry is treated as the entry module.
Parameters
- pluginId: string
- urls: readonly string[]
Returns Effect<void, PluginAssetCacheError>
- Defined in packages/sdk/app-framework/src/core/plugin-asset-cache.ts:31

evict

evict(pluginId: string): Effect<void, PluginAssetCacheError>
Drop all assets for a plugin (uninstall).
Parameters
- pluginId: string
Returns Effect<void, PluginAssetCacheError>
- Defined in packages/sdk/app-framework/src/core/plugin-asset-cache.ts:36

list

list(): Effect<readonly string[], PluginAssetCacheError>
List currently cached plugin ids (diagnostic).

Returns Effect<readonly string[], PluginAssetCacheError>
- Defined in packages/sdk/app-framework/src/core/plugin-asset-cache.ts:48

resolve

resolve(pluginId: string, url: string): Effect<string, PluginAssetCacheError>
Resolves a plugin asset URL to a platform-specific cached URL when one is available. Returns the original URL when no cached copy exists or the platform serves cached responses transparently (e.g. service worker fetch interception on web).
Parameters
- pluginId: string
- url: string
Returns Effect<string, PluginAssetCacheError>
- Defined in packages/sdk/app-framework/src/core/plugin-asset-cache.ts:43

Interface Cache

Index

Methods

Methods

cache

Parameters

Returns Effect<void, PluginAssetCacheError>

evict

Parameters

Returns Effect<void, PluginAssetCacheError>

list

Returns Effect<readonly string[], PluginAssetCacheError>

resolve

Parameters

Returns Effect<string, PluginAssetCacheError>

Settings

On This Page