@docen/docx 0.3.3 → 0.3.4

package/dist/index.mjs

@@ -1,6 +1,21 @@
-import { _ as PageBreak, a as DocxKit, c as tiptapMarkExtensions, l as tiptapNodeExtensions, s as docxExtensions } from "./core-B8ba_FNi.mjs";
+import { Blockquote, Bold, Code, CodeBlockLowlight, Details, DetailsContent, DetailsSummary, Emoji, HardBreak, Highlight, HorizontalRule, Italic, ListItem, Mathematics, Mention, Subscript, Superscript, TaskItem, TaskList, Text, TextAlign, Underline } from "./extensions/tiptap.mjs";
+import { BulletList } from "./extensions/bullet-list.mjs";
+import { CodeBlock } from "./extensions/code-block.mjs";
+import { C as ColumnBreak, S as FormattingMarks, _ as Tab, a as DocxKit, b as Passthrough, c as tiptapNodeExtensions, g as TocField, h as wpsShapeStyles, l as WpsShape, o as docxExtensions, s as tiptapMarkExtensions, u as WpgGroup, v as SectionBreak, x as PageBreak, y as InlinePassthrough } from "./core-BnF8XhVE.mjs";
 import { resolveFontName, resolvePageSize, sectionLinePitchCss, sectionMarginCss, twipsToMm } from "./extensions/utils.mjs";
 import { Document, createDocument } from "./extensions/document.mjs";
+import { Heading } from "./extensions/heading.mjs";
+import { Image } from "./extensions/image.mjs";
+import { scrollCaretToTop, scrollContainerOf } from "./extensions/scroll.mjs";
+import { Link } from "./extensions/link.mjs";
+import { OrderedList } from "./extensions/ordered-list.mjs";
+import { Paragraph } from "./extensions/paragraph.mjs";
+import { Strike } from "./extensions/strike.mjs";
+import { Table } from "./extensions/table.mjs";
+import { TableCell } from "./extensions/table-cell.mjs";
+import { TableHeader } from "./extensions/table-header.mjs";
+import { TableRow } from "./extensions/table-row.mjs";
+import { TextStyle } from "./extensions/text-style.mjs";
 import { createDocxEditor } from "./editor.mjs";
 import { fetchImageHandler, prepareDocument, prepareImages } from "./converters/prepare.mjs";
 import { effectiveRunProps, inlineStyles, quickStyles, stylesToCss } from "./converters/styles.mjs";
@@ -10,4 +25,4 @@ import { generateHTML, parseHTML } from "./converters/html.mjs";
 import { generateMarkdown, parseMarkdown } from "./converters/markdown.mjs";
 import { sectionMarginDefaults, sectionPageSizeDefaults } from "@office-open/docx";
 import { convertMillimetersToTwip } from "@office-open/core";
-export { Document, DocxKit, DocxManager, PageBreak, compileDocument, convertMillimetersToTwip, createDocument, createDocxEditor, docxExtensions, effectiveRunProps, fetchImageHandler, generateDOCX, generateDOCXStream, generateDOCXSync, generateHTML, generateMarkdown, inlineStyles, parseDOCX, parseHTML, parseMarkdown, patchDOCX, prepareDocument, prepareImages, quickStyles, resolveDocument, resolveFontName, resolvePageSize, sectionLinePitchCss, sectionMarginCss, sectionMarginDefaults, sectionPageSizeDefaults, stylesToCss, tiptapMarkExtensions, tiptapNodeExtensions, twipsToMm };
+export { Blockquote, Bold, BulletList, Code, CodeBlock, CodeBlockLowlight, ColumnBreak, Details, DetailsContent, DetailsSummary, Document, DocxKit, DocxManager, Emoji, FormattingMarks, HardBreak, Heading, Highlight, HorizontalRule, Image, InlinePassthrough, Italic, Link, ListItem, Mathematics, Mention, OrderedList, PageBreak, Paragraph, Passthrough, SectionBreak, Strike, Subscript, Superscript, Tab, Table, TableCell, TableHeader, TableRow, TaskItem, TaskList, Text, TextAlign, TextStyle, TocField, Underline, WpgGroup, WpsShape, compileDocument, convertMillimetersToTwip, createDocument, createDocxEditor, docxExtensions, effectiveRunProps, fetchImageHandler, generateDOCX, generateDOCXStream, generateDOCXSync, generateHTML, generateMarkdown, inlineStyles, parseDOCX, parseHTML, parseMarkdown, patchDOCX, prepareDocument, prepareImages, quickStyles, resolveDocument, resolveFontName, resolvePageSize, scrollCaretToTop, scrollContainerOf, sectionLinePitchCss, sectionMarginCss, sectionMarginDefaults, sectionPageSizeDefaults, stylesToCss, tiptapMarkExtensions, tiptapNodeExtensions, twipsToMm, wpsShapeStyles };

