Class PluginHost

Index

Constructors

Methods

constraintTemplates disable dispose enable exporters exportWith importerFor importFile list mountPanel panels register run storageAdapters subscribe unregister

Constructors

constructor

new PluginHost(engine: DotloomEngine, editor?: EditorCore | null): PluginHost
Parameters
- engine: DotloomEngine
- editor: EditorCore | null = null
Returns PluginHost
- Defined in packages/sdk/src/plugins.ts:131

Methods

constraintTemplates

constraintTemplates(): { plugin: string; template: ConstraintTemplate }[]
Returns { plugin: string; template: ConstraintTemplate }[]
- Defined in packages/sdk/src/plugins.ts:332

disable

disable(id: string): Promise<void>
Disable: tools/commands disappear, the plugin's entities become read-only (data kept).
Parameters
- id: string
Returns Promise<void>
- Defined in packages/sdk/src/plugins.ts:237

dispose

dispose(): Promise<void>
Unregister everything.

Returns Promise<void>
- Defined in packages/sdk/src/plugins.ts:370

enable

enable(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in packages/sdk/src/plugins.ts:246

exporters

exporters(): { exporter: Exporter; plugin: string }[]
Returns { exporter: Exporter; plugin: string }[]
- Defined in packages/sdk/src/plugins.ts:312

exportWith

exportWith(
plugin: string,
exporterId: string,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- plugin: string
- exporterId: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/sdk/src/plugins.ts:318

importerFor

importerFor(fileName: string): { importer: Importer; plugin: string } | null
Importer for a file name (enabled plugins only).
Parameters
- fileName: string
Returns { importer: Importer; plugin: string } | null
- Defined in packages/sdk/src/plugins.ts:292

importFile

importFile(fileName: string, bytes: Uint8Array): Promise<unknown>
Run an importer as one undoable transaction.
Parameters
- fileName: string
- bytes: Uint8Array
Returns Promise<unknown>
- Defined in packages/sdk/src/plugins.ts:304

list

list(): PluginInfo[]
Returns PluginInfo[]
- Defined in packages/sdk/src/plugins.ts:269

mountPanel

mountPanel(plugin: string, panelId: string, el: HTMLElement): () => void
Mount a plugin panel with an API that tracks the selection. The returned unmount function is idempotent; disabling or unregistering the plugin also unmounts it.
Parameters
- plugin: string
- panelId: string
- el: HTMLElement
Returns () => void
- Defined in packages/sdk/src/plugins.ts:348

panels

panels(): { panel: PanelContribution; plugin: string }[]
Returns { panel: PanelContribution; plugin: string }[]
- Defined in packages/sdk/src/plugins.ts:326

register

register(plugin: DotloomPlugin, opts?: { enabled?: boolean }): Promise<void>
Register (and by default enable) a plugin. Errors leave nothing registered.
Parameters
- plugin: DotloomPlugin
- opts: { enabled?: boolean } = {}
Returns Promise<void>
- Defined in packages/sdk/src/plugins.ts:161

run

run(qualified: string, args?: unknown): Promise<unknown>
Run a named plugin command (pluginId:command) as one transaction.
Parameters
- qualified: string
- Optionalargs: unknown
Returns Promise<unknown>
- Defined in packages/sdk/src/plugins.ts:281

storageAdapters

storageAdapters(): StorageAdapter[]
Storage adapters contributed by enabled plugins, in registration order.

Returns StorageAdapter[]
- Defined in packages/sdk/src/plugins.ts:339

subscribe(cb: () => void): () => void
Subscribe to registry changes.
Parameters
- cb: () => void
Returns () => void
- Defined in packages/sdk/src/plugins.ts:137

unregister

unregister(id: string): Promise<void>
Remove the plugin. Documents keep its entities (read-only until registered again).
Parameters
- id: string
Returns Promise<void>
- Defined in packages/sdk/src/plugins.ts:254