@pitcher/js-api 1.21.0-beta.10 → 1.21.0-beta.12

package/lib/apps/browser/util/file.d.ts

@@ -1,3 +1,3 @@
 import { RenderableFile } from '../../../types/files';
 
-export declare function openFile(item: RenderableFile, e: MouseEvent): void;
+export declare function openItem(item: RenderableFile, e: MouseEvent): void;

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

@@ -1,3 +1,4 @@
+import { AdminSelectContentRequest, AdminSelectContentResponse } from './types.admin';
 import { File, PaginatedFileList } from '../../../../../types/openapi';
 
 /**
@@ -28,3 +29,21 @@ export declare function getFile(payload: {
  * ```
  */
 export declare function getFiles(payload: Record<string, any>): Promise<PaginatedFileList>;
+/**
+ * Opens a selector that allows you to select (and preselect) from your Pitcher uploaded content.
+ * ```
+ * const api = useApi() // or useAdmin() if you know that you 're in Admin app context
+ * api
+ *   .select_content({
+ *     selections: [
+ *       { fileId: "01HCZ623YYRFJQ0F7B69VWE510", type: "file" },
+ *       {
+ *         fileId: "01HD3XGZ5FN90QJGK7CH8TBZDF",
+ *         type: "page",
+ *         pageIndex: 2,
+ *       },
+ *     ],
+ *   })
+ * ```
+ */
+export declare function selectContent(payload: AdminSelectContentRequest): Promise<AdminSelectContentResponse>;

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

@@ -1,7 +1,33 @@
 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 declare function toast(payload: AdminToastRequest): Promise<void>;
-export * from './env.admin';
-export * from './canvas.admin';
-export * from './metadataTemplates.admin';
+declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+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>;
+    getEnv(): Promise<import('./types.admin').AdminEnv>;
+    on: typeof on;
+    toast: typeof toast;
+};
+export default _default;

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

@@ -1,4 +1,5 @@
 import { PitcherEnv } from '../../../interfaces';
