Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Workspace Assets

Public Interface SDK exports in the Workspace Assets category.

ExportImport pathDescription
AssetOperation@dartwic/interface-sdk/assetsEngine operation callback used by asset helpers.
BundledAssetClient@dartwic/interface-sdk/assetsRead-only bundled UTF-8/JSON files. Updates replace them. Missing files and invalid JSON reject; no caching or real-time bound.
createBundledPluginAssetClient@dartwic/interface-sdkRead files shipped in this Interface plugin’s assets folder. Call after runtime registration, passing the manifest ID. Resolves the current host adapter automatically. Read-only UTF-8/JSON; updates replace the files. Missing files, invalid paths and invalid JSON reject.
createEnginePluginAssetClient@dartwic/interface-sdkRead engine/plugins/id/assets through the connected Engine, retaining its authorization. No writes.
createInterfacePluginAssetClient@dartwic/interface-sdkRead interface/plugins/id/assets using the Interface host installed-plugin file reader. No Engine installation is required.
createPluginWorkspaceAssetClient@dartwic/interface-sdkBind authored-file helpers once to a validated manifest plugin ID. Completion means the Engine operation finished; I/O may block without a real-time bound.
createWorkspaceAssetClient@dartwic/interface-sdkCreate shared UTF-8/JSON readers and writers. Reads cache per callback; failed reads are evicted. Writes require administrator authority and resolve after the Engine write completes. invalidate evicts external edits. Missing files and invalid JSON reject; no real-time bound.
PluginWorkspaceAssetClient@dartwic/interface-sdk/assetsAuthored plugin files confined by these helpers to workspace/assets/plugins/id. Project settings, secrets and runtime retain their scopes.
pluginWorkspaceAssetPath@dartwic/interface-sdkBuild assets/plugins/id/relative for shared authored files. Bind the manifest plugin ID; relative files may have validated subdirectories and must have an extension. No I/O or isolation from generic storage APIs.
validateWorkspaceAssetPath@dartwic/interface-sdk/assetsValidate and normalize a shared asset path.
WORKSPACE_ASSET_ROOT@dartwic/interface-sdkNamed root containing shared workspace assets.
WorkspaceAssetClient@dartwic/interface-sdk/assetsShared authored UTF-8/JSON file operations. Stored paths are workspace-relative assets/… references.
workspaceAssetPath@dartwic/interface-sdkBuild a portable assets/namespace/filename reference. Validated single segments, a filename extension and no traversal; throws on invalid input. No I/O.