← All packages

@searsuite/sear-assembly-config

Editor-local configuration storage, defaults, and typed configuration access.

Configuration defaults

interfaceDocConfig

Configuration owned by a standalone Doc editor.

typeEditorDefaultConfigOverrides
type EditorDefaultConfigOverrides = Partial<TConfig> & Record<string, unknown>

Host-provided overrides for one editor-owned configuration object.

variabledefaultDocConfig
defaultDocConfig: DocConfig

Built-in defaults for standalone Doc editors.

variabledefaultSheetConfig
defaultSheetConfig: SheetConfig

Built-in defaults for ordinary Sheet cells and Sheet viewport services.

Editor configuration storage

classConfigEngine
class ConfigEngine<TConfig>

Registry and merger for one editor-owned configuration scope.

constructorConfigEngine<TConfig>(defaults?: TConfig, initialConfig?: EditorDefaultConfigOverrides<TConfig>): ConfigEngine<TConfig>

Creates the engine for one composition-root-owned default configuration object.

propertyreadonly symbol: symbolstatic

DI token for resolving the shared configuration engine.

methodenforceCommandBoundary(isCommandExecuting: (): boolean): void

Seals retained configuration handles after editor initialization.

methodgetCombinedConfig<T>(): ConfigUnit<T> & T

Get merged config of all plugins

ReturnsMerged config

methodgetDefaultConfig(): TConfig

Returns this editor's defaults merged with its host/runtime overrides.

methodgetPluginConfig<T>(pluginKey: ConfigKey): ConfigUnit<T> & T | undefined

Get config of specified plugin

ReturnsPlugin configuration

pluginKey

Stable key whose configuration should be returned.

methodregisterPluginConfig<T>(pluginKey: ConfigKey, pluginConfig: T): void

Register plugin config

pluginKey

Stable key that owns the configuration.

pluginConfig

Plugin config

methodupdateDefaultConfigOverrides(overrides: EditorDefaultConfigOverrides<TConfig>): void

Merges host/runtime default overrides into future default-config reads.

classConfigUnit
class ConfigUnit<T>

Mutable configuration unit registered by a plugin or assembly module.

constructorConfigUnit<T>(initialConfig?: T): ConfigUnit<T>

Creates a config unit by copying the provided initial values.