@docx-editor.dev/core 0.0.1 → 2.1.0

package/dist/output.cjs

@@ -0,0 +1 @@
+'use strict';var chunk3JKQE4QJ_cjs=require('./chunk-3JKQE4QJ.cjs');require('./chunk-TSXT537P.cjs'),require('./chunk-BS554B6D.cjs'),require('./chunk-JQFDLZXQ.cjs'),require('./chunk-BZK64YU3.cjs');Object.defineProperty(exports,"paintSelectionOverlay",{enumerable:true,get:function(){return chunk3JKQE4QJ_cjs.e}});Object.defineProperty(exports,"paintSemanticLayout",{enumerable:true,get:function(){return chunk3JKQE4QJ_cjs.d}});

package/dist/output.d.cts

@@ -0,0 +1,158 @@
+import { C as ContentControlBoundaryRecord, S as SemanticLayout } from './semantic-records-COVFW5aS.cjs';
+import { D as DrawingPaintStrings, P as PaintImageUrlPort } from './semantic-paint-drawings-x8g44lD_.cjs';
+import './tree-op-types-UOXlRUqQ.cjs';
+import './ooxml-tree-BU0e3DVi.cjs';
+import './image-resources-DwpNnTg3.cjs';
+import './ooxml-package-CR5us6ad.cjs';
+import './revision-projection-72ZApe-g.cjs';
+
+/**
+ * How a layout is painted into DOM. Every field is optional.
+ *
+ * The painted pages ARE the editable surface, so everything here is presentation-only — nothing
+ * set through these options is ever serialised back into the document.
+ */
+interface PaintOptions {
+    /** Points to CSS pixels. 96/72 renders a point as a CSS point at 100% zoom. */
+    readonly scale?: number;
+    /** Generated paragraphs that paint as non-editable navigation surfaces. */
+    readonly readOnlyParagraphIds?: ReadonlySet<string>;
+    /**
+     * Empty-TOC begin paragraphs that paint subtle identifiable furniture. Paint-only — never
+     * serialised into the document.
+     */
+    readonly emptyTocPlaceholderIds?: ReadonlySet<string>;
+    /** Marks painted pages as presentational, so assistive tech reads the editable projection. */
+    readonly ariaHidden?: boolean;
+    /**
+     * Page indices to build in detail (task 9.4).
+     *
+     * Omitted means all of them. A page left out keeps its size and position but no content,
+     * so the document's height and page count are unchanged and scrolling to it reveals it
+     * instead of reflowing everything underneath.
+     */
+    readonly materialize?: ReadonlySet<number>;
+    /**
+     * Family-alias lookup for fonts the host registered on behalf of THIS document (see
+     * {@link PaintContext.fontAlias}). Painted runs emit the alias ahead of the declared
+     * family, so a file can never shadow a family name the host page uses.
+     */
+    readonly fontAlias?: (family: string) => string | undefined;
+    /** See {@link PaintContext.defaultFontFamily}. */
+    readonly defaultFontFamily?: string;
+    /**
+     * Relationship id of the header/footer story currently open for editing.
+     *
+     * When set, the matching `[data-docx-hf]` container is editable and every body
+     * `.docx-page-content` box is inert; all other furniture stays read-only.
+     */
+    readonly activeHeaderFooterRId?: string;
+    /**
+     * Sheet that hosts the active visual occurrence of a shared furniture part.
+     *
+     * Required with {@link activeHeaderFooterRId} so only one painted copy receives
+     * `data-docx-hf-active` / the engine caret when the same rId appears on many pages.
+     */
+    readonly activeHeaderFooterPageIndex?: number;
+    /**
+     * On-demand content-control boundary chrome (show-all and/or caret-entry).
+     *
+     * Furniture only — never contributes layout records or changes page geometry. Omitted or
+     * empty means no control chrome is painted. Folded into the paint-reuse key so a toggle
+     * rebuilds furniture without a layout pass.
+     */
+    readonly contentControlChrome?: {
+        readonly showAll?: boolean;
+        /** Control ids whose boundaries are visible because the caret is inside them. */
+        readonly activeIds?: ReadonlySet<string>;
+        /**
+         * Control ids whose boundaries are visible because the pointer is over them.
+         * Used for TOC hover chrome without projecting a persistent caret-active state.
+         *
+         * Deliberately OUTSIDE the paint-reuse key: hover must never rebuild a page. The
+         * surface toggles `data-hover` / `data-boundary-visible` on the painted chrome it
+         * already has, and this set only tells a page that rebuilds for some OTHER reason
+         * which of its controls is currently under the pointer.
+         */
+        readonly hoverIds?: ReadonlySet<string>;
+        /**
+         * Control ids whose boundary furniture is painted by something else.
+         *
+         * An empty TOC paints its own placeholder box on the begin paragraph, so drawing the
+         * control boundary as well left two rounded rectangles (of different heights) plus a
+         * label chip stacked over one empty region.
+         */
+        readonly suppressedIds?: ReadonlySet<string>;
+        /** Checkbox control ids whose canonical `w14:checked` state is on. */
+        readonly checkedIds?: ReadonlySet<string>;
+        /** Non-SDT structured regions that intentionally reuse content-control chrome. */
+        readonly additionalBoundaries?: readonly ContentControlBoundaryRecord[];
+        /** Control ids that represent TOC regions (hover-only chrome; never caret-sticky). */
+        readonly tocControlIds?: ReadonlySet<string>;
+    };
+    readonly drawingStrings?: DrawingPaintStrings;
+    readonly imageUrlPort?: PaintImageUrlPort;
+}
+
+/**
+ * Paint a whole layout into a container, reusing the pages that did not change.
+ *
+ * The DOM is built with `createElement` and `textContent` only — no file-derived string is
+ * ever parsed as markup — and stray children (nothing this module painted) are removed, so
+ * the container's content is always exactly the painted pages.
+ */
+declare function paintSemanticLayout(container: HTMLElement, layout: SemanticLayout, options?: PaintOptions): void;
+
+/** A rectangle in page-content coordinates, on a named page. */
+interface OverlayRect {
+    readonly pageIndex: number;
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+    /**
+     * Class for THIS rectangle, overriding the layer's default.
+     *
+     * One layer draws bands that mean different things — every commented range, and the one the
+     * caret is in — and splitting them into two layers would stack two absolutely positioned
+     * sheets over the pages just to vary a colour.
+     */
+    readonly className?: string;
+}
+/**
+ * How the selection overlay draws its rectangles over the painted pages.
+ *
+ * `scale` and `pageOffsetX` must match what the page painter used, or the highlight lands beside
+ * the content it describes rather than on it.
+ */
+interface SelectionOverlayOptions {
+    /** Points to CSS pixels. */
+    readonly scale: number;
+    /**
+     * Per-page horizontal offset the page painter applied, by page index.
+     *
+     * A document whose pages differ in width centres each one individually, so a page is drawn
+     * at an x its record does not carry. Without the same offset here a highlight would sit
+     * beside the cells it describes.
+     */
+    readonly pageOffsetX?: ReadonlyMap<number, number>;
+    /**
+     * Class for each painted rectangle. Defaults to the cell-selection class, because a cell
+     * rectangle was the only thing this layer drew when it was written.
+     *
+     * A retained TEXT range is drawn here too and must not look like selected cells — one is
+     * "these cells are chosen", the other is "your selection is still here while you type in
+     * this panel". Same geometry, different meaning, so the caller names the class.
+     */
+    readonly className?: string;
+}
+/**
+ * Draw a set of rectangles over the pages.
+ *
+ * The layer is a SIBLING of the pages, never a child: the page painter sweeps anything it did
+ * not paint out of its own subtree, and a stray child of a contenteditable is editable content
+ * a keystroke could land in.
+ */
+declare function paintSelectionOverlay(layer: HTMLElement, layout: SemanticLayout, rects: readonly OverlayRect[], options: SelectionOverlayOptions): void;
+
+export { type OverlayRect, type PaintOptions, type SelectionOverlayOptions, paintSelectionOverlay, paintSemanticLayout };

