office-open 0.10.15 → 0.12.0

package/README.md

@@ -4,14 +4,14 @@
 ![npm downloads](https://img.shields.io/npm/dw/office-open)
 ![npm license](https://img.shields.io/npm/l/office-open)
 
-> Umbrella package for Office Open XML — all packages, CLI, AI SDK tools, and Zod schemas in one install.
+> Everything for AI-native Office documents in one install — Word (.docx), Excel (.xlsx), and PowerPoint (.pptx) generation from JSON, plus a CLI, Vercel AI SDK tools, and frozen JSON Schemas for LLM tool-calling.
 
 ## Features
 
-- **Unified Re-exports** — Import from `office-open/docx`, `office-open/pptx`, `office-open/xlsx`
+- **One Install** — Import from `office-open/docx`, `office-open/pptx`, `office-open/xlsx`; no Microsoft Office required
+- **AI SDK Tools** — Vercel AI SDK compatible tools for `generate-docx`, `generate-pptx`, `generate-xlsx`, ready for AI agents and chatbots
+- **JSON Schemas** — Draft-07 input validation for all document types, with on-demand schema slicing for LLM context budgets
 - **CLI** — Generate files from JSON via `npx office-open`
-- **AI SDK Tools** — Vercel AI SDK compatible tools for `generate-docx`, `generate-pptx`, `generate-xlsx`
-- **Zod Schemas** — Input validation for all document types
 - **Generate Function** — Type-agnostic `generate()` for dynamic document creation
 
 ## Installation
@@ -57,6 +57,11 @@ const buffer = await generate({
 npx office-open docx document.json "output.docx"
 npx office-open pptx slides.json "output.pptx"
 npx office-open xlsx spreadsheet.json "output.xlsx"
+
+# Consult the JSON schemas (for AI agents and humans)
+npx office-open schema index docx                        # indexed lookup entries by domain
+npx office-open schema index docx --all                   # every definition name
+npx office-open schema slice docx ParagraphOptions RunOptions   # sub-schema for those types
 ```
 
 ### AI SDK Tools
@@ -72,16 +77,31 @@ const result = await generateText({
 });
 ```
 
-### Zod Schemas
+The generate tools carry skeleton input schemas (top-level shape + wrapper keys, ~5K tokens instead of the ~170K-token full schema); the `office-open-schema-lookup` tool fetches precise option schemas on demand.
+
+Two more agent entry points live on the documentation site:
+
+```bash
+# MCP server for Claude Code, Cursor, and other MCP clients
+claude mcp add --transport http office-open https://www.office-open.com/mcp
+
+# Installable Agent Skill with curated API references
+npx skills add https://www.office-open.com
+```
+
+### JSON Schemas
 
 ```typescript
-import { validateDocumentInput } from "office-open/schemas";
+import { validateDocumentInput, sliceDocumentSchema } from "office-open/schemas";
 
 try {
   const validated = validateDocumentInput("docx", userInput);
 } catch (e) {
-  // Structured validation error with path and message
+  // Aggregated validation errors with instance paths and messages
 }
+
+// Extract the dependency closure of specific option types
+const slice = sliceDocumentSchema("docx", ["ParagraphOptions", "RunOptions"]);
 ```
 
 ### Import from Sub-Packages
@@ -91,7 +111,7 @@ import { generateDocument, parseDocument, patchDocument } from "office-open/docx
 import { generatePresentation, parsePresentation, patchPresentation } from "office-open/pptx";
 import { generateWorkbook, parseWorkbook, patchWorkbook } from "office-open/xlsx";
 import { convertInchesToTwip } from "office-open/core";
-import { xml2js, js2xml } from "office-open/xml";
+import { parse, stringify } from "office-open/xml";
 ```
 
 ## Sub-Exports
@@ -106,7 +126,7 @@ import { xml2js, js2xml } from "office-open/xml";
 | `office-open/xml`      | @office-open/xml                         |
 | `office-open/generate` | `generate()` function                    |
 | `office-open/ai`       | Vercel AI SDK tools                      |
-| `office-open/schemas`  | Zod validation schemas                   |
+| `office-open/schemas`  | JSON schemas, validation, and slicing    |
 
 ## JSON Document Structures