@jonahschulte/rtf-toolkit

> Modern TypeScript RTF parser with track changes support

![Tests]()

A production-grade RTF parsing library for JavaScript/TypeScript with comprehensive track changes support. Perfect for government contracts, legal documents, and any application requiring RTF document analysis.

✨ Features

- ✅ Full RTF Parsing - Handles RTF 1.9.1 specification
- ✅ Track Changes Support - Parse insertions, deletions, and author metadata
- ✅ HTML Conversion - Clean, semantic HTML output
- ✅ TypeScript First - Full type safety and IntelliSense
- ✅ Zero Dependencies - Lightweight core library
- ✅ 100% Tested - 94 comprehensive unit tests
- ✅ Visual Track Changes - HTML rendering with color-coded changes

Installation

``bash
npm install @jonahschulte/rtf-toolkit
`

Quick Start

$3

`typescript
import { parseRTF, toHTML } from '@jonahschulte/rtf-toolkit';

// Parse RTF
const rtf = '{\\rtf1\\b Bold\\b0 and \\i italic\\i0 text}';
const doc = parseRTF(rtf);

// Convert to HTML
const html = toHTML(doc);
console.log(html);
// Output:

`typescript
import { parseRTF, getTrackChanges, getTrackChangeMetadata } from '@jonahschulte/rtf-toolkit';

// Parse RTF with track changes
const rtf = {\\rtf1
{\\*\\revtbl{Unknown;}{John Doe;}{Jane Smith;}}
Original text {\\revised\\revauth1 inserted by John} more text.
{\\deleted\\revauth2 removed by Jane} final text.};

const doc = parseRTF(rtf);

// Get all track changes
const changes = getTrackChanges(doc);
changes.forEach((change) => {
console.log(${change.type}: "${change.text}" by ${change.author});
});
// Output:
// insertion: "inserted by John" by John Doe
// deletion: "removed by Jane" by Jane Smith

// Get summary metadata
const metadata = getTrackChangeMetadata(doc);
console.log(${metadata.totalChanges} changes by ${metadata.authors.length} authors);
// Output: 2 changes by 2 authors
`

$3

`typescript
import { parseRTF, toHTML } from '@jonahschulte/rtf-toolkit';

const rtfWithChanges = {\\rtf1
{\\*\\revtbl{Unknown;}{Editor;}}
Text with {\\revised\\revauth1 new content} here.};

const doc = parseRTF(rtfWithChanges);
const html = toHTML(doc);

console.log(html);
// Output includes:
// // style="background-color: #d4edda; border-bottom: 2px solid #28a745;"
// data-revision-type="insertion"
// data-author="Editor">new content
`

API Reference

$3

#### parseRTF(rtf: string): RTFDocument

Parse an RTF string into an Abstract Syntax Tree (AST).

`typescript
const doc = parseRTF(rtfString);
console.log(doc.rtfVersion); // 1
console.log(doc.charset); // 'ansi'
console.log(doc.fontTable); // Array of fonts
console.log(doc.colorTable); // Array of colors
console.log(doc.content); // Array of paragraphs
`

$3

#### toHTML(doc: RTFDocument, options?: HTMLOptions): string

Convert RTF document AST to HTML.

`typescript
const html = toHTML(doc, {
includeWrapper: true, // Wrap in