superdoc 2.28.0 → 2.29.0-next.1

package/dist/superdoc/src/stores/comments-store.d.ts

@@ -101,23 +101,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -154,8 +174,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -186,7 +215,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -236,7 +277,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         liveAnchorKeys?: null | undefined;
     }) => any;
     remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
-}, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
+}, "COMMENT_EVENTS" | "isDebugging" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
         readonly NEW: "new";
@@ -339,23 +380,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -392,8 +453,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -424,7 +494,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -577,23 +659,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -630,8 +732,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -662,7 +773,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;