@eigenpal/docx-editor-react 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -26,9 +26,9 @@ import { R as ReactSidebarItem } from './types-D35gNE-_.mjs';
 import { Comment } from '@eigenpal/docx-editor-core/types/content';
 import { Translations, TFunction } from '@eigenpal/docx-editor-i18n';
 import { P as PrintOptions } from './PrintPreview-DEhwRBC_.mjs';
-import { DocumentAgent } from '@eigenpal/docx-editor-core/agent';
+import { DocumentAgent, ContentControlFilter, ContentControlValue } from '@eigenpal/docx-editor-core/agent';
 import { DocxInput, FontDefinition } from '@eigenpal/docx-editor-core/utils';
-import { SelectionState } from '@eigenpal/docx-editor-core/prosemirror';
+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';
@@ -462,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. */

package/dist/index.d.ts

@@ -26,9 +26,9 @@ 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 { DocumentAgent, ContentControlFilter, ContentControlValue } from '@eigenpal/docx-editor-core/agent';
 import { DocxInput, FontDefinition } from '@eigenpal/docx-editor-core/utils';
-import { SelectionState } from '@eigenpal/docx-editor-core/prosemirror';
+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';
@@ -462,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. */