@pixerate/editor-react 0.13.0 → 0.15.0

package/dist/index.d.cts

@@ -1,15 +1,18 @@
 import * as _tiptap_core from '@tiptap/core';
 import { Editor } from '@tiptap/core';
-import { Template, ColorGradient, FileImportOptions, RichTextPresetOptions, RichClipboardOptions, HistoryState, HistoryManager, Command, HistoryManagerOptions, FileImportState, FileImportController, FileImportControllerOptions, PromptValues, OutlineSnapshot, OutlineHeading, EditorSlotsMap, CommentStoreSnapshot, CommentStore, TrackChangesSnapshot, TrackedChange, ReviewAuthor } from '@pixerate/editor';
-export { ColorGradient, Command, DirtyTracker, DirtyTrackerOptions, HistoryManager, HistoryManagerOptions, HistoryState, OutlineHeading, OutlineSnapshot, OutlineTreeItem, PromptDiagnostic, PromptValues, RichTextPresetOptions, Template, TemplateVersion, Token, TokenType, VariableFormField, createDirtyTracker, createHistoryManager, defaultIsEqual } from '@pixerate/editor';
+import { Template, ColorGradient, FileImportOptions, RichTextPresetOptions, RichClipboardOptions, HistoryState, HistoryManager, HistoryEntry, Command, MergedExecutionOptions, HistoryMark, HistoryManagerOptions, DirtyTrackerOptions, DirtyTracker, FileImportState, FileImportController, FileImportControllerOptions, PromptValues, OutlineSnapshot, OutlineHeading, EditorSlotsMap, CommentStoreSnapshot, CommentStore, TrackChangesSnapshot, TrackedChange, ReviewAuthor } from '@pixerate/editor';
+export { BindDirtyToHistoryOptions, ColorGradient, Command, DirtyTracker, DirtyTrackerOptions, HistoryDirtyBinding, HistoryEntry, HistoryManager, HistoryManagerOptions, HistoryMark, HistoryState, MergedExecutionOptions, OutlineHeading, OutlineSnapshot, OutlineTreeItem, PromptDiagnostic, PromptValues, RichTextPresetOptions, Template, TemplateVersion, Token, TokenType, VariableFormField, bindDirtyToHistory, createDirtyTracker, createHistoryManager, defaultIsEqual, withoutDirty } from '@pixerate/editor';
 import { UseEditorOptions, EditorContentProps as EditorContentProps$1 } from '@tiptap/react';
