@opengeoweb/api 20.0.0 → 20.0.1

package/dist/index.esm.js

@@ -153,46 +153,77 @@ var withJsonFormat = function withJsonFormat(url) {
   urlObj.searchParams.set('f', 'json');
   return urlObj.toString();
 };
-// This function has a copy in libs/webmap-react/src/lib/edr-layer-api/api.ts. This cannot be used there due to circular dependency
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-var handleResponse = /*#__PURE__*/function () {
+/**
+ * Extracts the error message from a non-ok response and throws it, so the
+ * backend message can be shown to the user. Uses `message` from the JSON body
+ * when present, else the stringified body, else the status code. The response
+ * status is set as the error `cause`.
+ */
+var throwResponseError = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(response) {
+    var json, message;
     return _regenerator().w(function (_context) {
       while (1) switch (_context.n) {
+        case 0:
+          _context.n = 1;
+          return response.json()["catch"](function () {
+            return null;
+          });
+        case 1:
+          json = _context.v;
+          if (!json) {
+            _context.n = 3;
+            break;
+          }
+          message = json.message;
+          if (!message) {
+            _context.n = 2;
+            break;
+          }
+          throw new Error(message, {
+            cause: response.status
+          });
+        case 2:
+          throw new Error(JSON.stringify(json), {
+            cause: response.status
+          });
+        case 3:
+          throw new Error("" + response.status, {
+            cause: response.status
+          });
+        case 4:
+          return _context.a(2);
+      }
+    }, _callee);
+  }));
+  return function throwResponseError(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+// This function has a copy in libs/webmap-react/src/lib/edr-layer-api/api.ts. This cannot be used there due to circular dependency
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+var handleResponse = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(response) {
+    return _regenerator().w(function (_context2) {
+      while (1) switch (_context2.n) {
         case 0:
           if (!response.ok) {
-            _context.n = 1;
+            _context2.n = 1;
             break;
           }
-          return _context.a(2, response.json().then(function (json) {
+          return _context2.a(2, response.json().then(function (json) {
             // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             return json != null ? json : response.headers;
           })["catch"](function () {
             // No JSON response
           }));
         case 1:
-          return _context.a(2, response.json()["catch"](function () {
-            // Couldn't parse the JSON
-            throw new Error("" + response.status);
-          }).then(function (json) {
-            // Got valid JSON with error response, use it
-            if (json) {
-              var message = json.message;
-              if (message) {
-                throw new Error(message, {
-                  cause: response.status
-                });
-              }
-              var result = JSON.stringify(json);
-              throw new Error(result);
-            }
-            throw new Error("" + response.status);
-          }));
+          return _context2.a(2, throwResponseError(response));
       }
-    }, _callee);
+    }, _callee2);
   }));
