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

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.
Files changed (44) hide show
  1. package/js-api.esm.js +361 -102
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +10 -10
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/api/canvases/canvases.queries.d.ts +1 -1
  6. package/lib/apps/browser/stores/api.d.ts +53 -53
  7. package/lib/apps/browser/stores/app.d.ts +18 -15
  8. package/lib/apps/browser/stores/upload.d.ts +29 -29
  9. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +607 -621
  10. package/lib/apps/canvas-builder/composables/useCanvasDnd.d.ts +12 -0
  11. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +93 -95
  12. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +1 -0
  13. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +8 -7
  14. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +11 -11
  15. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +5 -4
  16. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +2 -2
  17. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +9 -9
  18. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +13 -10
  19. package/lib/apps/canvas-builder/types/canvas.d.ts +4 -3
  20. package/lib/apps/canvas-builder/util/tree.d.ts +1 -0
  21. package/lib/apps/content-selector/stores/app.d.ts +16 -15
  22. package/lib/components/CFileViewer/CFileViewer.use.d.ts +1 -1
  23. package/lib/composables/bulkActions.use.d.ts +4 -4
  24. package/lib/composables/recentFiles.use.d.ts +1 -1
  25. package/lib/composables/useDetailsView.d.ts +1 -1
  26. package/lib/composables/useLocation.d.ts +1 -1
  27. package/lib/composables/useLocationAPI.d.ts +2 -2
  28. package/lib/composables/useLocationManipulation.d.ts +1 -1
  29. package/lib/composables/useWindowEvents.d.ts +1 -1
  30. package/lib/custom-naive-locales/el.d.ts +1 -1
  31. package/lib/sdk/api/HighLevelApi.d.ts +31 -31
  32. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +6 -1
  33. package/lib/sdk/api/modules/ui/index.d.ts +7 -2
  34. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +4 -1
  35. package/lib/sdk/api/modules/ui/types.ui.d.ts +56 -2
  36. package/lib/sdk/api/onlineRestApiHandlers.d.ts +4 -0
  37. package/lib/sdk/interfaces.d.ts +2 -0
  38. package/lib/sdk/main.d.ts +134 -95
  39. package/lib/sdk/utils/httpFetch.d.ts +15 -0
  40. package/lib/theme/light.d.ts +5 -315
  41. package/lib/types/instanceSettings.d.ts +1 -0
  42. package/lib/types/launchDarkly.types.d.ts +1 -1
  43. package/lib/util/network.d.ts +1 -1
  44. package/package.json +1 -1
package/lib/sdk/main.d.ts CHANGED
@@ -13,6 +13,11 @@ export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
13
13
  export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
