superdoc 2.5.1 → 2.6.0-next.10

package/dist/superdoc/src/components/CommentsLayer/CommentDialog.vue.d.ts

@@ -21,7 +21,7 @@ declare const _default: import('vue').DefineComponent<{}, {
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
     commentDialogElement: HTMLDivElement;
     commentInput: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{}> & Readonly<{}>, {
-        focus: () => void;
+        focus: (options: any) => void;
         $emit: (event: "focus", ...args: any[]) => void;
         config: Record<string, any>;
         users: unknown[];
@@ -45,7 +45,7 @@ declare const _default: import('vue').DefineComponent<{}, {
         M: {};
         Defaults: {};
     }, Readonly<{}> & Readonly<{}>, {
-        focus: () => void;
+        focus: (options: any) => void;
         $emit: (event: "focus", ...args: any[]) => void;
         config: Record<string, any>;
         users: unknown[];

package/dist/superdoc/src/components/CommentsLayer/CommentInput.vue.d.ts

@@ -1,5 +1,5 @@
 declare const _default: import('vue').DefineComponent<{}, {
-    focus: () => void;
+    focus: (options: any) => void;
     $emit: (event: "focus", ...args: any[]) => void;
     config: Record<string, any>;
     users: unknown[];

package/dist/superdoc/src/core/SuperDoc.d.ts

@@ -542,6 +542,7 @@ export declare class SuperDoc extends EventEmitter<SuperDocEventMap> {
      * Story-aware navigation is currently supported for bookmark and tracked
      * change targets. Block and comment targets are body-only.
      *
+     * @deprecated Use the target-specific navigation APIs on `superdoc.ui`. This method will be removed in v3.
      * @returns Whether the target was found and navigated to.
      */
     navigateTo(target: NavigableAddress): Promise<boolean>;

package/dist/superdoc/src/core/types/index.d.ts

@@ -3730,30 +3730,63 @@ export interface ProofingError {
     cause?: unknown;
 }
 export interface ProofingConfig {
-    /** Enable or disable proofing (default: false). */
+    /**
+     * Enables proofing. A provider is also required before SuperDoc runs checks.
+     * @defaultValue false
+     */
     enabled?: boolean;
-    /** Provider instance. */
+    /**
+     * Checks the text segments SuperDoc supplies and returns spelling, grammar,
+     * or style issues.
+     * @defaultValue null
+     */
     provider?: ProofingProvider | null;
-    /** Fallback language for segments without a resolved language. */
+    /**
+     * Fallback language passed to the provider when a text segment has no
+     * resolved language.
+     * @defaultValue null
+     */
     defaultLanguage?: string | null;
-    /** Debounce delay after edits before rechecking (default: 500). */
+    /**
+     * Delay in milliseconds between an edit and the next proofing check. Values
+     * at or below 0 run without a delay.
+     * @defaultValue 500
+     */
     debounceMs?: number;
-    /** Maximum replacement suggestions per issue. */
+    /** Suggestion limit passed to the provider. The provider decides how to apply it. */
     maxSuggestions?: number;
-    /** Prioritize checking visible pages first (default: true). */
+    /** Prioritize checking visible pages first. */
     visibleFirst?: boolean;
-    /** Show "Ignore" in context menu (default: true). */
+    /**
+     * Shows Ignore in the proofing context menu. Ignored words remain suppressed
+     * for this editor session.
+     * @defaultValue true
+     */
     allowIgnoreWord?: boolean;
-    /** Words to suppress from proofing results. */
+    /**
+     * Words whose proofing issues SuperDoc suppresses. Matching is
+     * case-insensitive after Unicode normalization.
+     * @defaultValue []
+     */
     ignoredWords?: string[];
-    /** Provider call timeout in milliseconds (default: 10000). */
+    /**
+     * Maximum provider call time in milliseconds. Non-positive or non-finite
+     * values use the default.
+     * @defaultValue 10000
+     */
     timeoutMs?: number;
-    /** Max concurrent provider requests (default: 2). */
+    /** Maximum concurrent provider requests. */
     maxConcurrentRequests?: number;
-    /** Max segments per provider call (default: 20). */
+    /** Maximum segments per provider call. */
     maxSegmentsPerBatch?: number;
-    /** Error callback for provider failures. */
+    /**
+     * Runs when a provider check fails or times out.
+     * @param error - The failure kind, message, affected segment IDs, and cause.
+     */
     onProofingError?: (error: ProofingError) => void;
-    /** Status change callback. */
+    /**
+     * Runs when the proofing lifecycle status changes.
+     * @param status - The current proofing status.
+     */
     onStatusChange?: (status: ProofingStatus) => void;
 }

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

@@ -23,6 +23,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
+    currentCommentMentions: import('vue').Ref<never[], never[]>;
     commentsList: import('vue').Ref<never[], never[]>;
     reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
     isCommentsListVisible: import('vue').Ref<boolean, boolean>;
@@ -210,8 +211,26 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
     }) => any;
+    announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
+        ok: boolean;
+        reason: string;
+        detail?: undefined;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        comment: any;
+        reason?: undefined;
+        detail?: undefined;
+    }>;
     isV2EditorActive: (superdoc: any) => boolean;
-    replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
+    replyCommentV2: ({ superdoc, parentCommentId, text, mentions }?: {
+        mentions?: never[] | undefined;
+    }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
     reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -258,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" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
+}, "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" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
         readonly NEW: "new";
@@ -283,6 +302,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
+    currentCommentMentions: import('vue').Ref<never[], never[]>;
     commentsList: import('vue').Ref<never[], never[]>;
     reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
     isCommentsListVisible: import('vue').Ref<boolean, boolean>;
@@ -470,8 +490,26 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
     }) => any;
+    announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
+        ok: boolean;
+        reason: string;
+        detail?: undefined;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        comment: any;
+        reason?: undefined;
+        detail?: undefined;
+    }>;
     isV2EditorActive: (superdoc: any) => boolean;
-    replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
+    replyCommentV2: ({ superdoc, parentCommentId, text, mentions }?: {
+        mentions?: never[] | undefined;
+    }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
     reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -543,6 +581,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     suppressInternalExternal: import('vue').Ref<boolean, boolean>;
     pendingComment: import('vue').Ref<null, null>;
     currentCommentText: import('vue').Ref<string, string>;
+    currentCommentMentions: import('vue').Ref<never[], never[]>;
     commentsList: import('vue').Ref<never[], never[]>;
     reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
     isCommentsListVisible: import('vue').Ref<boolean, boolean>;
@@ -730,8 +769,26 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         preparedInputs?: null | undefined;
         pruneStale?: boolean | undefined;
     }) => any;
+    announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
+        ok: boolean;
+        reason: string;
+        detail?: undefined;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        reason: string;
+        detail: any;
+        comment?: undefined;
+    } | {
+        ok: boolean;
+        comment: any;
+        reason?: undefined;
+        detail?: undefined;
+    }>;
     isV2EditorActive: (superdoc: any) => boolean;
-    replyCommentV2: ({ superdoc, parentCommentId, text }?: {}) => Promise<any>;
+    replyCommentV2: ({ superdoc, parentCommentId, text, mentions }?: {
+        mentions?: never[] | undefined;
+    }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
     reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -778,4 +835,4 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         liveAnchorKeys?: null | undefined;
     }) => any;
     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" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
+}, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;