@pitcher/js-api 1.21.0-beta.8 → 1.21.0

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

@@ -14,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'];
@@ -26,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';
 
+/**
+ * Send an app error to Pitcher sentry instance.
+ *
+ * @example
+ * try {
+ *   throw new Error('This is an error')
+ * } catch (error) {
+ *   useUi().capture_app_error(error)
+ * }
+ *
+ * @param payload error object to send to Pitcher sentry instance
+ */
 export declare function capture_app_error(payload: UiCaptureAppErrorRequest): Promise<void>;

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

@@ -1,9 +1,82 @@
-import { Canvas } from '../../../../../types/openapi';
+import { CanvasRetrieve } from '../../../../../types/openapi';
 import { UiAppResizeRequest, UiCanvasNavigatePageReuqest, UiUpdateCanvasRequest } from './types.ui';
 
-export declare function update_canvas(payload: UiUpdateCanvasRequest): Promise<Canvas>;
+/**
+ * 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 update_canvas(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().app_loaded()
+ */
 export declare function app_loaded(): 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 app_resize(payload: UiAppResizeRequest): Promise<void>;
+/**
+ * Navigate to the next page in the current canvas. Noop if the current page is the last one.
+ *
+ * @example
+ * useUi().canvas_navigate_next_page()
+ */
 export declare function canvas_navigate_next_page(): Promise<void>;
+/**
+ * Navigate to the previous page in the current canvas. Noop if the current page is the first one.
+ *
+ * @example
+ * useUi().canvas_navigate_previous_page()
+ */
 export declare function canvas_navigate_previous_page(): 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.canvas_navigate_page({ page: target.id })
+ *   }
+ * })
+ */
 export declare function canvas_navigate_page(payload: UiCanvasNavigatePageReuqest): 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>;

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

@@ -1,7 +1,57 @@
 import { UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToastRequest, UiPreselectSfdcMeetingIdRequest, UiPreselectSfdcMeetingIdResponse } from './types.ui';
 
+/**
+ * @hidden
+ * @deprecated
+ */
 export declare function ui_select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
+/**
+ * Allows the user to select (and preselect) content from the instance.
+ *
+ * Opens the content selector dialog to allow the user to select content and handle the outcome. This method allows you to
+ * prompt the user to select content from the CatalogIQ instance and use that content in your application.
+ *
+ * @example
+ * const api = useApi() // or useUi() if you know that you 're in UI context
+ * api
+ *   .select_content({
+ *     selections: [
+ *       { fileId: "01HCZ623YYRFJQ0F7B69VWE510", type: "file" },
+ *       {
+ *         fileId: "01HD3XGZ5FN90QJGK7CH8TBZDF",
+ *         type: "page",
+ *         pageIndex: 2,
+ *       },
+ *     ],
+ *   })
+ *
+ * @param payload optional payload to preselect speciffic content
+ * @returns Promise with the user action and selected content
+ */
 export declare function select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
+/**
+ * Open a file in the CatalogIQ instance.
+ */
 export declare function open(payload: UiOpenRequest): Promise<void>;
+/**
+ * Show a toast message to the user.
+ *
+ * @example
+ * useUi().toast({ type: 'info', message: 'Hello, world!' })
+ */
 export declare function toast(payload: UiToastRequest): Promise<void>;
+/**
+ * Preselect a meeting in the top meeting bar by Salesforce Meeting ID. From there, the user can easily start the meeting
+ * with a single click.
+ *
+ * @example
+ * const objectFetchedFromSalesforce = {
+ *   // fetch dynamiccaly from Salesforce or provide in another way
+ *   EventId: '00U1r00000D1J1zEAF',
+ * }
+ * ui.preselect_sfdc_meeting_id({ eventId: objectFetchedFromSalesforce.EventId }).then((response) => {
+ *   // e.g. display advanced meeting details inside your app
+ *   console.log(response.event)
+ * })
+ */
 export declare function preselect_sfdc_meeting_id(payload: UiPreselectSfdcMeetingIdRequest): Promise<UiPreselectSfdcMeetingIdResponse>;

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

@@ -1,15 +1,151 @@
 import { UiMeetingCanceledPayload, UiCanvasUpdatedPayload, UiSectionListUpdatedPayload, UiAppSetDataPayload, UiAppUpdateDataPayload, UiBroadcastRequest, UiMessagePayloads } from './types.ui';
 
