DocxReviewer API

npm install @eigenpal/docx-editor-agents

import { DocxReviewer } from '@eigenpal/docx-editor-agents';
 
const reviewer = await DocxReviewer.fromBuffer(buffer, 'AI Reviewer');
 
// Read — plain text with paragraph indices for LLM prompts
const text = reviewer.getContentAsText();
// [0] (h1) Introduction
// [1] The liability cap is $50k per incident.
// [2] (table, row 1, col 1) Revenue ...
 
// Comment on a paragraph (anchors to whole paragraph)
reviewer.addComment(1, 'This cap seems too low.');
 
// Replace text (creates tracked change)
reviewer.replace(1, '$50k', '$500k');
 
// Or batch from an LLM JSON response
reviewer.applyReview({
  comments: [{ paragraphIndex: 1, text: 'Too low.' }],
  proposals: [{ paragraphIndex: 1, search: '$50k', replaceWith: '$500k' }],
});
 
// Export
const output = await reviewer.toBuffer();

// app/api/review/route.ts
import { NextRequest, NextResponse } from 'next/server';
import OpenAI from 'openai';
import { DocxReviewer } from '@eigenpal/docx-editor-agents';
 
const openai = new OpenAI();
 
export async function POST(request: NextRequest) {
  const formData = await request.formData();
  const file = formData.get('file') as File;
  if (!file) return NextResponse.json({ error: 'No file' }, { status: 400 });
 
  // 1. Parse DOCX and read as plain text
  const reviewer = await DocxReviewer.fromBuffer(await file.arrayBuffer(), 'AI Reviewer');
  const text = reviewer.getContentAsText();
 
  // 2. Send to LLM
  const response = await openai.chat.completions.create({
    model: 'gpt-4o',
    response_format: { type: 'json_object' },
    messages: [
      {
        role: 'system',
        content: `Review this document. Return JSON:
{
  "comments": [{ "paragraphIndex": <number>, "text": "<feedback>" }],
  "replacements": [{ "paragraphIndex": <number>, "search": "<phrase>", "replaceWith": "<better>" }]
}
paragraphIndex must match a [number] from the document.`
      },
      { role: 'user', content: text }
    ],
  });
 
  const actions = JSON.parse(response.choices[0]?.message?.content || '{}');
 
  // 3. Apply review — author is set once on the reviewer
  reviewer.applyReview({
    comments: actions.comments,
    proposals: actions.replacements,
  });
 
  // 4. Return modified DOCX
  const output = await reviewer.toBuffer();
  return new NextResponse(output, {
    headers: {
      'Content-Type': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
    },
  });
}

import { readFileSync, writeFileSync } from 'fs';
import { DocxReviewer } from '@eigenpal/docx-editor-agents';
 
const buffer = readFileSync('contract.docx');
const reviewer = await DocxReviewer.fromBuffer(buffer.buffer, 'Legal Bot');
 
// Read content
const content = reviewer.getContentAsText();
console.log(content);
// [0] (h1) Service Agreement
// [1] The liability cap is $50k per incident.
// [2] (table, row 1, col 1) Party A ...
 
// Add comments and changes directly
reviewer.addComment(1, 'Liability cap is below industry standard.');
reviewer.replace(1, '$50k', '$500k');
 
// Export
const output = await reviewer.toBuffer();
writeFileSync('contract-reviewed.docx', Buffer.from(output));

import Anthropic from '@anthropic-ai/sdk';
import { DocxReviewer } from '@eigenpal/docx-editor-agents';
 
const client = new Anthropic();
const reviewer = await DocxReviewer.fromBuffer(buffer, 'Claude Reviewer');
 
const response = await client.messages.create({
  model: 'claude-sonnet-4-20250514',
  max_tokens: 4096,
  messages: [{
    role: 'user',
    content: `Review this document and return JSON with comments and replacements:\n\n${reviewer.getContentAsText()}`
  }],
});
 
const actions = JSON.parse(response.content[0].text);
reviewer.applyReview({ comments: actions.comments, proposals: actions.replacements });