@portone/docx-editor 0.2.0 → 0.3.0

package/dist/docx/formatting/effectiveParagraph.js

@@ -1,81 +0,0 @@
-// src/docx/formatting/effectiveParagraph.ts
-import { toParagraphFormat } from "../../model/format.js";
-import { mergeTabStops } from "../../model/tabStops.js";
-import {
-  EMPTY_NUMBERING,
-  levelIndentPt
-} from "../../numbering/parseNumbering.js";
-import { parsePropsXml } from "../propsXml.js";
-import { readParagraphFormat } from "./direct.js";
-import {
-  paragraphStyleFormat
-} from "./styles.js";
-import { layerParagraphValues } from "./tabStops.js";
-var NO_PARAGRAPH_FORMATTING = {
-  styles: /* @__PURE__ */ new Map(),
-  defaultStyleId: null,
-  defaults: {},
-  numbering: EMPTY_NUMBERING
-};
-function numberingRef(defaults, style, direct) {
-  let value = defaults.numbering;
-  if (style.numbering !== void 0) value = style.numbering;
-  if (direct.numbering !== void 0) value = direct.numbering;
-  return value;
-}
-function numberingLayer(ref, numbering) {
-  if (!ref) return {};
-  const level = numbering.lists.get(ref.numId)?.levels.get(ref.ilvl);
-  if (!level) return {};
-  const indent = levelIndentPt(level.indent);
-  const leadingIndentPt = indent.startPt;
-  const implicitHangingStop = leadingIndentPt !== null && indent.textIndentPt !== null && indent.textIndentPt < 0 ? [{ positionPt: leadingIndentPt, align: "start" }] : [];
-  return {
-    tabStops: [...implicitHangingStop, ...level.tabStops ?? []]
-  };
-}
-function withImplicitHangingStop(format) {
-  const leadingIndentPt = format?.indentStartPt ?? format?.indentLeftPt;
-  if (format?.textIndentPt === void 0 || format.textIndentPt >= 0 || leadingIndentPt === void 0) {
-    return format;
-  }
-  const implicit = {
-    positionPt: leadingIndentPt,
-    align: "start"
-  };
-  return {
-    ...format,
-    tabStops: mergeTabStops([implicit], format.tabStops ?? [])
-  };
-}
-function directLayer(pPr) {
-  if (typeof pPr !== "string") return {};
-  return readParagraphFormat(parsePropsXml(pPr)) ?? {};
-}
-function styleFor(pPr, context) {
-  return paragraphStyleFormat(pPr, context.styles, context.defaultStyleId);
-}
-function effectiveParagraphFormat(pPr, context) {
-  const direct = directLayer(pPr);
-  const style = styleFor(pPr, context)?.paragraph ?? {};
-  const level = numberingLayer(
-    numberingRef(context.defaults, style, direct),
-    context.numbering
-  );
-  const layered = [level, style, direct].reduce(
-    layerParagraphValues,
-    context.defaults
-  );
-  const format = toParagraphFormat(layered);
-  return withImplicitHangingStop(
-    format !== null && Object.keys(format).length === 0 ? null : format
-  );
-}
-function effectiveParagraphStyle(pPr, context) {
-  return styleFor(pPr, context);
-}
-export {
-  NO_PARAGRAPH_FORMATTING,
-  effectiveParagraphFormat,
-  effectiveParagraphStyle
-};

package/dist/docx/propsXml.d.ts