package/dist/link-BawPjQZR.d.mts

@@ -0,0 +1,6 @@
+import { LinkOptions } from "@tiptap/extension-link";
+
+//#region src/extensions/link.d.ts
+declare const Link$1: import("@tiptap/core").Mark<LinkOptions, any>;
+//#endregion
+export { Link$1 as t };

package/dist/mention-BGLzLVYw.d.mts

@@ -0,0 +1,23 @@
+//#region src/extensions/mention.d.ts
+/**
+ * Mention extension — owns the DOCX expression of an inline mention.
+ *
+ * A mention is an atom node carrying `{ id, label }`. DOCX has no mention
+ * element, but an inline text-SDT (CT_SdtRun) is a reversible carrier: the
+ * `id` rides in the SDT alias, the `label` as the SDT's run text, and a fixed
+ * tag marks the type so resolve can recover the mention. (customXml would also
+ * carry the id but triggers Word's i4i patent warning; SDT does not.)
+ */
+/** SDT tag marking a mention content control. */
+declare const MENTION_TAG = "docen-mention";
+/** Inline text-SDT carrying a mention (id in alias, label as run text). */
+declare function createMention(id: string, label: string): Record<string, unknown>;
+/** True if an inline SDT child carries a mention. */
+declare function isMention(child: unknown): boolean;
+/** Read a mention SDT → `{ id, label }`. */
+declare function readMention(child: unknown): {
+  id: string;
+  label: string;
+};
+//#endregion
+export { readMention as i, createMention as n, isMention as r, MENTION_TAG as t };

package/dist/ordered-list-DFAe-YEV.d.mts

@@ -0,0 +1,25 @@
+import { LevelsOptions } from "@office-open/docx";
+
+//#region src/extensions/ordered-list.d.ts
+/**
+ * OrderedList extension — owns the DOCX expression of an ordered list.
+ *
+ * A Tiptap orderedList maps to a sequence of paragraphs referencing one
+ * abstractNum (decimal). The reference is keyed by `start` so lists with the
+ * same start share a definition; DocxManager gives each list its own instance
+ * for independent counting. This module owns that abstractNum shape; DocxManager
+ * owns the cross-paragraph tree walk, start recovery, and numbering-instance
+ * bookkeeping.
+ */
+/** Reference prefix for generated ordered-list abstractNum definitions. */
+declare const ORDERED_REFERENCE_PREFIX = "docen-ordered";
+/** lvlText per nesting depth (level 0 → "%1.", … level 8 → "%9."). */
+declare const ORDERED_LEVEL_TEXT: string[];
+/**
+ * Build nine decimal numbering levels for an ordered list. Level 0 carries
+ * `start`; deeper levels restart at 1 (Word convention).
+ */
+declare function buildOrderedLevels(start: number): LevelsOptions[];
+declare const OrderedList: import("@tiptap/core").Node<import("@tiptap/extension-ordered-list").OrderedListOptions, any>;
+//#endregion
+export { buildOrderedLevels as i, ORDERED_REFERENCE_PREFIX as n, OrderedList as r, ORDERED_LEVEL_TEXT as t };

