superdoc 2.29.0-next.3 → 2.29.0

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

@@ -11,15 +11,10 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         readonly CHANGE_ACCEPTED: "change-accepted";
         readonly CHANGE_REJECTED: "change-rejected";
     };
-    isDebugging: boolean;
-    hasInitializedComments: import('vue').Ref<boolean, boolean>;
     hasSyncedCollaborationComments: import('vue').Ref<boolean, boolean>;
     editingCommentId: import('vue').Ref<null, null>;
     activeComment: import('vue').Ref<null, null>;
     activeFloatingCommentInstanceId: import('vue').Ref<null, null>;
-    commentDialogs: import('vue').Ref<never[], never[]>;
-    overlappingComments: import('vue').Ref<never[], never[]>;
-    overlappedIds: Set<never>;
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
@@ -37,8 +32,6 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     isCommentHighlighted: import('vue').Ref<boolean, boolean>;
     floatingCommentsOffset: import('vue').Ref<number, number>;
     committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
-    sortedConversations: import('vue').Ref<never[], never[]>;
-    visibleConversations: import('vue').Ref<never[], never[]>;
     skipSelectionUpdate: import('vue').Ref<boolean, boolean>;
     isFloatingCommentsReady: import('vue').Ref<boolean, boolean>;
     instantSidebarAlignmentTargetY: import('vue').Ref<null, null>;
@@ -60,30 +53,46 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedComments: any[];
     }>;
     hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
-    getCommentsByPosition: import('vue').ComputedRef<{
-        parentComments: any[];
-        resolvedComments: any[];
-    }>;
     getFloatingComments: import('vue').ComputedRef<any[]>;
     getFloatingCommentInstances: import('vue').ComputedRef<{
-        id: any;
-        threadId: any;
+        id: string;
+        threadId: string | null;
         comment: any;
-        positionKey: any;
-        pageIndex: any;
+        positionKey: string | null;
+        positionEntry: {
+            pageIndex?: number | null;
+            rects?: readonly ({
+                pageIndex?: number | null;
+                left?: number;
+                top?: number;
+                right?: number;
+                bottom?: number;
+            } | null | undefined)[] | null;
+            bounds?: Partial<{
+                left: number;
+                top: number;
+                right: number;
+                bottom: number;
+                width: number;
+                height: number;
+            }> | null;
+        } | null;
+        pageIndex: number | null;
         isPrimary: boolean;
-        positionEntry: any;
     }[]>;
-    getCommentAliasIds: (commentOrId: any) => (string | null)[];
+    getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
     getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
-    getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
+    getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
     getCommentPosition: (commentOrId: Object | string) => Object | null;
-    resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
-        key: string | null;
-        entry: any;
+    resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
+        key: string;
+        entry: import('./helpers/comment-identity.js').CommentPositionEntry;
+    } | {
+        key: null;
+        entry: null;
     };
-    getCommentDocumentId: (comment: any) => string | null;
-    belongsToDocument: (comment: any, activeDocumentId: any, options?: {}) => any;
+    getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
+    belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
     viewingVisibility: {
         documentMode: string;
         commentsVisible: boolean;
@@ -93,13 +102,8 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
     init: (config?: Object) => void;
     setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
-    getComment: (id: string) => Record<string, unknown> | null | undefined;
+    getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
     setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
-    getCommentLocation: (selection: any, parent: any) => {
-        top: any;
-        left: any;
-    };
-    hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
         selection?: Object | undefined;
         documentId?: string | null | undefined;
@@ -188,11 +192,45 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
+        ok: boolean;
+        geometryOnly: boolean;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        commentItems: any;
+        trackedItems: any;
+        geometryOnly?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+    };
     reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
-    }) => any;
+    }) => {
+        added: null;
+        dropped: string;
+    } | {
+        added: any;
+        dropped?: undefined;
+    };
     announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
         ok: boolean;
         reason: string;
@@ -226,7 +264,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
             kind: "trackedChange";
             trackedChangeId: string;
             story?: unknown;
-            side?: "source" | "destination";
+            side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
         } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -255,7 +293,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedIds: never[];
         unresolvedIds: never[];
         allResolved: boolean;
-        removedRows: any;
+        removedRows: number;
         reason?: undefined;
         removedIds?: undefined;
     } | {
@@ -275,9 +313,13 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         previousPreparedPresentation?: null | undefined;
         liveIds?: null | undefined;
         liveAnchorKeys?: null | undefined;
-    }) => any;
+    }) => {
+        liveIds: Set<any>;
+        liveAnchorKeys: Set<any>;
+        appliedCount: number;
+    } | undefined;
     remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
-}, "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" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
         readonly NEW: "new";
