Sealpixel

Appearance

Interface: Registry ​

Defined in: packages/core/src/registry.ts:30

Plugins plus everything derived from them: schemas, reducers, stage order.

Properties ​

byId ​

readonly byId: ReadonlyMap<string, AnyPlugin>

Defined in: packages/core/src/registry.ts:33

byOpType ​

readonly byOpType: ReadonlyMap<string, RegisteredOperation>

Defined in: packages/core/src/registry.ts:34

plugins ​

readonly plugins: readonly AnyPlugin[]

Defined in: packages/core/src/registry.ts:32

Sorted by stage order, then id.

Methods ​

initialDocument() ​

initialDocument(): Document

Defined in: packages/core/src/registry.ts:37

Returns ​

Document

initialOps() ​

initialOps(source): Omit<OperationBase<string>, "id">[]

Defined in: packages/core/src/registry.ts:57

Ops that seed an empty log from option defaults, in stage order.

Parameters ​

source ​

SourceDescriptor

Returns ​

Omit<OperationBase<string>, "id">[]

parseEditLog() ​

parseEditLog(value, options?): EditLog

Defined in: packages/core/src/registry.ts:39

Validates and migrates an unknown value into an EditLog. Throws SealpixelError.

Parameters ​

value ​

unknown

options? ​

ParseOptions

Returns ​

EditLog

pluginOptions() ​

pluginOptions(): Record<string, unknown>

Defined in: packages/core/src/registry.ts:55

{ pluginId: options } for every plugin with options.

Returns ​

Record<string, unknown>

pluginVersions() ​

pluginVersions(): Record<string, number>

Defined in: packages/core/src/registry.ts:36

{ pluginId: version } for every registered plugin.

Returns ​

Record<string, number>

safeParseEditLog() ​

safeParseEditLog(value, options?): ParseResult

Defined in: packages/core/src/registry.ts:40

Parameters ​

value ​

unknown

options? ​

ParseOptions

Returns ​

ParseResult

validateDocument() ​

validateDocument(document, source): object[]

Defined in: packages/core/src/registry.ts:50

Runs every plugin's validateDocument over a compiled document. Returns all violations; empty when the state satisfies the configured options.

Parameters ​

document ​

Document

source ​

SourceDescriptor

Returns ​

object[]

validateOperation() ​

validateOperation(op, document, source): string | null

Defined in: packages/core/src/registry.ts:45

Runs the owning plugin's validate for one op against the document it would apply to. Returns the violation message, or null.

Parameters ​

op ​

OperationBase

document ​

Document

source ​

SourceDescriptor

Returns ​

string | null