@pixerate/editor 0.24.0 → 0.25.0

package/dist/{track-changes-BK5sVf4_.d.cts → track-changes-D_VAPELi.d.cts}

@@ -28,6 +28,26 @@ interface MentionOptions extends Partial<MentionOptions$1> {
  * Creates atomic inline <span data-type="mention"> nodes with full suggestion support.
  */
 declare const Mention: _tiptap_core.Node<MentionOptions$1<any, _tiptap_extension_mention.MentionNodeAttrs>, any>;
+/** Mention nodes in a document, with their positions (for role pickers). */
+interface MentionNodeInfo {
+    pos: number;
+    id: string;
+    label: string;
+    type?: string;
+    role?: string;
+}
+/** Every mention node of an editor's document, in document order. */
+declare function getMentionNodes(editor: {
+    state: {
+        doc: any;
+    };
+}): MentionNodeInfo[];
+/**
+ * Sets (or with `null` clears) the role of the mention node at `pos`, as one
+ * undoable step. Returns `false` when there is no mention at `pos` or the role
+ * name is invalid.
+ */
+declare function setMentionRoleAt(editor: any, pos: number, role: string | null): boolean;
 /**
  * Helper to configure the Mention extension with preset defaults.
  */
@@ -39,12 +59,18 @@ declare const DELETION_MARK_NAME = "deletion";
 declare const FORMAT_CHANGE_MARK_NAME = "formatChange";
 /** Node attribute recording a tracked block change (type, attributes or wrapping). */
 declare const BLOCK_CHANGE_ATTRIBUTE = "blockChange";
+/**
+ * Attribute of the insertion and deletion marks linking the two ends of a
+ * tracked move: the deletion is where the text moved from, the insertion
+ * where it moved to. Serialized as `data-move-id`.
+ */
+declare const MOVE_ID_ATTRIBUTE = "moveId";
 /**
  * Set this transaction meta to `true` to apply a change without tracking it,
  * e.g. `editor.chain().command(({ tr }) => { tr.setMeta(TRACK_CHANGES_SKIP_META, true); return true; }).setContent(…).run()`.
  */
 declare const TRACK_CHANGES_SKIP_META = "trackChangesSkip";
-type TrackedChangeType = "insertion" | "deletion" | "format" | "block";
+type TrackedChangeType = "insertion" | "deletion" | "format" | "block" | "move";
 /**
  * How tracked content is rendered by serializers:
  * - `accepted` (default): as if every change were accepted (deleted text is
@@ -59,6 +85,11 @@ interface TrackedChangeAttributes {
     authorName: string;
     authorColor: string | null;
     createdAt: number;
+    /**
+     * Insertion/deletion marks only: links a deletion (moved from) and an
+     * insertion (moved to) into one tracked move.
+     */
+    moveId?: string | null;
 }
 /** A serializable mark (`mark.toJSON()`). */
 interface TrackedMark {
@@ -132,6 +163,24 @@ interface TrackedChange {
         current: TrackedBlockSnapshot;
         operation?: TrackedBlockOperation;
     };
+    /**
+     * Moves (`type: "move"`): where the text was moved from (struck through
+     * until accepted) and where it was moved to. `ranges` holds both.
+     */
+    move?: {
+        from: {
+            from: number;
+            to: number;
+        }[];
+        to: {
+            from: number;
+            to: number;
+        }[];
+        /** The moved text at its source. */
+        fromText: string;
+        /** The moved text at its destination. */
+        toText: string;
+    };
 }
 interface TrackChangesSnapshot {
     enabled: boolean;
@@ -172,6 +221,19 @@ interface TrackChangesOptions {
     ignoredMarks: string[];
     /** Node attributes ignored when comparing blocks (e.g. generated ids). */
     ignoredBlockAttributes: string[];
+    /**
+     * Record a cut and paste (or a drag) of the same text as one tracked move
+     * instead of a deletion and an insertion. Default `true`.
+     */
+    trackMoves: boolean;
+    /**
+     * Decides whether moved text is big enough to be a move. Default
+     * `isMoveSized` (a paragraph, or at least a sentence of two words, as in
+     * Word); pass `() => true` to record every cut/paste or drag as a move.
+     */
+    isMove: (text: string) => boolean;
+    /** HTML attributes (e.g. `class`) of moved text, at both ends. Replaces the default green double line. */
+    moveHTMLAttributes: Record<string, any>;
 }
 /**
  * External store over the editor's tracked-change state. Snapshots only
@@ -207,27 +269,39 @@ declare module "@tiptap/core" {
             /** Rejects one change (single undo step). */
             rejectChange: (id: string) => ReturnType;
             acceptAllChanges: () => ReturnType;
+            /** Accepts a tracked move: removes the source, keeps the destination. */
+            acceptMove: (id: string) => ReturnType;
+            /** Rejects a tracked move: restores the source, removes the destination. */
+            rejectMove: (id: string) => ReturnType;
             rejectAllChanges: () => ReturnType;
             /** Selects the next change after the selection, wrapping around. */
             selectNextChange: () => ReturnType;
             /** Selects the previous change before the selection, wrapping around. */
             selectPreviousChange: () => ReturnType;
+            /** Selects a change (a move's destination, a block change's content). */
+            selectChange: (id: string) => ReturnType;
         };
     }
 }
