[WIKI-511] [WIKI-572] fix: extended page root and editor body (#7661)

* fix: better refactoring of page root and editor body

* fix: editor sideeffects

* fix: add comments json field

* fix: props name

* fix: review changes

* fix: extra checks

* fix: type changes

* fix: remove editor ref current

* fix: renaming

* fix: link check

packages/editor/src/ce/components/document-editor-side-effects.ts

@@ -0,0 +1,12 @@
+import { type Editor } from "@tiptap/core";
+import type { ReactElement } from "react";
+import type { IEditorPropsExtended } from "@/types";
+
+export type DocumentEditorSideEffectsProps = {
+  editor: Editor;
+  id: string;
+  updatePageProperties?: unknown;
+  extendedEditorProps?: IEditorPropsExtended;
+};
+
+export const DocumentEditorSideEffects = (_props: DocumentEditorSideEffectsProps): ReactElement | null => null;

packages/editor/src/ce/types/editor-extended.ts

@@ -0,0 +1,9 @@
+export type IEditorExtensionOptions = unknown;
+
+export type IEditorPropsExtended = unknown;
+
+export type TExtendedEditorCommands = never;
+
+export type TExtendedCommandExtraProps = unknown;
+
+export type TExtendedEditorRefApi = unknown;

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

@@ -1 +1,2 @@
 export * from "./issue-embed";
+export * from "./editor-extended";

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

@@ -12,6 +12,8 @@ import { WorkItemEmbedExtension } from "@/extensions";
 import { getEditorClassNames } from "@/helpers/common";
 // hooks
 import { useCollaborativeEditor } from "@/hooks/use-collaborative-editor";
+// constants
+import { DocumentEditorSideEffects } from "@/plane-editor/components/document-editor-side-effects";
 // types
 import type { EditorRefApi, ICollaborativeDocumentEditorProps } from "@/types";
 
@@ -27,6 +29,7 @@ const CollaborativeDocumentEditor: React.FC<ICollaborativeDocumentEditorProps> =
     editable,
     editorClassName = "",
     editorProps,
+    extendedEditorProps,
     embedHandler,
     fileHandler,
     flaggedExtensions,
@@ -97,20 +100,23 @@ const CollaborativeDocumentEditor: React.FC<ICollaborativeDocumentEditorProps> =
   if (!editor) return null;
 
   return (
-    <PageRenderer
-      aiHandler={aiHandler}
-      bubbleMenuEnabled={bubbleMenuEnabled}
-      displayConfig={displayConfig}
-      documentLoaderClassName={documentLoaderClassName}
-      editor={editor}
-      editorContainerClassName={cn(editorContainerClassNames, "document-editor")}
-      id={id}
-      isTouchDevice={!!isTouchDevice}
-      isLoading={!hasServerSynced && !hasServerConnectionFailed}
-      tabIndex={tabIndex}
-      flaggedExtensions={flaggedExtensions}
-      disabledExtensions={disabledExtensions}
-    />
+    <>
+      <DocumentEditorSideEffects editor={editor} id={id} extendedEditorProps={extendedEditorProps} />
+      <PageRenderer
+        aiHandler={aiHandler}
+        bubbleMenuEnabled={bubbleMenuEnabled}
+        displayConfig={displayConfig}
+        documentLoaderClassName={documentLoaderClassName}
+        editor={editor}
+        editorContainerClassName={cn(editorContainerClassNames, "document-editor")}
+        id={id}
+        isTouchDevice={!!isTouchDevice}
+        isLoading={!hasServerSynced && !hasServerConnectionFailed}
+        tabIndex={tabIndex}
+        flaggedExtensions={flaggedExtensions}
+        disabledExtensions={disabledExtensions}
+      />
+    </>
   );
 };
 

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

@@ -5,6 +5,8 @@ import type { EditorProps, EditorView } from "@tiptap/pm/view";
 import type { NodeViewProps as TNodeViewProps } from "@tiptap/react";
 // extension types
 import type { TTextAlign } from "@/extensions";
+// plane editor imports
+import type { IEditorPropsExtended, TExtendedEditorCommands } from "@/plane-editor/types/editor-extended";
 // types
 import type {
   IMarking,
@@ -50,7 +52,8 @@ export type TEditorCommands =
   | "callout"
   | "attachment"
   | "emoji"
-  | "external-embed";
+  | "external-embed"
+  | TExtendedEditorCommands;
 
 export type TCommandExtraProps = {
   image: {
@@ -157,6 +160,7 @@ export type IEditorProps = {
   placeholder?: string | ((isFocused: boolean, value: string) => string);
   tabIndex?: number;
   value?: string | null;
+  extendedEditorProps: IEditorPropsExtended;
 };
 
 export type ILiteTextEditorProps = IEditorProps;

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

@@ -8,5 +8,6 @@ export * from "./extensions";
 export * from "./hook";
 export * from "./mention";
 export * from "./slash-commands-suggestion";
-export * from "@/plane-editor/types";
 export * from "./document-collaborative-events";
+
+export * from "@/plane-editor/types";