package/dist/scroll-ZNeThJsJ.d.mts

@@ -0,0 +1,18 @@
+import { EditorView } from "@tiptap/pm/view";
+
+//#region src/extensions/scroll.d.ts
+/**
+ * Scroll helpers shared by the editor and the docx engine's link-click handler,
+ * so every "jump then scroll" path (outline heading, search result, find, TOC
+ * Ctrl+Click, post-reflow caret follow) scrolls the SAME way — to the top of the
+ * viewport, Word-style. ProseMirror's default `tr.scrollIntoView()` parks the
+ * caret at the bottom edge, which reads wrong for a page/heading/TOC jump.
+ */
+/** Nearest scrollable ancestor of the editor surface (e.g. the docen-canvas). */
+declare function scrollContainerOf(view: EditorView): HTMLElement | null;
+/** Scroll the caret to the TOP of the viewport when it has left the visible area
+ *  (Word-style page follow). No-op while the caret stays in view, so normal
+ *  typing doesn't fight the user's scroll. Replaces PM's default scrollIntoView. */
+declare function scrollCaretToTop(view: EditorView): void;
+//#endregion
+export { scrollContainerOf as n, scrollCaretToTop as t };

package/dist/task-item-B0ntvQ1Y.d.mts

@@ -0,0 +1,25 @@
+//#region src/extensions/task-item.d.ts
+/**
+ * TaskItem extension — owns the DOCX expression of a task-list checkbox.
+ *
+ * DOCX has no native task list, but a clickable checkbox is reversible via an
+ * inline content-control SDT (w14:checkbox). Each task paragraph carries a
+ * leading checkbox SDT tagged "docen-task" so resolve can tell task items apart
+ * from ordinary paragraphs that happen to contain an SDT. The checked state
+ * round-trips through the SDT; DocxManager injects/strips the SDT at the
+ * paragraph boundary and rebuilds the taskList/taskItem tree.
+ */
+/** SDT tag marking our task-item checkbox content control. */
+declare const TASK_CHECKBOX_TAG = "docen-task";
+/**
+ * Inline checkbox SDT (w14:checkbox) for a task item, as a ParagraphChild.
+ * Tagged so resolve can distinguish task items from ordinary SDT-bearing
+ * paragraphs.
+ */
+declare function createTaskCheckbox(checked: boolean): Record<string, unknown>;
+/** True if an inline ParagraphChild is our task checkbox SDT. */
+declare function isTaskCheckbox(child: unknown): boolean;
+/** Read the checked state of a task checkbox SDT child (false if not one). */
+declare function readCheckboxState(child: unknown): boolean;
+//#endregion
+export { readCheckboxState as i, createTaskCheckbox as n, isTaskCheckbox as r, TASK_CHECKBOX_TAG as t };

package/dist/{tiptap-pZsNPsvV.d.mts → tiptap-BKqn41uT.d.mts}

@@ -22,10 +22,10 @@ import { Italic } from "@tiptap/extension-italic";
 import { Underline } from "@tiptap/extension-underline";
 import { Strike } from "@tiptap/extension-strike";
 import { Code } from "@tiptap/extension-code";
-import { Link } from "@tiptap/extension-link";
+import { Link as Link$1 } from "@tiptap/extension-link";
 import { Highlight } from "@tiptap/extension-highlight";
 import { Subscript } from "@tiptap/extension-subscript";
 import { Superscript } from "@tiptap/extension-superscript";
 import { TextStyle } from "@tiptap/extension-text-style";
 import { TextAlign } from "@tiptap/extension-text-align";
