@pitcher/js-api 1.24.0-beta.3 → 1.25.0-beta.0

package/lib/components/CFileViewer/CFileViewer.vue.d.ts

@@ -7,9 +7,38 @@ import { CLIENT_TYPE } from '../../constants/cdp.const';
 import { AnnotationType } from './CFileViewer.types';
 import { PitcherFile } from '../../types/file.types';
 import { SupportedLocale } from '../../types/i18n.types';
+type __VLS_Props = {
+    file: PitcherFile | null;
+    initialPageNumber?: MiniPage['page_index'];
+    initialSearch?: string;
+    filePagesFavorites: Favorite[];
+    fileFavorite: Favorite | null;
+    isLoadingFavorite: boolean;
+    isPublishing?: boolean;
+    isSavingPagesMetadata?: boolean;
+    isLoadingInstanceMetadataTemplate?: boolean;
+    i18n: I18n;
+    hideActions?: boolean;
+    hideDownload?: boolean;
+    assetsPrefix?: string;
+    isFavoriteEnabled?: boolean;
+    clientType?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+    selectContent?: (fileId?: FileRetrieve['id'], pageIndex?: number) => Promise<FileRetrieve | null>;
+    appLocale?: SupportedLocale;
+    context?: Record<string, any>;
+    feedbackIntegration?: typeof FeedbackIntegration;
+    recentFiles?: RecentFile[];
+    track?: (eventName: string, payload: any) => void;
+    allowNoteTaking?: boolean;
+    fetchFileById?: (fileId: File['id']) => Promise<FileRetrieve>;
+    isOverlay?: boolean;
+    videoCurrentTime?: number;
+    instanceMetadataTemplate?: MetadataTemplate | null;
+};
 declare function __VLS_template(): {
+    attrs: Partial<{}>;
     slots: {
-        "file-info"?(_: {
+        'file-info'?(_: {
             file: PitcherFile | null;
         }): any;
     };
@@ -111,10 +140,12 @@ declare function __VLS_template(): {
                 preload?: string;
                 controls?: boolean;
                 responsive?: boolean;
+                maxHeight?: number;
                 liveui?: boolean;
                 enableSmoothSeeking?: boolean;
                 autoplay?: boolean;
                 poster?: string;
+                posterBackgroundSize?: import('../../types/background').BackgroundSize;
             };
         }> & Readonly<{
             onPause?: ((currentTime: number) => any) | undefined;
@@ -136,7 +167,9 @@ declare function __VLS_template(): {
         }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
             pause: (currentTime: number) => any;
             seeked: (currentTime: number) => any;
-        }, import('vue').PublicProps, {}, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        }, import('vue').PublicProps, {}, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+            videoPlayerRef: HTMLVideoElement;
+        }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
             D: {};
@@ -156,10 +189,12 @@ declare function __VLS_template(): {
                 preload?: string;
                 controls?: boolean;
                 responsive?: boolean;
+                maxHeight?: number;
                 liveui?: boolean;
                 enableSmoothSeeking?: boolean;
                 autoplay?: boolean;
                 poster?: string;
+                posterBackgroundSize?: import('../../types/background').BackgroundSize;
             };
         }> & Readonly<{
             onPause?: ((currentTime: number) => any) | undefined;
@@ -180,62 +215,10 @@ declare function __VLS_template(): {
             } | null>;
         }, {}, {}, {}, {}> | null;
     };
