π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
[WEB-2293] feat: pages version history (#5417)
Aaryan Khandelwala0ed51c84531
diff --git a/apiserver/plane/app/serializers/__init__.py b/apiserver/plane/app/serializers/__init__.pyindex 83981ab53c..618a9ec20f 100644--- a/apiserver/plane/app/serializers/__init__.py+++ b/apiserver/plane/app/serializers/__init__.py@@ -92,6 +92,7 @@ from .page import (SubPageSerializer,PageDetailSerializer,PageVersionSerializer,+ PageVersionDetailSerializer,)from .estimate import (diff --git a/apiserver/plane/app/serializers/page.py b/apiserver/plane/app/serializers/page.pyindex c754bd431c..e7f273d408 100644--- a/apiserver/plane/app/serializers/page.py+++ b/apiserver/plane/app/serializers/page.py@@ -167,7 +167,40 @@ class PageLogSerializer(BaseSerializer):class PageVersionSerializer(BaseSerializer):class Meta:model = PageVersion- fields = "__all__"+ fields = [+ "id",+ "workspace",+ "page",+ "last_saved_at",+ "owned_by",+ "created_at",+ "updated_at",+ "created_by",+ "updated_by",+ ]+ read_only_fields = [+ "workspace",+ "page",+ ]+++class PageVersionDetailSerializer(BaseSerializer):+ class Meta:+ model = PageVersion+ fields = [+ "id",+ "workspace",+ "page",+ "last_saved_at",+ "description_binary",+ "description_html",+ "description_json",+ "owned_by",+ "created_at",+ "updated_at",+ "created_by",+ "updated_by",+ ]read_only_fields = ["workspace","page",diff --git a/apiserver/plane/app/views/page/version.py b/apiserver/plane/app/views/page/version.pyindex 70f6bd978f..995a062636 100644--- a/apiserver/plane/app/views/page/version.py+++ b/apiserver/plane/app/views/page/version.py@@ -5,16 +5,18 @@ from rest_framework.response import Response# Module importsfrom plane.db.models import PageVersionfrom ..base import BaseAPIView-from plane.app.permissions import ProjectEntityPermission-from plane.app.serializers import PageVersionSerializer+from plane.app.serializers import (+ PageVersionSerializer,+ PageVersionDetailSerializer,+)+from plane.app.permissions import allow_permission, ROLEclass PageVersionEndpoint(BaseAPIView):- permission_classes = [- ProjectEntityPermission,- ]-+ @allow_permission(+ allowed_roles=[ROLE.ADMIN, ROLE.MEMBER, ROLE.VIEWER, ROLE.GUEST]+ )def get(self, request, slug, project_id, page_id, pk=None):# Check if pk is providedif pk:@@ -25,7 +27,7 @@ class PageVersionEndpoint(BaseAPIView):pk=pk,)# Serialize the page version- serializer = PageVersionSerializer(page_version)+ serializer = PageVersionDetailSerializer(page_version)return Response(serializer.data, status=status.HTTP_200_OK)# Return all page versionspage_versions = PageVersion.objects.filter(diff --git a/packages/editor/src/core/hooks/use-editor.ts b/packages/editor/src/core/hooks/use-editor.tsindex f9e8fdd609..523c4be0fa 100644--- a/packages/editor/src/core/hooks/use-editor.ts+++ b/packages/editor/src/core/hooks/use-editor.ts@@ -126,8 +126,8 @@ export const useEditor = (props: CustomEditorProps) => {useImperativeHandle(forwardedRef,() => ({- clearEditor: () => {- editorRef.current?.commands.clearContent();+ clearEditor: (emitUpdate = false) => {+ editorRef.current?.commands.clearContent(emitUpdate);},setEditorValue: (content: string) => {editorRef.current?.commands.setContent(content);diff --git a/packages/editor/src/core/types/editor.ts b/packages/editor/src/core/types/editor.tsindex ac804b9b14..b26fac3844 100644--- a/packages/editor/src/core/types/editor.ts+++ b/packages/editor/src/core/types/editor.ts@@ -6,7 +6,7 @@ import { IMentionHighlight, IMentionSuggestion, TDisplayConfig, TEditorCommands,export type EditorReadOnlyRefApi = {getMarkDown: () => string;getHTML: () => string;- clearEditor: () => void;+ clearEditor: (emitUpdate?: boolean) => void;setEditorValue: (content: string) => void;scrollSummary: (marking: IMarking) => void;};diff --git a/packages/types/src/pages.d.ts b/packages/types/src/pages.d.tsindex ea9b8b8ea5..a78ff30568 100644--- a/packages/types/src/pages.d.ts+++ b/packages/types/src/pages.d.ts@@ -48,3 +48,19 @@ export type TPageFilters = {};export type TPageEmbedType = "mention" | "issue";++export type TPageVersion = {+ created_at: string;+ created_by: string;+ deleted_at: string | null;+ description_binary?: string | null;+ description_html?: string | null;+ description_json?: object;+ id: string;+ last_saved_at: string;+ owned_by: string;+ page: string;+ updated_at: string;+ updated_by: string;+ workspace: string;+}\ No newline at end of filediff --git a/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/[pageId]/page.tsx b/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/[pageId]/page.tsxindex 8c96f2bcf8..e9debb2bcf 100644--- a/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/[pageId]/page.tsx+++ b/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/[pageId]/page.tsx@@ -64,7 +64,7 @@ const PageDetailsPage = observer(() => {<><PageHead title={name} /><div className="flex h-full flex-col justify-between">- <div className="h-full w-full flex-shrink-0 flex flex-col overflow-hidden">+ <div className="relative h-full w-full flex-shrink-0 flex flex-col overflow-hidden"><PageRoot page={page} projectId={projectId.toString()} workspaceSlug={workspaceSlug.toString()} /><IssuePeekOverview /></div>diff --git a/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/header.tsx b/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/header.tsxindex c04c6d9448..4cfe11d353 100644--- a/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/header.tsx+++ b/web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/header.tsx@@ -2,7 +2,7 @@import { useState } from "react";import { observer } from "mobx-react";-import { useParams } from "next/navigation";+import { useParams, useSearchParams } from "next/navigation";import { FileText } from "lucide-react";// typesimport { TLogoProps } from "@plane/types";@@ -25,6 +25,7 @@ export interface IPagesHeaderProps {export const PageDetailsHeader = observer(() => {// routerconst { workspaceSlug, pageId } = useParams();+ const searchParams = useSearchParams();// stateconst [isOpen, setIsOpen] = useState(false);// store hooks@@ -55,6 +56,8 @@ export const PageDetailsHeader = observer(() => {}};+ const isVersionHistoryOverlayActive = !!searchParams.get("version");+return (<div className="relative z-10 flex h-[3.75rem] w-full flex-shrink-0 flex-row items-center justify-between gap-x-2 gap-y-4 bg-custom-sidebar-background-100 p-4"><div className="flex w-full flex-grow items-center gap-2 overflow-ellipsis whitespace-nowrap">@@ -157,7 +160,7 @@ export const PageDetailsHeader = observer(() => {</div></div><PageDetailsHeaderExtraActions />- {isContentEditable && (+ {isContentEditable && !isVersionHistoryOverlayActive && (<Buttonvariant="primary"size="sm"diff --git a/web/core/components/pages/editor/header/options-dropdown.tsx b/web/core/components/pages/editor/header/options-dropdown.tsxindex 016ca8eb57..14b352456a 100644--- a/web/core/components/pages/editor/header/options-dropdown.tsx+++ b/web/core/components/pages/editor/header/options-dropdown.tsx@@ -1,8 +1,8 @@"use client";import { observer } from "mobx-react";-import { useParams } from "next/navigation";-import { ArchiveRestoreIcon, Clipboard, Copy, Link, Lock, LockOpen } from "lucide-react";+import { useParams, useRouter } from "next/navigation";+import { ArchiveRestoreIcon, Clipboard, Copy, History, Link, Lock, LockOpen } from "lucide-react";// document editorimport { EditorReadOnlyRefApi, EditorRefApi } from "@plane/editor";// ui@@ -11,6 +11,7 @@ import { ArchiveIcon, CustomMenu, TOAST_TYPE, ToggleSwitch, setToast } from "@plimport { copyTextToClipboard, copyUrlToClipboard } from "@/helpers/string.helper";// hooksimport { usePageFilters } from "@/hooks/use-page-filters";+import { useQueryParams } from "@/hooks/use-query-params";// storeimport { IPage } from "@/store/pages/page";@@ -23,6 +24,8 @@ type Props = {export const PageOptionsDropdown: React.FC<Props> = observer((props) => {const { editorRef, handleDuplicatePage, page, handleSaveDescription } = props;+ // router+ const router = useRouter();// store valuesconst {archived_at,@@ -40,6 +43,8 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {const { workspaceSlug, projectId } = useParams();// page filtersconst { isFullWidth, handleFullWidth } = usePageFilters();+ // update query params+ const { updateQueryParams } = useQueryParams();const handleArchivePage = async () =>await archive().catch(() =>@@ -145,6 +150,19 @@ export const PageOptionsDropdown: React.FC<Props> = observer((props) => {icon: archived_at ? ArchiveRestoreIcon : ArchiveIcon,shouldRender: canCurrentUserArchivePage,},+ {+ key: "version-history",+ action: () => {+ // add query param, version=current to the route+ const updatedRoute = updateQueryParams({+ paramsToAdd: { version: "current" },+ });+ router.push(updatedRoute);+ },+ label: "Version history",+ icon: History,+ shouldRender: true,+ },];return (diff --git a/web/core/components/pages/editor/page-root.tsx b/web/core/components/pages/editor/page-root.tsxindex 7ca023261a..bbb5acf819 100644--- a/web/core/components/pages/editor/page-root.tsx+++ b/web/core/components/pages/editor/page-root.tsx@@ -1,12 +1,23 @@-import { useRef, useState } from "react";+import { useEffect, useRef, useState } from "react";import { observer } from "mobx-react";+import { useSearchParams } from "next/navigation";+// plane editorimport { EditorRefApi, useEditorMarkings } from "@plane/editor";+// plane typesimport { TPage } from "@plane/types";+// plane uiimport { setToast, TOAST_TYPE } from "@plane/ui";-import { PageEditorHeaderRoot, PageEditorBody } from "@/components/pages";+// components+import { PageEditorHeaderRoot, PageEditorBody, PageVersionsOverlay } from "@/components/pages";+// hooksimport { useProjectPages } from "@/hooks/store";import { useAppRouter } from "@/hooks/use-app-router";import { usePageDescription } from "@/hooks/use-page-description";+import { useQueryParams } from "@/hooks/use-query-params";+// services+import { ProjectPageVersionService } from "@/services/page";+const projectPageVersionService = new ProjectPageVersionService();+// storeimport { IPage } from "@/store/pages/page";type TPageRootProps = {@@ -16,34 +27,40 @@ type TPageRootProps = {};export const PageRoot = observer((props: TPageRootProps) => {- // router- const router = useAppRouter();const { projectId, workspaceSlug, page } = props;- const { createPage } = useProjectPages();- const { access, description_html, name } = page;-// statesconst [editorReady, setEditorReady] = useState(false);const [readOnlyEditorReady, setReadOnlyEditorReady] = useState(false);-+ const [sidePeekVisible, setSidePeekVisible] = useState(window.innerWidth >= 768);+ const [isVersionsOverlayOpen, setIsVersionsOverlayOpen] = useState(false);// refsconst editorRef = useRef<EditorRefApi>(null);const readOnlyEditorRef = useRef<EditorRefApi>(null);-+ // router+ const router = useAppRouter();+ // search params+ const searchParams = useSearchParams();+ // store hooks+ const { createPage } = useProjectPages();+ // derived values+ const { access, description_html, name } = page;// editor markings hookconst { markings, updateMarkings } = useEditorMarkings();-- const [sidePeekVisible, setSidePeekVisible] = useState(window.innerWidth >= 768 ? true : false);-// project-description- const { handleDescriptionChange, isDescriptionReady, pageDescriptionYJS, handleSaveDescription } = usePageDescription(- {- editorRef,- page,- projectId,- workspaceSlug,- }- );+ const {+ handleDescriptionChange,+ isDescriptionReady,+ pageDescriptionYJS,+ handleSaveDescription,+ manuallyUpdateDescription,+ } = usePageDescription({+ editorRef,+ page,+ projectId,+ workspaceSlug,+ });+ // update query params+ const { updateQueryParams } = useQueryParams();const handleCreatePage = async (payload: Partial<TPage>) => await createPage(payload);@@ -65,8 +82,48 @@ export const PageRoot = observer((props: TPageRootProps) => {);};+ const version = searchParams.get("version");+ useEffect(() => {+ if (!version) {+ setIsVersionsOverlayOpen(false);+ return;+ }+ setIsVersionsOverlayOpen(true);+ }, [version]);++ const handleCloseVersionsOverlay = () => {+ const updatedRoute = updateQueryParams({+ paramsToRemove: ["version"],+ });+ router.push(updatedRoute);+ };+return (<>+ <PageVersionsOverlay+ activeVersion={version}+ fetchAllVersions={async (pageId) => {+ if (!workspaceSlug || !projectId) return;+ return await projectPageVersionService.fetchAllVersions(+ workspaceSlug.toString(),+ projectId.toString(),+ pageId+ );+ }}+ fetchVersionDetails={async (pageId, versionId) => {+ if (!workspaceSlug || !projectId) return;+ return await projectPageVersionService.fetchVersionById(+ workspaceSlug.toString(),+ projectId.toString(),+ pageId,+ versionId+ );+ }}+ handleRestore={manuallyUpdateDescription}+ isOpen={isVersionsOverlayOpen}+ onClose={handleCloseVersionsOverlay}+ pageId={page.id ?? ""}+ /><PageEditorHeaderRooteditorRef={editorRef}readOnlyEditorRef={readOnlyEditorRef}diff --git a/web/core/components/pages/index.ts b/web/core/components/pages/index.tsindex 13f5cec802..d372f2b89c 100644--- a/web/core/components/pages/index.ts+++ b/web/core/components/pages/index.ts@@ -4,5 +4,6 @@ export * from "./header";export * from "./list";export * from "./loaders";export * from "./modals";+export * from "./version";export * from "./pages-list-main-content";export * from "./pages-list-view";diff --git a/web/core/components/pages/version/editor.tsx b/web/core/components/pages/version/editor.tsxnew file mode 100644index 0000000000..973cb2b459--- /dev/null+++ b/web/core/components/pages/version/editor.tsx@@ -0,0 +1,111 @@+import { observer } from "mobx-react";+import { useParams } from "next/navigation";+// plane editor+import { DocumentReadOnlyEditorWithRef, TDisplayConfig } from "@plane/editor";+// plane types+import { IUserLite, TPageVersion } from "@plane/types";+// plane ui+import { Loader } from "@plane/ui";+// hooks+import { useMember, useMention, usePage, useUser } from "@/hooks/store";+import { usePageFilters } from "@/hooks/use-page-filters";+// plane web hooks+import { useIssueEmbed } from "@/plane-web/hooks/use-issue-embed";++type Props = {+ activeVersion: string | null;+ isCurrentVersionActive: boolean;+ versionDetails: TPageVersion | undefined;+};++export const PagesVersionEditor: React.FC<Props> = observer((props) => {+ const { activeVersion, isCurrentVersionActive, versionDetails } = props;+ // params+ const { workspaceSlug, projectId, pageId } = useParams();+ // store hooks+ const { data: currentUser } = useUser();+ const {+ getUserDetails,+ project: { getProjectMemberIds },+ } = useMember();+ const { description_html } = usePage(pageId.toString() ?? "");+ // derived values+ const projectMemberIds = projectId ? getProjectMemberIds(projectId.toString()) : [];+ const projectMemberDetails = projectMemberIds?.map((id) => getUserDetails(id) as IUserLite);+ // issue-embed+ const { issueEmbedProps } = useIssueEmbed(workspaceSlug?.toString() ?? "", projectId?.toString() ?? "");+ // use-mention+ const { mentionHighlights } = useMention({+ workspaceSlug: workspaceSlug?.toString() ?? "",+ projectId: projectId?.toString() ?? "",+ members: projectMemberDetails,+ user: currentUser ?? undefined,+ });+ // page filters+ const { fontSize, fontStyle } = usePageFilters();++ const displayConfig: TDisplayConfig = {+ fontSize,+ fontStyle,+ };++ if (!isCurrentVersionActive && !versionDetails)+ return (+ <div className="size-full px-5">+ <Loader className="relative space-y-4">+ <Loader.Item width="50%" height="36px" />+ <div className="space-y-2">+ <div className="py-2">+ <Loader.Item width="100%" height="36px" />+ </div>+ <Loader.Item width="80%" height="22px" />+ <div className="relative flex items-center gap-2">+ <Loader.Item width="30px" height="30px" />+ <Loader.Item width="30%" height="22px" />+ </div>+ <div className="py-2">+ <Loader.Item width="60%" height="36px" />+ </div>+ <Loader.Item width="70%" height="22px" />+ <Loader.Item width="30%" height="22px" />+ <div className="relative flex items-center gap-2">+ <Loader.Item width="30px" height="30px" />+ <Loader.Item width="30%" height="22px" />+ </div>+ <div className="py-2">+ <Loader.Item width="50%" height="30px" />+ </div>+ <Loader.Item width="100%" height="22px" />+ <div className="py-2">+ <Loader.Item width="30%" height="30px" />+ </div>+ <Loader.Item width="30%" height="22px" />+ <div className="relative flex items-center gap-2">+ <div className="py-2">+ <Loader.Item width="30px" height="30px" />+ </div>+ <Loader.Item width="30%" height="22px" />+ </div>+ </div>+ </Loader>+ </div>+ );++ return (+ <DocumentReadOnlyEditorWithRef+ id={activeVersion ?? ""}+ initialValue={(isCurrentVersionActive ? description_html : versionDetails?.description_html) ?? "<p></p>"}+ containerClassName="p-0 pb-64 border-none"+ displayConfig={displayConfig}+ editorClassName="pl-10"+ mentionHandler={{+ highlights: mentionHighlights,+ }}+ embedHandler={{+ issue: {+ widgetCallback: issueEmbedProps.widgetCallback,+ },+ }}+ />+ );+});diff --git a/web/core/components/pages/version/index.ts b/web/core/components/pages/version/index.tsnew file mode 100644index 0000000000..8e04e4de9e--- /dev/null+++ b/web/core/components/pages/version/index.ts@@ -0,0 +1,6 @@+export * from "./editor";+export * from "./main-content";+export * from "./root";+export * from "./sidebar-list-item";+export * from "./sidebar-list";+export * from "./sidebar-root";diff --git a/web/core/components/pages/version/main-content.tsx b/web/core/components/pages/version/main-content.tsxnew file mode 100644index 0000000000..5d9d7414af--- /dev/null+++ b/web/core/components/pages/version/main-content.tsx@@ -0,0 +1,114 @@+import { useState } from "react";+import { observer } from "mobx-react";+import useSWR from "swr";+import { TriangleAlert } from "lucide-react";+// plane types+import { TPageVersion } from "@plane/types";+// plane ui+import { Button, setToast, TOAST_TYPE } from "@plane/ui";+// components+import { PagesVersionEditor } from "@/components/pages";+// helpers+import { renderFormattedDate, renderFormattedTime } from "@/helpers/date-time.helper";++type Props = {+ activeVersion: string | null;+ fetchVersionDetails: (pageId: string, versionId: string) => Promise<TPageVersion | undefined>;+ handleClose: () => void;+ handleRestore: (descriptionHTML: string) => Promise<void>;+ pageId: string;+};++export const PageVersionsMainContent: React.FC<Props> = observer((props) => {+ const { activeVersion, fetchVersionDetails, handleClose, handleRestore, pageId } = props;+ // states+ const [isRestoring, setIsRestoring] = useState(false);+ const [isRetrying, setIsRetrying] = useState(false);++ const {+ data: versionDetails,+ error: versionDetailsError,+ mutate: mutateVersionDetails,+ } = useSWR(+ pageId && activeVersion && activeVersion !== "current" ? `PAGE_VERSION_${activeVersion}` : null,+ pageId && activeVersion && activeVersion !== "current" ? () => fetchVersionDetails(pageId, activeVersion) : null+ );++ const isCurrentVersionActive = activeVersion === "current";++ const handleRestoreVersion = async () => {+ setIsRestoring(true);+ await handleRestore(versionDetails?.description_html ?? "<p></p>")+ .then(() => {+ setToast({+ type: TOAST_TYPE.SUCCESS,+ title: "Page version restored.",+ });+ handleClose();+ })+ .catch(() =>+ setToast({+ type: TOAST_TYPE.ERROR,+ title: "Failed to restore page version.",+ })+ )+ .finally(() => setIsRestoring(false));+ };++ const handleRetry = async () => {+ setIsRetrying(true);+ await mutateVersionDetails();+ setIsRetrying(false);+ };++ return (+ <div className="flex-grow flex flex-col">+ {versionDetailsError ? (+ <div className="flex-grow grid place-items-center">+ <div className="flex flex-col items-center gap-4 text-center">+ <span className="flex-shrink-0 grid place-items-center size-11 text-custom-text-300">+ <TriangleAlert className="size-10" />+ </span>+ <div>+ <h6 className="text-lg font-semibold">Something went wrong!</h6>+ <p className="text-sm text-custom-text-300">The version could not be loaded, please try again.</p>+ </div>+ <Button variant="link-primary" onClick={handleRetry} loading={isRetrying}>+ Try again+ </Button>+ </div>+ </div>+ ) : (+ <>+ <div className="min-h-14 py-3 px-5 border-b border-custom-border-200 flex items-center justify-between gap-2">+ <h6 className="text-base font-medium">+ {isCurrentVersionActive+ ? "Current version"+ : versionDetails+ ? `${renderFormattedDate(versionDetails.last_saved_at)} ${renderFormattedTime(versionDetails.last_saved_at)}`+ : "Loading version details"}+ </h6>+ {!isCurrentVersionActive && (+ <Button+ variant="primary"+ size="sm"+ className="flex-shrink-0"+ onClick={handleRestoreVersion}+ loading={isRestoring}+ >+ {isRestoring ? "Restoring" : "Restore"}+ </Button>+ )}+ </div>+ <div className="pt-8 h-full overflow-y-scroll vertical-scrollbar scrollbar-sm">+ <PagesVersionEditor+ activeVersion={activeVersion}+ isCurrentVersionActive={isCurrentVersionActive}+ versionDetails={versionDetails}+ />+ </div>+ </>+ )}+ </div>+ );+});diff --git a/web/core/components/pages/version/root.tsx b/web/core/components/pages/version/root.tsxnew file mode 100644index 0000000000..443053d56d--- /dev/null+++ b/web/core/components/pages/version/root.tsx@@ -0,0 +1,50 @@+// plane types+import { TPageVersion } from "@plane/types";+// components+import { PageVersionsMainContent, PageVersionsSidebarRoot } from "@/components/pages";+// helpers+import { cn } from "@/helpers/common.helper";++type Props = {+ activeVersion: string | null;+ fetchAllVersions: (pageId: string) => Promise<TPageVersion[] | undefined>;+ fetchVersionDetails: (pageId: string, versionId: string) => Promise<TPageVersion | undefined>;+ handleRestore: (descriptionHTML: string) => Promise<void>;+ isOpen: boolean;+ onClose: () => void;+ pageId: string;+};++export const PageVersionsOverlay: React.FC<Props> = (props) => {+ const { activeVersion, fetchAllVersions, fetchVersionDetails, handleRestore, isOpen, onClose, pageId } = props;++ const handleClose = () => {+ onClose();+ };++ return (+ <div+ className={cn(+ "absolute inset-0 z-10 size-full bg-custom-background-100 flex overflow-hidden opacity-0 pointer-events-none transition-opacity",+ {+ "opacity-100 pointer-events-auto": isOpen,+ }+ )}+ >+ <PageVersionsMainContent+ activeVersion={activeVersion}+ fetchVersionDetails={fetchVersionDetails}+ handleClose={handleClose}+ handleRestore={handleRestore}+ pageId={pageId}+ />+ <PageVersionsSidebarRoot+ activeVersion={activeVersion}+ fetchAllVersions={fetchAllVersions}+ handleClose={handleClose}+ isOpen={isOpen}+ pageId={pageId}+ />+ </div>+ );+};diff --git a/web/core/components/pages/version/sidebar-list-item.tsx b/web/core/components/pages/version/sidebar-list-item.tsxnew file mode 100644index 0000000000..9c1c13e0de--- /dev/null+++ b/web/core/components/pages/version/sidebar-list-item.tsx@@ -0,0 +1,48 @@+import { observer } from "mobx-react";+import Link from "next/link";+// plane types+import { TPageVersion } from "@plane/types";+// plane ui+import { Avatar } from "@plane/ui";+// helpers+import { cn } from "@/helpers/common.helper";+import { renderFormattedDate, renderFormattedTime } from "@/helpers/date-time.helper";+// hooks+import { useMember } from "@/hooks/store";++type Props = {+ href: string;+ isActive: boolean;+ version: TPageVersion;+};++export const PlaneVersionsSidebarListItem: React.FC<Props> = observer((props) => {+ const { href, isActive, version } = props;+ // store hooks+ const { getUserDetails } = useMember();+ // derived values+ const ownerDetails = getUserDetails(version.owned_by);++ return (+ <Link+ href={href}+ className={cn("block p-2 rounded-md w-72 hover:bg-custom-background-80 transition-colors", {+ "bg-custom-background-80": isActive,+ })}+ >+ <p className="text-sm font-medium truncate">+ {renderFormattedDate(version.last_saved_at)} {renderFormattedTime(version.last_saved_at)}+ </p>+ <p className="mt-2 flex items-center gap-1 text-xs">+ <Avatar+ src={ownerDetails?.avatar}+ name={ownerDetails?.display_name}+ shape="square"+ size="sm"+ className="flex-shrink-0"+ />+ <span className="text-custom-text-300">{ownerDetails?.display_name}</span>+ </p>+ </Link>+ );+});diff --git a/web/core/components/pages/version/sidebar-list.tsx b/web/core/components/pages/version/sidebar-list.tsxnew file mode 100644index 0000000000..cf276742b0--- /dev/null+++ b/web/core/components/pages/version/sidebar-list.tsx@@ -0,0 +1,99 @@+import { useState } from "react";+import Link from "next/link";+import useSWR from "swr";+import { TriangleAlert } from "lucide-react";+// plane types+import { TPageVersion } from "@plane/types";+// plane ui+import { Button, Loader } from "@plane/ui";+// components+import { PlaneVersionsSidebarListItem } from "@/components/pages";+// helpers+import { cn } from "@/helpers/common.helper";+// hooks+import { useQueryParams } from "@/hooks/use-query-params";++type Props = {+ activeVersion: string | null;+ fetchAllVersions: (pageId: string) => Promise<TPageVersion[] | undefined>;+ isOpen: boolean;+ pageId: string;+};++export const PageVersionsSidebarList: React.FC<Props> = (props) => {+ const { activeVersion, fetchAllVersions, isOpen, pageId } = props;+ // states+ const [isRetrying, setIsRetrying] = useState(false);+ // update query params+ const { updateQueryParams } = useQueryParams();++ const {+ data: versionsList,+ error: versionsListError,+ mutate: mutateVersionsList,+ } = useSWR(+ pageId && isOpen ? `PAGE_VERSIONS_LIST_${pageId}` : null,+ pageId && isOpen ? () => fetchAllVersions(pageId) : null+ );++ const handleRetry = async () => {+ setIsRetrying(true);+ await mutateVersionsList();+ setIsRetrying(false);+ };++ const getVersionLink = (versionID: string) =>+ updateQueryParams({+ paramsToAdd: { version: versionID },+ });++ return (+ <div className="mt-4 px-4 h-full flex flex-col space-y-2 overflow-y-scroll vertical-scrollbar scrollbar-sm">+ <Link+ href={getVersionLink("current")}+ className={cn("block p-2 rounded-md w-72 hover:bg-custom-background-80 transition-colors", {+ "bg-custom-background-80": activeVersion === "current",+ })}+ >+ <p className="text-sm font-medium">Current version</p>+ </Link>+ {versionsListError ? (+ <div className="h-full grid place-items-center">+ <div className="flex flex-col items-center gap-4 text-center">+ <span className="flex-shrink-0 grid place-items-center size-11 text-custom-text-300">+ <TriangleAlert className="size-10" />+ </span>+ <div>+ <h6 className="text-base font-semibold">Something went wrong!</h6>+ <p className="text-xs text-custom-text-300">+ There was a problem while loading previous+ <br />+ versions, please try again.+ </p>+ </div>+ <Button variant="link-primary" onClick={handleRetry} loading={isRetrying}>+ Try again+ </Button>+ </div>+ </div>+ ) : versionsList ? (+ versionsList.map((version) => (+ <PlaneVersionsSidebarListItem+ key={version.id}+ href={getVersionLink(version.id)}+ isActive={activeVersion === version.id}+ version={version}+ />+ ))+ ) : (+ <Loader className="space-y-4">+ <Loader.Item height="56px" />+ <Loader.Item height="56px" />+ <Loader.Item height="56px" />+ <Loader.Item height="56px" />+ <Loader.Item height="56px" />+ </Loader>+ )}+ </div>+ );+};diff --git a/web/core/components/pages/version/sidebar-root.tsx b/web/core/components/pages/version/sidebar-root.tsxnew file mode 100644index 0000000000..793d7fed90--- /dev/null+++ b/web/core/components/pages/version/sidebar-root.tsx@@ -0,0 +1,38 @@+import { X } from "lucide-react";+// plane types+import { TPageVersion } from "@plane/types";+// components+import { PageVersionsSidebarList } from "@/components/pages";++type Props = {+ activeVersion: string | null;+ fetchAllVersions: (pageId: string) => Promise<TPageVersion[] | undefined>;+ handleClose: () => void;+ isOpen: boolean;+ pageId: string;+};++export const PageVersionsSidebarRoot: React.FC<Props> = (props) => {+ const { activeVersion, fetchAllVersions, handleClose, isOpen, pageId } = props;++ return (+ <div className="flex-shrink-0 py-4 border-l border-custom-border-200 flex flex-col">+ <div className="px-6 flex items-center justify-between gap-2">+ <h5 className="text-base font-semibold">Version history</h5>+ <button+ type="button"+ onClick={handleClose}+ className="flex-shrink-0 size-6 grid place-items-center text-custom-text-300 hover:text-custom-text-100 transition-colors"+ >+ <X className="size-4" />+ </button>+ </div>+ <PageVersionsSidebarList+ activeVersion={activeVersion}+ fetchAllVersions={fetchAllVersions}+ isOpen={isOpen}+ pageId={pageId}+ />+ </div>+ );+};diff --git a/web/core/hooks/use-page-description.ts b/web/core/hooks/use-page-description.tsindex f7b467d4d0..4273694505 100644--- a/web/core/hooks/use-page-description.ts+++ b/web/core/hooks/use-page-description.ts@@ -1,20 +1,19 @@import React, { useCallback, useEffect, useState } from "react";import useSWR from "swr";-+// plane editorimport {EditorRefApi,proseMirrorJSONToBinaryString,applyUpdates,generateJSONfromHTMLForDocumentEditor,} from "@plane/editor";-// hooksimport { setToast, TOAST_TYPE } from "@plane/ui";import useAutoSave from "@/hooks/use-auto-save";import useReloadConfirmations from "@/hooks/use-reload-confirmation";-// servicesimport { ProjectPageService } from "@/services/page";+// storeimport { IPage } from "@/store/pages/page";const projectPageService = new ProjectPageService();@@ -183,6 +182,19 @@ export const usePageDescription = (props: Props) => {]);+ const manuallyUpdateDescription = async (descriptionHTML: string) => {+ const { contentJSON, editorSchema } = generateJSONfromHTMLForDocumentEditor(descriptionHTML ?? "<p></p>");+ const yDocBinaryString = proseMirrorJSONToBinaryString(contentJSON, "default", editorSchema);++ try {+ editorRef.current?.clearEditor(true);+ await updateDescription(yDocBinaryString, descriptionHTML ?? "<p></p>");+ await mutateDescriptionYJS();+ } catch (error) {+ console.log("error", error);+ }+ };+useAutoSave(handleSaveDescription);return {@@ -190,5 +202,6 @@ export const usePageDescription = (props: Props) => {isDescriptionReady,pageDescriptionYJS,handleSaveDescription,+ manuallyUpdateDescription,};};diff --git a/web/core/hooks/use-query-params.ts b/web/core/hooks/use-query-params.tsnew file mode 100644index 0000000000..8b689f0cbe--- /dev/null+++ b/web/core/hooks/use-query-params.ts@@ -0,0 +1,39 @@+import { useSearchParams, usePathname } from "next/navigation";++type TParamsToAdd = {+ [key: string]: string;+};++export const useQueryParams = () => {+ // next navigation+ const searchParams = useSearchParams();+ const pathname = usePathname();++ const updateQueryParams = ({+ paramsToAdd = {},+ paramsToRemove = [],+ }: {+ paramsToAdd?: TParamsToAdd;+ paramsToRemove?: string[];+ }) => {+ const currentParams = new URLSearchParams(searchParams.toString());++ // add or update query parameters+ Object.keys(paramsToAdd).forEach((key) => {+ currentParams.set(key, paramsToAdd[key]);+ });++ // remove specified query parameters+ paramsToRemove.forEach((key) => {+ currentParams.delete(key);+ });++ // construct the new route with the updated query parameters+ const newRoute = `${pathname}?${currentParams.toString()}`;+ return newRoute;+ };++ return {+ updateQueryParams,+ };+};diff --git a/web/core/services/page/index.ts b/web/core/services/page/index.tsindex d89b175d63..b25199e7f3 100644--- a/web/core/services/page/index.ts+++ b/web/core/services/page/index.ts@@ -1 +1,2 @@+export * from "./project-page-version.service";export * from "./project-page.service";diff --git a/web/core/services/page/project-page-version.service.ts b/web/core/services/page/project-page-version.service.tsnew file mode 100644index 0000000000..05732e3d22--- /dev/null+++ b/web/core/services/page/project-page-version.service.ts@@ -0,0 +1,33 @@+// plane types+import { TPageVersion } from "@plane/types";+// helpers+import { API_BASE_URL } from "@/helpers/common.helper";+// services+import { APIService } from "@/services/api.service";++export class ProjectPageVersionService extends APIService {+ constructor() {+ super(API_BASE_URL);+ }++ async fetchAllVersions(workspaceSlug: string, projectId: string, pageId: string): Promise<TPageVersion[]> {+ return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/versions/`)+ .then((response) => response?.data)+ .catch((error) => {+ throw error?.response?.data;+ });+ }++ async fetchVersionById(+ workspaceSlug: string,+ projectId: string,+ pageId: string,+ versionId: string+ ): Promise<TPageVersion> {+ return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/pages/${pageId}/versions/${versionId}/`)+ .then((response) => response?.data)+ .catch((error) => {+ throw error?.response?.data;+ });+ }+}