velo-textZero-deps document platform

Beta 1.0.4 · TypeScript strict · Variables {{name}} · PDF

Pure core, no DOM

Canonical JSON AST, immutable transactions, selection, history, validation and canonical hash. Zero window/document/fs in core.

Rich editor

contenteditable reconciler, MutationObserver, IME, keyboard, tables (cell edit, align, col/row resize), columns, clipboard allowlist, a11y, 28 recolorable SVG icons.

Template engine

Typed VariableNode {{path | format ?? "fallback"}}, safe resolver, currency/date formatters, repeat-row alias with limit.

Deterministic export

PDF xref/trailer, contiguous tables, image align + PNG downscale. ODT/DOCX via the same exportDocument API.

Assets & Storage

Magic-signature sniff, dimensions, SHA-256 dedupe, S3 SigV4 presigned URLs, PG jsonb + revisions.

Layout & Theming

Micrometer units, line breaking, pagination widows/orphans, 4 themes with CSS tokens, equation rendering.

Quick start 1.0.4

This is a beta. APIs can still change. Install the prerelease tag:

bash

pnpm add velo-text@beta

Requires Node >= 18. Token and publish steps: Publish to npm.

import { createDocument, createIdGenerator, exportDocument } from "velo-text";
import { createBufferSink } from "velo-text/backend";

const doc = createDocument({ idGenerator: createIdGenerator("doc") });
doc.root.children.push({
  type: "paragraph", id: "p1",
  children: [{ type: "text", id: "t1", text: "Hello " }, { type: "variable", id: "v1", path: "name", source: "{{name}}", valueType: "string" }]
});

const { sink, getBuffer } = createBufferSink();
await exportDocument({ document: doc, data: { name: "Ada" }, format: "pdf", sink, options: { deterministic: true } });

Architecture in 30s

PortableDocument (AST JSON) — source of truth
  ├─ Core (model, ops, history, schema, normalize)
  ├─ Template (parser, resolver, formatter)
  ├─ Editor Web (view reconciler, input pipeline, tables, clipboard, a11y)
  ├─ Assets (sniff, dimensions, hashing, store, S3)
  ├─ Layout (units, text, pagination)
  ├─ Export (pdf, odt, docx)
  ├─ Theme (tokens, 4 presets)
  └─ Adapters (browser, backend, PG, S3)

Explore the Guide, Roadmap, and API. Try the Playground.