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

package/js-api.esm.js

@@ -2428,7 +2428,7 @@ function shareCanvas(payload) {
   return this.API.request("share_canvas", payload);
 }
 
-function getFiles(payload) {
+function getFiles$1(payload) {
   const p = { ...payload };
   if (p.type) {
     p.type = Array.isArray(p.type) ? p.type : [p.type];
@@ -2444,11 +2444,12 @@ function getRecentFiles(payload) {
 function downloadFile(payload) {
   return this.API.request("download_file", payload);
 }
-function getAppConfig(payload) {
+function getAppConfig$1(payload) {
   return this.API.request("get_app_config", payload);
 }
-function getFile(payload) {
-  return this.API.request("get_file", payload);
+function getFile$1(payload) {
+  const { id, file_id } = payload;
+  return this.API.request("get_file", { file_id: id || file_id });
 }
 function updateFile(payload) {
   return this.API.request("update_file", payload);
@@ -2484,7 +2485,7 @@ function renderPageAsImage(payload) {
   return this.API.request("render_page_as_image", payload);
 }
 
-function toast$1(payload) {
+function toast$2(payload) {
   return this.API.request("toast", payload);
 }
 
@@ -2563,14 +2564,14 @@ const modules = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 	deleteFolder,
 	downloadFile,
 	fetchDocumentInfo,
-	getAppConfig,
+	getAppConfig: getAppConfig$1,
 	getCanvas: getCanvas$1,
 	getCanvases: getCanvases$1,
 	getEnv: getEnv$2,
 	getEvents,
 	getFavorites,
-	getFile,
-	getFiles,
+	getFile: getFile$1,
+	getFiles: getFiles$1,
 	getFolder,
 	getInstanceMetadataTemplates: getInstanceMetadataTemplates$1,
 	getLanguages,
@@ -2589,7 +2590,7 @@ const modules = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 	selectDeviceFile,
 	shareCanvas,
 	submitUserFeedback,
-	toast: toast$1,
+	toast: toast$2,
 	track,
 	triggerNonFilesSync,
 	updateCanvas: updateCanvas$1,
@@ -2973,13 +2974,10 @@ function createHttpClient(origin, token) {
 }
 
 function normalizeNetworkFilterParams(params) {
+  if (!params) return {};
   return Object.entries(params).reduce(
     (acc, [key, value]) => {
-      if (key.endsWith("__range") && Array.isArray(value)) {
-        acc[key] = value.join(",");
-      } else {
-        acc[key] = value;
-      }
+      acc[key] = key.endsWith("__range") && Array.isArray(value) ? value.join(",") : value;
       return acc;
     },
     {}
@@ -3176,15 +3174,105 @@ function createHighLevelApi(options) {
   return {
     API,
     ...modules,
+    /**
+     * Subscribe to a given event type by its key.
+     *
+     * @param {string} type - The event type to subscribe to.
+     * @param {(payload: PitcherEvent) => void} callback - The callback function to handle the event.
+     * @returns A Promise resolving to a cleanup function to unsubscribe from the event.     * @example
+     *
+     * @example
+     * const unsubscribeFromSectionListUpdate = usePitcherApi().on('entered_fullscreen', (event: object) => {
+     *   // handle event
+     * })
+     * // later
+     * unsubscribeFromSectionListUpdate()
+     */
     on: (type, callback) => eventEmitter.on(type, callback),
+    /**
+     * Unsubscribe from a given event type by its key and the attached callback reference.
+     * @param {string} type - The event type to unsubscribe from.
+     * @param {(payload: PitcherEvent) => void} callback - The callback function reference to remove.
+     *
+     * @example
+     * const callback = (event: object) => {
+     *   // handle event
+     * }
+     * usePitcherApi().on('entered_fullscreen', callback)
+     * // later
+     * usePitcherApi().off('entered_fullscreen', callback)
+     */
     off: (type, callback) => eventEmitter.off(type, callback),
+    /**
+     * Make the entire CatalogIQ fullscreen.
+     *
+     * @example
+     * usePitcherApi().enterFullscreen()
+     */
     enterFullscreen: () => API.request("enter_fullscreen"),
+    /**
+     * Exit fullscreen mode.
+     *
+     * @example
+     * usePitcherApi().exitFullscreen()
+     */
     exitFullscreen: () => API.request("exit_fullscreen"),
+    /**
+     * Return is CatalogIQ in fullscreen.
+     *
+     * @example
+     * usePitcherApi().isFullscreen()
+     */
+    isFullscreen: () => API.request("is_fullscreen"),
+    /**
+     * Log out the current user.
+     *
+     * @example
+     * usePitcherApi().logout()
+     */
     logout: () => API.request("logout"),
+    /**
+     * Quit the current instance and go to the instance selection screen.
+     *
+     * @example
+     * usePitcherApi().quitInstance()
+     */
     quitInstance: () => API.request("quit_instance"),
+    /**
+     * Get the request types.
+     *
+     * @returns {Promise<any>}
+     */
     getRequestTypes: () => API.request("get_request_types"),
+    /**
+     * Broadcast an event to CatalogIQ.
+     * @param {PitcherEvent} event - The event to broadcast.
+     *
+     * @example
+     * usePitcherApi()
+     *   .broadcast({
+     *     type: "canvas_updated",
+     *     body: { context: { myContextProperty: 'test' } },
+     *   })
+     *   .then(function (result) {
+     *     useUi().toast({
+     *       message: "Canvas Populated.",
+     *       type: "info",
+     *     })
+     *   })
+     */
     broadcast: (event) => API.request("broadcast", event),
+    /**
+     * Subscribe to updates.
+     *
+     * @returns {Promise<void>}
+     */
     subscribe: () => API.request("subscribe"),
+    /**
+     * Unsubscribe from updates.
+     *
+     * @returns {Promise<void>}
+     */
     unsubscribe: () => API.request("unsubscribe")
   };
 }
@@ -3203,12 +3291,14 @@ const UI_API_METHOD_TYPES = {
   UI_TOAST: "ui_toast",
   UI_CAPTURE_APP_ERROR: "ui_capture_app_error",
   UI_UPDATE_CANVAS: "ui_update_canvas",
+  UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay",
   UI_UPDATE_LOCATION: "ui_update_location",
   UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id",
   UI_SET_POSTCALL_STYLE: "ui_set_postcall_style",
   UI_ENABLE_POSTCALL_SUBMIT: "ui_enable_postcall_submit",
   UI_DISABLE_POSTCALL_SUBMIT: "ui_disable_postcall_submit",
   UI_COMPLETE_POSTCALL: "ui_complete_postcall",
+  UI_STOP_MEETING: "ui_stop_meeting",
   UI_CANVAS_NAVIGATE_NEXT_PAGE: "ui_canvas_navigate_next_page",
   UI_CANVAS_NAVIGATE_PREVIOUS_PAGE: "ui_canvas_navigate_previous_page",
   UI_CANVAS_NAVIGATE_PAGE: "ui_canvas_navigate_page",
@@ -3245,7 +3335,7 @@ async function open(payload) {
   const pr = await usePostRobot();
   await pr.send(window.parent, UI_API_METHOD_TYPES.UI_OPEN, payload);
 }
-async function toast(payload) {
+async function toast$1(payload) {
   const pr = await usePostRobot();
   await pr.send(window.parent, UI_API_METHOD_TYPES.UI_TOAST, payload);
 }
@@ -3255,21 +3345,45 @@ async function preselect_sfdc_meeting_id(payload) {
   return response.data;
 }
 
+const contentUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	open,
+	preselect_sfdc_meeting_id,
+	select_content,
+	toast: toast$1,
+	ui_select_content
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function embeddable_ready$1() {
   const pr = await usePostRobot();
   await pr.send(window.parent, UI_API_METHOD_TYPES.UI_EMBEDDABLE_READY);
 }
 
+const loadingUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	embeddable_ready: embeddable_ready$1
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function update_location(payload) {
   const pr = await usePostRobot();
   return pr.send(window.top, UI_API_METHOD_TYPES.UI_UPDATE_LOCATION, payload);
 }
 
+const locationUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	update_location
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function capture_app_error(payload) {
   const pr = await usePostRobot();
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_CAPTURE_APP_ERROR, payload);
 }
 
+const appErrorsUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	capture_app_error
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function update_canvas(payload) {
   const pr = await usePostRobot();
   return pr.send(window.parent, UI_API_METHOD_TYPES.UI_UPDATE_CANVAS, payload).then((response) => response.data);
@@ -3292,11 +3406,30 @@ async function canvas_navigate_page(payload) {
   const pr = await usePostRobot();
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_CANVAS_NAVIGATE_PAGE, payload);
 }
+async function openCanvasOverlay$1(payload) {
+  const pr = await usePostRobot();
+  await pr.send(window.parent, UI_API_METHOD_TYPES.UI_OPEN_CANVAS_OVERLAY, payload);
+}
+
+const canvasUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	app_loaded,
+	app_resize,
+	canvas_navigate_next_page,
+	canvas_navigate_page,
+	canvas_navigate_previous_page,
+	openCanvasOverlay: openCanvasOverlay$1,
+	update_canvas
+}, Symbol.toStringTag, { value: 'Module' }));
 
 async function complete_postcall(payload) {
   const pr = await usePostRobot();
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_COMPLETE_POSTCALL, payload);
 }
+async function stop_meeting() {
+  const pr = await usePostRobot();
+  pr.send(window.parent, UI_API_METHOD_TYPES.UI_STOP_MEETING);
+}
 async function enable_postcall_submit() {
   const pr = await usePostRobot();
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_ENABLE_POSTCALL_SUBMIT);
@@ -3310,8 +3443,16 @@ async function set_postcall_style(payload) {
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_SET_POSTCALL_STYLE, payload);
 }
 
+const postCallUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	complete_postcall,
+	disable_postcall_submit,
+	enable_postcall_submit,
+	set_postcall_style,
+	stop_meeting
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function on_native(type, handler) {
-  console.log("attaching native handler for type", type);
   const messageListener = (event) => {
     if (event.data.type === type) {
       handler(event.data.body);
@@ -3350,35 +3491,21 @@ async function ui_broadcast(payload) {
   const pr = await usePostRobot();
   pr.send(window.parent, UI_API_METHOD_TYPES.UI_BROADCAST, payload);
 }
-
-const ui = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
-	__proto__: null,
-	app_loaded,
-	app_resize,
-	canvas_navigate_next_page,
-	canvas_navigate_page,
-	canvas_navigate_previous_page,
-	capture_app_error,
-	complete_postcall,
-	disable_postcall_submit,
-	embeddable_ready: embeddable_ready$1,
-	enable_postcall_submit,
-	on: on$2,
-	on_app_set_data,
-	on_app_update_data,
-	on_canvas_updated,
-	on_meeting_canceled,
-	on_section_list_updated,
-	open,
-	preselect_sfdc_meeting_id,
-	select_content,
-	set_postcall_style,
-	toast,
-	ui_broadcast,
-	ui_select_content,
-	update_canvas,
-	update_location
-}, Symbol.toStringTag, { value: 'Module' }));
+const ui = {
+  on: on$2,
+  on_meeting_canceled,
+  on_canvas_updated,
+  on_section_list_updated,
+  on_app_set_data,
+  on_app_update_data,
+  ui_broadcast,
+  ...contentUi,
+  ...loadingUi,
+  ...locationUi,
+  ...appErrorsUi,
+  ...canvasUi,
+  ...postCallUi
+};
 
 const ADMIN_MESSAGE = "ADMIN_MESSAGE";
 const ADMIN_MESSAGE_TYPES = {
@@ -3390,12 +3517,17 @@ const ADMIN_API_TYPES = {
 };
 const ADMIN_API_METHOD_TYPES = {
   CREATE_CANVAS: "admin_create_canvas",
-  GET_ENV: "admin_get_env",
+  GET_APP_CONFIG: "admin_get_app_config",
   GET_CANVAS: "admin_get_canvas",
   GET_CANVASES: "admin_get_canvases",
-  UPDATE_CANVAS: "admin_update_canvas",
+  OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay",
+  GET_ENV: "admin_get_env",
+  GET_FILE: "admin_get_file",
+  GET_FILES: "admin_get_files",
   GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates",
-  GET_APP_CONFIG: "admin_get_app_config"
+  TOAST: "admin_toast",
+  UPDATE_CANVAS: "admin_update_canvas",
+  SELECT_CONTENT: "admin_select_content"
 };
 
 async function getEnv$1() {
@@ -3404,6 +3536,11 @@ async function getEnv$1() {
   return response.data;
 }
 
+const envAdmin = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	getEnv: getEnv$1
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function createCanvas(payload) {
   const pr = await usePostRobot();
   const response = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.CREATE_CANVAS, payload);
@@ -3424,6 +3561,19 @@ async function updateCanvas(payload) {
   const r = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.UPDATE_CANVAS, payload);
   return r.data;
 }
+async function openCanvasOverlay(payload) {
+  const pr = await usePostRobot();
+  await pr.send(window.parent, ADMIN_API_METHOD_TYPES.OPEN_CANVAS_OVERLAY, payload);
+}
+
+const canvasAdmin = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	createCanvas,
+	getCanvas,
+	getCanvases,
+	openCanvasOverlay,
+	updateCanvas
+}, Symbol.toStringTag, { value: 'Module' }));
 
 async function getInstanceMetadataTemplates(payload) {
   const pr = await usePostRobot();
@@ -3431,23 +3581,58 @@ async function getInstanceMetadataTemplates(payload) {
   return response.data;
 }
 
-async function on$1(type, handler) {
+const metadataTemplatesAdmin = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	getInstanceMetadataTemplates
+}, Symbol.toStringTag, { value: 'Module' }));
+
+async function getAppConfig(payload) {
   const pr = await usePostRobot();
-  const listener = pr.on(type, (e) => handler(e.data));
-  return listener.cancel;
+  const response = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.GET_APP_CONFIG, payload);
+  return response.data;
+}
+async function getFile(payload) {
+  const pr = await usePostRobot();
+  const response = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.GET_FILE, payload);
+  return response.data;
+}
+async function getFiles(payload) {
+  const pr = await usePostRobot();
+  const response = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.GET_FILES, payload);
+  return response.data;
+}
+async function selectContent(payload) {
+  const pr = await usePostRobot();
+  const response = await pr.send(window.parent, ADMIN_API_METHOD_TYPES.SELECT_CONTENT, payload);
+  return response.data;
 }
 
