Core Types

Operation results and plugin-author contracts share issues and artifacts.

Result Types

KernelResult<T> discriminates plugin success and failure with success.

Issue and Location Types

KernelIssueType ('compilation' | 'runtime' | 'kernel' | 'connection' | 'unknown') and IssueSeverity ('error' | 'warning' | 'info') classify each issue. kernelIssueCodeValues enumerates the stable codes; isKernelIssueCode guards one.

Document Results

Document results always carry issues. Successful evaluations offer ordered view and export IDs, including an empty view list. A rendering correlates requestId and evaluationId; its artifact carries MIME type, content, and optional units. hash identifies its projected artifact. Successful exports carry a nonempty file tuple. Optional sourceRevision records evaluated source provenance.

DocumentStatus and ViewStatus describe separate owners. Their events and supersession outcomes are documented in Client API.

Dependency Types

Dependency records inputs to cache identity and change detection:

FileDependency.path is a canonical root-relative runtime path, shared by filesystem and cache identity.

Filesystem Types

Kernel Types

evaluate returns an opaque handle plus the ordered view and export IDs this result offers. The first offered view is the default. Views can expose named instances; render selects one view and optional instance without evaluating again.

Bundler Types

Tracer Types

Artifacts and Plugin Results

Artifact accepts open MIME types with text or bytes. asKnownArtifact narrows GLB and SVG; other MIME types remain valid. ExportOutput carries a nonempty ordered ExportFile tuple; RenderOutput carries one artifact whose MIME type matches the selected declaration.

Conversion Types

TranscoderServices supplies the logger, tracer, and cancellation signal. MediaType names artifact MIME types; JSONSchema7 carries serializable option metadata.

Content and Capability Types

Framework-owned content requirements stay separate from plugin-owned option schemas. A route advertises supported content and an ExportFidelity ('brep' | 'mesh') used by route ranking.

Related

• Handle Errors
• Live Rendering
• API: Client
• API: Filesystem