superdoc 2.3.0 → 2.4.0-next.10

package/dist/superdoc/src/public/ui/types.d.ts

@@ -837,7 +837,19 @@ export interface CommentsHandle extends SnapshotSubscribable<CommentsSlice> {
     list(query?: CommentsListQuery): readonly CommentInfo[];
     /** Resolve a single comment by id from the best-known loaded state. */
     getById(commentId: string): CommentInfo | null;
-    /** Create a comment from a frozen selection capture. */
+    /**
+     * Create a comment from a frozen selection capture.
+     *
+     * A capture carrying neither `target` nor `selectionTarget` fails closed with
+     * the same `NO_SELECTION` receipt {@link createFromSelection} mints for an
+     * empty selection, because both describe the same user-visible mistake:
+     * commenting with nothing selected. A capture that *has* a target which no
+     * longer resolves is a different failure, and keeps the Document API's own
+     * receipt so the reason stays specific.
+     *
+     * `capturedAt` is provenance for the consumer, not an expiry. A capture stays
+     * usable while its target resolves; elapsed time alone never invalidates it.
+     */
     createFromCapture(capture: CommentAnchorCapture, input: {
         text: string;
     }): WorkflowReceipt;
@@ -853,6 +865,18 @@ export interface CommentsHandle extends SnapshotSubscribable<CommentsSlice> {
     reply(commentId: string, input: {
         text: string;
     }): WorkflowReceipt;
+    /**
+     * Replace a comment's body text through the Document API
+     * (`comments.patch({ commentId, text })`).
+     *
+     * Gated by the comments `readOnly` policy like every other comment write.
+     * `allowResolve` is deliberately NOT consulted: that policy forbids only the
+     * resolve/reopen transition, and an application that may not resolve threads
+     * can still let an author correct their own wording.
+     */
+    edit(commentId: string, input: {
+        text: string;
+    }): WorkflowReceipt;
     /** Mark a comment resolved. */
     resolve(commentId: string): WorkflowReceipt;
     /** Reopen a resolved comment. */

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

@@ -152,9 +152,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         replacedFile?: boolean | undefined;
     }) => void;
     translateCommentsForExport: () => any[];
-    handleEditorLocationsUpdate: (allCommentPositions: any) => void;
+    handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
+        retainMissingTrackedChangeGeometry?: boolean;
+        retainedTrackedChangeIds?: Iterable<string>;
+    }) => void;
     clearEditorCommentPositions: () => void;
-    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState }: {
+    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
         superdoc: Object;
         params: Object;
     }) => void;
@@ -182,8 +185,18 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    hydrateCommentsFromV2: ({ superdoc, adapter, documentId }?: {}) => Promise<any>;
-    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items }?: {}) => any;
+    hydrateCommentsFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, isCurrent, signal, hydrationGeneration, }?: {
+        trackedChangesListMode?: string | undefined;
+    }) => Promise<any>;
+    applyReviewSnapshotFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    supersedeV2ReviewHydration: ({ commentsAdapter, trackedChangesAdapter }?: {}) => {
+        commentsGeneration: any;
+        trackedChangesGeneration: any;
+    };
+    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
+        preparedInputs?: null | undefined;
+        pruneStale?: boolean | undefined;
+    }) => any;
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -192,10 +205,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
     setV2TrackedChangesAdapter: (adapter: any) => void;
     getV2TrackedChangesAdapter: (superdoc: any) => any;
-    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, }?: {
+    getV2TrackedChangeRowCount: (documentId?: null) => number;
+    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, isCurrent, targetIds, reconciliationBatchSize, signal, hydrationGeneration, }?: {
         trackedChangesListMode?: string | undefined;
+        reconciliationBatchSize?: number | undefined;
     }) => Promise<any>;
-    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, }?: {
+    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, allResolved, }?: {
         upsertIds?: never[] | undefined;
         removedIds?: never[] | undefined;
     }) => Promise<{
@@ -204,6 +219,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         items?: undefined;
         resolvedIds?: undefined;
         unresolvedIds?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
+        failures?: undefined;
+    } | {
+        ok: boolean;
+        items: never[];
+        resolvedIds: never[];
+        unresolvedIds: never[];
+        allResolved: boolean;
+        removedRows: any;
+        reason?: undefined;
         failures?: undefined;
     } | {
         ok: boolean;
@@ -211,6 +237,8 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedIds: never[];
         unresolvedIds: never[];
         reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
         failures?: undefined;
     } | {
         ok: boolean;
@@ -219,10 +247,16 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         unresolvedIds: (string | null)[];
         failures: any[];
         reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
     }>;
-    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale }?: {
+    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
         pruneStale?: boolean | undefined;
+        preparedParams?: null | undefined;
+        liveIds?: null | undefined;
+        liveAnchorKeys?: null | undefined;
     }) => any;
+    remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
 }, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "isCommentsListVisible" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
@@ -377,9 +411,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         replacedFile?: boolean | undefined;
     }) => void;
     translateCommentsForExport: () => any[];
-    handleEditorLocationsUpdate: (allCommentPositions: any) => void;
+    handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
+        retainMissingTrackedChangeGeometry?: boolean;
+        retainedTrackedChangeIds?: Iterable<string>;
+    }) => void;
     clearEditorCommentPositions: () => void;
-    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState }: {
+    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
         superdoc: Object;
         params: Object;
     }) => void;
