@opengeoweb/api 14.0.1 → 14.2.1

package/index.esm.js

@@ -1,8 +1,12 @@
 import { useAuthenticationContext } from '@opengeoweb/authentication';
 export * from '@opengeoweb/authentication';
-import { useQuery } from '@tanstack/react-query';
+import { useQuery, QueryClientProvider } from '@tanstack/react-query';
 import { omit } from 'lodash';
 import { HttpResponse, delay } from 'msw';
+import { jsxs, jsx } from 'react/jsx-runtime';
+import { ReactQueryDevtools } from '@tanstack/react-query-devtools';
+import React from 'react';
+import { QueryClient, keepPreviousData } from '@tanstack/query-core';
 
 function _OverloadYield(e, d) {
   this.v = e, this.k = d;
@@ -283,33 +287,51 @@ var getHeaders = function getHeaders(auth) {
     Accept: 'application/json'
   }, auth ? [] : ['Authorization']);
 };
-// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-var handleResponse = function handleResponse(response) {
-  if (response.ok) {
-    return response.json().then(function (json) {
-      return json || response.headers;
-    })["catch"](function () {
-      // No JSON response
-    });
-  }
-  return 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
-        });
+// 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 _ref = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(response) {
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          if (!response.ok) {
+            _context.next = 2;
+            break;
+          }
+          return _context.abrupt("return", 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 2:
+          return _context.abrupt("return", 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);
+          }));
+        case 3:
+        case "end":
+          return _context.stop();
       }
-      var result = JSON.stringify(json);
-      throw new Error(result);
-    }
-    throw new Error("" + response.status);
-  });
-};
+    }, _callee);
+  }));
+  return function handleResponse(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
 var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchInterval) {
   if (disabled === void 0) {
     disabled = false;
@@ -322,9 +344,23 @@ var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchIn
   var enabled = !!auth && !disabled;
   return useQuery({
     queryKey: queryKey,
-    queryFn: function queryFn() {
-      return _queryFn(auth);
-    },
+    queryFn: function () {
+      var _queryFn2 = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+        return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              return _context2.abrupt("return", _queryFn(auth));
+            case 1:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2);
+      }));
+      function queryFn() {
+        return _queryFn2.apply(this, arguments);
+      }
+      return queryFn;
+    }(),
     enabled: enabled,
     refetchInterval: refetchInterval
   });
@@ -332,10 +368,10 @@ var useAuthQuery = function useAuthQuery(queryKey, _queryFn, disabled, refetchIn
 var optimisticUpdate = function optimisticUpdate(updatedQueryKey, queryClient, _optimisticUpdate, errorCallback) {
   return {
     onMutate: function () {
-      var _onMutate = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(variables) {
+      var _onMutate = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee3(variables) {
         var oldData;
-        return _regeneratorRuntime().wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regeneratorRuntime().wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
               void queryClient.cancelQueries({
                 queryKey: updatedQueryKey
@@ -348,16 +384,16 @@ var optimisticUpdate = function optimisticUpdate(updatedQueryKey, queryClient, _
                   });
                 });
               }
-              return _context.abrupt("return", {
+              return _context3.abrupt("return", {
                 oldData: oldData
               });
             case 4:
             case "end":
-              return _context.stop();
+              return _context3.stop();
           }
-        }, _callee);
+        }, _callee3);
       }));
-      function onMutate(_x) {
+      function onMutate(_x2) {
         return _onMutate.apply(this, arguments);
       }
       return onMutate;
@@ -393,9 +429,17 @@ var makeMockApiCall = function makeMockApiCall(response, responseInit, delayDura
       }, _callee);
     })));
   }