@@ -290,15 +332,10 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         readonly CHANGE_ACCEPTED: "change-accepted";
         readonly CHANGE_REJECTED: "change-rejected";
     };
-    isDebugging: boolean;
-    hasInitializedComments: import('vue').Ref<boolean, boolean>;
     hasSyncedCollaborationComments: import('vue').Ref<boolean, boolean>;
     editingCommentId: import('vue').Ref<null, null>;
     activeComment: import('vue').Ref<null, null>;
     activeFloatingCommentInstanceId: import('vue').Ref<null, null>;
-    commentDialogs: import('vue').Ref<never[], never[]>;
-    overlappingComments: import('vue').Ref<never[], never[]>;
-    overlappedIds: Set<never>;
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
@@ -316,8 +353,6 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     isCommentHighlighted: import('vue').Ref<boolean, boolean>;
     floatingCommentsOffset: import('vue').Ref<number, number>;
     committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
-    sortedConversations: import('vue').Ref<never[], never[]>;
-    visibleConversations: import('vue').Ref<never[], never[]>;
     skipSelectionUpdate: import('vue').Ref<boolean, boolean>;
     isFloatingCommentsReady: import('vue').Ref<boolean, boolean>;
     instantSidebarAlignmentTargetY: import('vue').Ref<null, null>;
@@ -339,30 +374,46 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedComments: any[];
     }>;
     hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
-    getCommentsByPosition: import('vue').ComputedRef<{
-        parentComments: any[];
-        resolvedComments: any[];
-    }>;
     getFloatingComments: import('vue').ComputedRef<any[]>;
     getFloatingCommentInstances: import('vue').ComputedRef<{
-        id: any;
-        threadId: any;
+        id: string;
+        threadId: string | null;
         comment: any;
-        positionKey: any;
-        pageIndex: any;
+        positionKey: string | null;
+        positionEntry: {
+            pageIndex?: number | null;
+            rects?: readonly ({
+                pageIndex?: number | null;
+                left?: number;
+                top?: number;
+                right?: number;
+                bottom?: number;
+            } | null | undefined)[] | null;
+            bounds?: Partial<{
+                left: number;
+                top: number;
+                right: number;
+                bottom: number;
+                width: number;
+                height: number;
+            }> | null;
+        } | null;
+        pageIndex: number | null;
         isPrimary: boolean;
-        positionEntry: any;
     }[]>;
-    getCommentAliasIds: (commentOrId: any) => (string | null)[];
+    getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
     getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
-    getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
+    getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
     getCommentPosition: (commentOrId: Object | string) => Object | null;
-    resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
-        key: string | null;
-        entry: any;
+    resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
+        key: string;
+        entry: import('./helpers/comment-identity.js').CommentPositionEntry;
+    } | {
+        key: null;
+        entry: null;
     };
-    getCommentDocumentId: (comment: any) => string | null;
-    belongsToDocument: (comment: any, activeDocumentId: any, options?: {}) => any;
+    getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
+    belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
     viewingVisibility: {
         documentMode: string;
         commentsVisible: boolean;
@@ -372,13 +423,8 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
     init: (config?: Object) => void;
     setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
-    getComment: (id: string) => Record<string, unknown> | null | undefined;
+    getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
     setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
-    getCommentLocation: (selection: any, parent: any) => {
-        top: any;
-        left: any;
-    };
-    hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
         selection?: Object | undefined;
         documentId?: string | null | undefined;
@@ -467,11 +513,45 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
+        ok: boolean;
+        geometryOnly: boolean;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        commentItems: any;
+        trackedItems: any;
+        geometryOnly?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+    };
     reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
-    }) => any;
+    }) => {
+        added: null;
+        dropped: string;
+    } | {
+        added: any;
+        dropped?: undefined;
+    };
     announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
         ok: boolean;
         reason: string;
@@ -505,7 +585,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
             kind: "trackedChange";
             trackedChangeId: string;
             story?: unknown;
-            side?: "source" | "destination";
+            side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
         } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -534,7 +614,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedIds: never[];
         unresolvedIds: never[];
         allResolved: boolean;
-        removedRows: any;
+        removedRows: number;
         reason?: undefined;
         removedIds?: undefined;
     } | {
@@ -554,9 +634,13 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         previousPreparedPresentation?: null | undefined;
         liveIds?: null | undefined;
         liveAnchorKeys?: null | undefined;
-    }) => any;
+    }) => {
+        liveIds: Set<any>;
+        liveAnchorKeys: Set<any>;
+        appliedCount: number;
+    } | undefined;
     remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
-}, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "getGroupedReviewDirectory" | "hasOpenTrackedChanges" | "getCommentsByPosition" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
+}, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "getGroupedReviewDirectory" | "hasOpenTrackedChanges" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
         readonly NEW: "new";
