@inkbar/vue 0.0.0-stage → 0.1.1

package/dist/components/InkRoot.vue.d.ts

@@ -0,0 +1,784 @@
+import { InkError, Annotation, AnnotationChange, AnnotationDefaults, DocumentSource, InkDocument, PdfAssets } from '@inkbar/core';
+import { InkHistory, InkStatus } from '../context';
+import { ToolId, ZoomValue } from '@inkbar/core/dom';
+type __VLS_Props = {
+    src: DocumentSource | null;
+    assets: PdfAssets;
+    password?: string | undefined;
+    /** Colour defaults. Without it, the theme's CSS variables on the root element apply. */
+    defaults?: AnnotationDefaults | undefined;
+    /**
+     * Pass (with v-model) to put annotations under the host's control. The mode is fixed when a
+     * document opens: passing or dropping this prop later takes effect on the next open.
+     */
+    annotations?: Annotation[] | undefined;
+    tool?: ToolId | undefined;
+    page?: number | undefined;
+    zoom?: ZoomValue | undefined;
+    /** Undo history. Defaults to on for uncontrolled, off for controlled. */
+    history?: boolean | undefined;
+    asChild?: boolean;
+};
+declare var __VLS_7: {
+    status: InkStatus;
+    document: InkDocument | null;
+};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_7) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {
+    document: import('vue').ShallowRef<InkDocument | null, InkDocument | null>;
+    status: import('vue').ComputedRef<InkStatus>;
+    rootEl: import('vue').ShallowRef<HTMLElement | null, HTMLElement | null>;
+    history: InkHistory;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:annotations": (next: ({
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "highlight" | "underline" | "strikeout" | "squiggly";
+        quads: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[];
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "note";
+        icon: "note" | "comment" | "help" | "insert" | "key" | "paragraph";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "freeText";
+        text: string;
+        fontSize: number;
+        fontFamily: string;
+        align: "left" | "center" | "right";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        callout?: {
+            x: number;
+            y: number;
+        }[] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "square" | "circle";
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "line";
+        start: {
+            x: number;
+            y: number;
+        };
+        end: {
+            x: number;
+            y: number;
+        };
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        endings?: ["square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash", "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash"] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "polyline" | "polygon";
+        vertices: {
+            x: number;
+            y: number;
+        }[];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "ink";
+        paths: {
+            x: number;
+            y: number;
+        }[][];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "redact";
+        origin: "user" | "suggested";
+        fill: string;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        quads?: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[] | undefined;
+        suggestion?: {
+            confidence: number;
+            jobId?: string | undefined;
+            reason?: string | undefined;
+            explanation?: string | undefined;
+            recommendation?: "redact" | "review" | "keep" | undefined;
+        } | undefined;
+        overlayText?: string | undefined;
+    })[]) => any;
+    change: (change: AnnotationChange) => any;
+    "update:tool": (tool: ToolId) => any;
+    "update:page": (page: number) => any;
+    "update:zoom": (zoom: ZoomValue) => any;
+    ready: (doc: InkDocument) => any;
+    error: (error: InkError) => any;
+    activate: (id: string) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:annotations"?: (next: ({
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "highlight" | "underline" | "strikeout" | "squiggly";
+        quads: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[];
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "note";
+        icon: "note" | "comment" | "help" | "insert" | "key" | "paragraph";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "freeText";
+        text: string;
+        fontSize: number;
+        fontFamily: string;
+        align: "left" | "center" | "right";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        callout?: {
+            x: number;
+            y: number;
+        }[] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "square" | "circle";
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "line";
+        start: {
+            x: number;
+            y: number;
+        };
+        end: {
+            x: number;
+            y: number;
+        };
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        endings?: ["square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash", "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash"] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "polyline" | "polygon";
+        vertices: {
+            x: number;
+            y: number;
+        }[];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "ink";
+        paths: {
+            x: number;
+            y: number;
+        }[][];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "redact";
+        origin: "user" | "suggested";
+        fill: string;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        quads?: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[] | undefined;
+        suggestion?: {
+            confidence: number;
+            jobId?: string | undefined;
+            reason?: string | undefined;
+            explanation?: string | undefined;
+            recommendation?: "redact" | "review" | "keep" | undefined;
+        } | undefined;
+        overlayText?: string | undefined;
+    })[]) => any;
+    onChange?: (change: AnnotationChange) => any;
+    "onUpdate:tool"?: (tool: ToolId) => any;
+    "onUpdate:page"?: (page: number) => any;
+    "onUpdate:zoom"?: (zoom: ZoomValue) => any;
+    onReady?: (doc: InkDocument) => any;
+    onError?: (error: InkError) => any;
+    onActivate?: (id: string) => any;
+}>, {
+    page: number | undefined;
+    password: string | undefined;
+    defaults: AnnotationDefaults | undefined;
+    annotations: ({
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "highlight" | "underline" | "strikeout" | "squiggly";
+        quads: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[];
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "note";
+        icon: "note" | "comment" | "help" | "insert" | "key" | "paragraph";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "freeText";
+        text: string;
+        fontSize: number;
+        fontFamily: string;
+        align: "left" | "center" | "right";
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        callout?: {
+            x: number;
+            y: number;
+        }[] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "square" | "circle";
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "line";
+        start: {
+            x: number;
+            y: number;
+        };
+        end: {
+            x: number;
+            y: number;
+        };
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        endings?: ["square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash", "square" | "circle" | "none" | "openArrow" | "closedArrow" | "diamond" | "butt" | "slash"] | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "polyline" | "polygon";
+        vertices: {
+            x: number;
+            y: number;
+        }[];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        fill?: string | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "ink";
+        paths: {
+            x: number;
+            y: number;
+        }[][];
+        strokeWidth: number;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+    } | {
+        id: string;
+        page: number;
+        rect: {
+            x: number;
+            y: number;
+            width: number;
+            height: number;
+        };
+        color: string;
+        opacity: number;
+        createdAt: string;
+        modifiedAt: string;
+        source: "session" | "pdf";
+        type: "redact";
+        origin: "user" | "suggested";
+        fill: string;
+        author?: string | undefined;
+        contents?: string | undefined;
+        inReplyTo?: string | undefined;
+        locked?: boolean | undefined;
+        custom?: Record<string, unknown> | undefined;
+        quads?: {
+            p1: {
+                x: number;
+                y: number;
+            };
+            p2: {
+                x: number;
+                y: number;
+            };
+            p3: {
+                x: number;
+                y: number;
+            };
+            p4: {
+                x: number;
+                y: number;
+            };
+        }[] | undefined;
+        suggestion?: {
+            confidence: number;
+            jobId?: string | undefined;
+            reason?: string | undefined;
+            explanation?: string | undefined;
+            recommendation?: "redact" | "review" | "keep" | undefined;
+        } | undefined;
+        overlayText?: string | undefined;
+    })[] | undefined;
+    tool: ToolId | undefined;
+    zoom: ZoomValue | undefined;
+    history: boolean | undefined;
+    asChild: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+//# sourceMappingURL=InkRoot.vue.d.ts.map