@portone/docx-editor 0.6.0 → 0.6.2

package/dist/docx/importDocx.js

@@ -37,7 +37,12 @@ import { readLinkTargets } from "./hyperlink.js";
 import { NO_IMPORT_SOURCES } from "./importParagraph.js";
 import { readImageSources } from "./media.js";
 import { NUMBERING_REL_TYPE } from "./newLists.js";
-import { readNotes } from "./notes.js";
+import { withNoteLabels } from "./notes/numbering.js";
+import {
+  readNoteNumbering,
+  readNotes,
+  specialNotesOf
+} from "./notes/reading.js";
 import { readPart, relatedPartPath } from "./packageParts.js";
 import { A4_PORTRAIT } from "./pageGeometry.js";
 import { readRelationships } from "./relationships.js";
@@ -215,25 +220,13 @@ function readDocx(input) {
   );
   const comments = readComments(parts, mainPartPath);
   const notes = readNotes(parts, mainPartPath);
-  const noteLabels = {
-    footnote: /* @__PURE__ */ new Map(),
-    endnote: /* @__PURE__ */ new Map()
-  };
-  const noteLabel = (kind, id) => {
-    const labels = noteLabels[kind];
-    const existing = labels.get(id);
-    if (existing) return existing;
-    const label = `${labels.size + 1}`;
-    labels.set(id, label);
-    return label;
-  };
+  const noteNumbering = readNoteNumbering(settingsDom);
+  const specialNotes = specialNotesOf(notes);
   const sources = {
     images: readImageSources(parts, mainPartPath),
     themeFonts,
     links: readLinkTargets(parts, mainPartPath),
-    comments,
-    notes,
-    noteLabel
+    comments
   };
   const sessionId = newSessionId();
   const headerFooters = readHeaderFooterStories(
@@ -275,14 +268,18 @@ function readDocx(input) {
       )
     );
   }