@@ -1,49 +0,0 @@
-/**
- * Handles the XML fragments that carry formatting, such as `<w:rPr>`, `<w:pPr>`, and `<w:tcPr>`.
- *
- * A fragment is never rebuilt: only the one child a job names is sliced out and swapped, so the
- * rest (borders, shading, margins) stays as the original text wrote it. OOXML lays down the order
- * of the children, so the spot to insert a child that was not there is found by that same order.
- */
-export interface PropsChild {
-    /** The name with its namespace prefix stripped off (e.g. `gridSpan`) */
-    name: string;
-    /** This child's original XML fragment exactly as it was */
-    xml: string;
-}
-export interface Props {
-    /** The opening tag name exactly as written (e.g. `w:tcPr`) */
-    tag: string;
-    attrs: string | null;
-    children: PropsChild[];
-}
-/** The order the children are laid out in under `w:rPr` (CT_RPr) */
-export declare const RUN_PR_ORDER: readonly string[];
-/** The order the children are laid out in under `w:pPr` (CT_PPr) */
-export declare const P_PR_ORDER: readonly string[];
-/** The order the children are laid out in under `w:tcPr` (CT_TcPr) */
-export declare const TC_PR_ORDER: readonly string[];
-/** The conventional order of children under `w:trPr` (CT_TrPr). */
-export declare const TR_PR_ORDER: readonly string[];
-/** The order the children are laid out in under `w:tblPr` (CT_TblPr) */
-export declare const TBL_PR_ORDER: readonly string[];
-/**
- * Splits a formatting fragment into its opening tag and its list of children.
- * null if its shape cannot be made out (in which case leaving the original untouched is the safe move).
- */
-export declare function parseProps(xml: string): Props | null;
-/** With no children at all, the formatting fragment itself is not written */
-export declare function renderProps(props: Props): string;
-/**
- * Replaces a single child with new XML.
- * A null `xml` removes that child. A child that was not there goes into the spot the order calls for.
- */
-export declare function setPropsChild(children: PropsChild[], name: string, xml: string | null, order: readonly string[]): PropsChild[];
-export declare function propsChild(children: PropsChild[], name: string): PropsChild | undefined;
-/**
- * Reads a single formatting fragment into an element.
- *
- * A fragment carries no namespace declarations, so they are put back on as it is wrapped.
- * null if its shape cannot be made out, in which case the caller leaves the display values alone.
- */
-export declare function parsePropsXml(xml: string): Element | null;

package/dist/docx/propsXml.js

