@fileverse-dev/ddoc 3.2.9 → 3.3.0

package/dist/package/stores/comment-store.d.ts

@@ -30,7 +30,38 @@ export interface CommentExternalDeps {
     ensResolutionUrl: string;
     commentAnchorsRef?: React.MutableRefObject<CommentAnchor[]>;
     refreshCommentAnchorState?: () => void;
+    /**
+     * Derived anchor list for in-progress suggestion drafts. Maintained by the
+     * store (not the consumer) — draft actions upsert into this ref whenever
+     * state.drafts changes. The decoration extension reads this ref alongside
+     * commentAnchorsRef to render both layers identically.
+     */
+    draftAnchorsRef?: React.MutableRefObject<CommentAnchor[]>;
+}
+/**
+ * A suggestion draft is the viewer's in-progress proposed edit — kept local
+ * until Submit. Drafts live in memory only (lost on refresh). Derived into
+ * a CommentAnchor for decoration rendering via deriveDraftAnchor(). Most
+ * suggestion types are derived at use time from hadDeletion + insertedText;
+ * linkHref marks a link suggestion over the original selected text.
+ */
+export interface DraftSuggestion {
+    id: string;
+    anchorFrom: Y.RelativePosition;
+    anchorTo: Y.RelativePosition;
+    /** The text that was selected at draft creation (for Delete/Replace strikethrough). */
+    originalContent: string;
+    /** Accumulated text the viewer has typed. Empty for a pure Delete draft. */
+    insertedText: string;
+    /** Per-keystroke history for undo — each entry is one typed character. */
+    keystrokes: string[];
+    /** True when the draft was created via select+delete or select+type. */
+    hadDeletion: boolean;
+    /** Pasted link href for a link suggestion. */
+    linkHref?: string;
 }
+type SuggestionDeleteDirection = 'backward' | 'forward';
+export declare function isRangeDraft(draft: DraftSuggestion): boolean;
 type FloatingCardsUpdater = React.SetStateAction<CommentFloatingCard[]>;
 type InlineCommentDataUpdater = Partial<InlineCommentData> | ((prev: InlineCommentData) => Partial<InlineCommentData> | InlineCommentData);
 type InlineDraftRecordMap = Record<string, InlineCommentDraft>;
