@portone/docx-editor 0.2.1 → 0.3.0

package/dist/docx/sdtProps.js

@@ -1,11 +1,21 @@
 // src/docx/sdtProps.ts
+import { elementXml, openTagXml } from "../ooxml/element.js";
+import { wName } from "../ooxml/names.js";
 import { editSdtPrefix } from "./sdt.js";
 var LOCK_BOTH_CLAUSES = '<w:lock w:val="sdtContentLocked"/>';
+function lockedControlPrefix(id) {
+  return openTagXml(wName("sdt"), null) + elementXml(
+    wName("sdtPr"),
+    [],
+    [elementXml(wName("id"), [[wName("val"), `${id}`]]), LOCK_BOTH_CLAUSES]
+  );
+}
 function withContentLock(sdtPrefix, locked) {
   return editSdtPrefix(sdtPrefix, [
     ["lock", locked ? LOCK_BOTH_CLAUSES : null]
   ]);
 }
 export {
+  lockedControlPrefix,
   withContentLock
 };

package/dist/docx/serializeBlock.d.ts

@@ -1,4 +1,6 @@
 import type { Node as PMNode } from "prosemirror-model";
 import { type ExportRefs } from "./exportRefs";
 import { type SessionStore } from "./session";
+/** Why there is no original to write, which a block that came in from another document answers differently */
+export declare function lostOriginal(node: PMNode, session: SessionStore): string;
 export declare function serializeBlock(node: PMNode, session: SessionStore, refs?: ExportRefs): string;

package/dist/docx/serializeBlock.js

@@ -3,14 +3,16 @@ import { DocxExportError } from "../ooxml/errors.js";
 import { NO_EXPORT_REFS } from "./exportRefs.js";
 import { preservedXml, serializeParagraph } from "./serializeParagraph.js";
 import { serializeTable } from "./serializeTable.js";
-import { originalBlock } from "./session.js";
+import { originalBlock, splitBlockKey } from "./session.js";
+function lostOriginal(node, session) {
+  const srcId = node.attrs.srcId;
+  const key = typeof srcId === "string" ? splitBlockKey(srcId) : null;
+  return key === null || key.sessionId === session.sessionId ? "a preserved block has lost its original XML" : `a preserved block comes from another document (${key.sessionId})`;
+}
 function serializeRaw(node, session) {
   const imported = originalBlock(node, session);
   if (!imported) {
-    throw new DocxExportError(
-      "lost-original",
-      "a preserved block has lost its original XML"
-    );
+    throw new DocxExportError("lost-original", lostOriginal(node, session));
   }
   return imported.xml;
 }
@@ -25,5 +27,6 @@ function serializeBlock(node, session, refs = NO_EXPORT_REFS) {
   );
 }
 export {
+  lostOriginal,
   serializeBlock
 };

package/dist/docx/serializeTable.js

