@pitcher/js-api 1.25.0-beta.3 → 1.26.0-beta.1

package/lib/components/savedCanvases/CSavedCanvasesManagementOwnerCell.vue.d.ts

@@ -144,7 +144,7 @@ declare const _default: import('vue').DefineComponent<{
             readonly type: BooleanConstructor;
             readonly default: true;
         };
-        readonly status: import('vue').PropType<import('naive-ui/es/form/src/interface').FormValidationStatus>;
+        readonly status: import('vue').PropType<import('naive-ui').FormValidationStatus>;
         readonly showCheckmark: {
             readonly type: BooleanConstructor;
             readonly default: true;
@@ -575,7 +575,7 @@ declare const _default: import('vue').DefineComponent<{
             }>;
         }>>>;
     }>> & Readonly<{}>, {
-        mergedStatus: import('vue').ComputedRef<import('naive-ui/es/form/src/interface').FormValidationStatus | undefined>;
+        mergedStatus: import('vue').ComputedRef<import('naive-ui').FormValidationStatus | undefined>;
         mergedClsPrefix: import('vue').Ref<string, string>;
         mergedBordered: import('vue').ComputedRef<boolean>;
         namespace: import('vue').ComputedRef<string | undefined>;
@@ -1004,7 +1004,7 @@ declare const _default: import('vue').DefineComponent<{
             readonly type: BooleanConstructor;
             readonly default: true;
         };
-        readonly status: import('vue').PropType<import('naive-ui/es/form/src/interface').FormValidationStatus>;
+        readonly status: import('vue').PropType<import('naive-ui').FormValidationStatus>;
         readonly showCheckmark: {
             readonly type: BooleanConstructor;
             readonly default: true;
@@ -1435,7 +1435,7 @@ declare const _default: import('vue').DefineComponent<{
             }>;
         }>>>;
     }>> & Readonly<{}>, {
-        mergedStatus: import('vue').ComputedRef<import('naive-ui/es/form/src/interface').FormValidationStatus | undefined>;
+        mergedStatus: import('vue').ComputedRef<import('naive-ui').FormValidationStatus | undefined>;
         mergedClsPrefix: import('vue').Ref<string, string>;
         mergedBordered: import('vue').ComputedRef<boolean>;
         namespace: import('vue').ComputedRef<string | undefined>;

package/lib/components/savedCanvases/smartFolders/SmartFolders.vue.d.ts

@@ -50,8 +50,6 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
         sortChanged: (s: import('@tanstack/table-core').SortingState) => any;
         pageChanged: (p: import('@tanstack/table-core').PaginationState) => any;
@@ -119,8 +117,6 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, {
         data: {
             [x: string]: any;

package/lib/components/savedCanvases/smartFolders/SmartFoldersMissingConfig.vue.d.ts

@@ -1,6 +1,11 @@
-declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+type __VLS_Props = {
+    hideConfigurationButton?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     configure: () => any;
-}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onConfigure?: (() => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+}>, {
+    hideConfigurationButton: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;

package/lib/components/sections/CSectionManagement.vue.d.ts

@@ -5,7 +5,7 @@ import { CLIENT_TYPE } from '../../constants/cdp.const';
 import { GetCanvasesParams } from '../../types/canvases';
 import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest } from '../../../types/openapi';
 type __VLS_Props = {
-    storageKey?: string;
+    storageKey: string;
     myUserId?: CanvasRetrieve['created_by']['id'];
     updater: (params: PatchedCanvasUpdateRequest & {
         id: CanvasRetrieve['id'];
@@ -130,8 +130,6 @@ declare function __VLS_template(): {
             selectedRowsCount: ComputedRef<number>;
             pageRowsCount: ComputedRef<number>;
             isRowDisabled: (id: string | number) => boolean;
-            saveScrollPosition: () => void;
-            restoreScrollPosition: () => void;
         }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
             sortChanged: (s: SortingState) => any;
             pageChanged: (p: PaginationState) => any;
@@ -199,8 +197,6 @@ declare function __VLS_template(): {
             selectedRowsCount: ComputedRef<number>;
             pageRowsCount: ComputedRef<number>;
             isRowDisabled: (id: string | number) => boolean;
-            saveScrollPosition: () => void;
-            restoreScrollPosition: () => void;
         }, {}, {}, {}, {
             data: {
                 [x: string]: any;
@@ -335,8 +331,6 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
         sortChanged: (s: SortingState) => any;
         pageChanged: (p: PaginationState) => any;
@@ -404,8 +398,6 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, {
         data: {
             [x: string]: any;

package/lib/components/themes/CThemeManagement.vue.d.ts

@@ -95,8 +95,6 @@ declare function __VLS_template(): {
             selectedRowsCount: ComputedRef<number>;
             pageRowsCount: ComputedRef<number>;
             isRowDisabled: (id: string | number) => boolean;
-            saveScrollPosition: () => void;
-            restoreScrollPosition: () => void;
         }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
             sortChanged: (s: SortingState) => any;
             pageChanged: (p: PaginationState) => any;
@@ -164,8 +162,6 @@ declare function __VLS_template(): {
             selectedRowsCount: ComputedRef<number>;
             pageRowsCount: ComputedRef<number>;
             isRowDisabled: (id: string | number) => boolean;
-            saveScrollPosition: () => void;
-            restoreScrollPosition: () => void;
         }, {}, {}, {}, {
             data: {
                 [x: string]: any;
@@ -267,8 +263,6 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
         sortChanged: (s: SortingState) => any;
         pageChanged: (p: PaginationState) => any;
@@ -336,8 +330,6 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         selectedRowsCount: ComputedRef<number>;
         pageRowsCount: ComputedRef<number>;
         isRowDisabled: (id: string | number) => boolean;
-        saveScrollPosition: () => void;
-        restoreScrollPosition: () => void;
     }, {}, {}, {}, {
         data: {
             [x: string]: any;

package/lib/composables/useBindValidation.d.ts

@@ -1,6 +1,6 @@
 import { Validation } from '@vuelidate/core';
-import { FormValidationStatus } from 'naive-ui/es/form/src/interface';
 import { Ref } from 'vue';
+type FormValidationStatus = 'error' | 'warning' | 'success';
 /**
  * Options for validators.
  */

package/lib/composables/useElementSizeAfterDom.d.ts

@@ -0,0 +1,5 @@
+import { Ref } from 'vue';
+export default function useElementSizeAfterDom(targetRef: Ref<HTMLElement | null>): {
+    clientWidth: Ref<number, number>;
+    clientHeight: Ref<number, number>;
+};

package/lib/composables/useFilterSuggestions.d.ts

@@ -0,0 +1,56 @@
+import { ComputedRef, Ref } from 'vue';
+import { MetadataFilterRequest } from '../types/core/MetadataFilter';
+interface FilterSuggestion {
+    name: string;
+    displayName: string;
+    usageCount?: number;
+}
+interface FilterSuggestionsData {
+    popular: FilterSuggestion[];
+    all: FilterSuggestion[];
+}
+interface FilterConstraint {
+    key: string;
+    value: string;
+}
+interface UseFilterSuggestionsOptions {
+    entity?: MetadataFilterRequest['entity'];
+    filterKey?: string;
+    includeDraftValues?: boolean;
+    isSection?: boolean;
+    isTemplate?: boolean;
+    ownerId?: number | null;
+    limit?: number;
+}
+export default function useFilterSuggestions(options?: UseFilterSuggestionsOptions): {
+    suggestions: Ref<{
+        popular: {
+            name: string;
+            displayName: string;
+            usageCount?: number | undefined;
+        }[];
+        all: {
+            name: string;
+            displayName: string;
+            usageCount?: number | undefined;
+        }[];
+    }, FilterSuggestionsData | {
+        popular: {
+            name: string;
+            displayName: string;
+            usageCount?: number | undefined;
+        }[];
+        all: {
+            name: string;
+            displayName: string;
+            usageCount?: number | undefined;
+        }[];
+    }>;
+    isLoading: Ref<boolean, boolean>;
+    isEnabled: ComputedRef<boolean | undefined>;
+    fetchSuggestions: (currentFilters?: Record<string, any>) => Promise<FilterSuggestionsData>;
+    debouncedFetch: (currentFilters?: Record<string, any>, delay?: number) => Promise<FilterSuggestionsData>;
+    buildConstraints: (currentFilters: Record<string, any>, excludeCurrentField?: boolean) => FilterConstraint[];
+    cleanup: () => void;
+};
+export {};

package/lib/composables/useImageAccessibility.d.ts

@@ -0,0 +1,13 @@
+import { ComputedRef } from 'vue';
+interface UseImageAccessibilityOptions {
+    thumbnailUrl: ComputedRef<string | null>;
+    hasAIEnabled: ComputedRef<boolean>;
+    hasFile: ComputedRef<boolean>;
+}
+export default function useImageAccessibility({ thumbnailUrl, hasAIEnabled, hasFile }: UseImageAccessibilityOptions): {
+    imageAccessible: import('vue').Ref<boolean | null, boolean | null>;
+    hasValidThumbnail: ComputedRef<boolean>;
+    handleImageError: () => void;
+    checkImageAccessibility: () => Promise<void>;
+};
+export {};

package/lib/composables/useMetadataSearch.d.ts

@@ -1,10 +1,16 @@
 import { MetadataFilterRequest, MetadataSearchParams } from '../types/core/MetadataFilter';
 import { StyledAutoCompleteOption } from '../types/search';
+interface MetadataUniqueValuesResponse {
+    popular: Array<StyledAutoCompleteOption & {
+        usage_count: number;
+    }>;
+    all: StyledAutoCompleteOption[];
+}
 interface UseMetadataSearchOptions {
     includeSearchTermAsOption?: boolean;
 }
 export default function useMetadataSearch(options?: UseMetadataSearchOptions): {
-    handleFetch: (searchTerm: string, entity: MetadataFilterRequest["entity"], { includeNameSearch, includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, searchMode, threshold, fetchAllUnique, }?: {
+    handleFetch: (searchTerm: string, entity: MetadataFilterRequest["entity"], { includeNameSearch, includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, searchMode, threshold, fetchAllUnique, contentType, }?: {
         includeNameSearch?: boolean;
         includeDraftValues?: boolean;
         isSection?: boolean;
@@ -15,6 +21,20 @@ export default function useMetadataSearch(options?: UseMetadataSearchOptions): {
         searchMode?: MetadataSearchParams["searchMode"];
         threshold?: number;
         fetchAllUnique?: boolean;
+        contentType?: string[];
     }) => Promise<StyledAutoCompleteOption[]>;
+    fetchUniqueValues: (entity: MetadataFilterRequest["entity"], { includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, limit, and, }?: {
+        includeDraftValues?: boolean;
+        isSection?: boolean;
+        isTemplate?: boolean;
+        isBlock?: boolean;
+        key?: MetadataSearchParams["key"];
+        ownerId?: number | null;
+        limit?: number;
+        and?: Array<{
+            key: string;
+            value: string;
+        }>;
+    }) => Promise<MetadataUniqueValuesResponse>;
 };
 export {};

package/lib/directives/element-mounted.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    mounted(el: HTMLElement, binding: any): void;
+};
+export default _default;

package/lib/main.lib.d.ts

@@ -90,6 +90,7 @@ export { default as CGlobalLoader } from './components/CGlobalLoader/CGlobalLoad
 export { default as CFilesFolderDeleteDialogContent } from './components/CFilesFolderDeleteDialogContent/CFilesFolderDeleteDialogContent.vue';
 export { default as CCatalogIqSwitcher } from './components/CCatalogIqSwitcher/CCatalogIqSwitcher.vue';
 export { default as CCarousel } from './components/CCarousel/CCarousel.vue';
+export { default as CSlideViewer } from './components/CSlideViewer/CSlideViewer.vue';
 export { default as CTags } from './components/CTags/CTags.vue';
 export { default as CMovableWidget } from './components/CMovableWidget/CMovableWidget.vue';
 export { default as CUserMenu } from './components/CUserMenu/CUserMenu.vue';
@@ -236,5 +237,6 @@ export { default as clickOutsideDirective } from './directives/clickOutside';
 export { default as autofocusDirective } from './directives/autofocus';
 export { default as tooltipDirective } from './directives/tooltip';
 export { default as usageTrackDirective } from './directives/usage-track.directive';
+export { default as elementMountedDirective } from './directives/element-mounted';
 export * from './constants/i18n.const';
 export * from './types/i18n.types';

package/lib/sdk/api/HighLevelApi.d.ts

@@ -111,6 +111,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../../main.lib').LanguageEnum | undefined;
     }): Promise<import('../../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<modules.Language[]>;
     getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;
     createEvent(payload: import('../../main.lib').EventRequest): Promise<import('../../main.lib').Event>;
@@ -251,6 +252,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('../payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     share(payload: import('../payload.types').SharePayload): Promise<import('../payload.types').ShareResponse>;
+    showPeerSession(payload: import('../payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../../main.lib').CanvasThemeRetrieve>): Promise<import('../../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../../main.lib').CanvasRetrieve["id"];

package/lib/sdk/api/modules/admin/types.admin.d.ts

@@ -148,6 +148,14 @@ export type AdminSelectContentRequest = {
      * Disables files from selection which are not sharable (optional).
      */
     disable_no_sharable?: boolean;
+    /**
+     * Disables files from selection which do not have pptx_data in metadata object (optional).
+     */
+    disable_no_pptx_data?: boolean;
+    /**
+     * Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
+     */
+    only_allow_content_pdf_pages?: boolean;
 };
 /**
  * Represents a response to a content selection request.

package/lib/sdk/api/modules/env.d.ts

@@ -19,4 +19,5 @@ import { User } from '../../../../types/openapi';
 export declare function getEnv(): Promise<PitcherEnv>;
 type UpdateEnvParams = Pick<User, 'language'>;
 export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;
+export declare function isOffline(): Promise<boolean>;
 export {};

package/lib/sdk/api/modules/share.d.ts

@@ -1,4 +1,4 @@
-import { SharePayload, ShareResponse } from '../../payload.types';
+import { SharePayload, ShareResponse, ShowPeerSessionRequestPayload } from '../../payload.types';
 /**
  * Dispatch iOS sharing dialog.
  *
@@ -6,3 +6,10 @@ import { SharePayload, ShareResponse } from '../../payload.types';
  * api.share({text: "example text", subject: "example subject"})
  */
 export declare function share(payload: SharePayload): Promise<ShareResponse>;
+/**
+ * Show peer session dialog with button coordinates, for local peer sharing feature.
+ *
+ * @example
+ * api.showPeerSession({x: 100, y: 200})
+ */
+export declare function showPeerSession(payload: ShowPeerSessionRequestPayload): Promise<void>;

package/lib/sdk/api/modules/ui/canvas.ui.d.ts

@@ -1,5 +1,5 @@
 import { CanvasRetrieve } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
+import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
 /**
  * Modify the currently loaded canvas. On the web it sends
  * an [update_canvas](https://pitcher.readme.io/reference/update_canvas) request to the server.
@@ -7,6 +7,20 @@ import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest,
  * @param payload parts of the canvas object to update with fields to return
  */
 export declare function updateCanvas(payload: UiUpdateCanvasRequest): Promise<CanvasRetrieve>;
+/**
+ * Trigger async print/download of a canvas with optional notification URL.
+ * Calls the downloader-test endpoint to convert the canvas to PDF.
+ *
+ * @param payload Canvas ID and optional notify URL for async notifications
+ * @returns Promise with job ID and success status
+ *
+ * @example
+ * useUi().printCanvas({
+ *   id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *   notify_url: 'https://my-webhook.example.com/canvas-ready'
+ * })
+ */
+export declare function printCanvas(payload: UiPrintCanvasRequest): Promise<UiPrintCanvasResponse>;
 /**
  * Notify the CatalogIQ instance that the app is loaded and ready to get the data. Triggering this method will trigger
  * the `on_app_set_data` event.
@@ -35,6 +49,16 @@ export declare function appResize(payload: UiAppResizeRequest): Promise<void>;
  * useUi().closeCanvasSectionExecution()
  */
 export declare function closeCanvasSectionExecution(): Promise<void>;
+/**
+ * Close the Canvas Drawer modal. Only takes effect for apps running in `canvas_drawer` embed location
+ *
+ * Note that this method simply closes the drawer and will result in the app calling it being unmounted from the DOM and
+ * destroyed. Make sure your app has finished updating data before you call this method.
+ *
+ * @example
+ * useUi().closeCanvasDrawer()
+ */
+export declare function closeCanvasDrawer(): Promise<void>;
 /**
  * Navigate to the next page in the current canvas. Noop if the current page is the last one.
  *

package/lib/sdk/api/modules/ui/index.d.ts

@@ -122,9 +122,11 @@ declare const _default: {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./types.ui').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./types.ui').UiPrintCanvasRequest): Promise<import('./types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./types.ui').UiCanvasNavigatePageRequest): Promise<void>;

package/lib/sdk/api/modules/ui/types.ui.d.ts

@@ -21,6 +21,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_TOAST: "ui_toast";
     readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error";
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
+    readonly UI_PRINT_CANVAS: "ui_print_canvas";
     readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
     readonly UI_SELECT_COLLECTION_PLAYER_CONTENT: "ui_select_collection_player_content";
     readonly UI_SELECT_AGENDA_CONTENT: "ui_select_agenda_content";
@@ -40,6 +41,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_APP_LOADED: "ui_app_loaded";
     readonly UI_APP_RESIZE: "ui_app_resize";
     readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution";
+    readonly UI_CLOSE_CANVAS_DRAWER: "ui_close_canvas_drawer";
 };
 export declare const UI_MESSAGE_TYPES: {
     readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
@@ -70,6 +72,14 @@ export type UiSelectContentRequest = {
      * Disables files from selection which are not sharable (optional).
      */
     disable_no_sharable?: boolean;
+    /**
+     * Disables files from selection which do not have pptx_data in metadata object (optional).
+     */
+    disable_no_pptx_data?: boolean;
+    /**
+     * Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
+     */
+    only_allow_content_pdf_pages?: boolean;
 };
 export type UiSelectContentResponse = {
     /** User action result */
@@ -136,6 +146,18 @@ export type UiUpdateCanvasRequest = Mutable<CanvasRetrieve> & {
     /** Comma-separated list of field keys to return from the server */
     fields?: string;
 };
+export type UiPrintCanvasRequest = {
+    /** Canvas ID to print */
+    id: CanvasRetrieve['id'];
+    /** Optional HTTPS URL for async download notifications */
+    notify_url?: string;
+};
+export type UiPrintCanvasResponse = {
+    /** Job ID for tracking the async download */
+    job_id?: string;
+    /** Indicates if the request was successful */
+    success: boolean;
+};
 export type UiOpenRequest = OpenRequestPayload & {
     /** Name of the app to open */
     app_name?: string;

package/lib/sdk/interfaces.d.ts

@@ -126,13 +126,21 @@ export declare enum PitcherEventName {
     EXITED_FULLSCREEN = "exited_fullscreen",
     SUBMIT_POSTCALL_CLICKED = "submit_postcall_clicked",
     ANALYTICS_CAPTURED = "analytics_captured",
-    OPEN_FOLDER_REQUESTED = "open_folder_requested"
+    OPEN_FOLDER_REQUESTED = "open_folder_requested",
+    CANVAS_PAGE_NEXT_REQUESTED = "canvas_page_next_requested",
+    CANVAS_PAGE_PREVIOUS_REQUESTED = "canvas_page_previous_requested",
+    CANVAS_OPEN_REQUESTED = "canvas_open_requested",
+    CANVAS_CLOSE_REQUESTED = "canvas_close_requested"
 }
 export declare enum PitcherBroadcastedEventName {
     UI_SHOW_MODAL = "ui:show-modal",
     UI_HIDE_MODAL = "ui:hide-modal",
     FAVORITES_CHANGED = "favorites:changed",
-    FILE_DOWNLOAD = "file:download"
+    FILE_DOWNLOAD = "file:download",
+    CANVAS_NEXT_BUTTON_CLICKED = "canvas_next_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_NEXT_REQUESTED`
+    CANVAS_PREVIOUS_BUTTON_CLICKED = "canvas_previous_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_PREVIOUS_REQUESTED`
+    CANVAS_OPENED = "canvas_opened",
+    CANVAS_CLOSED = "canvas_closed"
 }
 export declare enum PitcherExternalEventName {
     CREATE_AND_OPEN_CANVAS = "create_and_open_canvas",
@@ -371,6 +379,20 @@ export interface PitcherEventMap {
         view_id?: string;
     };
     [PitcherEventName.SUBMIT_POSTCALL_CLICKED]: void;
+    [PitcherEventName.CANVAS_PAGE_NEXT_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_PAGE_PREVIOUS_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_OPEN_REQUESTED]: {
+        canvas_id?: string;
+    };
+    [PitcherEventName.CANVAS_CLOSE_REQUESTED]: {
+        canvas_id?: string;
+    };
     [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
     [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
     [PitcherBroadcastedEventName.FAVORITES_CHANGED]: {
@@ -379,6 +401,28 @@ export interface PitcherEventMap {
     [PitcherBroadcastedEventName.FILE_DOWNLOAD]: {
         body: File['id'];
     };
+    [PitcherBroadcastedEventName.CANVAS_NEXT_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_PREVIOUS_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_OPENED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_CLOSED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
     [PitcherExternalEventName.OPEN_CANVAS]: OpenCanvasPitcherEvent;
     [PitcherExternalEventName.START_CALL]: StartCallPitcherEvent;
     [PitcherExternalEventName.CREATE_AND_OPEN_CANVAS]: CreateAndOpenCanvasEvent;

package/lib/sdk/main.d.ts

@@ -33,9 +33,11 @@ export declare function useUi(): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -189,6 +191,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
     createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -329,6 +332,7 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -406,9 +410,11 @@ export declare function useApi(options?: ApiOptions): {
         disablePostcallSubmit(): Promise<void>;
         setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
         updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+        printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
         appLoaded(): Promise<void>;
         appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
         closeCanvasSectionExecution(): Promise<void>;
+        closeCanvasDrawer(): Promise<void>;
         canvasNavigateNextPage(): Promise<void>;
         canvasNavigatePreviousPage(): Promise<void>;
         canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -462,6 +468,7 @@ export declare function useApi(options?: ApiOptions): {
         updateMyUser(payload: {
             language?: import('../main.lib').LanguageEnum | undefined;
         }): Promise<import('../main.lib').User>;
+        isOffline(): Promise<boolean>;
         getLanguages(): Promise<import('./api/modules').Language[]>;
         getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
         createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -602,6 +609,7 @@ export declare function useApi(options?: ApiOptions): {
         close(): Promise<any>;
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
         share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+        showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
         getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
         assignCanvasTheme(payload: {
             canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -621,9 +629,11 @@ export declare function useApi(options?: ApiOptions): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -673,6 +683,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
     createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -804,6 +815,7 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];

package/lib/sdk/payload.types.d.ts

@@ -248,6 +248,19 @@ export type ShareResponse = {
      */
     activity_type?: string;
 };
+/**
+ * Payload for showing peer session dialog.
+ */
+export interface ShowPeerSessionRequestPayload {
+    /**
+     * The x-coordinate of the button that triggered the action.
+     */
+    x: number;
+    /**
+     * The y-coordinate of the button that triggered the action.
+     */
+    y: number;
+}
 export type FolderListRequest = {
     search?: string;
     ordering?: string;