npm - superdoc - Versions diffs - 2.28.0 → 2.29.0-next.2 - Mend

superdoc 2.28.0 → 2.29.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

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

@@ -1,19 +1,694 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    focus: (options: any) => void;
-    $emit: (event: "focus", ...args: any[]) => void;
-    config: Record<string, any>;
-    users: unknown[];
+import { PropType } from 'vue';
+import { User } from '../../core/types/index.js';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    users: {
+        type: PropType<readonly (User & {
+            access?: string | {
+                role?: string;
+            } | null;
+        })[]>;
+        required: false;
+        default: () => never[];
+    };
+    config: {
+        type: PropType<{
+            readOnly?: boolean;
+            allowResolve?: boolean;
+        }>;
+        required: true;
+    };
+    isFocused: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    includeHeader: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    comment: {
+        type: PropType<{
+            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: any;
+                page: any;
+                selectionBounds: any;
+                getValues: () => {
+                    documentId: any;
+                    page: any;
+                    selectionBounds: any;
+                    source: any;
+                };
+                getContainerId: () => string;
+                getContainerLocation: (parentContainer: any) => {
+                    top: number;
+                    left: number;
+                };
+                source: any;
+            };
+            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/comments-types.js').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/event-types.js').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/event-types.js').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: any;
+                    page: any;
+                    selectionBounds: any;
+                    source: any;
+                } | 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/comments-types.js').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/event-types.js').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/event-types.js').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;
+        }>;
+        required: true;
+    };
+}>, {
+    focus: (options?: FocusOptions) => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    focus: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    users: {
+        type: PropType<readonly (User & {
+            access?: string | {
+                role?: string;
+            } | null;
+        })[]>;
+        required: false;
+        default: () => never[];
+    };
+    config: {
+        type: PropType<{
+            readOnly?: boolean;
+            allowResolve?: boolean;
+        }>;
+        required: true;
+    };
+    isFocused: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    includeHeader: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    comment: {
+        type: PropType<{
+            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: any;
+                page: any;
+                selectionBounds: any;
+                getValues: () => {
+                    documentId: any;
+                    page: any;
+                    selectionBounds: any;
+                    source: any;
+                };
+                getContainerId: () => string;
+                getContainerLocation: (parentContainer: any) => {
+                    top: number;
+                    left: number;
+                };
+                source: any;
+            };
+            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/comments-types.js').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/event-types.js').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/event-types.js').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: any;
+                    page: any;
+                    selectionBounds: any;
+                    source: any;
+                } | 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/comments-types.js').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/event-types.js').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/event-types.js').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;
+        }>;
+        required: true;
+    };
+}>> & Readonly<{
+    onFocus?: ((...args: any[]) => any) | undefined;
+}>, {
     isFocused: boolean;
+    users: readonly (User & {
+        access?: string | {
+            role?: string;
+        } | null;
+    })[];
     includeHeader: boolean;
-    comment?: Record<string, any> | undefined;
-    $props: {
-        readonly config?: Record<string, any> | undefined;
-        readonly users?: unknown[] | undefined;
-        readonly isFocused?: boolean | undefined;
-        readonly includeHeader?: boolean | undefined;
-        readonly comment?: Record<string, any> | undefined;
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
     inputRef: HTMLTextAreaElement;
 }, HTMLDivElement>;
 export default _default;