@pixerate/editor 0.59.0 → 0.61.0

package/dist/agent-caret-BmYhQF7L.d.cts

@@ -0,0 +1,106 @@
+import { Extension, Editor } from '@tiptap/core';
+import { PluginKey, Plugin, EditorState, Transaction } from '@tiptap/pm/state';
+import { DecorationSet } from '@tiptap/pm/view';
+
+/**
+ * Inline agent carets: a coloured caret with a name tag at a document position, the agent's
+ * selection highlighted, and the text it just changed tinted for a moment — as collaborators'
+ * cursors look in Google Docs. Decorations, so they follow the text as anyone edits it.
+ *
+ * `typeAgentText` plays an edit out a few characters at a time and still lands it as one undo step.
+ */
+declare const DEFAULT_AGENT_CARET_COLOR = "#8b5cf6";
+declare const DEFAULT_AGENT_CARET_NAME = "Agent";
+interface AgentCaretInput {
+    /** Stable id of the agent (one caret per id). */
+    id: string;
+    /** Name on the caret's tag (default "Agent"). */
+    name?: string;
+    /** CSS colour of the caret, tag and highlights (default violet). */
+    color?: string;
+    /** Selection anchor (document position). */
+    from: number;
+    /** Selection head, where the caret is drawn (default `from`). */
+    to?: number;
+}
+/** A range an agent is typing into, mapped through everyone's edits (see `typeAgentText`). */
+interface TypingSpan {
+    from: number;
+    to: number;
+    /** Someone else changed the document while the agent typed. */
+    foreign: boolean;
+}
+interface AgentCaretState {
+    carets: AgentCaret[];
+    spans: Record<string, TypingSpan>;
+    decorations: DecorationSet;
+}
+declare const agentCaretPluginKey: PluginKey<AgentCaretState>;
+/** The ProseMirror plugin behind `AgentCaret` (one per editor). */
+declare function createAgentCaretPlugin(): Plugin<AgentCaretState>;
+interface AgentCaret {
+    id: string;
+    name: string;
+    color: string;
+    anchor: number;
+    head: number;
+    /** Ranges the agent just changed, tinted until `clearAgentChanges`. */
+    changed: Array<{
+        from: number;
+        to: number;
+    }>;
+}
+/** TipTap extension drawing agent carets. Optional: the helpers below add the plugin when it's missing. */
+declare const AgentCaret: Extension<any, any>;
+/** Adds the agent caret plugin to a mounted editor that wasn't created with `AgentCaret`. */
+declare function ensureAgentCaret(editor: Editor): void;
+/** Shows (or moves) an agent's caret; `from < to` also highlights its selection. */
+declare function setAgentCaret(editor: Editor, caret: AgentCaretInput): void;
+/** Removes one agent's caret, or every agent caret when `id` is omitted. */
+declare function clearAgentCaret(editor: Editor, id?: string): void;
+/** Tints ranges an agent just changed (replacing its previous ones); `[]` clears them. */
+declare function markAgentChanges(editor: Editor, id: string, ranges: Array<{
+    from: number;
+    to: number;
+}>): void;
+/** The agent carets in an editor state (empty when the plugin isn't installed). */
+declare function getAgentCarets(state: EditorState): AgentCaret[];
+/**
+ * A transaction replacing `from..to` with literal text (HTML is not parsed; newlines split
+ * paragraphs), as the rich-text agent tools write it.
+ */
+declare function replaceWithTextTransaction(state: EditorState, from: number, to: number, text: string): Transaction;
+interface AgentTypingOptions {
+    /** Typing speed in characters per second (default 60). */
+    charsPerSecond?: number;
+    /** Longest a single edit takes to type, in ms; longer text types faster (default 1500). */
+    maxDurationMs?: number;
+    /** How long a replaced range stays highlighted before typing starts, in ms (default 250). */
+    selectMs?: number;
+}
+interface TypeAgentTextOptions extends AgentTypingOptions {
+    from: number;
+    to: number;
+    text: string;
+    /** The agent's caret, drawn where it types. */
+    caret: Omit<AgentCaretInput, "from" | "to">;
+    /** Stops typing and leaves the document as it was. */
+    signal?: AbortSignal;
+    /** Waits between frames (default `setTimeout`; injectable for tests). */
+    wait?: (ms: number) => Promise<void>;
+}
+/**
+ * Replaces `from..to` with `text` while the agent's caret types it out, then commits the edit as
+ * ONE undo step (the frames are kept out of history, rolled back and replaced by a single
+ * transaction in the same tick, so the screen never shows the rollback). Without a visible window,
+ * or with `charsPerSecond: Infinity`, the edit applies at once. Returns the inserted range.
+ *
+ * If the signal aborts or the editor is destroyed mid-way, the typed frames are rolled back and
+ * the promise rejects; nothing partial stays in the document.
+ */
+declare function typeAgentText(editor: Editor, options: TypeAgentTextOptions): Promise<{
+    from: number;
+    to: number;
+}>;
+
+export { type AgentTypingOptions as A, DEFAULT_AGENT_CARET_COLOR as D, type TypeAgentTextOptions as T, AgentCaret as a, type AgentCaretInput as b, DEFAULT_AGENT_CARET_NAME as c, agentCaretPluginKey as d, clearAgentCaret as e, createAgentCaretPlugin as f, ensureAgentCaret as g, getAgentCarets as h, markAgentChanges as m, replaceWithTextTransaction as r, setAgentCaret as s, typeAgentText as t };

