This commit is contained in:
Philipinho
2026-02-01 00:15:58 +00:00
parent d3ca1ed72c
commit 040ad04a27
3 changed files with 143 additions and 52 deletions
@@ -1,5 +1,6 @@
import "@/features/editor/styles/index.css"; import "@/features/editor/styles/index.css";
import { useEffect } from "react"; import "./history-diff.module.css";
import { useEffect, useImperativeHandle, forwardRef, useRef } from "react";
import { EditorContent, useEditor } from "@tiptap/react"; import { EditorContent, useEditor } from "@tiptap/react";
import { mainExtensions } from "@/features/editor/extensions/extensions"; import { mainExtensions } from "@/features/editor/extensions/extensions";
import { Title } from "@mantine/core"; import { Title } from "@mantine/core";
@@ -9,7 +10,11 @@ import { recreateTransform } from "@docmost/editor-ext";
import { DOMSerializer, Node } from "@tiptap/pm/model"; import { DOMSerializer, Node } from "@tiptap/pm/model";
import { ChangeSet, simplifyChanges } from "prosemirror-changeset"; import { ChangeSet, simplifyChanges } from "prosemirror-changeset";
export type DiffCounts = { added: number; deleted: number }; export type DiffCounts = { added: number; deleted: number; total: number };
export type HistoryEditorHandle = {
scrollToChange: (index: number) => void;
};
export interface HistoryEditorProps { export interface HistoryEditorProps {
title: string; title: string;
@@ -19,19 +24,31 @@ export interface HistoryEditorProps {
onDiffCalculated?: (counts: DiffCounts) => void; onDiffCalculated?: (counts: DiffCounts) => void;
} }
export function HistoryEditor({ export const HistoryEditor = forwardRef<HistoryEditorHandle, HistoryEditorProps>(
title, function HistoryEditor(
content, { title, content, previousContent, highlightChanges = true, onDiffCalculated },
previousContent, ref,
highlightChanges = true, ) {
onDiffCalculated, const editor = useEditor({
}: HistoryEditorProps) { extensions: mainExtensions,
const editor = useEditor({ editable: false,
extensions: mainExtensions, });
editable: false, const containerRef = useRef<HTMLDivElement>(null);
}); const changeIndexRef = useRef<number[]>([]);
useEffect(() => { useImperativeHandle(ref, () => ({
scrollToChange: (index: number) => {
if (!containerRef.current || index < 1) return;
const element = containerRef.current.querySelector(
`[data-diff-index="${index}"]`,
);
if (element) {
element.scrollIntoView({ behavior: "smooth", block: "center" });
}
},
}));
useEffect(() => {
if (!editor || !content) return; if (!editor || !content) return;
let decorationSet = DecorationSet.empty; let decorationSet = DecorationSet.empty;
@@ -74,13 +91,16 @@ export function HistoryEditor({
]); ]);
const decorations: Decoration[] = []; const decorations: Decoration[] = [];
let changeIndex = 0;
for (const change of changes) { for (const change of changes) {
if (change.toB > change.fromB) { if (change.toB > change.fromB) {
changeIndex++;
const currentIndex = changeIndex;
let foundSpecialNode: { node: Node; pos: number } | null = null; let foundSpecialNode: { node: Node; pos: number } | null = null;
docNew.nodesBetween(change.fromB, change.toB, (node, pos) => { docNew.nodesBetween(change.fromB, change.toB, (node, pos) => {
if (specialNodeTypes.has(node.type.name)) { if (specialNodeTypes.has(node.type.name)) {
const nodeEnd = pos + node.nodeSize; const nodeEnd = pos + node.nodeSize;
// Only match if change spans the entire node (not just content inside)
if (change.fromB <= pos && change.toB >= nodeEnd) { if (change.fromB <= pos && change.toB >= nodeEnd) {
foundSpecialNode = { node, pos }; foundSpecialNode = { node, pos };
return false; return false;
@@ -94,23 +114,26 @@ export function HistoryEditor({
decorations.push( decorations.push(
Decoration.node(foundSpecialNode.pos, nodeEnd, { Decoration.node(foundSpecialNode.pos, nodeEnd, {
class: "history-diff-node-added", class: "history-diff-node-added",
"data-diff-index": String(currentIndex),
}), }),
); );
} else { } else {
decorations.push( decorations.push(
Decoration.inline(change.fromB, change.toB, { Decoration.inline(change.fromB, change.toB, {
class: "history-diff-added", class: "history-diff-added",
"data-diff-index": String(currentIndex),
}), }),
); );
} }
addedCount += 1; addedCount += 1;
} }
if (change.toA > change.fromA) { if (change.toA > change.fromA) {
changeIndex++;
const currentIndex = changeIndex;
let foundDeletedNode: { node: Node; pos: number } | null = null; let foundDeletedNode: { node: Node; pos: number } | null = null;
docOld.nodesBetween(change.fromA, change.toA, (node, pos) => { docOld.nodesBetween(change.fromA, change.toA, (node, pos) => {
if (specialNodeTypes.has(node.type.name)) { if (specialNodeTypes.has(node.type.name)) {
const nodeEnd = pos + node.nodeSize; const nodeEnd = pos + node.nodeSize;
// Only match if change spans the entire node (not just content inside)
if (change.fromA <= pos && change.toA >= nodeEnd) { if (change.fromA <= pos && change.toA >= nodeEnd) {
foundDeletedNode = { node, pos }; foundDeletedNode = { node, pos };
return false; return false;
@@ -123,6 +146,7 @@ export function HistoryEditor({
Decoration.widget(change.fromB, () => { Decoration.widget(change.fromB, () => {
const wrapper = document.createElement("div"); const wrapper = document.createElement("div");
wrapper.className = "history-diff-node-deleted"; wrapper.className = "history-diff-node-deleted";
wrapper.setAttribute("data-diff-index", String(currentIndex));
const serializer = DOMSerializer.fromSchema(schema); const serializer = DOMSerializer.fromSchema(schema);
const dom = serializer.serializeNode(foundDeletedNode!.node); const dom = serializer.serializeNode(foundDeletedNode!.node);
wrapper.appendChild(dom); wrapper.appendChild(dom);
@@ -140,6 +164,7 @@ export function HistoryEditor({
Decoration.widget(change.fromB, () => { Decoration.widget(change.fromB, () => {
const span = document.createElement("span"); const span = document.createElement("span");
span.className = "history-diff-deleted"; span.className = "history-diff-deleted";
span.setAttribute("data-diff-index", String(currentIndex));
span.textContent = deletedText; span.textContent = deletedText;
return span; return span;
}), }),
@@ -150,6 +175,11 @@ export function HistoryEditor({
} }
} }
changeIndexRef.current = Array.from(
{ length: changeIndex },
(_, i) => i + 1,
);
decorationSet = DecorationSet.create(docNew, decorations); decorationSet = DecorationSet.create(docNew, decorations);
} catch (e) { } catch (e) {
console.error("History diff failed:", e); console.error("History diff failed:", e);
@@ -159,7 +189,8 @@ export function HistoryEditor({
editor.commands.setContent(content); editor.commands.setContent(content);
} }
onDiffCalculated?.({ added: addedCount, deleted: deletedCount }); const total = addedCount + deletedCount;
onDiffCalculated?.({ added: addedCount, deleted: deletedCount, total });
editor.setOptions({ editor.setOptions({
editorProps: { editorProps: {
@@ -170,15 +201,16 @@ export function HistoryEditor({
}); });
}, [title, content, editor, previousContent, highlightChanges]); }, [title, content, editor, previousContent, highlightChanges]);
return ( return (
<div> <div ref={containerRef}>
<Title order={1}>{title}</Title> <Title order={1}>{title}</Title>
{editor && ( {editor && (
<EditorContent <EditorContent
editor={editor} editor={editor}
className={historyClasses.historyEditor} className={historyClasses.historyEditor}
/> />
)} )}
</div> </div>
); );
} },
);
@@ -1,5 +1,16 @@
import { Badge, Group, Paper, ScrollArea, Switch } from "@mantine/core"; import {
import { DiffCounts } from "@/features/page-history/components/history-editor"; ActionIcon,
Badge,
Group,
Paper,
ScrollArea,
Switch,
Text,
} from "@mantine/core";
import {
DiffCounts,
HistoryEditorHandle,
} from "@/features/page-history/components/history-editor";
import HistoryList from "@/features/page-history/components/history-list"; import HistoryList from "@/features/page-history/components/history-list";
import classes from "./history.module.css"; import classes from "./history.module.css";
import { useAtom } from "jotai"; import { useAtom } from "jotai";
@@ -8,7 +19,8 @@ import {
activeHistoryPrevIdAtom, activeHistoryPrevIdAtom,
} from "@/features/page-history/atoms/history-atoms"; } from "@/features/page-history/atoms/history-atoms";
import HistoryView from "@/features/page-history/components/history-view"; import HistoryView from "@/features/page-history/components/history-view";
import { useEffect, useState } from "react"; import { useEffect, useRef, useState } from "react";
import { IconChevronUp, IconChevronDown } from "@tabler/icons-react";
interface Props { interface Props {
pageId: string; pageId: string;
@@ -21,12 +33,34 @@ export default function HistoryModalBody({ pageId }: Props) {
); );
const [highlightChanges, setHighlightChanges] = useState(true); const [highlightChanges, setHighlightChanges] = useState(true);
const [diffCounts, setDiffCounts] = useState<DiffCounts | null>(null); const [diffCounts, setDiffCounts] = useState<DiffCounts | null>(null);
const [currentChangeIndex, setCurrentChangeIndex] = useState(0);
const historyEditorRef = useRef<HistoryEditorHandle>(null);
useEffect(() => { useEffect(() => {
setActiveHistoryId(""); setActiveHistoryId("");
setActiveHistoryPrevId(""); setActiveHistoryPrevId("");
}, [pageId]); }, [pageId]);
useEffect(() => {
setCurrentChangeIndex(0);
}, [activeHistoryId]);
const handlePrevChange = () => {
if (!diffCounts || diffCounts.total === 0) return;
const newIndex =
currentChangeIndex <= 1 ? diffCounts.total : currentChangeIndex - 1;
setCurrentChangeIndex(newIndex);
historyEditorRef.current?.scrollToChange(newIndex);
};
const handleNextChange = () => {
if (!diffCounts || diffCounts.total === 0) return;
const newIndex =
currentChangeIndex >= diffCounts.total ? 1 : currentChangeIndex + 1;
setCurrentChangeIndex(newIndex);
historyEditorRef.current?.scrollToChange(newIndex);
};
return ( return (
<div className={classes.sidebarFlex}> <div className={classes.sidebarFlex}>
<nav className={classes.sidebar}> <nav className={classes.sidebar}>
@@ -40,6 +74,7 @@ export default function HistoryModalBody({ pageId }: Props) {
<div className={classes.sidebarRightSection}> <div className={classes.sidebarRightSection}>
{activeHistoryId && ( {activeHistoryId && (
<HistoryView <HistoryView
ref={historyEditorRef}
historyId={activeHistoryId} historyId={activeHistoryId}
prevHistoryId={activeHistoryPrevId} prevHistoryId={activeHistoryPrevId}
highlightChanges={highlightChanges} highlightChanges={highlightChanges}
@@ -78,6 +113,27 @@ export default function HistoryModalBody({ pageId }: Props) {
checked={highlightChanges} checked={highlightChanges}
onChange={(e) => setHighlightChanges(e.currentTarget.checked)} onChange={(e) => setHighlightChanges(e.currentTarget.checked)}
/> />
{diffCounts && diffCounts.total > 0 && (
<Group gap="xs">
<Text size="sm" c="dimmed">
{currentChangeIndex} of {diffCounts.total}
</Text>
<ActionIcon
variant="subtle"
size="sm"
onClick={handlePrevChange}
>
<IconChevronUp size={16} />
</ActionIcon>
<ActionIcon
variant="subtle"
size="sm"
onClick={handleNextChange}
>
<IconChevronDown size={16} />
</ActionIcon>
</Group>
)}
</Group> </Group>
</Paper> </Paper>
)} )}
@@ -2,8 +2,10 @@ import { usePageHistoryQuery } from "@/features/page-history/queries/page-histor
import { import {
DiffCounts, DiffCounts,
HistoryEditor, HistoryEditor,
HistoryEditorHandle,
} from "@/features/page-history/components/history-editor"; } from "@/features/page-history/components/history-editor";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import { forwardRef } from "react";
interface HistoryProps { interface HistoryProps {
historyId: string; historyId: string;
@@ -12,12 +14,11 @@ interface HistoryProps {
onDiffCalculated?: (counts: DiffCounts) => void; onDiffCalculated?: (counts: DiffCounts) => void;
} }
function HistoryView({ const HistoryView = forwardRef<HistoryEditorHandle, HistoryProps>(
historyId, function HistoryView(
prevHistoryId, { historyId, prevHistoryId, highlightChanges, onDiffCalculated },
highlightChanges, ref,
onDiffCalculated, ) {
}: HistoryProps) {
const { t } = useTranslation(); const { t } = useTranslation();
const { const {
data, data,
@@ -38,19 +39,21 @@ function HistoryView({
return <div>{t("Error fetching page data.")}</div>; return <div>{t("Error fetching page data.")}</div>;
} }
return ( return (
data && ( data && (
<div> <div>
<HistoryEditor <HistoryEditor
content={data.content} ref={ref}
title={data.title} content={data.content}
previousContent={!isErrorPrev ? prevData?.content : undefined} title={data.title}
highlightChanges={highlightChanges} previousContent={!isErrorPrev ? prevData?.content : undefined}
onDiffCalculated={onDiffCalculated} highlightChanges={highlightChanges}
/> onDiffCalculated={onDiffCalculated}
</div> />
) </div>
); )
} );
},
);
export default HistoryView; export default HistoryView;