@soleil-se/app-util 5.4.0 → 5.5.0

package/CHANGELOG.md

@@ -5,6 +5,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.5.0] - 2023-08-25
+
+- Remove abort controllers in `fetchJson` since it's better to handle this seperatly case by case.
+
+## [5.4.1] - 2023-08-22
+
+- Add `/edit-app-config` to ignored URI:s in `fetchJson`.
+
 ## [5.4.0] - 2023-08-09
 
 - Add `fetchJson` function to make requests to app routes or other resources.

package/README.md

@@ -230,6 +230,9 @@ Fetch wrapper for calling app routes, rest-api or external resources.
 **Returns**: `Promise<Object>` - Promise containing parsed JSON-data.  
 **Throws** `Error` - Extended error object with custom properties for `status`, `aborted` and other JSON-data returned by the request.
 
+URI:s starting with `/rest-api`, `/appresource`,  `/edit-app-config` or a protocol, for example `https://` will be left as is.  
+Other URI:s will be converted to match a route in the current app with `getRouteUri`.
+
 Most common usage is getting data from a route in the current app.
 
 ```js
@@ -269,15 +272,23 @@ async function getItems() {
 }
 ```
 
-Handle aborted requests called in rapid succession, for example searching when typing.
+When searching on input you probably want to abort the ongoing request to avoid weird bugs when
+the first request might be completed after the subsequent one.  
+Pass an [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) signal
+in options and abort the ongoing call.
 
 ```js
 import { fetchJson } from '@soleil-se/webapp-util/client';
 
+let controller;
+
 async function onInput() {
+  if(controller) controller.abort();
+  controller = new AbortController();
+
   const params = { query: 'foo' };
   try {
-    const result = await fetchJson('/search', { params });
+    const result = await fetchJson('/search', { params, signal: controller.signal });
     console.log(result);
   } catch(e) {
     // Ignore aborts due to new search.

package/client/fetch-json/index.js

@@ -1,7 +1,7 @@
 import { getRouteUri, stringifyParams } from '../../common';
 
 function getUrl(uri, params) {
-  if (uri.startsWith('/rest-api') || uri.startsWith('/appresource') || !uri.startsWith('/')) {
+  if (uri.startsWith('/rest-api') || uri.startsWith('/appresource') || uri.startsWith('/edit-app-config') || !uri.startsWith('/')) {
     return uri + stringifyParams(params, { addQueryPrefix: true });
   }
   return getRouteUri(uri, params);
@@ -29,12 +29,8 @@ async function handleResponse(response) {
   return json;
 }
 
-const controllers = {};
-
 export default function fetchJson(uri, { params = {}, retries = 0, ...options } = {}) {
-  if (controllers[uri]) controllers[uri].abort();
-  controllers[uri] = new AbortController();
-  return fetch(getUrl(uri, params), { signal: controllers[uri].signal, ...options })
+  return fetch(getUrl(uri, params), options)
     .then(handleResponse)
     .catch((error) => {
       const isTimeout = error.status === 504 || error.status === 408 || error.message.includes('SocketTimeoutException');

package/package.json

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