@pitcher/js-api 1.22.0-alpha.6 → 1.22.0-beta.1

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

@@ -1,6 +1,54 @@
-import { ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
+import { AdminToastRequest, ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
 
-export declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
-export * from './env.admin';
-export * from './canvas.admin';
-export * from './metadataTemplates.admin';
+/**
+ * Subscribe to a given event type by its key.
+ *
+ * @param type The event type/key to subscribe to.
+ * @param handler The handler function to call when the event is emitted.
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+/**
+ * Show a toast message to the user. Compatible with the UI API version of this method.
+ *
+ * @example
+ * useAdmin().toast({ type: 'info', message: 'Hello, world!' })
+ */
+declare function toast(payload: AdminToastRequest): Promise<void>;
+declare const _default: {
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        id: import('../../../../main.lib').File["id"];
+    }): Promise<import('../../../../main.lib').File>;
+    getFiles(payload: Record<string, any>): Promise<import('../../../../main.lib').PaginatedFileList>;
+    selectContent(payload: import('./types.admin').AdminSelectContentRequest): Promise<import('./types.admin').AdminSelectContentResponse>;
+    getInstanceMetadataTemplates(payload?: import('../../../payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../../../../main.lib').PaginatedMetadataTemplateList>;
+    createCanvas(payload: import('../../../../main.lib').CanvasCreateRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    getCanvases(payload: import('../../../../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any>;
+        fields?: string;
+    }): Promise<import('../../../../main.lib').PaginatedData<import('../../../../main.lib').CanvasRetrieve>>;
+    getCanvas(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        fields?: string;
+    }): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    updateCanvas(payload: import('../../../../main.lib').PatchedCanvasUpdateRequest & {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        instance_id?: import('../../../../main.lib').Instance["id"];
+        fields?: string;
+    }): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    selectCanvases(payload?: import('./types.admin').AdminSelectCanvasesRequest): Promise<import('./types.admin').AdminSelectCanvasesResponse>;
+    getEnv(): Promise<import('./types.admin').AdminEnv>;
+    on: typeof on;
+    toast: typeof toast;
+};
+export default _default;

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

@@ -4,8 +4,7 @@ import { GetInstanceMetadataTemplatesPayload } from '../../../payload.types';
 /**
  * Fetches a list of metadata templates to use in your app. Instance is auto-injected by admin app if in instance scope.
  *
- * ```
+ * @example
  * adminApi.getInstanceMetadataTemplates()
- * ```
  **/
 export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;

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

@@ -1,4 +1,7 @@
 import { PitcherEnv } from '../../../interfaces';
+import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { Canvas } from '../../../../../types/openapi';
+import { CanvasSelection } from '@canvas-selector/appTypes';
 
 export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
 export declare const ADMIN_MESSAGE_TYPES: {
@@ -10,37 +13,162 @@ export declare const ADMIN_API_TYPES: {
 };
 export declare const ADMIN_API_METHOD_TYPES: {
     readonly CREATE_CANVAS: "admin_create_canvas";
-    readonly GET_ENV: "admin_get_env";
+    readonly GET_APP_CONFIG: "admin_get_app_config";
     readonly GET_CANVAS: "admin_get_canvas";
     readonly GET_CANVASES: "admin_get_canvases";
-    readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
+    readonly GET_ENV: "admin_get_env";
+    readonly GET_FILE: "admin_get_file";
+    readonly GET_FILES: "admin_get_files";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
-    readonly GET_APP_CONFIG: "admin_get_app_config";
+    readonly TOAST: "admin_toast";
+    readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly SELECT_CONTENT: "admin_select_content";
+    readonly SELECT_CANVASES: "admin_select_canvases";
 };
 export type AdminMessagePayloads = {
     [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;
 };
+/**
+ * Represents an admin request with a specific payload.
+ * @template Payload - The type of the payload data.
+ */
 export type AdminRequest<Payload = any> = {
+    /**
+     * Unique identifier for the request.
+     */
     id: string;
+    /**
+     * Type of the admin API request.
+     */
     type: (typeof ADMIN_API_TYPES)['ADMIN_REQUEST'];
+    /**
+     * Body of the request containing the method type and payload data.
+     */
     body: {
+        /**
+         * Type of the admin API method.
+         */
         type: (typeof ADMIN_API_METHOD_TYPES)[keyof typeof ADMIN_API_METHOD_TYPES];
+        /**
+         * Payload data for the request.
+         */
         data: Payload;
     };
 };
+/**
+ * Represents a request to show a toast notification.
+ */
+export interface AdminToastRequest {
+    /**
+     * Type of the toast notification.
+     */
+    type: 'info' | 'error' | 'warning' | 'success' | 'loading';
+    /**
+     * Message to be displayed in the toast.
+     */
+    message: string;
+    /**
+     * Duration for which the toast should be displayed (optional).
+     */
+    duration?: number;
+    /**
+     * Indicates if the toast can be closed manually (optional).
+     */
+    closable?: boolean;
+    /**
+     * Indicates if the toast should remain visible when hovered over (optional).
+     */
+    keepAliveOnHover?: boolean;
+    /**
+     * Indicates if an icon should be shown in the toast (optional).
+     */
+    showIcon?: boolean;
+}
+/**
+ * Represents a request to select content.
+ */
+export type AdminSelectContentRequest = {
+    /**
+     * List of selections to be made (optional).
+     */
+    selections?: Selection[];
+};
+/**
+ * Represents a response to a content selection request.
+ */
+export type AdminSelectContentResponse = {
+    /**
+     * Action taken by the user.
+     */
+    user_action: 'cancelled' | 'selected';
+    /**
+     * Selected content, if any.
+     */
+    content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
+};
+export type AdminSelectCanvasesRequest = {
+    /** Array of selections */
+    selections?: CanvasSelection[];
+    allowed_types?: ('canvas' | 'canvas-template' | 'section' | 'section-template')[];
+};
+export type AdminSelectCanvasesResponse = {
+    /** User action result */
+    user_action: 'cancelled' | 'selected';
+    /** Selected canvases */
+    canvases?: Canvas[];
+};
+/**
+ * Represents an admin response with a specific payload.
+ * @template Response - The type of the response data.
+ */
 export type AdminResponse<Response = any> = {
+    /**
+     * Unique identifier for the response.
+     */
     id: string;
+    /**
+     * Type of the admin API response.
+     */
     type: (typeof ADMIN_API_TYPES)['ADMIN_RESPONSE'];
+    /**
+     * Body of the response containing the response data.
+     */
     body: Response;
 };
+/**
+ * Represents an admin message with a specific payload.
+ * @template Payload - The type of the message data.
+ */
 export type AdminMessage<Payload = any> = {
+    /**
+     * Unique identifier for the message.
+     */
     id: string;
+    /**
+     * Type of the admin message.
+     */
     type: typeof ADMIN_MESSAGE;
+    /**
+     * Body of the message containing the message type and payload data.
+     */
     body: {
+        /**
+         * Type of the admin message.
+         */
         type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES];
+        /**
+         * Payload data for the message.
+         */
         data: Payload;
     };
 };
+/**
+ * Represents the admin environment.
+ */
 export type AdminEnv = {
+    /**
+     * Pitcher environment settings.
+     */
     pitcher: PitcherEnv['pitcher'];
 };

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

@@ -1,11 +1,11 @@
-import { Canvas, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
+import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
 import { GetCanvasesParams } from '../../../types/canvases';
 import { PaginatedData } from '../../../types/paginatedData';
 
 /**
  * Fetches a list of canvases to use in your app.
  *
- * ```
+ * @example
  * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
  * api.getCanvases({
  *   search: 'my search query',
@@ -16,20 +16,19 @@ import { PaginatedData } from '../../../types/paginatedData';
  *   },
  *  fields: 'id,name,metadata',
  * })
- * ```
  */
 export declare function getCanvases(payload: GetCanvasesParams & {
     filters?: Record<string, any>;
     fields?: string;
-}): Promise<PaginatedData<Canvas>>;
-export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<Canvas>;
+}): Promise<PaginatedData<CanvasRetrieve>>;
+export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<CanvasRetrieve>;
 export declare function deleteCanvas(payload: {
-    id: Canvas['id'];
-}): Promise<Canvas>;
+    id: CanvasRetrieve['id'];
+}): Promise<CanvasRetrieve>;
 /**
  * Updates a canvas by ID
  *
- * ```
+ * @example
  * // The fields param is appended to the URL as a query param.
  * onMounted(() => {
  *   PitcherAPI.updateCanvas({
@@ -40,17 +39,16 @@ export declare function deleteCanvas(payload: {
  *     console.log(res)  // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' }
  *   })
  * })
- * ```
  */
 export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
     instance_id?: Instance['id'];
     fields?: string;
