@open-form/sdk

OpenForm is documents as code. It lets developers and AI agents define, validate, and render business documents using typed, composable schemas. This eliminates template drift, broken mappings, and brittle glue code — while giving AI systems a reliable document layer they can safely read, reason over, and generate against in production workflows.

Package overview

An umbrella package containing the OpenForm core framework, serialization, and renderers.

- 📦 All-in-one - Single install
- 🏗️ Type-safe builders - Fluent API with full TypeScript support
- 📄 Multi-format rendering - PDF, DOCX, HTML, Text from one definition
- ✅ Automatic validation - Schema-driven constraints and validation
- 🎯 Composable artifacts - Reuse fields, forms, and documents across definitions
- 🤖 AI-ready - Built for agent ingestion and verification

Installation

``bash
npm install @open-form/sdk
`

Usage

Define forms with parties, fields, and output layers:

`typescript
import { open, textRenderer } from "@open-form/sdk";
import { createFsResolver } from "@open-form/resolvers";

const leaseAgreement = open
.form()
.name("residential-lease-agreement")
.version("1.0.0")
.title("Residential Lease Agreement")
.defaultLayer("markdown")
.layers({
markdown: {
kind: "file",
path: "fixtures/lease-agreement.md",
mimeType: "text/markdown",
},
html: {
kind: "file",
path: "fixtures/lease-agreement.html",
mimeType: "text/html",
},
})
.parties({
landlord: open
.party()
.label("Landlord")
.signature({ required: true }),
tenant: open
.party()
.label("Tenant")
.multiple(true)
.min(1)
.max(4)
.signature({ required: true }),
})
.fields({
leaseId: { type: "uuid", label: "Lease ID" },
propertyAddress: {
type: "address",
label: "Property Address",
required: true,
},
monthlyRent: { type: "money", label: "Monthly Rent", required: true },
leaseStartDate: { type: "date", label: "Lease Start Date", required: true },
})
.build();

// Fill with data (automatic validation)
const filledLease = leaseAgreement.fill({
fields: {
leaseId: "550e8400-e29b-41d4-a716-446655440000",
propertyAddress: {
line1: "123 Main St",
locality: "Portland",
region: "OR",
postalCode: "97201",
country: "USA",
},
monthlyRent: { amount: 1500, currency: "USD" },
leaseStartDate: "2024-02-01",
},
});

// Render to multiple formats
const resolver = createFsResolver({ root: process.cwd() });
const markdown = await filledLease.render({
renderer: textRenderer(),
resolver,
layer: "markdown",
});
const html = await filledLease.render({
renderer: textRenderer(),
resolver,
layer: "html",
});
`

Add file attachments and advanced field types:

`typescript
const advancedLease = open
.form()
.name("commercial-lease")
.version("1.0.0")
.title("Commercial Lease Agreement")
.defaultLayer("markdown")
.layers({
markdown: {
kind: "file",
path: "fixtures/commercial-lease.md",
mimeType: "text/markdown",
},
})
.allowAdditionalAnnexes(true)
.annexes({
photoId: open.annex().title("Photo ID").required(true),
proofOfIncome: open.annex().title("Proof of Income").required(true),
})
.parties({
landlord: open
.party()
.label("Landlord")
.signature({ required: true }),
tenant: open
.party()
.label("Tenant")
.multiple(true)
.signature({ required: true }),
})
.fields({
leaseId: { type: "uuid", label: "Lease ID", required: true },
leaseTermMonths: {
type: "number",
label: "Lease Term (months)",
required: true,
},
monthlyRent: { type: "money", label: "Monthly Rent", required: true },
petPolicy: {
type: "enum",
enum: ["no-pets", "small-pets", "all-pets"],
label: "Pet Policy",
required: true,
},
})
.build();
`

Define static documents and workflow checklists:

`typescript
const leadPaintDisclosure = open
.document()
.name("lead-paint-disclosure")
.version("1.0.0")
.title("Lead Paint Disclosure")
.code("EPA-747-K-12-001")
.releaseDate("2025-12-01")
.metadata({ agency: "EPA/HUD", cfr: "40 CFR 745" })
.layers({
pdf: open
.layer()
.file()
.path("fixtures/lead-paint-disclosure.pdf")
.mimeType("application/pdf"),
})
.defaultLayer("pdf")
.build();

const leaseChecklist = open
.checklist()
.name("lease-application-checklist")
.version("1.0.0")
.title("Lease Application Checklist")
.items([
{ id: "application_received", title: "Application Received", status: { kind: "boolean" } },
{ id: "credit_check", title: "Credit Check Complete", status: { kind: "boolean" } },
{ id: "background_check", title: "Background Check Complete", status: { kind: "boolean" } },
{ id: "lease_signed", title: "Lease Signed", status: { kind: "boolean" } },
])
.build();
`

Combine forms, documents, and checklists into a bundle:

`typescript
const leaseBundle = open
.bundle()
.name("residential-lease-bundle")
.version("1.0.0")
.title("Residential Lease Bundle")
.contents([
{ type: "inline", key: "leaseAgreement", artifact: leaseAgreement.toJSON({ includeSchema: false }) },
{ type: "inline", key: "leadPaintDisclosure", artifact: leadPaintDisclosure.toJSON({ includeSchema: false }) },
{ type: "inline", key: "checklist", artifact: leaseChecklist.toJSON({ includeSchema: false }) },
])
.build();
`

Get automatic TypeScript types from your form definitions:

`typescript
import { type InferFormPayload } from "@open-form/sdk";

type LeaseData = InferFormPayload;

const data: LeaseData = {
fields: {
leaseId: "550e8400-e29b-41d4-a716-446655440000",
propertyAddress: {
line1: "123 Main St",
locality: "Portland",
region: "OR",
postalCode: "97201",
country: "USA",
},
monthlyRent: { amount: 1500, currency: "USD" },
leaseStartDate: "2024-02-01",
},
};
`

Validate and fill forms with data:

`typescript
// Check if the form schema itself is valid
if (!form.isValid()) {
console.log("Form schema is invalid");
}

// Fill the form with data (validates during fill)
const filled = form.fill(data); // throws if validation fails

// Or use safeFill to avoid exceptions
const result = form.safeFill(data);
if (result.success) {
const filled = result.data;
}
`

For a complete production example, see /incubator/apps/demo/src/demos/leasing. For API reference and advanced patterns, visit docs.open-form.dev.

Changelog

View the Changelog for updates.

Related packages

- @open-form/core - Core artifacts and builders
- @open-form/types - TypeScript utilities and types
- @open-form/schemas - JSON Schema definitions
- @open-form/serialization - Locale-aware formatting
- @open-form/resolvers - File and environment resolvers
- @open-form/renderers` - All renderers (PDF, DOCX, Text)

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines and code of conduct.

License

This project is licensed under the MIT license.

See LICENSE for more information.