superdoc 2.29.0 → 2.30.0-next.13

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

@@ -194,7 +194,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         trackedChangeAnchorKey: string | null;
         trackedChangeCanonicalId: string | null;
         trackedChangePositionAliases: string[];
-        trackedChangeDecision: ("accept" | "reject") | null;
+        trackedChangeDecision: import('./comment-params.js').TrackedChangeDecision | null;
         trackedChangeLabel: string | null;
         trackedChangeDetailLines: {
             excerpt: string;
@@ -202,13 +202,11 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         }[] | null;
         trackedChangeImagePreview: {
             src: string;
-            contentType: string;
-            role: "deleted" | "inserted" | "before" | "after";
-            partUri?: string | undefined;
-            relationshipId?: string | undefined;
+            contentType?: string | undefined;
+            role?: string | undefined;
             width?: number | undefined;
             height?: number | undefined;
-            alt?: string | undefined;
+            alt: string;
         } | null;
         customAttributes: readonly {
             name: string;
@@ -227,7 +225,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         docxCommentJSON: {} | null;
         origin: "word" | "google-docs" | "unknown" | undefined;
         threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
-        threadingStyleOverride: import('../../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
+        threadingStyleOverride: import('../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
         threadingParentCommentId: string | null | undefined;
         originalXmlStructure: {
             hasCommentsExtended: boolean;
@@ -238,7 +236,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             text: string;
             superdoc?: {
                 emit: (event: "comments-update", payload: {
-                    type: import('../../../../../shared/common/event-types.js').CommentEvent;
+                    type: import('../../../../shared/common/event-types.js').CommentEvent;
                     changes?: {
                         key: string;
                         value: unknown;
@@ -260,7 +258,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             text: string;
             superdoc: {
                 emit: (event: "comments-update", payload: {
-                    type: import('../../../../../shared/common/event-types.js').CommentEvent;
+                    type: import('../../../../shared/common/event-types.js').CommentEvent;
                     changes?: {
                         key: string;
                         value: unknown;
@@ -332,7 +330,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             trackedChangeAnchorKey: string | null;
             trackedChangeCanonicalId: string | null;
             trackedChangePositionAliases: string[];
-            trackedChangeDecision: ("accept" | "reject") | null;
+            trackedChangeDecision: import('./comment-params.js').TrackedChangeDecision | null;
             trackedChangeLabel: string | null;
             trackedChangeDetailLines: {
                 excerpt: string;
@@ -340,13 +338,11 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             }[] | null;
             trackedChangeImagePreview: {
                 src: string;
-                contentType: string;
-                role: "deleted" | "inserted" | "before" | "after";
-                partUri?: string | undefined;
-                relationshipId?: string | undefined;
+                contentType?: string | undefined;
+                role?: string | undefined;
                 width?: number | undefined;
                 height?: number | undefined;
-                alt?: string | undefined;
+                alt: string;
             } | null;
             customAttributes: readonly {
                 name: string;
@@ -361,7 +357,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             resolvedByName: string | null | undefined;
             origin: "word" | "google-docs" | "unknown" | undefined;
             threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
-            threadingStyleOverride: import('../../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
+            threadingStyleOverride: import('../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
             threadingParentCommentId: string | null | undefined;
             originalXmlStructure: {
                 hasCommentsExtended: boolean;
@@ -375,7 +371,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             name?: string | null;
             superdoc: {
                 emit: (event: "comments-update", payload: {
-                    type: import('../../../../../shared/common/event-types.js').CommentEvent;
+                    type: import('../../../../shared/common/event-types.js').CommentEvent;
                     changes?: {
                         key: string;
                         value: unknown;
@@ -392,7 +388,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
                     modules?: import('../../public/index.js').Modules;
                 };
             };
-            decision?: "accept" | "reject";
+            decision?: import('./comment-params.js').TrackedChangeDecision;
             reconciliationToken?: symbol;
         }) => {
             ok: false;
@@ -402,7 +398,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isInternal: boolean;
             superdoc: {
                 emit: (event: "comments-update", payload: {
-                    type: import('../../../../../shared/common/event-types.js').CommentEvent;
+                    type: import('../../../../shared/common/event-types.js').CommentEvent;
                     changes?: {
                         key: string;
                         value: unknown;
@@ -423,12 +419,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             ok: false;
             reason: "read-only-document";
         } | undefined;
-        updatePosition: (coords: {
-            top: number;
-            left: number;
-            right: number;
-            bottom: number;
-        }, parentElement: Pick<Element, "getBoundingClientRect">) => void;
+        updatePosition: (coords: import('./comment-params.js').SelectionBounds, parentElement: Pick<Element, "getBoundingClientRect">) => void;
         getCommentUser: () => {
             name: string;
             email: string | null | undefined;
@@ -440,14 +431,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             email: string | null;
             image: string | null;
         };
-        updateIdentityValues: (updates?: {
-            commentId?: string;
-            importedId?: string | null;
-            parentCommentId?: string | null;
-            trackedChangeParentId?: string | null;
-            trackedChangeThreadParentId?: string | null;
-            threadingParentCommentId?: string | null;
-        }) => void;
+        updateIdentityValues: (updates?: import('./comment-params.js').CommentIdentity) => void;
     }[] | null;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
     commentDialogElement: HTMLDivElement;

package/dist/superdoc/src/components/CommentsLayer/collect-tracked-change-thread.d.ts

@@ -1,3 +1,4 @@
+type CommentId = string | number;
 /**
  * Collect every comment that should appear inside the tracked-change dialog
  * for `parentComment`. Walks two sources of membership:
@@ -16,8 +17,9 @@
  * Returns the comments belonging to this tracked-change thread, in original list order.
  */
 export declare const collectTrackedChangeThread: <Comment extends {
-    commentId: string;
-    parentCommentId?: string | null;
-    threadingParentCommentId?: string | null;
-    trackedChangeThreadParentId?: string | null;
+    commentId: CommentId;
+    parentCommentId?: CommentId | null;
+    threadingParentCommentId?: CommentId | null;
+    trackedChangeThreadParentId?: CommentId | null;
 }>(parentComment: Comment, allComments: ReadonlyArray<Comment>) => Array<Comment>;
+export {};

package/dist/superdoc/src/components/CommentsLayer/comment-params.d.ts

@@ -0,0 +1,84 @@
+import { TrackChangeCustomAttribute } from '../../../../document-api/src/index.js';
+import { StoryLocator } from '../../core/types/index.js';
+export type TrackedChangeDecision = 'accept' | 'reject';
+export type SelectionBounds = {
+    top: number;
+    left: number;
+    right: number;
+    bottom: number;
+};
+export type CommentMention = {
+    name?: string | null;
+    email?: string | null;
+};
+export type CommentAuthor = {
+    name?: string | null;
+    email?: string | null;
+};
+export type TrackedChangeDetailLine = {
+    excerpt: string;
+    label: string;
+};
+export type TrackedChangeRowImagePreview = {
+    src: string;
+    contentType?: string;
+    role?: string;
+    width?: number;
+    height?: number;
+    alt: string;
+};
+export type CommentSelectionParams = {
+    documentId?: unknown;
+    page?: number;
+    selectionBounds?: Partial<SelectionBounds> | null;
+    source?: string | null;
+};
+export type CommentIdentity = {
+    commentId?: string;
+    importedId?: string | null;
+    parentCommentId?: string | null;
+    trackedChangeParentId?: string | null;
+    trackedChangeThreadParentId?: string | null;
+    threadingParentCommentId?: string | null;
+};
+export type CommentInputParams = CommentIdentity & {
+    uid?: string;
+    trackedChangeSide?: string | null;
+    fileId?: string | null;
+    fileType?: string | null;
+    createdAtVersionNumber?: number | null;
+    isInternal?: boolean;
+    mentions?: CommentMention[];
+    isFocused?: boolean;
+    creatorId?: string | null;
+    creatorEmail?: string | null;
+    creatorName?: string | null;
+    creatorImage?: string | null;
+    createdTime?: number;
+    importedAuthor?: CommentAuthor | null;
+    docxCommentJSON?: unknown;
+    commentText?: string;
+    selection?: CommentSelectionParams | null;
+    trackedChange?: boolean;
+    trackedChangeType?: string | null;
+    trackedChangeText?: string | null;
+    trackedChangeDisplayType?: string | null;
+    semanticColorKey?: string | null;
+    semanticColor?: string | null;
+    trackedChangeStory?: StoryLocator | null;
+    trackedChangeStoryKind?: string | null;
+    trackedChangeStoryLabel?: string;
+    trackedChangeAnchorKey?: string | null;
+    trackedChangeCanonicalId?: string | null;
+    trackedChangePositionAliases?: string[];
+    deletedText?: string | null;
+    trackedChangeLabel?: string | null;
+    trackedChangeDetailLines?: TrackedChangeDetailLine[] | null;
+    trackedChangeImagePreview?: TrackedChangeRowImagePreview | null;
+    customAttributes?: readonly TrackChangeCustomAttribute[] | null;
+    resolvedTime?: number | null;
+    resolvedById?: string | null;
+    resolvedByEmail?: string | null;
+    resolvedByName?: string | null;
+    trackedChangeDecision?: TrackedChangeDecision | null;
+};

package/dist/superdoc/src/components/CommentsLayer/use-comment.d.ts

@@ -1,36 +1,13 @@
-import { TrackChangeCustomAttribute, TrackChangeImagePreview } from '../../../../document-api/src/index.js';
-import { CommentEvent, Comment as CommonComment, CommentThreadingStyle } from '../../../../../shared/common';
-import { Modules, StoryLocator } from '../../core/types/index.js';
+import { CommentEvent } from '../../../../shared/common/event-types.js';
+import { Comment as CommonComment } from '../../../../shared/common/comments-types.js';
+import { Modules } from '../../core/types/index.js';
+import { CommentIdentity, CommentInputParams, SelectionBounds, TrackedChangeDecision } from './comment-params.js';
+export type UseCommentParams = CommentInputParams & Pick<CommonComment, 'origin' | 'threadingMethod' | 'threadingStyleOverride' | 'originalXmlStructure'>;
 export declare const COMMENT_RECONCILIATION_TOKEN: unique symbol;
 type ReadOnlyMutationOutcome = {
     ok: false;
     reason: 'read-only-document';
 };
-type TrackedChangeDecision = 'accept' | 'reject';
-type SelectionBounds = {
-    top: number;
-    left: number;
-    right: number;
-    bottom: number;
-};
-type CommentMention = {
-    name?: string | null;
-    email?: string | null;
-};
-type CommentAuthor = {
-    name?: string | null;
-    email?: string | null;
-};
-type TrackedChangeDetailLine = {
-    excerpt: string;
-    label: string;
-};
-type CommentSelectionParams = {
-    documentId?: string | null;
-    page?: number;
-    selectionBounds?: Partial<SelectionBounds> | null;
-    source?: string | null;
-};
 type CommentChange = {
     key: string;
     value: unknown;
@@ -52,59 +29,6 @@ type CommentsHost = {
         modules?: Modules;
     };
 };
-type CommentIdentity = {
-    commentId?: string;
-    importedId?: string | null;
-    parentCommentId?: string | null;
-    trackedChangeParentId?: string | null;
-    trackedChangeThreadParentId?: string | null;
-    threadingParentCommentId?: string | null;
-};
-export type UseCommentParams = CommentIdentity & {
-    uid?: string;
-    trackedChangeSide?: string | null;
-    fileId?: string | null;
-    fileType?: string | null;
-    createdAtVersionNumber?: number | null;
-    isInternal?: boolean;
-    mentions?: CommentMention[];
-    isFocused?: boolean;
-    creatorId?: string | null;
-    creatorEmail?: string | null;
-    creatorName?: string | null;
-    creatorImage?: string | null;
-    createdTime?: number;
-    importedAuthor?: CommentAuthor | null;
-    docxCommentJSON?: unknown;
-    origin?: CommonComment['origin'];
-    threadingMethod?: CommonComment['threadingMethod'];
-    threadingStyleOverride?: CommentThreadingStyle;
-    originalXmlStructure?: CommonComment['originalXmlStructure'];
-    commentText?: string;
-    selection?: CommentSelectionParams;
-    trackedChange?: boolean;
-    trackedChangeType?: string | null;
-    trackedChangeText?: string | null;
-    trackedChangeDisplayType?: string | null;
-    semanticColorKey?: string | null;
-    semanticColor?: string | null;
-    trackedChangeStory?: StoryLocator | null;
-    trackedChangeStoryKind?: string | null;
-    trackedChangeStoryLabel?: string;
-    trackedChangeAnchorKey?: string | null;
-    trackedChangeCanonicalId?: string | null;
-    trackedChangePositionAliases?: string[];
-    deletedText?: string | null;
-    trackedChangeLabel?: string | null;
-    trackedChangeDetailLines?: TrackedChangeDetailLine[] | null;
-    trackedChangeImagePreview?: TrackChangeImagePreview | null;
-    customAttributes?: readonly TrackChangeCustomAttribute[] | null;
-    resolvedTime?: number | null;
-    resolvedById?: string | null;
-    resolvedByEmail?: string | null;
-    resolvedByName?: string | null;
-    trackedChangeDecision?: TrackedChangeDecision | null;
-};
 type ResolveCommentParams = {
     id?: string | null;
     email?: string | null;
@@ -188,7 +112,7 @@ export default function useComment(params: UseCommentParams): {
     trackedChangeDisplayType: string | null;
     semanticColorKey: string | null;
     semanticColor: string | null;
-    trackedChangeStory: StoryLocator | null;
+    trackedChangeStory: import('../../public/index.js').StoryLocator | null;
     trackedChangeStoryKind: string | null;
     trackedChangeStoryLabel: string;
     trackedChangeAnchorKey: string | null;
@@ -202,13 +126,11 @@ export default function useComment(params: UseCommentParams): {
     }[] | null;
     trackedChangeImagePreview: {
         src: string;
-        contentType: string;
-        role: "deleted" | "inserted" | "before" | "after";
-        partUri?: string | undefined;
-        relationshipId?: string | undefined;
+        contentType?: string | undefined;
+        role?: string | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        alt?: string | undefined;
+        alt: string;
     } | null;
     customAttributes: readonly {
         name: string;
@@ -227,7 +149,7 @@ export default function useComment(params: UseCommentParams): {
     docxCommentJSON: {} | null;
     origin: "word" | "google-docs" | "unknown" | undefined;
     threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
-    threadingStyleOverride: CommentThreadingStyle | undefined;
+    threadingStyleOverride: import('../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
     threadingParentCommentId: string | null | undefined;
     originalXmlStructure: {
         hasCommentsExtended: boolean;
@@ -279,7 +201,7 @@ export default function useComment(params: UseCommentParams): {
         trackedChangeDisplayType: string | null;
         semanticColorKey: string | null;
         semanticColor: string | null;
-        trackedChangeStory: StoryLocator | null;
+        trackedChangeStory: import('../../public/index.js').StoryLocator | null;
         trackedChangeStoryKind: string | null;
         trackedChangeStoryLabel: string;
         trackedChangeAnchorKey: string | null;
@@ -293,13 +215,11 @@ export default function useComment(params: UseCommentParams): {
         }[] | null;
         trackedChangeImagePreview: {
             src: string;
-            contentType: string;
-            role: "deleted" | "inserted" | "before" | "after";
-            partUri?: string | undefined;
-            relationshipId?: string | undefined;
+            contentType?: string | undefined;
+            role?: string | undefined;
             width?: number | undefined;
             height?: number | undefined;
-            alt?: string | undefined;
+            alt: string;
         } | null;
         customAttributes: readonly {
             name: string;
@@ -314,7 +234,7 @@ export default function useComment(params: UseCommentParams): {
         resolvedByName: string | null | undefined;
         origin: "word" | "google-docs" | "unknown" | undefined;
         threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
-        threadingStyleOverride: CommentThreadingStyle | undefined;
+        threadingStyleOverride: import('../../../../shared/common/comments-types.js').CommentThreadingStyle | undefined;
         threadingParentCommentId: string | null | undefined;
         originalXmlStructure: {
             hasCommentsExtended: boolean;

package/dist/superdoc/src/components/Whiteboard/use-whiteboard.d.ts

@@ -1,26 +1,47 @@
 import { Ref } from 'vue';
-import { SuperDoc } from '../../core/SuperDoc.js';
+import { EventEmitter } from '../../core/EventEmitter.js';
 import { Document, Modules } from '../../core/types/index.js';
-import { WhiteboardPageSize } from '../../core/whiteboard/Whiteboard.js';
+import { Whiteboard, WhiteboardEventMap, WhiteboardPageSize } from '../../core/whiteboard/Whiteboard.js';
 import { WhiteboardPage } from '../../core/whiteboard/WhiteboardPage.js';
 import { PdfPageRenderedPayload } from '../PdfViewer/pdf-viewer-types.js';
 import { WhiteboardPageOffset } from './whiteboard-types.js';
 type WhiteboardDocument = Pick<Document, 'id' | 'type'>;
-type WhiteboardPageReadyPayload = Pick<PdfPageRenderedPayload, 'pageIndex' | 'width' | 'height' | 'originalWidth' | 'originalHeight'>;
-export type UseWhiteboardOptions = {
+type WhiteboardPageReadyPayload = Pick<PdfPageRenderedPayload, 'pageIndex' | 'width' | 'height'> & Partial<Pick<PdfPageRenderedPayload, 'originalWidth' | 'originalHeight'>>;
+type Bounds = Pick<DOMRect, 'top' | 'left'>;
+type WhiteboardLayerElement = {
+    getBoundingClientRect(): Bounds;
+};
+type WhiteboardPageSource = Pick<WhiteboardPage, 'pageIndex' | 'size' | 'setSize'>;
+type WhiteboardSource = Pick<Whiteboard, 'on' | 'off' | 'setPageSize'> & {
+    getPage(...args: Parameters<Whiteboard['getPage']>): WhiteboardPageSource | undefined;
+    getPages(): WhiteboardPageSource[];
+};
+type WhiteboardSourcePage<Board extends WhiteboardSource> = ReturnType<Board['getPages']>[number];
+type WhiteboardHostEvents<Board extends WhiteboardSource> = {
+    'whiteboard:ready': [{
+        whiteboard: Board;
+    }];
+    'whiteboard:change': WhiteboardEventMap['change'];
+    'whiteboard:enabled': WhiteboardEventMap['enabled'];
+    'whiteboard:tool': WhiteboardEventMap['tool'];
+};
+export type UseWhiteboardOptions<Board extends WhiteboardSource> = {
     proxy: {
-        $superdoc: Pick<SuperDoc, 'emit' | 'whiteboard'>;
+        $superdoc: Pick<EventEmitter<WhiteboardHostEvents<Board>>, 'emit'> & {
+            whiteboard?: Board | null;
+        };
     };
-    layers: Ref<HTMLElement | null>;
+    layers: Ref<WhiteboardLayerElement | null>;
     documents: Ref<WhiteboardDocument[]>;
     modules: Modules;
 };
-export declare const useWhiteboard: ({ proxy, layers, documents, modules }: UseWhiteboardOptions) => {
-    whiteboard: import('../../core/whiteboard/Whiteboard.js').Whiteboard | null;
+type Options<Board extends WhiteboardSource> = UseWhiteboardOptions<Board>;
+export declare const useWhiteboard: <B extends WhiteboardSource>({ proxy, layers, documents, modules }: Options<B>) => {
+    whiteboard: B | null | undefined;
     whiteboardModuleConfig: import('vue').ComputedRef<{
         enabled?: boolean;
     } | null>;
-    whiteboardPages: import('vue').ShallowRef<WhiteboardPage[], WhiteboardPage[]>;
+    whiteboardPages: import('vue').ShallowRef<WhiteboardSourcePage<B>[], WhiteboardSourcePage<B>[]>;
     whiteboardPageSizes: Record<number, WhiteboardPageSize>;
     whiteboardPageOffsets: Record<number, WhiteboardPageOffset>;
     whiteboardEnabled: Ref<boolean, boolean>;

package/dist/superdoc/src/composables/use-comment-sidebar.d.ts

@@ -0,0 +1,6 @@
+import { Ref } from 'vue';
+export declare function useCommentSidebar({ documentKey, enabled, hasContent, }: {
+    documentKey: Readonly<Ref<string>>;
+    enabled: Readonly<Ref<boolean>>;
+    hasContent: Readonly<Ref<boolean>>;
+}): import('vue').ComputedRef<boolean>;