@fileverse-dev/ddoc 2.1.2-patch-3.3 → 2.1.3-patch-1

package/dist/package/components/editor-bubble-menu/editor-bubble-menu.d.ts

@@ -0,0 +1,3 @@
+import { EditorBubbleMenuProps } from './types';
+
+export declare const EditorBubbleMenu: (props: EditorBubbleMenuProps) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/editor-bubble-menu/node-selector.d.ts

@@ -0,0 +1,3 @@
+import { NodeSelectorProps } from './types';
+
+export declare const NodeSelector: ({ editor, elementRef }: NodeSelectorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/editor-bubble-menu/props.d.ts

@@ -0,0 +1,58 @@
+import { Editor } from '@tiptap/core';
+import { EditorBubbleMenuProps } from './types';
+
+export declare const bubbleMenuProps: (props: EditorBubbleMenuProps) => {
+    tippyOptions: {
+        moveTransition: string;
+        duration: number;
+        animation: string;
+        zIndex: number;
+        appendTo: () => HTMLElement | null;
+        popperOptions: {
+            strategy: string;
+            modifiers: ({
+                name: string;
+                options: {
+                    fallbackPlacements: string[];
+                    altAxis?: undefined;
+                    tether?: undefined;
+                };
+            } | {
+                name: string;
+                options: {
+                    altAxis: boolean;
+                    tether: boolean;
+                    fallbackPlacements?: undefined;
+                };
+            })[];
+        };
+    };
+    className?: string | undefined;
+    editor: import('@tiptap/extension-bubble-menu').BubbleMenuPluginProps["editor"] | null;
+    pluginKey?: string | import('prosemirror-state').PluginKey<any> | undefined;
+    updateDelay?: number | undefined;
+    shouldShow?: ((props: {
+        editor: Editor;
+        element: HTMLElement;
+        view: import('prosemirror-view').EditorView;
+        state: import('prosemirror-state').EditorState;
+        oldState?: import('prosemirror-state').EditorState;
+        from: number;
+        to: number;
+    }) => boolean) | null | undefined;
+    activeCommentId: string | null;
+    isPreviewMode: boolean;
+    onError?: (errorString: string) => void;
+    zoomLevel: string;
+    setIsCommentSectionOpen?: (isOpen: boolean) => void;
+    inlineCommentData?: import('../../types').InlineCommentData;
+    setInlineCommentData?: React.Dispatch<React.SetStateAction<import('../../types').InlineCommentData>>;
+    walletAddress?: string;
+    username?: string;
+    onInlineComment?: () => void;
+    commentDrawerOpen?: boolean;
+    setCommentDrawerOpen?: React.Dispatch<import('react').SetStateAction<boolean>>;
+};
+export declare const shouldShow: ({ editor }: {
+    editor: Editor;
+}) => boolean;

package/dist/package/components/{editor-bubble-menu.d.ts → editor-bubble-menu/types.d.ts}

@@ -1,5 +1,6 @@
-import { BubbleMenuProps } from '@tiptap/react';
-import { default as React } from 'react';
+import { BubbleMenuProps, Editor } from '@tiptap/react';
+import { SetStateAction } from 'react';
+import { InlineCommentData } from '../../types';
 
 export interface BubbleMenuItem {
     name: string;
@@ -7,7 +8,8 @@ export interface BubbleMenuItem {
     command: () => void;
     icon: any;
 }
-type EditorBubbleMenuProps = Omit<BubbleMenuProps, 'children'> & {
+export type EditorBubbleMenuProps = Omit<BubbleMenuProps, 'children'> & {
+    activeCommentId: string | null;
     isPreviewMode: boolean;
     onError?: (errorString: string) => void;
     zoomLevel: string;
@@ -17,6 +19,10 @@ type EditorBubbleMenuProps = Omit<BubbleMenuProps, 'children'> & {
     walletAddress?: string;
     username?: string;
     onInlineComment?: () => void;
+    commentDrawerOpen?: boolean;
+    setCommentDrawerOpen?: React.Dispatch<SetStateAction<boolean>>;
 };
-export declare const EditorBubbleMenu: (props: EditorBubbleMenuProps) => import("react/jsx-runtime").JSX.Element;
-export {};
+export interface NodeSelectorProps {
+    editor: Editor;
+    elementRef: React.RefObject<HTMLDivElement>;
+}

package/dist/package/components/inline-comment/comment-bubble-card.d.ts

@@ -0,0 +1,7 @@
+import { Editor } from '@tiptap/core';
+
+export declare const CommentBubbleCard: ({ editor, activeCommentId, commentDrawerOpen, }: {
+    editor: Editor;
+    activeCommentId: string | null;
+    commentDrawerOpen: boolean;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/inline-comment/comment-card.d.ts

@@ -0,0 +1,3 @@
+import { CommentCardProps } from './types';
+
+export declare const CommentCard: ({ username, selectedContent, comment, createdAt, replies, onResolve, onDelete, onUnresolve, isResolved, isDropdown, activeCommentId, id, isDisabled, isCommentOwner, version, }: CommentCardProps) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/inline-comment/comment-drawer.d.ts

@@ -0,0 +1,3 @@
+import { CommentDrawerProps } from './types';
+
+export declare const CommentDrawer: ({ isOpen, onClose, isNavbarVisible, isPresentationMode, activeCommentId, isPreviewMode, }: CommentDrawerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/inline-comment/comment-dropdown.d.ts

@@ -0,0 +1,3 @@
+import { CommentDropdownProps } from './types';
+
+export declare const CommentDropdown: ({ activeCommentId, initialComment, isBubbleMenu, selectedContent, isDisabled, isCommentOwner, }: CommentDropdownProps) => import("react/jsx-runtime").JSX.Element | null;

package/dist/package/components/inline-comment/comment-section.d.ts

@@ -0,0 +1,3 @@
+import { CommentSectionProps } from './types';
+
+export declare const CommentSection: ({ activeCommentId, isNavbarVisible, isPresentationMode, isOpen, }: CommentSectionProps) => import("react/jsx-runtime").JSX.Element;

package/dist/package/components/inline-comment/comment-username.d.ts

@@ -0,0 +1,4 @@
+import { CommentUsernameProps } from './context/types';
+
+declare const CommentUsername: ({ username, setUsername, isNavbarVisible, isConnected, connectViaUsername, connectViaWallet, isLoading, }: CommentUsernameProps) => import("react/jsx-runtime").JSX.Element;
+export { CommentUsername };

package/dist/package/components/inline-comment/context/comment-context.d.ts

@@ -0,0 +1,6 @@
+import { CommentContextType, CommentProviderProps } from './types';
+import { EnsStatus } from '../types';
+
+export declare const CommentProvider: ({ children, editor, initialComments, setInitialComments, username, setUsername, activeCommentId, setActiveCommentId, focusCommentWithActiveId, onNewComment, onCommentReply, ensResolutionUrl, onResolveComment, onUnresolveComment, onDeleteComment, isConnected, connectViaWallet, isLoading, connectViaUsername, isDDocOwner, }: CommentProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useComments: () => CommentContextType;
+export declare const useEnsName: (username?: string) => EnsStatus;

package/dist/package/components/inline-comment/context/types.d.ts

@@ -0,0 +1,74 @@
+import { Editor } from '@tiptap/react';
+import { IComment } from '../../../extensions/comment';
+import { SetStateAction } from 'react';
+import { CommentAccountProps } from '../../../types';
+
+export interface CommentContextType extends CommentAccountProps {
+    comments: IComment[];
+    setComments: React.Dispatch<SetStateAction<IComment[]>>;
+    editor: Editor;
+    username?: string | null;
+    setUsername?: React.Dispatch<SetStateAction<string>>;
+    showResolved: boolean;
+    setShowResolved: (show: boolean) => void;
+    resolveComment: (commentId: string) => void;
+    unresolveComment: (commentId: string) => void;
+    deleteComment: (commentId: string) => void;
+    handleAddReply: (activeCommentId: string, replyContent: string, onCommentReply: (activeCommentId: string, reply: IComment) => void) => void;
+    focusCommentInEditor: (commentId: string) => void;
+    handleReplyChange: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+    handleCommentChange: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+    handleCommentKeyDown: (event: React.KeyboardEvent<HTMLTextAreaElement>) => void;
+    handleReplySubmit: () => void;
+    toggleResolved: () => void;
+    openReplyId: string | null;
+    setOpenReplyId: (id: string | null) => void;
+    handleReplyKeyDown: (event: React.KeyboardEvent<HTMLTextAreaElement>) => void;
+    commentsSectionRef: React.RefObject<HTMLDivElement>;
+    replySectionRef: React.RefObject<HTMLDivElement>;
+    addComment: (content?: string) => void;
+    handleCommentSubmit: () => void;
+    reply: string;
+    setReply: React.Dispatch<React.SetStateAction<string>>;
+    comment: string;
+    setComment: React.Dispatch<React.SetStateAction<string>>;
+    onPrevComment: () => void;
+    onNextComment: () => void;
+    activeCommentIndex: number;
+    activeComment: IComment | undefined;
+    selectedText: string;
+    isCommentOpen: boolean;
+    onInlineCommentClick: (event: React.MouseEvent) => void;
+    handleInlineComment: () => void;
+    portalRef: React.RefObject<HTMLDivElement>;
+    buttonRef: React.RefObject<HTMLDivElement>;
+    dropdownRef: React.RefObject<HTMLDivElement>;
+    activeComments: IComment[];
+    handleInput: (e: React.FormEvent<HTMLTextAreaElement>, content: string) => void;
+    isCommentActive: boolean;
+    isCommentResolved: boolean;
+    ensResolutionUrl: string;
+    onCommentReply?: (activeCommentId: string, reply: IComment) => void;
+}
+export interface CommentProviderProps extends CommentAccountProps {
+    children: React.ReactNode;
+    editor: Editor;
+    initialComments?: IComment[];
+    setInitialComments?: React.Dispatch<SetStateAction<IComment[]>>;
+    onCommentReply?: (activeCommentId: string, reply: IComment) => void;
+    onNewComment?: (newComment: IComment) => void;
+    onResolveComment?: (activeCommentId: string) => void;
+    onUnresolveComment?: (activeCommentId: string) => void;
+    onDeleteComment?: (activeCommentId: string) => void;
+    username: string | null;
+    setUsername?: React.Dispatch<SetStateAction<string>>;
+    activeCommentId: string | null;
+    setActiveCommentId: React.Dispatch<React.SetStateAction<string | null>>;
+    focusCommentWithActiveId: (id: string) => void;
+    ensResolutionUrl: string;
+}
+export interface CommentUsernameProps extends CommentAccountProps {
+    username?: string | null;
+    setUsername?: React.Dispatch<SetStateAction<string>>;
+    isNavbarVisible?: boolean;
+}

package/dist/package/components/inline-comment/empty-comments.d.ts

@@ -0,0 +1,2 @@
+declare const EmptyComments: () => import("react/jsx-runtime").JSX.Element;
+export { EmptyComments };

package/dist/package/components/inline-comment/types.d.ts

@@ -0,0 +1,68 @@
+import { BubbleMenuProps, Editor } from '@tiptap/react';
+import { IComment } from '../../extensions/comment';
+import { SetStateAction } from 'react';
+
+export interface UseCommentActionsProps {
+    editor: Editor;
+    comments: IComment[];
+    setComments: (comments: IComment[]) => void;
+}
+export interface CommentDropdownProps {
+    editor: Editor;
+    onSubmit: (content: string) => string;
+    onClose: () => void;
+    setComments?: (comments: IComment[]) => void;
+    comments?: IComment[];
+    username?: string;
+    walletAddress?: string;
+    activeCommentId?: string;
+    commentDrawerOpen?: boolean;
+    setCommentDrawerOpen?: React.Dispatch<SetStateAction<boolean>>;
+    initialComment?: string;
+    isBubbleMenu?: boolean;
+    selectedContent?: string;
+    isDisabled?: boolean;
+    isCommentOwner?: boolean;
+}
+export interface CommentDrawerProps {
+    isOpen: boolean;
+    onClose: () => void;
+    isNavbarVisible: boolean;
+    isPresentationMode: boolean;
+    activeCommentId: string | null;
+    isPreviewMode: boolean;
+}
+export interface CommentCardProps extends IComment {
+    comment?: string;
+    onResolve?: (commentId: string) => void;
+    onDelete?: (commentId: string) => void;
+    onUnresolve?: (commentId: string) => void;
+    isResolved?: boolean;
+    isDropdown?: boolean;
+    activeCommentId?: string;
+    isDisabled?: boolean;
+    isCommentOwner?: boolean;
+    version?: string;
+}
+export type CommentBubbleMenuProps = Omit<BubbleMenuProps, 'children'> & {
+    zoomLevel: string;
+};
+export interface CommentReplyProps {
+    reply: string;
+    username: string;
+    createdAt: Date;
+}
+export interface EnsStatus {
+    name: string;
+    isEns: boolean;
+}
+export interface CommentSectionProps {
+    activeCommentId: string | null;
+    isNavbarVisible?: boolean;
+    isPresentationMode?: boolean;
+    isOpen?: boolean;
+}
+export interface UserDisplayProps {
+    ensStatus: EnsStatus;
+    createdAt: Date | undefined;
+}

package/dist/package/components/presentation-mode/presentation-mode.d.ts

@@ -4,9 +4,9 @@ interface PresentationModeProps {
     editor: Editor;
     onClose: () => void;
     isFullscreen: boolean;
-    setIsFullscreen: (isFullscreen: boolean) => void;
+    setIsFullscreen: React.Dispatch<React.SetStateAction<boolean>>;
     onError?: (error: string) => void;
-    setIsCommentSectionOpen: React.Dispatch<React.SetStateAction<boolean>> | undefined;
+    setCommentDrawerOpen: React.Dispatch<React.SetStateAction<boolean>> | undefined;
     sharedSlidesLink?: string;
     isPreviewMode: boolean;
     documentName: string;
@@ -14,5 +14,5 @@ interface PresentationModeProps {
     slides: string[];
     setSlides: React.Dispatch<React.SetStateAction<string[]>>;
 }
-export declare const PresentationMode: ({ editor, onClose, isFullscreen, setIsFullscreen, onError, setIsCommentSectionOpen, sharedSlidesLink, isPreviewMode, documentName, onSlidesShare, slides, setSlides, }: PresentationModeProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const PresentationMode: ({ editor, onClose, isFullscreen, setIsFullscreen, onError, setCommentDrawerOpen, sharedSlidesLink, isPreviewMode, documentName, onSlidesShare, slides, setSlides, }: PresentationModeProps) => import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/package/extensions/comment/comment.d.ts

@@ -0,0 +1,64 @@
+import { Mark, Range } from '@tiptap/core';
+import { Mark as PMMark } from '@tiptap/pm/model';
+
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        comment: {
+            /**
+             * Set a comment (add)
+             */
+            setComment: (commentId: string) => ReturnType;
+            /**
+             * Unset a comment (remove completely)
+             */
+            unsetComment: (commentId: string) => ReturnType;
+            /**
+             * Resolve a comment (keep ID but update styling)
+             */
+            resolveComment: (commentId: string) => ReturnType;
+            /**
+             * Unresolve a comment (switch back to unresolved state)
+             */
+            unresolveComment: (commentId: string) => ReturnType;
+            /**
+             * Set a comment active
+             */
+            setCommentActive: (commentId: string) => ReturnType;
+            /**
+             * Unset comment active
+             */
+            unsetCommentActive: () => ReturnType;
+        };
+    }
+}
+export interface MarkWithRange {
+    mark: PMMark;
+    range: Range;
+}
+export interface CommentOptions {
+    HTMLAttributes: Record<string, any>;
+    onCommentActivated: (commentId: string) => void;
+    onCommentResolved?: (commentId: string) => void;
+    onCommentUnresolved?: (commentId: string) => void;
+    onCommentDeleted?: (commentId: string) => void;
+}
+export interface CommentStorage {
+    activeCommentId: string | null;
+}
+export interface IComment {
+    id?: string;
+    username?: string;
+    reactions?: {
+        count: number;
+        type: string;
+    }[];
+    selectedContent?: string;
+    content?: string;
+    replies?: IComment[];
+    createdAt?: Date;
+    resolved?: boolean;
+    deleted?: boolean;
+    commentIndex?: number;
+    version?: string;
+}
+export declare const CommentExtension: Mark<CommentOptions, CommentStorage>;

package/dist/package/extensions/comment/index.d.ts

@@ -0,0 +1,2 @@
+export * from './comment';
+export { CommentExtension as default } from './comment';

package/dist/package/types.d.ts

@@ -3,6 +3,7 @@ import { Extension, JSONContent } from '@tiptap/core';
 import { EditorProps } from '@tiptap/pm/view';
 import { Editor } from '@tiptap/react';
 import { default as React, SetStateAction } from 'react';
+import { IComment } from './extensions/comment';
 
 export declare const DdocEditorProps: EditorProps;
 export interface IDocCollabUsers {
@@ -10,12 +11,28 @@ export interface IDocCollabUsers {
     isEns: string;
     color: string;
 }
-type InlineCommentData = {
+export type InlineCommentData = {
     inlineCommentText: string;
     highlightedTextContent: string;
     handleClick: boolean;
 };
-export interface DdocProps {
+export interface CommentAccountProps {
+    isConnected?: boolean;
+    connectViaWallet?: () => Promise<void>;
+    isLoading?: boolean;
+    connectViaUsername?: (username: string) => Promise<void>;
+    isDDocOwner?: boolean;
+}
+export interface DdocProps extends CommentAccountProps {
+    commentDrawerOpen?: boolean;
+    setCommentDrawerOpen?: React.Dispatch<SetStateAction<boolean>>;
+    initialComments?: IComment[];
+    setInitialComments?: React.Dispatch<SetStateAction<IComment[]>>;
+    onCommentReply?: (activeCommentId: string, reply: IComment) => void;
+    onNewComment?: (newComment: IComment) => void;
+    onResolveComment?: (activeCommentId: string) => void;
+    onUnresolveComment?: (activeCommentId: string) => void;
+    onDeleteComment?: (activeCommentId: string) => void;
     showTOC?: boolean;
     setShowTOC?: React.Dispatch<SetStateAction<boolean>>;
     proExtensions?: Record<string, Extension | any>;
@@ -40,10 +57,11 @@ export interface DdocProps {
     initialContent?: JSONContent | string | string[] | null;
     walletAddress?: string | null;
     username?: string | null;
+    setUsername?: React.Dispatch<SetStateAction<string>>;
     renderNavbar?: ({ editor }: {
         editor: JSONContent;
     }) => JSX.Element;
-    onChange?: (changes: Data['editorJSONData']) => void;
+    onChange?: (updatedDocContent: Data['editorJSONData'], updateChunk: string) => void;
     onCollaboratorChange?: (collaborators: undefined | IDocCollabUsers[]) => void;
     onTextSelection?: (data: IEditorSelectionData) => void;
     onCommentInteraction?: (data: IEditorSelectionData) => void;
@@ -78,11 +96,11 @@ export interface IEditorSelectionData {
     isHighlightedYellow: boolean;
 }
 export interface Data {
-    editorJSONData: JSONContent;
+    editorJSONData: string | JSONContent;
 }
 export interface IUser {
     name: string;
     color: string;
     isEns: boolean;
 }
-export {};
+export { type IComment };

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

@@ -8,6 +8,9 @@ export declare const useDdocEditor: ({ isPreviewMode, initialContent, enableColl
     connect: (username: string | null | undefined, isEns?: boolean) => () => void;
     ydoc: Y.Doc;
     refreshYjsIndexedDbProvider: () => Promise<void>;
+    activeCommentId: string | null;
+    setActiveCommentId: import('react').Dispatch<import('react').SetStateAction<string | null>>;
+    focusCommentWithActiveId: (id: string) => void;
     slides: string[];
     setSlides: import('react').Dispatch<import('react').SetStateAction<string[]>>;
     tocItems: any[];

package/dist/package/utils/helpers.d.ts

@@ -0,0 +1,2 @@
+export declare const nameFormatter: (username: string) => string;
+export declare const dateFormatter: (date: Date) => string | import("react/jsx-runtime").JSX.Element;

package/dist/package/utils/responsive.d.ts

@@ -0,0 +1,7 @@
+export declare const useResponsive: () => {
+    isBelow1024px: boolean;
+    isBelow1280px: boolean;
+    isMobileScreen: boolean;
+    isNativeMobile: boolean;
+    isIOS: boolean;
+};