-  return function handleResponse(_x) {
-    return _ref.apply(this, arguments);
+  return function handleResponse(_x2) {
+    return _ref2.apply(this, arguments);
   };
 }();
 var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchInterval) {
@@ -208,13 +239,13 @@ var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchIn
   return useQuery({
     queryKey: queryKey,
     queryFn: function () {
-      var _queryFn2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
-        return _regenerator().w(function (_context2) {
-          while (1) switch (_context2.n) {
+      var _queryFn2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
+        return _regenerator().w(function (_context3) {
+          while (1) switch (_context3.n) {
             case 0:
-              return _context2.a(2, _queryFn(auth));
+              return _context3.a(2, _queryFn(auth));
           }
-        }, _callee2);
+        }, _callee3);
       }));
       function queryFn() {
         return _queryFn2.apply(this, arguments);
@@ -228,12 +259,12 @@ var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchIn
 var optimisticUpdate = function optimisticUpdate(updatedQueryKey, queryClient, _optimisticUpdate, errorCallback) {
   return {
     onMutate: function () {
-      var _onMutate = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(variables) {
+      var _onMutate = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(variables) {
         var previousData, matchesVariables;
-        return _regenerator().w(function (_context3) {
-          while (1) switch (_context3.n) {
+        return _regenerator().w(function (_context4) {
+          while (1) switch (_context4.n) {
             case 0:
-              _context3.n = 1;
+              _context4.n = 1;
               return queryClient.cancelQueries({
                 queryKey: updatedQueryKey,
                 exact: false
@@ -254,21 +285,21 @@ var optimisticUpdate = function optimisticUpdate(updatedQueryKey, queryClient, _
                   return matchesVariables(item) ? _optimisticUpdate(item, variables) : item;
                 });
               });
-              return _context3.a(2, {
+              return _context4.a(2, {
                 previousData: previousData
               });
           }
-        }, _callee3);
+        }, _callee4);
       }));
-      function onMutate(_x2) {
+      function onMutate(_x3) {
         return _onMutate.apply(this, arguments);
       }
       return onMutate;
     }(),
     onError: function onError(err, _, context) {
-      context == null || context.previousData.forEach(function (_ref2) {
-        var queryKey = _ref2[0],
-          data = _ref2[1];
+      context == null || context.previousData.forEach(function (_ref3) {
+        var queryKey = _ref3[0],
+          data = _ref3[1];
         queryClient.setQueryData(queryKey, data);
       });
       if (errorCallback) {
@@ -597,4 +628,4 @@ var QueryClientProviderWrapper = function QueryClientProviderWrapper(_ref) {
 var API_NAMESPACE = 'api';
 // Initialize and create provider if needed
 
-export { API_NAMESPACE, AirmetPhenomena, CloudLevelUnits, Direction, LevelUnits, MovementUnit, ProductStatus, QueryClientProviderWrapper, SigmetPhenomena, VisibilityCause, WindUnit, configureLibraryDefaults, createTestQueryClient, getHeaders, getQueryClient, handleResponse, makeMockApiCall, optimisticUpdate, resetQueryClient, setQueryClient, useAuthQuery, withJsonFormat };
+export { API_NAMESPACE, AirmetPhenomena, CloudLevelUnits, Direction, LevelUnits, MovementUnit, ProductStatus, QueryClientProviderWrapper, SigmetPhenomena, VisibilityCause, WindUnit, configureLibraryDefaults, createTestQueryClient, getHeaders, getQueryClient, handleResponse, makeMockApiCall, optimisticUpdate, resetQueryClient, setQueryClient, throwResponseError, useAuthQuery, withJsonFormat };

package/dist/src/utils.d.ts

@@ -1,7 +1,23 @@
-import type { MutationOptions, QueryClient, QueryKey, UseQueryResult } from '@tanstack/react-query';
+import type { MutationOptions, QueryClient, QueryKey, UseQueryResult, UseMutationResult } from '@tanstack/react-query';
 import type { Credentials } from '@opengeoweb/authentication';
+/**
+ * Return type for mutations with an Error and optional optimistic-update context.
+ *
+ * @typeParam TData - Data returned by the mutation when it succeeds.
+ * @typeParam TVariables - Input passed to mutate or mutateAsync.
+ * @typeParam TContext - Value returned by onMutate and passed to callbacks,
+ * such as previous data used by onError to roll back an optimistic update.
+ */
+export type UseMutationReturnType<TData = unknown, TVariables = void, TContext = unknown> = UseMutationResult<TData, Error, TVariables, TContext>;
 export declare const getHeaders: (auth?: Credentials) => HeadersInit;
 export declare const withJsonFormat: (url: string) => string;
+/**
+ * Extracts the error message from a non-ok response and throws it, so the
+ * backend message can be shown to the user. Uses `message` from the JSON body
+ * when present, else the stringified body, else the status code. The response
+ * status is set as the error `cause`.
+ */
+export declare const throwResponseError: (response: Response) => Promise<never>;
 export declare const handleResponse: (response: Response) => Promise<any>;
 export declare const useAuthQuery: <T>(queryKey: string[], queryFn: (auth: Credentials) => Promise<T>, disabled?: boolean, refetchInterval?: number | false) => UseQueryResult<T>;
 export declare const optimisticUpdate: <U extends {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@opengeoweb/api",
-    "version": "20.0.0",
+    "version": "20.0.1",
     "description": "GeoWeb API library for the opengeoweb project",
     "license": "Apache-2.0",
     "repository": {
@@ -20,8 +20,8 @@
         }
     },
     "dependencies": {
-        "@opengeoweb/authentication": "20.0.0",
-        "@opengeoweb/store": "20.0.0",
+        "@opengeoweb/authentication": "20.0.1",
+        "@opengeoweb/store": "20.0.1",
         "lodash": "^4.18.1",
         "@tanstack/react-query": "^5.85.5",
         "@tanstack/query-core": "^5.79.0",