-}): Promise<Canvas>;
+}): Promise<CanvasRetrieve>;
 export declare function getCanvas(payload: {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
     fields?: string;
-}): Promise<Canvas>;
+}): Promise<CanvasRetrieve>;
 export declare function shareCanvas(payload: {
-    id: Canvas['id'];
+    id: CanvasRetrieve['id'];
 }): Promise<SharedLink>;

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

@@ -1,10 +1,11 @@
 import { DsrEnv } from './types.dsr';
 
 /**
- * Fetches the necessary info for the app to know where it is embedded. LaunchDarkly flags are omitted for now as they are not yet used.
+ * Fetches the necessary info for the app to know where it is embedded.
  *
- * ```
+ * Check out [usePitcherApi().getEnv()](../internal/functions/createHighLevelApi.md#getenv) for more information.
+ *
+ * @example
  * useDsr().getEnv()
- * ```
  */
 export declare function getEnv(): Promise<DsrEnv>;

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

@@ -1,5 +1,16 @@
 import { DSR_MESSAGE_TYPES, DsrMessagePayloads } from './types.dsr';
 
-export declare function on(type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES], handler: (data: DsrMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
-export * from './env.dsr';
-export * from './loading.dsr';
+/**
+ * Subscribe to a given event type by its key.
+ *
+ * @param type The event type/key to subscribe to.
+ * @param handler The handler function to call when the event is emitted.
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on(type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES], handler: (data: DsrMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+declare const _default: {
+    embeddableReady(): Promise<void>;
+    getEnv(): Promise<import('./types.dsr').DsrEnv>;
+    on: typeof on;
+};
+export default _default;

package/lib/sdk/api/modules/dsr/loading.dsr.d.ts

@@ -1 +1,7 @@
-export declare function embeddable_ready(): Promise<void>;
+/**
+ * Signal to DSR that the app is ready to be shown.
+ *
+ * @example
+ * useDsr().embeddableReady()
+ */
+export declare function embeddableReady(): Promise<void>;

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

@@ -1,6 +1,22 @@
 import { PitcherEnv } from '../../interfaces';
 import { User } from '../../../../types/openapi';
 
+/**
+ * Fetches the necessary info for the app to know where it is embedded.
+ *
+ * It contains information about:
+ * - user
+ * - instance
+ * - organization
+ * - security token to query Pitcher REST API
+ * - Salesforce connection information (if connected) including security token to query Salesforce REST API
+ * - Auth0 token information
+ *
+ * @example
+ * const env = usePitcherApi().getEnv().then((env) => {
+ *   console.log(env.pitcher.user.name)
+ * })
+ */
 export declare function getEnv(): Promise<PitcherEnv>;
 type UpdateEnvParams = Pick<User, 'language' | 'dark_mode'>;
 export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;

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

@@ -1,8 +1,17 @@
 import { Favorite, FavoriteCreateRequest, PaginatedFavoriteList } from '../../../../types/openapi';
 import { GetFavoritesParams } from '../../../types/favorites';
 
+/**
+ * Get a list of favorites
+ */
 export declare function getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>;
+/**
+ * Create a favorite
+ */
 export declare function createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>;
+/**
+ * Delete a favorite
+ */
 export declare function deleteFavorite(payload: {
     favorite_id: Favorite['id'];
 }): Promise<void>;

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

@@ -1,3 +1,6 @@
 import { SubmitUserFeedbackPayload } from '../../payload.types';
 
+/**
+ * Submit user feedback
+ */
 export declare function submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>;

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

@@ -2,7 +2,10 @@ import { File, FileRetrieve, PaginatedFileList, FileUpdateRequest } from '../../
 import { GetRecentFilesPayload, ListFilesPayload } from '../../payload.types';
 import { AllFileCreateRequest, DeviceFile } from '../../../types/files';
 
-export declare function getFiles(payload: ListFilesPayload): Promise<PaginatedFileList>;
+export declare function getFiles(payload: ListFilesPayload & {
+    filters?: Record<string, any>;
+    fields?: string;
+}): Promise<PaginatedFileList>;
 export declare function getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>;
 export declare function downloadFile(payload: {
     file_id: File['id'];
@@ -11,7 +14,8 @@ export declare function getAppConfig(payload: {
     app_name: string;
 }): Promise<Record<string, any>>;
 export declare function getFile(payload: {
-    file_id: FileRetrieve['id'];
+    id?: FileRetrieve['id'];
+    file_id?: FileRetrieve['id'];
 }): Promise<FileRetrieve>;
 export declare function updateFile(payload: FileUpdateRequest & {
     id: File['id'];
@@ -23,9 +27,8 @@ export declare function createFile(payload: Omit<AllFileCreateRequest, 'instance
 /**
  * Dispatches iOS native file selector and returns the selected file.
  *
- * ```
+ * @example
  * // iOS only method to select a file from the device.
  * api.selectDeviceFile()
- * ```
  */
 export declare function selectDeviceFile(): Promise<DeviceFile>;

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

@@ -1,16 +1,45 @@
 import { File, Folder, FolderRetrieve, FolderCreateRequest, FolderUpdateRequest } from '../../../../types/openapi';
 
+/**
+ * Retrieves a folder by its ID.
+ * @param payload - An object containing the folder ID.
+ * @param payload.id - The ID of the folder to retrieve. Defaults to 'root'.
+ * @returns A promise that resolves to the retrieved folder.
+ */
 export declare function getFolder(payload?: {
     id: FolderRetrieve['id'];
 }): Promise<FolderRetrieve>;
+/**
+ * Creates a new folder.
+ * @param payload - The folder creation request payload, excluding the instance_id.
+ * @returns A promise that resolves to the created folder.
+ */
 export declare function createFolder(payload: Omit<FolderCreateRequest, 'instance_id'>): Promise<FolderRetrieve>;
 type UpdateFolderPayload = FolderUpdateRequest & {
     id: Folder['id'];
 };
+/**
+ * Updates an existing folder.
+ * @param payload - The folder update payload, including the folder ID and update data.
+ * @returns A promise that resolves to the updated folder.
+ */
 export declare function updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>;
+/**
+ * Deletes a folder.
+ * @param payload - An object containing the ID of the folder to delete.
+ * @param payload.folder_id - The ID of the folder to delete.
+ * @returns A promise that resolves when the folder is deleted.
+ */
 export declare function deleteFolder(payload: {
     folder_id: FolderRetrieve['id'];
 }): Promise<void>;
+/**
+ * Moves items (files or folders) to a target folder.
+ * @param payload - The payload containing the target folder ID and items to move.
+ * @param payload.target_folder_id - The ID of the target folder.
+ * @param payload.items - An array of items to move, each with an ID and type.
+ * @returns A promise that resolves to the updated target folder.
+ */
 export declare function moveFolderItems(payload: {
     target_folder_id: Folder['id'];
     items: {

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

@@ -1,4 +1,10 @@
 import { OpenExternalUrlRequestPayload, OpenRequestPayload } from '../../payload.types';
 
+/**
+ * Open a file in the CatalogIQ instance.
+ */
 export declare function open(payload?: OpenRequestPayload): Promise<string>;
+/**
+ * Open external URL in a new tab. Works on both web and mobile.
+ */
 export declare function openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>;

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

@@ -1,9 +1,8 @@
 /**
  * Dispatches iOS only sync method for non-files.
  *
- * ```
+ * @example
  * // iOS only method to sync non-files from the server.
  * api.triggerNonFilesSync()
- * ```
  */
 export declare function triggerNonFilesSync(): Promise<void>;

package/lib/sdk/api/modules/ui/app-errors.ui.d.ts

@@ -1,3 +1,15 @@
 import { UiCaptureAppErrorRequest } from './types.ui';
 
-export declare function capture_app_error(payload: UiCaptureAppErrorRequest): Promise<void>;
+/**
+ * Send an app error to Pitcher sentry instance.
+ *
+ * @example
+ * try {
+ *   throw new Error('This is an error')
+ * } catch (error) {
+ *   useUi().captureAppError(error)
+ * }
+ *
+ * @param payload error object to send to Pitcher sentry instance
+ */
+export declare function captureAppError(payload: UiCaptureAppErrorRequest): Promise<void>;

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

@@ -1,9 +1,103 @@
-import { Canvas } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageReuqest, UiUpdateCanvasRequest } from './types.ui';
+import { CanvasRetrieve } from '../../../../../types/openapi';
+import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
 
-export declare function update_canvas(payload: UiUpdateCanvasRequest): Promise<Canvas>;
-export declare function app_loaded(): Promise<void>;
-export declare function app_resize(payload: UiAppResizeRequest): Promise<void>;
-export declare function canvas_navigate_next_page(): Promise<void>;
-export declare function canvas_navigate_previous_page(): Promise<void>;
-export declare function canvas_navigate_page(payload: UiCanvasNavigatePageReuqest): Promise<void>;
+/**
+ * Modify the currently loaded canvas. On the web it sends
+ * an [update_canvas](https://pitcher.readme.io/reference/update_canvas) request to the server.
+ *
+ * @param payload parts of the canvas object to update with fields to return
+ */
+export declare function updateCanvas(payload: UiUpdateCanvasRequest): Promise<CanvasRetrieve>;
+/**
+ * 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.
+ *
+ * @example
+ * @example
+ * useUi().appLoaded()
+ */
+export declare function appLoaded(): Promise<void>;
+/**
+ * Resize the app iframe to a given height.
+ *
+ * Note that initial iframe height comes from the `app.json` manifest file. It can also be adjusted by the user when adding
+ * app component to the canvas. In case when the app must be temporarily resized to show larger ui elements it can read the
+ * user-set height from the [on_app_set_data](#on-app-set-data) event.
+ * @param payload object containing requested height of the iframe as the number of pixels
+ */
+export declare function appResize(payload: UiAppResizeRequest): Promise<void>;
+/**
+ * Navigate to the next page in the current canvas. Noop if the current page is the last one.
+ *
+ * @example
+ * useUi().canvasNavigateNextPage()
+ */
+export declare function canvasNavigateNextPage(): Promise<void>;
+/**
+ * Navigate to the previous page in the current canvas. Noop if the current page is the first one.
+ *
+ * @example
+ * useUi().canvasNavigatePreviousPage()
+ */
+export declare function canvasNavigatePreviousPage(): Promise<void>;
+/**
+ * Navigate to a specific canvas place in the current canvas. Despite the event and parameter name, it takes the component
+ * id that we want to put in view.
+ *
+ * @example
+ * const uiApi = useUi() // our useApi()
+ *
+ * let activeCanvas = null
+ * const unsubscribe = uiApi.on_app_set_data((data) => {
+ *   activeCanvas = data?.canvas
+ * })
+ *
+ * document.getElementById('my-button').addEventListener('click', () => {
+ *   const target = activeCanvas?.content?.data?.find((i: any) => i.data.app_name === 'my-target-app-id') || null
+ *   if (target) {
+ *     uiApi.canvasNavigatePage({ page: target.id })
+ *   }
+ * })
+ */
+export declare function canvasNavigatePage(payload: UiCanvasNavigatePageRequest): Promise<void>;
+/**
+ * Opens a modal to view a canvas by ID.
+ *
+ * ```
+ * onMounted(() => {
+ *   uiApi.openCanvasOverlay({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     edit_mode: false,
+ *     fullscreen: true,
+ *   })
+ * })
+ * ```
+ */
+export declare function openCanvasOverlay(payload: {
+    id: CanvasRetrieve['id'];
+    edit_mode?: boolean;
+    fullscreen?: boolean;
+    component_id?: string;
+    section_id?: string;
+}): Promise<void>;
+/**
+ * Allows the user to select (and preselect) canvases from the instance.
+ *
+ * This method allows you to prompt the user to select canvases from the CatalogIQ
+ * instance and use that canvas selection in your application.
+ *
+ * @example
+ * const api = useApi() // or useUi() if you know that you 're in UI context
+ * api
+ *   .selectCanvases({
+ *     allowed_types: ['canvas','canvas-template','section','section-template'] // default ['canvas']
+ *     selections: [
+ *       { id: "01HCZ623YYRFJQ0F7B69VWE510" },
+ *       { id: "02HCZ623YYRFJQ0F7B69VWE510" },
+ *     ], // default []
+ *   })
+ *
+ * @param payload optional payload to preselect specific canvases
+ * @returns Promise with the user action and selected canvases
+ */
+export declare function selectCanvases(payload?: UiSelectCanvasesRequest): Promise<UiSelectCanvasesResponse>;