@primeui/texteditor-types 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,23 @@
+# License
+
+MIT License
+
+Copyright (c) 2026 PrimeTek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# PrimeUI TextEditor Types

package/dist/index.d.ts

@@ -0,0 +1 @@
+export type * from './texteditor.types';

package/dist/texteditor.types.d.ts

@@ -0,0 +1,819 @@
+import type { ComponentContext, ComponentInstance } from '@primeui/core/types/api';
+import type { UIElement } from '@primeui/core/types/shared';
+import type { EditorState, Command as PMCommand, Plugin as PMPlugin } from 'prosemirror-state';
+import type { EditorView } from 'prosemirror-view';
+/**
+ * Viewport coordinates and dimensions of the text caret, used to position
+ * floating UI such as the context toolbar, slash menu, and mention popup.
+ * @group Interface
+ */
+export interface CaretPosition {
+    /** Distance from the top of the viewport to the top of the caret, in pixels. */
+    top: number;
+    /** Distance from the left of the viewport to the caret, in pixels. */
+    left: number;
+    /** Distance from the top of the viewport to the bottom of the caret, in pixels. */
+    bottom: number;
+    /** Height of the caret, in pixels. */
+    height: number;
+    /** Width of the caret, in pixels. */
+    width: number;
+}
+/**
+ * Upload slot entry — represents a single file in the upload UI
+ * @group Interface
+ */
+export interface UploadSlotEntry {
+    /** Unique identifier for the upload slot. */
+    id: string;
+    /** Original name of the file being uploaded. */
+    fileName: string;
+    /** Size of the file in bytes. */
+    fileSize: number;
+    /** Human-readable file size (e.g. "1.2 MB"). */
+    fileSizeFormatted: string;
+    /** Upload progress as a percentage (0–100). */
+    progress: number;
+    /** Current state of the upload. */
+    status: 'uploading' | 'complete' | 'error' | 'cancelled';
+    /** Aborts the in-progress upload for this slot. */
+    cancel: () => void;
+}
+/**
+ * A heading entry extracted from the document
+ * @group Interface
+ */
+export interface TextEditorHeadingEntry {
+    /** ProseMirror document position of the heading node */
+    pos: number;
+    /** Heading level (1-6) */
+    level: number;
+    /** Plain text content of the heading */
+    text: string;
+}
+/**
+ * TextEditor component refs
+ * @group Interface
+ */
+export interface TextEditorRefs {
+    /** Reference to the editor content element */
+    element?: UIElement;
+    /** Reference to the block mode container element (Block mode) */
+    blockModeElement?: UIElement;
+    /** Reference to the file input element for image uploads */
+    fileInputElement?: UIElement;
+}
+/**
+ * TextEditor mode
+ * @group Types
+ */
+export type TextEditorMode = 'classic' | 'block';
+/**
+ * TextEditor component props
+ * @group Props
+ */
+export interface TextEditorProps {
+    /** Editor value: string for classic mode, string[] for block mode */
+    value?: string | string[] | null | undefined;
+    /** Editor mode: 'classic' (toolbar editor) or 'block' (Notion-like block editor) */
+    mode?: TextEditorMode | null | undefined;
+    /** Placeholder text displayed inside an empty editor */
+    placeholder?: string | null | undefined;
+    /** Placeholder text displayed after '/' when slash commands are active (e.g. "Type to search") */
+    slashPlaceholder?: string | null | undefined;
+    /** Placeholder text displayed inside empty checklist items (e.g. "To-Do") */
+    checklistPlaceholder?: string | null | undefined;
+    /** Accepted file types for image uploads. Defaults to 'image/*'. */
+    allowedImageTypes?: string | undefined;
+    /** Accepted file types for document uploads. */
+    allowedDocumentTypes?: string | undefined;
+    /** Maximum number of images allowed per upload selection. */
+    imageMaxFileCount?: number | null | undefined;
+    /** Maximum image file size in bytes per file. */
+    imageMaxFileSize?: number | null | undefined;
+    /** Maximum number of documents allowed per upload selection. */
+    documentMaxFileCount?: number | null | undefined;
+    /** Maximum document file size in bytes per file. */
+    documentMaxFileSize?: number | null | undefined;
+    /** Enables the document navigator minimap. Default: false */
+    navigator?: boolean | undefined;
+    /** Enables markdown input rules (e.g. # heading, **bold**, - list). Default: false */
+    markdown?: boolean | undefined;
+    /** Debounce (ms) for `value-change`. Default 0 (immediate). */
+    valueChangeDebounce?: number | null | undefined;
+    /** Minimum column width in pixels for table column resize. Default: 40 */
+    minTableColumnWidth?: number | null | undefined;
+    /** Default column width in pixels when inserting a new table or adding columns. Default: 120 */
+    defaultTableColumnWidth?: number | null | undefined;
+    /** Color applied by the one-click highlight toggle and `==` rule. Default: soft yellow. */
+    defaultHighlightColor?: string | null | undefined;
+    /** Upload handler fallback when image/document handlers aren't set. */
+    uploadHandler?: ((file: File, options: {
+        onProgress: (percent: number) => void;
+        signal: AbortSignal;
+    }) => Promise<string>) | undefined;
+    /** Image upload handler; takes precedence over uploadHandler. */
+    imageUploadHandler?: ((file: File, options: {
+        onProgress: (percent: number) => void;
+        signal: AbortSignal;
+    }) => Promise<string>) | undefined;
+    /** Document upload handler; takes precedence over uploadHandler. */
+    documentUploadHandler?: ((file: File, options: {
+        onProgress: (percent: number) => void;
+        signal: AbortSignal;
+    }) => Promise<string>) | undefined;
+    /** Handler for fetching mention suggestions. Receives the current
+     *  `@…` query and returns an array (or promise of array) of items. */
+    mentionHandler?: ((query: string) => unknown[] | Promise<unknown[]>) | undefined;
+    /** Field name used to filter mention items (e.g. 'name', 'label') */
+    mentionFilterField?: string | undefined;
+    /** Custom template function for rendering mention chips */
+    mentionTemplate?: ((data: unknown) => string) | undefined;
+    /** Array of editor plugins */
+    plugins?: unknown[] | undefined;
+    /** Disables editing and toolbar interactions while still rendering content. */
+    disabled?: boolean | undefined;
+    /** Keeps content selectable / copyable but blocks edits. */
+    readonly?: boolean | undefined;
+    /** Accessible name for the editor region (WCAG 4.1.2). */
+    ariaLabel?: string | undefined;
+    /** ID(s) of element(s) labelling the editor region (alternative to ariaLabel). */
+    ariaLabelledby?: string | undefined;
+}
+/**
+ * TextEditor component state
+ * @group State
+ */
+export interface TextEditorState {
+    /** Snapshot of the active formatting at the current selection. */
+    formatState?: TextEditorFormatState | null | undefined;
+    /** Currently hovered block index (block mode) */
+    hoveredBlockIndex?: number | null | undefined;
+    /** Block index being dragged (block mode) */
+    draggedBlockIndex?: number | null | undefined;
+    /** Drop indicator position - shows line above this index (block mode) */
+    dropIndicatorIndex?: number | null | undefined;
+    /** Whether mention feature is enabled (determined by #mention-list slot existence) */
+    isMentionEnabled?: boolean;
+    /** Whether slash commands are enabled (determined by #slash-menu slot existence) */
+    isSlashCommandsEnabled?: boolean;
+}
+/**
+ * TextEditor component event emitters
+ * @group Events
+ */
+export interface TextEditorEmits {
+    /** Emitted when editor content value changes */
+    valueChange: (value: string | string[]) => void;
+    /** Emitted when editor format state changes */
+    formatStateChange: (value: TextEditorFormatState) => void;
+    /** Emitted when the selection changes (caret move or range change) without a document edit */
+    selectionUpdate: () => void;
+    /** Emitted when the editor gains focus */
+    editorFocus: () => void;
+    /** Emitted when the editor loses focus */
+    editorBlur: () => void;
+    /** Emitted once when the editor view is created and ready */
+    editorCreate: () => void;
+    /** Emitted when context toolbar should be shown (on double-click or text selection) */
+    contextToolbarRequest: (position: CaretPosition) => void;
+    /** Emitted on every transaction while slash menu is active — provides filter text, position, and dismiss signal */
+    slashMenuRequest: (update: {
+        active: boolean;
+        text: string;
+        position: CaretPosition | null;
+    }) => void;
+    /** Emitted when image upload placeholder is inserted and upload UI should be shown */
+    imageUploadRequest: () => void;
+    /** Emitted when document upload placeholder is inserted and upload UI should be shown */
+    documentUploadRequest: () => void;
+    /** Emitted on every transaction while mention is active — provides filter text, position, and dismiss signal */
+    mentionRequest: (update: {
+        active: boolean;
+        text: string;
+        position: CaretPosition | null;
+        items?: unknown[];
+    }) => void;
+    /** Emitted when files are rejected due to validation (max count, max size, or disallowed file type) */
+    imageReject: (data: {
+        files: File[];
+        reason: 'max-file-count' | 'max-file-size' | 'file-type';
+    }) => void;
+    /** Emitted when documents are rejected due to validation (max count, max size, or disallowed file type) */
+    documentReject: (data: {
+        files: File[];
+        reason: 'max-file-count' | 'max-file-size' | 'file-type';
+    }) => void;
+    /** Emitted when an image upload handler rejects (network/server error) */
+    imageUploadError: (data: {
+        file: File;
+        error: unknown;
+    }) => void;
+    /** Emitted when a document upload handler rejects (network/server error) */
+    documentUploadError: (data: {
+        file: File;
+        error: unknown;
+    }) => void;
+    /** Emitted when an incoming value can't be parsed (e.g. pathological nesting); the editor falls back to an empty document */
+    parseError: (data: {
+        error: unknown;
+    }) => void;
+    /** Emitted when image upload entries change (progress, status) */
+    imageUploadStateChange: (entries: UploadSlotEntry[]) => void;
+    /** Emitted when document upload entries change (progress, status) */
+    documentUploadStateChange: (entries: UploadSlotEntry[]) => void;
+    /** Emitted when all image uploads complete (entries cleared) */
+    imageUploadComplete: () => void;
+    /** Emitted when all document uploads complete (entries cleared) */
+    documentUploadComplete: () => void;
+    /** Emitted when table overlay rect changes (for positioning controls) */
+    tableOverlayRectChange: (rect: TableOverlayRect | null) => void;
+    /** Emitted when table active state changes */
+    tableActiveStateChange: (state: TableActiveState | null) => void;
+    /** Emitted when table column trigger dot is clicked */
+    tableColumnMenuRequest: (colIndex: number, event: MouseEvent) => void;
+    /** Emitted when table row trigger dot is clicked */
+    tableRowMenuRequest: (rowIndex: number, event: MouseEvent) => void;
+    /** Emitted when table cell trigger dot is clicked */
+    tableCellMenuRequest: (event: MouseEvent) => void;
+    /** Emitted when hovered block changes (block mode, for floating controls positioning) */
+    blockHoverChange: (data: {
+        index: number;
+        element: HTMLElement | null;
+    }) => void;
+    /** Emitted when a block drag starts (block mode), with the dragged block index */
+    blockDragStart: (index: number) => void;
+    /** Emitted when a block drag ends (block mode) */
+    blockDragEnd: () => void;
+    /** Emitted when document headings change (for navigator minimap) */
+    navigatorHeadingsChange: (headings: TextEditorHeadingEntry[]) => void;
+    /** Emitted when the navigator's active heading index changes during scrolling */
+    navigatorActiveIndexChange: (index: number) => void;
+}
+/**
+ * TextEditor component exposed public API methods
+ * @group Methods
+ */
+export interface TextEditorExpose {
+    /** Re-applies the ProseMirror `editable` predicate after `disabled`
+     *  or `readonly` props change. */
+    refreshEditable: () => void;
+    /** Adds/removes the markdown input-rules plugin live after the
+     *  `markdown` prop changes, without remounting. */
+    refreshMarkdown: () => void;
+    /** Serialize the current document to HTML. */
+    getHTML: () => string;
+    /** Serialize as the array-of-block-HTML representation used by block mode. */
+    getBlocks: () => string[];
+    /** ProseMirror document as JSON (loss-less). */
+    getJSON: () => unknown;
+    /** Plain-text projection of the document. */
+    getText: () => string;
+    /** Markdown projection of the document. */
+    getMarkdown: () => string;
+    /** Internal handler for keydown events on the editor element. */
+    onEditorKeyDown: () => void;
+    /** Internal handler for mousedown events on the editor element. */
+    onEditorMouseDown: () => void;
+    /** Filters out files that fail image validation (count, size, type), returning the accepted ones. */
+    validateImageFiles: (files: File[]) => File[];
+    /** Starts uploading the given image files and inserts upload placeholders. */
+    startImageUploads: (files: File[]) => void;
+    /** Cancels any in-progress image uploads and clears the upload UI. */
+    dismissImageUpload: () => void;
+    /** Filters out files that fail document validation (count, size, type), returning the accepted ones. */
+    validateDocumentFiles: (files: File[]) => File[];
+    /** Starts uploading the given document files and inserts upload placeholders. */
+    startDocumentUploads: (files: File[]) => void;
+    /** Cancels any in-progress document uploads and clears the upload UI. */
+    dismissDocumentUpload: () => void;
+    /** Inserts a new empty block immediately after the block at the given index (block mode). */
+    addBlockAfter: (index: number) => void;
+    /** Returns the block type name (e.g. 'paragraph', 'heading') at the given index (block mode). */
+    getBlockType: (index: number) => string;
+    /** Internal handler invoked when a block drag starts (block mode). */
+    onBlockDragStart: (index: number, event: DragEvent) => void;
+    /** Internal handler invoked when a block drag ends (block mode). */
+    onBlockDragEnd: () => void;
+    /** Moves a block from one index to another, reordering the document (block mode). */
+    moveBlock: (fromIndex: number, toIndex: number) => void;
+    /** Returns the full set of imperative editing commands for the editor. */
+    getCommands: () => TextEditorCommands;
+    /** Returns the command set for the block handle menu at the given block index (block mode). */
+    getBlockMenuCommands: (blockIndex: number, onDismiss: () => void) => TextEditorBlockMenuCommands;
+    /** Returns the command set for the slash (`/`) menu at the given block index. */
+    getSlashMenuCommands: (blockIndex: number, onDismiss: () => void) => TextEditorSlashMenuCommands;
+    /** Adds a row to the given table element at the current cursor position. */
+    onTableAddRow: (table: HTMLTableElement) => void;
+    /** Adds a column to the given table element at the current cursor position. */
+    onTableAddColumn: (table: HTMLTableElement) => void;
+    /** Returns the command set for the active table column. */
+    getTableColumnCommands: (colIndex: number, onDismiss: () => void) => TextEditorTableColumnCommands;
+    /** Returns the command set for the active table row. */
+    getTableRowCommands: (rowIndex: number, onDismiss: () => void) => TextEditorTableRowCommands;
+    /** Returns the command set for the active table cell (or multi-cell selection). */
+    getTableCellCommands: (onDismiss: () => void) => TextEditorTableCellCommands;
+    /** Returns the geometry used to position the table editing overlay, or null when not in a table. */
+    getTableOverlayRect: () => TableOverlayRect | null;
+    /** Returns the active table state when the cursor is inside a table, or null otherwise. */
+    getTableActiveState: () => TableActiveState | null;
+    /** Returns true when more than one table cell is currently selected. */
+    getIsMultiCellSelected: () => boolean;
+    /** Returns true when the active cell is a merged cell. */
+    getIsCellMerged: () => boolean;
+    /** Recomputes and emits the table overlay rect (e.g. after layout changes). */
+    updateTableOverlayRect: () => void;
+    /** Returns the command set for the mention popup. */
+    getMentionCommands: (onDismiss: () => void, options?: {
+        filterField?: string;
+        template?: (data: unknown) => string;
+    }) => TextEditorMentionCommands;
+    /** Filters mention items by the given field and filter text. */
+    getFilteredMentionItems: (items: unknown[], filterField?: string, filterText?: string) => unknown[];
+    /** Returns the plain text of the current selection. */
+    getSelectedText: () => string;
+    /** Replaces the current selection with the given content, optionally interpreted as HTML. */
+    replaceSelection: (content: string, asHtml?: boolean) => void;
+    /** Returns the editor's content DOM element, or null before mount. */
+    getEditorElement: () => HTMLElement | null;
+    /** Returns the live ProseMirror EditorView, or null before mount. */
+    getView: () => EditorView | null;
+    /** Returns the current ProseMirror EditorState, or null before mount. */
+    getState: () => EditorState | null;
+    /** Attaches a ProseMirror plugin to the live editor; returns a remover function. */
+    registerProseMirrorPlugin: (plugin: PMPlugin) => () => void;
+    /** Runs a ProseMirror command against the editor; returns whether it applied. */
+    runCommand: (command: PMCommand) => boolean;
+    /** Visually preserves the current selection while focus moves to external UI (e.g. toolbar inputs). */
+    preserveSelection: () => void;
+    /** Points the editor's aria-activedescendant at the active option of an open type-ahead menu. */
+    setComboboxActiveDescendant: (id: string | null) => void;
+    /** Replaces the editor content with the given value (string for classic, string[] for block mode). */
+    setValue: (value: string | string[]) => void;
+    /** Returns all headings in the document, used by the navigator minimap. */
+    getDocumentHeadings: () => TextEditorHeadingEntry[];
+    /** Moves focus to the heading at the given document position. */
+    focusHeading: (pos: number) => void;
+    /** Scrolls the heading at the given position into view. */
+    scrollToHeading: (pos: number, headings: TextEditorHeadingEntry[]) => void;
+    /** Recomputes which heading is currently active based on scroll position. */
+    updateActiveHeading: (headings: TextEditorHeadingEntry[]) => void;
+    /** Internal handler invoked on navigator scroll to sync the active heading. */
+    onNavigatorScroll: (headings: TextEditorHeadingEntry[]) => void;
+}
+/**
+ * Context provided to TextEditor plugins via defineTextEditorPlugin.
+ * @group Interface
+ */
+export interface TextEditorPluginContext<TOptions = unknown> {
+    /** Returns the plain text of the current selection. */
+    getSelectedText: () => string;
+    /** Replaces the current selection with the given content, optionally interpreted as HTML. */
+    replaceSelection: (content: string, asHtml?: boolean) => void;
+    /** Returns the editor's content DOM element, or null before mount. */
+    getEditorElement: () => HTMLElement | null;
+    /** The live ProseMirror EditorView, or null before mount. */
+    getView: () => EditorView | null;
+    /** The current ProseMirror EditorState, or null before mount. */
+    getState: () => EditorState | null;
+    /** Attach a ProseMirror plugin to the live editor; returns a remover. */
+    registerProseMirrorPlugin: (plugin: PMPlugin) => () => void;
+    /** Run a ProseMirror command against the editor. */
+    runCommand: (command: PMCommand) => boolean;
+    /** Options passed to the plugin at registration time. */
+    options?: TOptions;
+    /** Registers a cleanup callback run when the editor unmounts. */
+    onUnmounted: (fn: () => void) => void;
+}
+/**
+ * Return type from a TextEditor plugin's install function.
+ * @group Interface
+ */
+export interface TextEditorPluginExpose {
+    /** Named commands contributed by the plugin, merged into the editor's command surface. */
+    commands?: Record<string, (...args: unknown[]) => unknown>;
+}
+/**
+ * TextEditor component instance with reactive state management and lifecycle methods
+ *
+ * @remarks
+ * This type extends ComponentInstance with TextEditor-specific refs, props, state, emits, and exposed methods.
+ *
+ * @see {@link ComponentInstance} - Base component instance type
+ * @see {@link TextEditorRefs} - TextEditor refs type
+ * @see {@link TextEditorProps} - TextEditor props type
+ * @see {@link TextEditorState} - TextEditor state type
+ * @see {@link TextEditorEmits} - TextEditor emits type
+ * @see {@link TextEditorExpose} - TextEditor exposed methods
+ * @group Types
+ */
+export type TextEditorInstance = ComponentInstance<TextEditorRefs, TextEditorProps, TextEditorState, TextEditorEmits, TextEditorExpose>;
+/**
+ * TextEditor component context for initialization
+ *
+ * @remarks
+ * Used to pass initial values to the TextEditor component.
+ * All properties are optional and will be merged with defaults.
+ *
+ * @see {@link TextEditorInstance} - The component instance type
+ * @see {@link ComponentContext} - Base component context type
+ * @group Types
+ */
+export type TextEditorContext = ComponentContext<TextEditorInstance>;
+/**
+ * Attributes applied to an inserted image element. `alt`, `width`, and
+ * `height` are recognized explicitly; any additional string/number attributes
+ * are passed through to the rendered `<img>` element.
+ */
+export interface ImageAttributes {
+    /** Alternative text for the image (the `alt` attribute). */
+    alt?: string;
+    /** Image width, as a pixel number or CSS length string. */
+    width?: string | number;
+    /** Image height, as a pixel number or CSS length string. */
+    height?: string | number;
+    /** Additional pass-through attributes applied to the rendered `<img>` element. */
+    [key: string]: string | number | undefined;
+}
+/**
+ * Table active state emitted when cursor is inside a table
+ * @group Interface
+ */
+export interface TableActiveState {
+    /** The table element the cursor is currently inside. */
+    table: HTMLTableElement;
+    /** Zero-based column index of the active cell. */
+    colIndex: number;
+    /** Zero-based row index of the active cell. */
+    rowIndex: number;
+    /** Total number of columns in the table. */
+    colCount: number;
+    /** Total number of rows in the table. */
+    rowCount: number;
+}
+/**
+ * Geometry used to position the table editing overlay (resize handles and
+ * trigger dots) relative to the active table and the currently focused cell.
+ * @group Interface
+ */
+export interface TableOverlayRect {
+    /** Bounding rectangle of the table element. */
+    tableRect: DOMRect;
+    /** Bounding rectangle of the currently focused cell. */
+    cellRect: DOMRect;
+    /** Whether the active cell is in the last column. */
+    isLastColumn: boolean;
+    /** Whether the active cell is in the last row. */
+    isLastRow: boolean;
+    /** X positions of the column borders, used to render resize handles. */
+    columnBorders: number[];
+}
+/**
+ * Bounding rectangle of a multi-cell table selection, expressed as inclusive
+ * row and column index ranges.
+ * @group Interface
+ */
+export interface TableSelectionRect {
+    /** Smallest (top-most) row index in the selection. */
+    minRow: number;
+    /** Largest (bottom-most) row index in the selection. */
+    maxRow: number;
+    /** Smallest (left-most) column index in the selection. */
+    minCol: number;
+    /** Largest (right-most) column index in the selection. */
+    maxCol: number;
+}
+/**
+ * Snapshot of the active formatting at the current selection. Each flag
+ * reflects whether a mark/block is applied, plus contextual values such as the
+ * current font, colors, heading level, link state, and undo/redo availability.
+ * Emitted via `formatStateChange` and consumed by toolbars to render active states.
+ * @group Interface
+ */
+export interface TextEditorFormatState {
+    /** Whether bold is applied to the selection. */
+    bold?: boolean;
+    /** Whether italic is applied to the selection. */
+    italic?: boolean;
+    /** Whether underline is applied to the selection. */
+    underline?: boolean;
+    /** Whether strikethrough is applied to the selection. */
+    strikethrough?: boolean;
+    /** Whether subscript is applied to the selection. */
+    subscript?: boolean;
+    /** Whether superscript is applied to the selection. */
+    superscript?: boolean;
+    /** Whether inline code is applied to the selection. */
+    code?: boolean;
+    /** Whether the selection is inside a code block. */
+    codeBlock?: boolean;
+    /** Whether the selection is inside a blockquote. */
+    blockquote?: boolean;
+    /** Current text alignment of the block, or null if mixed/none. */
+    textAlign?: string | null;
+    /** Current font family of the selection, or null if mixed/none. */
+    fontFamily?: string | null;
+    /** Current font size of the selection, or null if mixed/none. */
+    fontSize?: string | null;
+    /** Current text (foreground) color, or null if mixed/none. */
+    foregroundColor?: string | null;
+    /** Current highlight (background) color, or null if mixed/none. */
+    backgroundColor?: string | null;
+    /** Whether a highlight (any background color) is applied to the selection. */
+    highlight?: boolean;
+    /** Current heading level (1–6), or null when not a heading. */
+    heading?: number | null;
+    /** Whether the selection is inside a bullet list. */
+    bulletList?: boolean;
+    /** Whether the selection is inside an ordered list. */
+    orderedList?: boolean;
+    /** Whether the selection is inside a checklist. */
+    checkList?: boolean;
+    /** Whether the selection is within a link. */
+    link?: boolean;
+    /** URL of the active link, or null when not in a link. */
+    linkUrl?: string | null;
+    /** Whether the cursor is inside a table. */
+    inTable?: boolean;
+    /** Whether there is a non-empty text selection. */
+    hasSelection?: boolean;
+    /** Whether the editor currently has focus. */
+    hasFocus?: boolean;
+    /** Whether an undo step is available. */
+    canUndo?: boolean;
+    /** Whether a redo step is available. */
+    canRedo?: boolean;
+    /** Whether an image upload placeholder is present in the document. */
+    hasImageUploadPlaceholder?: boolean;
+    /** Whether a document upload placeholder is present in the document. */
+    hasDocumentUploadPlaceholder?: boolean;
+    /** Whether more than one table cell is selected. */
+    isMultiCellSelected?: boolean;
+    /** Whether the active cell is a merged cell. */
+    isCellMerged?: boolean;
+}
+/**
+ * Formatting state exposed to the toolbar slot. Identical in shape to
+ * {@link TextEditorFormatState}; provided as a distinct name for the toolbar API surface.
+ * @group Interface
+ */
+export interface TextEditorToolbarState extends TextEditorFormatState {
+}
+/**
+ * Imperative formatting and editing commands available on the editor. Covers
+ * inline marks, block types, lists, links, images, tables, history, and the
+ * `turnInto` block-conversion group. Typically obtained via `getCommands()`.
+ */
+export interface TextEditorCommands {
+    /** Toggles bold on the current selection. */
+    bold: () => void;
+    /** Toggles italic on the current selection. */
+    italic: () => void;
+    /** Toggles underline on the current selection. */
+    underline: () => void;
+    /** Toggles strikethrough on the current selection. */
+    strikethrough: () => void;
+    /** Toggles subscript on the current selection. */
+    subscript: () => void;
+    /** Toggles superscript on the current selection. */
+    superscript: () => void;
+    /** Toggles inline code on the current selection. */
+    code: () => void;
+    /** Toggles a default highlight (background color) on the current selection. */
+    highlight: () => void;
+    /** Removes all marks from the selection and resets blocks to paragraphs. */
+    clearFormatting: () => void;
+    /** Toggles the current block between a code block and a paragraph. */
+    codeBlock: () => void;
+    /** Toggles blockquote on the current block. */
+    blockquote: () => void;
+    /** Sets the text alignment of the current block. */
+    textAlign: (alignment: string) => void;
+    /** Sets the font family of the current selection (null clears it). */
+    fontFamily: (fontFamily: string | null) => void;
+    /** Sets the font size of the current selection (null clears it). */
+    fontSize: (fontSize: string | null) => void;
+    /** Sets the text (foreground) color of the current selection (null clears it). */
+    foregroundColor: (color: string | null) => void;
+    /** Sets the highlight (background) color of the current selection (null clears it). */
+    backgroundColor: (color: string | null) => void;
+    /** Converts the current block into a heading of the given level (1–6). */
+    heading: (level: number) => void;
+    /** Converts the current block into a paragraph. */
+    paragraph: () => void;
+    /** Toggles a bullet list on the current block. */
+    bulletList: () => void;
+    /** Toggles an ordered list on the current block. */
+    orderedList: () => void;
+    /** Toggles a checklist on the current block. */
+    checkList: () => void;
+    /** Inserts a link with the given URL (and optional text) at the selection. */
+    insertLink: (url: string, text?: string) => void;
+    /** Updates the URL of the link at the current selection. */
+    updateLink: (url: string) => void;
+    /** Removes the link from the current selection. */
+    removeLink: () => void;
+    /** Opens the link at the current selection in a new browser tab. */
+    openLink: () => void;
+    /** Inserts an image with the given source and optional attributes. */
+    insertImage: (src: string, attrs?: ImageAttributes) => void;
+    /** Opens the image picker / starts the image upload flow. */
+    uploadImages: () => void;
+    /** Opens the document picker / starts the document upload flow. */
+    uploadDocuments: () => void;
+    /** Prints the editor content. */
+    print: () => void;
+    /** Inserts a horizontal rule (divider) at the cursor. */
+    insertHorizontalRule: () => void;
+    /** Inserts a table with the given dimensions and optional placeholder texts. */
+    table: (rows?: number, cols?: number, headerPlaceholder?: string, cellPlaceholder?: string) => void;
+    /** Undoes the last change. */
+    undo: () => void;
+    /** Redoes the last undone change. */
+    redo: () => void;
+    /** Visually preserves the current selection while focus moves to external UI. */
+    preserveSelection: () => void;
+    /** Converts the current block into another block type. */
+    turnInto: {
+        /** Converts the block into a paragraph. */
+        text: () => void;
+        /** Converts the block into a level-1 heading. */
+        heading1: () => void;
+        /** Converts the block into a level-2 heading. */
+        heading2: () => void;
+        /** Converts the block into a level-3 heading. */
+        heading3: () => void;
+        /** Converts the block into a bullet list. */
+        bulletList: () => void;
+        /** Converts the block into an ordered list. */
+        orderedList: () => void;
+        /** Converts the block into a checklist. */
+        checkList: () => void;
+        /** Converts the block into a blockquote. */
+        blockquote: () => void;
+        /** Converts the block into a code block. */
+        codeBlock: () => void;
+    };
+}
+/**
+ * Commands for applying foreground (text) and background (highlight) colors.
+ * Shared base for the block, table column, row, and cell command sets.
+ * @group Interface
+ */
+export interface TextEditorColorCommands {
+    /** Applies the given text (foreground) color. */
+    foregroundColor: (color: string) => void;
+    /** Applies the given highlight (background) color. */
+    backgroundColor: (color: string) => void;
+}
+/**
+ * Commands exposed by the block handle menu (block mode): duplicate, copy,
+ * delete, color, and `turnInto` block-type conversions. Obtained via
+ * `getBlockMenuCommands()`.
+ * @group Interface
+ */
+export interface TextEditorBlockMenuCommands extends TextEditorColorCommands {
+    /** Duplicates the block. */
+    duplicate: () => void;
+    /** Copies the block's content to the clipboard. */
+    copyToClipboard: () => void;
+    /** Deletes the block. */
+    deleteBlock: () => void;
+    /** Converts the block into another block type. */
+    turnInto: {
+        /** Converts the block into a paragraph. */
+        text: () => void;
+        /** Converts the block into a level-1 heading. */
+        heading1: () => void;
+        /** Converts the block into a level-2 heading. */
+        heading2: () => void;
+        /** Converts the block into a level-3 heading. */
+        heading3: () => void;
+        /** Converts the block into a bullet list. */
+        bulletList: () => void;
+        /** Converts the block into an ordered list. */
+        orderedList: () => void;
+        /** Converts the block into a checklist. */
+        checkList: () => void;
+        /** Converts the block into a blockquote. */
+        blockquote: () => void;
+        /** Converts the block into a code block. */
+        codeBlock: () => void;
+    };
+}
+/**
+ * Commands available from the slash (`/`) command menu for inserting or
+ * converting the current block: text, headings, lists, blockquote, code,
+ * divider, uploads, and table. Obtained via `getSlashMenuCommands()`.
+ * @group Interface
+ */
+export interface TextEditorSlashMenuCommands {
+    /** Inserts/converts to a plain text paragraph. */
+    text: () => void;
+    /** Inserts/converts to a heading of the given level (1–6). */
+    heading: (level: number) => void;
+    /** Inserts/converts to a bullet list. */
+    bulletList: () => void;
+    /** Inserts/converts to an ordered list. */
+    orderedList: () => void;
+    /** Inserts/converts to a checklist. */
+    checkList: () => void;
+    /** Inserts/converts to a blockquote. */
+    blockquote: () => void;
+    /** Inserts/converts to a code block. */
+    code: () => void;
+    /** Inserts a horizontal rule (divider). */
+    divider: () => void;
+    /** Opens the image picker / starts the image upload flow. */
+    uploadImages: () => void;
+    /** Opens the document picker / starts the document upload flow. */
+    uploadDocuments: () => void;
+    /** Inserts a table. */
+    table: () => void;
+}
+/**
+ * Commands for the active table column: insert before/after, delete, reorder,
+ * duplicate, align, and color. Obtained via `getTableColumnCommands()`.
+ * @group Interface
+ */
+export interface TextEditorTableColumnCommands extends TextEditorColorCommands {
+    /** Inserts a new column before the active column. */
+    insertBefore: () => void;
+    /** Inserts a new column after the active column. */
+    insertAfter: () => void;
+    /** Deletes the active column. */
+    delete: () => void;
+    /** Moves the active column one position to the left. */
+    moveLeft: () => void;
+    /** Moves the active column one position to the right. */
+    moveRight: () => void;
+    /** Duplicates the active column. */
+    duplicate: () => void;
+    /** Sets the text alignment for the active column. */
+    align: (value: string) => void;
+    /** Toggles the active column between header and body cells. */
+    toggleHeader: () => void;
+}
+/**
+ * Commands for the active table row: insert before/after, delete, reorder,
+ * duplicate, delete the whole table, align, and color. Obtained via
+ * `getTableRowCommands()`.
+ * @group Interface
+ */
+export interface TextEditorTableRowCommands extends TextEditorColorCommands {
+    /** Inserts a new row before the active row. */
+    insertBefore: () => void;
+    /** Inserts a new row after the active row. */
+    insertAfter: () => void;
+    /** Deletes the active row. */
+    delete: () => void;
+    /** Moves the active row one position up. */
+    moveUp: () => void;
+    /** Moves the active row one position down. */
+    moveDown: () => void;
+    /** Duplicates the active row. */
+    duplicate: () => void;
+    /** Deletes the entire table. */
+    deleteTable: () => void;
+    /** Sets the text alignment for the active row. */
+    align: (value: string) => void;
+    /** Toggles the active row between header and body cells. */
+    toggleHeader: () => void;
+}
+/**
+ * Commands for the active table cell (or multi-cell selection): clear contents,
+ * align, merge, split, and color. Obtained via `getTableCellCommands()`.
+ * @group Interface
+ */
+export interface TextEditorTableCellCommands extends TextEditorColorCommands {
+    /** Clears the contents of the active cell(s). */
+    clearContents: () => void;
+    /** Sets the text alignment for the active cell(s). */
+    align: (value: string) => void;
+    /** Merges the selected cells into one. */
+    mergeCells: () => void;
+    /** Splits a merged cell back into individual cells. */
+    splitCell: () => void;
+    /** Toggles the active cell(s) between header and body cells. */
+    toggleHeader: () => void;
+}
+/**
+ * Command for the mention popup: select a mention item, inserting the
+ * corresponding mention chip. Obtained via `getMentionCommands()`.
+ * @group Interface
+ */
+export interface TextEditorMentionCommands {
+    /** Selects a mention item, inserting its mention chip into the document. */
+    select: (data: unknown) => void;
+}
+/**
+ * Controls for a named submenu (e.g. nested toolbar/menu panels): open the
+ * submenu anchored to an element, or close it.
+ * @group Interface
+ */
+export interface TextEditorSubmenu {
+    /** Opens the named submenu anchored to the given element. */
+    open: (name: string, anchor: HTMLElement) => void;
+    /** Closes the submenu. */
+    close: () => void;
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@primeui/texteditor-types",
+  "version": "0.0.1-alpha.1",
+  "author": "PrimeTek Informatics",
+  "description": "Shared TextEditor type definitions for PrimeUI.",
+  "keywords": [
+    "texteditor",
+    "types",
+    "primeui"
+  ],
+  "license": "SEE LICENSE IN LICENSE.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/primefaces/primeui.git",
+    "directory": "packages/components/texteditor/texteditor-types"
+  },
+  "bugs": {
+    "url": "https://github.com/primefaces/primeui/issues"
+  },
+  "main": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts"
+    },
+    "./*": {
+      "types": "./dist/*.types.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@primeui/core": "0.0.1-alpha.1"
+  },
+  "devDependencies": {
+    "prosemirror-state": "^1.4.4",
+    "prosemirror-view": "^1.41.7"
+  },
+  "scripts": {
+    "build": "NODE_ENV=production INPUT_DIR=src/ OUTPUT_DIR=dist/ pnpm run build:package",
+    "build:package": "pnpm run type:check && tsc -p tsconfig.build.json",
+    "type:check": "tsc --noEmit",
+    "dev:link": "pnpm link --global && npm link"
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export type * from './texteditor.types';