@vue-pdf-viewer/viewer 3.0.0-alpha.4 → 3.0.0-alpha.6

package/dist/types/composables/usePdfProperties.d.ts

@@ -0,0 +1,10 @@
+import type { PDFDocumentProxy } from 'pdfjs-dist';
+import { Ref, ShallowRef } from 'vue';
+import type { PdfProperties, PDFSrc } from '@/utils/types';
+type CMapSource = {
+    url: string;
+    cMapPacked: boolean;
+    cMapUrl: string;
+};
+declare const usePdfProperties: (pdfDoc: ShallowRef<PDFDocumentProxy | undefined>, source: Ref<PDFSrc | CMapSource>, filename: Ref<string | undefined>) => Ref<PdfProperties | undefined, PdfProperties | undefined>;
+export default usePdfProperties;

package/dist/types/composables/usePinch.d.ts

@@ -0,0 +1,3 @@
+import { Ref } from 'vue';
+declare const usePinch: (container: Ref<HTMLDivElement | undefined>, currentScale: Ref<number | undefined>) => void;
+export default usePinch;

package/dist/types/composables/usePlugins.d.ts

@@ -0,0 +1,252 @@
+import { ComputedRef } from 'vue';
+import type { Reactive } from 'vue';
+import type { Localization, PluginItem, Plugin } from '@vue-pdf-viewer/shared';
+declare const usePlugins: (plugins?: Reactive<Plugin[]>, viewerLocalization?: ComputedRef<Localization>) => {
+    currentInstance: import("vue").ComponentInternalInstance | null;
+    sidebarItems: import("vue").Ref<{
+        id: string;
+        component: {
+            new (...args: any[]): any;
+            __isFragment?: undefined;
+            __isTeleport?: undefined;
+            __isSuspense?: undefined;
+        } | import("vue").FunctionalComponent<any, {}, any, {}> | {
+            [x: string]: any;
+            setup?: ((this: void, props: import("@vue/shared").LooseRequired<any>, ctx: {
+                attrs: {
+                    [x: string]: unknown;
+                };
+                slots: Readonly<{
+                    [name: string]: import("vue").Slot<any> | undefined;
+                }>;
+                emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
+                expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed | undefined) => void;
+            }) => any) | undefined;
+            name?: string | undefined;
+            template?: string | object | undefined;
+            render?: Function | undefined;
+            components?: Record<string, import("vue").Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions, {}, any>> | undefined;
+            directives?: Record<string, import("vue").Directive<any, any, string, string>> | undefined;
+            inheritAttrs?: boolean | undefined;
+            emits?: any;
+            slots?: {} | undefined;
+            expose?: string[] | undefined;
+            serverPrefetch?: (() => void | Promise<any>) | undefined;
+            compilerOptions?: {
+                isCustomElement?: ((tag: string) => boolean) | undefined;
+                whitespace?: "preserve" | "condense" | undefined;
+                comments?: boolean | undefined;
+                delimiters?: [string, string] | undefined;
+            } | undefined;
+            call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
+            __isFragment?: undefined;
+            __isTeleport?: undefined;
+            __isSuspense?: undefined;
+            __defaults?: {} | undefined;
+            compatConfig?: {
+                GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
+                GLOBAL_MOUNT_CONTAINER?: boolean | "suppress-warning" | undefined;
+                GLOBAL_EXTEND?: boolean | "suppress-warning" | undefined;
+                GLOBAL_PROTOTYPE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_SET?: boolean | "suppress-warning" | undefined;
+                GLOBAL_DELETE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_OBSERVABLE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_PRIVATE_UTIL?: boolean | "suppress-warning" | undefined;
+                CONFIG_SILENT?: boolean | "suppress-warning" | undefined;
+                CONFIG_DEVTOOLS?: boolean | "suppress-warning" | undefined;
+                CONFIG_KEY_CODES?: boolean | "suppress-warning" | undefined;
+                CONFIG_PRODUCTION_TIP?: boolean | "suppress-warning" | undefined;
+                CONFIG_IGNORED_ELEMENTS?: boolean | "suppress-warning" | undefined;
+                CONFIG_WHITESPACE?: boolean | "suppress-warning" | undefined;
+                CONFIG_OPTION_MERGE_STRATS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_SET?: boolean | "suppress-warning" | undefined;
+                INSTANCE_DELETE?: boolean | "suppress-warning" | undefined;
+                INSTANCE_DESTROY?: boolean | "suppress-warning" | undefined;
+                INSTANCE_EVENT_EMITTER?: boolean | "suppress-warning" | undefined;
+                INSTANCE_EVENT_HOOKS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_CHILDREN?: boolean | "suppress-warning" | undefined;
+                INSTANCE_LISTENERS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_SCOPED_SLOTS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_ATTRS_CLASS_STYLE?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DATA_FN?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DATA_MERGE?: boolean | "suppress-warning" | undefined;
+                OPTIONS_BEFORE_DESTROY?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DESTROYED?: boolean | "suppress-warning" | undefined;
+                WATCH_ARRAY?: boolean | "suppress-warning" | undefined;
+                PROPS_DEFAULT_THIS?: boolean | "suppress-warning" | undefined;
+                V_ON_KEYCODE_MODIFIER?: boolean | "suppress-warning" | undefined;
+                CUSTOM_DIR?: boolean | "suppress-warning" | undefined;
+                ATTR_FALSE_VALUE?: boolean | "suppress-warning" | undefined;
+                ATTR_ENUMERATED_COERCION?: boolean | "suppress-warning" | undefined;
+                TRANSITION_CLASSES?: boolean | "suppress-warning" | undefined;
+                TRANSITION_GROUP_ROOT?: boolean | "suppress-warning" | undefined;
+                COMPONENT_ASYNC?: boolean | "suppress-warning" | undefined;
+                COMPONENT_FUNCTIONAL?: boolean | "suppress-warning" | undefined;
+                COMPONENT_V_MODEL?: boolean | "suppress-warning" | undefined;
+                RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
+                FILTERS?: boolean | "suppress-warning" | undefined;
+                PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
+                MODE?: 3 | 2 | ((comp: import("vue").Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions, {}, any> | null) => 3 | 2) | undefined;
+            } | undefined;
+            data?: ((this: any, vm: any) => any) | undefined;
+            computed?: import("vue").ComputedOptions | undefined;
+            methods?: import("vue").MethodOptions | undefined;
+            watch?: {
+                [x: string]: (string | import("vue").WatchCallback<any, any> | ({
+                    handler: string | import("vue").WatchCallback<any, any>;
+                } & import("vue").WatchOptions<boolean>)) | (string | import("vue").WatchCallback<any, any> | ({
+                    handler: string | import("vue").WatchCallback<any, any>;
+                } & import("vue").WatchOptions<boolean>))[];
+            } | undefined;
+            provide?: import("vue").ComponentProvideOptions | undefined;
+            inject?: {} | string[] | undefined;
+            filters?: Record<string, Function> | undefined;
+            mixins?: any[] | undefined;
+            extends?: any;
+            beforeCreate?: (() => void) | undefined;
+            created?: (() => void) | undefined;
+            beforeMount?: (() => void) | undefined;
+            mounted?: (() => void) | undefined;
+            beforeUpdate?: (() => void) | undefined;
+            updated?: (() => void) | undefined;
+            activated?: (() => void) | undefined;
+            deactivated?: (() => void) | undefined;
+            beforeDestroy?: (() => void) | undefined;
+            beforeUnmount?: (() => void) | undefined;
+            destroyed?: (() => void) | undefined;
+            unmounted?: (() => void) | undefined;
+            renderTracked?: ((e: import("vue").DebuggerEvent) => void) | undefined;
+            renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | undefined;
+            errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import("vue").ComponentProvideOptions>, {}, {}, "", {}, any> | null, info: string) => boolean | void) | undefined;
+            delimiters?: [string, string] | undefined;
+            __differentiator?: string | number | symbol | undefined;
+            __isBuiltIn?: boolean | undefined;
+            __file?: string | undefined;
+            __name?: string | undefined;
+        };
+        toolbarDirection: import("@vue-pdf-viewer/shared").ToolbarDirection;
+    }[], PluginItem[] | {
+        id: string;
+        component: {
+            new (...args: any[]): any;
+            __isFragment?: undefined;
+            __isTeleport?: undefined;
+            __isSuspense?: undefined;
+        } | import("vue").FunctionalComponent<any, {}, any, {}> | {
+            [x: string]: any;
+            setup?: ((this: void, props: import("@vue/shared").LooseRequired<any>, ctx: {
+                attrs: {
+                    [x: string]: unknown;
+                };
+                slots: Readonly<{
+                    [name: string]: import("vue").Slot<any> | undefined;
+                }>;
+                emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
+                expose: <Exposed extends Record<string, any> = Record<string, any>>(exposed?: Exposed | undefined) => void;
+            }) => any) | undefined;
+            name?: string | undefined;
+            template?: string | object | undefined;
+            render?: Function | undefined;
+            components?: Record<string, import("vue").Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions, {}, any>> | undefined;
+            directives?: Record<string, import("vue").Directive<any, any, string, string>> | undefined;
+            inheritAttrs?: boolean | undefined;
+            emits?: any;
+            slots?: {} | undefined;
+            expose?: string[] | undefined;
+            serverPrefetch?: (() => void | Promise<any>) | undefined;
+            compilerOptions?: {
+                isCustomElement?: ((tag: string) => boolean) | undefined;
+                whitespace?: "preserve" | "condense" | undefined;
+                comments?: boolean | undefined;
+                delimiters?: [string, string] | undefined;
+            } | undefined;
+            call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
+            __isFragment?: undefined;
+            __isTeleport?: undefined;
+            __isSuspense?: undefined;
+            __defaults?: {} | undefined;
+            compatConfig?: {
+                GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
+                GLOBAL_MOUNT_CONTAINER?: boolean | "suppress-warning" | undefined;
+                GLOBAL_EXTEND?: boolean | "suppress-warning" | undefined;
+                GLOBAL_PROTOTYPE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_SET?: boolean | "suppress-warning" | undefined;
+                GLOBAL_DELETE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_OBSERVABLE?: boolean | "suppress-warning" | undefined;
+                GLOBAL_PRIVATE_UTIL?: boolean | "suppress-warning" | undefined;
+                CONFIG_SILENT?: boolean | "suppress-warning" | undefined;
+                CONFIG_DEVTOOLS?: boolean | "suppress-warning" | undefined;
+                CONFIG_KEY_CODES?: boolean | "suppress-warning" | undefined;
+                CONFIG_PRODUCTION_TIP?: boolean | "suppress-warning" | undefined;
+                CONFIG_IGNORED_ELEMENTS?: boolean | "suppress-warning" | undefined;
+                CONFIG_WHITESPACE?: boolean | "suppress-warning" | undefined;
+                CONFIG_OPTION_MERGE_STRATS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_SET?: boolean | "suppress-warning" | undefined;
+                INSTANCE_DELETE?: boolean | "suppress-warning" | undefined;
+                INSTANCE_DESTROY?: boolean | "suppress-warning" | undefined;
+                INSTANCE_EVENT_EMITTER?: boolean | "suppress-warning" | undefined;
+                INSTANCE_EVENT_HOOKS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_CHILDREN?: boolean | "suppress-warning" | undefined;
+                INSTANCE_LISTENERS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_SCOPED_SLOTS?: boolean | "suppress-warning" | undefined;
+                INSTANCE_ATTRS_CLASS_STYLE?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DATA_FN?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DATA_MERGE?: boolean | "suppress-warning" | undefined;
+                OPTIONS_BEFORE_DESTROY?: boolean | "suppress-warning" | undefined;
+                OPTIONS_DESTROYED?: boolean | "suppress-warning" | undefined;
+                WATCH_ARRAY?: boolean | "suppress-warning" | undefined;
+                PROPS_DEFAULT_THIS?: boolean | "suppress-warning" | undefined;
+                V_ON_KEYCODE_MODIFIER?: boolean | "suppress-warning" | undefined;
+                CUSTOM_DIR?: boolean | "suppress-warning" | undefined;
+                ATTR_FALSE_VALUE?: boolean | "suppress-warning" | undefined;
+                ATTR_ENUMERATED_COERCION?: boolean | "suppress-warning" | undefined;
+                TRANSITION_CLASSES?: boolean | "suppress-warning" | undefined;
+                TRANSITION_GROUP_ROOT?: boolean | "suppress-warning" | undefined;
+                COMPONENT_ASYNC?: boolean | "suppress-warning" | undefined;
+                COMPONENT_FUNCTIONAL?: boolean | "suppress-warning" | undefined;
+                COMPONENT_V_MODEL?: boolean | "suppress-warning" | undefined;
+                RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
+                FILTERS?: boolean | "suppress-warning" | undefined;
+                PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
+                MODE?: 3 | 2 | ((comp: import("vue").Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions, {}, any> | null) => 3 | 2) | undefined;
+            } | undefined;
+            data?: ((this: any, vm: any) => any) | undefined;
+            computed?: import("vue").ComputedOptions | undefined;
+            methods?: import("vue").MethodOptions | undefined;
+            watch?: {
+                [x: string]: (string | import("vue").WatchCallback<any, any> | ({
+                    handler: string | import("vue").WatchCallback<any, any>;
+                } & import("vue").WatchOptions<boolean>)) | (string | import("vue").WatchCallback<any, any> | ({
+                    handler: string | import("vue").WatchCallback<any, any>;
+                } & import("vue").WatchOptions<boolean>))[];
+            } | undefined;
+            provide?: import("vue").ComponentProvideOptions | undefined;
+            inject?: {} | string[] | undefined;
+            filters?: Record<string, Function> | undefined;
+            mixins?: any[] | undefined;
+            extends?: any;
+            beforeCreate?: (() => void) | undefined;
+            created?: (() => void) | undefined;
+            beforeMount?: (() => void) | undefined;
+            mounted?: (() => void) | undefined;
+            beforeUpdate?: (() => void) | undefined;
+            updated?: (() => void) | undefined;
+            activated?: (() => void) | undefined;
+            deactivated?: (() => void) | undefined;
+            beforeDestroy?: (() => void) | undefined;
+            beforeUnmount?: (() => void) | undefined;
+            destroyed?: (() => void) | undefined;
+            unmounted?: (() => void) | undefined;
+            renderTracked?: ((e: import("vue").DebuggerEvent) => void) | undefined;
+            renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | undefined;
+            errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import("vue").ComponentProvideOptions>, {}, {}, "", {}, any> | null, info: string) => boolean | void) | undefined;
+            delimiters?: [string, string] | undefined;
+            __differentiator?: string | number | symbol | undefined;
+            __isBuiltIn?: boolean | undefined;
+            __file?: string | undefined;
+            __name?: string | undefined;
+        };
+        toolbarDirection: import("@vue-pdf-viewer/shared").ToolbarDirection;
+    }[]>;
+};
+export default usePlugins;