@@ -569,15 +653,10 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         readonly CHANGE_ACCEPTED: "change-accepted";
         readonly CHANGE_REJECTED: "change-rejected";
     };
-    isDebugging: boolean;
-    hasInitializedComments: import('vue').Ref<boolean, boolean>;
     hasSyncedCollaborationComments: import('vue').Ref<boolean, boolean>;
     editingCommentId: import('vue').Ref<null, null>;
     activeComment: import('vue').Ref<null, null>;
     activeFloatingCommentInstanceId: import('vue').Ref<null, null>;
-    commentDialogs: import('vue').Ref<never[], never[]>;
-    overlappingComments: import('vue').Ref<never[], never[]>;
-    overlappedIds: Set<never>;
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
@@ -595,8 +674,6 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     isCommentHighlighted: import('vue').Ref<boolean, boolean>;
     floatingCommentsOffset: import('vue').Ref<number, number>;
     committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
-    sortedConversations: import('vue').Ref<never[], never[]>;
-    visibleConversations: import('vue').Ref<never[], never[]>;
     skipSelectionUpdate: import('vue').Ref<boolean, boolean>;
     isFloatingCommentsReady: import('vue').Ref<boolean, boolean>;
     instantSidebarAlignmentTargetY: import('vue').Ref<null, null>;
@@ -618,30 +695,46 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedComments: any[];
     }>;
     hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
-    getCommentsByPosition: import('vue').ComputedRef<{
-        parentComments: any[];
-        resolvedComments: any[];
-    }>;
     getFloatingComments: import('vue').ComputedRef<any[]>;
     getFloatingCommentInstances: import('vue').ComputedRef<{
-        id: any;
-        threadId: any;
+        id: string;
+        threadId: string | null;
         comment: any;
-        positionKey: any;
-        pageIndex: any;
+        positionKey: string | null;
+        positionEntry: {
+            pageIndex?: number | null;
+            rects?: readonly ({
+                pageIndex?: number | null;
+                left?: number;
+                top?: number;
+                right?: number;
+                bottom?: number;
+            } | null | undefined)[] | null;
+            bounds?: Partial<{
+                left: number;
+                top: number;
+                right: number;
+                bottom: number;
+                width: number;
+                height: number;
+            }> | null;
+        } | null;
+        pageIndex: number | null;
         isPrimary: boolean;
-        positionEntry: any;
     }[]>;
-    getCommentAliasIds: (commentOrId: any) => (string | null)[];
+    getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
     getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
-    getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
+    getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
     getCommentPosition: (commentOrId: Object | string) => Object | null;
-    resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
-        key: string | null;
-        entry: any;
+    resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
+        key: string;
+        entry: import('./helpers/comment-identity.js').CommentPositionEntry;
+    } | {
+        key: null;
+        entry: null;
     };
-    getCommentDocumentId: (comment: any) => string | null;
-    belongsToDocument: (comment: any, activeDocumentId: any, options?: {}) => any;
+    getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
+    belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
     viewingVisibility: {
         documentMode: string;
         commentsVisible: boolean;
@@ -651,13 +744,8 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
     init: (config?: Object) => void;
     setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
-    getComment: (id: string) => Record<string, unknown> | null | undefined;
+    getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
     setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
-    getCommentLocation: (selection: any, parent: any) => {
-        top: any;
-        left: any;
-    };
-    hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
         selection?: Object | undefined;
         documentId?: string | null | undefined;
@@ -746,11 +834,45 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
+        ok: boolean;
+        geometryOnly: boolean;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        commentItems: any;
+        trackedItems: any;
+        geometryOnly?: undefined;
+        reason?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+        detail?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        geometryOnly?: undefined;
+        commentItems?: undefined;
+        trackedItems?: undefined;
+    };
     reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
-    }) => any;
+    }) => {
+        added: null;
+        dropped: string;
+    } | {
+        added: any;
+        dropped?: undefined;
+    };
     announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
         ok: boolean;
         reason: string;
@@ -784,7 +906,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
             kind: "trackedChange";
             trackedChangeId: string;
             story?: unknown;
-            side?: "source" | "destination";
+            side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
         } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -813,7 +935,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedIds: never[];
         unresolvedIds: never[];
         allResolved: boolean;
-        removedRows: any;
+        removedRows: number;
         reason?: undefined;
         removedIds?: undefined;
     } | {
@@ -833,6 +955,10 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         previousPreparedPresentation?: null | undefined;
         liveIds?: null | undefined;
         liveAnchorKeys?: null | undefined;
-    }) => any;
+    }) => {
+        liveIds: Set<any>;
+        liveAnchorKeys: Set<any>;
+        appliedCount: number;
+    } | undefined;
     remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