@@ -407,8 +444,18 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    hydrateCommentsFromV2: ({ superdoc, adapter, documentId }?: {}) => Promise<any>;
-    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items }?: {}) => any;
+    hydrateCommentsFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, isCurrent, signal, hydrationGeneration, }?: {
+        trackedChangesListMode?: string | undefined;
+    }) => Promise<any>;
+    applyReviewSnapshotFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    supersedeV2ReviewHydration: ({ commentsAdapter, trackedChangesAdapter }?: {}) => {
+        commentsGeneration: any;
+        trackedChangesGeneration: any;
+    };
+    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
+        preparedInputs?: null | undefined;
+        pruneStale?: boolean | undefined;
+    }) => any;
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -417,10 +464,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
     setV2TrackedChangesAdapter: (adapter: any) => void;
     getV2TrackedChangesAdapter: (superdoc: any) => any;
-    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, }?: {
+    getV2TrackedChangeRowCount: (documentId?: null) => number;
+    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, isCurrent, targetIds, reconciliationBatchSize, signal, hydrationGeneration, }?: {
         trackedChangesListMode?: string | undefined;
+        reconciliationBatchSize?: number | undefined;
     }) => Promise<any>;
-    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, }?: {
+    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, allResolved, }?: {
         upsertIds?: never[] | undefined;
         removedIds?: never[] | undefined;
     }) => Promise<{
@@ -429,14 +478,27 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         items?: undefined;
         resolvedIds?: undefined;
         unresolvedIds?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
         failures?: undefined;
     } | {
         ok: boolean;
         items: never[];
         resolvedIds: never[];
         unresolvedIds: never[];
+        allResolved: boolean;
+        removedRows: any;
         reason?: undefined;
         failures?: undefined;
+    } | {
+        ok: boolean;
+        items: never[];
+        resolvedIds: never[];
+        unresolvedIds: never[];
+        reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
+        failures?: undefined;
     } | {
         ok: boolean;
         items: any[];
@@ -444,10 +506,16 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         unresolvedIds: (string | null)[];
         failures: any[];
         reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
     }>;
-    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale }?: {
+    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
         pruneStale?: boolean | undefined;
+        preparedParams?: null | undefined;
+        liveIds?: null | undefined;
+        liveAnchorKeys?: null | undefined;
     }) => any;
+    remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
 }, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "hasOpenTrackedChanges" | "getCommentsByPosition" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
@@ -602,9 +670,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         replacedFile?: boolean | undefined;
     }) => void;
     translateCommentsForExport: () => any[];
-    handleEditorLocationsUpdate: (allCommentPositions: any) => void;
+    handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
+        retainMissingTrackedChangeGeometry?: boolean;
+        retainedTrackedChangeIds?: Iterable<string>;
+    }) => void;
     clearEditorCommentPositions: () => void;
-    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState }: {
+    handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
         superdoc: Object;
         params: Object;
     }) => void;
@@ -632,8 +703,18 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
-    hydrateCommentsFromV2: ({ superdoc, adapter, documentId }?: {}) => Promise<any>;
-    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items }?: {}) => any;
+    hydrateCommentsFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, isCurrent, signal, hydrationGeneration, }?: {
+        trackedChangesListMode?: string | undefined;
+    }) => Promise<any>;
+    applyReviewSnapshotFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => any;
+    supersedeV2ReviewHydration: ({ commentsAdapter, trackedChangesAdapter }?: {}) => {
+        commentsGeneration: any;
+        trackedChangesGeneration: any;
+    };
+    reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
+        preparedInputs?: null | undefined;
+        pruneStale?: boolean | undefined;
+    }) => any;
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
@@ -642,10 +723,12 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
     setV2TrackedChangesAdapter: (adapter: any) => void;
     getV2TrackedChangesAdapter: (superdoc: any) => any;
-    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, }?: {
+    getV2TrackedChangeRowCount: (documentId?: null) => number;
+    hydrateTrackedChangesFromV2: ({ superdoc, adapter, documentId, trackedChangesListMode, refreshReason, blocking, isCurrent, targetIds, reconciliationBatchSize, signal, hydrationGeneration, }?: {
         trackedChangesListMode?: string | undefined;
+        reconciliationBatchSize?: number | undefined;
     }) => Promise<any>;
-    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, }?: {
+    reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, allResolved, }?: {
         upsertIds?: never[] | undefined;
         removedIds?: never[] | undefined;
     }) => Promise<{
@@ -654,6 +737,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         items?: undefined;
         resolvedIds?: undefined;
         unresolvedIds?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
+        failures?: undefined;
+    } | {
+        ok: boolean;
+        items: never[];
+        resolvedIds: never[];
+        unresolvedIds: never[];
+        allResolved: boolean;
+        removedRows: any;
+        reason?: undefined;
         failures?: undefined;
     } | {
         ok: boolean;
@@ -661,6 +755,8 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         resolvedIds: never[];
         unresolvedIds: never[];
         reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
         failures?: undefined;
     } | {
         ok: boolean;
@@ -669,8 +765,14 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         unresolvedIds: (string | null)[];
         failures: any[];
         reason?: undefined;
+        allResolved?: undefined;
+        removedRows?: undefined;
     }>;
-    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale }?: {
+    reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
         pruneStale?: boolean | undefined;
+        preparedParams?: null | undefined;
+        liveIds?: null | undefined;
+        liveAnchorKeys?: null | undefined;
     }) => any;
-}, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "hydrateCommentsFromV2" | "reconcileCommentsFromV2" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "hydrateTrackedChangesFromV2" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2">>;
+    remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
+}, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "hydrateCommentsFromV2" | "applyReviewSnapshotFromV2" | "supersedeV2ReviewHydration" | "reconcileCommentsFromV2" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "hydrateTrackedChangesFromV2" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;