+import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
 
 export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
 export declare const ADMIN_MESSAGE_TYPES: {
@@ -16,6 +17,7 @@ export declare const ADMIN_API_METHOD_TYPES: {
     readonly GET_ENV: "admin_get_env";
     readonly GET_FILE: "admin_get_file";
     readonly GET_FILES: "admin_get_files";
+    readonly SELECT_CONTENT: "admin_select_content";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
     readonly TOAST: "admin_toast";
     readonly UPDATE_CANVAS: "admin_update_canvas";
@@ -39,6 +41,13 @@ export interface AdminToastRequest {
     keepAliveOnHover?: boolean;
     showIcon?: boolean;
 }
+export type AdminSelectContentRequest = {
+    selections?: Selection[];
+};
+export type AdminSelectContentResponse = {
+    user_action: 'cancelled' | 'selected';
+    content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
+};
 export type AdminResponse<Response = any> = {
     id: string;
     type: (typeof ADMIN_API_TYPES)['ADMIN_RESPONSE'];

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

@@ -1,5 +1,9 @@
 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';
+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: {
+    embeddable_ready(): Promise<void>;
+    getEnv(): Promise<import('./types.dsr').DsrEnv>;
+    on: typeof on;
+};
+export default _default;

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

@@ -2,7 +2,7 @@ import { UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToast
 
 export declare function ui_select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
 /**
- * Fetches a list of canvases to use in your app.
+ * Allows you to select (and preselect) content from your Pitcher content.
  * ```
  * const api = useApi() // or useUi() if you know that you 're in UI context
  * api

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

@@ -1,15 +1,37 @@
 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';
+declare function on<T extends keyof UiMessagePayloads>(type: T, handler: (data: UiMessagePayloads[T]) => Promise<void>): Promise<() => void>;
+declare function on_meeting_canceled(handler: (data: UiMeetingCanceledPayload) => Promise<void>): Promise<() => void>;
+declare function on_canvas_updated(handler: (data: UiCanvasUpdatedPayload) => Promise<void>): Promise<() => void>;
+declare function on_section_list_updated(handler: (data: UiSectionListUpdatedPayload) => Promise<void>): Promise<() => void>;
+declare function on_app_set_data(handler: (data: UiAppSetDataPayload) => Promise<void>): Promise<() => void>;
+declare function on_app_update_data(handler: (data: UiAppUpdateDataPayload) => Promise<void>): Promise<() => void>;
+declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
+declare const _default: {
+    complete_postcall(payload: import('../../../../main.lib').UiCompletePostcallRequest): 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>;
+    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/main.d.ts

@@ -1,9 +1,6 @@
 import { ApiOptions } from './interfaces';
 import { createHighLevelApi } from './api/HighLevelApi';
 
-import * as ui from '@sdk/api/modules/ui';
-import * as admin from '@sdk/api/modules/admin';
-import * as dsr from '@sdk/api/modules/dsr';
 export * from './interfaces';
 export * from './payload.types';
 export * from './api/modules/ui/types.ui';
@@ -12,47 +9,65 @@ export * from './api/modules/dsr/types.dsr';
 export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
 export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
 export declare function useUi(): {
-    on: typeof ui.on;
-    on_meeting_canceled: typeof ui.on_meeting_canceled;
-    on_canvas_updated: typeof ui.on_canvas_updated;
-    on_section_list_updated: typeof ui.on_section_list_updated;
-    on_app_set_data: typeof ui.on_app_set_data;
-    on_app_update_data: typeof ui.on_app_update_data;
-    ui_broadcast: typeof ui.ui_broadcast;
-    ui_select_content: typeof ui.ui_select_content;
-    select_content: typeof ui.select_content;
-    open: typeof ui.open;
-    toast: typeof ui.toast;
-    preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-    embeddable_ready: typeof ui.embeddable_ready;
-    update_location: typeof ui.update_location;
-    capture_app_error: typeof ui.capture_app_error;
-    update_canvas: typeof ui.update_canvas;
-    app_loaded: typeof ui.app_loaded;
-    app_resize: typeof ui.app_resize;
-    canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-    canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-    canvas_navigate_page: typeof ui.canvas_navigate_page;
-    complete_postcall: typeof ui.complete_postcall;
-    enable_postcall_submit: typeof ui.enable_postcall_submit;
-    disable_postcall_submit: typeof ui.disable_postcall_submit;
-    set_postcall_style: typeof ui.set_postcall_style;
-} & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    enable_postcall_submit(): Promise<void>;
+    disable_postcall_submit(): Promise<void>;
+    set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+    update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    app_loaded(): Promise<void>;
+    app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+    canvas_navigate_next_page(): Promise<void>;
+    canvas_navigate_previous_page(): Promise<void>;
+    canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+    update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+    embeddable_ready(): Promise<void>;
+    ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+    toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+    preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+    on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+    on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+    on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+    on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+    ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
+};
 export declare function useAdmin(): {
-    on: typeof admin.on;
-    toast: typeof admin.toast;
-    getEnv: typeof admin.getEnv;
-    createCanvas: typeof admin.createCanvas;
-    getCanvases: typeof admin.getCanvases;
-    getCanvas: typeof admin.getCanvas;
-    updateCanvas: typeof admin.updateCanvas;
-    getInstanceMetadataTemplates: typeof admin.getInstanceMetadataTemplates;
-} & Record<string, typeof admin.on | typeof admin.createCanvas | typeof admin.getEnv | typeof admin.toast | typeof admin.getCanvases | typeof admin.getCanvas | typeof admin.updateCanvas | typeof admin.getInstanceMetadataTemplates>;
+    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('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/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>;
+    getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
+    on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+    toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
+};
 export declare function useDsr(): {
-    on: typeof dsr.on;
-    getEnv: typeof dsr.getEnv;
-    embeddable_ready: typeof dsr.embeddable_ready;
-} & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>;
+    embeddable_ready(): Promise<void>;
+    getEnv(): Promise<import('./api/modules/dsr/types.dsr').DsrEnv>;
+    on: (type: typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES[keyof typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES], handler: (data: import('./api/modules/dsr/types.dsr').DsrMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+};
 export type JsApiLocation = 'ui' | 'admin' | 'dsr' | 'impact';
 export declare function getAvailableApis(): JsApiLocation[];
 export declare function useApi(options?: ApiOptions): {
@@ -180,47 +195,65 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     API: import('./api/LowLevelApi').LowLevelApi;
-} | ({
-    on: typeof admin.on;
-    toast: typeof admin.toast;
-    getEnv: typeof admin.getEnv;
-    createCanvas: typeof admin.createCanvas;
-    getCanvases: typeof admin.getCanvases;
-    getCanvas: typeof admin.getCanvas;
-    updateCanvas: typeof admin.updateCanvas;
-    getInstanceMetadataTemplates: typeof admin.getInstanceMetadataTemplates;
-} & Record<string, typeof admin.on | typeof admin.createCanvas | typeof admin.getEnv | typeof admin.toast | typeof admin.getCanvases | typeof admin.getCanvas | typeof admin.updateCanvas | typeof admin.getInstanceMetadataTemplates>) | ({
-    on: typeof dsr.on;
-    getEnv: typeof dsr.getEnv;
-    embeddable_ready: typeof dsr.embeddable_ready;
-} & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>) | {
+} | {
+    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('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/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>;
+    getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
+    on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+    toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
+} | {
+    embeddable_ready(): Promise<void>;
+    getEnv(): Promise<import('./api/modules/dsr/types.dsr').DsrEnv>;
+    on: (type: typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES[keyof typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES], handler: (data: import('./api/modules/dsr/types.dsr').DsrMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
+} | {
     ui: {
-        on: typeof ui.on;
-        on_meeting_canceled: typeof ui.on_meeting_canceled;
-        on_canvas_updated: typeof ui.on_canvas_updated;
-        on_section_list_updated: typeof ui.on_section_list_updated;
-        on_app_set_data: typeof ui.on_app_set_data;
-        on_app_update_data: typeof ui.on_app_update_data;
-        ui_broadcast: typeof ui.ui_broadcast;
-        ui_select_content: typeof ui.ui_select_content;
-        select_content: typeof ui.select_content;
-        open: typeof ui.open;
-        toast: typeof ui.toast;
-        preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-        embeddable_ready: typeof ui.embeddable_ready;
-        update_location: typeof ui.update_location;
-        capture_app_error: typeof ui.capture_app_error;
-        update_canvas: typeof ui.update_canvas;
-        app_loaded: typeof ui.app_loaded;
-        app_resize: typeof ui.app_resize;
-        canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-        canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-        canvas_navigate_page: typeof ui.canvas_navigate_page;
-        complete_postcall: typeof ui.complete_postcall;
-        enable_postcall_submit: typeof ui.enable_postcall_submit;
-        disable_postcall_submit: typeof ui.disable_postcall_submit;
-        set_postcall_style: typeof ui.set_postcall_style;
-    } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.on_meeting_canceled | typeof ui.on_canvas_updated | typeof ui.on_section_list_updated | typeof ui.on_app_set_data | typeof ui.on_app_update_data | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.app_loaded | typeof ui.app_resize | typeof ui.canvas_navigate_next_page | typeof ui.canvas_navigate_previous_page | typeof ui.canvas_navigate_page | typeof ui.complete_postcall | typeof ui.enable_postcall_submit | typeof ui.disable_postcall_submit | typeof ui.set_postcall_style>;
+        complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+        enable_postcall_submit(): Promise<void>;
+        disable_postcall_submit(): Promise<void>;
+        set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+        update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+        app_loaded(): Promise<void>;
+        app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+        canvas_navigate_next_page(): Promise<void>;
+        canvas_navigate_previous_page(): Promise<void>;
+        canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+        capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+        update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+        embeddable_ready(): Promise<void>;
+        ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+        select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+        open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+        toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+        preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+        on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+        on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+        on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+        on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+        on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+        on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+        ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
+    };
     impact: {
         on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
         off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
@@ -347,31 +380,31 @@ export declare function useApi(options?: ApiOptions): {
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
         API: import('./api/LowLevelApi').LowLevelApi;
     };
-    on: typeof ui.on;
-    on_meeting_canceled: typeof ui.on_meeting_canceled;
-    on_canvas_updated: typeof ui.on_canvas_updated;
-    on_section_list_updated: typeof ui.on_section_list_updated;
-    on_app_set_data: typeof ui.on_app_set_data;
-    on_app_update_data: typeof ui.on_app_update_data;
-    ui_broadcast: typeof ui.ui_broadcast;
-    ui_select_content: typeof ui.ui_select_content;
-    select_content: typeof ui.select_content;
-    open: typeof ui.open;
-    toast: typeof ui.toast;
-    preselect_sfdc_meeting_id: typeof ui.preselect_sfdc_meeting_id;
-    embeddable_ready: typeof ui.embeddable_ready;
-    update_location: typeof ui.update_location;
-    capture_app_error: typeof ui.capture_app_error;
-    update_canvas: typeof ui.update_canvas;
-    app_loaded: typeof ui.app_loaded;
-    app_resize: typeof ui.app_resize;
-    canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
-    canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
-    canvas_navigate_page: typeof ui.canvas_navigate_page;
-    complete_postcall: typeof ui.complete_postcall;
-    enable_postcall_submit: typeof ui.enable_postcall_submit;
-    disable_postcall_submit: typeof ui.disable_postcall_submit;
-    set_postcall_style: typeof ui.set_postcall_style;
+    complete_postcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
+    enable_postcall_submit(): Promise<void>;
+    disable_postcall_submit(): Promise<void>;
+    set_postcall_style(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
+    update_canvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    app_loaded(): Promise<void>;
+    app_resize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
+    canvas_navigate_next_page(): Promise<void>;
+    canvas_navigate_previous_page(): Promise<void>;
+    canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
+    update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
+    embeddable_ready(): Promise<void>;
+    ui_select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    select_content(payload?: import('./api/modules/ui/types.ui').UiSelectContentRequest): Promise<import('./api/modules/ui/types.ui').UiSelectContentResponse>;
+    open(payload: import('./api/modules/ui/types.ui').UiOpenRequest): Promise<void>;
+    toast(payload: import('./api/modules/ui/types.ui').UiToastRequest): Promise<void>;
+    preselect_sfdc_meeting_id(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
+    on: <T extends keyof import('./api/modules/ui/types.ui').UiMessagePayloads>(type: T, handler: (data: import('./api/modules/ui/types.ui').UiMessagePayloads[T]) => Promise<void>) => Promise<() => void>;
+    on_meeting_canceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
+    on_canvas_updated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_section_list_updated: (handler: (data: import('./api/modules/ui/types.ui').UiSectionListUpdatedPayload) => Promise<void>) => Promise<() => void>;
+    on_app_set_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppSetDataPayload) => Promise<void>) => Promise<() => void>;
+    on_app_update_data: (handler: (data: import('./api/modules/ui/types.ui').UiAppUpdateDataPayload) => Promise<void>) => Promise<() => void>;
+    ui_broadcast: (payload: import('./api/modules/ui/types.ui').UiBroadcastRequest) => Promise<void>;
     off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     enterFullscreen: () => Promise<any>;
     exitFullscreen: () => Promise<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.21.0-beta.10",
+  "version": "1.21.0-beta.12",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",