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

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

@@ -1,7 +1,8 @@
 import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { Selection } from '@content-selector/appTypes';
 import { CanvasSection, ComponentNode, EmbeddableProps, SfEvent } from '../../../../main.lib';
 import { Mutable } from '../../../../types/ts';
-import { Canvas, User } from '../../../../../types/openapi';
+import { CanvasRetrieve, User } from '../../../../../types/openapi';
 import { OpenRequestPayload } from '../../../payload.types';
 
 export declare const UI_MESSAGE: "UI_MESSAGE";
@@ -13,12 +14,14 @@ 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_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
     readonly UI_UPDATE_LOCATION: "ui_update_location";
     readonly UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id";
     readonly UI_SET_POSTCALL_STYLE: "ui_set_postcall_style";
     readonly UI_ENABLE_POSTCALL_SUBMIT: "ui_enable_postcall_submit";
     readonly UI_DISABLE_POSTCALL_SUBMIT: "ui_disable_postcall_submit";
     readonly UI_COMPLETE_POSTCALL: "ui_complete_postcall";
+    readonly UI_STOP_MEETING: "ui_stop_meeting";
     readonly UI_CANVAS_NAVIGATE_NEXT_PAGE: "ui_canvas_navigate_next_page";
     readonly UI_CANVAS_NAVIGATE_PREVIOUS_PAGE: "ui_canvas_navigate_previous_page";
     readonly UI_CANVAS_NAVIGATE_PAGE: "ui_canvas_navigate_page";
@@ -34,38 +37,76 @@ export declare const UI_MESSAGE_TYPES: {
 };
 export declare const UI_NATIVE_MESSAGE_TYPES: readonly ["ui_app_set_data", "ui_app_update_data", "ui_canvas_updated"];
 export type UiBroadcastRequest = Record<string, any>;
-export type UiSelectContentRequest = Record<string, never>;
+export type UiSelectContentRequest = {
+    /** Array of selections */
+    selections?: Selection[];
+};
 export type UiSelectContentResponse = {
+    /** User action result */
     user_action: 'cancelled' | 'selected';
+    /** Selected content */
     content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
 };
+/**
+ * Error object to send to Pitcher sentry instance
+ */
 export type UiCaptureAppErrorRequest = Record<string, any>;
-export type UiUpdateCanvasRequest = Mutable<Canvas> & {
+export type UiUpdateCanvasRequest = Mutable<CanvasRetrieve> & {
+    /** Comma-separated list of field keys to return from the server */
     fields?: string;
 };
 export type UiOpenRequest = OpenRequestPayload;
 export type UiCompletePostcallRequest = {
+    /** Indicates if the postcall was successfully submitted */
     was_successfully_submitted?: boolean;
 };
 export type UiSetPostcallStyleRequest = Record<string, any>;
 export type UiAppResizeRequest = {
+    /** Requested height as the number of pixels */
     height: number;
 };
 export type UiCanvasNavigatePageReuqest = {
+    /** The id of the component we want to navigate to */
     page: ComponentNode['id'];
 };
 export interface UiToastRequest {
+    /**
+     * Type of the toast, influences the default icon
+     * @defaultValue **REQUIRED**
+     */
     type: 'info' | 'error' | 'warning' | 'success' | 'loading';
+    /**
+     * Text to show inside the toast
+     * @defaultValue **REQUIRED**
+     */
     message: string;
+    /**
+     * Optional, value in milliseconds
+     * @defaultValue 3500
+     */
     duration?: number;
+    /**
+     * Visibility of the close button, default is true
+     * @defaultValue true
+     */
     closable?: boolean;
+    /**
+     * Toast won't be hidden as long as it is hovered
+     * @defaultValue true
+     */
     keepAliveOnHover?: boolean;
+    /**
+     * Set to `false` to hide the icon
+     * @defaultValue true
+     */
     showIcon?: boolean;
 }
 export interface UiPreselectSfdcMeetingIdRequest {
+    /** Salesforce Meeting ID */
     eventId: string;
 }
 export interface UiPreselectSfdcMeetingIdResponse {
+    /** Salesforce Event */
     event: SfEvent | null;
 }
 export type UiMessagePayloads = {
@@ -76,36 +117,58 @@ export type UiMessagePayloads = {
     [UI_MESSAGE_TYPES.UI_SECTION_LIST_UPDATED]: UiSectionListUpdatedPayload;
 };
 export type UiMessageEnvelope<T extends (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES] = (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES]> = {
+    /** Message type */
     type: T;
+    /** Message body */
     body: UiMessagePayloads[T];
 };
 export type UiMeetingCanceledPayload = {
+    /** Account ID */
     accountId?: string;
+    /** Event ID */
     eventId?: string;
 };
 export type UiAppSetDataPayload = {
+    /** Client name */
     client: string | null;
+    /** Platform name */
     platform: string | undefined;
+    /** User information */
     user: User | null;
+    /** Edit mode status */
     is_edit_mode: boolean;
+    /** Call status */
     in_call: boolean;
-    canvas: Canvas;
+    /** Canvas data */
+    canvas: CanvasRetrieve;
+    /** Section used in canvas */
     used_in_section: CanvasSection | null;
+    /** Component ID */
     component_id: string;
+    /** Embeddable settings */
     settings: EmbeddableProps['settings'] | null;
+    /** Width of the canvas */
     width: string | undefined;
+    /** Height of the canvas */
     height: string | undefined;
+    /** Display mode */
     display_mode: string | undefined;
 };
 export type UiAppUpdateDataPayload = {
+    /** Call status */
     in_call: boolean;
+    /** Edit mode status */
     is_edit_mode: boolean;
 };
 export type UiCanvasUpdatedPayload = {
-    canvas: Canvas;
+    /** Canvas data */
+    canvas: CanvasRetrieve;
 };
 export type UiSectionListUpdatedPayload = {
+    /** List of section IDs */
     section_list_ids: string[];
+    /** Section list component ID */
     section_list_component_id: string;
-    canvas: Canvas | null;
+    /** Canvas data */
+    canvas: CanvasRetrieve | null;
 };

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

@@ -3,5 +3,9 @@ import { PaginatedData } from '../../../types/paginatedData';
 import { User } from '../../../../types/openapi';
 
 export declare function getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>;
+/**
+ * Ask for a refreshed Salesforce token. In case the token hasn't expired yet, this method will return the same token as the current one found in the (`getEnv`)[#getenv] result.
+ * @returns Promise resolving to an object containing the token
+ */
 export declare function refreshServiceToken(payload?: RefreshServiceTokenRequest): Promise<RefreshServiceTokenResponse>;
 export declare function refreshAccessToken(): any;

package/lib/sdk/interfaces.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from './utils/eventEmitter';
-import { Favorite, File, User, Canvas } from '../../types/openapi';
+import { Favorite, File, User, CanvasRetrieve } from '../../types/openapi';
 import { PitcherOrg } from '../types/organization.types';
 import { PitcherInstance } from '../types/instance.types';
 import { PaginatedData } from '../types/paginatedData';
@@ -111,54 +111,171 @@ export declare enum PitcherExternalEventName {
     OPEN_CANVAS = "open_canvas",
     START_CALL = "start_call"
 }
+/**
+ * Base interface for update location actions.
+ */
 interface UpdateLocation {
+    /**
+     * The action to be performed.
+     */
     action: string;
 }
+/**
+ * Represents a route in the location.
+ */
 export interface LocationRoute {
+    /**
+     * The path of the route.
+     */
     path: string;
+    /**
+     * The query parameters of the route.
+     */
     query: Record<string, any>;
+    /**
+     * Indicates if the route is being restored.
+     */
     is_restoring: boolean;
+    /**
+     * Indicates if the route is mounted.
+     */
     is_mounted: boolean;
 }
+/**
+ * A record of location routes.
+ */
 export type LocationRoutes = Record<string, LocationRoute>;
+/**
+ * Interface for the 'register' update location action.
+ */
 export interface UpdateLocationOnRegister extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'register';
+    /**
+     * The child application identifier.
+     */
     child_app: string;
+    /**
+     * The parent application identifier (optional).
+     */
     parent_app?: string;
+    /**
+     * The path of the route (optional).
+     */
     path?: string;
+    /**
+     * The query parameters of the route (optional).
+     */
     query?: Record<string, any>;
 }
+/**
+ * Interface for the 'unregister' update location action.
+ */
 export interface UpdateLocationOnUnregister extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'unregister';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'update' update location action.
+ */
 export interface UpdateLocationOnUpdate extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'update';
+    /**
+     * The routes to be updated.
+     */
     routes: Record<string, Omit<LocationRoute, 'is_restoring' | 'is_mounted'>>;
 }