-}, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "syncResolvedCommentsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
+}, "resolveCommentPositionEntry" | "getCommentAliasIds" | "getCommentPositionKey" | "belongsToDocument" | "getComment" | "getTrackedChangeThread" | "getCommentPosition" | "getCommentDocumentId" | "init" | "setViewingVisibility" | "setActiveComment" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "syncResolvedCommentsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;

package/dist/superdoc/src/stores/helpers/comment-document-scope.d.ts

@@ -0,0 +1,22 @@
+export type DocumentScopedComment = {
+    fileId?: unknown;
+    documentId?: unknown;
+    selection?: {
+        documentId?: unknown;
+    } | null;
+} | null | undefined;
+type OpenDocument = {
+    id?: unknown;
+} | null | undefined;
+export type OpenDocumentsSource = OpenDocument[] | {
+    value?: OpenDocument[] | null;
+} | null | undefined;
+export type BelongsToDocumentOptions = {
+    allowSingleDocumentMismatch?: boolean;
+};
+export declare const getCommentDocumentId: (comment: DocumentScopedComment) => string | null;
+export declare const createCommentDocumentScope: (readOpenDocuments: () => OpenDocumentsSource) => {
+    belongsToDocument: (comment: DocumentScopedComment, activeDocumentId: string | null | undefined, options?: BelongsToDocumentOptions) => boolean;
+    belongsToTrackedChangeSyncDocument: (comment: DocumentScopedComment, activeDocumentId: string | null | undefined) => boolean;
+};
+export {};

package/dist/superdoc/src/stores/helpers/comment-grouping.d.ts

@@ -0,0 +1,30 @@
+type CommentId = string | number;
+export type GroupableComment = {
+    commentId: CommentId;
+    fileId?: CommentId | null;
+    parentCommentId?: CommentId | null;
+    threadingParentCommentId?: CommentId | null;
+    trackedChange?: boolean;
+    trackedChangeCanonicalId?: CommentId | null;
+    trackedChangeSide?: string | null;
+    trackedChangeParentId?: CommentId | null;
+    trackedChangeThreadParentId?: CommentId | null;
+    semanticColorKey?: string | null;
+    createdTime?: number | null;
+    resolvedTime?: number | null;
+};
+type GroupedComments<Comment> = {
+    parentComments: Comment[];
+    resolvedComments: Comment[];
+};
+type CommittedReviewPresentation = {
+    groupOrder: {
+        open: readonly CommentId[];
+        resolved: readonly CommentId[];
+    };
+};
+type CommittedReviewPresentations = Readonly<Record<string, CommittedReviewPresentation>>;
+export declare const groupComments: <Comment extends GroupableComment>(source: readonly Comment[], isVisible: (comment: Comment) => boolean) => GroupedComments<Comment>;
+export declare const groupCommittedComments: <Comment extends GroupableComment>(comments: readonly Comment[], presentations: CommittedReviewPresentations, isVisible: (comment: Comment) => boolean) => GroupedComments<Comment>;
+export declare const hasOpenTrackedChange: ({ parentComments }: GroupedComments<GroupableComment>) => boolean;
+export {};

package/dist/superdoc/src/stores/helpers/comment-identity.d.ts

@@ -0,0 +1,40 @@
+export type CommentIdentityRow = Record<string, unknown>;
+type PositionBounds = {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+};
+export type CommentPositionEntry = {
+    key?: unknown;
+    threadId?: unknown;
+    kind?: string;
+    storyKey?: string;
+    pageIndex?: number | null;
+    start?: number;
+    end?: number;
+    bounds?: PositionBounds | null;
+} | null;
+export type CommentPositions = Record<string, CommentPositionEntry | undefined>;
+type PositionMatch = {
+    key: string;
+    entry: CommentPositionEntry;
+} | {
+    key: null;
+    entry: null;
+};
+type CommentIdentitySources = {
+    getComments: () => CommentIdentityRow[];
+    getReviewDirectory: () => CommentIdentityRow[];
+    getPositions: () => CommentPositions | null | undefined;
+};
+type CommentReference = CommentIdentityRow | string | number | null | undefined;
+export declare const trackedChangeThreadParentIdForComment: (comment: CommentIdentityRow | null | undefined) => unknown;
+export declare const createCommentIdentity: ({ getComments, getReviewDirectory, getPositions }: CommentIdentitySources) => {
+    getComment: (id: unknown) => CommentIdentityRow | null;
+    getThreadParent: (comment: CommentIdentityRow | null | undefined) => CommentIdentityRow | null | undefined;
+    getCommentPositionKey: (commentOrId: CommentIdentityRow | string | null | undefined) => unknown;
+    getCommentAliasIds: (commentOrId: CommentReference) => string[];
+    resolveCommentPositionEntry: (commentOrId: CommentReference, preferredId?: unknown) => PositionMatch;
+};
+export {};