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

Renders OpenForm documents to DOCX (Microsoft Word) format with automatic field type detection and serialization.

• Automatic field serialization - Detects field types (Money, Person, Phone, Address, Organization) from form schema and automatically formats them
• Template-based rendering - Use DOCX files as templates with Handlebars-style placeholders
• Binary output - Returns Uint8Array for direct file writing or streaming
• Type-safe - Full TypeScript support with OpenForm core types

Installation

npm install @open-form/renderer-docx

Usage

Direct Rendering with renderDocx()

Render DOCX templates directly with automatic field serialization:

import { renderDocx } from "@open-form/renderer-docx";
import fs from "node:fs";
import { petAddendumForm } from "./forms/pet-addendum";

const template = fs.readFileSync("pet-addendum.docx");

const output = await renderDocx(
  new Uint8Array(template),
  {
    petName: {
      firstName: "Fluffy",
      lastName: "Whiskers",
      fullName: "Fluffy Whiskers",
    },
    monthlyFee: {
      amount: 100,
      currency: "USD",
    },
  },
  {},
  petAddendumForm // Automatic field type detection and serialization
);

// output is Uint8Array - write to file
fs.writeFileSync("output.docx", output);

renderDocx() Parameters:

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | template | Uint8Array | Yes | DOCX template as binary | | data | Record<string, unknown> | Yes | Data object to populate template | | options | DocxRenderOptions | No | DOCX-specific rendering options (cmdDelimiter, failFast, processLineBreaks) | | form | Form | No | Form schema for automatic field type detection and serialization | | serializers | SerializerRegistry | No | Custom serializer registry (defaults to USA serializers) |

Returns: Promise<Uint8Array> - Rendered DOCX as binary

Using the Form Builder API

Render DOCX using the OpenForm builder pattern with method chaining:

import { docxRenderer } from "@open-form/renderer-docx";
import { createFsResolver } from "@open-form/resolvers/fs";
import { petAddendumForm } from "./forms/pet-addendum";

const resolver = createFsResolver({ root: "./templates" });

const output = await petAddendumForm
  .fill({
    fields: {
      petName: {
        firstName: "Fluffy",
        lastName: "Whiskers",
        fullName: "Fluffy Whiskers",
      },
      monthlyFee: {
        amount: 100,
        currency: "USD",
      },
    },
  })
  .render({
    renderer: docxRenderer,
    layer: "docx",
    resolver,
  });

// output is Uint8Array

docxRenderer Instance:

| Property | Type | Description | |----------|------|-------------| | id | string | Renderer identifier: "docx" | | render() | function | Async render function accepting RenderRequest |

Form .render() Parameters:

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | renderer | OpenFormRenderer | Yes | Renderer instance (docxRenderer) | | layer | string | Yes | Name of the template layer to render | | resolver | FileResolver | No | File resolver for loading template files |

Returns: Promise<Uint8Array> - Rendered DOCX as binary

Changelog

View the Changelog for updates.

Related packages

• @open-form/sdk - OpenForm framework SDK
• @open-form/renderers - All renderers in one package

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.

Acknowledgments

Built with these excellent libraries:

• docx-templates - Template-based DOCX generation