+/**
+ * Interface for the 'mounted' update location action.
+ */
 export interface UpdateLocationOnMounted extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'mounted';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'restore' update location action.
+ */
 export interface UpdateLocationOnRestore extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'restore';
+    /**
+     * The routes to be restored.
+     */
     routes: Record<string, Omit<LocationRoute, 'is_mounted'>>;
 }
+/**
+ * Interface for the 'restore_completed' update location action.
+ */
 export interface UpdateLocationOnRestoreCompleted extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'restore_completed';
+    /**
+     * The application identifier.
+     */
     app: string;
+    /**
+     * The path of the route.
+     */
     path: string;
+    /**
+     * The query parameters of the route.
+     */
     query: Record<string, any>;
 }
+/**
+ * Interface for the 'get_routes_request' update location action.
+ */
 export interface UpdateLocationOnGetRoutesRequest extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'get_routes_request';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'get_routes_response' update location action.
+ */
 export interface UpdateLocationOnGetRoutesResponse extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'get_routes_response';
+    /**
+     * The application identifier.
+     */
     app: string;
+    /**
+     * The routes in the response.
+     */
     routes: LocationRoutes;
 }
+/**
+ * Union type for all update location pitcher events.
+ */
 export type UpdateLocationPitcherEvent = UpdateLocationOnUnregister | UpdateLocationOnRestore | UpdateLocationOnUpdate | UpdateLocationOnRegister | UpdateLocationOnRestoreCompleted | UpdateLocationOnMounted | UpdateLocationOnGetRoutesRequest | UpdateLocationOnGetRoutesResponse;
 export interface PitcherEventMap {
     [PitcherEventName.ENV_CHANGED]: PitcherEnv;
@@ -204,7 +321,7 @@ export interface PitcherEventMap {
      */
     [PitcherEventName.EXITED_FULLSCREEN]: void;
     [PitcherEventName.CANVAS_UPDATED]: Record<string, any>;
-    [PitcherEventName.CANVAS_UPDATED_SUCCESS]: Partial<Canvas>;
+    [PitcherEventName.CANVAS_UPDATED_SUCCESS]: Partial<CanvasRetrieve>;
     [PitcherEventName.UPDATE_LOCATION]: UpdateLocationPitcherEvent;
     [PitcherEventName.FILE_CLOSED]: {
         file_id?: string;