-const admin = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+const filesAdmin = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 	__proto__: null,
-	createCanvas,
-	getCanvas,
-	getCanvases,
-	getEnv: getEnv$1,
-	getInstanceMetadataTemplates,
-	on: on$1,
-	updateCanvas
+	getAppConfig,
+	getFile,
+	getFiles,
+	selectContent
 }, Symbol.toStringTag, { value: 'Module' }));
 
+async function on$1(type, handler) {
+  const pr = await usePostRobot();
+  const listener = pr.on(type, (e) => handler(e.data));
+  return listener.cancel;
+}
+async function toast(payload) {
+  const pr = await usePostRobot();
+  await pr.send(window.parent, ADMIN_API_METHOD_TYPES.TOAST, payload);
+}
+const admin = {
+  on: on$1,
+  toast,
+  ...envAdmin,
+  ...canvasAdmin,
+  ...metadataTemplatesAdmin,
+  ...filesAdmin
+};
+
 const DSR_MESSAGE = "DSR_MESSAGE";
 const DSR_MESSAGE_TYPES = {
   ENV_CHANGED: "dsr_env_changed"
@@ -3467,23 +3652,31 @@ async function getEnv() {
   return response.data;
 }
 
+const envDsr = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	getEnv
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function embeddable_ready() {
   const pr = await usePostRobot();
   await pr.send(window.parent, DSR_API_METHOD_TYPES.DSR_EMBEDDABLE_READY);
 }
 
+const loadingDsr = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
+	__proto__: null,
+	embeddable_ready
+}, Symbol.toStringTag, { value: 'Module' }));
+
 async function on(type, handler) {
   const pr = await usePostRobot();
   const listener = pr.on(type, (e) => handler(e.data));
   return listener.cancel;
 }