@@ -93,6 +124,8 @@ export interface CommentStoreState {
     inlineCommentData: InlineCommentData;
     floatingCards: CommentFloatingCard[];
     pendingPrehydrationFloatingThreadIds: string[];
+    /** In-progress suggestion drafts — keyed by suggestionId. Viewer-local, lost on refresh. */
+    drafts: Record<string, DraftSuggestion>;
     inlineDrafts: InlineDraftRecordMap;
     activeDraftId: string | null;
     isDesktopFloatingEnabled: boolean;
@@ -156,6 +189,7 @@ export interface CommentStoreState {
     cancelFloatingDraft: (draftId: string) => void;
     submitFloatingDraft: (draftId: string) => void;
     openFloatingThread: (commentId: string) => void;
+    focusSubmittedSuggestionFromEditor: (commentId: string) => boolean;
     closeFloatingCard: (floatingCardId: string) => void;
     blurFloatingCard: (floatingCardId: string) => void;
     focusFloatingCard: (floatingCardId: string) => void;
@@ -178,6 +212,55 @@ export interface CommentStoreState {
     deleteComment: (commentId: string, options?: {
         skipExternalCallback?: boolean;
     }) => void;
+    acceptSuggestion: (commentId: string) => void;
+    /**
+     * Append typed characters to the draft at the current cursor position.
+     * Creates a new Add draft if no draft exists at the cursor.
+     */
+    appendToDraftAtCursor: (text: string) => void;
+    /**
+     * Create a Delete (or pending Replace) draft from a selection range.
+     * Captures originalContent, leaves insertedText empty; type becomes 'replace'
+     * as soon as the viewer types.
+     */
+    startDeleteDraft: (from: number, to: number, collapseTo?: number) => void;
+    /**
+     * Create a link suggestion from a selected range and pasted href.
+     * The document stays unchanged until the owner accepts the suggestion.
+     */
+    startLinkDraft: (from: number, to: number, href: string) => void;
+    /**
+     * Convert a collapsed-caret Backspace/Delete into a delete draft when the
+     * caret is adjacent to text, or shrink the active draft if the caret is
+     * already inside one.
+     */
+    deleteAtCursorOrUndoActiveDraft: (direction: SuggestionDeleteDirection) => void;
+    /**
+     * Handle browser deletion paths that resolved to a concrete range even
+     * though the user had no explicit selection.
+     */
+    deleteRangeOrUndoActiveDraft: (from: number, to: number) => void;
+    /**
+     * Undo the last keystroke in the draft at the current cursor position.
+     * When the draft has no keystrokes left, it is discarded.
+     * For a pure Delete draft (no keystrokes ever), calling this discards.
+     */
+    undoLastKeystrokeInActiveDraft: () => void;
+    /** Drop a draft entirely — removes the inline overlay and draft card. */
+    discardDraft: (suggestionId: string) => void;
+    /**
+     * Refresh the `originalContent` (and the suggestion-draft card's selectedText)
+     * for a Delete/Replace draft whose anchored range still resolves but now
+     * covers different text — happens when the owner edits within the anchored
+     * range while the viewer's draft is open.
+     */
+    refreshDraftOriginalContent: (suggestionId: string, currentText: string) => void;
+    /**
+     * Promote a draft to a submitted suggestion. Pushes the anchor into
+     * commentAnchorsRef, calls onNewComment, removes the draft, and swaps the
+     * suggestion-draft floating card for a thread card (same floatingCardId).
+     */
+    submitDraft: (suggestionId: string) => void;
     deleteReply: (commentId: string, replyId: string) => void;
     requestEditComment: (commentId: string) => void;
     requestEditReply: (commentId: string, replyId: string) => void;
@@ -185,6 +268,7 @@ export interface CommentStoreState {
     editReplyContent: (commentId: string, replyId: string, content: string) => void;
     handleAddReply: (activeCommentId: string, replyContent: string, replyCallback?: (activeCommentId: string, reply: IComment) => void) => void;
     focusCommentInEditor: (commentId: string, options?: FocusCommentInEditorOptions) => void;
+    focusSuggestionDraftInEditor: (suggestionId: string) => void;
     onPrevComment: () => void;
     onNextComment: () => void;
     getEnsStatus: (walletAddress: string, setEnsStatus: React.Dispatch<React.SetStateAction<EnsStatus>>) => void;

package/dist/package/types.d.ts

@@ -20,6 +20,7 @@ export type InlineCommentData = {
     handleClick: boolean;
 };
 export type CommentMutationType = 'create' | 'edit' | 'resolve' | 'unresolve' | 'delete';
+export type SuggestionType = 'add' | 'replace' | 'delete' | 'link';
 export interface CommentMutationMeta {
     type: CommentMutationType;
     updateChunk?: string;
@@ -27,6 +28,9 @@ export interface CommentMutationMeta {
     anchorTo?: string;
     selectedContent?: string;
     content?: string;
+    suggestionType?: SuggestionType;
+    originalContent?: string;
+    suggestedContent?: string;
 }
 export interface SerializedCommentAnchor {
     id: string;
@@ -34,6 +38,10 @@ export interface SerializedCommentAnchor {
     anchorTo: string;
     resolved: boolean;
     deleted: boolean;
+    isSuggestion?: boolean;
+    suggestionType?: SuggestionType;
+    originalContent?: string;
+    suggestedContent?: string;
 }
 export interface CommentAccountProps {
     isConnected?: boolean;
@@ -145,6 +153,7 @@ export interface DdocProps extends CommentAccountProps {
     editorCanvasClassNames?: string;
     isCommentSectionOpen?: boolean;
     isPreviewMode: boolean;
+    viewerMode?: 'suggest' | 'view-only';
     ensResolutionUrl?: string;
     ipfsImageUploadFn?: (file: File) => Promise<IpfsImageUploadResponse>;
     enableIndexeddbSync?: boolean;

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

@@ -1,7 +1,7 @@
 import { DdocProps } from './types';
 import { Editor } from '@tiptap/react';
 
-export declare const useDdocEditor: ({ isPreviewMode, initialContent, versionHistoryState, collaboration, onChange, onCollaboratorChange, onCommentInteraction, onError, setCharacterCount, setWordCount, setPageCount, ipfsImageUploadFn, ddocId, enableIndexeddbSync, unFocused, isFocusMode, theme, zoomLevel, onInvalidContentError, ignoreCorruptedData, isPresentationMode, metadataProxyUrl, extensions: externalExtensions, onCopyHeadingLink, ipfsImageFetchFn, fetchV1ImageFn, isConnected, activeModel, maxTokens, isAIAgentEnabled, onIndexedDbError, disableInlineComment, initialCommentAnchors, ...rest }: Partial<DdocProps> & {
+export declare const useDdocEditor: ({ isPreviewMode, viewerMode, initialContent, versionHistoryState, collaboration, onChange, onCollaboratorChange, onCommentInteraction, onError, setCharacterCount, setWordCount, setPageCount, ipfsImageUploadFn, ddocId, enableIndexeddbSync, unFocused, isFocusMode, theme, zoomLevel, onInvalidContentError, ignoreCorruptedData, isPresentationMode, metadataProxyUrl, extensions: externalExtensions, onCopyHeadingLink, ipfsImageFetchFn, fetchV1ImageFn, isConnected, activeModel, maxTokens, isAIAgentEnabled, onIndexedDbError, disableInlineComment, initialCommentAnchors, ...rest }: Partial<DdocProps> & {
     isFocusMode?: boolean;
 }) => {
     ydoc: import('yjs').Doc;
@@ -41,4 +41,6 @@ export declare const useDdocEditor: ({ isPreviewMode, initialContent, versionHis
     setActiveCommentId: import('react').Dispatch<import('react').SetStateAction<string | null>>;
     focusCommentWithActiveId: (id: string) => void;
     commentAnchorsRef: import('react').MutableRefObject<import('./extensions/comment/comment-decoration-plugin').CommentAnchor[]>;
+    draftAnchorsRef: import('react').MutableRefObject<import('./extensions/comment/comment-decoration-plugin').CommentAnchor[]>;
+    storeApiRef: import('react').MutableRefObject<import('zustand').StoreApi<import('./stores/comment-store').CommentStoreState> | null>;
 };