@pitcher/canvas-ui 2025.12.16-082349-beta → 2025.12.16-082908-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { UiSelectAgendaRequest, UiSelectAgendaResponse, UiSelectCollectionPlayerRequest, UiSelectCollectionPlayerResponse, UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToastRequest, UiPreselectSfdcMeetingIdRequest, UiPreselectSfdcMeetingIdResponse } from './types.ui';
|
|
1
|
+
import { UiSelectAgendaRequest, UiSelectAgendaResponse, UiSelectCollectionPlayerRequest, UiSelectCollectionPlayerResponse, UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToastRequest, UiPreselectSfdcMeetingIdRequest, UiPreselectSfdcMeetingIdResponse, UiOpenGlobalPopupResponse } from './types.ui';
|
|
2
2
|
/**
|
|
3
3
|
* @hidden
|
|
4
4
|
* @deprecated
|
|
@@ -84,3 +84,24 @@ export declare function selectCollectionContent(payload?: UiSelectCollectionPlay
|
|
|
84
84
|
* ```
|
|
85
85
|
*/
|
|
86
86
|
export declare function selectAgendaContent(payload?: UiSelectAgendaRequest): Promise<UiSelectAgendaResponse>;
|
|
87
|
+
/**
|
|
88
|
+
* Opens a global popup app by name.
|
|
89
|
+
*
|
|
90
|
+
* @example
|
|
91
|
+
* const api = useApi()
|
|
92
|
+
* api.openGlobalPopup('my-popup-app')
|
|
93
|
+
* api.openGlobalPopup('my-popup-app', { customData: 'value' })
|
|
94
|
+
*
|
|
95
|
+
* @param appName - The name of the app to open (must have app_type: 'ui-global-popup')
|
|
96
|
+
* @param extraContext - Extra context to pass to the app
|
|
97
|
+
* @returns Promise with the result of the operation
|
|
98
|
+
*/
|
|
99
|
+
export declare function openGlobalPopup(appName: string, extraContext?: Record<string, any>): Promise<UiOpenGlobalPopupResponse>;
|
|
100
|
+
/**
|
|
101
|
+
* Closes the currently open global popup app.
|
|
102
|
+
*
|
|
103
|
+
* @example
|
|
104
|
+
* const api = useApi()
|
|
105
|
+
* api.closeGlobalPopup()
|
|
106
|
+
*/
|
|
107
|
+
export declare function closeGlobalPopup(): Promise<void>;
|
|
@@ -155,6 +155,8 @@ declare const _default: {
|
|
|
155
155
|
preselectSfdcMeetingId(payload: import('./types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./types.ui').UiPreselectSfdcMeetingIdResponse>;
|
|
156
156
|
selectCollectionContent(payload?: import('./types.ui').UiSelectCollectionPlayerRequest): Promise<import('./types.ui').UiSelectCollectionPlayerResponse>;
|
|
157
157
|
selectAgendaContent(payload?: import('./types.ui').UiSelectAgendaRequest): Promise<import('./types.ui').UiSelectAgendaResponse>;
|
|
158
|
+
openGlobalPopup(appName: string, extraContext?: Record<string, any>): Promise<import('./types.ui').UiOpenGlobalPopupResponse>;
|
|
159
|
+
closeGlobalPopup(): Promise<void>;
|
|
158
160
|
on: typeof on;
|
|
159
161
|
onMeetingCanceled: typeof onMeetingCanceled;
|
|
160
162
|
onCanvasUpdated: typeof onCanvasUpdated;
|
|
@@ -43,6 +43,8 @@ export declare const UI_API_METHOD_TYPES: {
|
|
|
43
43
|
readonly UI_APP_RESIZE: "ui_app_resize";
|
|
44
44
|
readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution";
|
|
45
45
|
readonly UI_CLOSE_CANVAS_DRAWER: "ui_close_canvas_drawer";
|
|
46
|
+
readonly UI_OPEN_GLOBAL_POPUP: "ui_open_global_popup";
|
|
47
|
+
readonly UI_CLOSE_GLOBAL_POPUP: "ui_close_global_popup";
|
|
46
48
|
};
|
|
47
49
|
export declare const UI_MESSAGE_TYPES: {
|
|
48
50
|
readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
|
|
@@ -319,3 +321,13 @@ export type UiPromptPiaResponseStreamedPayload = {
|
|
|
319
321
|
/** Current chunk of the response */
|
|
320
322
|
chunk: string;
|
|
321
323
|
};
|
|
324
|
+
export interface UiOpenGlobalPopupRequest {
|
|
325
|
+
/** Name of the app to open */
|
|
326
|
+
app_name: string;
|
|
327
|
+
/** Extra context to pass to the app */
|
|
328
|
+
extra_context?: Record<string, any>;
|
|
329
|
+
}
|
|
330
|
+
export interface UiOpenGlobalPopupResponse {
|
|
331
|
+
/** Whether the popup was successfully opened */
|
|
332
|
+
success: boolean;
|
|
333
|
+
}
|
package/lib/sdk/main.d.ts
CHANGED
|
@@ -67,6 +67,8 @@ export declare function useUi(): {
|
|
|
67
67
|
preselectSfdcMeetingId(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
|
|
68
68
|
selectCollectionContent(payload?: import('./api/modules/ui/types.ui').UiSelectCollectionPlayerRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCollectionPlayerResponse>;
|
|
69
69
|
selectAgendaContent(payload?: import('./api/modules/ui/types.ui').UiSelectAgendaRequest): Promise<import('./api/modules/ui/types.ui').UiSelectAgendaResponse>;
|
|
70
|
+
openGlobalPopup(appName: string, extraContext?: Record<string, any>): Promise<import('./api/modules/ui/types.ui').UiOpenGlobalPopupResponse>;
|
|
71
|
+
closeGlobalPopup(): Promise<void>;
|
|
70
72
|
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>;
|
|
71
73
|
onMeetingCanceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
|
|
72
74
|
onCanvasUpdated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
|
|
@@ -452,6 +454,8 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
452
454
|
preselectSfdcMeetingId(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
|
|
453
455
|
selectCollectionContent(payload?: import('./api/modules/ui/types.ui').UiSelectCollectionPlayerRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCollectionPlayerResponse>;
|
|
454
456
|
selectAgendaContent(payload?: import('./api/modules/ui/types.ui').UiSelectAgendaRequest): Promise<import('./api/modules/ui/types.ui').UiSelectAgendaResponse>;
|
|
457
|
+
openGlobalPopup(appName: string, extraContext?: Record<string, any>): Promise<import('./api/modules/ui/types.ui').UiOpenGlobalPopupResponse>;
|
|
458
|
+
closeGlobalPopup(): Promise<void>;
|
|
455
459
|
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>;
|
|
456
460
|
onMeetingCanceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
|
|
457
461
|
onCanvasUpdated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
|
|
@@ -682,6 +686,8 @@ export declare function useApi(options?: ApiOptions): {
|
|
|
682
686
|
preselectSfdcMeetingId(payload: import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./api/modules/ui/types.ui').UiPreselectSfdcMeetingIdResponse>;
|
|
683
687
|
selectCollectionContent(payload?: import('./api/modules/ui/types.ui').UiSelectCollectionPlayerRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCollectionPlayerResponse>;
|
|
684
688
|
selectAgendaContent(payload?: import('./api/modules/ui/types.ui').UiSelectAgendaRequest): Promise<import('./api/modules/ui/types.ui').UiSelectAgendaResponse>;
|
|
689
|
+
openGlobalPopup(appName: string, extraContext?: Record<string, any>): Promise<import('./api/modules/ui/types.ui').UiOpenGlobalPopupResponse>;
|
|
690
|
+
closeGlobalPopup(): Promise<void>;
|
|
685
691
|
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>;
|
|
686
692
|
onMeetingCanceled: (handler: (data: import('./api/modules/ui/types.ui').UiMeetingCanceledPayload) => Promise<void>) => Promise<() => void>;
|
|
687
693
|
onCanvasUpdated: (handler: (data: import('./api/modules/ui/types.ui').UiCanvasUpdatedPayload) => Promise<void>) => Promise<() => void>;
|