-
-const dsr = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
-	__proto__: null,
-	embeddable_ready,
-	getEnv,
-	on
-}, Symbol.toStringTag, { value: 'Module' }));
+const dsr = {
+  on,
+  ...envDsr,
+  ...loadingDsr
+};
 
 let highLevelApi;
 let prevOptions;
@@ -3494,38 +3687,24 @@ function usePitcherApi(options) {
   }
   return highLevelApi;
 }
-const uiApi = Object.entries(
-  ui
-).reduce(
-  (acc, [key, value]) => {
-    acc[key] = value;
-    acc[snakeCase(key)] = value;
-    return acc;
-  },
-  {}
-);
+function enhanceWithSnakeCase(api) {
+  Object.entries(api).forEach(([key, value]) => {
+    const newKey = snakeCase(key);
+    if (newKey && !api[newKey]) {
+      api[newKey] = value;
+    }
+  });
+  return api;
+}
+const uiApi = enhanceWithSnakeCase(ui);
+const adminApi = enhanceWithSnakeCase(admin);
+const dsrApi = enhanceWithSnakeCase(dsr);
 function useUi() {
   return uiApi;
 }
-const adminApi = Object.entries(admin).reduce(
-  (acc, [key, value]) => {
-    acc[key] = value;
-    acc[snakeCase(key)] = value;
-    return acc;
-  },
-  {}
-);
 function useAdmin() {
   return adminApi;
 }
-const dsrApi = Object.entries(dsr).reduce(
-  (acc, [key, value]) => {
-    acc[key] = value;
-    acc[snakeCase(key)] = value;
-    return acc;
-  },
-  {}
-);
 function useDsr() {
   return dsrApi;
 }