-  const doc = docxSchema.nodes.doc.create(
-    {
-      sectPr: scan.sectPr,
-      stories: Object.fromEntries(
-        Array.from(stories, ([key, story]) => [key, story.doc.toJSON()])
-      )
-    },
-    blockNodes
+  const doc = withNoteLabels(
+    docxSchema.nodes.doc.create(
+      {
+        sectPr: scan.sectPr,
+        stories: Object.fromEntries(
+          Array.from(stories, ([key, story]) => [key, story.doc.toJSON()])
+        )
+      },
+      blockNodes
+    ),
+    noteNumbering,
+    specialNotes
   );
   return {
     doc,
@@ -294,7 +291,7 @@ function readDocx(input) {
       documentPrefix: scan.prefix,
       documentSuffix: scan.suffix,
       documentHadBom: hadBom,
-      blocks: blockNodes.map((node, i) => ({
+      blocks: doc.children.map((node, i) => ({
         xml: scan.blocks[i]?.xml ?? "",
         node
       })),
@@ -308,7 +305,9 @@ function readDocx(input) {
       comments,
       commentReferenceIds: new Set(commentReferencesIn(doc).keys()),
       headerFooterStories: headerFooters.refs,
-      stories
+      stories,
+      noteNumbering,
+      specialNotes
     })
   };
 }

package/dist/docx/importParagraph.d.ts

@@ -19,11 +19,10 @@ import type { Node as PMNode } from "prosemirror-model";
 import { type ImportedComments } from "./comments/reading";
 import { type LinkTargets } from "./hyperlink";
 import type { ImageSources } from "./media";
-import { type ImportedNotes, type NoteKind } from "./notes";
 import { type ThemeFonts } from "./theme";
 /**
  * What the body is read with: the images its drawings can point at, the fonts a theme reference
- * resolves to, the addresses its links can point at, and the bodies of its comments and notes.
+ * resolves to, the addresses its links can point at, and the comments its references name.
  * They travel together from `docx/importDocx` down through the tables to here.
  */
 export interface ImportSources {
@@ -31,8 +30,6 @@ export interface ImportSources {
     themeFonts: ThemeFonts;
     links: LinkTargets;
     comments: ImportedComments;
-    notes: ImportedNotes;
-    noteLabel: (kind: NoteKind, id: string) => string;
 }
 export declare const NO_IMPORT_SOURCES: ImportSources;
 /**

package/dist/docx/importParagraph.js

@@ -20,7 +20,6 @@ import {
   preservationOf
 } from "./importPreserved.js";
 import { NO_IMAGES } from "./media.js";
-import { NO_NOTES, noteById } from "./notes.js";
 import { NO_THEME_FONTS } from "./theme.js";
 import { wrapperFits, wrapperKindFor } from "./wrappers.js";
 function runMark(run, themeFonts) {
@@ -47,7 +46,7 @@ function buildImage(el, marks, images) {
     marks
   );
 }
-function buildModelledRunChild(el, marks, images, comments, notes, noteLabel) {
+function buildModelledRunChild(el, marks, images, comments) {
   switch (el.localName) {
     case "t": {
       const text = el.textContent ?? "";
@@ -102,7 +101,6 @@ function buildModelledRunChild(el, marks, images, comments, notes, noteLabel) {
       const id = annotationId(el);
       if (id === null) return null;
       const kind = el.localName === "footnoteReference" ? "footnote" : "endnote";
-      const note = noteById(notes, kind, id);
       const written = attributeByLocalName(el, "customMarkFollows");
       const customMarkFollows = written !== null && (ST_OnOff.parse(written) ?? true);
       return [
@@ -110,7 +108,6 @@ function buildModelledRunChild(el, marks, images, comments, notes, noteLabel) {
           {
             kind,
             id,
-            label: note ? noteLabel(kind, id) : "?",
             customMarkFollows,
             referenceXml: serializeXml(el)
           },
@@ -123,7 +120,7 @@ function buildModelledRunChild(el, marks, images, comments, notes, noteLabel) {
       return null;
   }
 }
-function buildRunNodes(run, images, themeFonts, comments, notes, noteLabel, wrappers = []) {
+function buildRunNodes(run, images, themeFonts, comments, wrappers = []) {
   const mark = runMark(run, themeFonts);
   const marks = wrappers.reduce(
     (set, wrapper) => wrapper.addToSet(set),
@@ -134,14 +131,7 @@ function buildRunNodes(run, images, themeFonts, comments, notes, noteLabel, wrap
     const policy = policyFor(child, "r");
     if (policy.tier === "model") {
       if (child.localName === "rPr") continue;
-      const built = buildModelledRunChild(
-        child,
-        marks,
-        images,
-        comments,
-        notes,
-        noteLabel
-      );
+      const built = buildModelledRunChild(child, marks, images, comments);
       if (built !== null) {
         nodes.push(...built);
         continue;
@@ -176,9 +166,7 @@ var NO_IMPORT_SOURCES = {
   images: NO_IMAGES,
   themeFonts: NO_THEME_FONTS,
   links: NO_LINK_TARGETS,
-  comments: NO_COMMENTS,
-  notes: NO_NOTES,
-  noteLabel: () => "?"
+  comments: NO_COMMENTS
 };
 function buildModelledInline(child, sources, depth, wrappers) {
   if (child.localName === "r") {
@@ -187,8 +175,6 @@ function buildModelledInline(child, sources, depth, wrappers) {
       sources.images,
       sources.themeFonts,
       sources.comments,
-      sources.notes,
-      sources.noteLabel,
       wrappers
     );
   }

package/dist/docx/invariants.d.ts

@@ -5,27 +5,30 @@
  * would throw, so a screen can ask at edit time what `exportDocx` would say. The list is walked in
  * order and `exportDocx` throws its first entry, which is what keeps the two from disagreeing.
  *
+ * A code covers several situations, so each entry also carries the `ExportProblemReason`
+ * (`ooxml/errors`) naming the one that was met and the content it is about. Every place a problem
+ * is built names its own, rather than a reader telling them apart by the message.
+ *
+ * What the writer puts out block by block is the body and every side story a part writer rewrites
+ * (`exportScopes`), so the invariants over content are asked of each of those in turn: markup
+ * refused in the body is refused just the same out of a footnote or a header.
+ *
  * The checks inspect model attrs and preserved XML without running the writers. Bookmark
  * fragments and list definitions use the export parser. `assertBookmarkPairs` in `./exportDocx`
  * and `assertPartsParse` in `./partPlan` remain the final checks over the parts as actually written.
  */
 import type { Node as PMNode } from "prosemirror-model";
-import type { DocxExportErrorCode } from "../ooxml/errors";
+import type { ExportProblem } from "../ooxml/errors";
 import type { ExportOptions } from "./exportDocx";
 import { type DocxSession, type SessionStore } from "./session";
-/** One reason the document cannot be written back, with the code `exportDocx` would throw it under */
-export interface ExportProblem {
-    readonly code: DocxExportErrorCode;
-    readonly message: string;
-    /** Where the problem stands in the document. Absent for a problem of the package or of the session */
-    readonly pos?: number;
-}
+export type { ExportPartName, ExportProblem, ExportProblemReason, ExportProblemStory, ExportStoryKind, } from "../ooxml/errors";
 /** The problems as the writer sees them, for a caller already inside the writer's parser scope */
 export declare function problemsOf(doc: PMNode, session: SessionStore): readonly ExportProblem[];
 /**
  * Known reasons writing this document back would be refused, in the order `exportDocx` would
- * raise them. An empty list does not rule out failures while writing. Each entry carries the code and message the
- * `DocxExportError` would carry, and the position in the document where there is one.
+ * raise them. An empty list does not rule out failures while writing. Each entry carries the code
+ * and message the `DocxExportError` would carry, the `reason` naming what the refusal is about,
+ * and the position in the document where there is one.
  *
  * The list definitions are read to tell a new list from one the document already had, so this
  * needs an XML parser the way `exportDocx` does and takes the same option.