fix: add lock unlock archive restore realtime sync

live/src/core/hocuspocus-server.ts

@@ -4,6 +4,10 @@ import { v4 as uuidv4 } from "uuid";
 import { handleAuthentication } from "@/core/lib/authentication.js";
 // extensions
 import { getExtensions } from "@/core/extensions/index.js";
+import {
+  DocumentEventResponses,
+  TDocumentEventsServer,
+} from "@plane/editor/lib";
 
 export const getHocusPocusServer = async () => {
   const extensions = await getExtensions();
@@ -31,6 +35,12 @@ export const getHocusPocusServer = async () => {
         throw Error("Authentication unsuccessful!");
       }
     },
+    async onStateless({ payload, document }) {
+      const response = DocumentEventResponses[payload as TDocumentEventsServer];
+      if (response) {
+        document.broadcastStateless(response);
+      }
+    },
     extensions,
     debounce: 10000,
   });

packages/editor/src/core/components/editors/document/collaborative-editor.tsx

@@ -14,6 +14,7 @@ import { EditorRefApi, ICollaborativeDocumentEditor } from "@/types";
 
 const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {
   const {
+    socket,
     aiHandler,
     containerClassName,
     disabledExtensions,
@@ -47,6 +48,7 @@ const CollaborativeDocumentEditor = (props: ICollaborativeDocumentEditor) => {
     editorClassName,
     embedHandler,
     extensions,
+    socket,
     fileHandler,
     forwardedRef,
     handleEditorReady,

packages/editor/src/core/extensions/custom-image/components/image-block.tsx

@@ -116,7 +116,6 @@ export const CustomImageBlock: React.FC<CustomImageBlockProps> = (props) => {
         height: `${Math.round(initialHeight)}px` satisfies Pixel,
         aspectRatio: aspectRatioCalculated,
       };
-
       setSize(initialComputedSize);
       updateAttributesSafely(
         initialComputedSize,

packages/editor/src/core/helpers/document-events.ts

@@ -0,0 +1,6 @@
+export enum DocumentEventResponses {
+  Lock = "locked",
+  Unlock = "unlocked",
+  Archive = "archived",
+  Unarchive = "unarchived",
+}

packages/editor/src/core/hooks/use-collaborative-editor.ts

@@ -1,4 +1,4 @@
-import { useEffect, useLayoutEffect, useMemo, useState } from "react";
+import { useEffect, useLayoutEffect, useMemo, useRef, useState } from "react";
 import { HocuspocusProvider } from "@hocuspocus/provider";
 import Collaboration from "@tiptap/extension-collaboration";
 import { IndexeddbPersistence } from "y-indexeddb";
@@ -28,6 +28,7 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {
     serverHandler,
     tabIndex,
     user,
+    socket,
   } = props;
   // states
   const [hasServerConnectionFailed, setHasServerConnectionFailed] = useState(false);
@@ -36,11 +37,12 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {
   const provider = useMemo(
     () =>
       new HocuspocusProvider({
+        websocketProvider: socket,
         name: id,
-        parameters: realtimeConfig.queryParams,
+        // parameters: realtimeConfig.queryParams,
         // using user id as a token to verify the user on the server
         token: user.id,
-        url: realtimeConfig.url,
+        // url: realtimeConfig.url,
         onAuthenticationFailed: () => {
           serverHandler?.onServerError?.();
           setHasServerConnectionFailed(true);
@@ -57,14 +59,15 @@ export const useCollaborativeEditor = (props: TCollaborativeEditorProps) => {
     [id, realtimeConfig, serverHandler, user.id]
   );
 
-  // destroy and disconnect connection on unmount
-  useEffect(
-    () => () => {
-      provider.destroy();
-      provider.disconnect();
-    },
-    [provider]
-  );
+  // // destroy and disconnect connection on unmount
+  // useEffect(
+  //   () => () => {
+  //     provider.destroy();
+  //     provider.disconnect();
+  //   },
+  //   [provider]
+  // );
+
   // indexed db integration for offline support
   useLayoutEffect(() => {
     const localProvider = new IndexeddbPersistence(id, provider.document);

packages/editor/src/core/hooks/use-editor.ts

@@ -16,7 +16,14 @@ import { IMarking, scrollSummary } from "@/helpers/scroll-to-node";
 // props
 import { CoreEditorProps } from "@/props";
 // types
-import { EditorRefApi, IMentionHighlight, IMentionSuggestion, TEditorCommands, TFileHandler } from "@/types";
+import type {
+  TDocumentEventsServer,
+  EditorRefApi,
+  IMentionHighlight,
+  IMentionSuggestion,
+  TEditorCommands,
+  TFileHandler,
+} from "@/types";
 
 export interface CustomEditorProps {
   editorClassName: string;
@@ -55,9 +62,9 @@ export const useEditor = (props: CustomEditorProps) => {
     mentionHandler,
     onChange,
     placeholder,
-    provider,
     tabIndex,
     value,
+    provider,
   } = props;
   // states
 
@@ -236,7 +243,7 @@ export const useEditor = (props: CustomEditorProps) => {
         if (empty) return null;
 
         const nodesArray: string[] = [];
-        state.doc.nodesBetween(from, to, (node, pos, parent) => {
+        state.doc.nodesBetween(from, to, (node, _pos, parent) => {
           if (parent === state.doc && editorRef.current) {
             const serializer = DOMSerializer.fromSchema(editorRef.current?.schema);
             const dom = serializer.serializeNode(node);
@@ -277,6 +284,8 @@ export const useEditor = (props: CustomEditorProps) => {
         if (!document) return;
         Y.applyUpdate(document, value);
       },
+      emitRealTimeUpdate: (message: TDocumentEventsServer) => provider?.sendStateless(message),
+      listenToRealTimeUpdate: () => provider,
     }),
     [editorRef, savedSelection]
   );

packages/editor/src/core/hooks/use-read-only-collaborative-editor.ts

@@ -47,8 +47,9 @@ export const useReadOnlyCollaborativeEditor = (props: TReadOnlyCollaborativeEdit
         },
         onSynced: () => setHasServerSynced(true),
       }),
-    [id, realtimeConfig, user.id]
+    [id, realtimeConfig, serverHandler, user.id]
   );
+
   // destroy and disconnect connection on unmount
   useEffect(
     () => () => {

packages/editor/src/core/hooks/use-read-only-editor.ts

@@ -11,7 +11,7 @@ import { IMarking, scrollSummary } from "@/helpers/scroll-to-node";
 // props
 import { CoreReadOnlyEditorProps } from "@/props";
 // types
-import { EditorReadOnlyRefApi, IMentionHighlight, TFileHandler } from "@/types";
+import { EditorReadOnlyRefApi, IMentionHighlight, TDocumentEventsServer, TFileHandler } from "@/types";
 
 interface CustomReadOnlyEditorProps {
   initialValue?: string;
@@ -117,6 +117,8 @@ export const useReadOnlyEditor = (props: CustomReadOnlyEditorProps) => {
         editorRef.current?.off("update");
       };
     },
+    emitRealTimeUpdate: (message: TDocumentEventsServer) => provider?.sendStateless(message),
+    listenToRealTimeUpdate: () => provider,
     getHeadings: () => editorRef?.current?.storage.headingList.headings,
   }));
 

packages/editor/src/core/types/collaboration.ts

@@ -13,6 +13,7 @@ import {
   TRealtimeConfig,
   TUserDetails,
 } from "@/types";
+import { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
 
 export type TServerHandler = {
   onConnect?: () => void;
@@ -41,6 +42,7 @@ export type TCollaborativeEditorProps = TCollaborativeEditorHookProps & {
   forwardedRef?: React.MutableRefObject<EditorRefApi | null>;
   placeholder?: string | ((isFocused: boolean, value: string) => string);
   tabIndex?: number;
+  socket?: HocuspocusProviderWebsocket;
 };
 
 export type TReadOnlyCollaborativeEditorProps = TCollaborativeEditorHookProps & {

packages/editor/src/core/types/document-events.ts

@@ -0,0 +1,4 @@
+import { DocumentEventResponses } from "@/helpers/document-events";
+
+export type TDocumentEventsServer = keyof typeof DocumentEventResponses;
+export type TDocumentEventsClient = `${DocumentEventResponses}`;

packages/editor/src/core/types/editor.ts

@@ -14,7 +14,11 @@ import {
   TFileHandler,
   TNonColorEditorCommands,
   TServerHandler,
+  TDocumentEventsServer,
 } from "@/types";
+
+import { HocuspocusProvider, HocuspocusProviderWebsocket } from "@hocuspocus/provider";
+
 // editor refs
 export type EditorReadOnlyRefApi = {
   getMarkDown: () => string;
@@ -31,8 +35,8 @@ export type EditorReadOnlyRefApi = {
     paragraphs: number;
     words: number;
   };
-  onHeadingChange: (callback: (headings: IMarking[]) => void) => () => void;
-  getHeadings: () => IMarking[];
+  emitRealTimeUpdate: (message: TDocumentEventsServer) => void;
+  listenToRealTimeUpdate: () => HocuspocusProvider;
 };
 
 export interface EditorRefApi extends EditorReadOnlyRefApi {
@@ -101,6 +105,7 @@ export interface ICollaborativeDocumentEditor
   realtimeConfig: TRealtimeConfig;
   serverHandler?: TServerHandler;
   user: TUserDetails;
+  socket: HocuspocusProviderWebsocket;
 }
 
 // read only editor props

packages/editor/src/core/types/index.ts

@@ -8,3 +8,4 @@ export * from "./image";
 export * from "./mention-suggestion";
 export * from "./slash-commands-suggestion";
 export * from "@/plane-editor/types";
+export * from "./document-events";

packages/editor/src/lib.ts

@@ -1 +1,3 @@
 export * from "@/extensions/core-without-props";
+export * from "@/helpers/document-events";
+export * from "@/types/document-events";

packages/ui/src/icons/index.ts

@@ -1,3 +1,4 @@
+export type { ISvgIcons } from "./type";
 export * from "./cycle";
 export * from "./module";
 export * from "./state";
@@ -31,4 +32,4 @@ export * from "./favorite-folder-icon";
 export * from "./planned-icon";
 export * from "./in-progress-icon";
 export * from "./done-icon";
-export * from "./pending-icon";
+export * from "./pending-icon";

web/app/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/pages/(detail)/[pageId]/page.tsx

@@ -1,5 +1,6 @@
 "use client";
 
+import { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
 import { observer } from "mobx-react";
 import Link from "next/link";
 import { useParams } from "next/navigation";

web/core/components/pages/editor/editor-body.tsx

@@ -1,4 +1,5 @@
-import { useCallback, useMemo } from "react";
+import { useCallback, useMemo, useState } from "react";
+import { HocuspocusProviderWebsocket } from "@hocuspocus/provider";
 import { observer } from "mobx-react";
 import { useParams } from "next/navigation";
 // document-editor
@@ -35,6 +36,7 @@ import { useIssueEmbed } from "@/plane-web/hooks/use-issue-embed";
 import { FileService } from "@/services/file.service";
 // store
 import { IPage } from "@/store/pages/page";
+import { getSocketConnection } from "./socket";
 
 // services init
 const fileService = new FileService();
@@ -123,7 +125,7 @@ export const PageEditorBody: React.FC<Props> = observer((props) => {
       onConnect: handleServerConnect,
       onServerError: handleServerError,
     }),
-    []
+    [handleServerConnect, handleServerError]
   );
 
   const realtimeConfig: TRealtimeConfig | undefined = useMemo(() => {
@@ -151,6 +153,9 @@ export const PageEditorBody: React.FC<Props> = observer((props) => {
 
   if (pageId === undefined || !realtimeConfig) return <PageContentLoader />;
 
+  const socket = useMemo(() => getSocketConnection(realtimeConfig, currentUser?.id), [realtimeConfig]);
+  console.log("socket connection", socket);
+
   return (
     <div className="flex items-center h-full w-full overflow-y-auto">
       <Row
@@ -181,6 +186,7 @@ export const PageEditorBody: React.FC<Props> = observer((props) => {
           </div>
           {isContentEditable ? (
             <CollaborativeDocumentEditorWithRef
+              socket={socket as HocuspocusProviderWebsocket}
               id={pageId}
               fileHandler={getEditorFileHandlers({
                 maxFileSize,