@pitcher/js-api 1.26.0-beta.1 → 1.26.0-beta.10

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

@@ -0,0 +1,6 @@
+import { File } from '../../../types/openapi';
+type __VLS_Props = {
+    file: File;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -1,7 +1,7 @@
 import { Ref } from 'vue';
 import { I18n } from 'vue-i18n';
 import { feedbackIntegration as FeedbackIntegration } from '@sentry/vue';
-import { File, Favorite, MiniPage, FileRetrieve, MetadataTemplate } from '../../../types/openapi';
+import { File, MiniPage, FileRetrieve, MetadataTemplate } from '../../../types/openapi';
 import { RecentFile } from '../../types/recentFiles.types';
 import { CLIENT_TYPE } from '../../constants/cdp.const';
 import { AnnotationType } from './CFileViewer.types';
@@ -11,9 +11,6 @@ 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;
@@ -21,7 +18,6 @@ type __VLS_Props = {
     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;
@@ -64,6 +60,7 @@ declare function __VLS_template(): {
             isAnnotationVisibilityEnabled: boolean;
             hasHotspotsOnCurrentPage: boolean;
             isHotspotToggleEnabled: boolean;
+            rootElement?: HTMLElement | null;
         }> & Readonly<{
             onClick?: (() => any) | undefined;
             onExitFullscreen?: (() => any) | undefined;
@@ -120,6 +117,7 @@ declare function __VLS_template(): {
             isAnnotationVisibilityEnabled: boolean;
             hasHotspotsOnCurrentPage: boolean;
             isHotspotToggleEnabled: boolean;
+            rootElement?: HTMLElement | null;
         }> & Readonly<{
             onClick?: (() => any) | undefined;
             onExitFullscreen?: (() => any) | undefined;
@@ -232,18 +230,14 @@ type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 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;
     isPublishing: boolean;
     hideActions: boolean;
     allowNoteTaking: boolean;
     clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
     hideDownload: boolean;
-    isFavoriteEnabled: boolean;
-    filePagesFavorites: Favorite[];
     assetsPrefix: string;
     initialPageNumber: number;
     initialSearch: string;
-    fileFavorite: Favorite | null;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     pdfViewerEl: HTMLDivElement;
     bottomBarRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
@@ -264,6 +258,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}
         isAnnotationVisibilityEnabled: boolean;
         hasHotspotsOnCurrentPage: boolean;
         isHotspotToggleEnabled: boolean;
+        rootElement?: HTMLElement | null;
     }> & Readonly<{
         onClick?: (() => any) | undefined;
         onExitFullscreen?: (() => any) | undefined;
@@ -320,6 +315,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}
         isAnnotationVisibilityEnabled: boolean;
         hasHotspotsOnCurrentPage: boolean;
         isHotspotToggleEnabled: boolean;
+        rootElement?: HTMLElement | null;
     }> & Readonly<{
         onClick?: (() => any) | undefined;
         onExitFullscreen?: (() => any) | undefined;

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

@@ -8,8 +8,6 @@ interface Props {
     file: PitcherFile | null;
     isPublishing: boolean;
     areAnnotationsModified: boolean;
-    isFavorite: boolean;
-    isLoadingFavorite: boolean;
     hideActions: boolean;
     allowNoteTaking?: boolean;
     clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
@@ -18,7 +16,6 @@ interface Props {
     track?: (eventName: string, payload: any) => void;
     disableFullScreen?: boolean;
     hideDownload?: boolean;
-    isFavoriteEnabled?: boolean;
     isInSharebox?: boolean;
     isPreviewMode?: boolean;
 }
@@ -28,7 +25,6 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     downloadFile: () => any;
     publishFile: () => any;
     addToSharebox: (args_0: ShareboxItem) => any;
-    toggleFavoriteFile: () => any;
     toggleNotes: () => any;
     showRecentFiles: (args_0: string[]) => any;
     toggleFullscreen: () => any;
@@ -44,7 +40,6 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     onDownloadFile?: (() => any) | undefined;
     onPublishFile?: (() => any) | undefined;
     onAddToSharebox?: ((args_0: ShareboxItem) => any) | undefined;
-    onToggleFavoriteFile?: (() => any) | undefined;
     onToggleNotes?: (() => any) | undefined;
     onShowRecentFiles?: ((args_0: string[]) => any) | undefined;
     onToggleFullscreen?: (() => any) | undefined;

package/lib/components/CFileViewer/pdf/CFileViewer.pdf.link.types.d.ts

@@ -1,13 +1,14 @@
 import { File } from '../../../../types/openapi';
 export interface SaveLinkAnnotationPayload {
     customData: {
-        type: 'file';
-        fileId: File['id'];
+        type: 'file' | 'url';
+        fileId?: File['id'];
         pageIndex?: number;
         newTab?: boolean;
         startTime?: number;
         embedded?: boolean;
         autoplay?: boolean;
+        url?: string;
         tags?: string[];
         trackingId?: string;
     };

package/lib/components/CFileViewer/pdf/CFileViewer.pdf.use.d.ts

@@ -3,7 +3,7 @@ import { I18n } from 'vue-i18n';
 import { Instance, AnnotationsUnion } from 'pspdfkit';
 import { AnnotationType } from '../CFileViewer.types';
 import { PitcherFile } from '../../../types/file.types';
-import { Favorite, MiniPage, File, FileRetrieve } from '../../../../types/openapi';
+import { MiniPage, File, FileRetrieve } from '../../../../types/openapi';
 import { CLIENT_TYPE } from '../../../constants/cdp.const';
 import { default as CFileViewerBottomPdf } from './CFileViewerBottom.pdf.vue';
 import { CanvasFile } from '../../../apps/canvas-builder/types/canvas';
@@ -19,7 +19,6 @@ declare const fileViewerSettings: Readonly<Ref<{
 }>>;
 interface FileViewerActions {
     onCloseFile: () => void;
-    onToggleFavoriteFilePage: (pageIndex: number) => void;
     onShowPageMetadata: (pageIndex: number) => void;
 }
 interface FileViewerPdfReturnType {
@@ -33,7 +32,6 @@ interface FileViewerPdfReturnType {
     isTextAnnotationOpen: Ref<boolean>;
     isLinkAnnotationOpen: Ref<boolean>;
     currentPageIndex: Ref<number>;
-    toggleFavoritePageIndex: Ref<number | null>;
     isAnnotationOpen: Ref<boolean>;
     areAnnotationsModified: Ref<boolean>;
     selectedAnnotationType: Ref<Exclude<AnnotationType, 'text'>>;
@@ -47,15 +45,13 @@ interface FileViewerPdfReturnType {
     onSaveLinkAnnotation: (data: SaveLinkAnnotationPayload) => void;
     hasHotspotsOnCurrentPage: Ref<boolean>;
 }
-declare const _default: ({ pdfViewerEl, bottomBarRef, i18n, appLocale, actions, filePagesFavorites, assetsPrefix, isFavoriteEnabled, clientType, context, pitcherSettings, launchDarkly, emit, fileId, fetchFileById, }: {
+declare const _default: ({ pdfViewerEl, bottomBarRef, i18n, appLocale, actions, assetsPrefix, clientType, context, pitcherSettings, launchDarkly, emit, fileId, fetchFileById, }: {
     pdfViewerEl: Ref<HTMLElement | null>;
     bottomBarRef: Ref<InstanceType<typeof CFileViewerBottomPdf> | null>;
-    filePagesFavorites: ComputedRef<Favorite[] | null>;
     i18n: I18n;
     appLocale?: SupportedLocale;
     actions: FileViewerActions;
     assetsPrefix: string;
-    isFavoriteEnabled: boolean;
     clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
     context?: Record<string, any>;
     pitcherSettings?: ComputedRef<OrganizationSettings & InstanceSettings>;

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

@@ -21,6 +21,7 @@ type Props = {
     isAnnotationVisibilityEnabled: boolean;
     hasHotspotsOnCurrentPage: boolean;
     isHotspotToggleEnabled: boolean;
+    rootElement?: HTMLElement | null;
 };
 export interface AnnotationOption extends SelectBaseOption {
     label: string;

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

@@ -36,14 +36,16 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     }>, {
         validate: () => Promise<{
             config: Record<string, any>;
-            success: boolean;
+            success: true;
             errors?: undefined;
+            firstErrorFieldName?: undefined;
         } | {
             config: Record<string, any>;
             errors: unknown;
-            success: boolean;
+            firstErrorFieldName: string | undefined;
+            success: false;
         }>;
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
         change: (config: Record<string, any>) => any;
     }, import('vue').PublicProps, {
         loading: boolean;
@@ -183,9 +185,9 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
         }>> & Readonly<{}>, import('naive-ui').FormInst & {
             mergedClsPrefix: import('vue').Ref<string, string>;
         }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
-            readonly inline: boolean;
             readonly disabled: boolean;
             readonly onSubmit: (e: Event) => void;
+            readonly inline: boolean;
             readonly labelPlacement: import('naive-ui/es/form/src/interface').LabelPlacement;
             readonly model: Record<string, any>;
             readonly showRequireMark: boolean | undefined;
@@ -330,9 +332,9 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
         }>> & Readonly<{}>, import('naive-ui').FormInst & {
             mergedClsPrefix: import('vue').Ref<string, string>;
         }, {}, {}, {}, {
-            readonly inline: boolean;
             readonly disabled: boolean;
             readonly onSubmit: (e: Event) => void;
+            readonly inline: boolean;
             readonly labelPlacement: import('naive-ui/es/form/src/interface').LabelPlacement;
             readonly model: Record<string, any>;
             readonly showRequireMark: boolean | undefined;
@@ -358,12 +360,14 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     }>, {
         validate: () => Promise<{
             config: Record<string, any>;
-            success: boolean;
+            success: true;
             errors?: undefined;
+            firstErrorFieldName?: undefined;
         } | {
             config: Record<string, any>;
             errors: unknown;
-            success: boolean;
+            firstErrorFieldName: string | undefined;
+            success: false;
         }>;
     }, {}, {}, {}, {
         loading: boolean;

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

@@ -1,9 +1,16 @@
+import { ComputedRef } from 'vue';
+import { FileContentTypeEnum } from '../../../types/openapi';
 type __VLS_Props = {
     src?: string | null;
     fallbackSrc?: string | null;
     aiImgDescription?: string;
     objectFit?: 'cover' | 'contain' | 'scale-down';
     type?: 'default' | 'error';
+    fileData?: {
+        name?: string;
+        content_type?: FileContentTypeEnum | null;
+        content_extension?: string | null;
+    } | null;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     error: () => any;
@@ -12,6 +19,11 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
 }>, {
     type: "default" | "error";
     objectFit: "cover" | "contain" | "scale-down";
+    fileData: {
+        name?: string;
+        content_type?: FileContentTypeEnum | null;
+        content_extension?: string | null;
+    } | null;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     imageRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
         onPreviewPrev: import('vue').PropType<() => void>;
@@ -48,7 +60,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>;
         themeOverrides: import('vue').PropType<import('naive-ui/es/_mixins/use-theme').ExtractThemeOverrides<import('naive-ui/es/_mixins').Theme<"Image", {
@@ -77,7 +102,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>>;
         builtinThemeOverrides: import('vue').PropType<import('naive-ui/es/_mixins/use-theme').ExtractThemeOverrides<import('naive-ui/es/_mixins').Theme<"Image", {
@@ -106,7 +144,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>>;
         alt: StringConstructor;
@@ -129,26 +180,26 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         onLoad: import('vue').PropType<(e: Event) => void>;
     }>> & Readonly<{}>, {
         click: () => void;
+        showPreview: () => void;
         mergedClsPrefix: import('vue').Ref<string, string>;
         groupId: string | undefined;
         previewInstRef: import('vue').Ref<{
             setThumbnailEl: (e: HTMLImageElement | null) => void;
-            setPreviewSrc: (src?: string) => void;
-            toggleShow: () => void;
-        } | null, import('naive-ui/es/image/src/ImagePreview').ImagePreviewInst | {
+        } | null, import('naive-ui').ImagePreviewInst | {
             setThumbnailEl: (e: HTMLImageElement | null) => void;
-            setPreviewSrc: (src?: string) => void;
-            toggleShow: () => void;
         } | null>;
         imageRef: import('vue').Ref<HTMLImageElement | null, HTMLImageElement | null>;
+        mergedPreviewSrc: import('vue').ComputedRef<string | undefined>;
         showError: import('vue').Ref<boolean, boolean>;
         shouldStartLoading: import('vue').Ref<boolean, boolean>;
         loaded: import('vue').Ref<boolean, boolean>;
-        mergedOnClick: (e: MouseEvent) => void;
+        mergedOnClick: (e: PointerEvent) => void;
+        onPreviewClose: () => void;
         mergedOnError: (e: Event) => void;
         mergedOnLoad: (e: Event) => void;
+        previewShow: import('vue').Ref<boolean, boolean>;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
-        objectFit: "fill" | "none" | "contain" | "cover" | "scale-down";
+        objectFit: "none" | "fill" | "contain" | "cover" | "scale-down";
         lazy: boolean;
         showToolbar: boolean;
         showToolbarTooltip: boolean;
@@ -195,7 +246,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>;
         themeOverrides: import('vue').PropType<import('naive-ui/es/_mixins/use-theme').ExtractThemeOverrides<import('naive-ui/es/_mixins').Theme<"Image", {
@@ -224,7 +288,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>>;
         builtinThemeOverrides: import('vue').PropType<import('naive-ui/es/_mixins/use-theme').ExtractThemeOverrides<import('naive-ui/es/_mixins').Theme<"Image", {
@@ -253,7 +330,20 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
                     arrowOffsetVertical: string;
                     arrowHeight: string;
                     padding: string;
-                }, any>;
+                }, {
+                    Scrollbar: import('naive-ui/es/_mixins').Theme<"Scrollbar", {
+                        height: string;
+                        width: string;
+                        borderRadius: string;
+                        color: string;
+                        colorHover: string;
+                        railInsetHorizontalBottom: string;
+                        railInsetHorizontalTop: string;
+                        railInsetVerticalRight: string;
+                        railInsetVerticalLeft: string;
+                        railColor: string;
+                    }, any>;
+                }>;
             }>;
         }>>>;
         alt: StringConstructor;
@@ -276,26 +366,26 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         onLoad: import('vue').PropType<(e: Event) => void>;
     }>> & Readonly<{}>, {
         click: () => void;
+        showPreview: () => void;
         mergedClsPrefix: import('vue').Ref<string, string>;
         groupId: string | undefined;
         previewInstRef: import('vue').Ref<{
             setThumbnailEl: (e: HTMLImageElement | null) => void;
-            setPreviewSrc: (src?: string) => void;
-            toggleShow: () => void;
-        } | null, import('naive-ui/es/image/src/ImagePreview').ImagePreviewInst | {
+        } | null, import('naive-ui').ImagePreviewInst | {
             setThumbnailEl: (e: HTMLImageElement | null) => void;
-            setPreviewSrc: (src?: string) => void;
-            toggleShow: () => void;
         } | null>;
         imageRef: import('vue').Ref<HTMLImageElement | null, HTMLImageElement | null>;
+        mergedPreviewSrc: import('vue').ComputedRef<string | undefined>;
         showError: import('vue').Ref<boolean, boolean>;
         shouldStartLoading: import('vue').Ref<boolean, boolean>;
         loaded: import('vue').Ref<boolean, boolean>;
-        mergedOnClick: (e: MouseEvent) => void;
+        mergedOnClick: (e: PointerEvent) => void;
+        onPreviewClose: () => void;
         mergedOnError: (e: Event) => void;
         mergedOnLoad: (e: Event) => void;
+        previewShow: import('vue').Ref<boolean, boolean>;
     }, {}, {}, {}, {
-        objectFit: "fill" | "none" | "contain" | "cover" | "scale-down";
+        objectFit: "none" | "fill" | "contain" | "cover" | "scale-down";
         lazy: boolean;
         showToolbar: boolean;
         showToolbarTooltip: boolean;