@vue-pdf-viewer/viewer 0.0.0-beta.8 → 0.0.0-experimental.0

package/dist/types/const.d.ts

@@ -1,40 +1,108 @@
-import type { InjectionKey, Slot, Ref, ComponentPublicInstance, ShallowRef } from 'vue';
-import type { License, ToolbarOptions, ViewerPdfPage } from './components';
+import { PDFDocumentProxy } from 'pdfjs-dist/types/src/display/api';
+import type { PDFPageProxy } from 'pdfjs-dist/types/web/interfaces';
+import type { InjectionKey, Slot, Ref, ComponentPublicInstance, ShallowRef, Reactive, ComputedRef } from 'vue';
+import type { HighlightMatchPosition, HighlightOptions, NormalizedKeyword, Offset, PdfProperties, ToolbarOptions, ViewerPdfPage, Comment } from './utils/types';
+import { LicenseType, ScrollMode, ViewMode, ZoomLevel } from './components';
+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 = 8;
-export declare const START_MOBILE_WIDTH = 768;
+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<import("vue").ExtractPropTypes<{}>> & {
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
     onChange?: ((file: string) => any) | undefined;
     onFilenameChange?: ((file: string) => any) | undefined;
-}, {}, {}>, {}, {}, {}, {}, {}, import("vue").DefineComponent<{}, {
+}>, {}, {}, {}, {}, 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<import("vue").ExtractPropTypes<{}>> & {
+}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{
     onChange?: ((file: string) => any) | undefined;
     onFilenameChange?: ((file: string) => any) | undefined;
-}, {}, {}>, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | undefined>>;
-export declare const TOOLBAR_OPTIONS: InjectionKey<Ref<ToolbarOptions | undefined>>;
-export declare const TOTAL_TOOL_OTHERS_MENU: InjectionKey<Ref<number>>;
-export declare const IS_DARK: InjectionKey<Ref<boolean>>;
-export declare const IS_MOBILE_VIEW: InjectionKey<Ref<boolean>>;
-export declare const LOADER_IMAGE: InjectionKey<Slot<any> | undefined>;
-export declare const PAGES_CONTAINER: InjectionKey<ShallowRef<HTMLDivElement | null>>;
-export declare const pdfPagesKey: InjectionKey<ViewerPdfPage[] | null>;
-export declare const FOCUSED_PAGE_NUMBER: InjectionKey<Ref<number>>;
-export declare const TOTAL_PAGE: InjectionKey<Ref<number>>;
+}>, {}, {}, {}, {}, 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;
+}>;
+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<ShallowRef<License | undefined>>;
+export declare const LICENSE: InjectionKey<{
+    invalidatedMessage?: string | undefined;
+    isValidating: boolean;
+    isValidated: boolean;
+    isValidKey: boolean;
+    type: LicenseType;
+}>;
+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 FUNC_GO_TO_PAGE: InjectionKey<(page: number) => void>;
+export declare const LICENSE_DEFAULT: {
+    isValidated: boolean;
+    isValidating: boolean;
+    isValidKey: boolean;
+    licenseKey: null;
+    type: LicenseType;
+};
+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>>>;

package/dist/types/index.d.ts

@@ -1,4 +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/appConsole.d.ts

@@ -0,0 +1,24 @@
+export declare class Console {
+    private static instance;
+    private isProduction;
+    private constructor();
+    static getInstance(): Console;
+    /**
+     * Debug level logging - stripped in production
+     */
+    debug(...args: any[]): void;
+    /**
+     * Info level logging
+     */
+    info(...args: any[]): void;
+    /**
+     * Warning level logging
+     */
+    warn(...args: any[]): void;
+    /**
+     * Error level logging
+     */
+    error(...args: any[]): void;
+}
+declare const _default: Console;
+export default _default;

package/dist/types/utils/characters.d.ts

@@ -0,0 +1,16 @@
+declare enum CharacterType {
+    SPACE = 0,
+    ALPHA_LETTER = 1,
+    PUNCTUATION = 2,
+    HAN_LETTER = 3,
+    KATAKANA_LETTER = 4,
+    HIRAGANA_LETTER = 5,
+    HALF_WIDTH_KATAKANA_LETTER = 6,
+    THAI_LETTER = 7
+}
+/**
+ * This function is based on the word-break detection implemented in:
+ * https://hg.mozilla.org/mozilla-central/file/tip/intl/lwbrk/WordBreaker.cpp
+ */
+declare function getCharacterType(charCode: number): CharacterType;
+export { CharacterType, getCharacterType };

package/dist/types/utils/enumerators.d.ts

