office-open

English | 简体中文

AI-native Office documents for TypeScript and JavaScript.
Create Word, Excel, and PowerPoint files (.docx, .xlsx, .pptx) from plain JSON or fully typed APIs — generate, parse, and patch. Built for AI agents, LLM tool-calling, and hand-written code alike; no Microsoft Office required, opens in every major office suite.

Documentation · AI Integration · Benchmarks · npm

⭐ If office-open speeds up your work, a star helps other developers find it.

Features

• 📄 All-in-One — Word (.docx), Excel (.xlsx), and PowerPoint (.pptx) in one cohesive API — no server required, works offline
• 🤖 AI Tooling — Draft-07 JSON Schemas frozen from the TypeScript API, on-demand schema slicing for LLM context budgets (CLI + SDK tool), Vercel AI SDK tool definitions, and an installable Agent Skill
• 🧭 100% OOXML Coverage — All 2,191 elements and 1,923 attributes across the 18 OOXML Transitional schemas (WordprocessingML, PresentationML, SpreadsheetML, DrawingML, shared math, and VML) are implemented for both generation and parsing — tracked by automated XSD coverage tooling
• 📐 Spec-Compliant — Output validates against the OOXML Transitional XSD schemas (ISO/IEC 29500) and is verified to open in Microsoft Office, WPS Office, LibreOffice, and Google Workspace
• 🔒 Fully Typed — Comprehensive TypeScript definitions for autocomplete and type safety across every API
• 🔄 Parse & Patch — Read existing .docx, .pptx, .xlsx files for round-trip workflows, or patch templates by placeholder replacement
• 🎨 Rich Content — Paragraphs, tables, images, charts, SmartArt, math equations, effects, animations, and more
• 🔀 Cross-Format Copy — Convert pictures, shapes, tables, and text between formats; each format keeps its native types, conversions reuse shared core domains — no unified model layer
• ⚡ High Performance — Pure string concatenation for XML generation, no intermediate AST, native zlib compression — see the benchmarks
• 🌐 Cross-Platform — Node.js, browsers, Deno, Bun. Export to Buffer, Blob, Base64, stream, or string

Performance

Highlights from the per-package benchmarks (ops/s, higher is better; Windows 11, Node 24 — the same scenarios run up to ~2× faster again on Bun 1.4). Compression matches MS Office defaults; full methodology, compression modes, and complete tables live in each package's README:

Packages

Package	Version	Description
office-open		Umbrella: all packages + CLI + AI SDK tools
@office-open/docx		Word document generation, parsing, and patching
@office-open/pptx		PowerPoint generation, parsing, and patching
@office-open/xlsx		Spreadsheet generation, parsing, and patching
@office-open/core		Shared OOXML infrastructure, charts, unit converters
@office-open/xml		Low-level XML parsing and serialization

Quick Start

# pnpm
pnpm add office-open

# npm
npm install office-open

# yarn
yarn add office-open

# bun
bun add office-open

The office-open package bundles all three format packages plus the CLI, JSON Schemas, and AI SDK tools. Prefer a smaller footprint? See Packages for the per-format @office-open/* packages.

import { generateDocumentSync } from "office-open/docx";
import { writeFileSync } from "node:fs";

// Options are plain JSON objects — zero class instantiation
const buffer = generateDocumentSync({
  sections: [
    {
      children: [
        { paragraph: { heading: "Heading1", children: ["Document Title"] } },
        { paragraph: { children: [{ text: "Body text", italic: true }] } },
        {
          table: {
            rows: [
              { cells: [{ children: [{ paragraph: "A1" }] }, { children: [{ paragraph: "B1" }] }] },
              { cells: [{ children: [{ paragraph: "A2" }] }, { children: [{ paragraph: "B2" }] }] },
            ],
          },
        },
      ],
    },
  ],
});
writeFileSync("document.docx", buffer);

PowerPoint and Excel follow the same shape — generatePresentationSync({ slides: [...] }) and generateWorkbookSync({ worksheets: [...] }); see the per-package READMEs linked above. There is also a type-dispatched generate() helper and a CLI:

npx office-open xlsx input.json "output.xlsx"

Parse Existing Files

Read existing files back into the same structured options for inspection or round-trip editing — parsePresentation (pptx) and parseWorkbook (xlsx) mirror it:

import { parseDocument } from "office-open/docx";

const opts = await parseDocument(buffer);
// opts.sections — document sections and content
// opts.title, opts.creator — core properties

AI Integration

Give AI agents first-class Office document abilities — four ways, no glue code:

Vercel AI SDK tools — let Claude, GPT, and other models generate valid documents with schema-validated retries:

import { generateText } from "ai";
import { officeOpenTools } from "office-open/ai";

const result = await generateText({
  model,
  prompt: "Create a quarterly report document",
  tools: officeOpenTools, // generate-docx / generate-pptx / generate-xlsx + schema lookup
});

MCP server — connect the documentation to Claude Code, Cursor, or any MCP client:

claude mcp add --transport http office-open https://www.office-open.com/mcp

Agent Skill — installable skill with curated API references for docx, pptx, and xlsx:

npx skills add https://www.office-open.com

JSON Schemas — frozen draft-07 schemas for your own tool-calling, sliced on demand to fit LLM context budgets:

npx office-open schema index docx
npx office-open schema slice docx ParagraphOptions

See the AI integration guide for details.

Versioning

This project follows Semantic Versioning. While the major version is 0 (pre-1.0), breaking API changes are released as minor version bumps (0.x.0) rather than patch releases — the public API is expected to keep evolving until the 1.0.0 stabilization release. Pin exact versions in downstream projects if you require stability between minor updates.

Development

Requires Node.js 18+ and pnpm 9+.

git clone https://github.com/DemoMacro/office-open.git
cd office-open
pnpm install

pnpm dev            # Development mode with watch
pnpm build          # Build all packages
pnpm test           # Run tests
pnpm check          # Lint & format

Contributing

We welcome contributions! Fork the repository, clone your fork, and add the upstream remote:

git clone https://github.com/YOUR_USERNAME/office-open.git
cd office-open
git remote add upstream https://github.com/DemoMacro/office-open.git
pnpm install

Then follow the workflow: code to the project standards, run pnpm build && pnpm test, commit with conventional commits (feat:, fix:, docs:, refactor:, …), push to your fork, and open a Pull Request against upstream.

Support & Community

• Documentation — guides, API reference, and AI integration docs
• Discussions — questions, ideas, and show-and-tell
• Changelog — release notes
• Report Issues — bug reports and feature requests

If office-open is useful to you, a ⭐ star helps other developers find it.

Sponsors

office-open is supported by Wiseair-srl — their json-to-office picks @office-open/docx as its quality-first DOCX renderer, with a live playground at docx.json-to-office.com. Thank you! Want to support the project too? GitHub Sponsors.

Acknowledgements

This project's git history began as a fork of dolanmiu/docx. The implementation has since been fully rewritten, but the API shape — sections, paragraphs, tables, runs — still follows the model that project established, and its design shaped our early direction. Thank you, Dolan Miu and docx contributors, for the head start and the inspiration.

License

This project is licensed under the MIT License — see the LICENSE file for details.

Built with ❤️ by Demo Macro