package/dist/output.d.ts

@@ -0,0 +1,158 @@
+import { C as ContentControlBoundaryRecord, S as SemanticLayout } from './semantic-records-zTC0_1zi.js';
+import { D as DrawingPaintStrings, P as PaintImageUrlPort } from './semantic-paint-drawings-B5Wk2so5.js';
+import './tree-op-types-DWLCllG7.js';
+import './ooxml-tree-BU0e3DVi.js';
+import './image-resources-C_YnqPhn.js';
+import './ooxml-package-D_CtywTW.js';
+import './revision-projection-DHAkcD_L.js';
+
+/**
+ * How a layout is painted into DOM. Every field is optional.
+ *
+ * The painted pages ARE the editable surface, so everything here is presentation-only — nothing
+ * set through these options is ever serialised back into the document.
+ */
+interface PaintOptions {
+    /** Points to CSS pixels. 96/72 renders a point as a CSS point at 100% zoom. */
+    readonly scale?: number;
+    /** Generated paragraphs that paint as non-editable navigation surfaces. */
+    readonly readOnlyParagraphIds?: ReadonlySet<string>;
+    /**
+     * Empty-TOC begin paragraphs that paint subtle identifiable furniture. Paint-only — never
+     * serialised into the document.
+     */
+    readonly emptyTocPlaceholderIds?: ReadonlySet<string>;
+    /** Marks painted pages as presentational, so assistive tech reads the editable projection. */
+    readonly ariaHidden?: boolean;
+    /**
+     * Page indices to build in detail (task 9.4).
+     *
+     * Omitted means all of them. A page left out keeps its size and position but no content,
+     * so the document's height and page count are unchanged and scrolling to it reveals it
+     * instead of reflowing everything underneath.
+     */
+    readonly materialize?: ReadonlySet<number>;
+    /**
+     * Family-alias lookup for fonts the host registered on behalf of THIS document (see
+     * {@link PaintContext.fontAlias}). Painted runs emit the alias ahead of the declared
+     * family, so a file can never shadow a family name the host page uses.
+     */
+    readonly fontAlias?: (family: string) => string | undefined;
+    /** See {@link PaintContext.defaultFontFamily}. */
+    readonly defaultFontFamily?: string;
+    /**
+     * Relationship id of the header/footer story currently open for editing.
+     *
+     * When set, the matching `[data-docx-hf]` container is editable and every body
+     * `.docx-page-content` box is inert; all other furniture stays read-only.
+     */
+    readonly activeHeaderFooterRId?: string;
+    /**
+     * Sheet that hosts the active visual occurrence of a shared furniture part.
+     *
+     * Required with {@link activeHeaderFooterRId} so only one painted copy receives
+     * `data-docx-hf-active` / the engine caret when the same rId appears on many pages.
+     */
+    readonly activeHeaderFooterPageIndex?: number;
+    /**
+     * On-demand content-control boundary chrome (show-all and/or caret-entry).
+     *
+     * Furniture only — never contributes layout records or changes page geometry. Omitted or
+     * empty means no control chrome is painted. Folded into the paint-reuse key so a toggle
+     * rebuilds furniture without a layout pass.
+     */
+    readonly contentControlChrome?: {
+        readonly showAll?: boolean;
+        /** Control ids whose boundaries are visible because the caret is inside them. */
+        readonly activeIds?: ReadonlySet<string>;
+        /**
+         * Control ids whose boundaries are visible because the pointer is over them.
+         * Used for TOC hover chrome without projecting a persistent caret-active state.
+         *
+         * Deliberately OUTSIDE the paint-reuse key: hover must never rebuild a page. The
+         * surface toggles `data-hover` / `data-boundary-visible` on the painted chrome it
+         * already has, and this set only tells a page that rebuilds for some OTHER reason
+         * which of its controls is currently under the pointer.
+         */
+        readonly hoverIds?: ReadonlySet<string>;
+        /**
+         * Control ids whose boundary furniture is painted by something else.
+         *
+         * An empty TOC paints its own placeholder box on the begin paragraph, so drawing the
+         * control boundary as well left two rounded rectangles (of different heights) plus a
+         * label chip stacked over one empty region.
+         */
+        readonly suppressedIds?: ReadonlySet<string>;
+        /** Checkbox control ids whose canonical `w14:checked` state is on. */
+        readonly checkedIds?: ReadonlySet<string>;
+        /** Non-SDT structured regions that intentionally reuse content-control chrome. */
+        readonly additionalBoundaries?: readonly ContentControlBoundaryRecord[];
+        /** Control ids that represent TOC regions (hover-only chrome; never caret-sticky). */
+        readonly tocControlIds?: ReadonlySet<string>;
+    };
+    readonly drawingStrings?: DrawingPaintStrings;
+    readonly imageUrlPort?: PaintImageUrlPort;
+}
+
+/**
+ * Paint a whole layout into a container, reusing the pages that did not change.
+ *
+ * The DOM is built with `createElement` and `textContent` only — no file-derived string is
+ * ever parsed as markup — and stray children (nothing this module painted) are removed, so
+ * the container's content is always exactly the painted pages.
+ */
+declare function paintSemanticLayout(container: HTMLElement, layout: SemanticLayout, options?: PaintOptions): void;
+
+/** A rectangle in page-content coordinates, on a named page. */
+interface OverlayRect {
+    readonly pageIndex: number;
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+    /**
+     * Class for THIS rectangle, overriding the layer's default.
+     *
+     * One layer draws bands that mean different things — every commented range, and the one the
+     * caret is in — and splitting them into two layers would stack two absolutely positioned
+     * sheets over the pages just to vary a colour.
+     */
+    readonly className?: string;
+}
+/**
+ * How the selection overlay draws its rectangles over the painted pages.
+ *
+ * `scale` and `pageOffsetX` must match what the page painter used, or the highlight lands beside
+ * the content it describes rather than on it.
+ */
+interface SelectionOverlayOptions {
+    /** Points to CSS pixels. */
+    readonly scale: number;
+    /**
+     * Per-page horizontal offset the page painter applied, by page index.
+     *
+     * A document whose pages differ in width centres each one individually, so a page is drawn
+     * at an x its record does not carry. Without the same offset here a highlight would sit
+     * beside the cells it describes.
+     */
+    readonly pageOffsetX?: ReadonlyMap<number, number>;
+    /**
+     * Class for each painted rectangle. Defaults to the cell-selection class, because a cell
+     * rectangle was the only thing this layer drew when it was written.
+     *
+     * A retained TEXT range is drawn here too and must not look like selected cells — one is
+     * "these cells are chosen", the other is "your selection is still here while you type in
+     * this panel". Same geometry, different meaning, so the caller names the class.
+     */
+    readonly className?: string;
+}
+/**
+ * Draw a set of rectangles over the pages.
+ *
+ * The layer is a SIBLING of the pages, never a child: the page painter sweeps anything it did
+ * not paint out of its own subtree, and a stray child of a contenteditable is editable content
+ * a keystroke could land in.
+ */
+declare function paintSelectionOverlay(layer: HTMLElement, layout: SemanticLayout, rects: readonly OverlayRect[], options: SelectionOverlayOptions): void;
+
+export { type OverlayRect, type PaintOptions, type SelectionOverlayOptions, paintSelectionOverlay, paintSemanticLayout };

package/dist/output.js

@@ -0,0 +1 @@
+export{e as paintSelectionOverlay,d as paintSemanticLayout}from'./chunk-QRAUDDVY.js';import'./chunk-STCITBJK.js';import'./chunk-4WWEDTTE.js';import'./chunk-2DTQDAN7.js';import'./chunk-Y7TA7TPF.js';