@@ -0,0 +1,76 @@
+export declare enum LicenseType {
+    All = "all",
+    Premium = "premium",
+    Freemium = "freemium",
+    Unlicense = "none",
+    Organization = "organization",
+    Developer = "developer"
+}
+export declare enum ScrollMode {
+    Vertical = "Vertical",
+    Horizontal = "Horizontal",
+    Page = "Page",
+    Wrapped = "Wrapped"
+}
+export declare enum ViewMode {
+    SinglePage = "Single",
+    DualPage = "Dual"
+}
+export declare enum ZoomLevel {
+    ActualSize = "actualSize",
+    PageFit = "pageFit",
+    PageWidth = "pageWidth"
+}
+export declare enum ScrollDirection {
+    Horizontal = "Horizontal",
+    Vertical = "Vertical",
+    Both = "Both"
+}
+export declare enum VPVAnnotationType {
+    INTERNAL_LINK = "internal-link",
+    LINK = "link",
+    FILE_ATTACHMENT = "file-attachment",
+    FORM_TEXT = "form-text",
+    FORM_SELECT = "form-select",
+    FORM_CHECKBOX = "form-checkbox",
+    FORM_RADIO = "form-radio",
+    FORM_BUTTON = "form-button",
+    BUTTON = "button",
+    NAVIGATION = "navigation"
+}
+export declare enum LayerRenderStatus {
+    PreRender = 0,
+    DidRender = 1
+}
+export declare enum AnnotationType {
+    Text = 1,
+    Link = 2,
+    FreeText = 3,
+    Line = 4,
+    Square = 5,
+    Circle = 6,
+    Polygon = 7,
+    Polyline = 8,
+    Highlight = 9,
+    Underline = 10,
+    Squiggly = 11,
+    StrikeOut = 12,
+    Stamp = 13,
+    Caret = 14,
+    Ink = 15,
+    Popup = 16,
+    FileAttachment = 17,
+    Widget = 20
+}
+export declare enum AnnotationFlag {
+    INVISIBLE = 1,
+    HIDDEN = 2,
+    PRINT = 4,
+    NOZOOM = 8,
+    NOROTATE = 16,
+    NOVIEW = 32,
+    READONLY = 64,
+    LOCKED = 128,
+    TOGGLENOVIEW = 256,
+    LOCKEDCONTENTS = 512
+}

package/dist/types/utils/highlight.d.ts

@@ -0,0 +1,8 @@
+import type { TextContent } from 'pdfjs-dist/types/src/display/text_layer';
+import type { HighlightOptions, Match } from './types';
+declare function isMatchEntireWord(content: string, startIdx: number, length: number): boolean;
+declare function highlightMatches(matches: Match[], textContent: TextContent, textDivs: HTMLElement[]): void;
+declare function resetDivs(textContent: TextContent, textDivs: HTMLElement[]): void;
+declare function findMatches(queries: (string | RegExp)[], textContent: TextContent, pageIndex: number, options: HighlightOptions): Match[];
+declare function getHighlightOptionsWithDefaults(options?: HighlightOptions): HighlightOptions;
+export { findMatches, highlightMatches, resetDivs, getHighlightOptionsWithDefaults, isMatchEntireWord };

package/dist/types/utils/promiseWithResolvers.d.ts

@@ -0,0 +1,7 @@
+type Resolve = (value: unknown) => void;
+export declare function promiseWithResolvers<T = void>(): {
+    promise: Promise<T>;
+    resolve: Resolve;
+    reject: (reason?: any) => void;
+};
+export {};

package/dist/types/utils/searchHighlight.d.ts

@@ -0,0 +1,10 @@
+import type { CSSProperties } from 'vue';
+import type { FlagKeyword, HighlightArea, HighlightMatchPosition, NormalizedKeyword, SingleKeyword } from './types';
+export declare const normalizeFlagKeyword: (flagKeyword: FlagKeyword) => NormalizedKeyword;
+export declare const normalizeSingleKeyword: (keyword: SingleKeyword, matchCase?: boolean, wholeWords?: boolean) => NormalizedKeyword;
+export declare const sortHighlightPosition: (a: HighlightArea, b: HighlightArea) => 0 | 1 | -1;
+export declare const getHighlightStyle: (area: HighlightArea) => CSSProperties;
+export declare const unwrap: (ele: Node) => void;
+export declare const getHighlightElement: (layerRef: HTMLElement, query: HighlightMatchPosition, selector?: string) => HTMLElement;
+export declare const getHighlightElements: (layerRef: HTMLElement, querySelector: string) => Promise<NodeListOf<Element>>;
+export declare function scrollHighlightIntoView(highlightEle: HTMLElement, pageContainer: HTMLElement, viewerContainer: HTMLElement): void;

package/dist/types/utils/smoothScroll.d.ts

@@ -0,0 +1,2 @@
+import { ScrollDirection, Offset } from '..';
+export declare const smoothScroll: (ele: HTMLElement, scrollDirection: ScrollDirection, targetPosition: Offset, duration: number, easing?: (t: number) => number, onReachTarget?: () => void) => void;