Interface: PluginInput<Id, Doc, Options>
Defined in: plugin-sdk/src/index.ts:56
Type Parameters
Id
Id extends string
Doc
Doc
Options
Options = undefined
Properties
assets?
optionalassets?:AssetDeclaration[] | ((options) =>AssetDeclaration[])
Defined in: plugin-sdk/src/index.ts:67
Declared assets, or a function of the options (a sticker library, fonts).
id
id:
Id
Defined in: plugin-sdk/src/index.ts:57
initialDocument
initialDocument:
Doc
Defined in: plugin-sdk/src/index.ts:61
initialOps?
optionalinitialOps?: (ctx) =>Omit<OperationBase<string>,"id">[]
Defined in: plugin-sdk/src/index.ts:75
Ops that seed an empty log from option defaults (a default preset, a locked watermark).
Parameters
ctx
options
Options
source
SourceDescriptor
Returns
Omit<OperationBase<string>, "id">[]
kernel
kernel:
KernelDef
Defined in: plugin-sdk/src/index.ts:64
operations
operations: readonly
OperationDef<Doc,any>[]
Defined in: plugin-sdk/src/index.ts:60
options?
optionaloptions?:OptionsDef<Options>
Defined in: plugin-sdk/src/index.ts:69
Options schema and defaults. Omit for plugins without options.
stage
stage:
object
Defined in: plugin-sdk/src/index.ts:62
name
name:
string
order
order:
number
tool?
optionaltool?: () =>Promise<ToolDef>
Defined in: plugin-sdk/src/index.ts:65
Returns
Promise<ToolDef>
toPlan
toPlan: (
slice,ctx) =>StageParams|null
Defined in: plugin-sdk/src/index.ts:63
Parameters
slice
Doc
ctx
PlanContext & object
Returns
StageParams | null
validate?
optionalvalidate?: (op,ctx) =>string|null
Defined in: plugin-sdk/src/index.ts:71
Constraint check per operation; return a message to reject.
Parameters
op
OperationBase
ctx
ValidateContext<Doc, Options>
Returns
string | null
validateDocument?
optionalvalidateDocument?: (slice,ctx) =>string|null
Defined in: plugin-sdk/src/index.ts:73
Constraint check on the final state before export or server render.
Parameters
slice
Doc
ctx
ValidateDocumentContext<Options>
Returns
string | null
version
version:
number
Defined in: plugin-sdk/src/index.ts:58