@soleil-se/app-util 5.6.4 → 5.7.0

package/CHANGELOG.md

@@ -7,6 +7,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [5.7.0] - 2024-05-23
+
+- Add widget support for `fetchJson`.
+
+## [5.6.5] - 2024-01-25
+
+- Fix asynchronous handling of error in `fetchJson`.
+
 ## [5.6.4] - 2024-01-18
 
 - Cast `Packages.java.util.UUID.randomUUID()` to `string`.

package/client/fetch-json/index.js

@@ -16,19 +16,20 @@ async function toJson(response) {
   }
 }
 
-async function handleError(response) {
+async function responseError(response) {
   const json = await toJson(response) || {};
   const error = new Error(json?.message || response?.statusText);
   Object.entries(json).forEach(([key, value]) => {
     error[key] = value;
   });
   error.status = response.status;
-  throw error;
+  return error;
 }
 
 async function handleResponse(response) {
-  if (!response.ok) handleError(response);
-
+  if (!response.ok) {
+    throw await responseError(response);
+  }
   const json = await toJson(response);
   if (!json) {
     throw new Error('Response could not be parsed as JSON.');
@@ -36,13 +37,49 @@ async function handleResponse(response) {
   return json;
 }
 
-export default function fetchJson(uri, { params = {}, retries = 0, ...options } = {}) {
-  return fetch(getUrl(uri, params), options)
+function isWidget() {
+  return window.document.location.pathname.startsWith('/edit-dashboard');
+}
+
+function getWidgetOptions(options) {
+  return {
+    ...options,
+    params: {
+      svAjaxReqParam: 'ajax',
+      ...options.params,
+    },
+    headers: {
+      ...options.headers,
+      'X-Requested-With': 'XMLHttpRequest',
+    },
+  };
+}
+
+/**
+ * Fetches JSON data from a specified URI.
+ * URI:s starting with `/rest-api`, `/appresource`, `/edit-app-config` or a protocol, for example
+ * `https://` will be left as is. Other URI:s willbe converted to match a route in the current app
+ * with `getRouteUri`.
+ *
+ * @param {string} uri - The URI to fetch JSON data from.
+ * @param {object} options - The options for the fetch request, see <https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters>.
+ * @param {string} options.method - The HTTP method to use in the request.
+ * @param {object} options.params - The parameters to be included in the request URL.
+ * @param {object} options.body - The body to include in the request.
+ * @param {number} options.retries - The number of retries to attempt in case of a timeout error.
+ * @param {object} options.headers - The headers to be included in the request.
+ * @returns {Promise<object>} A promise that resolves to the JSON response.
+ * @throws {Error} If the response is not successful or cannot be parsed as JSON.
+ */
+export default function fetchJson(uri, options) {
+  const { params = {}, retries = 0, ...rest } = isWidget() ? getWidgetOptions(options) : options;
+
+  return fetch(getUrl(uri, params), rest)
     .then(handleResponse)
     .catch((error) => {
-      const isTimeout = error.status === 504 || error.status === 408 || error.message.includes('SocketTimeoutException');
+      const isTimeout = error.status === 504 || error.status === 408 || error.message?.includes('SocketTimeoutException');
       if (isTimeout && retries > 0) {
-        return fetchJson(uri, { ...options, params, retries: retries - 1 });
+        return fetchJson(uri, { ...rest, params, retries: retries - 1 });
       }
       // eslint-disable-next-line no-param-reassign
       error.aborted = error.name === 'AbortError';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "5.6.4",
+  "version": "5.7.0",
   "description": "Utility and rendering functions for WebApps.",
   "main": "./common/index.js",
   "author": "Soleil AB",
@@ -14,6 +14,6 @@
   "peerDependencies": {
     "@sitevision/api": "*"
   },
-  "gitHead": "a0b6562f68aa56e089f547d7c3d85ac18a367367",
+  "gitHead": "d555d9d6df015ae9876ff6d7d9c127a14b39a132",
   "dependencies": {}
 }