Reference

Find the authoritative API and type reference for each Editorial Workflows domain. Exact contracts live at the bottom of the corresponding concept page.

• Engine: engine construction, verbs, transactions, evaluation, errors, actor resolution, and persisted-model governance. See the advanced exports below for lower-level helpers.
• Definitions and instances: definition and instance shapes.
• History and audit trail: retrieving instance history and the complete HistoryEntry event reference.
• Stages and transitions: stage, visit, and transition contracts.
• Fields: field declarations, stored field types, progress, initial values, validation, and editability.
• Conditions: condition syntax, variables, and evaluation contexts.
• Activities and actions: declarations, evaluation, and projected firing consequences.
• Operations: state-changing operations and value expressions.
• Effects and runtimes: declarations, handlers, draining, mid-dispatch field reports, and completion.
• Guards and enforcement: guard declarations and lifecycle.
• Subworkflows: spawning, child lifecycle, and propagation.
• Global document references: resource-qualified references and deployment helpers. See expandResourceAliases and refsOf below.

These lower-level exports support custom integrations, deployment tooling, and persisted-model diagnostics.

resolveActor(directory, actor) resolves a person actor through a ProjectUserDirectory. It returns resolved, missing, or inaccessible; agent and system actors return not-person without a user lookup.

DATA_MODEL_CHANGES is the frozen manifest of governed persisted-model changes, including each change’s document types, compatibility class, introduced model, minimum reader model, applicability, and summary.

requiredModelFeatures(documentType, document) returns the manifest entries whose feature detectors apply to one canonical stored definition or instance.

requiredReaderModel(documentType, document) returns the oldest engine data model that can safely interpret that stored definition or instance. It returns 0 when no governed feature raises the floor.

assertReaderModelAcknowledgement(expectedMinReaderModel, context?) asserts that a reviewed numeric literal exactly matches the installed engine’s current reader floor. It throws ReaderModelAcknowledgementError when the acknowledgement is missing, malformed, or stale; context labels the failing caller.

expandResourceAliases(definition, resourceAliases) returns the workflow definition with logical @alias: references expanded to physical GDRs. It validates alias names and rejects missing or malformed standalone aliases.

refsOf(definition) returns the definition’s outgoing spawn dependencies as LogicalRef[], where each row is {name: string, version?: number | 'latest'}.

• The reactive session: reactive state and commands.
• CLI: deployment and administration commands.
• MCP server: agent tools and configuration.
• Studio plugin: Studio setup and workflow UI.
• Custom Studio integrations: Studio-bound engine, hooks, and a Document Action example.
• App SDK: building workflow interfaces with the App SDK.
• Reusable UI components: assignment, date, progress, member, and workflow-diagram controls.

• Testing: the in-memory test bench and test patterns.
• Limits: current product and runtime limits.