+interface TrackedMarkOptions {
+    HTMLAttributes: Record<string, any>;
+    /** Attributes used instead of `HTMLAttributes` when the mark is one end of a move. */
+    moveHTMLAttributes: Record<string, any>;
+}
+/** Default classes of moved text: green double underline (destination) / strike (source), as in Word. */
+declare const MOVE_TO_CLASS = "pixerate-move-to underline decoration-double decoration-emerald-600 text-emerald-700 dark:text-emerald-400";
+declare const MOVE_FROM_CLASS = "pixerate-move-from line-through decoration-double decoration-emerald-600 text-emerald-700 dark:text-emerald-400";
 /**
- * Text inserted while tracking was on. Rendered as `<ins>`.
+ * Text inserted while tracking was on. Rendered as `<ins>`. With a `moveId`
+ * it is the destination of a tracked move.
  */
-declare const TrackedInsertion: Mark<{
-    HTMLAttributes: Record<string, any>;
-}, any>;
+declare const TrackedInsertion: Mark<TrackedMarkOptions, any>;
 /**
  * Text deleted while tracking was on. The text stays in the document until
- * the change is accepted. Rendered as `<del>` (struck through).
+ * the change is accepted. Rendered as `<del>` (struck through). With a
+ * `moveId` it is the source of a tracked move.
  */
-declare const TrackedDeletion: Mark<{
-    HTMLAttributes: Record<string, any>;
-}, any>;
+declare const TrackedDeletion: Mark<TrackedMarkOptions, any>;
 /**
  * Existing text whose formatting changed while tracking was on. Stores the
  * formatting before and after the change, rendered as
@@ -240,6 +314,8 @@ declare const TrackedFormatChange: Mark<{
 declare function describeFormatChange(summary: TrackedFormatSummary): string;
 /** Describes a block change, e.g. `Changed Paragraph to Heading 2`. */
 declare function describeBlockChange(previous: TrackedBlockSnapshot, current: TrackedBlockSnapshot, ignoredAttributes?: readonly string[]): string;
+/** Short label of a change's type for review UIs (`Moved` for a move). */
+declare function trackedChangeLabel(change: Pick<TrackedChange, "type">): string;
 /**
  * Lists tracked changes in document order. Accepts an editor, an editor
  * state or a ProseMirror document.
@@ -255,17 +331,25 @@ declare function getTrackChangesStore(editor: Editor | null | undefined): TrackC
  * (`accepted` by default). The input document is not modified.
  */
 declare function resolveTrackedChanges(doc: Node, view?: TrackedChangesView): Node;
