ooxml-ui 1.12.3 → 1.14.0

package/dist/docx/print-float-selection.d.ts

@@ -0,0 +1,24 @@
+import type { EditorView } from 'prosemirror-view';
+export { locateFloat, selectedFloat } from './print-float-locate.js';
+export interface PrintFloatHost {
+    /** The `.dve-print-pages` element. */
+    pages: HTMLElement;
+    /** The editing surface whose keys a selected float takes over. */
+    paper: HTMLElement;
+    view(): EditorView | undefined;
+    printActive(): boolean;
+}
+export interface PrintFloats {
+    /** Redraws the selection frame; call after transactions and layouts. */
+    refresh(): void;
+    destroy(): void;
+}
+/**
+ * Floating pictures, shapes and text boxes on Print Layout pages are selectable like in Word: a press selects the object
+ * (the same node selection the Draft surface uses) and draws a frame with eight handles; dragging
+ * moves it, corner handles resize it (keeping the aspect ratio for pictures; a second press on a shape
+ * that holds text, or a double-click on any shape, edits its text in place), arrow keys nudge it and Delete
+ * removes it. Each gesture is one transaction, so it is one undo step. Pictures behind the text
+ * are only taken where no text is, so a press on text still places the caret.
+ */
+export declare function attachPrintFloatSelection(host: PrintFloatHost): PrintFloats;

package/dist/docx/print-float-text.d.ts

@@ -0,0 +1,8 @@
+import type { EditorView } from 'prosemirror-view';
+/**
+ * Edits the text of a floating shape or text box in place on its page: a textarea laid over the
+ * shape, one paragraph per line. Enter adds a line, Escape cancels, Ctrl+Enter or leaving the
+ * field applies it as one transaction (one undo step). Returns a function that applies and closes the editor
+ * ; undefined when the shape's text cannot be edited.
+ */
+export declare function editShapeText(view: EditorView, element: HTMLElement, lines: string[], onClose: () => void): (() => void) | undefined;

package/dist/docx/print-keyboard-navigation.d.ts

@@ -1,18 +1,19 @@
 import type { EditorView } from 'prosemirror-view';
 import type { PrintEditingIndex } from './print-editing-index.js';
+import { type CaretAffinity } from './print-caret-affinity.js';
 interface Options {
     active(): boolean;
     getView(): EditorView | undefined;
     index: PrintEditingIndex;
     position(id: string, offset: number): number | undefined;
-    select(id: string, offset: number, extend?: boolean): boolean;
+    select(id: string, offset: number, extend?: boolean, affinity?: CaretAffinity): boolean;
     resolveHit(target: Element, x: number): {
         blockId: string;
         offset: number;
     } | null;
     scrollContainer: HTMLElement;
-    preferredPage(): string | undefined;
-    setPreferredPage(page: string | undefined): void;
+    /** Affinity of the current caret. */
+    affinity(): CaretAffinity;
 }
 export declare function printKeyboardNavigation(options: Options): (event: KeyboardEvent) => void;
 export {};

package/dist/docx/print-layout-view.d.ts

@@ -12,6 +12,8 @@ export interface PrintLayoutController {
         offset: number;
     } | null;
     scheduleRelayout(model: DocumentModel): void;