@@ -8,16 +8,15 @@ import {
 import { elementXml, openTagXml } from "../ooxml/element.js";
 import { DocxExportError } from "../ooxml/errors.js";
 import { wName } from "../ooxml/names.js";
-import { NO_EXPORT_REFS } from "./exportRefs.js";
 import {
   innerXml,
   parseProps,
   propsChild,
   renderProps,
-  setPropsChild,
-  TBL_PR_ORDER,
-  TC_PR_ORDER
-} from "./propsXml.js";
+  setChild
+} from "../ooxml/props.js";
+import { ST_MeasurementOrPercent, ST_TwipsMeasure } from "../ooxml/simpleTypes.js";
+import { NO_EXPORT_REFS } from "./exportRefs.js";
 import {
   preservedXml,
   rawAttrsOf,
@@ -35,31 +34,49 @@ function modelled(name, attrs, replacing) {
   const inner = replacing === void 0 ? "" : innerXml(replacing);
   return elementXml(wName(name), attrs, inner === "" ? [] : [inner]);
 }
+function widthText(width) {
+  const value = widthNumber(width);
+  if (value === null || !Number.isFinite(value)) return "0";
+  return ST_MeasurementOrPercent.format({
+    kind: "number",
+    value: Math.round(value)
+  }) ?? "0";
+}
 function widthXml(name, width, replacing) {
   return modelled(
     name,
     [
-      [wName("w"), `${widthNumber(width) ?? 0}`],
+      [wName("w"), widthText(width)],
       [wName("type"), width.type]
     ],
     replacing
   );
 }
-function withWidth(props, name, width, order) {
+function withWidth(props, name, width) {
   if (!width) return props;
   const replacing = propsChild(props.children, name)?.xml;
-  return setPropsChild(props, name, widthXml(name, width, replacing), order);
+  return setChild(props, name, widthXml(name, width, replacing));
 }
 function tablePropsXml(table) {
   const props = propsOf(table.attrs.tblPr, "w:tblPr");
   const width = toTableWidth(table.attrs.tblW);
-  return renderProps(withWidth(props, "tblW", width, TBL_PR_ORDER));
+  return renderProps(withWidth(props, "tblW", width)) || elementXml(wName("tblPr"), []);
 }
 function tableGridXml(table) {
   const gridCols = toGridCols(table.attrs.gridCols);
-  if (gridCols.length === 0) return "";
-  const cols = gridCols.map((w) => elementXml(wName("gridCol"), [[wName("w"), `${w}`]])).join("");
-  return elementXml(wName("tblGrid"), [], [cols]);
+  const gridChange = typeof table.attrs.gridChange === "string" ? table.attrs.gridChange : "";
+  if (gridCols.length === 0 && gridChange === "") return "";
+  const cols = gridCols.map((w) => {
+    const width = ST_TwipsMeasure.format(Math.round(w));
+    if (width === null) {
+      throw new DocxExportError(
+        "invalid-table",
+        "a grid column has no writable width"
+      );
+    }
+    return elementXml(wName("gridCol"), [[wName("w"), width]]);
+  }).join("");
+  return elementXml(wName("tblGrid"), [], [cols + gridChange]);
 }
 function cellPropsXml(cell, role) {
   const props = propsOf(cell.attrs.tcPr, "w:tcPr");
@@ -75,10 +92,10 @@ function cellPropsXml(cell, role) {
     [[wName("val"), "restart"]],
     propsChild(props.children, "vMerge")?.xml
   ) : null;
-  const spanned = setPropsChild(props, "gridSpan", gridSpan, TC_PR_ORDER);
-  const merged = setPropsChild(spanned, "vMerge", vMerge, TC_PR_ORDER);
+  const spanned = setChild(props, "gridSpan", gridSpan);
+  const merged = setChild(spanned, "vMerge", vMerge);
   const width = toTableWidth(cell.attrs.tcW);
-  return renderProps(withWidth(merged, "tcW", width, TC_PR_ORDER));
+  return renderProps(withWidth(merged, "tcW", width));
 }
 function cellBlockXml(block, refs) {
   if (block.type.name === "paragraph") return serializeParagraph(block, refs);

package/dist/docx/session.d.ts

@@ -9,9 +9,9 @@
  */
 import type { Node as PMNode } from "prosemirror-model";
 import type { DocumentDefaults } from "../model/format";
-import { type Numbering } from "../numbering/parseNumbering";
+import { type Numbering, type NumberingOptions } from "../numbering/parseNumbering";
 import type { ImportedComments } from "./comments";
-import type { ParagraphFormatLayer, ParagraphStyleOption, StyleTable } from "./formatting";
+import type { FormattingContext, ParagraphStyleOption } from "./formatting";
 import type { HeadersFooters } from "./headersFooters";
 import type { PageGeometry } from "./pageGeometry";
 export interface ImportedBlock {
@@ -28,9 +28,23 @@ export interface ImportedBlock {
 export interface DocxSession {
     readonly kind: "docxSession";
 }
+/** What names one open document, which a block key is written against */
+export interface SessionIdentity {
+    readonly sessionId: string;
+}
+/**
+ * A name for one open document.
+ *
+ * Opening the same bytes twice opens two documents, so this is drawn fresh each time rather than
+ * worked out from what was opened. It carries no `:`, which is what lets a block key be read back
+ * however many colons the story it names holds.
+ */
+export declare function newSessionId(): string;
 /** What the package's own layers read the open document off */
-export declare class SessionStore implements DocxSession {
+export declare class SessionStore implements DocxSession, SessionIdentity {
     readonly kind = "docxSession";
+    /** Which open document this is. Every block key of it names it, so a block of another document is not taken for one of this one */
+    readonly sessionId: string;
     readonly parts: Map<string, Uint8Array>;
     readonly mainPartPath: string;
     readonly documentPrefix: string;
@@ -41,19 +55,12 @@ export declare class SessionStore implements DocxSession {
     readonly defaults: DocumentDefaults;
     /** The effective automatic tab interval read from settings.xml. Used for display only. */
     readonly defaultTabStopPt: number;
-    /** The paragraph properties at the base of the OOXML formatting hierarchy. */
-    readonly paragraphDefaults: ParagraphFormatLayer;
     /** The paper this document is written on, read from the first section. Used for display only: the `w:sectPr` itself goes back out in the preserved tail */
     readonly geometry: PageGeometry;
-    /** The style chain from styles.xml. Used only to fold the style a paragraph points at into its displayed values */
-    readonly styles: StyleTable;
+    /** Everything the display values of a paragraph or a run are resolved against: the style chain, the defaults, the list definitions */
+    readonly formatting: FormattingContext;
     /** The paragraph styles this document defines, in the order styles.xml lists them. What the style picker offers */
     readonly paragraphStyles: ParagraphStyleOption[];
-    /**
-     * The paragraph style every paragraph with no `w:pStyle` of its own wears (`w:default="1"`,
-     * usually Normal). null when the document marks none
-     */
-    readonly defaultParagraphStyleId: string | null;
     /** The raw text of numbering.xml. Kept around so list numbers can be drawn on screen. null if there is none */
     readonly numberingXml: string | null;
     /** Where numbering.xml sits inside the zip. When a new list is exported it is rewritten at that spot. null if there is none */
@@ -76,6 +83,27 @@ export declare function sessionOf(session: DocxSession): SessionStore;
 /** Where the body part sits inside the package, which is the one part an export rewrites */
 export declare function documentPartPath(session: DocxSession): string;
 /** The list definitions the document carries, which is what a paragraph's numbering points into */
-export declare function documentNumbering(session: DocxSession): Numbering;
-/** Finds which original block a node came from. undefined for a node newly created during editing */
+export declare function documentNumbering(session: DocxSession, options?: NumberingOptions): Numbering;
+/** The story a block key names when the block stood in the main document body */
+export declare const BODY_STORY_KEY = "body";
+/** A block key read back: which open document the block came from, which story of it, and where in that story */
+export interface BlockKey {
+    sessionId: string;
+    storyKey: string;
+    index: number;
+}
+/** Where a block stands, as the one string a node carries on its `srcId` */
+export declare function blockKey(session: SessionIdentity, storyKey: string, index: number): string;
+/**
+ * The three parts of a block key, or null for a string that is not one.
+ *
+ * A story key holds colons of its own (`comment:4`), so the key is read from both ends rather
+ * than split: the first segment is the document, the last is the place in the story, and
+ * everything between them is the story itself.
+ */
+export declare function splitBlockKey(key: string): BlockKey | null;
+/**
+ * Finds which original block a node came from. undefined for a node newly created during editing,
+ * and for one that came in from another document, whose original is in that file and not this one.
+ */
 export declare function originalBlock(node: PMNode, session: SessionStore): ImportedBlock | undefined;

package/dist/docx/session.js

@@ -1,7 +1,16 @@
 // src/docx/session.ts
-import { parseNumbering } from "../numbering/parseNumbering.js";
+import {
+  parseNumbering
+} from "../numbering/parseNumbering.js";
+var sessionsOpened = 0;
+function newSessionId() {
+  sessionsOpened += 1;
+  return `d${sessionsOpened}-${Math.random().toString(36).slice(2, 10)}`;
+}
 var SessionStore = class {
   kind = "docxSession";
+  /** Which open document this is. Every block key of it names it, so a block of another document is not taken for one of this one */
+  sessionId;
   parts;
   mainPartPath;
   documentPrefix;
@@ -12,19 +21,12 @@ var SessionStore = class {
   defaults;
   /** The effective automatic tab interval read from settings.xml. Used for display only. */
   defaultTabStopPt;
-  /** The paragraph properties at the base of the OOXML formatting hierarchy. */
-  paragraphDefaults;
   /** The paper this document is written on, read from the first section. Used for display only: the `w:sectPr` itself goes back out in the preserved tail */
   geometry;
-  /** The style chain from styles.xml. Used only to fold the style a paragraph points at into its displayed values */
-  styles;
+  /** Everything the display values of a paragraph or a run are resolved against: the style chain, the defaults, the list definitions */
+  formatting;
   /** The paragraph styles this document defines, in the order styles.xml lists them. What the style picker offers */
   paragraphStyles;
-  /**
-   * The paragraph style every paragraph with no `w:pStyle` of its own wears (`w:default="1"`,
-   * usually Normal). null when the document marks none
-   */
-  defaultParagraphStyleId;
   /** The raw text of numbering.xml. Kept around so list numbers can be drawn on screen. null if there is none */
   numberingXml;
   /** Where numbering.xml sits inside the zip. When a new list is exported it is rewritten at that spot. null if there is none */
@@ -36,6 +38,7 @@ var SessionStore = class {
   /** First-section header and footer stories projected for the page preview. */
   headersFooters;
   constructor(opened) {
+    this.sessionId = opened.sessionId;
     this.parts = opened.parts;
     this.mainPartPath = opened.mainPartPath;
     this.documentPrefix = opened.documentPrefix;
@@ -44,11 +47,9 @@ var SessionStore = class {
     this.blocks = opened.blocks;
     this.defaults = opened.defaults;
     this.defaultTabStopPt = opened.defaultTabStopPt;
-    this.paragraphDefaults = opened.paragraphDefaults;
     this.geometry = opened.geometry;
-    this.styles = opened.styles;
+    this.formatting = opened.formatting;
     this.paragraphStyles = opened.paragraphStyles;
-    this.defaultParagraphStyleId = opened.defaultParagraphStyleId;
     this.numberingXml = opened.numberingXml;
     this.numberingPartPath = opened.numberingPartPath;
     this.comments = opened.comments;
@@ -63,17 +64,42 @@ function sessionOf(session) {
 function documentPartPath(session) {
   return sessionOf(session).mainPartPath;
 }
-function documentNumbering(session) {
-  return parseNumbering(sessionOf(session).numberingXml);
+function documentNumbering(session, options) {
+  return parseNumbering(sessionOf(session).numberingXml, options);
+}
+var BODY_STORY_KEY = "body";
+function blockKey(session, storyKey, index) {
+  return `${session.sessionId}:${storyKey}:${index}`;
+}
+function splitBlockKey(key) {
+  const first = key.indexOf(":");
+  const last = key.lastIndexOf(":");
+  if (first < 1 || last <= first + 1) return null;
+  const indexText = key.slice(last + 1);
+  if (!/^\d+$/.test(indexText)) return null;
+  const index = Number(indexText);
+  if (!Number.isSafeInteger(index)) return null;
+  return {
+    sessionId: key.slice(0, first),
+    storyKey: key.slice(first + 1, last),
+    index
+  };
 }
 function originalBlock(node, session) {
   const srcId = node.attrs.srcId;
-  return typeof srcId === "number" ? session.blocks[srcId] : void 0;
+  if (typeof srcId !== "string") return void 0;
+  const key = splitBlockKey(srcId);
+  if (key === null || key.sessionId !== session.sessionId) return void 0;
+  return key.storyKey === BODY_STORY_KEY ? session.blocks[key.index] : void 0;
 }
 export {
+  BODY_STORY_KEY,
   SessionStore,
+  blockKey,
   documentNumbering,
   documentPartPath,
+  newSessionId,
   originalBlock,
-  sessionOf
+  sessionOf,
+  splitBlockKey
 };