featherbit UI
    Preparing search index...

    Interface PluginNodeData

    Data payload stored on every pluginNode ReactFlow node. GraphCanvas writes it when converting a Policy to nodes and reads it back on save, so it must carry everything needed to reconstruct a policy node.

    interface PluginNodeData {
        config: Record<string, unknown>;
        configRef?: string;
        expanded?: boolean;
        label: string;
        onSelect?: (nodeId: string) => void;
        onToggleExpand?: (nodeId: string) => void;
        pluginType: string;
        ports?: PortSpec;
        portSpecs?: PortSpecLookup;
        showPortNames?: boolean;
        supernodeDef?: Supernode;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Index signature required by ReactFlow's node data constraint.

    Index
    config configRef? expanded? label onSelect? onToggleExpand? pluginType ports? portSpecs? showPortNames? supernodeDef?
    config: Record<string, unknown>

    Plugin configuration, serialized verbatim into the policy node's config on save.

    configRef?: string

    Optional name of a shared plugin config this node inherits from.

    expanded?: boolean

    Whether this supernode instance is expanded to its inline preview.

    label: string

    Text shown in the node body (usually the node id; script nodes append the runtime).

    onSelect?: (nodeId: string) => void

    Called with the node id when the node is clicked; used by GraphCanvas to open the inspector.

    onToggleExpand?: (nodeId: string) => void

    Called with the node id when the expand/fold chevron is clicked (supernode nodes only).

    pluginType: string

    Gateway plugin type, e.g. listener, upstream, key-auth, script.

    ports?: PortSpec

    Declared ports for this node's plugin type, from the GET /api/plugins catalog (GraphCanvas looks this up by pluginType when building nodes). Undefined for supernode boundary pseudo-nodes and any type missing from the catalog; PluginNode resolves the effective outputs via module:nodeKinds.resolveOutputs, which applies the entry/terminal special cases and the default success+error fallback.

    portSpecs?: PortSpecLookup

    Catalog port-spec lookup, threaded to the expanded preview's inner nodes (supernode nodes only).

    showPortNames?: boolean

    When false, ports render as bare handles with hover tooltips; default true renders labeled rows.

    supernodeDef?: Supernode

    Resolved supernode definition for supernode nodes; undefined = unresolved (stale/missing reference).

    Settings
    Member Visibility

    On This Page
    Properties