14
14
  export declare function useUi(): {
15
15
  on: typeof ui.on;
16
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
17
+ on_canvas_updated: typeof ui.on_canvas_updated;
18
+ on_section_list_updated: typeof ui.on_section_list_updated;
19
+ on_app_set_data: typeof ui.on_app_set_data;
20
+ on_app_update_data: typeof ui.on_app_update_data;
16
21
  ui_broadcast: typeof ui.ui_broadcast;
17
22
  ui_select_content: typeof ui.ui_select_content;
18
23
  select_content: typeof ui.select_content;
@@ -23,8 +28,16 @@ export declare function useUi(): {
23
28
  update_location: typeof ui.update_location;
24
29
  capture_app_error: typeof ui.capture_app_error;
25
30
  update_canvas: typeof ui.update_canvas;
31
+ app_loaded: typeof ui.app_loaded;
32
+ app_resize: typeof ui.app_resize;
33
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
34
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
35
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
26
36
  complete_postcall: typeof ui.complete_postcall;
27
- } & 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.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.complete_postcall>;
37
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
38
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
39
+ set_postcall_style: typeof ui.set_postcall_style;
40
+ } & 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>;
28
41
  export declare function useAdmin(): {
29
42
  on: typeof admin.on;
30
43
  getEnv: typeof admin.getEnv;
@@ -56,8 +69,8 @@ export declare function useApi(): {
56
69
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
57
70
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
58
71
  updateMyUser(payload: {
59
- language?: import('../main.lib').LanguageEnum | undefined;
60
- dark_mode?: boolean | undefined;
72
+ language?: import('../main.lib').LanguageEnum;
73
+ dark_mode?: boolean;
61
74
  }): Promise<import('../main.lib').User>;
62
75
  getLanguages(): Promise<import('./api/modules').Language[]>;
63
76
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -65,58 +78,58 @@ export declare function useApi(): {
65
78
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
66
79
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
67
80
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
68
- filters?: Record<string, any> | undefined;
69
- fields?: string | undefined;
81
+ filters?: Record<string, any>;
82
+ fields?: string;
70
83
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
71
84
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
72
85
  deleteCanvas(payload: {
73
- id: string;
86
+ id: import('../main.lib').Canvas["id"];
74
87
  }): Promise<import('../main.lib').Canvas>;
75
88
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
76
- id: string;
77
- instance_id?: string | undefined;
78
- fields?: string | undefined;
89
+ id: import('../main.lib').Canvas["id"];
90
+ instance_id?: import('../main.lib').Instance["id"];
91
+ fields?: string;
79
92
  }): Promise<import('../main.lib').Canvas>;
80
93
  getCanvas(payload: {
81
- id: string;
82
- fields?: string | undefined;
94
+ id: import('../main.lib').Canvas["id"];
95
+ fields?: string;
83
96
  }): Promise<import('../main.lib').Canvas>;
84
97
  shareCanvas(payload: {
85
- id: string;
98
+ id: import('../main.lib').Canvas["id"];
86
99
  }): Promise<import('../main.lib').SharedLink>;
87
100
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
88
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
101
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
89
102
  downloadFile(payload: {
90
- file_id: string;
103
+ file_id: import('../main.lib').File["id"];
91
104
  }): Promise<null>;
92
105
  getAppConfig(payload: {
93
106
  app_name: string;
94
107
  }): Promise<Record<string, any>>;
95
108
  getFile(payload: {
96
- file_id: string;
109
+ file_id: import('../main.lib').FileRetrieve["id"];
97
110
  }): Promise<import('../main.lib').FileRetrieve>;
98
111
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
99
- id: string;
112
+ id: import('../main.lib').File["id"];
100
113
  }): Promise<import('../main.lib').FileRetrieve>;
101
114
  deleteFile(payload: {
102
- file_id: string;
103
- }): Promise<string>;
115
+ file_id: import('../main.lib').File["id"];
116
+ }): Promise<import('../main.lib').File["id"]>;
104
117
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
105
118
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
106
119
  search(payload: {
107
120
  query: string;
108
- includeExpired?: boolean | undefined;
121
+ includeExpired?: boolean;
109
122
  }): Promise<any>;
110
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
123
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
111
124
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
112
125
  fetchDocumentInfo(payload: {
113
- fileId: string;
126
+ fileId: import('../main.lib').File["id"];
114
127
  }): Promise<{
115
- [key: string]: unknown;
116
128
  pageCount: number;
129
+ [key: string]: unknown;
117
130
  }>;
118
131
  renderPageAsImage(payload: {
119
- fileId: string;
132
+ fileId: import('../main.lib').File["id"];
120
133
  pageNumber: number;
121
134
  params: {
122
135
  width: number;
@@ -130,33 +143,33 @@ export declare function useApi(): {
130
143
  }): Promise<void>;
131
144
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
132
145
  getFolder(payload?: {
133
- id: string;
146
+ id: import('../main.lib').FolderRetrieve["id"];
134
147
  }): Promise<import('../main.lib').FolderRetrieve>;
135
148
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
136
149
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
137
- id: string;
150
+ id: import('../main.lib').Folder["id"];
138
151
  }): Promise<import('../main.lib').FolderRetrieve>;
139
152
  deleteFolder(payload: {
140
- folder_id: string;
153
+ folder_id: import('../main.lib').FolderRetrieve["id"];
141
154
  }): Promise<void>;
142
155
  moveFolderItems(payload: {
143
- target_folder_id: string;
156
+ target_folder_id: import('../main.lib').Folder["id"];
144
157
  items: {
145
- id: string;
146
- type: "file" | "folder";
158
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
159
+ type: "folder" | "file";
147
160
  }[];
148
161
  }): Promise<import('../main.lib').FolderRetrieve>;