+/**
+ * Whether moved text is big enough to be recorded as a move rather than a
+ * deletion and an insertion, as in Word: a paragraph (the text holds a
+ * paragraph break) or at least a sentence of two or more words.
+ */
+declare function isMoveSized(text: string): boolean;
 /**
  * Suggestion mode / track changes. When enabled, typed and pasted content is
  * marked as an insertion and deleted content is kept but marked as a
  * deletion (struck through) until the change is accepted or rejected.
  * Formatting changes on existing text are recorded with the `formatChange`
  * mark, and textblock type/attribute/wrapping changes with the `blockChange`
- * node attribute.
+ * node attribute. A cut and paste (or a drag) of a sentence or paragraph is
+ * recorded as a move: a deletion and an insertion linked by `moveId`, listed
+ * as one change and accepted or rejected together.
  *
  * Deleting your own insertion really deletes it. Paragraph splits and joins
  * are not tracked. IME composition is tracked once the composition ends.
  */
 declare const TrackChanges: Extension<TrackChangesOptions, TrackChangesStorage>;
 
-export { isTrackChangesEnabled as A, BLOCK_CHANGE_ATTRIBUTE as B, resolveTrackedChanges as C, DELETION_MARK_NAME as D, trackChangesPluginKey as E, FORMAT_CHANGE_MARK_NAME as F, INSERTION_MARK_NAME as I, Mention as M, TRACK_CHANGES_SKIP_META as T, type MentionEntity as a, type MentionOptions as b, TrackChanges as c, type TrackChangesOptions as d, type TrackChangesSnapshot as e, type TrackChangesStorage as f, TrackChangesStore as g, type TrackedBlockChangeAttributes as h, type TrackedBlockOperation as i, type TrackedBlockSnapshot as j, type TrackedChange as k, type TrackedChangeAttributes as l, type TrackedChangeType as m, type TrackedChangesView as n, TrackedDeletion as o, TrackedFormatChange as p, type TrackedFormatChangeAttributes as q, type TrackedFormatSummary as r, TrackedInsertion as s, type TrackedMark as t, createMentionExtension as u, describeBlockChange as v, describeFormatChange as w, getTrackChangesStore as x, getTrackedChangeAt as y, getTrackedChanges as z };
+export { describeFormatChange as A, BLOCK_CHANGE_ATTRIBUTE as B, getMentionNodes as C, DELETION_MARK_NAME as D, getTrackChangesStore as E, FORMAT_CHANGE_MARK_NAME as F, getTrackedChangeAt as G, getTrackedChanges as H, INSERTION_MARK_NAME as I, isMoveSized as J, isTrackChangesEnabled as K, resolveTrackedChanges as L, MOVE_FROM_CLASS as M, setMentionRoleAt as N, trackChangesPluginKey as O, trackedChangeLabel as P, TRACK_CHANGES_SKIP_META as T, MOVE_ID_ATTRIBUTE as a, MOVE_TO_CLASS as b, Mention as c, type MentionEntity as d, type MentionNodeInfo as e, type MentionOptions as f, TrackChanges as g, type TrackChangesOptions as h, type TrackChangesSnapshot as i, type TrackChangesStorage as j, TrackChangesStore as k, type TrackedBlockChangeAttributes as l, type TrackedBlockOperation as m, type TrackedBlockSnapshot as n, type TrackedChange as o, type TrackedChangeAttributes as p, type TrackedChangeType as q, type TrackedChangesView as r, TrackedDeletion as s, TrackedFormatChange as t, type TrackedFormatChangeAttributes as u, type TrackedFormatSummary as v, TrackedInsertion as w, type TrackedMark as x, createMentionExtension as y, describeBlockChange as z };

package/dist/{track-changes-CDjCrwKe.d.ts → track-changes-Db_fGEvx.d.ts}

