@opengeoweb/api 9.26.0 → 9.27.1

package/index.esm.js

@@ -1,5 +1,6 @@
-import { getConfig } from '@opengeoweb/authentication';
+import { getConfig, useAuthenticationContext } from '@opengeoweb/authentication';
 export * from '@opengeoweb/authentication';
+import { useQuery } from '@tanstack/react-query';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -2267,6 +2268,189 @@ const getSigmetConfig = auth => {
   }).then(r => r.json());
 };
 
+/* *
+ * 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 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2024 - Finnish Meteorological Institute (FMI)
+ * Copyright 2024 - The Norwegian Meteorological Institute (MET Norway)
+ * */
+/**
+ * ProductStatus is returned by the backend. The backend fills in  this property.
+ * For the backend, it should only need to store 'DRAFT' | 'PUBLISHED' | 'CANCELLED' in its DB.
+ * The backend should derive and return the status 'EXPIRED' from the product properties.
+ *
+ * Note: ProductStatus from the backend should be refreshed regularly to display status updates. */
+var ProductStatus;
+(function (ProductStatus) {
+  ProductStatus["DRAFT"] = "DRAFT";
+  ProductStatus["PUBLISHED"] = "PUBLISHED";
+  ProductStatus["CANCELLED"] = "CANCELLED";
+  ProductStatus["EXPIRED"] = "EXPIRED";
+  ProductStatus["DISCARDED"] = "DISCARDED";
+})(ProductStatus || (ProductStatus = {}));
+var LevelUnits;
+(function (LevelUnits) {
+  LevelUnits["FT"] = "ft";
+  LevelUnits["M"] = "m";
+  LevelUnits["FL"] = "FL";
+})(LevelUnits || (LevelUnits = {}));
+var CloudLevelUnits;
+(function (CloudLevelUnits) {
+  CloudLevelUnits["FT"] = "ft";
+  CloudLevelUnits["M"] = "m";
+})(CloudLevelUnits || (CloudLevelUnits = {}));
+/**
+ * The possible phenomena for the sigmet
+ */
+var SigmetPhenomena;
+(function (SigmetPhenomena) {
+  SigmetPhenomena["EMBD_TS"] = "Embedded thunderstorm(s)";
+  SigmetPhenomena["EMBD_TSGR"] = "Embedded thunderstorm(s) with hail";
+  SigmetPhenomena["FRQ_TS"] = "Frequent thunderstorm(s)";
+  SigmetPhenomena["FRQ_TSGR"] = "Frequent thunderstorm(s) with hail";
+  SigmetPhenomena["HVY_DS"] = "Heavy duststorm";
+  SigmetPhenomena["HVY_SS"] = "Heavy sandstorm";
+  SigmetPhenomena["OBSC_TS"] = "Obscured thunderstorm(s)";
+  SigmetPhenomena["OBSC_TSGR"] = "Obscured thunderstorm(s) with hail";
+  SigmetPhenomena["RDOACT_CLD"] = "Radioactive cloud";
+  SigmetPhenomena["SEV_ICE"] = "Severe icing";
+  SigmetPhenomena["SEV_ICE_FRZ_RN"] = "Severe icing due to freezing rain";
+  SigmetPhenomena["SEV_MTW"] = "Severe mountain wave";
+  SigmetPhenomena["SEV_TURB"] = "Severe turbulence";
+  SigmetPhenomena["SQL_TS"] = "Squall line";
+  SigmetPhenomena["SQL_TSGR"] = "Squall line thunderstorm(s) with hail";
+  // 'TC' = 'Tropical cyclone',     // Don't show this option in the list because it will be not used by KNMI.
+  SigmetPhenomena["VA_CLD"] = "Volcanic ash cloud";
+})(SigmetPhenomena || (SigmetPhenomena = {}));
+/**
+ * The possible phenomena for the airmet
+ */
+var AirmetPhenomena;
+(function (AirmetPhenomena) {
+  AirmetPhenomena["SFC_VIS"] = "Surface visibility";
+  AirmetPhenomena["SFC_WIND"] = "Surface wind";
+  AirmetPhenomena["OVC_CLD"] = "Overcast cloud";
+  AirmetPhenomena["BKN_CLD"] = "Broken cloud";
+  AirmetPhenomena["ISOL_CB"] = "Isolated cumulonimbus cloud";
+  AirmetPhenomena["OCNL_CB"] = "Occasional cumulonimbus cloud";
+  AirmetPhenomena["FRQ_CB"] = "Frequent cumulonimbus cloud";
+  AirmetPhenomena["ISOL_TS"] = "Isolated thunderstorm(s)";
+  AirmetPhenomena["OCNL_TS"] = "Occasional thunderstorm(s)";
+  AirmetPhenomena["ISOL_TSGR"] = "Isolated thunderstorm(s) with hail";
+  AirmetPhenomena["OCNL_TSGR"] = "Occasional thunderstorm(s) with hail";
+  AirmetPhenomena["ISOL_TCU"] = "Isolated towering cumulus cloud";
+  AirmetPhenomena["OCNL_TCU"] = "Occasional towering cumulus cloud";
+  AirmetPhenomena["FRQ_TCU"] = "Frequent towering cumulus cloud";
+  AirmetPhenomena["MOD_ICE"] = "Moderate icing";
+  AirmetPhenomena["MOD_MTW"] = "Moderate mountain wave";
+  AirmetPhenomena["MOD_TURB"] = "Moderate turbulence";
+  AirmetPhenomena["MT_OBSC"] = "Mountains obscured";
+})(AirmetPhenomena || (AirmetPhenomena = {}));
+/* Speed unit, e.g. 'KT', 'KMH' */
+var MovementUnit;
+(function (MovementUnit) {
+  MovementUnit["KT"] = "kt";
+  MovementUnit["KMH"] = "kmh";
+})(MovementUnit || (MovementUnit = {}));
+// can these be unified as SpeedUnit?
+var WindUnit;
+(function (WindUnit) {
+  WindUnit["KT"] = "kt";
+  WindUnit["MPS"] = "mps";
+})(WindUnit || (WindUnit = {}));
+var Direction;
+(function (Direction) {
+  Direction["N"] = "N";
+  Direction["NNE"] = "NNE";
+  Direction["NE"] = "NE";
+  Direction["ENE"] = "ENE";
+  Direction["E"] = "E";
+  Direction["ESE"] = "ESE";
+  Direction["SE"] = "SE";
+  Direction["SSE"] = "SSE";
+  Direction["S"] = "S";
+  Direction["SSW"] = "SSW";
+  Direction["SW"] = "SW";
+  Direction["WSW"] = "WSW";
+  Direction["W"] = "W";
+  Direction["WNW"] = "WNW";
+  Direction["NW"] = "NW";
+  Direction["NNW"] = "NNW";
+})(Direction || (Direction = {}));
+var VisibilityCause;
+(function (VisibilityCause) {
+  VisibilityCause["DZ"] = "Drizzle";
+  VisibilityCause["DU"] = "Dust";
+  VisibilityCause["PO"] = "Dust or sand devil";
+  VisibilityCause["DS"] = "Dust storm";
+  VisibilityCause["FG"] = "Fog";
+  VisibilityCause["FC"] = "Funnel clouds";
+  VisibilityCause["GR"] = "Hail";
+  VisibilityCause["HZ"] = "Haze";
+  VisibilityCause["PL"] = "Ice pellets";
+  VisibilityCause["BR"] = "Mist";
+  VisibilityCause["RA"] = "Rain";
+  VisibilityCause["SA"] = "Sand";
+  VisibilityCause["SS"] = "Sand storm";
+  VisibilityCause["FU"] = "Smoke";
+  VisibilityCause["SN"] = "Snow";
+  VisibilityCause["SG"] = "Snow grains";
+  VisibilityCause["GS"] = "Soft hail";
+  VisibilityCause["SQ"] = "Squalls";
+  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 2024 - Koninklijk Nederlands Meteorologisch Instituut (KNMI)
+ * Copyright 2024 - Finnish Meteorological Institute (FMI)
+ * Copyright 2024 - The Norwegian Meteorological Institute (MET Norway)
+ * */
+const useAirmetList = () => {
+  const {
+    auth
+  } = useAuthenticationContext();
+  const data = useQuery({
+    queryKey: ['airmet-list'],
+    queryFn: () => getAirmetList(auth),
+    enabled: !!auth
+  });
+  return data;
+};
+const useSigmetList = () => {
+  const {
+    auth
+  } = useAuthenticationContext();
+  const data = useQuery({
+    queryKey: ['sigmet-list'],
+    queryFn: () => getSigmetList(auth),
+    enabled: !!auth
+  });
+  return data;
+};
+
 /* *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -2287,4 +2471,4 @@ const getSigmetConfig = auth => {
 const API_NAMESPACE = 'api';
 // Initialize and create provider if needed
 
-export { API_NAMESPACE, getAirmetConfig, getAirmetList, getSigmetConfig, getSigmetList, getlocalProductConfig };
+export { API_NAMESPACE, AirmetPhenomena, CloudLevelUnits, Direction, LevelUnits, MovementUnit, ProductStatus, SigmetPhenomena, VisibilityCause, WindUnit, getAirmetConfig, getAirmetList, getSigmetConfig, getSigmetList, getlocalProductConfig, useAirmetList, useSigmetList };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "9.26.0",
+  "version": "9.27.1",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -9,9 +9,9 @@
   },
   "dependencies": {
     "@opengeoweb/authentication": "*",
-    "@opengeoweb/store": "*"
+    "@opengeoweb/store": "*",
+    "@tanstack/react-query": "^5.52.1"
   },
-  "peerDependencies": {},
   "module": "./index.esm.js",
   "type": "module",
   "main": "./index.esm.js"

package/src/index.d.ts

@@ -1,4 +1,6 @@
 export * from '@opengeoweb/authentication';
 export * from './sigmet-airmet-api/api';
 export * from './sigmet-airmet-api/types';
+export * from './sigmet-airmet-api/definitions';
+export * from './sigmet-airmet-api/hooks';
 export { API_NAMESPACE } from './i18n';

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

@@ -0,0 +1,4 @@
+import { UseQueryResult } from '@tanstack/react-query';
+import { AirmetFromBackend, SigmetFromBackend } from './types';
+export declare const useAirmetList: () => UseQueryResult<AirmetFromBackend[]>;
+export declare const useSigmetList: () => UseQueryResult<SigmetFromBackend[]>;