-export { TaskItem as A, Strike as C, TableCell as D, Table as E, Underline as F, Text as M, TextAlign as N, TableHeader as O, TextStyle as P, Paragraph as S, Superscript as T, Link as _, CodeBlockLowlight as a, Mention as b, DetailsSummary as c, HardBreak as d, Heading as f, Italic as g, Image as h, Code as i, TaskList as j, TableRow as k, Document as l, HorizontalRule as m, Bold as n, Details as o, Highlight as p, BulletList as r, DetailsContent as s, Blockquote as t, Emoji as u, ListItem as v, Subscript as w, OrderedList as x, Mathematics as y };
+export { TaskItem as A, Strike as C, TableCell as D, Table as E, Underline as F, Text as M, TextAlign as N, TableHeader as O, TextStyle as P, Paragraph as S, Superscript as T, Link$1 as _, CodeBlockLowlight as a, Mention as b, DetailsSummary as c, HardBreak as d, Heading as f, Italic as g, Image as h, Code as i, TaskList as j, TableRow as k, Document as l, HorizontalRule as m, Bold as n, Details as o, Highlight as p, BulletList as r, DetailsContent as s, Blockquote as t, Emoji as u, ListItem as v, Subscript as w, OrderedList as x, Mathematics as y };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docen/docx",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "DOCX editor and converter powered by @office-open/docx with Tiptap editing layer, supporting bidirectional conversion between DOCX, HTML, and Markdown",
   "keywords": [
     "converter",
@@ -59,8 +59,8 @@
     }
   },
   "dependencies": {
-    "@office-open/core": "0.10.9",
-    "@office-open/docx": "0.10.9",
+    "@office-open/core": "0.10.11",
+    "@office-open/docx": "0.10.11",
     "@tiptap/core": "3.27.1",
     "@tiptap/extension-blockquote": "3.27.1",
     "@tiptap/extension-bold": "3.27.1",

package/dist/core-DRaLI8nd.d.mts

@@ -1,203 +0,0 @@
-import { AnyExtension, Editor, Extension, Extensions, JSONContent as JSONContent$1, Mark, Node } from "@tiptap/core";
-import { TextAlign } from "@tiptap/extension-text-align";
-
-//#region src/extensions/image.d.ts
-type CropRect = {
-  left?: number;
-  top?: number;
-  right?: number;
-  bottom?: number;
-};
-/**
- * Tiptap JSON image node → CoreImageOptions-shaped object.
- *
- * Returns `{ image: ImageOptions }` (structural wrapper) or null when no
- * embedded image data is available (external URLs need pre-fetching).
- * rotation is carried via transformation.rotation (not dropped).
- */
-declare function renderDocx(node: JSONContent$1): Record<string, unknown> | null;
-/**
- * ImageOptions-shaped object → Tiptap attrs.
- *
- * Near-identity unpack: transformation → width/height/rotation, altText → alt/title,
- * floating/srcRect(→crop)/outline passed through verbatim. src is reconstructed by
- * DocxManager from the image data bytes (kept out of parseDocx).
- */
-declare function parseDocx(imageOpts: Record<string, unknown>): Record<string, unknown>;
-/** Extent-box dimensions needed to size the inner <img> for a cropped image. */
-interface CropRenderContext {
-  width?: number;
-  height?: number;
-}
-/**
- * Render crop as the inner <img> style for byte-accurate four-sided srcRect.
- *
- * object-fit:cover scales uniformly, so it only matches single-axis crops.
- * Instead the inner <img> is sized to the un-cropped display size per axis
- * (imgW = W/visibleW, imgH = H/visibleH) and translated so the visible srcRect
- * region maps exactly onto the extent box; the outer box clips (overflow:hidden)
- * the cropped-out left/top region. Mathematically equivalent to a
- * background-size/background-position crop, but keeps a real <img> (alt,
- * accessibility, semantics, drag-to-save).
- */
-declare function renderCropAttrs(crop: Record<string, unknown> | CropRect, ctx?: CropRenderContext): {
-  style: string;
-};
-declare const Image: import("@tiptap/core").Node<import("@tiptap/extension-image").ImageOptions, any>;
-//#endregion
-//#region src/extensions/wpg-group.d.ts
-interface FillColor {
-  value?: string;
-}
-interface Fill {
-  type?: string;
-  color?: FillColor;
-}
-interface Outline {
-  type?: string;
-  color?: FillColor;
-  width?: number;
-  dash?: string;
-}
-/** wps shape data (WpsShapeCoreOptions subset used for rendering). */
-interface WpsBodyProperties {
-  rotation?: number;
-  lIns?: number;
-  tIns?: number;
-  rIns?: number;
-  bIns?: number;
-  vert?: string;
-}
-interface WpsData {
-  fill?: Fill;
-  outline?: Outline;
-  bodyProperties?: WpsBodyProperties & Record<string, unknown>;
-  children?: unknown[];
-}
-type Spec = ReadonlyArray<unknown>;
-/** wps text-body paragraphs (office-open ParagraphOptions[]) → inline HTML runs
- *  so a text-box shape shows its text. Each paragraph's run defaults merge with
- *  each text run; renderRunStyles converts font/color/size/… to CSS. Advanced run
- *  props (shadow w14RawXml, kern) are carried in attrs but not rendered. */
-declare function renderWpsText(children: unknown): Spec[];
-/**
- * Render a wps shape's interior (fill/outline/insets/rotation/writing-mode + text
- * body) as a positioned div. Shared by the wpg group's inline wps children and
- * the standalone wpsShape node, so a text-box shape renders identically whether
- * it floats alone (wp:anchor > wps:wsp) or sits inside a group. `positionStyle`
- * carries the placement — absolute group coords for a group child, the floating
- * anchor CSS for a standalone shape. `opts.rotation` overrides bodyPr rotation
- * (a group child's rotation may come from the group transform, not bodyPr).
- */
-declare function renderWpsInterior(data: WpsData, positionStyle: string, opts?: {
-  rotation?: number;
-  attrs?: Record<string, string>;
-}): Spec;
-declare const WpgGroup: Node<any, any>;
-//#endregion
-//#region src/extensions/wps-shape.d.ts
-declare const WpsShape: Node<any, any>;
-//#endregion
-//#region src/extensions/passthrough.d.ts
-/**
- * Passthrough — block atom carrying an opaque {@link SectionChild} that has
- * no native Tiptap representation (rawXml, bookmarkStart/End, textbox,
- * altChunk, subDoc, customXml).
- *
- * The full SectionChild is stored as JSON in `attrs.data` so the DOCX→JSON→DOCX
- * round-trip stays byte-faithful: office-open's stringify handles the inner
- * structure verbatim (including a textbox's nested children, which remain as
- * structured ParagraphOptions inside the blob rather than editable Tiptap
- * nodes). The node is not editable — it renders a read-only placeholder in HTML.
- *
- * DOCX serialization is inlined in DocxManager (compile/resolve read/write
- * `attrs.data` directly), so no renderDocx/parseDocx is needed here.
- */
-declare const Passthrough: Node<any, any>;
-//#endregion
-//#region src/extensions/toc-field.d.ts
-/**
- * TOC field (`tocField`) — a block container representing a DOCX table of
- * contents, with the rendered entries as editable `content` and the TOC field
- * switches on `attrs.options`.
- *
- * Named `tocField` (not `tableOfContents`) to avoid colliding with the official
- * `@tiptap/extension-table-of-contents`, which is an `Extension` (a live outline
- * generator injected into the editor) that already owns the `tableOfContents`
- * name. Same-name extensions dedupe in Tiptap, and since the official one is not
- * a node it would erase this node type from the schema. The two coexist for
- * different purposes: this node persists a DOCX's rendered TOC; the official
- * extension drives the heading-outline pane.
- *
- * Structuring the TOC as a node (instead of opaque passthrough) is what fixes
- * the export crash. Each entry paragraph's `w:hyperlink` wraps a HYPERLINK field
- * whose content-less runs (fldChar begin/separate/end) office-open parses as
- * `null`. As opaque passthrough those nulls survived verbatim to
- * `generateDocument`, where office-open's `stringifyRunInline(null).break`
- * crashed. Resolving the entries through `resolveParagraphChildren` drops the
- * nulls (the existing `child !== null` guard), so compile rebuilds clean entries
- * and the generate path never sees a null — no office-open change required.
- *
- * DOCX serialization is inlined in DocxManager (resolve/compile read/write
- * `attrs.options` + the entry content directly), so no renderDocx/parseDocx is
- * needed here — the same pattern as the details extension.
- */
-declare const TocField: Node<any, any>;
-//#endregion
-//#region src/extensions/extensions.d.ts
-declare const tiptapNodeExtensions: AnyExtension[];
-declare const tiptapMarkExtensions: AnyExtension[];
-declare const docxExtensions: AnyExtension[];
-interface DocxKitOptions {
-  bold?: Record<string, any> | false;
-  blockquote?: Record<string, any> | false;
-  bulletList?: Record<string, any> | false;
-  code?: Record<string, any> | false;
-  codeBlock?: Record<string, any> | false;
-  document?: false;
-  hardBreak?: Record<string, any> | false;
-  heading?: Record<string, any> | false;
-  horizontalRule?: Record<string, any> | false;
-  italic?: Record<string, any> | false;
-  listItem?: Record<string, any> | false;
-  link?: Record<string, any> | false;
-  orderedList?: Record<string, any> | false;
-  paragraph?: Record<string, any> | false;
-  strike?: Record<string, any> | false;
-  text?: false;
-  underline?: Record<string, any> | false;
-}
-declare const DocxKit: Extension<DocxKitOptions, any>;
-//#endregion
-//#region src/extensions/page-break.d.ts
-/**
- * PageBreak — inline atom node for DOCX page breaks (`<w:br w:type="page"/>`).
- *
- * OOXML page breaks live inside a run (inline), so the Tiptap node is inline
- * too (group "inline"). This keeps a break inside its paragraph on round-trip
- * — a break mid-paragraph stays mid-paragraph instead of splitting the
- * paragraph into separate blocks (which would lose the original structure).
- * Sibling to HardBreak: both render `<w:br>`, differing only by type.
- *
- * The DOCX payload (`{ pageBreak: true }`) is inlined in DocxManager — a
- * one-liner with no per-node variance, so no extension helper for it.
- *
- * Inserting a page break must also visually reflow (the C-route paginator only
- * forces a new page after a block *containing* a pageBreak atom). So
- * `setPageBreak` inserts the atom then splits the paragraph — the atom lands at
- * the end of the first half, the trailing text becomes a fresh paragraph, and
- * the paginator's `forcesPageBreakAfter` moves it to the next page (matching
- * Word's Ctrl+Enter behavior).
- */
-declare const PageBreak: Node<any, any>;
-declare module "@tiptap/core" {
-  interface Commands<ReturnType> {
-    pageBreak: {
-      /** Insert a page break at the cursor and split the paragraph so the
-       *  trailing content reflows to the next page. */
-      setPageBreak: () => ReturnType;
-    };
-  }
-}
-//#endregion
-export { Image as C, renderDocx as E, CropRenderContext as S, renderCropAttrs as T, WpsShape as _, JSONContent$1 as a, renderWpsInterior as b, PageBreak as c, TextAlign as d, docxExtensions as f, Passthrough as g, TocField as h, Extensions as i, DocxKit as l, tiptapNodeExtensions as m, Editor as n, Mark as o, tiptapMarkExtensions as p, Extension as r, Node as s, AnyExtension as t, DocxKitOptions as u, WpgGroup as v, parseDocx as w, renderWpsText as x, WpsData as y };