@eigenpal/docx-editor-react 1.0.3 → 1.2.0

package/dist/index.d.ts

@@ -20,15 +20,15 @@ import * as prosemirror_view from 'prosemirror-view';
 import { EditorView } from 'prosemirror-view';
 import * as prosemirror_state from 'prosemirror-state';
 import { EditorState, Transaction } from 'prosemirror-state';
-import { Document, Theme } from '@eigenpal/docx-editor-core/types/document';
+import { Document, HeaderFooter, Theme } from '@eigenpal/docx-editor-core/types/document';
 import { FontOption } from '@eigenpal/docx-editor-core/utils/fontOptions';
 import { R as ReactSidebarItem } from './types-D35gNE-_.js';
 import { Comment } from '@eigenpal/docx-editor-core/types/content';
 import { Translations, TFunction } from '@eigenpal/docx-editor-i18n';
 import { P as PrintOptions } from './PrintPreview-DEhwRBC_.js';
-import { DocumentAgent } from '@eigenpal/docx-editor-core/agent';
-import { DocxInput } from '@eigenpal/docx-editor-core/utils';
-import { SelectionState } from '@eigenpal/docx-editor-core/prosemirror';
+import { DocumentAgent, ContentControlFilter, ContentControlValue } from '@eigenpal/docx-editor-core/agent';
+import { DocxInput, FontDefinition } from '@eigenpal/docx-editor-core/utils';
+import { SelectionState, PMContentControl } from '@eigenpal/docx-editor-core/prosemirror';
 import { Layout } from '@eigenpal/docx-editor-core/layout-engine';
 import { RenderedDomContext } from '@eigenpal/docx-editor-core/plugin-api';
 import { EditorHandle } from '@eigenpal/docx-editor-core';
@@ -108,6 +108,17 @@ interface PagedEditorRef {
      * No-op if the layout isn't ready yet or pageNumber is out of range.
      */
     scrollToPage(pageNumber: number): void;
+    /**
+     * Look up the persistent hidden HF PM EditorView for a given HeaderFooter
+     * instance. Returns null when none is mounted (no document, or `hf` is not
+     * present in `Document.package.headers/footers`). Phase 2 of the HF
+     * unification: the inline overlay uses this to replicate edits into the
+     * persistent PM so the painter — which reads from the persistent PM per
+     * phase 1 — re-renders live during typing. Phase 5 deletes the inline
+     * overlay's PM and this method's only remaining caller is the click /
+     * focus router (phase 3).
+     */
+    getHfPmView(hf: HeaderFooter): EditorView | null;
 }
 
 /**
@@ -202,6 +213,23 @@ interface DocxEditorProps {
      * @example fontFamilies={[{ name: 'Roboto', fontFamily: 'Roboto, sans-serif', category: 'sans-serif' }]}
      */
     fontFamilies?: ReadonlyArray<string | FontOption>;
+    /**
+     * Custom font faces to register with the browser before the editor measures
+     * text. Each entry injects an `@font-face` rule. Pass a URL (woff2/woff/
+     * ttf/otf), an ArrayBuffer, or omit `src` to load by name from Google Fonts.
+     * Multiple entries can share `family` to register different weights/styles.
+     *
+     * Pass a stable reference — inline arrays re-register faces on each render
+     * (the loader dedupes by `family|weight|style`, so it's harmless but wastes
+     * work).
+     *
+     * @example
+     * fonts={[
+     *   { family: 'Custom Sans', src: '/fonts/CustomSans-Regular.woff2' },
+     *   { family: 'Custom Sans', src: '/fonts/CustomSans-Bold.woff2', weight: 700 },
+     * ]}
+     */
+    fonts?: ReadonlyArray<FontDefinition>;
     /** Print options for print preview */
     printOptions?: PrintOptions;
     /**
@@ -434,6 +462,41 @@ interface DocxEditorRef {
     } | null;
     /** Get all comments. */
     getComments: () => Comment[];
+    /**
+     * List block-level content controls (SDTs) in the live document, optionally
+     * filtered by `tag`/`alias`/`id`/`type`. Each result includes the control's
+     * text and PM position. Anchors for templates and document automation.
+     */
+    getContentControls: (filter?: ContentControlFilter) => PMContentControl[];
+    /** Scroll the first content control matching `filter` into view. Returns false if none. */
+    scrollToContentControl: (filter: ContentControlFilter) => boolean;
+    /**
+     * Replace the content of the first control matching `filter` with `text`
+     * (newlines become paragraphs). Returns false if no match. Throws if the
+     * control is content-locked unless `{ force: true }`.
+     */
+    setContentControlContent: (filter: ContentControlFilter, text: string, options?: {
+        force?: boolean;
+    }) => boolean;
+    /**
+     * Remove the first control matching `filter`. With `{ keepContent: true }`
+     * the inner blocks are unwrapped in place. Returns false if no match. Throws
+     * if the control is deletion-locked unless `{ force: true }`.
+     */
+    removeContentControl: (filter: ContentControlFilter, options?: {
+        force?: boolean;
+        keepContent?: boolean;
+    }) => boolean;
+    /**
+     * Set a typed value on the first control matching `filter`: a dropdown
+     * selection (`{ kind: 'dropdown', value }`), checkbox (`{ kind: 'checkbox',
+     * checked }`), or date (`{ kind: 'date', date }`). Updates the visible
+     * content and structured state. Returns false if no match; throws if
+     * content-locked (unless `force`) or the value doesn't fit the control type.
+     */
+    setContentControlValue: (filter: ContentControlFilter, value: ContentControlValue, options?: {
+        force?: boolean;
+    }) => boolean;
     /** Subscribe to document changes. Fires after every committed edit. Returns unsubscribe. */
     onContentChange: (listener: (document: Document) => void) => () => void;
     /** Subscribe to selection changes (cursor moves / selection changes). Returns unsubscribe. */