149
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
162
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
150
163
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
151
164
  deleteFavorite(payload: {
152
- favorite_id: string;
165
+ favorite_id: import('../main.lib').Favorite["id"];
153
166
  }): Promise<void>;
154
167
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
155
168
  track(payload: {
156
169
  event_name: string;
157
170
  payload: any;
158
171
  }): Promise<any>;
159
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
172
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
160
173
  triggerNonFilesSync(): Promise<void>;
161
174
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
162
175
  close(): Promise<any>;
@@ -177,6 +190,11 @@ export declare function useApi(): {
177
190
  } & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>) | {
178
191
  ui: {
179
192
  on: typeof ui.on;
193
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
194
+ on_canvas_updated: typeof ui.on_canvas_updated;
195
+ on_section_list_updated: typeof ui.on_section_list_updated;
196
+ on_app_set_data: typeof ui.on_app_set_data;
197
+ on_app_update_data: typeof ui.on_app_update_data;
180
198
  ui_broadcast: typeof ui.ui_broadcast;
181
199
  ui_select_content: typeof ui.ui_select_content;
182
200
  select_content: typeof ui.select_content;
@@ -187,8 +205,16 @@ export declare function useApi(): {
187
205
  update_location: typeof ui.update_location;
188
206
  capture_app_error: typeof ui.capture_app_error;
189
207
  update_canvas: typeof ui.update_canvas;
208
+ app_loaded: typeof ui.app_loaded;
209
+ app_resize: typeof ui.app_resize;
210
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
211
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
212
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
190
213
  complete_postcall: typeof ui.complete_postcall;
191
- } & 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.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.complete_postcall>;
214
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
215
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
216
+ set_postcall_style: typeof ui.set_postcall_style;
217
+ } & 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>;
192
218
  impact: {
193
219
  on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
194
220
  off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
@@ -204,8 +230,8 @@ export declare function useApi(): {
204
230
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
205
231
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
206
232
  updateMyUser(payload: {
207
- language?: import('../main.lib').LanguageEnum | undefined;
208
- dark_mode?: boolean | undefined;
233
+ language?: import('../main.lib').LanguageEnum;
234
+ dark_mode?: boolean;
209
235
  }): Promise<import('../main.lib').User>;
210
236
  getLanguages(): Promise<import('./api/modules').Language[]>;
211
237
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -213,58 +239,58 @@ export declare function useApi(): {
213
239
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
214
240
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
215
241
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
216
- filters?: Record<string, any> | undefined;
217
- fields?: string | undefined;
242
+ filters?: Record<string, any>;
243
+ fields?: string;
218
244
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
219
245
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
220
246
  deleteCanvas(payload: {
221
- id: string;
247
+ id: import('../main.lib').Canvas["id"];
222
248
  }): Promise<import('../main.lib').Canvas>;
223
249
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
224
- id: string;
225
- instance_id?: string | undefined;
226
- fields?: string | undefined;
250
+ id: import('../main.lib').Canvas["id"];
251
+ instance_id?: import('../main.lib').Instance["id"];
252
+ fields?: string;
227
253
  }): Promise<import('../main.lib').Canvas>;
228
254
  getCanvas(payload: {
229
- id: string;
230
- fields?: string | undefined;
255
+ id: import('../main.lib').Canvas["id"];
256
+ fields?: string;
231
257
  }): Promise<import('../main.lib').Canvas>;
232
258
  shareCanvas(payload: {
233
- id: string;
259
+ id: import('../main.lib').Canvas["id"];
234
260
  }): Promise<import('../main.lib').SharedLink>;
235
261
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
236
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
262
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
237
263
  downloadFile(payload: {
238
- file_id: string;
264
+ file_id: import('../main.lib').File["id"];
239
265
  }): Promise<null>;
240
266
  getAppConfig(payload: {
241
267
  app_name: string;
242
268
  }): Promise<Record<string, any>>;
243
269
  getFile(payload: {
244
- file_id: string;
270
+ file_id: import('../main.lib').FileRetrieve["id"];
245
271
  }): Promise<import('../main.lib').FileRetrieve>;
246
272
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
247
- id: string;
273
+ id: import('../main.lib').File["id"];
248
274
  }): Promise<import('../main.lib').FileRetrieve>;
