@file-viewer/docx 0.3.29 → 0.3.31

package/README.md

@@ -104,7 +104,7 @@ markup in the DOM, show comments by default, and enable the four read-only views
 import {
   collectDocxReviewChanges,
   renderAsync,
-  setDocxReviewMode
+  renderDocument
 } from "@file-viewer/docx";
 
 const document = await renderAsync(file, container, null, {
@@ -112,7 +112,7 @@ const document = await renderAsync(file, container, null, {
 });
 
 const changes = collectDocxReviewChanges(document);
-setDocxReviewMode(container, "original"); // no reparse required
+await renderDocument(document, container, null, { reviewMode: "original" });
 ```
 
 `renderChanges: true` is retained as a compatibility alias for `reviewMode: "all"`.
@@ -127,6 +127,20 @@ wants Word-style margin balloons can use `collectDocxReviewChanges()` together
 with the stable `data-docx-change-*` anchors; the renderer does not force that
 optional review UI on normal document previews.
 
+Paragraph-mark revisions are resolved when rendering a review mode: deleted
+marks join paragraphs in `final`/`simple`, and inserted marks join paragraphs
+in `original`. Content stays within its table cell, section, or positioned
+frame. Native Word-created fixtures verify paragraph boundaries, tabs, soft
+breaks, mixed bold runs, CJK replacements, and table cell text against Word's
+Accept All and Reject All files. The browser gate repeats these checks in
+the main thread and a real Worker while reusing the parsed document.
+
+Use `renderDocument()` with the returned parsed document when switching a view
+that can change paragraph boundaries; it does not parse or upload the file again.
+The synchronous `setDocxReviewMode()` helper changes CSS visibility only. It does
+not rebuild paragraph structure or pagination and is not a substitute for that
+render step. File Viewer's Word settings perform the render step automatically.
+
 `collectDocxReviewChanges()` returns logical Word review items rather than raw
 OOXML wrappers. Adjacent/nested revision fragments from the same paragraph,
 author, and edit session are coalesced; `ids` lists every source revision id.
@@ -330,3 +344,16 @@ node tests/regression/check-numbering-suffix.cjs
 ```
 
 The large database-design regression uses the cached rendered snapshot by default to avoid spending minutes rebuilding the full document in constrained CI. Set `DOCXJS_RERENDER_REGRESSION=1` when you need to regenerate it from the DOCX.
+
+## Maintainer releases
+
+`publish.yml` checks out the exact stable release tag, builds the package, runs
+semantic and native Word browser regressions, then publishes with npm provenance.
+The npm trusted publisher must bind `@file-viewer/docx` to
+`flyfish-dev/docxjs` and `publish.yml`; no long-lived npm token is required.
+The workflow alone does not create that npm permission.
+
+Manual dispatch defaults to a dry run and requires an existing release tag.
+Retries verify the packed SHA-512 against the registry before skipping an
+existing version. Different bytes or an uncertain write stop the run rather
+than changing the version or repeating an authentication prompt.