superdoc 2.29.0-next.1 → 2.29.0-next.13

package/dist/superdoc/src/composables/use-document.d.ts

@@ -1,37 +1,1217 @@
-export default function useDocument(params: any, superdocConfig: any): {
-    id: any;
-    data: any;
-    html: any;
-    markdown: any;
-    password: any;
-    fieldContext: any;
-    load: any;
-    loadScope: any;
+import { FieldDefinition } from './use-field.js';
+import { UseCommentParams } from '../components/CommentsLayer/use-comment.js';
+import { DocumentRendererRuntime, Editor, InternalConfig, RuntimeDocument } from '../core/types/index.js';
+type UseDocumentParams = Pick<RuntimeDocument, 'id' | 'data' | 'password' | 'fieldContext' | 'load' | 'loadScope' | 'role' | 'ydoc' | 'provider' | 'isNewFile' | 'v2Collaboration'> & {
+    type?: string;
+    state?: unknown;
+    html?: string;
+    markdown?: string;
+    socket?: unknown;
+    fields?: FieldDefinition[];
+    annotations?: unknown[];
+    conversations?: UseCommentParams[];
+    commentThreadingProfile?: unknown;
+};
+type DocumentPageContainer = {
+    page: number;
+    containerBounds?: unknown;
+    container?: Element | null;
+};
+type UseDocumentConfig = Pick<InternalConfig, 'modules' | 'rulers'>;
+export default function useDocument(params: UseDocumentParams, superdocConfig: UseDocumentConfig | null): {
+    id: string | undefined;
+    data: File | Blob | null | undefined;
+    html: string | undefined;
+    markdown: string | undefined;
+    password: string | undefined;
+    fieldContext: {
+        fileName?: string | null;
+        fullPath?: string | null;
+        currentUser?: {
+            name?: string | null;
+            initials?: string | null;
+            address?: string | null;
+        } | null;
+    } | undefined;
+    load: import('../public/index.js').DocumentLoadOptions | undefined;
+    loadScope: {
+        signal: AbortSignal;
+        wait<T>(task: Promise<T>): Promise<T>;
+        assertActive(): void;
+        finish(): boolean;
+        cancel: () => void;
+        onSettled(listener: () => void): void;
+        onFailure(listener: (error: import('../public/index.js').DocumentLoadError) => void): () => boolean;
+    } | undefined;
     type: string;
-    config: any;
-    state: any;
-    role: any;
+    config: UseDocumentConfig;
+    state: unknown;
+    role: "editor" | "viewer" | "suggester" | undefined;
     core: import('vue').Ref<null, null>;
     editorMountNonce: import('vue').Ref<number, number>;
-    ydoc: import('vue').ShallowRef<any, any>;
-    provider: import('vue').ShallowRef<any, any>;
-    socket: import('vue').ShallowRef<any, any>;
-    isNewFile: import('vue').Ref<any, any>;
-    v2Collaboration: import('vue').ShallowRef<any, any>;
-    container: import('vue').Ref<null, null>;
-    pageContainers: import('vue').Ref<never[], never[]>;
+    ydoc: import('vue').ShallowRef<import('yjs').Doc | undefined, import('yjs').Doc | undefined>;
+    provider: import('vue').ShallowRef<import('../core/types/index.js').CollaborationProvider | undefined, import('../core/types/index.js').CollaborationProvider | undefined>;
+    socket: import('vue').ShallowRef<unknown, unknown>;
+    isNewFile: import('vue').Ref<boolean | undefined, boolean | undefined>;
+    v2Collaboration: import('vue').ShallowRef<import('../public/index.js').DocumentCollaborationConfig | null, import('../public/index.js').DocumentCollaborationConfig | null>;
+    container: import('vue').Ref<Element | null, Element | null>;
+    pageContainers: import('vue').Ref<{
+        page: number;
+        containerBounds?: unknown;
+        container?: (Element | null) | undefined;
+    }[], DocumentPageContainer[] | {
+        page: number;
+        containerBounds?: unknown;
+        container?: (Element | null) | undefined;
+    }[]>;
     isReady: import('vue').Ref<boolean, boolean>;
-    rulers: import('vue').Ref<any, any>;
-    rawFields: import('vue').Ref<any, any>;
-    fields: import('vue').Ref<any, any>;
-    annotations: import('vue').Ref<any, any>;
-    conversations: import('vue').Ref<any, any>;
-    commentThreadingProfile: import('vue').Ref<any, any>;
-    setEditor: (ref: any) => any;
-    getEditor: () => null;
-    setDocumentRuntime: (ref: any) => any;
-    getDocumentRuntime: () => null;
+    rulers: import('vue').Ref<boolean | undefined, boolean | undefined>;
+    rawFields: import('vue').Ref<{
+        itemid: {
+            value?: unknown;
+        };
+        itemicon?: unknown;
+        itemiconpack?: unknown;
+        itemdisplaylabel?: unknown;
+        itemlinkvalue?: unknown;
+        itemplaceholdertext?: unknown;
+        itemtype?: string | undefined;
+        itemfieldtype?: unknown;
+        itemformat?: unknown;
+        itemoptions?: {
+            itemdisplaylabel?: unknown;
+            itemlinkvalue?: unknown;
+            ischecked?: unknown;
+            itemid?: unknown;
+            annotationId?: unknown;
+        }[] | null | undefined;
+        iteminputtype?: unknown;
+        fontfamily?: string | null | undefined;
+        font_size?: string | null | undefined;
+        original_font_size?: string | null | undefined;
+        logicrules?: unknown;
+        valueGetter?: ((data: object) => string) | undefined;
+    }[], FieldDefinition[] | {
+        itemid: {
+            value?: unknown;
+        };
+        itemicon?: unknown;
+        itemiconpack?: unknown;
+        itemdisplaylabel?: unknown;
+        itemlinkvalue?: unknown;
+        itemplaceholdertext?: unknown;
+        itemtype?: string | undefined;
+        itemfieldtype?: unknown;
+        itemformat?: unknown;
+        itemoptions?: {
+            itemdisplaylabel?: unknown;
+            itemlinkvalue?: unknown;
+            ischecked?: unknown;
+            itemid?: unknown;
+            annotationId?: unknown;
+        }[] | null | undefined;
+        iteminputtype?: unknown;
+        fontfamily?: string | null | undefined;
+        font_size?: string | null | undefined;
+        original_font_size?: string | null | undefined;
+        logicrules?: unknown;
+        valueGetter?: ((data: object) => string) | undefined;
+    }[]>;
+    fields: import('vue').Ref<{
+        id: {
+            value?: unknown;
+        };
+        icon: unknown;
+        iconPack: unknown;
+        label: unknown;
+        placeholder: unknown;
+        fieldType: string | undefined;
+        fieldSubType: unknown;
+        value: {};
+        format: unknown;
+        logicRules: unknown;
+        hidden: boolean;
+        originalJSON: {
+            itemid: {
+                value?: unknown;
+            };
+            itemicon?: unknown;
+            itemiconpack?: unknown;
+            itemdisplaylabel?: unknown;
+            itemlinkvalue?: unknown;
+            itemplaceholdertext?: unknown;
+            itemtype?: string | undefined;
+            itemfieldtype?: unknown;
+            itemformat?: unknown;
+            itemoptions?: {
+                itemdisplaylabel?: unknown;
+                itemlinkvalue?: unknown;
+                ischecked?: unknown;
+                itemid?: unknown;
+                annotationId?: unknown;
+            }[] | null | undefined;
+            iteminputtype?: unknown;
+            fontfamily?: string | null | undefined;
+            font_size?: string | null | undefined;
+            original_font_size?: string | null | undefined;
+            logicrules?: unknown;
+            valueGetter?: ((data: object) => string) | undefined;
+        };
+        fieldStyle: {
+            fontFamily: string;
+            fontSize: string;
+            originalFontSize: string;
+        };
+        valueGetter: ((data: object) => string) | undefined;
+    }[], {
+        id: import('vue').Ref<{
+            value?: unknown;
+        }, {
+            value?: unknown;
+        } | {
+            value?: unknown;
+        }>;
+        icon: import('vue').Ref<unknown, unknown>;
+        iconPack: import('vue').Ref<unknown, unknown>;
+        label: import('vue').Ref<unknown, unknown>;
+        placeholder: unknown;
+        fieldType: import('vue').Ref<string | undefined, string | undefined>;
+        fieldSubType: import('vue').Ref<unknown, unknown>;
+        value: {};
+        format: import('vue').Ref<unknown, unknown>;
+        logicRules: import('vue').Ref<unknown, unknown>;
+        hidden: import('vue').Ref<boolean, boolean>;
+        originalJSON: FieldDefinition;
+        fieldStyle: {
+            fontFamily: string;
+            fontSize: string;
+            originalFontSize: string;
+        };
+        valueGetter: ((data: object) => string) | undefined;
+    }[] | {
+        id: {
+            value?: unknown;
+        };
+        icon: unknown;
+        iconPack: unknown;
+        label: unknown;
+        placeholder: unknown;
+        fieldType: string | undefined;
+        fieldSubType: unknown;
+        value: {};
+        format: unknown;
+        logicRules: unknown;
+        hidden: boolean;
+        originalJSON: {
+            itemid: {
+                value?: unknown;
+            };
+            itemicon?: unknown;
+            itemiconpack?: unknown;
+            itemdisplaylabel?: unknown;
+            itemlinkvalue?: unknown;
+            itemplaceholdertext?: unknown;
+            itemtype?: string | undefined;
+            itemfieldtype?: unknown;
+            itemformat?: unknown;
+            itemoptions?: {
+                itemdisplaylabel?: unknown;
+                itemlinkvalue?: unknown;
+                ischecked?: unknown;
+                itemid?: unknown;
+                annotationId?: unknown;
+            }[] | null | undefined;
+            iteminputtype?: unknown;
+            fontfamily?: string | null | undefined;
+            font_size?: string | null | undefined;
+            original_font_size?: string | null | undefined;
+            logicrules?: unknown;
+            valueGetter?: ((data: object) => string) | undefined;
+        };
+        fieldStyle: {
+            fontFamily: string;
+            fontSize: string;
+            originalFontSize: string;
+        };
+        valueGetter: ((data: object) => string) | undefined;
+    }[]>;
+    annotations: import('vue').Ref<unknown[], unknown[]>;
+    conversations: import('vue').Ref<{
+        uid: string | undefined;
+        commentId: string;
+        importedId: string | null | undefined;
+        parentCommentId: string | null | undefined;
+        trackedChangeParentId: string | null | undefined;
+        trackedChangeThreadParentId: string | null | undefined;
+        trackedChangeSide: string | null | undefined;
+        fileId: string | null | undefined;
+        fileType: string | null | undefined;
+        mentions: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        }[];
+        commentElement: HTMLElement | null;
+        isFocused: boolean;
+        creatorId: string | null;
+        creatorEmail: string | null;
+        creatorName: string | null;
+        creatorImage: string | null;
+        createdTime: number;
+        isInternal: boolean;
+        commentText: string;
+        selection: {
+            documentId: unknown;
+            page: number | undefined;
+            selectionBounds: {
+                top?: number | undefined;
+                left?: number | undefined;
+                right?: number | undefined;
+                bottom?: number | undefined;
+            };
+            getValues: () => {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            };
+            getContainerId: () => string;
+            getContainerLocation: (parentContainer: Pick<Element, "getBoundingClientRect"> | null | undefined) => {
+                top: number;
+                left: number;
+            };
+            source: string | null | undefined;
+        };
+        floatingPosition: {
+            top?: number | undefined;
+            left?: number | undefined;
+            right?: number | undefined;
+            bottom?: number | undefined;
+        };
+        trackedChange: boolean | undefined;
+        deletedText: string | null;
+        trackedChangeType: string | null;
+        trackedChangeText: string | null;
+        trackedChangeDisplayType: string | null;
+        semanticColorKey: string | null;
+        semanticColor: string | null;
+        trackedChangeStory: import('../public/index.js').StoryLocator | null;
+        trackedChangeStoryKind: string | null;
+        trackedChangeStoryLabel: string;
+        trackedChangeAnchorKey: string | null;
+        trackedChangeCanonicalId: string | null;
+        trackedChangePositionAliases: string[];
+        trackedChangeDecision: ("accept" | "reject") | null;
+        trackedChangeLabel: string | null;
+        trackedChangeDetailLines: {
+            excerpt: string;
+            label: string;
+        }[] | null;
+        trackedChangeImagePreview: {
+            src: string;
+            contentType: string;
+            role: "deleted" | "inserted" | "before" | "after";
+            partUri?: string | undefined;
+            relationshipId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+            alt?: string | undefined;
+        } | null;
+        customAttributes: readonly {
+            name: string;
+            namespaceUri: string;
+            localName: string;
+            value: string;
+        }[] | null;
+        resolvedTime: number | null;
+        resolvedById: string | null;
+        resolvedByEmail: string | null | undefined;
+        resolvedByName: string | null | undefined;
+        importedAuthor: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        } | null;
+        docxCommentJSON: {} | null;
+        origin: "word" | "google-docs" | "unknown" | undefined;
+        threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+        threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+        threadingParentCommentId: string | null | undefined;
+        originalXmlStructure: {
+            hasCommentsExtended: boolean;
+            hasCommentsExtensible: boolean;
+            hasCommentsIds: boolean;
+        } | undefined;
+        setText: ({ text, superdoc, suppressUpdate }: {
+            text: string;
+            superdoc?: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate: true;
+        } | {
+            text: string;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate?: false;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        getValues: () => {
+            uid: string | undefined;
+            commentId: string | undefined;
+            importedId: string | null | undefined;
+            parentCommentId: string | null | undefined;
+            trackedChangeParentId: string | null | undefined;
+            trackedChangeThreadParentId: string | null | undefined;
+            trackedChangeSide: string | null | undefined;
+            fileId: string | null | undefined;
+            fileType: string | null | undefined;
+            mentions: {
+                name: string | null | undefined;
+                email?: string | null | undefined;
+            }[];
+            createdAtVersionNumber: number | null | undefined;
+            creatorId: string | null;
+            creatorEmail: string | null;
+            creatorName: string | null;
+            creatorImage: string | null;
+            createdTime: number;
+            importedAuthor: {
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | null;
+            docxCommentJSON: {} | null;
+            isInternal: boolean;
+            commentText: string;
+            selection: {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            } | null;
+            trackedChange: boolean | undefined;
+            trackedChangeText: string | null;
+            trackedChangeType: string | null;
+            trackedChangeDisplayType: string | null;
+            semanticColorKey: string | null;
+            semanticColor: string | null;
+            trackedChangeStory: import('../public/index.js').StoryLocator | null;
+            trackedChangeStoryKind: string | null;
+            trackedChangeStoryLabel: string;
+            trackedChangeAnchorKey: string | null;
+            trackedChangeCanonicalId: string | null;
+            trackedChangePositionAliases: string[];
+            trackedChangeDecision: ("accept" | "reject") | null;
+            trackedChangeLabel: string | null;
+            trackedChangeDetailLines: {
+                excerpt: string;
+                label: string;
+            }[] | null;
+            trackedChangeImagePreview: {
+                src: string;
+                contentType: string;
+                role: "deleted" | "inserted" | "before" | "after";
+                partUri?: string | undefined;
+                relationshipId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                alt?: string | undefined;
+            } | null;
+            customAttributes: readonly {
+                name: string;
+                namespaceUri: string;
+                localName: string;
+                value: string;
+            }[] | null;
+            deletedText: string | null;
+            resolvedTime: number | null;
+            resolvedById: string | null;
+            resolvedByEmail: string | null | undefined;
+            resolvedByName: string | null | undefined;
+            origin: "word" | "google-docs" | "unknown" | undefined;
+            threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+            threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+            threadingParentCommentId: string | null | undefined;
+            originalXmlStructure: {
+                hasCommentsExtended: boolean;
+                hasCommentsExtensible: boolean;
+                hasCommentsIds: boolean;
+            } | undefined;
+        };
+        resolveComment: ({ id, email, name, superdoc, decision, reconciliationToken, }: {
+            id?: string | null;
+            email?: string | null;
+            name?: string | null;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            decision?: "accept" | "reject";
+            reconciliationToken?: symbol;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        setIsInternal: ({ isInternal: newIsInternal, superdoc, }: {
+            isInternal: boolean;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        updatePosition: (coords: {
+            top: number;
+            left: number;
+            right: number;
+            bottom: number;
+        }, parentElement: Pick<Element, "getBoundingClientRect">) => void;
+        getCommentUser: () => {
+            name: string;
+            email: string | null | undefined;
+            id?: undefined;
+            image?: undefined;
+        } | {
+            id: string | null;
+            name: string | null;
+            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;
+    }[], {
+        uid: string | undefined;
+        commentId: string;
+        importedId: string | null | undefined;
+        parentCommentId: string | null | undefined;
+        trackedChangeParentId: string | null | undefined;
+        trackedChangeThreadParentId: string | null | undefined;
+        trackedChangeSide: string | null | undefined;
+        fileId: string | null | undefined;
+        fileType: string | null | undefined;
+        mentions: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        }[];
+        commentElement: HTMLElement | null;
+        isFocused: boolean;
+        creatorId: string | null;
+        creatorEmail: string | null;
+        creatorName: string | null;
+        creatorImage: string | null;
+        createdTime: number;
+        isInternal: boolean;
+        commentText: string;
+        selection: {
+            documentId: unknown;
+            page: number | undefined;
+            selectionBounds: {
+                top?: number | undefined;
+                left?: number | undefined;
+                right?: number | undefined;
+                bottom?: number | undefined;
+            };
+            getValues: () => {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            };
+            getContainerId: () => string;
+            getContainerLocation: (parentContainer: Pick<Element, "getBoundingClientRect"> | null | undefined) => {
+                top: number;
+                left: number;
+            };
+            source: string | null | undefined;
+        };
+        floatingPosition: {
+            top?: number | undefined;
+            left?: number | undefined;
+            right?: number | undefined;
+            bottom?: number | undefined;
+        };
+        trackedChange: boolean | undefined;
+        deletedText: string | null;
+        trackedChangeType: string | null;
+        trackedChangeText: string | null;
+        trackedChangeDisplayType: string | null;
+        semanticColorKey: string | null;
+        semanticColor: string | null;
+        trackedChangeStory: import('../public/index.js').StoryLocator | null;
+        trackedChangeStoryKind: string | null;
+        trackedChangeStoryLabel: string;
+        trackedChangeAnchorKey: string | null;
+        trackedChangeCanonicalId: string | null;
+        trackedChangePositionAliases: string[];
+        trackedChangeDecision: ("accept" | "reject") | null;
+        trackedChangeLabel: string | null;
+        trackedChangeDetailLines: {
+            excerpt: string;
+            label: string;
+        }[] | null;
+        trackedChangeImagePreview: {
+            src: string;
+            contentType: string;
+            role: "deleted" | "inserted" | "before" | "after";
+            partUri?: string | undefined;
+            relationshipId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+            alt?: string | undefined;
+        } | null;
+        customAttributes: readonly {
+            name: string;
+            namespaceUri: string;
+            localName: string;
+            value: string;
+        }[] | null;
+        resolvedTime: number | null;
+        resolvedById: string | null;
+        resolvedByEmail: string | null | undefined;
+        resolvedByName: string | null | undefined;
+        importedAuthor: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        } | null;
+        docxCommentJSON: {} | null;
+        origin: "word" | "google-docs" | "unknown" | undefined;
+        threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+        threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+        threadingParentCommentId: string | null | undefined;
+        originalXmlStructure: {
+            hasCommentsExtended: boolean;
+            hasCommentsExtensible: boolean;
+            hasCommentsIds: boolean;
+        } | undefined;
+        setText: ({ text, superdoc, suppressUpdate }: {
+            text: string;
+            superdoc?: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate: true;
+        } | {
+            text: string;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate?: false;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        getValues: () => {
+            uid: string | undefined;
+            commentId: string | undefined;
+            importedId: string | null | undefined;
+            parentCommentId: string | null | undefined;
+            trackedChangeParentId: string | null | undefined;
+            trackedChangeThreadParentId: string | null | undefined;
+            trackedChangeSide: string | null | undefined;
+            fileId: string | null | undefined;
+            fileType: string | null | undefined;
+            mentions: {
+                name: string | null | undefined;
+                email?: string | null | undefined;
+            }[];
+            createdAtVersionNumber: number | null | undefined;
+            creatorId: string | null;
+            creatorEmail: string | null;
+            creatorName: string | null;
+            creatorImage: string | null;
+            createdTime: number;
+            importedAuthor: {
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | null;
+            docxCommentJSON: {} | null;
+            isInternal: boolean;
+            commentText: string;
+            selection: {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            } | null;
+            trackedChange: boolean | undefined;
+            trackedChangeText: string | null;
+            trackedChangeType: string | null;
+            trackedChangeDisplayType: string | null;
+            semanticColorKey: string | null;
+            semanticColor: string | null;
+            trackedChangeStory: import('../public/index.js').StoryLocator | null;
+            trackedChangeStoryKind: string | null;
+            trackedChangeStoryLabel: string;
+            trackedChangeAnchorKey: string | null;
+            trackedChangeCanonicalId: string | null;
+            trackedChangePositionAliases: string[];
+            trackedChangeDecision: ("accept" | "reject") | null;
+            trackedChangeLabel: string | null;
+            trackedChangeDetailLines: {
+                excerpt: string;
+                label: string;
+            }[] | null;
+            trackedChangeImagePreview: {
+                src: string;
+                contentType: string;
+                role: "deleted" | "inserted" | "before" | "after";
+                partUri?: string | undefined;
+                relationshipId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                alt?: string | undefined;
+            } | null;
+            customAttributes: readonly {
+                name: string;
+                namespaceUri: string;
+                localName: string;
+                value: string;
+            }[] | null;
+            deletedText: string | null;
+            resolvedTime: number | null;
+            resolvedById: string | null;
+            resolvedByEmail: string | null | undefined;
+            resolvedByName: string | null | undefined;
+            origin: "word" | "google-docs" | "unknown" | undefined;
+            threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+            threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+            threadingParentCommentId: string | null | undefined;
+            originalXmlStructure: {
+                hasCommentsExtended: boolean;
+                hasCommentsExtensible: boolean;
+                hasCommentsIds: boolean;
+            } | undefined;
+        };
+        resolveComment: ({ id, email, name, superdoc, decision, reconciliationToken, }: {
+            id?: string | null;
+            email?: string | null;
+            name?: string | null;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            decision?: "accept" | "reject";
+            reconciliationToken?: symbol;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        setIsInternal: ({ isInternal: newIsInternal, superdoc, }: {
+            isInternal: boolean;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        updatePosition: (coords: {
+            top: number;
+            left: number;
+            right: number;
+            bottom: number;
+        }, parentElement: Pick<Element, "getBoundingClientRect">) => void;
+        getCommentUser: () => {
+            name: string;
+            email: string | null | undefined;
+            id?: undefined;
+            image?: undefined;
+        } | {
+            id: string | null;
+            name: string | null;
+            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;
+    }[] | {
+        uid: string | undefined;
+        commentId: string;
+        importedId: string | null | undefined;
+        parentCommentId: string | null | undefined;
+        trackedChangeParentId: string | null | undefined;
+        trackedChangeThreadParentId: string | null | undefined;
+        trackedChangeSide: string | null | undefined;
+        fileId: string | null | undefined;
+        fileType: string | null | undefined;
+        mentions: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        }[];
+        commentElement: HTMLElement | null;
+        isFocused: boolean;
+        creatorId: string | null;
+        creatorEmail: string | null;
+        creatorName: string | null;
+        creatorImage: string | null;
+        createdTime: number;
+        isInternal: boolean;
+        commentText: string;
+        selection: {
+            documentId: unknown;
+            page: number | undefined;
+            selectionBounds: {
+                top?: number | undefined;
+                left?: number | undefined;
+                right?: number | undefined;
+                bottom?: number | undefined;
+            };
+            getValues: () => {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            };
+            getContainerId: () => string;
+            getContainerLocation: (parentContainer: Pick<Element, "getBoundingClientRect"> | null | undefined) => {
+                top: number;
+                left: number;
+            };
+            source: string | null | undefined;
+        };
+        floatingPosition: {
+            top?: number | undefined;
+            left?: number | undefined;
+            right?: number | undefined;
+            bottom?: number | undefined;
+        };
+        trackedChange: boolean | undefined;
+        deletedText: string | null;
+        trackedChangeType: string | null;
+        trackedChangeText: string | null;
+        trackedChangeDisplayType: string | null;
+        semanticColorKey: string | null;
+        semanticColor: string | null;
+        trackedChangeStory: import('../public/index.js').StoryLocator | null;
+        trackedChangeStoryKind: string | null;
+        trackedChangeStoryLabel: string;
+        trackedChangeAnchorKey: string | null;
+        trackedChangeCanonicalId: string | null;
+        trackedChangePositionAliases: string[];
+        trackedChangeDecision: ("accept" | "reject") | null;
+        trackedChangeLabel: string | null;
+        trackedChangeDetailLines: {
+            excerpt: string;
+            label: string;
+        }[] | null;
+        trackedChangeImagePreview: {
+            src: string;
+            contentType: string;
+            role: "deleted" | "inserted" | "before" | "after";
+            partUri?: string | undefined;
+            relationshipId?: string | undefined;
+            width?: number | undefined;
+            height?: number | undefined;
+            alt?: string | undefined;
+        } | null;
+        customAttributes: readonly {
+            name: string;
+            namespaceUri: string;
+            localName: string;
+            value: string;
+        }[] | null;
+        resolvedTime: number | null;
+        resolvedById: string | null;
+        resolvedByEmail: string | null | undefined;
+        resolvedByName: string | null | undefined;
+        importedAuthor: {
+            name?: string | null | undefined;
+            email?: string | null | undefined;
+        } | null;
+        docxCommentJSON: {} | null;
+        origin: "word" | "google-docs" | "unknown" | undefined;
+        threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+        threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+        threadingParentCommentId: string | null | undefined;
+        originalXmlStructure: {
+            hasCommentsExtended: boolean;
+            hasCommentsExtensible: boolean;
+            hasCommentsIds: boolean;
+        } | undefined;
+        setText: ({ text, superdoc, suppressUpdate }: {
+            text: string;
+            superdoc?: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate: true;
+        } | {
+            text: string;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            suppressUpdate?: false;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        getValues: () => {
+            uid: string | undefined;
+            commentId: string | undefined;
+            importedId: string | null | undefined;
+            parentCommentId: string | null | undefined;
+            trackedChangeParentId: string | null | undefined;
+            trackedChangeThreadParentId: string | null | undefined;
+            trackedChangeSide: string | null | undefined;
+            fileId: string | null | undefined;
+            fileType: string | null | undefined;
+            mentions: {
+                name: string | null | undefined;
+                email?: string | null | undefined;
+            }[];
+            createdAtVersionNumber: number | null | undefined;
+            creatorId: string | null;
+            creatorEmail: string | null;
+            creatorName: string | null;
+            creatorImage: string | null;
+            createdTime: number;
+            importedAuthor: {
+                name?: string | null | undefined;
+                email?: string | null | undefined;
+            } | null;
+            docxCommentJSON: {} | null;
+            isInternal: boolean;
+            commentText: string;
+            selection: {
+                documentId: unknown;
+                page: number | undefined;
+                selectionBounds: {
+                    top?: number;
+                    left?: number;
+                    right?: number;
+                    bottom?: number;
+                };
+                source: string | null | undefined;
+            } | null;
+            trackedChange: boolean | undefined;
+            trackedChangeText: string | null;
+            trackedChangeType: string | null;
+            trackedChangeDisplayType: string | null;
+            semanticColorKey: string | null;
+            semanticColor: string | null;
+            trackedChangeStory: import('../public/index.js').StoryLocator | null;
+            trackedChangeStoryKind: string | null;
+            trackedChangeStoryLabel: string;
+            trackedChangeAnchorKey: string | null;
+            trackedChangeCanonicalId: string | null;
+            trackedChangePositionAliases: string[];
+            trackedChangeDecision: ("accept" | "reject") | null;
+            trackedChangeLabel: string | null;
+            trackedChangeDetailLines: {
+                excerpt: string;
+                label: string;
+            }[] | null;
+            trackedChangeImagePreview: {
+                src: string;
+                contentType: string;
+                role: "deleted" | "inserted" | "before" | "after";
+                partUri?: string | undefined;
+                relationshipId?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                alt?: string | undefined;
+            } | null;
+            customAttributes: readonly {
+                name: string;
+                namespaceUri: string;
+                localName: string;
+                value: string;
+            }[] | null;
+            deletedText: string | null;
+            resolvedTime: number | null;
+            resolvedById: string | null;
+            resolvedByEmail: string | null | undefined;
+            resolvedByName: string | null | undefined;
+            origin: "word" | "google-docs" | "unknown" | undefined;
+            threadingMethod: "commentsExtended" | "range-based" | "mixed" | undefined;
+            threadingStyleOverride: import('../../../../shared/common').CommentThreadingStyle | undefined;
+            threadingParentCommentId: string | null | undefined;
+            originalXmlStructure: {
+                hasCommentsExtended: boolean;
+                hasCommentsExtensible: boolean;
+                hasCommentsIds: boolean;
+            } | undefined;
+        };
+        resolveComment: ({ id, email, name, superdoc, decision, reconciliationToken, }: {
+            id?: string | null;
+            email?: string | null;
+            name?: string | null;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+            decision?: "accept" | "reject";
+            reconciliationToken?: symbol;
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        setIsInternal: ({ isInternal: newIsInternal, superdoc, }: {
+            isInternal: boolean;
+            superdoc: {
+                emit: (event: "comments-update", payload: {
+                    type: import('../../../../shared/common').CommentEvent;
+                    changes?: {
+                        key: string;
+                        value: unknown;
+                        previousValue?: unknown;
+                    }[];
+                    comment: unknown;
+                }) => unknown;
+                commentsStore?: {
+                    getConfig?: {
+                        readOnly?: boolean;
+                    };
+                };
+                config?: {
+                    modules?: import('../public/index.js').Modules;
+                };
+            };
+        }) => {
+            ok: false;
+            reason: "read-only-document";
+        } | undefined;
+        updatePosition: (coords: {
+            top: number;
+            left: number;
+            right: number;
+            bottom: number;
+        }, parentElement: Pick<Element, "getBoundingClientRect">) => void;
+        getCommentUser: () => {
+            name: string;
+            email: string | null | undefined;
+            id?: undefined;
+            image?: undefined;
+        } | {
+            id: string | null;
+            name: string | null;
+            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;
+    }[]>;
+    commentThreadingProfile: import('vue').Ref<{} | null, {} | null>;
+    setEditor: (ref: Editor | null) => Editor | null;
+    getEditor: () => Editor | null;
+    setDocumentRuntime: (ref: DocumentRendererRuntime | null) => DocumentRendererRuntime | null;
+    getDocumentRuntime: () => DocumentRendererRuntime | null;
     removeComments: () => void;
     restoreComments: () => void;
-    removeConversation: (conversationId: any) => void;
 };
+export {};