249
275
  deleteFile(payload: {
250
- file_id: string;
251
- }): Promise<string>;
276
+ file_id: import('../main.lib').File["id"];
277
+ }): Promise<import('../main.lib').File["id"]>;
252
278
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
253
279
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
254
280
  search(payload: {
255
281
  query: string;
256
- includeExpired?: boolean | undefined;
282
+ includeExpired?: boolean;
257
283
  }): Promise<any>;
258
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
284
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
259
285
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
260
286
  fetchDocumentInfo(payload: {
261
- fileId: string;
287
+ fileId: import('../main.lib').File["id"];
262
288
  }): Promise<{
263
- [key: string]: unknown;
264
289
  pageCount: number;
290
+ [key: string]: unknown;
265
291
  }>;
266
292
  renderPageAsImage(payload: {
267
- fileId: string;
293
+ fileId: import('../main.lib').File["id"];
268
294
  pageNumber: number;
269
295
  params: {
270
296
  width: number;
@@ -278,33 +304,33 @@ export declare function useApi(): {
278
304
  }): Promise<void>;
279
305
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
280
306
  getFolder(payload?: {
281
- id: string;
307
+ id: import('../main.lib').FolderRetrieve["id"];
282
308
  }): Promise<import('../main.lib').FolderRetrieve>;
283
309
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
284
310
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
285
- id: string;
311
+ id: import('../main.lib').Folder["id"];
286
312
  }): Promise<import('../main.lib').FolderRetrieve>;
287
313
  deleteFolder(payload: {
288
- folder_id: string;
314
+ folder_id: import('../main.lib').FolderRetrieve["id"];
289
315
  }): Promise<void>;
290
316
  moveFolderItems(payload: {
291
- target_folder_id: string;
317
+ target_folder_id: import('../main.lib').Folder["id"];
292
318
  items: {
293
- id: string;
294
- type: "file" | "folder";
319
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
320
+ type: "folder" | "file";
295
321
  }[];
296
322
  }): Promise<import('../main.lib').FolderRetrieve>;
297
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
323
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
298
324
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
299
325
  deleteFavorite(payload: {
300
- favorite_id: string;
326
+ favorite_id: import('../main.lib').Favorite["id"];
301
327
  }): Promise<void>;
302
328
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
303
329
  track(payload: {
304
330
  event_name: string;
305
331
  payload: any;
306
332
  }): Promise<any>;
307
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
333
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
308
334
  triggerNonFilesSync(): Promise<void>;
309
335
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
310
336
  close(): Promise<any>;
@@ -312,6 +338,11 @@ export declare function useApi(): {
312
338
  API: import('./api/LowLevelApi').LowLevelApi;
313
339
  };
314
340
  on: typeof ui.on;
341
+ on_meeting_canceled: typeof ui.on_meeting_canceled;
342
+ on_canvas_updated: typeof ui.on_canvas_updated;
343
+ on_section_list_updated: typeof ui.on_section_list_updated;
344
+ on_app_set_data: typeof ui.on_app_set_data;
345
+ on_app_update_data: typeof ui.on_app_update_data;
315
346
  ui_broadcast: typeof ui.ui_broadcast;
316
347
  ui_select_content: typeof ui.ui_select_content;
317
348
  select_content: typeof ui.select_content;
