Skip to content

Glossary

Domain vocabulary used throughout the Contributor Guide, alphabetical. Each entry links to where it's covered in depth.

  • BlockRule — a tag (Configurable, NoChildren, SingleChild, MultipleChildren, MultipleElement) on a logic block describing what shape of children it accepts; enforced uniformly by the logic pipeline, not by each block's own mutation.

  • Entry / EntryType — a leaf value in the tree model: Boolean, Simple, Graph, Internal, Cell, or Code. The one non-leaf variant is Map (a container) — EntryItemType is the "leaf only" version of this enum.

  • FieldSuggestion — one candidate value a plugin proposes for a field, surfaced when the user clicks the suggestions button; aggregated across all active plugins by usePlugins().fieldSuggestions.

  • Input — the enum of form-widget kinds (TextInput, SingleSelect, TextSelector, ...) a node's configuration field can use. Defined in types, mapped to actual components by the input widget registry.

  • Logic block — one entry in LOGIC_BLOCKS: defines what a node type in the graph editor can do (its mutation, options, ports, and BlockRules). See Logic & structure blocks.

  • OptionType / OptionVisibility — how a node option's value is sourced (UserDefined, Reference, Graph, Code, Boolean) and whether it shows in the node's Quick View. Part of the graph-facing wrapper around a tree node.

  • Path / Reference — the file-viewer's selection model: a Path is a doubly-linked list of References (one per clicked/selected element), stored flat by id. See Selection & paths.

  • PathModeAbsolute (a path from the document root) or Relative (extending an existing path defined elsewhere in the template). See Relative paths.

  • Plugin hooks — the six lifecycle callbacks a plugin can implement: bootstrap (once per loaded file), preRender (before each render), shouldRender (per node), postRender (per node, post-generation), fieldSuggestions / postFieldSuggestions (on demand).

  • Port — a node's input or output connection point in the graph view (PortDirection, an optional PortValueKind). See The graph-facing wrapper.

  • Reserved name — an identifier (data, db, emailMessage, ...) pre-injected into a template's runtime scope; a node key that collides with one is silently shadowed rather than erroring. See Reserved names.

  • RuntimeSchema / SerializedSchema — the live (Zod validators, real functions) and JSON-safe forms of a schema's definition, converted by schema-serialization. Not the same thing as a TreeNode — see that page's opening note.

  • SchemaVariant — the enum (Pdf, Table, Xml, Text, Email, Json) that picks a file's type. Drives which file-viewer organism renders it and which logic/structure block set applies.

  • SelectionModeText or Reference, per file-viewer instance: which of the two selection mechanisms is active.

  • Structure block — one entry in STRUCTURE_BLOCKS: defines how a Map node's children get laid out in the generated output (unwrap, group, array, forEach, data, code). Unlike logic blocks, the same six apply to every SchemaVariant. See Structure blocks.

  • TreeNode / TreeItem / TreeMap — the mapping's actual data structure: TreeNode is TreeItem | TreeMap, where TreeItem is any leaf Entry and TreeMap is the container variant. See Tree nodes: what a mapping is made of.

  • ZodDescriptor — the JSON-safe stand-in for a Zod validator used by schema serialization; a closed set of 7 shapes, not a general Zod-to-JSON encoding.