+import { HistoryManager as HistoryManager$1 } from '@pixerate/editor/history';
 import { ToolRegistry, AgentToolProvider } from '@pixerate/editor/agent';
 import React__default from 'react';
 import { BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu';
 export { FormulaHints, FormulaHintsProps, SpreadsheetContextMenu, SpreadsheetContextMenuProps, SpreadsheetEditor, SpreadsheetEditorProps, SpreadsheetGroupRow, SpreadsheetGroupRowProps, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor } from './spreadsheet/index.cjs';
 export { ImageEditor, ImageEditorProps, UseImageEditorReturn, useImageEditor } from './image-editor/index.cjs';
+export { CommandPalette, CommandPaletteProps, UseCommandPaletteOptions, UseCommandPaletteResult, UseCommandShortcutsOptions, useCommandPalette, useCommandShortcuts, useRegisterCommands } from './commands/index.cjs';
 import '@pixerate/editor/spreadsheet';
 import '@pixerate/editor/image-editor';
+import '@pixerate/editor/commands';
 
 interface UsePromptEditorProps {
     /**
@@ -144,14 +147,23 @@ declare function useDismissGuard({ isDirty, enabled, onDismiss, }: UseDismissGua
 
 interface UseHistoryResult extends HistoryState {
     manager: HistoryManager;
+    /** History panel rows (undo steps, then redo steps). */
+    entries: HistoryEntry[];
     undo: () => boolean;
     redo: () => boolean;
     clear: () => void;
     execute: (command: Command) => void;
-    executeMerged: (command: Command, options?: {
-        windowMs?: number;
-    }) => void;
+    executeMerged: (command: Command, options?: MergedExecutionOptions) => void;
     batch: (name: string, fn: () => void) => void;
+    /** Undoes / redoes until the entry at `index` is current (`-1` = before all). */
+    goTo: (index: number) => number;
+    /** Captures the current point, e.g. when a drag starts. */
+    mark: () => HistoryMark;
+    /** Takes back every step since `mark` without leaving redo (Escape-cancel). */
+    revertTo: (mark: HistoryMark) => number;
+    /** Joins every merged execute into one step until `endGesture`. */
+    beginGesture: (key: string) => void;
+    endGesture: () => void;
 }
 /**
  * React hook that subscribes to a HistoryManager instance.
@@ -160,6 +172,33 @@ interface UseHistoryResult extends HistoryState {
  */
 declare function useHistory(managerOrOptions?: HistoryManager | HistoryManagerOptions): UseHistoryResult;
 
+interface UseHistoryDirtyOptions<T> extends DirtyTrackerOptions<T> {
+    /** The history whose changes re-check the document. */
+    history: HistoryManager;
+    /** Reads the current document value (the latest function is always used). */
+    getValue: () => T;
+    /** Existing tracker to drive (read on first render only). */
+    tracker?: DirtyTracker<T>;
+}
+interface UseHistoryDirtyResult<T> {
+    /** Whether the document differs from the saved state. Feed it to `useNavigationGuard`. */
+    isDirty: boolean;
+    /** Marks the current document as saved. */
+    markClean: () => void;
+    /** Runs a load / restore without marking the document dirty (re-entrant). */
+    suppress: <R>(fn: () => R) => R;
+    /** Re-checks after a change made outside the history. */
+    refresh: () => boolean;
+    tracker: DirtyTracker<T>;
+}
+/**
+ * Dirty-vs-saved tracking bound to a HistoryManager: undoing back to the saved
+ * state makes the document clean again, selection/viewport changes can be
+ * ignored with `normalize`, and programmatic loads can be wrapped in `suppress`.
+ * Options other than `getValue` and `history` are read on first render only.
+ */
+declare function useHistoryDirty<T>(options: UseHistoryDirtyOptions<T>): UseHistoryDirtyResult<T>;
+
 interface HistoryShortcutsOptions {
     /**
      * Whether the keyboard shortcuts are enabled. Defaults to true.
@@ -179,7 +218,7 @@ interface HistoryShortcutsOptions {
  * Attaches keyboard listeners for Undo (Mod+Z) and Redo (Mod+Shift+Z / Mod+Y).
  * Automatically guards against active text inputs and contenteditable editors.
  */
-declare function useHistoryShortcuts(manager: HistoryManager, options?: HistoryShortcutsOptions): void;
+declare function useHistoryShortcuts(manager: HistoryManager$1, options?: HistoryShortcutsOptions): void;
 
 interface UseFileImportResult extends FileImportState {
     /** Value for `<input type="file" accept={…}>`. */
@@ -370,10 +409,19 @@ declare const CommentsPanel: React__default.FC<CommentsPanelProps>;
 interface ReviewToolbarProps {
     editor: Editor | null;
     className?: string;
+    /**
+     * Show the current change's author and description (e.g. "Alice: Formatted:
+     * Bold"). Defaults to `true`.
+     */
+    showDescription?: boolean;
+    /** Class of the description label. */
+    descriptionClassName?: string;
 }
 /**
- * Toolbar for tracked changes: toggle tracking, step through changes, and
- * accept or reject the current change or all changes.
+ * Toolbar for tracked changes: toggle tracking, step through changes
+ * (insertions, deletions, formatting and block changes, with a description
+ * of the current one), and accept or reject the current change or all
+ * changes.
  */
 declare const ReviewToolbar: React__default.FC<ReviewToolbarProps>;
 
@@ -388,4 +436,4 @@ interface CommentButtonProps {
  */
 declare const CommentButton: React__default.FC<CommentButtonProps>;
 
-export { BubbleMenu, type BubbleMenuProps, CommentButton, type CommentButtonProps, CommentsPanel, type CommentsPanelProps, EditorContent, type EditorContentProps, EditorSlotsProvider, type EditorSlotsProviderProps, type HistoryShortcutsOptions, OutlinePanel, type OutlinePanelProps, ReviewToolbar, type ReviewToolbarProps, TemplateRenderer, type TemplateRendererProps, type UseCommentsResult, type UseDismissGuardOptions, type UseDismissGuardReturn, type UseFileImportResult, type UseHistoryResult, type UseNavigationGuardOptions, type UseNavigationGuardReturn, type UsePromptEditorProps, type UseRichEditorProps, type UseTrackChangesResult, VariableForm, type VariableFormProps, useAgentToolProvider, useComments, useDismissGuard, useEditor, useEditorSlots, useFileImport, useHistory, useHistoryShortcuts, useNavigationGuard, useOutline, usePromptEditor, useTrackChanges };
+export { BubbleMenu, type BubbleMenuProps, CommentButton, type CommentButtonProps, CommentsPanel, type CommentsPanelProps, EditorContent, type EditorContentProps, EditorSlotsProvider, type EditorSlotsProviderProps, type HistoryShortcutsOptions, OutlinePanel, type OutlinePanelProps, ReviewToolbar, type ReviewToolbarProps, TemplateRenderer, type TemplateRendererProps, type UseCommentsResult, type UseDismissGuardOptions, type UseDismissGuardReturn, type UseFileImportResult, type UseHistoryDirtyOptions, type UseHistoryDirtyResult, type UseHistoryResult, type UseNavigationGuardOptions, type UseNavigationGuardReturn, type UsePromptEditorProps, type UseRichEditorProps, type UseTrackChangesResult, VariableForm, type VariableFormProps, useAgentToolProvider, useComments, useDismissGuard, useEditor, useEditorSlots, useFileImport, useHistory, useHistoryDirty, useHistoryShortcuts, useNavigationGuard, useOutline, usePromptEditor, useTrackChanges };

package/dist/index.d.ts

@@ -1,15 +1,18 @@
 import * as _tiptap_core from '@tiptap/core';
 import { Editor } from '@tiptap/core';
-import { Template, ColorGradient, FileImportOptions, RichTextPresetOptions, RichClipboardOptions, HistoryState, HistoryManager, Command, HistoryManagerOptions, FileImportState, FileImportController, FileImportControllerOptions, PromptValues, OutlineSnapshot, OutlineHeading, EditorSlotsMap, CommentStoreSnapshot, CommentStore, TrackChangesSnapshot, TrackedChange, ReviewAuthor } from '@pixerate/editor';
-export { ColorGradient, Command, DirtyTracker, DirtyTrackerOptions, HistoryManager, HistoryManagerOptions, HistoryState, OutlineHeading, OutlineSnapshot, OutlineTreeItem, PromptDiagnostic, PromptValues, RichTextPresetOptions, Template, TemplateVersion, Token, TokenType, VariableFormField, createDirtyTracker, createHistoryManager, defaultIsEqual } from '@pixerate/editor';
+import { Template, ColorGradient, FileImportOptions, RichTextPresetOptions, RichClipboardOptions, HistoryState, HistoryManager, HistoryEntry, Command, MergedExecutionOptions, HistoryMark, HistoryManagerOptions, DirtyTrackerOptions, DirtyTracker, FileImportState, FileImportController, FileImportControllerOptions, PromptValues, OutlineSnapshot, OutlineHeading, EditorSlotsMap, CommentStoreSnapshot, CommentStore, TrackChangesSnapshot, TrackedChange, ReviewAuthor } from '@pixerate/editor';
+export { BindDirtyToHistoryOptions, ColorGradient, Command, DirtyTracker, DirtyTrackerOptions, HistoryDirtyBinding, HistoryEntry, HistoryManager, HistoryManagerOptions, HistoryMark, HistoryState, MergedExecutionOptions, OutlineHeading, OutlineSnapshot, OutlineTreeItem, PromptDiagnostic, PromptValues, RichTextPresetOptions, Template, TemplateVersion, Token, TokenType, VariableFormField, bindDirtyToHistory, createDirtyTracker, createHistoryManager, defaultIsEqual, withoutDirty } from '@pixerate/editor';
 import { UseEditorOptions, EditorContentProps as EditorContentProps$1 } from '@tiptap/react';
+import { HistoryManager as HistoryManager$1 } from '@pixerate/editor/history';
 import { ToolRegistry, AgentToolProvider } from '@pixerate/editor/agent';
 import React__default from 'react';
 import { BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu';
 export { FormulaHints, FormulaHintsProps, SpreadsheetContextMenu, SpreadsheetContextMenuProps, SpreadsheetEditor, SpreadsheetEditorProps, SpreadsheetGroupRow, SpreadsheetGroupRowProps, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor } from './spreadsheet/index.js';
 export { ImageEditor, ImageEditorProps, UseImageEditorReturn, useImageEditor } from './image-editor/index.js';
+export { CommandPalette, CommandPaletteProps, UseCommandPaletteOptions, UseCommandPaletteResult, UseCommandShortcutsOptions, useCommandPalette, useCommandShortcuts, useRegisterCommands } from './commands/index.js';
 import '@pixerate/editor/spreadsheet';
 import '@pixerate/editor/image-editor';
+import '@pixerate/editor/commands';
 
 interface UsePromptEditorProps {
     /**
@@ -144,14 +147,23 @@ declare function useDismissGuard({ isDirty, enabled, onDismiss, }: UseDismissGua
 
 interface UseHistoryResult extends HistoryState {
     manager: HistoryManager;
+    /** History panel rows (undo steps, then redo steps). */
+    entries: HistoryEntry[];
     undo: () => boolean;
     redo: () => boolean;
     clear: () => void;
     execute: (command: Command) => void;
-    executeMerged: (command: Command, options?: {
-        windowMs?: number;
-    }) => void;
+    executeMerged: (command: Command, options?: MergedExecutionOptions) => void;
     batch: (name: string, fn: () => void) => void;
+    /** Undoes / redoes until the entry at `index` is current (`-1` = before all). */
+    goTo: (index: number) => number;
+    /** Captures the current point, e.g. when a drag starts. */
+    mark: () => HistoryMark;
+    /** Takes back every step since `mark` without leaving redo (Escape-cancel). */
+    revertTo: (mark: HistoryMark) => number;
+    /** Joins every merged execute into one step until `endGesture`. */
+    beginGesture: (key: string) => void;
+    endGesture: () => void;
 }
 /**
  * React hook that subscribes to a HistoryManager instance.
@@ -160,6 +172,33 @@ interface UseHistoryResult extends HistoryState {
  */
 declare function useHistory(managerOrOptions?: HistoryManager | HistoryManagerOptions): UseHistoryResult;
 
+interface UseHistoryDirtyOptions<T> extends DirtyTrackerOptions<T> {
+    /** The history whose changes re-check the document. */
+    history: HistoryManager;
+    /** Reads the current document value (the latest function is always used). */
+    getValue: () => T;
+    /** Existing tracker to drive (read on first render only). */
+    tracker?: DirtyTracker<T>;
+}
+interface UseHistoryDirtyResult<T> {
+    /** Whether the document differs from the saved state. Feed it to `useNavigationGuard`. */
+    isDirty: boolean;
+    /** Marks the current document as saved. */
+    markClean: () => void;
+    /** Runs a load / restore without marking the document dirty (re-entrant). */
+    suppress: <R>(fn: () => R) => R;
+    /** Re-checks after a change made outside the history. */
+    refresh: () => boolean;
+    tracker: DirtyTracker<T>;
+}
+/**
+ * Dirty-vs-saved tracking bound to a HistoryManager: undoing back to the saved
+ * state makes the document clean again, selection/viewport changes can be
+ * ignored with `normalize`, and programmatic loads can be wrapped in `suppress`.
+ * Options other than `getValue` and `history` are read on first render only.
+ */
+declare function useHistoryDirty<T>(options: UseHistoryDirtyOptions<T>): UseHistoryDirtyResult<T>;
+
 interface HistoryShortcutsOptions {
     /**
      * Whether the keyboard shortcuts are enabled. Defaults to true.
@@ -179,7 +218,7 @@ interface HistoryShortcutsOptions {
  * Attaches keyboard listeners for Undo (Mod+Z) and Redo (Mod+Shift+Z / Mod+Y).
  * Automatically guards against active text inputs and contenteditable editors.
  */
-declare function useHistoryShortcuts(manager: HistoryManager, options?: HistoryShortcutsOptions): void;
+declare function useHistoryShortcuts(manager: HistoryManager$1, options?: HistoryShortcutsOptions): void;
 
 interface UseFileImportResult extends FileImportState {
     /** Value for `<input type="file" accept={…}>`. */
@@ -370,10 +409,19 @@ declare const CommentsPanel: React__default.FC<CommentsPanelProps>;
 interface ReviewToolbarProps {
     editor: Editor | null;
     className?: string;
+    /**
+     * Show the current change's author and description (e.g. "Alice: Formatted:
+     * Bold"). Defaults to `true`.
+     */
+    showDescription?: boolean;
+    /** Class of the description label. */
+    descriptionClassName?: string;
 }
 /**
- * Toolbar for tracked changes: toggle tracking, step through changes, and
- * accept or reject the current change or all changes.
+ * Toolbar for tracked changes: toggle tracking, step through changes
+ * (insertions, deletions, formatting and block changes, with a description
+ * of the current one), and accept or reject the current change or all
+ * changes.
  */
 declare const ReviewToolbar: React__default.FC<ReviewToolbarProps>;
 
@@ -388,4 +436,4 @@ interface CommentButtonProps {
  */
 declare const CommentButton: React__default.FC<CommentButtonProps>;
 
-export { BubbleMenu, type BubbleMenuProps, CommentButton, type CommentButtonProps, CommentsPanel, type CommentsPanelProps, EditorContent, type EditorContentProps, EditorSlotsProvider, type EditorSlotsProviderProps, type HistoryShortcutsOptions, OutlinePanel, type OutlinePanelProps, ReviewToolbar, type ReviewToolbarProps, TemplateRenderer, type TemplateRendererProps, type UseCommentsResult, type UseDismissGuardOptions, type UseDismissGuardReturn, type UseFileImportResult, type UseHistoryResult, type UseNavigationGuardOptions, type UseNavigationGuardReturn, type UsePromptEditorProps, type UseRichEditorProps, type UseTrackChangesResult, VariableForm, type VariableFormProps, useAgentToolProvider, useComments, useDismissGuard, useEditor, useEditorSlots, useFileImport, useHistory, useHistoryShortcuts, useNavigationGuard, useOutline, usePromptEditor, useTrackChanges };
+export { BubbleMenu, type BubbleMenuProps, CommentButton, type CommentButtonProps, CommentsPanel, type CommentsPanelProps, EditorContent, type EditorContentProps, EditorSlotsProvider, type EditorSlotsProviderProps, type HistoryShortcutsOptions, OutlinePanel, type OutlinePanelProps, ReviewToolbar, type ReviewToolbarProps, TemplateRenderer, type TemplateRendererProps, type UseCommentsResult, type UseDismissGuardOptions, type UseDismissGuardReturn, type UseFileImportResult, type UseHistoryDirtyOptions, type UseHistoryDirtyResult, type UseHistoryResult, type UseNavigationGuardOptions, type UseNavigationGuardReturn, type UsePromptEditorProps, type UseRichEditorProps, type UseTrackChangesResult, VariableForm, type VariableFormProps, useAgentToolProvider, useComments, useDismissGuard, useEditor, useEditorSlots, useFileImport, useHistory, useHistoryDirty, useHistoryShortcuts, useNavigationGuard, useOutline, usePromptEditor, useTrackChanges };