@@ -322,7 +353,15 @@ export declare function useApi(): {
322
353
  update_location: typeof ui.update_location;
323
354
  capture_app_error: typeof ui.capture_app_error;
324
355
  update_canvas: typeof ui.update_canvas;
356
+ app_loaded: typeof ui.app_loaded;
357
+ app_resize: typeof ui.app_resize;
358
+ canvas_navigate_next_page: typeof ui.canvas_navigate_next_page;
359
+ canvas_navigate_previous_page: typeof ui.canvas_navigate_previous_page;
360
+ canvas_navigate_page: typeof ui.canvas_navigate_page;
325
361
  complete_postcall: typeof ui.complete_postcall;
362
+ enable_postcall_submit: typeof ui.enable_postcall_submit;
363
+ disable_postcall_submit: typeof ui.disable_postcall_submit;
364
+ set_postcall_style: typeof ui.set_postcall_style;
326
365
  off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
327
366
  enterFullscreen: () => Promise<any>;
328
367
  exitFullscreen: () => Promise<any>;
@@ -335,8 +374,8 @@ export declare function useApi(): {
335
374
  openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;
336
375
  getEnv(): Promise<import('./interfaces').PitcherEnv>;
337
376
  updateMyUser(payload: {
338
- language?: import('../main.lib').LanguageEnum | undefined;
339
- dark_mode?: boolean | undefined;
377
+ language?: import('../main.lib').LanguageEnum;
378
+ dark_mode?: boolean;
340
379
  }): Promise<import('../main.lib').User>;
341
380
  getLanguages(): Promise<import('./api/modules').Language[]>;
342
381
  getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -344,58 +383,58 @@ export declare function useApi(): {
344
383
  updateEvent(payload: import('../main.lib').PatchedEventRequest): Promise<import('../main.lib').Event>;
345
384
  deleteEvent(payload: Partial<import('../main.lib').Event>): Promise<void>;
346
385
  getCanvases(payload: import('../main.lib').GetCanvasesParams & {
347
- filters?: Record<string, any> | undefined;
348
- fields?: string | undefined;
386
+ filters?: Record<string, any>;
387
+ fields?: string;
349
388
  }): Promise<import('../main.lib').PaginatedData<import('../main.lib').Canvas>>;
350
389
  createCanvas(payload: Omit<import('../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../main.lib').Canvas>;
351
390
  deleteCanvas(payload: {
352
- id: string;
391
+ id: import('../main.lib').Canvas["id"];
353
392
  }): Promise<import('../main.lib').Canvas>;
354
393
  updateCanvas(payload: import('../main.lib').PatchedCanvasUpdateRequest & {
355
- id: string;
356
- instance_id?: string | undefined;
357
- fields?: string | undefined;
394
+ id: import('../main.lib').Canvas["id"];
395
+ instance_id?: import('../main.lib').Instance["id"];
396
+ fields?: string;
358
397
  }): Promise<import('../main.lib').Canvas>;
359
398
  getCanvas(payload: {
360
- id: string;
361
- fields?: string | undefined;
399
+ id: import('../main.lib').Canvas["id"];
400
+ fields?: string;
362
401
  }): Promise<import('../main.lib').Canvas>;
363
402
  shareCanvas(payload: {
364
- id: string;
403
+ id: import('../main.lib').Canvas["id"];
365
404
  }): Promise<import('../main.lib').SharedLink>;
366
405
  getFiles(payload: import('./payload.types').ListFilesPayload): Promise<import('../main.lib').PaginatedFileList>;
367
- getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload | undefined): Promise<import('../main.lib').File[]>;
406
+ getRecentFiles(payload?: import('./payload.types').GetRecentFilesPayload): Promise<import('../main.lib').File[]>;
368
407
  downloadFile(payload: {
369
- file_id: string;
408
+ file_id: import('../main.lib').File["id"];
370
409
  }): Promise<null>;
371
410
  getAppConfig(payload: {
372
411
  app_name: string;
373
412
  }): Promise<Record<string, any>>;
374
413
  getFile(payload: {
375
- file_id: string;
414
+ file_id: import('../main.lib').FileRetrieve["id"];
376
415
  }): Promise<import('../main.lib').FileRetrieve>;
377
416
  updateFile(payload: import('../main.lib').FileUpdateRequest & {
378
- id: string;
417
+ id: import('../main.lib').File["id"];
379
418
  }): Promise<import('../main.lib').FileRetrieve>;
380
419
  deleteFile(payload: {
381
- file_id: string;
382
- }): Promise<string>;
420
+ file_id: import('../main.lib').File["id"];
421
+ }): Promise<import('../main.lib').File["id"]>;
383
422
  createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
384
423
  selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
385
424
  search(payload: {
386
425
  query: string;
387
- includeExpired?: boolean | undefined;
426
+ includeExpired?: boolean;
388
427
  }): Promise<any>;
389
- getUsers(payload?: import('../main.lib').GetUsersParams | undefined): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
428
+ getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
390
429
  refreshServiceToken(payload: import('../main.lib').RefreshServiceTokenRequest): Promise<import('../main.lib').RefreshServiceTokenResponse>;
391
430
  fetchDocumentInfo(payload: {
392
- fileId: string;
431
+ fileId: import('../main.lib').File["id"];
393
432
  }): Promise<{
394
- [key: string]: unknown;
395
433
  pageCount: number;
434
+ [key: string]: unknown;
396
435
  }>;
397
436
  renderPageAsImage(payload: {
398
- fileId: string;
437
+ fileId: import('../main.lib').File["id"];
399
438
  pageNumber: number;
400
439
  params: {
401
440
  width: number;
@@ -405,33 +444,33 @@ export declare function useApi(): {
405
444
  }): Promise<ArrayBuffer>;
406
445
  query(payload: import('./payload.types').QueryPayload): Promise<any>;
407
446
  getFolder(payload?: {
408
- id: string;
447
+ id: import('../main.lib').FolderRetrieve["id"];
409
448
  }): Promise<import('../main.lib').FolderRetrieve>;
410
449
  createFolder(payload: Omit<import('../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../main.lib').FolderRetrieve>;
411
450
  updateFolder(payload: import('../main.lib').FolderUpdateRequest & {
412
- id: string;
451
+ id: import('../main.lib').Folder["id"];
413
452
  }): Promise<import('../main.lib').FolderRetrieve>;
414
453
  deleteFolder(payload: {
415
- folder_id: string;
454
+ folder_id: import('../main.lib').FolderRetrieve["id"];
416
455
  }): Promise<void>;
417
456
  moveFolderItems(payload: {
418
- target_folder_id: string;
457
+ target_folder_id: import('../main.lib').Folder["id"];
419
458
  items: {
420
- id: string;
421
- type: "file" | "folder";
459
+ id: import('../main.lib').File["id"] | import('../main.lib').Folder["id"];
460
+ type: "folder" | "file";
422
461
  }[];
423
462
  }): Promise<import('../main.lib').FolderRetrieve>;
424
- getFavorites(payload?: import('../main.lib').GetFavoritesParams | undefined): Promise<import('../main.lib').PaginatedFavoriteList>;
463
+ getFavorites(payload?: import('../main.lib').GetFavoritesParams): Promise<import('../main.lib').PaginatedFavoriteList>;
425
464
  createFavorite(payload: import('../main.lib').FavoriteCreateRequest): Promise<import('../main.lib').Favorite>;
426
465
  deleteFavorite(payload: {
427
- favorite_id: string;
466
+ favorite_id: import('../main.lib').Favorite["id"];
428
467
  }): Promise<void>;
429
468
  notify(payload: import('./payload.types').NotificationPayload): Promise<void>;
430
469
  track(payload: {
431
470
  event_name: string;
432
471
  payload: any;
433
472
  }): Promise<any>;
434
- getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
473
+ getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
435
474
  triggerNonFilesSync(): Promise<void>;
436
475
  submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
437
476
  close(): Promise<any>;
package/lib/sdk/utils/httpFetch.d.ts ADDED
@@ -0,0 +1,15 @@
1
+ type FetchOptions = {
2
+ method?: string;
3
+ headers?: Record<string, string>;
4
+ body?: string;
5
+ credentials?: RequestCredentials;
6
+ params?: Record<string, any>;
7
+ };
8
+ export declare function createHttpClient(origin: string, token: string): {
9
+ get: (endpoint: string, options?: FetchOptions) => Promise<any>;
10
+ post: (endpoint: string, body: object, options?: FetchOptions) => Promise<any>;
11
+ put: (endpoint: string, body: object, options?: FetchOptions) => Promise<any>;
12
+ delete: (endpoint: string, options?: FetchOptions) => Promise<any>;
13
+ patch: (endpoint: string, body: object, options?: FetchOptions) => Promise<any>;
14
+ };
15
+ export {};