@opengeoweb/api 14.0.1 → 14.1.0

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,6 +287,7 @@ var getHeaders = function getHeaders(auth) {
     Accept: 'application/json'
   }, auth ? [] : ['Authorization']);
 };
+// 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/explicit-function-return-type
 var handleResponse = function handleResponse(response) {
   if (response.ok) {
@@ -542,6 +547,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 +653,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.1.0",
   "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.1.0",
+    "@opengeoweb/store": "14.1.0",
     "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/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 {};