-export declare function on<T extends keyof UiMessagePayloads>(type: T, handler: (data: UiMessagePayloads[T]) => Promise<void>): Promise<() => void>;
-export declare function on_meeting_canceled(handler: (data: UiMeetingCanceledPayload) => Promise<void>): Promise<() => void>;
-export declare function on_canvas_updated(handler: (data: UiCanvasUpdatedPayload) => Promise<void>): Promise<() => void>;
-export declare function on_section_list_updated(handler: (data: UiSectionListUpdatedPayload) => Promise<void>): Promise<() => void>;
-export declare function on_app_set_data(handler: (data: UiAppSetDataPayload) => Promise<void>): Promise<() => void>;
-export declare function on_app_update_data(handler: (data: UiAppUpdateDataPayload) => Promise<void>): Promise<() => void>;
-export declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
-export * from './content.ui';
-export * from './loading.ui';
-export * from './location.ui';
-export * from './app-errors.ui';
-export * from './canvas.ui';
-export * from './post-call.ui';
+/**
+ * Subscribe to a given event type by its key.
+ *
+ * @example
+ * const unsubscribeFromSectionListUpdate = useUi().on('ui_section_list_updated', (event: object) => {
+ *   // handle event
+ * })
+ *
+ * // later
+ * unsubscribeFromSectionListUpdate.then(unsubscribe => unsubscribe())
+ *
+ * @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<T extends keyof UiMessagePayloads>(type: T, handler: (data: UiMessagePayloads[T]) => Promise<void>): Promise<() => void>;
+/**
+ * Subscribe to the meeting canceled event.
+ *
+ * @example
+ * const unsubscribeFromMeetingCanceled = useUi().on_meeting_canceled((event: {
+ *   accountId?: string;
+ *   eventId?: string;
+ * }) => {
+ *   // handle event
+ * })
+ *
+ * // later
+ * unsubscribeFromMeetingCanceled.then(cancel => cancel())
+ *
+ * @param handler
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on_meeting_canceled(handler: (data: UiMeetingCanceledPayload) => Promise<void>): Promise<() => void>;
+/**
+ * Subscribe to the canvas updated event. It is triggered when the current canvas of the app is updated.
+ *
+ * @example
+ * const unsubscribePromise = useUi().on_canvas_updated((event: { canvas }) => {
+ *   // handle event
+ * })
+ *
+ * // later
+ * unsubscribePromise.then(unsubscribe => unsubscribe())
+ *
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on_canvas_updated(handler: (data: UiCanvasUpdatedPayload) => Promise<void>): Promise<() => void>;
+/**
+ * Subscribe to the section list updated event. It is triggered when the list of sections (products) in the current canvas
+ * is updated.
+ *
+ * @example
+ * const unsubscribePromise = useUi().on_section_list_updated((event: { canvas }) => {
+ *   // handle event
+ * })
+ *
+ * // later
+ * unsubscribePromise.then(unsubscribe => unsubscribe())
+ *
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on_section_list_updated(handler: (data: UiSectionListUpdatedPayload) => Promise<void>): Promise<() => void>;
+/**
+ * Subscribe to the app set data event. It is triggered when the app data is set. This event is triggered when the app is
+ * loaded and in certain other cases after loading.
+ *
+ * This is the main event for the canvas app to receive data from the CatalogIQ instance and know about its environment.
+ *
+ * @example
+ * let user = null
+ * let isEditMode = null
+ * let activeCanvas = null
+ * let isPrintMode = false
+ * const unsubscribePromise = useUi().on_app_set_data((data) => {
+ *   user = data?.user
+ *   isEditMode = data?.is_edit_mode
+ *   activeCanvas = data?.canvas
+ *   isPrintMode = data?.display_mode === 'print' || data?.client === 'dsr'
+ *   // ...mode logic...
+ * })
+ *
+ * // later
+ * unsubscribePromise.then(unsubscribe => unsubscribe())
+ *
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on_app_set_data(handler: (data: UiAppSetDataPayload) => Promise<void>): Promise<() => void>;
+/**
+ * Subscribe to the app update data event. It is triggered when the user changes from edit mode to view mode or vice versa
+ * and when the call is started or ended.
+ *
+ * @example
+ * let inCall = false
+ * let isEditMode = false
+ * const unsubscribePromise = useUi().on_app_update_data((data) => {
+ *   isEditMode = data?.is_edit_mode
+ *   inCall = data?.in_call
+ *   // ...mode logic...
+ * })
+ *
+ * // later
+ * unsubscribePromise.then(unsubscribe => unsubscribe())
+ *
+ * @returns A Promise resolving to a cleanup function to unsubscribe from the event.
+ */
+declare function on_app_update_data(handler: (data: UiAppUpdateDataPayload) => Promise<void>): Promise<() => void>;
+/**
+ * Broadcast event to the UI. Hidden from the documentation.
+ *
+ * @hidden
+ */
+declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
+declare const _default: {
+    complete_postcall(payload: import('../../../../main.lib').UiCompletePostcallRequest): Promise<void>;
+    stop_meeting(): Promise<void>;
+    enable_postcall_submit(): Promise<void>;
+    disable_postcall_submit(): Promise<void>;
+    set_postcall_style(payload: import('../../../../main.lib').UiSetPostcallStyleRequest): Promise<void>;
+    update_canvas(payload: import('../../../../main.lib').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    app_loaded(): Promise<void>;
+    app_resize(payload: import('../../../../main.lib').UiAppResizeRequest): Promise<void>;
+    canvas_navigate_next_page(): Promise<void>;
+    canvas_navigate_previous_page(): Promise<void>;
+    canvas_navigate_page(payload: import('../../../../main.lib').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
+    capture_app_error(payload: import('../../../../main.lib').UiCaptureAppErrorRequest): Promise<void>;
+    update_location(payload: import('../../../../main.lib').UpdateLocationPitcherEvent): Promise<any>;
+    embeddable_ready(): Promise<void>;
+    ui_select_content(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
+    select_content(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
+    open(payload: import('../../../../main.lib').UiOpenRequest): Promise<void>;
+    toast(payload: import('../../../../main.lib').UiToastRequest): Promise<void>;
+    preselect_sfdc_meeting_id(payload: import('../../../../main.lib').UiPreselectSfdcMeetingIdRequest): Promise<import('../../../../main.lib').UiPreselectSfdcMeetingIdResponse>;
+    on: typeof on;
+    on_meeting_canceled: typeof on_meeting_canceled;
+    on_canvas_updated: typeof on_canvas_updated;
+    on_section_list_updated: typeof on_section_list_updated;
+    on_app_set_data: typeof on_app_set_data;
+    on_app_update_data: typeof on_app_update_data;
+    ui_broadcast: typeof ui_broadcast;
+};
+export default _default;

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

@@ -1 +1,16 @@
+/**
+ * Notify the CatalogIQ instance that the app is loaded. This method should be called when the app is fully loaded and
+ * ready to be displayed.
+ *
+ * ::: warning
+ * This method is deprecated. If you find yourself needing it, contact the Pitcher team.
+ * :::
+ *
+ * [//]: # 'TODO: Is this even needed today? We should probably remove it'
+ *
+ * @example
+ * useUi().embeddable_ready()
+ *
+ * @deprecated
+ */
 export declare function embeddable_ready(): Promise<void>;

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

@@ -1,3 +1,20 @@
 import { UpdateLocationPitcherEvent } from '../../../interfaces';
 
+/**
+ * Navigate to another page in the CatalogIQ instance.
+ *
+ * [//]: # 'TODO: This is a very powerful event, we need to expand documentation here'
+ *
+ * @example
+ * const canvasId = '1234567890abcdef12345678' // obtain target canvasId
+ * useUi().update_location({
+ *   action: 'restore',
+ *   routes: {
+ *     'slotty-ui': {
+ *       path: '/canvases/saved-canvases/' + canvasId + '/build/present',
+ *       query: {},
+ *     },
+ *   },
+ * })
+ */
 export declare function update_location(payload: UpdateLocationPitcherEvent): Promise<any>;

package/lib/sdk/api/modules/ui/post-call.ui.d.ts

@@ -1,6 +1,31 @@
 import { UiCompletePostcallRequest, UiSetPostcallStyleRequest } from './types.ui';
 
 export declare function complete_postcall(payload: UiCompletePostcallRequest): Promise<void>;
+/**
+ * Ends current meeting and shows postcall form.
+ *
+ * @example
+ * useUi().stop_meeting()
+ */
+export declare function stop_meeting(): Promise<void>;
+/**
+ * Mark the postcall form as possible to submit by the user.
+ *
+ * @example
+ * useUi().enable_postcall_submit()
+ */
 export declare function enable_postcall_submit(): Promise<void>;
+/**
+ * Mark the postcall form as **not** possible to submit by the user. Useful while processing the form data.
+ *
+ * @example
+ * useUi().disable_postcall_submit()
+ */
 export declare function disable_postcall_submit(): Promise<void>;
+/**
+ * Change the height of the postcall form.
+ *
+ * @example
+ * useUi().set_postcall_style({ height: 100 })
+ */
 export declare function set_postcall_style(payload: UiSetPostcallStyleRequest): Promise<void>;