Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

ConfigMapDefinition

A single declaration shared by resource editors and Module Map, without another persistent configuration store.

load returns the existing full document; the host edits declared paths and preserves other fields. apply must resolve only after existing persistence and the resource’s application policy complete, or reject with an actionable error. Return the accepted document, or omit the result to accept next. Context supplies operation and the resource identity (module, task, or plugin). No restart behavior is implied.

Import

import type { ConfigMapDefinition } from "@dartwic/interface-sdk/config-maps";

Declaration

export interface ConfigMapDefinition {
    title?: string;
    groups: Array<{id: string; label: string; fields?: ConfigMapField[]; tables?: ConfigMapTable[]}>;
    load(context: any): Promise<any>;
    apply(next: any, previous: any, context: any): Promise<any>;
    validate?(value: any, context: any): string;
}

Members

NameTypeRequirementDescription
titlestringOptional
groupsArray<{id: string; label: string; fields?: ConfigMapField[]; tables?: ConfigMapTable[]}>Required
loadPromise<any>Required
applyPromise<any>Required
validatestringOptional