+    /** Lays out now, dropping a pending debounced layout (a document swap must not show stale pages). */
+    relayoutNow(model: DocumentModel): void;
     /** Recomputes which page is most visible; call on the scroll container's `scroll` event. */
     refreshCurrentPage(): void;
     pageStatus(): {
@@ -30,6 +32,12 @@ export interface PrintLayoutController {
     approximations(): string[];
     /** Lays out immediately (no debounce) and opens the browser print dialog for the paginated render. */
     print(model: DocumentModel, note: (message: string) => void): void;
+    /**
+     * Holds layout while an in-page header, footer or note editor is open (a relayout would replace
+     * the page it lives in); releasing lays out the latest model. `page` (a zero-based index) stays
+     * mounted while held, so scrolling a long document does not tear the open editor down.
+     */
+    holdLayout(held: boolean, page?: number): void;
     destroy(): void;
 }
 export declare function createPrintLayoutController(scrollContainer: HTMLElement, onRequestCursor: (blockId: string, offset: number) => void, pictureUrl?: PictureUrl, onLayout?: () => void, getReviewMode?: () => ReviewDisplayMode, isEditing?: () => boolean): PrintLayoutController;

package/dist/docx/print-layout.d.ts

@@ -8,7 +8,7 @@ export interface PrintLayoutHandle {
     /** The scrollable element holding one sheet per page; mount this in the DOM. */
     element: HTMLElement;
     pageCount: number;
-    showPages(center: number, pinned?: number): void;
+    showPages(center: number, pinned?: number | readonly (number | undefined)[]): void;
     renderAll(): void;
     pageSnapshot(index: number): HTMLElement | undefined;
     /**

package/dist/docx/print-note-editing.d.ts

@@ -0,0 +1,47 @@
+import type { DocumentModel } from 'ooxml-core/docx';
+import type { EditorView } from 'prosemirror-view';
+import type { NoteKind } from './note-commands.js';
+import type { PartsController } from './parts-controller.js';
+export interface PrintNoteHost {
+    /** The `.dve-print-pages` element. */
+    pages: HTMLElement;
+    parts: Pick<PartsController, 'editNoteOnPage' | 'closeOpenStory'>;
+    model(): DocumentModel;
+    /** The body editor, which keeps the caret outside the note. */
+    view(): EditorView | undefined;
+    printActive(): boolean;
+    /** `page` is the zero-based index of the page the open editor lives on. */
+    holdLayout(held: boolean, page?: number): void;
+    /** Mounts the page that holds a paragraph (virtualised documents). */
+    showBlock(id: string, offset: number): void;
+}
+interface NoteRef {
+    kind: NoteKind;
+    id: string;
+    /** Id of the note's first paragraph (where the automatic number mark sits). */
+    firstId: string;
+}
+/** Paragraph id to owning note, for every footnote and endnote paragraph in the model. */
+export declare function noteParagraphs(model: DocumentModel): Map<string, NoteRef>;
+/** The note a body reference mark under `target` points at, when it is one. */
+export declare function referenceUnder(view: EditorView, target: Element): {
+    kind: NoteKind;
+    id: string;
+} | undefined;
+/** Position just after the body reference to a note, with the id of its paragraph. */
+export declare function referencePosition(view: EditorView, ref: {
+    kind: NoteKind;
+    id: string;
+}): {
+    pos: number;
+    blockId: string;
+    offset: number;
+} | undefined;
+/**
+ * Notes on Print Layout pages. A press on a note's text opens the note's own editor over it with
+ * the caret there; Escape, or a press anywhere else, returns to the body. Double-clicking a
+ * reference mark in the body jumps to its note, and double-clicking the number in the note jumps
+ * back to the reference, as in Word.
+ */
+export declare function attachPrintNoteEditing(host: PrintNoteHost): () => void;
+export {};

package/dist/docx/print-page-window.d.ts

@@ -10,7 +10,8 @@ export declare class PrintPageWindow {
     mount(index: number): void;
     private unmount;
     private changed;
-    show(center: number, pinned?: number): void;
+    /** Mounts the pages around `center`; `pinned` pages stay mounted wherever the window is. */
+    show(center: number, pinned?: number | readonly (number | undefined)[]): void;
     all(): void;
     snapshot(index: number): HTMLElement | undefined;
 }

package/dist/docx/print-picture.d.ts

@@ -1,5 +1,12 @@
 /** Resolves a package picture part to a displayable URL; undefined draws a placeholder box. */
 export type PictureUrl = (partName: string, contentType: string) => string | undefined;
+/**
+ * Strips the active content from a chart SVG before it is imported into the
+ * page: `<script>` and `<foreignObject>` elements, every `on*` event-handler
+ * attribute, and `href` / `xlink:href` values other than fragments or
+ * `data:image` URLs. Mirrors the rules of `src/core/docx/ui/chart-spec.ts`.
+ */
+export declare function sanitizeChartSvg(svg: Element): void;
 export declare function pictureElement(object: {
     partName: string;
     contentType: string;

package/dist/docx/print-story-editing.d.ts

@@ -0,0 +1,16 @@
+import type { DocumentModel } from 'ooxml-core/docx';
+import type { PartsController } from './parts-controller.js';
+export interface PrintStoryHost {
+    /** The `.dve-print-pages` element. */
+    pages: HTMLElement;
+    parts: Pick<PartsController, 'editOnPage' | 'closeOpenStory'>;
+    model(): DocumentModel;
+    printActive(): boolean;
+    /** `page` is the zero-based index of the page the open editor lives on. */
+    holdLayout(held: boolean, page?: number): void;
+}
+/**
+ * Double-clicking a page's header or footer area edits it in place, as in Word: the body dims, the
+ * Header & Footer ribbon tab appears, and Escape or a double-click on the body closes it.
+ */
+export declare function attachPrintStoryEditing(host: PrintStoryHost): () => void;

package/dist/docx/print-vertical-step.d.ts

@@ -0,0 +1,7 @@
+import type { PrintEditingIndex } from './print-editing-index.js';
+/**
+ * The line one step up or down from `line`. Outside tables that is the next rendered line; inside a
+ * table it stays in the cell, then moves to the cell of the next row under the same x, and leaves
+ * the table past its last or first row. Entering a table lands in the cell under `x`.
+ */
+export declare function stepVertical(index: PrintEditingIndex, line: HTMLElement, direction: number, x: number): HTMLElement;

package/dist/docx/ribbon-action.d.ts

@@ -167,6 +167,21 @@ export type RibbonAction = {
     key: 'toggle' | 'add' | 'delete' | 'previous' | 'next';
 } | {
     type: 'insertPicture';
+} | {
+    type: 'shapePicker';
+} | {
+    type: 'drawShape';
+    preset: string;
+} | {
+    type: 'shape';
+    key: 'fill' | 'outline' | 'weight' | 'width' | 'height' | 'wrap';
+    value: string | number;
+} | {
+    type: 'insertEquation';
+    id: 'area' | 'quadratic' | 'pythagorean' | 'binomial';
+} | {
+    type: 'insertContentControl';
+    value: 'richText' | 'text' | 'checkbox' | 'dropDownList' | 'comboBox' | 'date';
 } | {
     type: 'formatPicture';
 } | {

package/dist/docx/ribbon-icons.d.ts

@@ -118,6 +118,9 @@ declare const paths: {
     readonly watermark: 'M5 18L19 6 M7 8h4 M13 16h4';
     readonly pageBorders: 'M4 4h16v16H4z M7 7h10v10H7z';
     readonly textBox: 'M4 5h16v14H4z M8 10h8 M8 14h5';
+    readonly shapes: 'M4 14h8v6H4z M17 7.5a4 4 0 1 0 0 .01 M10 11l4-8 4 8z';
+    readonly equation: 'M18 5H7l6 7-6 7h11';
+    readonly contentControl: 'M4 7h16v12H4z M4 7V4h7v3 M8 12h8 M8 15h5';
     readonly pageColor: 'M6 3h9l3 3v15H6z M9 11h6v6H9z';
     readonly hyphenation: 'M4 6h16 M4 11h9 M16 11h4 M4 16h16 M13 11h3';
     readonly caret: 'M7 10l5 5 5-5';

package/dist/docx/schema.d.ts

@@ -3,4 +3,4 @@ export { wordHighlightColors } from 'ooxml-core/docx/ui';
 /** Single line spacing as a multiple of the font size, close to Calibri's and Arial's metrics. */
 export declare const NATURAL_LINE_HEIGHT = 1.2;
 export declare function paragraphStyle(attrs: Record<string, unknown>): string;
-export declare const schema: Schema<"doc" | "equation" | "fieldMarker" | "hardBreak" | "image" | "nestedTablePreview" | "noteReference" | "pageBreak" | "paragraph" | "table" | "tableCell" | "tableRow" | "text", "bold" | "characterStyle" | "comment" | "deletion" | "field" | "font" | "highlight" | "inlineCommentAnchors" | "insertion" | "italic" | "language" | "link" | "runProperties" | "runRtl" | "strike" | "underline" | "verticalAlign">;
+export declare const schema: Schema<"doc" | "equation" | "fieldMarker" | "hardBreak" | "image" | "nestedTablePreview" | "noteReference" | "pageBreak" | "paragraph" | "table" | "tableCell" | "tableRow" | "text", "bold" | "characterStyle" | "comment" | "contentControl" | "deletion" | "field" | "font" | "highlight" | "inlineCommentAnchors" | "insertion" | "italic" | "language" | "link" | "runProperties" | "runRtl" | "strike" | "underline" | "verticalAlign">;

package/dist/docx/shape-commands.d.ts

@@ -0,0 +1,40 @@
+import { type EditorState } from 'prosemirror-state';
+import type { EditorView } from 'prosemirror-view';
+import { type PicturePlacement, type ShapeSpec } from 'ooxml-core/docx';
+export interface SelectedShape {
+    pos: number;
+    spec: ShapeSpec;
+    widthPx: number;
+    heightPx: number;
+    anchored: boolean;
+    placement: PicturePlacement | undefined;
+}
+/** The shape the selection is on (an image atom that carries a shape), if any. */
+export declare function selectedShape(state: EditorState): SelectedShape | undefined;
+/** Shape Fill: a `#rrggbb` colour, `none`, or `default` for the theme style's fill. */
+export declare function setShapeFill(view: EditorView, value: string): boolean;
+/** Shape Outline: a `#rrggbb` colour, `none`, or `default`. Keeps the weight and dash. */
+export declare function setShapeOutline(view: EditorView, value: string): boolean;
+/** Shape Outline > Weight, in points. */
+export declare function setShapeWeight(view: EditorView, points: number): boolean;
+export declare function setShapeText(view: EditorView, lines: string[]): boolean;
+export declare function setShapeSize(view: EditorView, widthPx?: number, heightPx?: number): boolean;
+export type ShapeWrap = 'inline' | 'square' | 'tight' | 'through' | 'topAndBottom' | 'behind' | 'front';
+/** Wrap Text: the wrapping of the shape, or In Line with Text. */
+export declare function setShapeWrap(view: EditorView, wrap: ShapeWrap): boolean;
+/** The Wrap Text choice that describes the selected shape. */
+export declare function shapeWrapOf(shape: SelectedShape): ShapeWrap;
+export interface DrawnRect {
+    /** Offset from the left edge of the text column and the top of the paragraph, in CSS pixels. */
+    x: number;
+    y: number;
+    widthPx: number;
+    heightPx: number;
+    flipH?: boolean;
+    flipV?: boolean;
+}
+/**
+ * Places a drawn shape as a floating shape in front of text, anchored to the paragraph holding
+ * `pos`, and selects it. Returns whether a shape was inserted.
+ */
+export declare function insertDrawnShape(view: EditorView, preset: string, pos: number, rect: Partial<DrawnRect> & Pick<DrawnRect, 'x' | 'y'>): boolean;

package/dist/docx/shape-draw.d.ts

@@ -0,0 +1,12 @@
+import { Plugin } from 'prosemirror-state';
+/** Which shape the next drag on the page draws (set from Insert > Shapes), shared by the editor. */
+export declare class ShapeTool {
+    private current;
+    private readonly listeners;
+    get preset(): string | undefined;
+    arm(preset: string): void;
+    disarm(): void;
+    onChange(listener: () => void): () => void;
+}
+/** The plugin that turns a drag on the page into a shape while `tool` is armed. */
+export declare function shapeDrawPlugin(tool: ShapeTool): Plugin;

package/dist/docx/shape-format-ribbon.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState } from 'prosemirror-state';
+export declare function buildShapeFormatPanel(panel: HTMLElement): void;
+/** Shows the tab while a shape is selected (switching to it on entry) and fills its controls. */
+export declare function syncShapeFormat(toolbar: HTMLElement, state: EditorState, editable: boolean): void;

package/dist/docx/shape-node-view.d.ts

@@ -0,0 +1,4 @@
+import type { Node as ProseMirrorNode } from 'prosemirror-model';
+import type { EditorView, NodeView } from 'prosemirror-view';
+import { type ThemeCatalog } from 'ooxml-core/docx';
+export declare function shapeNodeView(initial: ProseMirrorNode, view: EditorView, getPos: () => number | undefined, theme: () => ThemeCatalog | undefined): NodeView;

package/dist/docx/shape-picker.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Opens the shape gallery under `anchor`. `onPick` receives the preset; the caller then lets the
+ * user draw it on the page. Arrow keys move through the cells and Enter chooses.
+ */
+export declare function openShapePicker(anchor: HTMLElement, onPick: (preset: string) => void, onClose: () => void): void;

package/dist/docx/shape-text-dialog.d.ts

@@ -0,0 +1,4 @@
+import type { EditorView } from 'prosemirror-view';
+import type { FormatDialog } from './font-dialog.js';
+/** Shape Format > Add Text: the text inside the selected shape, one paragraph per line. */
+export declare function createShapeTextDialog(getView: () => EditorView | undefined): FormatDialog;

package/dist/docx/status-bar.d.ts

@@ -13,7 +13,7 @@ export interface StatusBar {
     /** Redraws every label after the editor locale changed. */
     relocalize(): void;
 }
-export declare const ZOOM_MIN = 50;
+export declare const ZOOM_MIN = 25;
 export declare const ZOOM_MAX = 200;
 /**
  * Word-style status bar: page/words/language on the left, views and zoom on the right. The shared

package/dist/docx/table-model-adapter.d.ts

@@ -1,6 +1,6 @@
 import type { Node as ProseMirrorNode } from 'prosemirror-model';
 import type { Paragraph, Table, TableStyleCatalog } from 'ooxml-core/docx';
-export declare function tableNode(block: Table, paragraphNode: (paragraph: Paragraph) => ProseMirrorNode, tableStyles?: TableStyleCatalog): ProseMirrorNode;
+export declare function tableNode(block: Table, paragraphNode: (paragraph: Paragraph) => ProseMirrorNode, tableStyles?: TableStyleCatalog, nested?: boolean): ProseMirrorNode;
 /** Reads editable formatting from nodes rather than a stale prior model. */
 export declare function tableFormattingFromNode(node: ProseMirrorNode): {
     rowProperties: Table['rowProperties'];

package/dist/docx/table-navigation.d.ts

@@ -0,0 +1,8 @@
+import { type Command } from 'prosemirror-state';
+/**
+ * Word's Tab and Shift+Tab inside a table: move to the next or previous cell in reading order and
+ * select its text. Tab in the last cell adds a row when the table's structure may change; a
+ * structure-locked table (merged cells) keeps the caret where it is. Cells of nested tables take
+ * part in the reading order, and Tab in the last nested cell continues in the enclosing table.
+ */
+export declare function cellTab(direction: 1 | -1): Command;