@@ -28,6 +28,26 @@ interface MentionOptions extends Partial<MentionOptions$1> {
  * Creates atomic inline <span data-type="mention"> nodes with full suggestion support.
  */
 declare const Mention: _tiptap_core.Node<MentionOptions$1<any, _tiptap_extension_mention.MentionNodeAttrs>, any>;
+/** Mention nodes in a document, with their positions (for role pickers). */
+interface MentionNodeInfo {
+    pos: number;
+    id: string;
+    label: string;
+    type?: string;
+    role?: string;
+}
+/** Every mention node of an editor's document, in document order. */
+declare function getMentionNodes(editor: {
+    state: {
+        doc: any;
+    };
+}): MentionNodeInfo[];
+/**
+ * Sets (or with `null` clears) the role of the mention node at `pos`, as one
+ * undoable step. Returns `false` when there is no mention at `pos` or the role
+ * name is invalid.
+ */
+declare function setMentionRoleAt(editor: any, pos: number, role: string | null): boolean;
 /**
  * Helper to configure the Mention extension with preset defaults.
  */
@@ -39,12 +59,18 @@ declare const DELETION_MARK_NAME = "deletion";
 declare const FORMAT_CHANGE_MARK_NAME = "formatChange";
 /** Node attribute recording a tracked block change (type, attributes or wrapping). */
 declare const BLOCK_CHANGE_ATTRIBUTE = "blockChange";
+/**
+ * Attribute of the insertion and deletion marks linking the two ends of a
+ * tracked move: the deletion is where the text moved from, the insertion
+ * where it moved to. Serialized as `data-move-id`.
+ */
+declare const MOVE_ID_ATTRIBUTE = "moveId";
 /**
  * Set this transaction meta to `true` to apply a change without tracking it,
  * e.g. `editor.chain().command(({ tr }) => { tr.setMeta(TRACK_CHANGES_SKIP_META, true); return true; }).setContent(…).run()`.
  */
 declare const TRACK_CHANGES_SKIP_META = "trackChangesSkip";
-type TrackedChangeType = "insertion" | "deletion" | "format" | "block";
+type TrackedChangeType = "insertion" | "deletion" | "format" | "block" | "move";
 /**
  * How tracked content is rendered by serializers:
  * - `accepted` (default): as if every change were accepted (deleted text is
@@ -59,6 +85,11 @@ interface TrackedChangeAttributes {
     authorName: string;
     authorColor: string | null;
     createdAt: number;
+    /**
+     * Insertion/deletion marks only: links a deletion (moved from) and an
+     * insertion (moved to) into one tracked move.
+     */
+    moveId?: string | null;
 }
 /** A serializable mark (`mark.toJSON()`). */
 interface TrackedMark {
@@ -132,6 +163,24 @@ interface TrackedChange {
         current: TrackedBlockSnapshot;
         operation?: TrackedBlockOperation;
     };
+    /**
+     * Moves (`type: "move"`): where the text was moved from (struck through
+     * until accepted) and where it was moved to. `ranges` holds both.
+     */
+    move?: {
+        from: {
+            from: number;
+            to: number;
+        }[];
+        to: {
+            from: number;
+            to: number;
+        }[];
+        /** The moved text at its source. */
+        fromText: string;
+        /** The moved text at its destination. */
+        toText: string;
+    };
 }
 interface TrackChangesSnapshot {
     enabled: boolean;
@@ -172,6 +221,19 @@ interface TrackChangesOptions {
     ignoredMarks: string[];
     /** Node attributes ignored when comparing blocks (e.g. generated ids). */
     ignoredBlockAttributes: string[];
+    /**
+     * Record a cut and paste (or a drag) of the same text as one tracked move
+     * instead of a deletion and an insertion. Default `true`.
+     */
+    trackMoves: boolean;
+    /**
+     * Decides whether moved text is big enough to be a move. Default
+     * `isMoveSized` (a paragraph, or at least a sentence of two words, as in
+     * Word); pass `() => true` to record every cut/paste or drag as a move.
+     */
+    isMove: (text: string) => boolean;
+    /** HTML attributes (e.g. `class`) of moved text, at both ends. Replaces the default green double line. */
+    moveHTMLAttributes: Record<string, any>;
 }
 /**
  * External store over the editor's tracked-change state. Snapshots only
@@ -207,27 +269,39 @@ declare module "@tiptap/core" {
             /** Rejects one change (single undo step). */
             rejectChange: (id: string) => ReturnType;
             acceptAllChanges: () => ReturnType;
+            /** Accepts a tracked move: removes the source, keeps the destination. */
+            acceptMove: (id: string) => ReturnType;
+            /** Rejects a tracked move: restores the source, removes the destination. */
+            rejectMove: (id: string) => ReturnType;
             rejectAllChanges: () => ReturnType;
             /** Selects the next change after the selection, wrapping around. */
             selectNextChange: () => ReturnType;
             /** Selects the previous change before the selection, wrapping around. */
             selectPreviousChange: () => ReturnType;
+            /** Selects a change (a move's destination, a block change's content). */
+            selectChange: (id: string) => ReturnType;
         };
     }
 }
