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

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/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;
@@ -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,15 @@
+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 +18,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>;

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

@@ -1,4 +1,4 @@
-interface Props {
+export interface Props {
     jsUrl?: string;
     cssUrl?: string;
     initialize: (n?: HTMLElement | null) => void;

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

@@ -0,0 +1,14 @@
+export interface PillOption {
+    label: string;
+    value: string | number | null;
+}
+type __VLS_Props = {
+    options: PillOption[];
+    modelValue: string | number | null | undefined;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: string | number | null | undefined) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string | number | null | undefined) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/lib/components/CPopularityAndEngagementIcons/CPopularityAndEngagementExtended.vue.d.ts

@@ -10,5 +10,5 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     isRecommended: boolean;
     views: number;
     variation: "extended" | "compact" | "minimal";
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

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

@@ -0,0 +1,19 @@
+interface Props {
+    message?: string;
+    opacity?: number;
+    spinSize?: 'small' | 'medium' | 'large';
+    spinColor?: string;
+    textSize?: 'sm' | 'base' | 'lg' | 'xl';
+    textColor?: string;
+    rounded?: boolean;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {
+    textColor: string;
+    message: string;
+    opacity: number;
+    spinSize: "small" | "medium" | "large";
+    spinColor: string;
+    textSize: "sm" | "base" | "lg" | "xl";
+    rounded: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

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

@@ -0,0 +1,28 @@
+interface Props {
+    modelValue: string;
+    title?: string;
+    nameLabel?: string;
+    placeholder?: string;
+    description?: string;
+    cancelText?: string;
+    confirmText?: string;
+    required?: boolean;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    cancel: () => any;
+    "update:modelValue": (value: string) => any;
+    confirm: (value: string) => any;
+}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{
+    onCancel?: (() => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+    onConfirm?: ((value: string) => any) | undefined;
+}>, {
+    placeholder: string;
+    title: string;
+    required: boolean;
+    description: string;
+    nameLabel: string;
+    cancelText: string;
+    confirmText: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/lib/components/CRichTextEditor/components/CDynamicValueTreeSelect.vue.d.ts

@@ -1,6 +1,7 @@
 import { StyleValue } from 'vue';
 import { TreeSelectOverrideNodeClickBehavior } from 'naive-ui';
 type __VLS_Props = {
+    allowMultiple?: boolean;
     data: Record<string, any>;
     themeOverrides?: {
         active: StyleValue;
@@ -13,6 +14,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onSelect?: ((value: string) => any) | undefined;
 }>, {
+    allowMultiple: boolean;
     allowArrays: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     popoverRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{

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

@@ -0,0 +1,19 @@
+import { CanvasRetrieve } from '../../../types/openapi';
+type __VLS_Props = {
+    totalSelected: number;
+    addedItemIds?: CanvasRetrieve['id'][];
+    selectedItemIds?: CanvasRetrieve['id'][];
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "clear-selection": () => any;
+    "items-added": (itemIds: string[], position?: "bottom" | "top" | undefined) => any;
+    "items-removed": (itemIds: string[]) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onClear-selection"?: (() => any) | undefined;
+    "onItems-added"?: ((itemIds: string[], position?: "bottom" | "top" | undefined) => any) | undefined;
+    "onItems-removed"?: ((itemIds: string[]) => any) | undefined;
+}>, {
+    addedItemIds: CanvasRetrieve["id"][];
+    selectedItemIds: CanvasRetrieve["id"][];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

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

@@ -1,17 +1,43 @@
+import { nextTick } from 'vue';
 import { CanvasRetrieve } from '../../../types/openapi';
 type __VLS_Props = {
     storageKey: string;
+    mode: 'management' | 'selector';
+    selectedSectionIds?: CanvasRetrieve['id'][];
+    addedSectionIds?: CanvasRetrieve['id'][];
 };
 declare function onSmartFoldersConfigure(): void;
+declare function getSelectedSections(): CanvasRetrieve[];
+declare function calculateContentHeight(): void;
+declare function addSelectedSections(position?: 'top' | 'bottom'): void;
+declare function removeSelectedSections(): void;
 declare const _default: import('vue').DefineComponent<__VLS_Props, {
     showConfigurationModal: typeof onSmartFoldersConfigure;
+    addSelectedSections: typeof addSelectedSections;
+    removeSelectedSections: typeof removeSelectedSections;
+    getSelectedSections: typeof getSelectedSections;
+    calculateContentHeight: typeof calculateContentHeight;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "clear-selection": () => any;
     "open-section": (section: CanvasRetrieve) => any;
     "edit-section": (section: CanvasRetrieve) => any;
+    "section-select": (section: CanvasRetrieve) => any;
+    "section-add": (section: CanvasRetrieve) => any;
+    "section-remove": (section: CanvasRetrieve) => any;
+    "sections-bulk-add": (sections: CanvasRetrieve[], position?: "bottom" | "top" | undefined, targetIndex?: number | undefined) => any;
+    "sections-bulk-remove": (sections: CanvasRetrieve[]) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onClear-selection"?: (() => any) | undefined;
     "onOpen-section"?: ((section: CanvasRetrieve) => any) | undefined;
     "onEdit-section"?: ((section: CanvasRetrieve) => any) | undefined;
+    "onSection-select"?: ((section: CanvasRetrieve) => any) | undefined;
+    "onSection-add"?: ((section: CanvasRetrieve) => any) | undefined;
+    "onSection-remove"?: ((section: CanvasRetrieve) => any) | undefined;
+    "onSections-bulk-add"?: ((sections: CanvasRetrieve[], position?: "bottom" | "top" | undefined, targetIndex?: number | undefined) => any) | undefined;
+    "onSections-bulk-remove"?: ((sections: CanvasRetrieve[]) => any) | undefined;
 }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    containerRef: HTMLDivElement;
+    toolbarRef: HTMLDivElement;
     listRef: ({
         $: import('vue').ComponentInternalInstance;
         $data: {};
@@ -72,7 +98,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
             errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void)[];
         };
         $forceUpdate: () => void;
-        $nextTick: typeof import('vue').nextTick;
+        $nextTick: typeof nextTick;
         $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import('@vue/reactivity').OnCleanup]) => any : (...args: [any, any, import('@vue/reactivity').OnCleanup]) => any, options?: import('vue').WatchOptions): import('vue').WatchStopHandle;
     } & Readonly<{}> & Omit<Readonly<{
         data: import('../CList/CList.vue').ListDataItem[];

package/lib/components/CSectionSmartFolders/CSectionSmartFoldersToolbar.vue.d.ts

@@ -4,10 +4,16 @@ type Props = {
         field: string;
         order: 'asc' | 'desc';
     };
+    mode: 'management' | 'selector';
+    selectedItemIds?: string[];
+    addedItemIds?: string[];
 };
 declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     search: (value: string) => any;
     "update:search": (value: string) => any;
+    "clear-selection": () => any;
+    "items-added": (itemIds: string[], position?: "bottom" | "top" | undefined) => any;
+    "items-removed": (itemIds: string[]) => any;
     "breadcrumb-click": (index: number) => any;
     "breadcrumb-reset": () => any;
     "sort-changed": (sort: {
@@ -17,6 +23,9 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
 }, string, import('vue').PublicProps, Readonly<Props> & Readonly<{
     onSearch?: ((value: string) => any) | undefined;
     "onUpdate:search"?: ((value: string) => any) | undefined;
+    "onClear-selection"?: (() => any) | undefined;
+    "onItems-added"?: ((itemIds: string[], position?: "bottom" | "top" | undefined) => any) | undefined;
+    "onItems-removed"?: ((itemIds: string[]) => any) | undefined;
     "onBreadcrumb-click"?: ((index: number) => any) | undefined;
     "onBreadcrumb-reset"?: (() => any) | undefined;
     "onSort-changed"?: ((sort: {
@@ -25,6 +34,8 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     }) => any) | undefined;
 }>, {
     search: string;
+    addedItemIds: string[];
+    selectedItemIds: string[];
     currentSort: {
         field: string;
         order: "asc" | "desc";

package/lib/components/CSlideViewer/CSlideViewer.pdfjs.vue.d.ts

@@ -0,0 +1,18 @@
+type __VLS_Props = {
+    pageIndex?: number;
+    useClientSide?: boolean;
+    pdfUrl?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    pdfLoaded: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onPdfLoaded?: (() => any) | undefined;
+}>, {
+    pageIndex: number;
+    pdfUrl: string;
+    useClientSide: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    containerRef: HTMLDivElement;
+    canvasRef: HTMLCanvasElement;
+}, HTMLDivElement>;
+export default _default;

package/lib/components/CSlideViewer/CSlideViewer.pspdfkit.vue.d.ts

@@ -0,0 +1,14 @@
+type __VLS_Props = {
+    pageIndex?: number;
+    pdfUrl: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    pdfLoaded: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onPdfLoaded?: (() => any) | undefined;
+}>, {
+    pageIndex: number;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    iframeRef: HTMLIFrameElement;
+}, HTMLDivElement>;
+export default _default;

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

@@ -1,7 +1,6 @@
 type __VLS_Props = {
-    pdfUrl: string | null;
     pageIndex?: number;
-    pdfjsDirUrl?: string;
+    pdfUrl: string;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     pdfLoaded: () => any;
@@ -9,9 +8,5 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     onPdfLoaded?: (() => any) | undefined;
 }>, {
     pageIndex: number;
-    pdfjsDirUrl: string;
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
-    containerRef: HTMLDivElement;
-    canvasRef: HTMLCanvasElement;
-}, HTMLDivElement>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

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

@@ -9,6 +9,7 @@ interface UserMenuOptionItem {
     icon?: string;
     text?: string;
     type?: 'separator';
+    paddingClass?: string;
 }
 interface Props {
     menuPlacement: PopoverPlacement;