-    attrs: Partial<{}>;
+    rootEl: any;
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<{
-    file: PitcherFile | null;
-    initialPageNumber?: MiniPage["page_index"];
-    initialSearch?: string;
-    filePagesFavorites: Favorite[];
-    fileFavorite: Favorite | null;
-    isLoadingFavorite: boolean;
-    isPublishing?: boolean;
-    isSavingPagesMetadata?: boolean;
-    isLoadingInstanceMetadataTemplate?: boolean;
-    i18n: I18n;
-    hideActions?: boolean;
-    assetsPrefix?: string;
-    isFavoriteEnabled?: boolean;
-    clientType?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
-    selectContent?: (fileId?: FileRetrieve["id"], pageIndex?: number) => Promise<FileRetrieve | null>;
-    appLocale?: SupportedLocale;
-    context?: Record<string, any>;
-    feedbackIntegration?: typeof FeedbackIntegration;
-    recentFiles?: RecentFile[];
-    track?: (eventName: string, payload: any) => void;
-    allowNoteTaking?: boolean;
-    fetchFileById?: (fileId: File["id"]) => Promise<FileRetrieve>;
-    isOverlay?: boolean;
-    videoCurrentTime?: number;
-    instanceMetadataTemplate?: MetadataTemplate | null;
-}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
-    file: PitcherFile | null;
-    initialPageNumber?: MiniPage["page_index"];
-    initialSearch?: string;
-    filePagesFavorites: Favorite[];
-    fileFavorite: Favorite | null;
-    isLoadingFavorite: boolean;
-    isPublishing?: boolean;
-    isSavingPagesMetadata?: boolean;
-    isLoadingInstanceMetadataTemplate?: boolean;
-    i18n: I18n;
-    hideActions?: boolean;
-    assetsPrefix?: string;
-    isFavoriteEnabled?: boolean;
-    clientType?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
-    selectContent?: (fileId?: FileRetrieve["id"], pageIndex?: number) => Promise<FileRetrieve | null>;
-    appLocale?: SupportedLocale;
-    context?: Record<string, any>;
-    feedbackIntegration?: typeof FeedbackIntegration;
-    recentFiles?: RecentFile[];
-    track?: (eventName: string, payload: any) => void;
-    allowNoteTaking?: boolean;
-    fetchFileById?: (fileId: File["id"]) => Promise<FileRetrieve>;
-    isOverlay?: boolean;
-    videoCurrentTime?: number;
-    instanceMetadataTemplate?: MetadataTemplate | null;
-}> & Readonly<{}>, {
+declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
     file: PitcherFile | null;
     isOverlay: boolean;
     isLoadingFavorite: boolean;
@@ -243,13 +226,186 @@ declare const __VLS_component: import('vue').DefineComponent<{
     hideActions: boolean;
     allowNoteTaking: boolean;
     clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+    hideDownload: boolean;
+    isFavoriteEnabled: boolean;
     filePagesFavorites: Favorite[];
     assetsPrefix: string;
-    isFavoriteEnabled: boolean;
     initialPageNumber: number;
     initialSearch: string;
     fileFavorite: Favorite | null;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    pdfViewerEl: HTMLDivElement;
+    bottomBarRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        totalPages: number;
+        page?: number;
+        fileViewerSettings: import('../../types/fileViewerSettings.types').FileViewerSettings;
+        file: PitcherFile | null;
+        isTextAnnotationSelected: boolean;
+        isLinkAnnotationSelected: boolean;
+        isAnnotationsSelected: boolean;
+        selectedAnnotationType: Exclude<AnnotationType, "text">;
+        isSearchSelected: boolean;
+        isThumbnailsSelected: boolean;
+        hideActions: boolean;
+        isFullscreen: boolean;
+        clientType?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+        isOverlay?: boolean;
+    }> & Readonly<{
+        onClick?: (() => any) | undefined;
+        onExitFullscreen?: (() => any) | undefined;
+        onZoomOut?: (() => any) | undefined;
+        onZoomIn?: (() => any) | undefined;
+        onSetPage?: ((p: number) => any) | undefined;
+        onFitModeToggle?: (() => any) | undefined;
+        onSearchFile?: (() => any) | undefined;
+        onToggleThumbnails?: (() => any) | undefined;
+        onToggleTextAnnotation?: (() => any) | undefined;
+        onToggleLinkAnnotation?: (() => any) | undefined;
+        onToggleAnnotations?: (() => any) | undefined;
+        onSelectAnnotation?: ((a: "link" | "drawing" | "freeformHighlight" | "textHighlight" | "eraser") => any) | undefined;
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        click: () => any;
+        exitFullscreen: () => any;
+        zoomOut: () => any;
+        zoomIn: () => any;
+        setPage: (p: number) => any;
+        fitModeToggle: () => any;
+        searchFile: () => any;
+        toggleThumbnails: () => any;
+        toggleTextAnnotation: () => any;
+        toggleLinkAnnotation: () => any;
+        toggleAnnotations: () => any;
+        selectAnnotation: (a: "link" | "drawing" | "freeformHighlight" | "textHighlight" | "eraser") => any;
+    }, import('vue').PublicProps, {
+        page: number;
+        isOverlay: boolean;
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        totalPages: number;
+        page?: number;
+        fileViewerSettings: import('../../types/fileViewerSettings.types').FileViewerSettings;
+        file: PitcherFile | null;
+        isTextAnnotationSelected: boolean;
+        isLinkAnnotationSelected: boolean;
+        isAnnotationsSelected: boolean;
+        selectedAnnotationType: Exclude<AnnotationType, "text">;
+        isSearchSelected: boolean;
+        isThumbnailsSelected: boolean;
+        hideActions: boolean;
+        isFullscreen: boolean;
+        clientType?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+        isOverlay?: boolean;
+    }> & Readonly<{
+        onClick?: (() => any) | undefined;
+        onExitFullscreen?: (() => any) | undefined;
+        onZoomOut?: (() => any) | undefined;
+        onZoomIn?: (() => any) | undefined;
+        onSetPage?: ((p: number) => any) | undefined;
+        onFitModeToggle?: (() => any) | undefined;
+        onSearchFile?: (() => any) | undefined;
+        onToggleThumbnails?: (() => any) | undefined;
+        onToggleTextAnnotation?: (() => any) | undefined;
+        onToggleLinkAnnotation?: (() => any) | undefined;
+        onToggleAnnotations?: (() => any) | undefined;
+        onSelectAnnotation?: ((a: "link" | "drawing" | "freeformHighlight" | "textHighlight" | "eraser") => any) | undefined;
+    }>, {}, {}, {}, {}, {
+        page: number;
+        isOverlay: boolean;
+    }> | null;
+    videoPlayerEl: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        currentTime?: number;
+        ignoreAspectRatio?: boolean;
+        preventPointerEvents?: boolean;
+        options?: {
+            sources?: {
+                src: string;
+                type?: string;
+            }[];
+            fluid?: boolean;
+            preload?: string;
+            controls?: boolean;
+            responsive?: boolean;
+            maxHeight?: number;
+            liveui?: boolean;
+            enableSmoothSeeking?: boolean;
+            autoplay?: boolean;
+            poster?: string;
+            posterBackgroundSize?: import('../../types/background').BackgroundSize;
+        };
+    }> & Readonly<{
+        onPause?: ((currentTime: number) => any) | undefined;
+        onSeeked?: ((currentTime: number) => any) | undefined;
+    }>, {
+        videoPlayer: Ref<{
+            dispose: () => void;
+            requestFullscreen: () => void;
+            on: (event: string, callback: (this: import('../CVideo/CVideo.types').VideoPlayerType, ...args: any[]) => void) => void;
+            currentTime: (time?: number) => number;
+            el_: HTMLElement;
+        } | null, import('../CVideo/CVideo.types').VideoPlayerType | {
+            dispose: () => void;
+            requestFullscreen: () => void;
+            on: (event: string, callback: (this: import('../CVideo/CVideo.types').VideoPlayerType, ...args: any[]) => void) => void;
+            currentTime: (time?: number) => number;
+            el_: HTMLElement;
+        } | null>;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        pause: (currentTime: number) => any;
+        seeked: (currentTime: number) => any;
+    }, import('vue').PublicProps, {}, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+        videoPlayerRef: HTMLVideoElement;
+    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        currentTime?: number;
+        ignoreAspectRatio?: boolean;
+        preventPointerEvents?: boolean;
+        options?: {
+            sources?: {
+                src: string;
+                type?: string;
+            }[];
+            fluid?: boolean;
+            preload?: string;
+            controls?: boolean;
+            responsive?: boolean;
+            maxHeight?: number;
+            liveui?: boolean;
+            enableSmoothSeeking?: boolean;
+            autoplay?: boolean;
+            poster?: string;
+            posterBackgroundSize?: import('../../types/background').BackgroundSize;
+        };
+    }> & Readonly<{
+        onPause?: ((currentTime: number) => any) | undefined;
+        onSeeked?: ((currentTime: number) => any) | undefined;
+    }>, {
+        videoPlayer: Ref<{
+            dispose: () => void;
+            requestFullscreen: () => void;
+            on: (event: string, callback: (this: import('../CVideo/CVideo.types').VideoPlayerType, ...args: any[]) => void) => void;
+            currentTime: (time?: number) => number;
+            el_: HTMLElement;
+        } | null, import('../CVideo/CVideo.types').VideoPlayerType | {
+            dispose: () => void;
+            requestFullscreen: () => void;
+            on: (event: string, callback: (this: import('../CVideo/CVideo.types').VideoPlayerType, ...args: any[]) => void) => void;
+            currentTime: (time?: number) => number;
+            el_: HTMLElement;
+        } | null>;
+    }, {}, {}, {}, {}> | null;
+}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
 type __VLS_WithTemplateSlots<T, S> = T & {

package/lib/components/CFileViewer/CFileViewerCloseDialogContent.vue.d.ts

@@ -1,10 +1,9 @@
-declare const _default: import('vue').DefineComponent<{
+type __VLS_Props = {
     rememberForNextTime: boolean;
-}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     "update:rememberForNextTime": (value: boolean) => any;
-}, string, import('vue').PublicProps, Readonly<{
-    rememberForNextTime: boolean;
-}> & Readonly<{
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     "onUpdate:rememberForNextTime"?: ((value: boolean) => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/lib/components/CFileViewer/CFileViewerTop.vue.d.ts

@@ -16,6 +16,8 @@ interface Props {
     recentFiles?: RecentFile[];
     track?: (eventName: string, payload: any) => void;
     disableFullScreen?: boolean;
+    hideDownload?: boolean;
+    isFavoriteEnabled?: boolean;
 }
 declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     search: () => any;