+interface TrackedMarkOptions {
+    HTMLAttributes: Record<string, any>;
+    /** Attributes used instead of `HTMLAttributes` when the mark is one end of a move. */
+    moveHTMLAttributes: Record<string, any>;
+}
+/** Default classes of moved text: green double underline (destination) / strike (source), as in Word. */
+declare const MOVE_TO_CLASS = "pixerate-move-to underline decoration-double decoration-emerald-600 text-emerald-700 dark:text-emerald-400";
+declare const MOVE_FROM_CLASS = "pixerate-move-from line-through decoration-double decoration-emerald-600 text-emerald-700 dark:text-emerald-400";
 /**
- * Text inserted while tracking was on. Rendered as `<ins>`.
+ * Text inserted while tracking was on. Rendered as `<ins>`. With a `moveId`
+ * it is the destination of a tracked move.
  */
-declare const TrackedInsertion: Mark<{
-    HTMLAttributes: Record<string, any>;
-}, any>;
+declare const TrackedInsertion: Mark<TrackedMarkOptions, any>;
 /**
  * Text deleted while tracking was on. The text stays in the document until
- * the change is accepted. Rendered as `<del>` (struck through).
+ * the change is accepted. Rendered as `<del>` (struck through). With a
+ * `moveId` it is the source of a tracked move.
  */
-declare const TrackedDeletion: Mark<{
-    HTMLAttributes: Record<string, any>;
-}, any>;
+declare const TrackedDeletion: Mark<TrackedMarkOptions, any>;
 /**
  * Existing text whose formatting changed while tracking was on. Stores the
  * formatting before and after the change, rendered as
@@ -240,6 +314,8 @@ declare const TrackedFormatChange: Mark<{
 declare function describeFormatChange(summary: TrackedFormatSummary): string;
 /** Describes a block change, e.g. `Changed Paragraph to Heading 2`. */
 declare function describeBlockChange(previous: TrackedBlockSnapshot, current: TrackedBlockSnapshot, ignoredAttributes?: readonly string[]): string;
+/** Short label of a change's type for review UIs (`Moved` for a move). */
+declare function trackedChangeLabel(change: Pick<TrackedChange, "type">): string;
 /**
  * Lists tracked changes in document order. Accepts an editor, an editor
  * state or a ProseMirror document.
@@ -255,17 +331,25 @@ declare function getTrackChangesStore(editor: Editor | null | undefined): TrackC
  * (`accepted` by default). The input document is not modified.
  */
 declare function resolveTrackedChanges(doc: Node, view?: TrackedChangesView): Node;
