superdoc 2.28.0 → 2.29.0-next.2

package/dist/superdoc/src/internal/toolbar/built-in/ToolbarButtonIcon.vue.d.ts

@@ -1,11 +1,32 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    name: string;
-    color: string;
-    icon: string;
-    $props: {
-        readonly name?: string | undefined;
-        readonly color?: string | undefined;
-        readonly icon?: string | undefined;
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+import { PropType } from 'vue';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    color: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    icon: {
+        type: PropType<string | null>;
+        default: null;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    color: {
+        type: PropType<string | null>;
+        default: null;
+    };
+    icon: {
+        type: PropType<string | null>;
+        default: null;
+    };
+}>> & Readonly<{}>, {
+    color: string | null;
+    icon: string | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
 export default _default;

package/dist/superdoc/src/internal/toolbar/built-in/ToolbarComboBox.vue.d.ts

@@ -1,16 +1,87 @@
-declare const _default: import('vue').DefineComponent<{}, {
-    $emit: (event: "command" | "item-clicked" | "tab-out" | "editor-handoff", ...args: any[]) => void;
-    item: Record<string, any>;
+import { CSSProperties, PropType, Ref, StyleValue } from 'vue';
+interface ComboBoxOption {
+    key: string;
+    label: string;
+    value?: string;
+    props?: {
+        style?: CSSProperties;
+        [key: string]: unknown;
+    };
+}
+interface ComboBoxItem {
+    id?: Ref<string>;
+    name?: Ref<string>;
+    label?: Ref<string | number | null | undefined>;
+    disabled?: Ref<boolean | undefined>;
+    attributes?: Ref<{
+        ariaLabel?: string;
+    } | undefined>;
+    nestedOptions?: Ref<ComboBoxOption[]>;
+    selectedValue: Ref<string | undefined>;
+    expand?: Ref<boolean>;
+    style?: Ref<StyleValue | undefined>;
+}
+interface TabOutTarget {
+    shiftKey: boolean;
+    target: HTMLInputElement | null;
+}
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    item: {
+        type: PropType<ComboBoxItem>;
+        required: true;
+    };
+    uiFontFamily: {
+        type: StringConstructor;
+        default: string;
+    };
+    showPreview: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    normalizeValue: {
+        type: PropType<(value: string) => string>;
+        default: (value: string) => string;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    command: (payload: {
+        item: ComboBoxItem;
+        argument: string;
+        option: ComboBoxOption | null;
+    }) => any;
+    "item-clicked": () => any;
+    "tab-out": (event: KeyboardEvent | TabOutTarget) => any;
+    "editor-handoff": () => any;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    item: {
+        type: PropType<ComboBoxItem>;
+        required: true;
+    };
+    uiFontFamily: {
+        type: StringConstructor;
+        default: string;
+    };
+    showPreview: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    normalizeValue: {
+        type: PropType<(value: string) => string>;
+        default: (value: string) => string;
+    };
+}>> & Readonly<{
+    onCommand?: ((payload: {
+        item: ComboBoxItem;
+        argument: string;
+        option: ComboBoxOption | null;
+    }) => any) | undefined;
+    "onItem-clicked"?: (() => any) | undefined;
+    "onTab-out"?: ((event: KeyboardEvent | TabOutTarget) => any) | undefined;
+    "onEditor-handoff"?: (() => any) | undefined;
+}>, {
     uiFontFamily: string;
     showPreview: boolean;
-    normalizeValue: Function;
-    $props: {
-        readonly item?: Record<string, any> | undefined;
-        readonly uiFontFamily?: string | undefined;
-        readonly showPreview?: boolean | undefined;
-        readonly normalizeValue?: Function | undefined;
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    normalizeValue: (value: string) => string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
     rootRef: HTMLDivElement;
     inputRef: HTMLInputElement;
     popupRef: HTMLDivElement;

package/dist/superdoc/src/internal/toolbar/built-in/ToolbarDropdown.vue.d.ts

@@ -1,36 +1,22 @@
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
-export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & (new () => {
-    $slots: S;
-});
-declare const __VLS_component: import('vue').DefineComponent<{}, {
-    focusTrigger: () => void;
-    $emit: (event: "select" | "update:show", ...args: any[]) => void;
-    placement: string;
-    options: unknown[];
-    disabled: boolean;
-    contentStyle: Record<string, any>;
-    show: boolean;
-    menuProps: Function;
-    nodeProps: Function;
-    closeOnEscape: boolean;
-    hasOpenChild: boolean;
-    $props: {
-        readonly placement?: string | undefined;
-        readonly options?: unknown[] | undefined;
-        readonly disabled?: boolean | undefined;
-        readonly contentStyle?: Record<string, any> | undefined;
-        readonly show?: boolean | undefined;
-        readonly menuProps?: Function | undefined;
-        readonly nodeProps?: Function | undefined;
-        readonly closeOnEscape?: boolean | undefined;
-        readonly hasOpenChild?: boolean | undefined;
-    };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
-    triggerRef: HTMLDivElement;
-    menuRef: HTMLDivElement;
-}, HTMLDivElement>;
-type __VLS_TemplateResult = {
+import { CSSProperties, PropType } from 'vue';
+interface DropdownOption {
+    key?: string | number;
+    label?: string;
+    type?: string;
+    disabled?: boolean;
+    class?: unknown;
+    props?: Record<string, unknown>;
+    icon?: string | object | ((option: DropdownOption) => unknown);
+    render?: () => unknown;
+}
+interface DropdownMenuProps {
+    class?: unknown;
+    style?: CSSProperties;
+    [attribute: string]: unknown;
+}
+type MenuPropsFactory = () => DropdownMenuProps | null | undefined;
+type NodePropsFactory = (option: DropdownOption) => Record<string, unknown> | null | undefined;
+declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
         trigger?(_: {}): any;
@@ -42,3 +28,106 @@ type __VLS_TemplateResult = {
     };
     rootEl: HTMLDivElement;
 };
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    options: {
+        type: PropType<DropdownOption[]>;
+        default: () => never[];
+    };
+    show: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    placement: {
+        type: StringConstructor;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    contentStyle: {
+        type: PropType<CSSProperties>;
+        default: () => {};
+    };
+    menuProps: {
+        type: PropType<MenuPropsFactory>;
+        default: null;
+    };
+    nodeProps: {
+        type: PropType<NodePropsFactory>;
+        default: null;
+    };
+    closeOnEscape: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    hasOpenChild: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {
+    focusTrigger: () => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    select: (key: string | number | undefined, option: DropdownOption) => any;
+    "update:show": (value: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    options: {
+        type: PropType<DropdownOption[]>;
+        default: () => never[];
+    };
+    show: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    placement: {
+        type: StringConstructor;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    contentStyle: {
+        type: PropType<CSSProperties>;
+        default: () => {};
+    };
+    menuProps: {
+        type: PropType<MenuPropsFactory>;
+        default: null;
+    };
+    nodeProps: {
+        type: PropType<NodePropsFactory>;
+        default: null;
+    };
+    closeOnEscape: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    hasOpenChild: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onSelect?: ((key: string | number | undefined, option: DropdownOption) => any) | undefined;
+    "onUpdate:show"?: ((value: boolean) => any) | undefined;
+}>, {
+    placement: string;
+    options: DropdownOption[];
+    disabled: boolean;
+    contentStyle: CSSProperties;
+    menuProps: MenuPropsFactory;
+    nodeProps: NodePropsFactory;
+    closeOnEscape: boolean;
+    hasOpenChild: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    triggerRef: HTMLDivElement;
+    menuRef: HTMLDivElement;
+}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/superdoc/src/internal/toolbar/built-in/use-toolbar-item.d.ts

@@ -23,7 +23,6 @@ export function useToolbarItem(options: any): {
     style: import('vue').Ref<any, any>;
     isNarrow: import('vue').Ref<any, any>;
     isWide: import('vue').Ref<any, any>;
-    minWidth: import('vue').Ref<any, any>;
     layoutWidth: import('vue').Ref<any, any>;
     argument: import('vue').Ref<any, any>;
     parentItem: import('vue').Ref<null, null>;

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

@@ -101,23 +101,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -154,8 +174,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -186,7 +215,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -236,7 +277,7 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
         liveAnchorKeys?: null | undefined;
     }) => any;
     remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
-}, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
+}, "COMMENT_EVENTS" | "isDebugging" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
     COMMENT_EVENTS: {
         readonly RESOLVED: "resolved";
         readonly NEW: "new";
@@ -339,23 +380,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -392,8 +453,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -424,7 +494,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -577,23 +659,43 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     hasOverlapId: (id: any) => any;
     getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
-        selection: Object;
-        documentId: string;
-        parentCommentId: string;
-    }) => Object;
+        selection?: Object | undefined;
+        documentId?: string | null | undefined;
+        parentCommentId?: string | null | undefined;
+    }) => ReturnType<typeof useComment>;
     showAddComment: (superdoc: any, targetClientY?: null) => any;
     addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
         superdoc: any;
         comment: any;
         skipEditorUpdate?: boolean | undefined;
         broadcastChanges?: boolean | undefined;
-    }) => void;
+    }) => {
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    } | Promise<{
+        ok: boolean;
+        reason?: string;
+        detail?: string;
+        code?: string;
+    }>;
     cancelComment: (superdoc: any) => void;
     deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
         commentId: any;
@@ -630,8 +732,17 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     clearInstantSidebarAlignment: () => void;
     decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
         superdoc: Object;
-        editor: Object;
-    }) => void;
+        comment: Object;
+        decision: string;
+    }) => {
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    } | Promise<{
+        ok: boolean;
+        success?: boolean;
+        reason?: string;
+    }>;
     v2CommentsAdapter: import('vue').ShallowRef<null, null>;
     setV2CommentsAdapter: (adapter: any) => void;
     getV2CommentsAdapter: (superdoc: any) => any;
@@ -662,7 +773,19 @@ export const useCommentsStore: import('pinia').StoreDefinition<"comments", Pick<
     };
     isV2EditorActive: (superdoc: any) => boolean;
     replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
-        mentions?: never[] | undefined;
+        superdoc?: Object | undefined;
+        parentCommentId?: string | null | undefined;
+        text?: string | undefined;
+        mentions?: {
+            name?: string | null;
+            email?: string | null;
+        }[] | undefined;
+        trackedChangeTarget?: {
+            kind: "trackedChange";
+            trackedChangeId: string;
+            story?: unknown;
+            side?: "source" | "destination";
+        } | undefined;
     }) => Promise<any>;
     editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
     resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;