Vyuh DOCX
vyuh_docx is the pure-Dart document engine used by docx_editor and server workflows. It owns DOCX/SFDT parsing, the typed document model, layout, pagination, PDF export, document diffing, templating, validation, and lower-level reader diagnostics.
This documentation is intentionally scoped for code review. It does not include installation guides, host database requirements, or application deployment procedures.
Review Pages
| Page | What to review |
|---|---|
| Architecture Map | Engine layers, package boundary, source-backed rendering rule, and layout model responsibilities. |
| Configuration | PdfExporter, PdfLayoutEngine, reader, builder, parser, and deterministic render configuration. |
| SFDT to PDF | The full pure-Dart conversion path from Syncfusion JSON to PDF bytes. |
| Rendering Capabilities | Current renderer support for sections, paragraphs, runs, tables, images, shapes, comments, revisions, TOC, footnotes, fonts, and deterministic output. |
| API Reference | Public exports and API families exposed by package:vyuh_docx/vyuh_docx.dart. |
Package Boundary
| Package | Responsibility |
|---|---|
vyuh_docx | DOCX/SFDT readers, AST/model classes, builders, exporters, PDF layout engine, diff/template utilities, validation, and diagnostics. |
docx_editor | Flutter editor UI, Syncfusion bridge, actor/capability/lifecycle policy, signing, storage contracts, and controlled-print issuance. |
vyuh_docx should not own user permissions, lifecycle state, e-signature ceremonies, controlled-copy allocation, print registers, or audit persistence.
Main Import
dart
import 'package:vyuh_docx/vyuh_docx.dart';That import exposes the readers, model types, builders, exporters, layout model, diff/template helpers, parser utilities, and diagnostics documented in the API reference.