@pitcher/js-api 1.22.0-alpha.4 → 1.22.0-alpha.6

package/lib/components/CFileViewer/CFileViewer.use.d.ts

@@ -25,7 +25,7 @@ declare const _default: ({ videoPlayerEl, pdfViewerEl, bottomBarRef, i18n, appLo
     clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
     context?: Record<string, any>;
 }) => {
-    viewPdf: (file: FileModel | CanvasFile | null, pageIndex: MiniPage['page_index']) => Promise<void | Instance>;
+    viewPdf: (file: FileModel | CanvasFile | null, pageIndex: MiniPage["page_index"]) => Promise<void | Instance>;
     viewVideo: (file: FileModel | CanvasFile | null) => Promise<void>;
     onPdfFullScreen: () => void;
     updateFileViewerSettings: (partialSettings: Partial<import('../../types/fileViewerSettings.types').FileViewerSettings>) => void;

package/lib/composables/bulkActions.use.d.ts

@@ -5,8 +5,8 @@ export default function useBulkActions(): {
     deleteFiles: (payload: BulkDeleteRequest) => Promise<BulkDeleteResponse>;
     deleteFolders: (payload: BulkDeleteRequest) => Promise<BulkDeleteResponse>;
     deleteFavorites: (payload: BulkDeleteRequest) => Promise<BulkDeleteResponse>;
-    addTags: (payload: Omit<BulkUpdateTagsRequest, 'instance_id' | 'operation'>) => Promise<BulkUpdateTags>;
-    removeTags: (payload: Omit<BulkUpdateTagsRequest, 'instance_id' | 'operation'>) => Promise<BulkUpdateTags>;
-    mergeMetadata: (payload: Omit<BulkUpdateMetadataRequest, 'instance_id' | 'operation'>) => Promise<BulkUpdateMetadata>;
-    replaceMetadata: (payload: Omit<BulkUpdateMetadataRequest, 'instance_id' | 'operation'>) => Promise<BulkUpdateMetadata>;
+    addTags: (payload: Omit<BulkUpdateTagsRequest, "instance_id" | "operation">) => Promise<BulkUpdateTags>;
+    removeTags: (payload: Omit<BulkUpdateTagsRequest, "instance_id" | "operation">) => Promise<BulkUpdateTags>;
+    mergeMetadata: (payload: Omit<BulkUpdateMetadataRequest, "instance_id" | "operation">) => Promise<BulkUpdateMetadata>;
+    replaceMetadata: (payload: Omit<BulkUpdateMetadataRequest, "instance_id" | "operation">) => Promise<BulkUpdateMetadata>;
 };

package/lib/composables/recentFiles.use.d.ts

@@ -8,5 +8,5 @@ export default function useRecentFiles({ instanceId, app, }: {
 }): {
     addRecentFile: (file: RecentFile) => void;
     instanceRecentFiles: ComputedRef<RecentFile[]>;
-    updateRecentFiles: (files: Pick<RecentFile, 'id' | 'thumbnail_url' | 'name'>[]) => void;
+    updateRecentFiles: (files: Pick<RecentFile, "id" | "thumbnail_url" | "name">[]) => void;
 };

package/lib/composables/useDetailsView.d.ts

@@ -10,7 +10,7 @@ export default function <T extends string>(sectionIdList: T[]): {
     onClose: (sectionId: T) => void;
     onClickMenu: (sectionId: T) => void;
     selectedSectionId: Ref<string>;
-    sectionsEditStates: import('vue').UnwrapNestedRefs<Record<T, boolean>>;
+    sectionsEditStates: import('vue').Reactive<Record<T, boolean>>;
     routerGuard: (guard: ComputedRef<boolean>, goBack: () => Promise<void | NavigationFailure | undefined>) => void;
     waypointOptions: {
         threshold: number;

package/lib/composables/useLocation.d.ts

@@ -18,7 +18,7 @@ export default function useLocation({ app, router, isReady, isRoot, selfRegister
     routes: LocationRoutes;
     relations: Record<string, string>;
     unmount: () => Promise<void>;
-    update: (newRoutes: UpdateLocationOnUpdate['routes']) => Promise<void>;
+    update: (newRoutes: UpdateLocationOnUpdate["routes"]) => Promise<void>;
     isPathRestored: import('vue').Ref<boolean>;
     isAppMounted: import('vue').ComputedRef<boolean>;
     isAppRestored: import('vue').ComputedRef<boolean>;

package/lib/composables/useLocationAPI.d.ts

@@ -13,10 +13,10 @@ export default function useLocationAPI(params: UseLocationAPI): {
     broadcast: {
         unregister: (appName: string) => Promise<any>;
         register: ({ child_app, parent_app, path }: RegisterLocation) => Promise<any>;
-        update: (routes: UpdateLocationOnUpdate['routes']) => Promise<any>;
+        update: (routes: UpdateLocationOnUpdate["routes"]) => Promise<any>;
         mount: () => Promise<any>;
         mounted: () => Promise<any>;
-        restore: (routes: UpdateLocationOnRestore['routes']) => Promise<any>;
+        restore: (routes: UpdateLocationOnRestore["routes"]) => Promise<any>;
         restoreCompleted: (path: string, query: Record<string, any>) => Promise<any>;
         getRoutesRequest: () => Promise<any>;
         getRoutesResponse: (app: string, routes: LocationRoutes) => Promise<any>;

package/lib/composables/useLocationManipulation.d.ts

@@ -27,7 +27,7 @@ export default function useLocationManipulation({ routes, relations, app, action
     isAppRestored: import('vue').ComputedRef<boolean>;
     recoverRouteFromLocations: (rootApp: string) => Route;
     isSameRoute: (route1?: Route, route2?: Route) => boolean;
-    isSameRouteAsStored: (internalRouter: ReturnType<typeof useLocationAPI>['internalRouter']) => boolean;
+    isSameRouteAsStored: (internalRouter: ReturnType<typeof useLocationAPI>["internalRouter"]) => boolean;
     deleteRelation: (appName: string) => string[];
     addActionToQueue: (body: UpdateLocationPitcherEvent) => void;
     registerLocation: ({ child_app, parent_app, path, query }: RegisterLocation) => void;

package/lib/composables/useWindowEvents.d.ts

@@ -10,7 +10,7 @@ export type InactiveEventPayload = {
 export default function (track: (eventName: string, payload: any) => void, pitcherApi?: ReturnType<typeof usePitcherApi>): {
     registerInactiveEvent: ({ id, payload, enterEvent, exitEvent, type, }: {
         id: string;
-        payload: InactiveEventPayload;
+        payload: InactiveEventPayload | (() => InactiveEventPayload);
         enterEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         exitEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         type?: EventType;

package/lib/custom-naive-locales/el.d.ts

@@ -47,7 +47,7 @@ declare const _default: {
         startMonthPlaceholder: string;
         endMonthPlaceholder: string;
         monthBeforeYear: boolean;
-        firstDayOfWeek: 0 | 2 | 1 | 3 | 4 | 5 | 6;
+        firstDayOfWeek: 0 | 1 | 2 | 3 | 4 | 5 | 6;
         today: string;
     };
     DataTable: {

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

@@ -16,8 +16,8 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
     getEnv(): Promise<import('../interfaces').PitcherEnv>;
     updateMyUser(payload: {
-        language?: import('../../main.lib').LanguageEnum | undefined;
-        dark_mode?: boolean | undefined;
+        language?: import('../../main.lib').LanguageEnum;
+        dark_mode?: boolean;
     }): Promise<import('../../main.lib').User>;
     getLanguages(): Promise<modules.Language[]>;
     getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;
@@ -25,58 +25,58 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     updateEvent(payload: import('../../main.lib').PatchedEventRequest): Promise<import('../../main.lib').Event>;
     deleteEvent(payload: Partial<import('../../main.lib').Event>): Promise<void>;
     getCanvases(payload: import('../../main.lib').GetCanvasesParams & {
-        filters?: Record<string, any> | undefined;
-        fields?: string | undefined;
+        filters?: Record<string, any>;
+        fields?: string;
     }): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Canvas>>;
     createCanvas(payload: Omit<import('../../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../../main.lib').Canvas>;
     deleteCanvas(payload: {
-        id: string;
+        id: import('../../main.lib').Canvas["id"];
     }): Promise<import('../../main.lib').Canvas>;
     updateCanvas(payload: import('../../main.lib').PatchedCanvasUpdateRequest & {
-        id: string;
-        instance_id?: string | undefined;
-        fields?: string | undefined;
+        id: import('../../main.lib').Canvas["id"];
+        instance_id?: import('../../main.lib').Instance["id"];
+        fields?: string;
     }): Promise<import('../../main.lib').Canvas>;
     getCanvas(payload: {
-        id: string;
-        fields?: string | undefined;
+        id: import('../../main.lib').Canvas["id"];
+        fields?: string;
     }): Promise<import('../../main.lib').Canvas>;
     shareCanvas(payload: {
-        id: string;
+        id: import('../../main.lib').Canvas["id"];
     }): Promise<import('../../main.lib').SharedLink>;
     getFiles(payload: import('../payload.types').ListFilesPayload): Promise<import('../../main.lib').PaginatedFileList>;
-    getRecentFiles(payload?: import('../payload.types').GetRecentFilesPayload | undefined): Promise<import('../../main.lib').File[]>;
+    getRecentFiles(payload?: import('../payload.types').GetRecentFilesPayload): Promise<import('../../main.lib').File[]>;
     downloadFile(payload: {
-        file_id: string;
+        file_id: import('../../main.lib').File["id"];
     }): Promise<null>;
     getAppConfig(payload: {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: string;
+        file_id: import('../../main.lib').FileRetrieve["id"];
     }): Promise<import('../../main.lib').FileRetrieve>;
     updateFile(payload: import('../../main.lib').FileUpdateRequest & {
-        id: string;
+        id: import('../../main.lib').File["id"];
     }): Promise<import('../../main.lib').FileRetrieve>;
     deleteFile(payload: {
-        file_id: string;
-    }): Promise<string>;
+        file_id: import('../../main.lib').File["id"];
+    }): Promise<import('../../main.lib').File["id"]>;
     createFile(payload: Omit<import('../../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../../main.lib').FileRetrieve>;
     selectDeviceFile(): Promise<import('../../main.lib').DeviceFile>;
     search(payload: {
         query: string;
-        includeExpired?: boolean | undefined;
+        includeExpired?: boolean;
     }): Promise<any>;
-    getUsers(payload?: import('../../main.lib').GetUsersParams | undefined): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').User>>;
+    getUsers(payload?: import('../../main.lib').GetUsersParams): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').User>>;
     refreshServiceToken(payload: import('../../main.lib').RefreshServiceTokenRequest): Promise<import('../../main.lib').RefreshServiceTokenResponse>;
     fetchDocumentInfo(payload: {
-        fileId: string;
+        fileId: import('../../main.lib').File["id"];
     }): Promise<{
-        [key: string]: unknown;
         pageCount: number;
+        [key: string]: unknown;
     }>;
     renderPageAsImage(payload: {
-        fileId: string;
+        fileId: import('../../main.lib').File["id"];
         pageNumber: number;
         params: {
             width: number;
@@ -90,33 +90,33 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     }): Promise<void>;
     query(payload: import('../payload.types').QueryPayload): Promise<any>;
     getFolder(payload?: {
-        id: string;
+        id: import('../../main.lib').FolderRetrieve["id"];
     }): Promise<import('../../main.lib').FolderRetrieve>;
     createFolder(payload: Omit<import('../../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../../main.lib').FolderRetrieve>;
     updateFolder(payload: import('../../main.lib').FolderUpdateRequest & {
-        id: string;
+        id: import('../../main.lib').Folder["id"];
     }): Promise<import('../../main.lib').FolderRetrieve>;
     deleteFolder(payload: {
-        folder_id: string;
+        folder_id: import('../../main.lib').FolderRetrieve["id"];
     }): Promise<void>;
     moveFolderItems(payload: {
-        target_folder_id: string;
+        target_folder_id: import('../../main.lib').Folder["id"];
         items: {
-            id: string;
-            type: "file" | "folder";
+            id: import('../../main.lib').File["id"] | import('../../main.lib').Folder["id"];
+            type: "folder" | "file";
         }[];
     }): Promise<import('../../main.lib').FolderRetrieve>;
-    getFavorites(payload?: import('../../main.lib').GetFavoritesParams | undefined): Promise<import('../../main.lib').PaginatedFavoriteList>;
+    getFavorites(payload?: import('../../main.lib').GetFavoritesParams): Promise<import('../../main.lib').PaginatedFavoriteList>;
     createFavorite(payload: import('../../main.lib').FavoriteCreateRequest): Promise<import('../../main.lib').Favorite>;
     deleteFavorite(payload: {
-        favorite_id: string;
+        favorite_id: import('../../main.lib').Favorite["id"];
     }): Promise<void>;
     notify(payload: import('../payload.types').NotificationPayload): Promise<void>;
     track(payload: {
         event_name: string;
         payload: any;
     }): Promise<any>;
-    getInstanceMetadataTemplates(payload?: import('../payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../../main.lib').PaginatedMetadataTemplateList>;
+    getInstanceMetadataTemplates(payload?: import('../payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../../main.lib').PaginatedMetadataTemplateList>;
     triggerNonFilesSync(): Promise<void>;
     submitUserFeedback(payload: import('../payload.types').SubmitUserFeedbackPayload): Promise<any>;
     close(): Promise<any>;

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

@@ -1,4 +1,9 @@
 import { Canvas } from '../../../../../types/openapi';
-import { UiUpdateCanvasRequest } from './types.ui';
+import { UiAppResizeRequest, UiCanvasNavigatePageReuqest, UiUpdateCanvasRequest } 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>;

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

@@ -1,6 +1,11 @@
-import { UiBroadcastRequest, UI_MESSAGE_TYPES, UiMessagePayloads } from './types.ui';
+import { UiMeetingCanceledPayload, UiCanvasUpdatedPayload, UiSectionListUpdatedPayload, UiAppSetDataPayload, UiAppUpdateDataPayload, UiBroadcastRequest, UiMessagePayloads } from './types.ui';
 
-export declare function on(type: (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES], handler: (data: UiMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+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';

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

@@ -1,3 +1,6 @@
-import { UiCompletePostcallRequest } from './types.ui';
+import { UiCompletePostcallRequest, UiSetPostcallStyleRequest } from './types.ui';
 
 export declare function complete_postcall(payload: UiCompletePostcallRequest): Promise<void>;
+export declare function enable_postcall_submit(): Promise<void>;
+export declare function disable_postcall_submit(): Promise<void>;
+export declare function set_postcall_style(payload: UiSetPostcallStyleRequest): Promise<void>;

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

@@ -1,7 +1,7 @@
 import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
-import { SfEvent } from '../../../../main.lib';
+import { CanvasSection, ComponentNode, EmbeddableProps, SfEvent } from '../../../../main.lib';
 import { Mutable } from '../../../../types/ts';
-import { Canvas } from '../../../../../types/openapi';
+import { Canvas, User } from '../../../../../types/openapi';
 import { OpenRequestPayload } from '../../../payload.types';
 
 export declare const UI_MESSAGE: "UI_MESSAGE";
@@ -15,11 +15,24 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
     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_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";
+    readonly UI_APP_LOADED: "ui_app_loaded";
+    readonly UI_APP_RESIZE: "ui_app_resize";
 };
 export declare const UI_MESSAGE_TYPES: {
     readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
+    readonly UI_CANVAS_UPDATED: "ui_canvas_updated";
+    readonly UI_SECTION_LIST_UPDATED: "ui_section_list_updated";
+    readonly UI_APP_SET_DATA: "ui_app_set_data";
+    readonly UI_APP_UPDATE_DATA: "ui_app_update_data";
 };
+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 UiSelectContentResponse = {
@@ -34,6 +47,13 @@ export type UiOpenRequest = OpenRequestPayload;
 export type UiCompletePostcallRequest = {
     was_successfully_submitted?: boolean;
 };
+export type UiSetPostcallStyleRequest = Record<string, any>;
+export type UiAppResizeRequest = {
+    height: number;
+};
+export type UiCanvasNavigatePageReuqest = {
+    page: ComponentNode['id'];
+};
 export interface UiToastRequest {
     type: 'info' | 'error' | 'warning' | 'success' | 'loading';
     message: string;
@@ -50,8 +70,42 @@ export interface UiPreselectSfdcMeetingIdResponse {
 }
 export type UiMessagePayloads = {
     [UI_MESSAGE_TYPES.UI_MEETING_CANCELED]: UiMeetingCanceledPayload;
+    [UI_MESSAGE_TYPES.UI_APP_SET_DATA]: UiAppSetDataPayload;
+    [UI_MESSAGE_TYPES.UI_APP_UPDATE_DATA]: UiAppUpdateDataPayload;
+    [UI_MESSAGE_TYPES.UI_CANVAS_UPDATED]: UiCanvasUpdatedPayload;
+    [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]> = {
+    type: T;
+    body: UiMessagePayloads[T];
 };
 export type UiMeetingCanceledPayload = {
     accountId?: string;
     eventId?: string;
 };
+export type UiAppSetDataPayload = {
+    client: string | null;
+    platform: string | undefined;
+    user: User | null;
+    is_edit_mode: boolean;
+    in_call: boolean;
+    canvas: Canvas;
+    used_in_section: CanvasSection | null;
+    component_id: string;
+    settings: EmbeddableProps['settings'] | null;
+    width: string | undefined;
+    height: string | undefined;
+    display_mode: string | undefined;
+};
+export type UiAppUpdateDataPayload = {
+    in_call: boolean;
+    is_edit_mode: boolean;
+};
+export type UiCanvasUpdatedPayload = {
+    canvas: Canvas;
+};
+export type UiSectionListUpdatedPayload = {
+    section_list_ids: string[];
+    section_list_component_id: string;
+    canvas: Canvas | null;
+};

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

@@ -0,0 +1,4 @@
+import { PitcherEnv } from '../interfaces';
+
+export declare const setEnv: (e: PitcherEnv) => void;
+export declare const onlineRestApiHandlers: Record<string, any>;

package/lib/sdk/interfaces.d.ts

@@ -22,10 +22,12 @@ export interface PitcherMessage {
         body?: Record<string, any>;
     };
 }
+type FetchMode = 'postmessage' | 'prefer-online';
 export interface ApiOptions {
     errorLogger?: (p: any) => string | void;
     logLevel?: 'off' | 'info' | 'debug';
     casing?: 'camel' | 'snake';
+    fetchMode?: FetchMode;
 }
 export interface PitcherEnv {
     mode: 'WEB' | 'IOS' | 'WINDOWS' | 'ANDROID';