Artifacts
Last updated on

Builder functions for top-level OpenForm artifacts

Artifact Builders

Artifact builders create top-level schema types that can be validated, serialized, and rendered independently.

Available Builders

Builder	Description	Badge
document	Static content (disclosures, pamphlets)	Design-time
form	Interactive forms with fields and parties	Design-time
checklist	Task lists and verification items	Design-time
bundle	Collection of multiple artifacts	Design-time

Common Features

All artifact builders share common functionality:

Static Methods

.from(input) - Parse unknown input, throws on error
.safeFrom(input) - Parse unknown input, returns result object

Instance Methods

.validate() - Validate the schema definition
.isValid() - Check if schema is valid
.toJSON() - Serialize to JSON
.toYAML() - Serialize to YAML
.clone() - Deep clone the instance

Instance Properties

_data - Raw artifact data
kind - Artifact type discriminator
name - Artifact name
version - Semantic version

SDK

TypeScript SDK for creating and working with OpenForm artifacts

document

Create Document artifacts for static content

On this page

Artifact Builders Available Builders Common Features Static Methods Instance Methods Instance Properties