+/**
+ * Whether moved text is big enough to be recorded as a move rather than a
+ * deletion and an insertion, as in Word: a paragraph (the text holds a
+ * paragraph break) or at least a sentence of two or more words.
+ */
+declare function isMoveSized(text: string): boolean;
 /**
  * Suggestion mode / track changes. When enabled, typed and pasted content is
  * marked as an insertion and deleted content is kept but marked as a
  * deletion (struck through) until the change is accepted or rejected.
  * Formatting changes on existing text are recorded with the `formatChange`
  * mark, and textblock type/attribute/wrapping changes with the `blockChange`
- * node attribute.
+ * node attribute. A cut and paste (or a drag) of a sentence or paragraph is
+ * recorded as a move: a deletion and an insertion linked by `moveId`, listed
+ * as one change and accepted or rejected together.
  *
  * Deleting your own insertion really deletes it. Paragraph splits and joins
  * are not tracked. IME composition is tracked once the composition ends.
  */
 declare const TrackChanges: Extension<TrackChangesOptions, TrackChangesStorage>;
 
-export { isTrackChangesEnabled as A, BLOCK_CHANGE_ATTRIBUTE as B, resolveTrackedChanges as C, DELETION_MARK_NAME as D, trackChangesPluginKey as E, FORMAT_CHANGE_MARK_NAME as F, INSERTION_MARK_NAME as I, Mention as M, TRACK_CHANGES_SKIP_META as T, type MentionEntity as a, type MentionOptions as b, TrackChanges as c, type TrackChangesOptions as d, type TrackChangesSnapshot as e, type TrackChangesStorage as f, TrackChangesStore as g, type TrackedBlockChangeAttributes as h, type TrackedBlockOperation as i, type TrackedBlockSnapshot as j, type TrackedChange as k, type TrackedChangeAttributes as l, type TrackedChangeType as m, type TrackedChangesView as n, TrackedDeletion as o, TrackedFormatChange as p, type TrackedFormatChangeAttributes as q, type TrackedFormatSummary as r, TrackedInsertion as s, type TrackedMark as t, createMentionExtension as u, describeBlockChange as v, describeFormatChange as w, getTrackChangesStore as x, getTrackedChangeAt as y, getTrackedChanges as z };
+export { describeFormatChange as A, BLOCK_CHANGE_ATTRIBUTE as B, getMentionNodes as C, DELETION_MARK_NAME as D, getTrackChangesStore as E, FORMAT_CHANGE_MARK_NAME as F, getTrackedChangeAt as G, getTrackedChanges as H, INSERTION_MARK_NAME as I, isMoveSized as J, isTrackChangesEnabled as K, resolveTrackedChanges as L, MOVE_FROM_CLASS as M, setMentionRoleAt as N, trackChangesPluginKey as O, trackedChangeLabel as P, TRACK_CHANGES_SKIP_META as T, MOVE_ID_ATTRIBUTE as a, MOVE_TO_CLASS as b, Mention as c, type MentionEntity as d, type MentionNodeInfo as e, type MentionOptions as f, TrackChanges as g, type TrackChangesOptions as h, type TrackChangesSnapshot as i, type TrackChangesStorage as j, TrackChangesStore as k, type TrackedBlockChangeAttributes as l, type TrackedBlockOperation as m, type TrackedBlockSnapshot as n, type TrackedChange as o, type TrackedChangeAttributes as p, type TrackedChangeType as q, type TrackedChangesView as r, TrackedDeletion as s, TrackedFormatChange as t, type TrackedFormatChangeAttributes as u, type TrackedFormatSummary as v, TrackedInsertion as w, type TrackedMark as x, createMentionExtension as y, describeBlockChange as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixerate/editor",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "description": "UI-agnostic rich text and media editing core library",
   "author": "Pixerate",
   "license": "MIT",
@@ -78,6 +78,11 @@
       "types": "./dist/compare/index.d.ts",
       "import": "./dist/compare/index.js",
       "require": "./dist/compare/index.cjs"
+    },
+    "./tokens": {
+      "types": "./dist/tokens/index.d.ts",
+      "import": "./dist/tokens/index.js",
+      "require": "./dist/tokens/index.cjs"
     }
   },
   "files": [