@searsuite/sear-assembly-config API reference

class ConfigEngine<TConfig>

Registry and merger for one editor-owned configuration scope.

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

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

defaults: TConfig
initialConfig: EditorDefaultConfigOverrides<TConfig>

propertysymbolstatic

readonly symbol: symbol

DI token for resolving the shared configuration engine.

methodenforceCommandBoundary

enforceCommandBoundary(isCommandExecuting: (): boolean): void

Seals retained configuration handles after editor initialization.

isCommandExecuting: (): boolean

methodgetCombinedConfig

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

Get merged config of all plugins

ReturnsMerged config

methodgetDefaultConfig

getDefaultConfig(): TConfig

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

methodgetPluginConfig

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

Get config of specified plugin

ReturnsPlugin configuration

pluginKey: ConfigKey: Stable key whose configuration should be returned.

methodregisterPluginConfig

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

Register plugin config

pluginKey: ConfigKey: Stable key that owns the configuration.
pluginConfig: T: Plugin config

methodupdateDefaultConfigOverrides

updateDefaultConfigOverrides(overrides: EditorDefaultConfigOverrides<TConfig>): void

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

overrides: EditorDefaultConfigOverrides<TConfig>

classConfigUnit source ↗

class ConfigUnit<T>

Mutable configuration unit registered by a plugin or assembly module.

constructorconstructor

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

Creates a config unit by copying the provided initial values.

initialConfig: T

interfaceDocConfig source ↗

interface DocConfig

Configuration owned by a standalone Doc editor.

propertydevicePixelRatio

readonly devicePixelRatio: number

propertydocFontFamily

readonly docFontFamily: string

propertydocFontSize

readonly docFontSize: number

propertydocLineHeightMultiplier

readonly docLineHeightMultiplier: number

Default paragraph line-height multiplier used by standalone Doc.

propertydocParagraphSpacingAfter

readonly docParagraphSpacingAfter: number

Default paragraph spacing after each non-final block.

propertydocVerticalAlign

readonly docVerticalAlign: "center" | "top"

propertyincrementalRenderPolicyLimits

readonly incrementalRenderPolicyLimits: IncrementalRenderPolicyLimitsConfig

interfaceIncrementalRenderPolicyLimitsConfig source ↗

interface IncrementalRenderPolicyLimitsConfig

Guardrails for accepting an incremental document render plan.

propertymaxCopiedAreaRatio

readonly maxCopiedAreaRatio: number

propertymaxCopyCount

readonly maxCopyCount: number

propertymaxInvalidAreaRatio

readonly maxInvalidAreaRatio: number

propertymaxInvalidRectCount

readonly maxInvalidRectCount: number

interfaceSheetConfig source ↗

interface SheetConfig

Configuration owned by a standalone Sheet editor.

propertycellPadding

readonly cellPadding: number

propertydefaultCellAlign

readonly defaultCellAlign: SheetHorizontalAlignment

propertydefaultCellVerticalAlign

readonly defaultCellVerticalAlign: SheetVerticalAlignment

propertydefaultColumnSize

readonly defaultColumnSize: number

propertydefaultRowSize

readonly defaultRowSize: number

propertydevicePixelRatio

readonly devicePixelRatio: number

propertysheetCellFontFamily

readonly sheetCellFontFamily: string

propertysheetCellFontSize

readonly sheetCellFontSize: number

propertysheetOffsetX

readonly sheetOffsetX: number

propertysheetOffsetY

readonly sheetOffsetY: number

typeEditorDefaultConfigOverrides source ↗

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

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

variabledefaultDocConfig source ↗

defaultDocConfig: DocConfig

Built-in defaults for standalone Doc editors.

variabledefaultSheetConfig source ↗

defaultSheetConfig: SheetConfig

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