@@ -1,302 +0,0 @@
-// src/docx/propsXml.ts
-import { elementChildren, localPart, parseXml, W_NS } from "../ooxml/xml.js";
-var RUN_PR_ORDER = [
-  "rStyle",
-  "rFonts",
-  "b",
-  "bCs",
-  "i",
-  "iCs",
-  "caps",
-  "smallCaps",
-  "strike",
-  "dstrike",
-  "outline",
-  "shadow",
-  "emboss",
-  "imprint",
-  "noProof",
-  "snapToGrid",
-  "vanish",
-  "webHidden",
-  "color",
-  "spacing",
-  "w",
-  "kern",
-  "position",
-  "sz",
-  "szCs",
-  "highlight",
-  "u",
-  "effect",
-  "bdr",
-  "shd",
-  "fitText",
-  "vertAlign",
-  "rtl",
-  "cs",
-  "em",
-  "lang",
-  "eastAsianLayout",
-  "specVanish",
-  "oMath",
-  "rPrChange"
-];
-var P_PR_ORDER = [
-  "pStyle",
-  "keepNext",
-  "keepLines",
-  "pageBreakBefore",
-  "framePr",
-  "widowControl",
-  "numPr",
-  "suppressLineNumbers",
-  "pBdr",
-  "shd",
-  "tabs",
-  "suppressAutoHyphens",
-  "kinsoku",
-  "wordWrap",
-  "overflowPunct",
-  "topLinePunct",
-  "autoSpaceDE",
-  "autoSpaceDN",
-  "bidi",
-  "adjustRightInd",
-  "snapToGrid",
-  "spacing",
-  "ind",
-  "contextualSpacing",
-  "mirrorIndents",
-  "suppressOverlap",
-  "jc",
-  "textDirection",
-  "textAlignment",
-  "textboxTightWrap",
-  "outlineLvl",
-  "divId",
-  "cnfStyle",
-  "rPr",
-  "sectPr",
-  "pPrChange"
-];
-var TC_PR_ORDER = [
-  "cnfStyle",
-  "tcW",
-  "gridSpan",
-  "hMerge",
-  "vMerge",
-  "tcBorders",
-  "shd",
-  "noWrap",
-  "tcMar",
-  "textDirection",
-  "tcFitText",
-  "vAlign",
-  "hideMark",
-  "headers",
-  "cellIns",
-  "cellDel",
-  "cellMerge",
-  "tcPrChange"
-];
-var TR_PR_ORDER = [
-  "cnfStyle",
-  "divId",
-  "gridBefore",
-  "gridAfter",
-  "wBefore",
-  "wAfter",
-  "cantSplit",
-  "trHeight",
-  "tblHeader",
-  "tblCellSpacing",
-  "jc",
-  "hidden",
-  "ins",
-  "del",
-  "trPrChange"
-];
-var TBL_PR_ORDER = [
-  "tblStyle",
-  "tblpPr",
-  "tblOverlap",
-  "bidiVisual",
-  "tblStyleRowBandSize",
-  "tblStyleColBandSize",
-  "tblW",
-  "jc",
-  "tblCellSpacing",
-  "tblInd",
-  "tblBorders",
-  "shd",
-  "tblLayout",
-  "tblCellMar",
-  "tblLook",
-  "tblCaption",
-  "tblDescription",
-  "tblPrChange"
-];
-function skipPast(source, from, marker) {
-  const at = source.indexOf(marker, from);
-  return at === -1 ? -1 : at + marker.length;
-}
-function otherTag(end) {
-  return end === -1 ? null : { kind: "other", name: "", nameEnd: end, end };
-}
-function readTag(source, lt) {
-  if (source.startsWith("<?", lt)) return otherTag(skipPast(source, lt, "?>"));
-  if (source.startsWith("<!--", lt))
-    return otherTag(skipPast(source, lt, "-->"));
-  if (source.startsWith("<![CDATA[", lt))
-    return otherTag(skipPast(source, lt, "]]>"));
-  if (source.startsWith("<!", lt)) return otherTag(skipPast(source, lt, ">"));
-  const closing = source.startsWith("</", lt);
-  let i = lt + (closing ? 2 : 1);
-  const nameStart = i;
-  while (i < source.length && !" 	\r\n/>".includes(source[i])) i += 1;
-  const name = source.slice(nameStart, i);
-  if (!name) return null;
-  const nameEnd = i;
-  let quote = null;
-  while (i < source.length) {
-    const ch = source[i];
-    if (quote !== null) {
-      if (ch === quote) quote = null;
-    } else if (ch === '"' || ch === "'") {
-      quote = ch;
-    } else if (ch === ">") {
-      const selfClosing = source[i - 1] === "/";
-      const kind = closing ? "close" : selfClosing ? "empty" : "open";
-      return { kind, name, nameEnd, end: i + 1 };
-    }
-    i += 1;
-  }
-  return null;
-}
-function attrsOf(source, tag) {
-  const closeLength = tag.kind === "empty" ? 2 : 1;
-  const attrs = source.slice(tag.nameEnd, tag.end - closeLength).trim();
-  return attrs.length > 0 ? attrs : null;
-}
-function parseProps(xml) {
-  const open = readTag(xml, 0);
-  if (!open || xml[0] !== "<") return null;
-  const attrs = attrsOf(xml, open);
-  if (open.kind === "empty") {
-    return open.end === xml.length ? { tag: open.name, attrs, children: [] } : null;
-  }
-  if (open.kind !== "open") return null;
-  const children = [];
-  let depth = 0;
-  let childStart = -1;
-  let childName = "";
-  let i = open.end;
-  while (i < xml.length) {
-    const lt = xml.indexOf("<", i);
-    if (lt === -1) return null;
-    const tag = readTag(xml, lt);
-    if (!tag) return null;
-    if (tag.kind === "other") {
-      i = tag.end;
-      continue;
-    }
-    if (depth === 0) {
-      if (tag.kind === "close") {
-        if (tag.name !== open.name || tag.end !== xml.length) return null;
-        return { tag: open.name, attrs, children };
-      }
-      childStart = lt;
-      childName = tag.name;
-      if (tag.kind === "empty") {
-        children.push({
-          name: localPart(childName),
-          xml: xml.slice(childStart, tag.end)
-        });
-      } else {
-        depth = 1;
-      }
-    } else if (tag.kind === "open") {
-      depth += 1;
-    } else if (tag.kind === "close") {
-      depth -= 1;
-      if (depth === 0) {
-        children.push({
-          name: localPart(childName),
-          xml: xml.slice(childStart, tag.end)
-        });
-      }
-    }
-    i = tag.end;
-  }
-  return null;
-}
-function renderProps(props) {
-  if (props.children.length === 0) return "";
-  const open = props.attrs ? `<${props.tag} ${props.attrs}>` : `<${props.tag}>`;
-  return open + props.children.map((child) => child.xml).join("") + `</${props.tag}>`;
-}
-function insertIndex(children, name, order) {
-  const target = order.indexOf(name);
-  if (target === -1) return children.length;
-  let previous = -1;
-  for (const [index, child] of children.entries()) {
-    const known = order.indexOf(child.name);
-    const effective = known === -1 ? previous : known;
-    if (effective > target) return index;
-    previous = effective;
-  }
-  return children.length;
-}
-function setPropsChild(children, name, xml, order) {
-  const without = children.filter((child2) => child2.name !== name);
-  if (xml === null) return without;
-  const child = { name, xml };
-  const at = children.findIndex((entry) => entry.name === name);
-  if (at === -1) {
-    const index = insertIndex(without, name, order);
-    return [...without.slice(0, index), child, ...without.slice(index)];
-  }
-  return [
-    ...children.slice(0, at),
-    child,
-    ...children.slice(at + 1).filter((entry) => entry.name !== name)
-  ];
-}
-function propsChild(children, name) {
-  return children.find((child) => child.name === name);
-}
-function namespaceDecls(xml) {
-  const prefixes = /* @__PURE__ */ new Set(["w"]);
-  for (const [, prefix] of xml.matchAll(/<\/?([A-Za-z_][\w.-]*):/g)) {
-    prefixes.add(prefix);
-  }
-  for (const [, prefix] of xml.matchAll(/[\s"']([A-Za-z_][\w.-]*):[\w.-]+=/g)) {
-    prefixes.add(prefix);
-  }
-  prefixes.delete("xml");
-  prefixes.delete("xmlns");
-  return Array.from(prefixes).map(
-    (prefix) => `xmlns:${prefix}="${prefix === "w" ? W_NS : `urn:docx-editor:${prefix}`}"`
-  ).join(" ");
-}
-function parsePropsXml(xml) {
-  try {
-    const wrapped = `<props ${namespaceDecls(xml)}>${xml}</props>`;
-    return elementChildren(parseXml(wrapped).documentElement)[0] ?? null;
-  } catch {
-    return null;
-  }
-}
-export {
-  P_PR_ORDER,
-  RUN_PR_ORDER,
-  TBL_PR_ORDER,
-  TC_PR_ORDER,
-  TR_PR_ORDER,
-  parseProps,
-  parsePropsXml,
-  propsChild,
-  renderProps,
-  setPropsChild
-};

package/dist/docx/uniqueControls.d.ts

@@ -1,14 +0,0 @@
-/**
- * Keeping one content control from going out twice under the same name.
- *
- * A control cannot cross a paragraph, so splitting a paragraph in the middle of one leaves that
- * same control standing in two, and dropping unmarked text into the middle of one breaks it in
- * two within the paragraph. Each piece then writes a `w:sdt` of its own (see `docx/sdt` for what
- * a copy must not carry along).
- *
- * A document nobody broke apart comes back node for node as it was, which is what keeps an
- * unedited block going out as its original XML.
- */
-import { type Node as PMNode } from "prosemirror-model";
-/** The document with every copy of a control opening under a name of its own */
-export declare function withUniqueControls(doc: PMNode): PMNode;

package/dist/docx/uniqueControls.js

@@ -1,62 +0,0 @@
-// src/docx/uniqueControls.ts
-import { Fragment } from "prosemirror-model";
-import { docxSchema } from "../schema/index.js";
-import { copiedControlPrefix, newControlId } from "./sdt.js";
-function sdtMarkOf(node) {
-  return node.marks.find((mark) => mark.type === docxSchema.marks.sdt) ?? null;
-}
-function controlName(mark) {
-  const key = mark.attrs.sdtKey;
-  const prefix = mark.attrs.sdtPrefix;
-  return `${typeof key === "number" ? key : 0} ${typeof prefix === "string" ? prefix : ""}`;
-}
-function copiedMark(mark) {
-  const prefix = mark.attrs.sdtPrefix;
-  if (typeof prefix !== "string") return mark;
-  return mark.type.create({
-    ...mark.attrs,
-    sdtPrefix: copiedControlPrefix(prefix, newControlId())
-  });
-}
-function claim(mark, written) {
-  const name = controlName(mark);
-  const copy = written.has(name) ? copiedMark(mark) : null;
-  written.add(name);
-  return { mark, copy };
-}
-function rewriteParagraph(paragraph, written) {
-  const inline = [];
-  let running = null;
-  let renamed = false;
-  paragraph.forEach((child) => {
-    const mark = sdtMarkOf(child);
-    if (!mark) {
-      running = null;
-      inline.push(child);
-      return;
-    }
-    const control = running?.mark.eq(mark) ? running : claim(mark, written);
-    running = control;
-    if (!control.copy) {
-      inline.push(child);
-      return;
-    }
-    renamed = true;
-    inline.push(
-      child.mark(control.copy.addToSet(mark.removeFromSet(child.marks)))
-    );
-  });
-  return renamed ? paragraph.copy(Fragment.fromArray(inline)) : paragraph;
-}
-function rewriteBlock(node, written) {
-  if (node.type.name === "paragraph") return rewriteParagraph(node, written);
-  if (node.childCount === 0) return node;
-  const children = node.children.map((child) => rewriteBlock(child, written));
-  return children.every((child, index) => child === node.child(index)) ? node : node.copy(Fragment.fromArray(children));
-}
-function withUniqueControls(doc) {
-  return rewriteBlock(doc, /* @__PURE__ */ new Set());
-}
-export {
-  withUniqueControls
-};

package/dist/editor/plugins/bookmarkProtection.d.ts

@@ -1,3 +0,0 @@
-/** Prevents ordinary editor transactions from dropping imported bookmark range markers. */
-import { Plugin } from "prosemirror-state";
-export declare function bookmarkProtection(): Plugin;

package/dist/editor/plugins/bookmarkProtection.js

@@ -1,28 +0,0 @@
-// src/editor/plugins/bookmarkProtection.ts
-import { Plugin } from "prosemirror-state";
-var BOOKMARK_XML = /<(?:[\w.-]+:)?bookmark(?:Start|End)\b/;
-function signatures(doc) {
-  const found = [];
-  doc.descendants((node) => {
-    if (node.type.name === "bookmarkBlock") {
-      found.push(`block:${node.attrs.srcId}:${node.attrs.name}`);
-    } else if (node.type.name === "rawInline" && typeof node.attrs.xml === "string" && BOOKMARK_XML.test(node.attrs.xml)) {
-      found.push(`inline:${node.attrs.xml}`);
-    }
-    return true;
-  });
-  return found;
-}
-function same(a, b) {
-  return a.length === b.length && a.every((value, index) => value === b[index]);
-}
-function bookmarkProtection() {
-  return new Plugin({
-    filterTransaction(transaction, state) {
-      return !transaction.docChanged || same(signatures(state.doc), signatures(transaction.doc));
-    }
-  });
-}
-export {
-  bookmarkProtection
-};

package/dist/editor/plugins/commentReservations.d.ts

@@ -1,5 +0,0 @@
-/** Keeps identifiers from the opened Comments parts reserved for the lifetime of the editor state. */
-import { type EditorState, Plugin } from "prosemirror-state";
-export declare function commentReservations(ids: Iterable<string>, paraIds: Iterable<string>): Plugin;
-export declare function reservedCommentIds(state: EditorState): ReadonlySet<string>;
-export declare function reservedCommentParaIds(state: EditorState): ReadonlySet<string>;

package/dist/editor/plugins/commentReservations.js

@@ -1,26 +0,0 @@
-// src/editor/plugins/commentReservations.ts
-import { Plugin, PluginKey } from "prosemirror-state";
-var commentReservationsKey = new PluginKey(
-  "docxCommentReservations"
-);
-function commentReservations(ids, paraIds) {
-  const reserved = { ids: new Set(ids), paraIds: new Set(paraIds) };
-  return new Plugin({
-    key: commentReservationsKey,
-    state: {
-      init: () => reserved,
-      apply: (_transaction, value) => value
-    }
-  });
-}
-function reservedCommentIds(state) {
-  return commentReservationsKey.getState(state)?.ids ?? /* @__PURE__ */ new Set();
-}
-function reservedCommentParaIds(state) {
-  return commentReservationsKey.getState(state)?.paraIds ?? /* @__PURE__ */ new Set();
-}
-export {
-  commentReservations,
-  reservedCommentIds,
-  reservedCommentParaIds
-};

package/dist/editor/plugins/noteProtection.d.ts

@@ -1,3 +0,0 @@
-/** Keeps imported footnote and endnote references intact while their bodies are display-only. */
-import { Plugin } from "prosemirror-state";
-export declare function noteProtection(): Plugin;

package/dist/editor/plugins/noteProtection.js

@@ -1,25 +0,0 @@
-// src/editor/plugins/noteProtection.ts
-import { Plugin } from "prosemirror-state";
-function signatures(doc) {
-  const found = [];
-  doc.descendants((node) => {
-    if (node.type.name === "noteReference") {
-      found.push(JSON.stringify(node.attrs));
-    }
-    return true;
-  });
-  return found;
-}
-function same(a, b) {
-  return a.length === b.length && a.every((value, index) => value === b[index]);
-}
-function noteProtection() {
-  return new Plugin({
-    filterTransaction(transaction, state) {
-      return !transaction.docChanged || same(signatures(state.doc), signatures(transaction.doc));
-    }
-  });
-}
-export {
-  noteProtection
-};

package/dist/editor/plugins/styledParagraphs.d.ts

@@ -1,15 +0,0 @@
-/**
- * Applies inherited style display values to paragraphs created in the editor. The paragraph under
- * active IME composition is deferred to avoid redrawing and canceling the composition.
- */
-import { Plugin } from "prosemirror-state";
-/**
- * Reads the document's styles into the paragraphs an edit built.
- *
- * No transaction of its own goes to the history: ProseMirror hands an appended transaction to the
- * history as part of the same event, so a single undo takes the edit and these values back together.
- *
- * An appended transaction is handed nothing but states, so the view an open composition is read
- * from is the one the plugin is given when it mounts.
- */
-export declare function styledParagraphs(): Plugin;

package/dist/editor/plugins/styledParagraphs.js

@@ -1,65 +0,0 @@
-// src/editor/plugins/styledParagraphs.ts
-import { Plugin } from "prosemirror-state";
-import {
-  effectiveParagraphFormat,
-  effectiveParagraphStyle,
-  layerRunFormat
-} from "../../docx/formatting.js";
-import { docxSchema } from "../../schema/index.js";
-import { documentParagraphFormatting } from "../documentStyles.js";
-function needsFormatting(node) {
-  return node.attrs.format === null && node.attrs.styleRun === null;
-}
-function paragraphSpots(doc) {
-  const found = [];
-  doc.descendants((node, pos) => {
-    if (node.type !== docxSchema.nodes.paragraph) return true;
-    if (needsFormatting(node)) found.push({ pos, node });
-    return false;
-  });
-  return found;
-}
-function styledAttrs(node, state) {
-  const context = documentParagraphFormatting(state);
-  const style = effectiveParagraphStyle(node.attrs.pPr, context);
-  const format = effectiveParagraphFormat(node.attrs.pPr, context);
-  const styleRun = style ? layerRunFormat(style.run, null) : null;
-  return { ...node.attrs, format, styleRun };
-}
-function composingAt(view, state) {
-  return view?.composing === true ? state.selection.from : null;
-}
-function holdsComposition(paragraph, composing) {
-  return composing !== null && composing >= paragraph.pos && composing <= paragraph.pos + paragraph.node.nodeSize;
-}
-function styledParagraphs() {
-  let live = null;
-  return new Plugin({
-    view(view) {
-      live = view;
-      return {
-        destroy() {
-          live = null;
-        }
-      };
-    },
-    appendTransaction(transactions, _oldState, newState) {
-      if (!transactions.some((transaction) => transaction.docChanged)) {
-        return null;
-      }
-      const composing = composingAt(live, newState);
-      const tr = newState.tr;
-      for (const paragraph of paragraphSpots(newState.doc)) {
-        if (holdsComposition(paragraph, composing)) continue;
-        const attrs = styledAttrs(paragraph.node, newState);
-        if (!paragraph.node.hasMarkup(paragraph.node.type, attrs)) {
-          tr.setNodeMarkup(paragraph.pos, null, attrs);
-        }
-      }
-      return tr.docChanged ? tr : null;
-    }
-  });
-}
-export {
-  styledParagraphs
-};