@pitcher/js-api 1.21.0-beta.13 → 1.21.0-beta.15

package/js-api.esm.js

@@ -2974,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;
     },
     {}
@@ -3177,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")
   };
 }
@@ -3204,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",
@@ -3317,6 +3406,10 @@ 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,
@@ -3325,6 +3418,7 @@ const canvasUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 	canvas_navigate_next_page,
 	canvas_navigate_page,
 	canvas_navigate_previous_page,
+	openCanvasOverlay: openCanvasOverlay$1,
 	update_canvas
 }, Symbol.toStringTag, { value: 'Module' }));
 
@@ -3332,6 +3426,10 @@ 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);
@@ -3350,7 +3448,8 @@ const postCallUi = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty
 	complete_postcall,
 	disable_postcall_submit,
 	enable_postcall_submit,
-	set_postcall_style
+	set_postcall_style,
+	stop_meeting
 }, Symbol.toStringTag, { value: 'Module' }));
 
 async function on_native(type, handler) {
@@ -3421,6 +3520,7 @@ const ADMIN_API_METHOD_TYPES = {
   GET_APP_CONFIG: "admin_get_app_config",
   GET_CANVAS: "admin_get_canvas",
   GET_CANVASES: "admin_get_canvases",
+  OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay",
   GET_ENV: "admin_get_env",
   GET_FILE: "admin_get_file",
   GET_FILES: "admin_get_files",
@@ -3461,12 +3561,17 @@ 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' }));