Loading...
;\n if (error) return Error: {error.message}
;\n\n return (\n \n \n \n
\n );\n}\n```\n\n### Using the Comparison Hook\n\n```tsx\nimport { useComparison } from 'docxodus/react';\n\nfunction DocumentComparer() {\n const {\n html,\n isComparing,\n error,\n compareToHtml,\n downloadResult\n } = useComparison('/wasm/');\n\n const handleCompare = async (original: File, modified: File) => {\n await compareToHtml(original, modified, { authorName: 'Legal Team' });\n };\n\n return (\n \n {isComparing &&
\n );\n}\n```\n\n## Node.js (ES modules)\n\nImport the engine from `docxodus/core` for server-side conversion, comparison, annotations,\nand document sessions. It loads without a bundler or a custom Node loader:\n\n```js\nimport { readFile, writeFile } from 'node:fs/promises';\nimport { initialize, convertDocxToHtml, compareDocuments } from 'docxodus/core';\n\nawait initialize(); // Finds the WASM runtime included in the installed package.\nconst original = await readFile('original.docx');\nconst revised = await readFile('revised.docx');\nawait writeFile('original.html', await convertDocxToHtml(original));\nawait writeFile('redline.docx', await compareDocuments(original, revised));\n```\n\n`docxodus/core` exposes the engine functions, types, enums, annotation helpers, and history\nAPIs from `docxodus`, excluding `DocxEditor`, `CommentGutter`, `mountRibbon`, and their editor\ntypes. The existing `docxodus` entry includes those browser editor APIs and requires a browser\nbundler; use `docxodus/core` in plain Node ESM. Both entries share the same engine state.\nBrowser helpers retained in `core`, such as pagination, the document viewport, IndexedDB\nstorage, and history controls, still require their browser APIs when called.\n\n## API Reference\n\n### Package verification\n\n`generatePackageManifest(document)` inspects supplied bytes without opening an editable package;\n`session.getPackageManifest()` describes the current logical session checkpoint, including unsaved\nedits, without advancing its version. Both return the same schema-v1 `PackageManifest` with exact\npackage, ordered OPC-content, and normalized-semantic SHA-256 identities plus entries,\nrelationships, facts, and structured findings. Worker users can call\n`worker.generatePackageManifest(document)` or `await workerSession.getPackageManifest()`. See\n[`package_manifests.md`](../docs/architecture/package_manifests.md) for the normalization boundary.\n\n### Stateful inspection and editing\n\n`openDocxSession(bytes)` exposes the live document rather than a one-shot conversion. Inspect the\nsource before writing it: `listStyles()` returns the document's actual paragraph/character/table\nstyles, `getFormatting(anchorId)` keeps `directParagraph` separate from `effectiveParagraph`, and\n`listInlineSpans(anchorId)` returns `anchorId` + `span` pairs accepted unchanged by `applyFormat`.\n\n```typescript\nconst session = openDocxSession(bytes);\ntry {\n const anchorId = Object.keys(session.project().anchorIndex)[0];\n const style = session.listStyles().find(s => s.name === \"Strong Custom\");\n const run = session.listInlineSpans(anchorId).find(s => s.text === \"Defined Term\");\n if (style && run) {\n session.applyFormat(run.anchorId, run.span, { runStyle: style.id });\n }\n} finally {\n session.close();\n}\n```\n\nAn omitted property in a `direct` record means \"not written at this layer\"; it must not be treated\nas false or zero. The matching `effective` record resolves document defaults and the full style\nchain. `getListMembership` and `getSectionInfo` likewise return their query `anchorId` so callers\ndo not have to translate between inspection and mutation coordinate systems.\n\n`effective` is deliberately a shorter cascade than the renderer's: it excludes the numbering\nlevel's own paragraph properties and the table style's conditional formatting, so a list item\nindented only by its numbering definition reports `leftIndentTwips: 0` and a run bolded by a\n`firstRow` table style reports `bold: false`. Use `getListMembership` for the real numbering\nindentation. See `docs/architecture/docx_mutation_api.md` for the exact layer list.\n\n### Core Functions\n\n#### `initialize(basePath?: string): PromiseComparing...
}\n {error &&Error: {error.message}
}\n {html && }\n \n` and\n`