package/dist/types/composables/usePrintControl.d.ts

@@ -0,0 +1,22 @@
+import { type Ref } from 'vue';
+import type { CanvasLoadedCallback, PreparePrintProgress, ViewerPdfPage } from '@/utils/types';
+import { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
+declare const usePrintControl: (pdfDocument: Ref<PDFDocumentProxy | undefined>, pages: Ref<ViewerPdfPage[]>, afterCanvasLoaded?: Ref<Record<number, CanvasLoadedCallback> | undefined>) => {
+    print: (showProgress?: boolean) => Promise<void>;
+    printControl: {
+        print: (options?: {
+            visibleDefaultProgress: boolean;
+        } | undefined) => void;
+        cancel: () => void;
+        onProgress?: ((progress: PreparePrintProgress) => void) | undefined;
+        onError?: ((error: Error) => void) | undefined;
+        onComplete?: (() => void) | undefined;
+    };
+    visiblePrintProcess: Ref<boolean, boolean>;
+    cancelPrint: Ref<boolean, boolean>;
+    onPrintCancel: () => void;
+    onPrintLoading: () => void;
+    changePercent: (value: number) => void;
+    printProgressPercentage: Ref<number, number>;
+};
+export default usePrintControl;

package/dist/types/composables/usePrintProcess.d.ts

@@ -0,0 +1,8 @@
+export declare const usePrintProcess: () => {
+    isCancel: import("vue").Ref<boolean, boolean>;
+    percent: import("vue").Ref<number, number>;
+    showPrintProcess: import("vue").Ref<boolean, boolean>;
+    onCancel: () => void;
+    onLoading: () => void;
+    changePercent: (value: number) => void;
+};

package/dist/types/composables/useRenderQueue.d.ts

@@ -0,0 +1,13 @@
+import { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
+import { MaybeRef } from 'vue';
+export interface UseRenderQueueReturn {
+    getHighestPriorityPage: () => number;
+    isInRange: (pageIndex: number) => boolean;
+    markNotRendered: () => void;
+    markRendered: (pageIndex: number) => void;
+    markRendering: (pageIndex: number) => void;
+    setOutOfRange: (pageIndex: number) => void;
+    setRange: (startIndex: number, endIndex: number) => void;
+    setVisibility: (pageIndex: number, visibility: number) => void;
+}
+export declare const useRenderQueue: (doc: MaybeRef<PDFDocumentProxy | undefined>) => UseRenderQueueReturn;

package/dist/types/composables/useRequestAnimationFrame.d.ts

@@ -0,0 +1 @@
+export declare const useRequestAnimationFrame: <T extends unknown[]>(callback: (...args: T) => void, recurring?: boolean) => (...args: T) => void;

package/dist/types/composables/useRotation.d.ts

@@ -0,0 +1,7 @@
+import { Ref } from 'vue';
+import { RotateEvent } from '..';
+declare const useRotation: (currentRotation: Ref<number>, rotateCallback?: ((event: RotateEvent) => void) | undefined) => {
+    onRotateClockwise: () => void;
+    onRotateCounterclockwise: () => void;
+};
+export default useRotation;

package/dist/types/composables/useScale.d.ts

@@ -0,0 +1,21 @@
+import { MaybeRef, Ref, ShallowRef, UnwrapRef } from 'vue';
+import type { UseScaleCallback, ViewerPdfPage } from '@/utils/types';
+import { ViewMode, ZoomLevel } from '@/utils/enumerators';
+import type { PDFDocumentProxy } from 'pdfjs-dist';
+interface UseScaleProps {
+    pdfDocument: ShallowRef<PDFDocumentProxy | undefined>;
+    pagesContainerRef: ShallowRef<HTMLDivElement | undefined>;
+    viewMode: Ref<ViewMode>;
+    initialScale: MaybeRef<number | ZoomLevel>;
+    focusedPage: MaybeRef<ViewerPdfPage | undefined>;
+    leftToolbar?: Ref<boolean>;
+}
+declare const useScale: (props: UnwrapRef<UseScaleProps>, scaleCallback?: ((event: UseScaleCallback) => void) | undefined) => {
+    currentScale: Ref<number, number>;
+    zoom: (scale: number | ZoomLevel) => void;
+    zoomControl: {
+        scale: number;
+        zoom: (scale: number | ZoomLevel) => void;
+    };
+};
+export default useScale;

package/dist/types/composables/useSearch.d.ts

@@ -0,0 +1,5 @@
+import { ShallowRef } from 'vue';
+import type { PDFDocumentProxy } from 'pdfjs-dist';
+import type { SearchControlValue, HighlightOptions } from '@/utils/types';
+declare const useSearch: (pdfDoc: ShallowRef<PDFDocumentProxy | undefined>, initialSearch?: string, options?: ShallowRef<HighlightOptions>) => SearchControlValue;
+export default useSearch;

package/dist/types/composables/useTextLayers.d.ts

@@ -0,0 +1,5 @@
+export declare const useTextLayers: () => {
+    addTextLayer: (textLayer: HTMLElement) => void;
+    removeTextLayer: (textLayer: HTMLElement) => void;
+    getTextLayers: () => import("vue").Reactive<Set<HTMLElement>>;
+};

package/dist/types/composables/useVirtualPages.d.ts

@@ -0,0 +1,32 @@
+import { ComputedRef, CSSProperties, Ref, StyleValue, UnwrapRef } from 'vue';
+import type { ViewerPdfPage, VirtualRange, ElementRect } from '@/utils/types';
+import { ScrollMode, ViewMode } from '@/utils/enumerators';
+interface UseVirtualListItem<T> {
+    data: T;
+    index: number;
+}
+export interface UseVirtualListReturn {
+    list: Ref<UseVirtualListItem<ViewerPdfPage>[]>;
+    scrollTo: (index: number, rect?: ElementRect) => void;
+    pageGroups: ComputedRef<Array<UseVirtualListItem<ViewerPdfPage>[]> | undefined>;
+    containerProps: {
+        ref: Ref<HTMLElement | null>;
+        onScroll: () => void;
+        style: StyleValue;
+    };
+    wrapperProps: ComputedRef<{
+        style: CSSProperties;
+    }>;
+    range: Ref<VirtualRange>;
+    pagesPerRow: Ref<number>;
+}
+interface UseVirtualPagesProps {
+    pages: Ref<ViewerPdfPage[]>;
+    viewerRef: Ref<HTMLElement | undefined>;
+    scrollMode: Ref<ScrollMode>;
+    viewMode: Ref<ViewMode>;
+    isRtl: boolean;
+    smoothScroll: Ref<boolean>;
+}
+declare function useVirtualPages(props: UnwrapRef<UseVirtualPagesProps>): UseVirtualListReturn;
+export default useVirtualPages;

package/dist/types/composables/useVisibilities.d.ts

@@ -0,0 +1,9 @@
+import { type Ref } from 'vue';
+import { VirtualRange, VisibilityInfo } from '@/utils/types';
+declare function useVisibilities(totalPages: Ref<number>): {
+    resetVisibility: (preserveRange?: VirtualRange) => void;
+    updateVisibility: (info: VisibilityInfo) => void;
+    currentPage: Ref<number, number>;
+    calculateCurrentPage: (range?: VirtualRange) => number;
+};
+export default useVisibilities;

package/dist/types/const.d.ts

@@ -0,0 +1,149 @@
+import { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
+import type { PDFPageProxy } from 'pdfjs-dist/types/web/interfaces';
+import { type InjectionKey, type Slot, type Ref, type ComponentPublicInstance, type ShallowRef, type Reactive, type ComputedRef } from 'vue';
+import type { HighlightMatchPosition, HighlightOptions, NormalizedKeyword, Offset, PdfProperties, ToolbarOptions, ViewerPdfPage, ViewerState, Comment } from './utils/types';
+import { LicenseProduct } from './utils/enumerators';
+import { LicenseType, ScrollMode, ViewMode, ZoomLevel } from './components';
+import { AnnotationHighlightColors } from '@vue-pdf-viewer/shared';
+import { AnnotationImageManager } from './utils/annotation-image';
+export declare const CSS_CLASSES: {
+    SELECTING: string;
+    END_OF_CONTENT: string;
+};
+export declare const DEFAULT_TOOLBAR_OPTIONS: ToolbarOptions;
+export declare const DEFAULT_PROPS: {
+    workerUrl: undefined;
+    initialPage: number;
+    initialScale: ZoomLevel;
+    initialScrollMode: ScrollMode;
+    initialViewMode: ViewMode;
+    initialRotation: number;
+    initialThumbnailsVisible: boolean;
+    initialSearch: undefined;
+    textLayer: boolean;
+    characterMap: undefined;
+    toolbarOptions: ToolbarOptions;
+    localization: Record<string, import("@vue-pdf-viewer/shared").Localization>;
+    afterCanvasLoaded: undefined;
+};
+export declare const DEFAULT_OFFSET: Offset;
+export declare const PERCENTAGE = 100;
+export declare const MIN_ZOOM_SCALE = 0.25;
+export declare const MAX_ZOOM_SCALE = 10;
+export declare const SCROLL_BAR_WIDTH = 20;
+export declare const PAGE_PADDING = 1;
+export declare const PAGE_OFFSET = 0;
+export declare const LAST_PAGE_OFFSET = 4;
+export declare const SEARCH_MAX_HEIGHT = 97;
+export declare const FILE_INPUT: InjectionKey<Ref<ComponentPublicInstance<import("vue").DefineComponent<{}, {
+    triggerClick: () => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    change: (file: string) => void;
+} & {
+    filenameChange: (file: string) => void;
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
+    onChange?: ((file: string) => any) | undefined;
+    onFilenameChange?: ((file: string) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import("vue").ComponentProvideOptions>, {}, {}, "", {}, any> | undefined, ComponentPublicInstance<import("vue").DefineComponent<{}, {
+    triggerClick: () => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    change: (file: string) => void;
+} & {
+    filenameChange: (file: string) => void;
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
+    onChange?: ((file: string) => any) | undefined;
+    onFilenameChange?: ((file: string) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import("vue").ComponentProvideOptions>, {}, {}, "", {}, any> | undefined>>;
+export declare const EMPTY_KEYWORD_REGEXP: NormalizedKeyword;
+export declare const CURRENT_MATCH_CSS_CLASS = "vpv-highlight__text-current";
+export declare const LATEST_MATCH_POSITION: InjectionKey<Ref<HighlightMatchPosition | undefined, HighlightMatchPosition | undefined>>;
+export declare const GET_PAGE: InjectionKey<(doc: PDFDocumentProxy, pageIndex: number) => Promise<PDFPageProxy>>;
+export declare const RESTRICTED_CUSTOM: InjectionKey<Ref<boolean, boolean>>;
+export declare const VIEWER_STATE: InjectionKey<{
+    pdfDocument: PDFDocumentProxy | undefined;
+    pagesContainerRef: HTMLElement | undefined;
+    pageIndex: number;
+    viewMode: ViewMode;
+    scrollMode: ScrollMode;
+    scale: number;
+    rotation: number;
+    isEditing: boolean;
+    updateViewerState: (state: Partial<ViewerState>) => void;
+}>;
+export declare const VIEWER_PAGES_PER_ROW: InjectionKey<Ref<number, number>>;
+export declare const TOOLBAR_OPTIONS: InjectionKey<Ref<ToolbarOptions | undefined, ToolbarOptions | undefined>>;
+export declare const TOTAL_TOOL_OTHERS_MENU: InjectionKey<Ref<number, number>>;
+export declare const IS_DARK: InjectionKey<Ref<boolean, boolean>>;
+export declare const IS_MOBILE_VIEW: InjectionKey<Ref<boolean, boolean>>;
+export declare const CONTAINER: InjectionKey<ShallowRef<HTMLDivElement | undefined, HTMLDivElement | undefined>>;
+export declare const PAGES_CONTAINER: InjectionKey<ShallowRef<HTMLDivElement | undefined, HTMLDivElement | undefined>>;
+export declare const ACTUAL_PDF_PAGES: InjectionKey<ShallowRef<ViewerPdfPage[], ViewerPdfPage[]>>;
+export declare const FOCUSED_PAGE_NUMBER: InjectionKey<Ref<number, number>>;
+export declare const ROTATION_DEGREE: InjectionKey<Ref<number, number>>;
+export declare const TOTAL_PAGE: InjectionKey<Ref<number, number>>;
+export declare const INITIAL_TEXT_LAYER: InjectionKey<boolean>;
+export declare const DOWNLOAD_FILE: InjectionKey<() => Promise<void>>;
+export declare const LICENSE: InjectionKey<{
+    invalidatedMessage?: string | undefined;
+    isValidating: boolean;
+    isValidated: boolean;
+    isValidKey: boolean;
+    type: LicenseType;
+    product: LicenseProduct;
+}>;
+export declare const LICENSE_KEY: InjectionKey<ComputedRef<string | null | undefined>>;
+export declare const HIGHLIGHT_OPTIONS: InjectionKey<ShallowRef<HighlightOptions, HighlightOptions>>;
+export declare const PDF_PROPERTIES: InjectionKey<Ref<PdfProperties | undefined, PdfProperties | undefined>>;
+export declare const SLOT_LOADER_IMAGE: InjectionKey<Slot<any> | undefined>;
+export declare const SLOT_ICON_OPEN_FILE: InjectionKey<Slot<any> | undefined>;
+export declare const SLOT_ICON_DOWNLOAD: InjectionKey<Slot<any> | undefined>;
+export declare const SLOT_ICON_PRINT: InjectionKey<Slot<any> | undefined>;
+export declare const SLOT_ICON_FULLSCREEN: InjectionKey<Slot<any> | undefined>;
+export declare const SYMBOL_ANNOTATION_KEYS: {
+    ANNOTATION_IMAGE_MANAGER: InjectionKey<AnnotationImageManager>;
+    ENABLE_ANNOTATION_EDITOR: InjectionKey<Ref<boolean, boolean>>;
+    ACTIVE_ANNOTATION: InjectionKey<{
+        Text: boolean;
+        Link: boolean;
+        FreeText: boolean;
+        Line: boolean;
+        Square: boolean;
+        Circle: boolean;
+        Polygon: boolean;
+        Polyline: boolean;
+        Highlight: boolean;
+        Underline: boolean;
+        Squiggly: boolean;
+        StrikeOut: boolean;
+        Stamp: boolean;
+        Caret: boolean;
+        Ink: boolean;
+        Popup: boolean;
+        FileAttachment: boolean;
+        Widget: boolean;
+    }>;
+    HIGHLIGHT_COLOR: InjectionKey<Ref<string | null, string | null>>;
+    HIGHLIGHT_COLORS: InjectionKey<Ref<AnnotationHighlightColors, AnnotationHighlightColors>>;
+    ENABLE_ANNOTATION_IMAGE_EDITOR: InjectionKey<Ref<boolean, boolean>>;
+};
+export declare const FUNC_GO_TO_PAGE: InjectionKey<(page: number) => void>;
+export declare const LICENSE_DEFAULT: {
+    isValidated: boolean;
+    isValidating: boolean;
+    isValidKey: boolean;
+    licenseKey: null;
+    type: LicenseType;
+    product: LicenseProduct;
+};
+export declare const PDF_COMMENTS: InjectionKey<{
+    comments: Map<number, Comment[]>;
+    repliedCommentPages: import("./components").PdfCommentPage[];
+}>;
+export declare const ANNOTATION_CANVAS_MAP: InjectionKey<Reactive<Map<string, HTMLCanvasElement>>>;
+export declare const DEFAULT_VIEWER_STATE: Reactive<ViewerState>;
+export declare const SUPPORTED_IMAGE_MIME_TYPES: readonly ["image/apng", "image/avif", "image/bmp", "image/gif", "image/jpeg", "image/png", "image/svg+xml", "image/webp", "image/x-icon"];
+export declare const PIXELS_PER_INCH: {
+    CSS: number;
+    PDF: number;
+    PDF_TO_CSS_UNITS: number;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+import type { Plugin } from 'vue';
+import { Locales } from '@vue-pdf-viewer/shared';
+export declare const VPdfViewerPlugin: Plugin;
+export { Locales };
+export * from './components';
+export type { VPVInstance, CanvasLoadedCallback, PrintControl, ToolbarOptions, MatchHighlightResult } from './utils/types';
+export type { Localization } from '@vue-pdf-viewer/shared';
+export default VPdfViewerPlugin;

package/dist/types/utils/annotation-command.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Command Manager for Undo/Redo functionality
+ */
+export declare class CommandManager {
+    #private;
+    constructor(maxSize?: number);
+    add({ cmd, undo, post, mustExec }: {
+        cmd: () => void;
+        undo: () => void;
+        post?: () => void;
+        mustExec?: boolean;
+    }): void;
+    undo(): void;
+    redo(): void;
+    hasSomethingToUndo(): boolean;
+    hasSomethingToRedo(): boolean;
+    clear(): void;
+}

package/dist/types/utils/annotation-display.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Scale factors for the canvas, necessary with HiDPI displays.
+ */
+export declare class OutputScale {
+    sx: number;
+    sy: number;
+    constructor();
+    /**
+     * @type {boolean} Returns `true` when scaling is required, `false` otherwise.
+     */
+    get scaled(): boolean;
+    /**
+     * @type {boolean} Returns `true` when scaling is symmetric,
+     *   `false` otherwise.
+     */
+    get symmetric(): boolean;
+    /**
+     * @returns {boolean} Returns `true` if scaling was limited,
+     *   `false` otherwise.
+     */
+    limitCanvas(width: number, height: number, maxPixels: number, maxDim: number, capAreaFactor?: number): boolean;
+    static get pixelRatio(): number;
+    static capPixels(maxPixels: number, capAreaFactor: number): number;
+}

package/dist/types/utils/annotation-free-text.d.ts

@@ -0,0 +1,4 @@
+export declare function getFreeTextFont(fontName: string, fontSize: number): {
+    fontSize: string;
+    fontFamily: string;
+};