-  return jest.fn().mockImplementation(function () {
-    return Promise.resolve(HttpResponse.json(response, responseInit));
-  });
+  return jest.fn().mockImplementation(/*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2() {
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          return _context2.abrupt("return", Promise.resolve(HttpResponse.json(response, responseInit)));
+        case 1:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
 };
 
 /* *
@@ -542,6 +586,92 @@ var VisibilityCause;
   VisibilityCause["VA"] = "Volcanic Ash";
 })(VisibilityCause || (VisibilityCause = {}));
 
+/* *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Copyright 2025 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2025 - Finnish Meteorological Institute (FMI)
+ * Copyright 2025 - The Norwegian Meteorological Institute (MET Norway)
+ * */
+var queryClientInstance = null;
+var getQueryClient = function getQueryClient() {
+  var _queryClientInstance;
+  (_queryClientInstance = queryClientInstance) != null ? _queryClientInstance : queryClientInstance = new QueryClient({
+    defaultOptions: {
+      queries: {
+        refetchOnWindowFocus: false,
+        refetchOnMount: false,
+        refetchOnReconnect: false,
+        refetchInterval: false,
+        placeholderData: keepPreviousData,
+        staleTime: 1000 * 60 * 5
+      }
+    }
+  });
+  return queryClientInstance;
+};
+var setQueryClient = function setQueryClient(client) {
+  queryClientInstance = client;
+};
+var configureLibraryDefaults = function configureLibraryDefaults(queryKeyPrefix, options) {
+  var client = getQueryClient();
+  client.setQueryDefaults(queryKeyPrefix, options);
+};
+var createTestQueryClient = function createTestQueryClient(overrides) {
+  var client = new QueryClient({
+    defaultOptions: {
+      queries: Object.assign({
+        retry: false,
+        staleTime: 0,
+        refetchOnWindowFocus: false,
+        refetchOnMount: false,
+        refetchOnReconnect: false,
+        refetchInterval: false
+      }, overrides == null ? void 0 : overrides.queries),
+      mutations: Object.assign({
+        retry: false
+      }, overrides == null ? void 0 : overrides.mutations)
+    }
+  });
+  setQueryClient(client);
+  return client;
+};
+var resetQueryClient = function resetQueryClient() {
+  var _queryClientInstance2;
+  (_queryClientInstance2 = queryClientInstance) == null || _queryClientInstance2.clear();
+  queryClientInstance = null;
+};
+
+var QueryClientProviderWrapper = function QueryClientProviderWrapper(_ref) {
+  var client = _ref.client,
+    children = _ref.children,
+    _ref$mode = _ref.mode,
+    mode = _ref$mode === void 0 ? 'production' : _ref$mode;
+  var queryClient = React.useMemo(function () {
+    if (client) {
+      setQueryClient(client);
+      return client;
+    }
+    return mode === 'test' ? createTestQueryClient() : getQueryClient();
+  }, [client, mode]);
+  return jsxs(QueryClientProvider, {
+    client: queryClient,
+    children: [children, jsx(ReactQueryDevtools, {
+      initialIsOpen: false
+    })]
+  });
+};
+
 /* *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -562,4 +692,4 @@ var VisibilityCause;
 var API_NAMESPACE = 'api';
 // Initialize and create provider if needed
 
-export { API_NAMESPACE, AirmetPhenomena, CloudLevelUnits, Direction, LevelUnits, MovementUnit, ProductStatus, SigmetPhenomena, VisibilityCause, WindUnit, getHeaders, handleResponse, makeMockApiCall, optimisticUpdate, useAuthQuery };
+export { API_NAMESPACE, AirmetPhenomena, CloudLevelUnits, Direction, LevelUnits, MovementUnit, ProductStatus, QueryClientProviderWrapper, SigmetPhenomena, VisibilityCause, WindUnit, configureLibraryDefaults, createTestQueryClient, getHeaders, getQueryClient, handleResponse, makeMockApiCall, optimisticUpdate, resetQueryClient, setQueryClient, useAuthQuery };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "14.0.1",
+  "version": "14.2.1",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -8,10 +8,13 @@
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
   "dependencies": {
-    "@opengeoweb/authentication": "14.0.1",
-    "@opengeoweb/store": "14.0.1",
+    "@opengeoweb/authentication": "14.2.1",
+    "@opengeoweb/store": "14.2.1",
     "lodash": "^4.17.21",
-    "@tanstack/react-query": "^5.85.5"
+    "@tanstack/react-query": "^5.85.5",
+    "@tanstack/query-core": "^5.79.0",
+    "react": "^18.3.1",
+    "@tanstack/react-query-devtools": "5.90.2"
   },
   "module": "./index.esm.js",
   "type": "module",

package/src/fakeApi.d.ts

@@ -1,2 +1,2 @@
-import { HttpResponseInit, JsonBodyType } from 'msw';
+import type { HttpResponseInit, JsonBodyType } from 'msw';
 export declare const makeMockApiCall: (response: JsonBodyType, responseInit?: HttpResponseInit, delayDuration?: number) => jest.Mock;

package/src/index.d.ts

@@ -1,7 +1,8 @@
 export * from '@opengeoweb/authentication';
 export * from './utils';
 export * from './fakeApi';
-export * from './sigmet-airmet-api/types';
+export type * from './sigmet-airmet-api/types';
 export * from './sigmet-airmet-api/definitions';
-export * from './sigmet-airmet-api/config-types';
+export type * from './sigmet-airmet-api/config-types';
+export * from './query-client';
 export { API_NAMESPACE } from './i18n';

package/src/query-client/QueryClientProviderWrapper.d.ts

@@ -0,0 +1,9 @@
+import type { QueryClient } from '@tanstack/query-core';
+import React from 'react';
+interface QueryClientProviderWrapperProps {
+    client?: QueryClient;
+    children: React.ReactNode;
+    mode?: 'test' | 'production';
+}
+export declare const QueryClientProviderWrapper: ({ client, children, mode, }: QueryClientProviderWrapperProps) => React.ReactElement;
+export {};

package/src/query-client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './QueryClientProviderWrapper';
+export * from './queryClient';

package/src/query-client/queryClient.d.ts

@@ -0,0 +1,10 @@
+import type { DefaultOptions } from '@tanstack/query-core';
+import { QueryClient } from '@tanstack/query-core';
+export declare const getQueryClient: () => QueryClient;
+export declare const setQueryClient: (client: QueryClient) => void;
+export declare const configureLibraryDefaults: (queryKeyPrefix: string[], options: DefaultOptions["queries"]) => void;
+export declare const createTestQueryClient: (overrides?: {
+    queries?: DefaultOptions["queries"];
+    mutations?: DefaultOptions["mutations"];
+}) => QueryClient;
+export declare const resetQueryClient: () => void;

package/src/query-client/queryClient.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/sigmet-airmet-api/config-types.d.ts

@@ -1,4 +1,4 @@
-import { MapPreset } from '@opengeoweb/store';
+import type { MapPreset } from '@opengeoweb/store';
 export interface AllowedUnits {
     unit_type: string;
     allowed_units: string[];

package/src/sigmet-airmet-api/types.d.ts

@@ -1,4 +1,4 @@
-import { AirmetMovementType, AirmetPhenomena, ATSRLocation, ATSULocation, Change, CloudLevelInfoMode, CloudLevelUnits, DateType, Direction, ICAOLocation, LevelInfoMode, LevelUnits, MovementUnit, MWOLocation, ObservationOrForcast, ProductCanbe, ProductSequenceId, ProductStatus, SigmetMovementType, SigmetPhenomena, VisibilityCause, VisibilityUnit, WindUnit } from './definitions';
+import type { AirmetMovementType, AirmetPhenomena, ATSRLocation, ATSULocation, Change, CloudLevelInfoMode, CloudLevelUnits, DateType, Direction, ICAOLocation, LevelInfoMode, LevelUnits, MovementUnit, MWOLocation, ObservationOrForcast, ProductCanbe, ProductSequenceId, ProductStatus, SigmetMovementType, SigmetPhenomena, VisibilityCause, VisibilityUnit, WindUnit } from './definitions';
 export interface LevelType {
     value: number;
     unit: LevelUnits;

package/src/utils.d.ts

@@ -1,5 +1,5 @@
-import { MutationOptions, QueryClient, UseQueryResult } from '@tanstack/react-query';
-import { Credentials } from '@opengeoweb/authentication';
+import type { MutationOptions, QueryClient, UseQueryResult } from '@tanstack/react-query';
+import type { Credentials } from '@opengeoweb/authentication';
 export declare const getHeaders: (auth?: Credentials) => HeadersInit;
 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>;