@fileverse-dev/ddoc 2.0.3-sync-patch-12 → 2.0.3-sync-patch-13

package/dist/package/extensions/sync-cursor.d.ts

@@ -0,0 +1,12 @@
+import { Extension } from '@tiptap/core';
+import { CollaborationCursorOptions, CollaborationCursorStorage } from '../types';
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        collaborationCursor: {
+            updateUser: (attributes: Record<string, any>) => ReturnType;
+            user: (attributes: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const SyncCursor: Extension<CollaborationCursorOptions, CollaborationCursorStorage>;

package/dist/package/types.d.ts

@@ -24,7 +24,7 @@ export interface DdocProps {
     renderNavbar?: ({ editor }: {
         editor: JSONContent;
     }) => JSX.Element;
-    onChange?: (changes: Data['editorJSONData']) => void;
+    onChange?: (changes: string) => void;
     onCollaboratorChange?: (collaborators: undefined | IDocCollabUsers[]) => void;
     onTextSelection?: (data: IEditorSelectionData) => void;
     onCommentInteraction?: (data: IEditorSelectionData) => void;
@@ -34,6 +34,11 @@ export interface DdocProps {
     onError?: (error: string) => void;
     setCharacterCount?: React.Dispatch<SetStateAction<number>>;
     setWordCount?: React.Dispatch<SetStateAction<number>>;
+    collaborationKey?: string;
+    yjsUpdate?: string;
+    onDisconnectionDueToSyncError?: (syncError: {
+        message: string;
+    }) => void;
     tags?: Array<{
         name: string;
         color: string;
@@ -55,3 +60,19 @@ export interface IUser {
     color: string;
     isEns: boolean;
 }
+export type CollaborationCursorStorage = {
+    users: {
+        clientId: number;
+        [key: string]: any;
+    }[];
+};
+export interface CollaborationCursorOptions {
+    provider: any;
+    user: Record<string, any>;
+    render(user: Record<string, any>): HTMLElement;
+    selectionRender(user: Record<string, any>): any;
+    onUpdate: (users: {
+        clientId: number;
+        [key: string]: any;
+    }[]) => null;
+}

package/dist/package/use-ddoc-editor.d.ts

@@ -1,10 +1,14 @@
 import { DdocProps } from './types';
 
-import * as Y from 'yjs';
-export declare const useDdocEditor: ({ isPreviewMode, initialContent, enableCollaboration, collaborationId, walletAddress, username, onChange, onCollaboratorChange, onCommentInteraction, onTextSelection, ensResolutionUrl, onError, setCharacterCount, setWordCount, secureImageUploadUrl, scrollPosition, }: Partial<DdocProps>) => {
+export declare const useDdocEditor: ({ isPreviewMode, initialContent, enableCollaboration, collaborationId, walletAddress, username, onChange, onCollaboratorChange, ensResolutionUrl, onError, setCharacterCount, setWordCount, collaborationKey, yjsUpdate, onDisconnectionDueToSyncError, secureImageUploadUrl, scrollPosition, }: Partial<DdocProps>) => {
     editor: import('@tiptap/core').Editor | null;
     isContentLoading: boolean;
     ref: import('react').RefObject<HTMLDivElement>;
-    connect: (username: string | null | undefined, isEns?: boolean) => () => void;
-    ydoc: Y.Doc;
+    connect: (username: string | null | undefined, isEns?: boolean) => void;
+    ydoc: import('yjs').Doc;
+    isCollaborationReady: boolean;
+    syncError: {
+        message: string;
+    } | null;
+    isSyncFetchingFromIpfs: boolean;
 };