package/dist/agent-caret-BmYhQF7L.d.ts

@@ -0,0 +1,106 @@
+import { Extension, Editor } from '@tiptap/core';
+import { PluginKey, Plugin, EditorState, Transaction } from '@tiptap/pm/state';
+import { DecorationSet } from '@tiptap/pm/view';
+
+/**
+ * Inline agent carets: a coloured caret with a name tag at a document position, the agent's
+ * selection highlighted, and the text it just changed tinted for a moment — as collaborators'
+ * cursors look in Google Docs. Decorations, so they follow the text as anyone edits it.
+ *
+ * `typeAgentText` plays an edit out a few characters at a time and still lands it as one undo step.
+ */
+declare const DEFAULT_AGENT_CARET_COLOR = "#8b5cf6";
+declare const DEFAULT_AGENT_CARET_NAME = "Agent";
+interface AgentCaretInput {
+    /** Stable id of the agent (one caret per id). */
+    id: string;
+    /** Name on the caret's tag (default "Agent"). */
+    name?: string;
+    /** CSS colour of the caret, tag and highlights (default violet). */
+    color?: string;
+    /** Selection anchor (document position). */
+    from: number;
+    /** Selection head, where the caret is drawn (default `from`). */
+    to?: number;
+}
+/** A range an agent is typing into, mapped through everyone's edits (see `typeAgentText`). */
+interface TypingSpan {
+    from: number;
+    to: number;
+    /** Someone else changed the document while the agent typed. */
+    foreign: boolean;
+}
+interface AgentCaretState {
+    carets: AgentCaret[];
+    spans: Record<string, TypingSpan>;
+    decorations: DecorationSet;
+}
+declare const agentCaretPluginKey: PluginKey<AgentCaretState>;
+/** The ProseMirror plugin behind `AgentCaret` (one per editor). */
+declare function createAgentCaretPlugin(): Plugin<AgentCaretState>;
+interface AgentCaret {
+    id: string;
+    name: string;
+    color: string;
+    anchor: number;
+    head: number;
+    /** Ranges the agent just changed, tinted until `clearAgentChanges`. */
+    changed: Array<{
+        from: number;
+        to: number;
+    }>;
+}
+/** TipTap extension drawing agent carets. Optional: the helpers below add the plugin when it's missing. */
+declare const AgentCaret: Extension<any, any>;
+/** Adds the agent caret plugin to a mounted editor that wasn't created with `AgentCaret`. */
+declare function ensureAgentCaret(editor: Editor): void;
+/** Shows (or moves) an agent's caret; `from < to` also highlights its selection. */
+declare function setAgentCaret(editor: Editor, caret: AgentCaretInput): void;
+/** Removes one agent's caret, or every agent caret when `id` is omitted. */
+declare function clearAgentCaret(editor: Editor, id?: string): void;
+/** Tints ranges an agent just changed (replacing its previous ones); `[]` clears them. */
+declare function markAgentChanges(editor: Editor, id: string, ranges: Array<{
+    from: number;
+    to: number;
+}>): void;
+/** The agent carets in an editor state (empty when the plugin isn't installed). */
+declare function getAgentCarets(state: EditorState): AgentCaret[];
+/**
+ * A transaction replacing `from..to` with literal text (HTML is not parsed; newlines split
+ * paragraphs), as the rich-text agent tools write it.
+ */
+declare function replaceWithTextTransaction(state: EditorState, from: number, to: number, text: string): Transaction;
+interface AgentTypingOptions {
+    /** Typing speed in characters per second (default 60). */
+    charsPerSecond?: number;
+    /** Longest a single edit takes to type, in ms; longer text types faster (default 1500). */
+    maxDurationMs?: number;
+    /** How long a replaced range stays highlighted before typing starts, in ms (default 250). */
+    selectMs?: number;
+}
+interface TypeAgentTextOptions extends AgentTypingOptions {
+    from: number;
+    to: number;
+    text: string;
+    /** The agent's caret, drawn where it types. */
+    caret: Omit<AgentCaretInput, "from" | "to">;
+    /** Stops typing and leaves the document as it was. */
+    signal?: AbortSignal;
+    /** Waits between frames (default `setTimeout`; injectable for tests). */
+    wait?: (ms: number) => Promise<void>;
+}
+/**
+ * Replaces `from..to` with `text` while the agent's caret types it out, then commits the edit as
+ * ONE undo step (the frames are kept out of history, rolled back and replaced by a single
+ * transaction in the same tick, so the screen never shows the rollback). Without a visible window,
+ * or with `charsPerSecond: Infinity`, the edit applies at once. Returns the inserted range.
+ *
+ * If the signal aborts or the editor is destroyed mid-way, the typed frames are rolled back and
+ * the promise rejects; nothing partial stays in the document.
+ */
+declare function typeAgentText(editor: Editor, options: TypeAgentTextOptions): Promise<{
+    from: number;
+    to: number;
+}>;
+
+export { type AgentTypingOptions as A, DEFAULT_AGENT_CARET_COLOR as D, type TypeAgentTextOptions as T, AgentCaret as a, type AgentCaretInput as b, DEFAULT_AGENT_CARET_NAME as c, agentCaretPluginKey as d, clearAgentCaret as e, createAgentCaretPlugin as f, ensureAgentCaret as g, getAgentCarets as h, markAgentChanges as m, replaceWithTextTransaction as r, setAgentCaret as s, typeAgentText as t };