@opengeoweb/webmap-react 19.0.0 → 19.1.1

package/dist/src/lib/geotiff-layer-api/utils/useGetStacGeoTIFFLayerInstance.d.ts

@@ -0,0 +1,11 @@
+import { WMLayer } from '@opengeoweb/webmap';
+import type { OnInitializeLayerProps } from '../../components/OpenLayers/utils/types';
+/**
+ * Returns WMLayer instance in STAC GeoTIFF mode. The layer will contains parsed dimensions and styles and keeps a state for these properties.
+ *
+ * @param {string} serviceUrl
+ * @param {string} name
+ * @returns {(WMLayer | null)}
+ */
+export declare const useGetStacGeoTIFFWMLayerInstance: (serviceUrl: string, name: string, id?: string, onLayerError?: (layerId: string, message: string) => void) => WMLayer | null;
+export declare const useGetStacGeoTIFFLayerInstance: (stacCollectionURL: string, parameter: string, layerId?: string, onInitializeLayer?: (payload: OnInitializeLayerProps) => void) => WMLayer | null;

package/dist/src/lib/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from './useHooksGetCapabilities';
+export * from './useSetInterValWhenVisible';
+export * from './useViewFromLayer';
+export * from './useAnimationForLayer';

package/dist/src/lib/hooks/useAnimationForLayer.d.ts

@@ -0,0 +1,9 @@
+import type { Dimension, RefTimeDimensionModes } from '@opengeoweb/webmap';
+import type { OpenLayersLayerProps } from '../components/OpenLayers/layers';
+import type { TimeContextType } from '../components/OpenLayers/types/Timespan';
+interface UseAnimationForLayerProps {
+    dimensions: Dimension[];
+    timeContext: TimeContextType;
+}
+export declare const useAnimationForLayer: (layerProps: OpenLayersLayerProps, intervalInMs: number, numStepsTillLatest?: number, checkForUpdatesMs?: number, refTimeDimensionModes?: RefTimeDimensionModes) => UseAnimationForLayerProps;
+export {};

package/dist/src/lib/hooks/useHooksGetCapabilities.d.ts

@@ -0,0 +1,63 @@
+import type { UseQueryResult } from '@tanstack/react-query';
+import type { WMSServiceInfo, LayerTree, LayerProps, Style, OGCWMSWMTSGetCapabilities, LayerFoundation } from '@opengeoweb/webmap';
+import { WMLayer } from '@opengeoweb/webmap';
+/**
+ * Queries the WMS GetCapabilities. This is the base TanStack hook for the other hooks in this file.
+ *
+ * @param {string} serviceUrl
+ * @returns {UseQueryResult<WMSGetCapabilities>}
+ */
+export declare const useQueryGetWMSGetCapabilities: (serviceUrl: string) => UseQueryResult<OGCWMSWMTSGetCapabilities>;
+/**
+ * Returns details about the WMS service
+ *
+ * @param {string} serviceUrl
+ * @returns {(WMSServiceInfo | null)}
+ */
+export declare const useQueryGetWMSServiceInfo: (serviceUrl: string) => WMSServiceInfo | null;
+/**
+ * Gets the layer tree in hierarchical order for a WMS service. Cached by TanStack. Uses the same store as in queryWMSGetCapabilities.
+ *
+ * @param {string} serviceUrl
+ * @returns {(LayerTree | null)}
+ */
+export declare const useQueryGetWMSLayersTree: (serviceUrl: string) => LayerTree | null;
+/**
+ * Gets the flat layer list (without hierarchy) for a WMS service. Cached by TanStack. Uses the same store as in queryWMSGetCapabilities.
+ *
+ * @param {string} serviceUrl
+ * @returns {LayerProps[]}
+ */
+export declare const useQueryGetWMSLayers: (serviceUrl: string) => LayerProps[];
+/**
+ * Returns specific layer from the WMS service
+ *
+ * @param {string} serviceUrl
+ * @param {string} name
+ * @returns {(LayerProps | null)}
+ */
+export declare const useQueryGetWMSLayer: (serviceUrl: string, name: string) => LayerProps | null;
+/**
+ * Returns a stylelist for given layer in a service
+ *
+ * @param {string} serviceUrl
+ * @param {string} name
+ * @returns {(Style[] | null)}
+ */
+export declare const useGetWMSLayerStyleList: (serviceUrl: string, name: string) => Style[] | null;
+/**
+ * Returns a WMLayer instance. If the layerType is LayerType.mapLayer or LayerType.wmtsMapLayer, the layer will detect the right type and will contain the parsed dimensions and styles.
+ *
+ * @param layerFoundation
+ * @returns object with wmLayer and if set an errorMessage
+ */
+export declare const useGetWMLayerInstance: (layerFoundation?: LayerFoundation) => {
+    wmLayer: WMLayer | null;
+    errorMessage: string | null;
+};
+/**
+ * Used for querying WMTS GetCapabilities documents
+ * @param serviceUrl
+ * @returns
+ */
+export declare const useQueryWMTSGetCapabilities: (serviceUrl: string) => UseQueryResult<string>;

package/dist/src/lib/hooks/useSetInterValWhenVisible.d.ts

@@ -0,0 +1 @@
+export declare const useSetIntervalWhenVisible: (autoUpdate: () => void, refetchInterval: number, shouldAutoFetch?: boolean) => void;

package/dist/src/lib/hooks/useViewFromLayer.d.ts

@@ -0,0 +1,7 @@
+import { View } from 'ol';
+import type { OpenLayersLayerProps } from '../components/OpenLayers/layers';
+export declare const useViewFromLayer: (layerProps: OpenLayersLayerProps, baseView?: {
+    projection: string;
+    zoom: number;
+    center: number[];
+}) => View;

package/dist/src/lib/index.d.ts

@@ -0,0 +1,8 @@
+export * from './components';
+export * from './layers';
+export * from './hooks';
+export * from './utils';
+export type * from './types';
+export * from './edr-layer-api';
+export * from './geotiff-layer-api';
+export { WEBMAP_REACT_NAMESPACE } from './utils/i18n';

package/dist/src/lib/layers/defaultLayers.d.ts

@@ -0,0 +1,15 @@
+import { LayerType } from '@opengeoweb/webmap';
+export declare const baseLayerGrey: {
+    id: string;
+    name: string;
+    type: string;
+    layerType: LayerType;
+};
+export declare const overLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};

package/dist/src/lib/layers/defaultStorybookSettings.d.ts

@@ -0,0 +1,9 @@
+export declare const initialBbox: {
+    srs: "EPSG:3857";
+    bbox: {
+        left: number;
+        bottom: number;
+        right: number;
+        top: number;
+    };
+};

package/dist/src/lib/layers/index.d.ts

@@ -0,0 +1,3 @@
+export * as publicLayers from './publicLayers';
+export * as defaultLayers from './defaultLayers';
+export * as publicServices from './publicServices';

package/dist/src/lib/layers/profileLayers.d.ts

@@ -0,0 +1,19 @@
+import { LayerType } from '@opengeoweb/webmap';
+/**
+ * Base URL of the adaguc-service where all profiles are configured
+ */
+export declare const profileAdagucServiceBaseUrl = "https://geoservices.knmi.nl";
+/** The station layer with overview of profile datasets */
+export declare const profileStationLayer: {
+    service: string;
+    name: string;
+    style: string;
+    layerType: LayerType;
+};
+export declare const profileDataLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    layerType: LayerType;
+};

package/dist/src/lib/layers/publicLayers.d.ts

@@ -0,0 +1,310 @@
+import { LayerType } from '@opengeoweb/webmap';
+import * as defaultLayers from './defaultLayers';
+export { defaultLayers };
+export declare const baseLayer: {
+    name: string;
+    title: string;
+    type: string;
+    layerType: LayerType;
+    enabled: boolean;
+    id: string;
+};
+export declare const baseLayerOpenStreetMapNL: {
+    id: string;
+    name: string;
+    type: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const baseLayerArcGisCanvas: {
+    service: string;
+    id: string;
+    name: string;
+    type: string;
+    enabled: boolean;
+    layerType: LayerType;
+};
+export declare const baseLayerWorldMap: {
+    id: string;
+    name: string;
+    type: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const baseLayerHeiGit: {
+    service: string;
+    id: string;
+    name: string;
+    layerType: LayerType;
+};
+export declare const msgCppLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    style: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const veiligheidsRegiosGebiedsIndelingenLabels: {
+    service: string;
+    name: string;
+    style: string;
+    enabled: boolean;
+    layerType: LayerType;
+};
+export declare const veiligheidsRegiosGebiedsIndelingen: {
+    service: string;
+    name: string;
+    style: string;
+    enabled: boolean;
+    layerType: LayerType;
+};
+export declare const radarLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    style: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const radarLayerWithError: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    style: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsAirTemperature: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsWind: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsAirPressureAtSeaLevel: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsRelativeHumidity: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsGlobalSolarRadiation: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const obsPrecipitationIntensityPWS: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+};
+export declare const harmonieRelativeHumidityPl: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const harmonieWindPl: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const harmonieAirTemperature: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const harmoniePrecipitation: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const harmoniePressure: {
+    service: string;
+    name: string;
+    id: string;
+    layerType: LayerType;
+    enabled: boolean;
+};
+export declare const harmonieWindFlags: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const klimaatAtlasTG3: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const dwdWarningLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const dwdRadarLayer: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const dwdObservationsWetterLayer: {
+    service: string;
+    name: string;
+    style: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const dwdObservationsWetterLayerWithHeader: {
+    service: string;
+    name: string;
+    style: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+    headers: {
+        name: string;
+        value: string;
+    }[];
+};
+export declare const dwdObservationsWindLayer: {
+    service: string;
+    name: string;
+    style: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const FMITemp: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const MetNoTemp: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const metNorwayWind1: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const metNorwayWind2: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const metNorwayWind3: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const metNorwayLatestT: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const metNorwaySalinaty: {
+    service: string;
+    name: string;
+    format: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgFesEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgNaturalenhncdEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgAshEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgCthEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgFogEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};
+export declare const msgNaturalEUMETSAT: {
+    service: string;
+    name: string;
+    enabled: boolean;
+    id: string;
+    layerType: LayerType;
+};

package/dist/src/lib/layers/publicServices.d.ts

@@ -0,0 +1,90 @@
+export declare const DWD: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const nationaalgeoregister: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const KNMImsgcpp: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const HeiGit: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const ArcGisCanvas: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const KNMIgeoservicesRadar: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const KNMIgeoservicesObs: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const KNMIgeoservicesKlimaatAtlas: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const KNMIgeoservicesHarmonie: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const MetNorwayService: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const FMIopenwms: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const DWDObservations: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const DWDWarnings: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const DWDWXProdukt: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const EUMETSAT: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const eumetviewEUMETSAT: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const ECMWFPublicService: {
+    name: string;
+    url: string;
+    id: string;
+};
+export declare const MeteoCanada: {
+    name: string;
+    url: string;
+    id: string;
+};

package/dist/src/lib/types/index.d.ts

@@ -0,0 +1 @@
+export type * from './types';

package/dist/src/lib/types/types.d.ts

@@ -0,0 +1,64 @@
+import type { Bbox, Dimension } from '@opengeoweb/webmap';
+export interface MapLocation {
+    lat: number;
+    lon: number;
+    screenOffsetX?: number;
+    screenOffsetY?: number;
+    projectionX?: number;
+    projectionY?: number;
+    resolution?: number;
+    srs?: string;
+    id?: string;
+    serviceId?: string;
+    collectionId?: string;
+}
+export interface MapPinLocationPayload {
+    mapId: string;
+    mapPinLocation: MapLocation;
+}
+export interface SetMapDimensionPayload {
+    origin: string;
+    mapId: string;
+    dimension: Dimension;
+}
+export interface SetBboxPayload {
+    mapId: string;
+    bbox: Bbox;
+    srs?: string;
+    origin?: string;
+}
+export interface SetStepBackWardOrForward {
+    mapId: string;
+    isForwardStep: boolean;
+}
+export interface SetLayerDimensionsPayload {
+    layerId: string;
+    origin: string;
+    dimensions: Dimension[];
+}
+export interface UpdateAllMapDimensionsPayload {
+    origin: string;
+    mapId: string;
+    dimensions: Dimension[];
+}
+export interface SetLayerStylePayload {
+    layerId: string;
+    style: string;
+    mapId?: string;
+    origin?: string;
+}
+export interface SetLayerAcceptanceTimePayload {
+    layerId: string;
+    acceptanceTime: number | null;
+    mapId?: string;
+    origin?: string;
+}
+export interface UpdateLayerInfoPayload {
+    origin: string;
+    mapDimensions?: UpdateAllMapDimensionsPayload;
+    layerStyle?: SetLayerStylePayload;
+    layerDimensions?: SetLayerDimensionsPayload;
+    error?: {
+        layerId: string;
+    } | undefined;
+}

package/dist/src/lib/utils/i18n.d.ts

@@ -0,0 +1,8 @@
+import type { Namespace } from 'i18next';
+import i18n from 'i18next';
+import type { UseTranslationResponse } from 'react-i18next';
+export declare const WEBMAP_REACT_NAMESPACE = "webmapreact";
+export declare const initWebmapReactTestI18n: () => void;
+export declare const translateInTestsAndStories: (key: string, params?: Record<string, string | number> | undefined, ns?: string) => string;
+export declare const useWebmapReactTranslation: (ns?: Namespace) => UseTranslationResponse<typeof ns, typeof i18n>;
+export { i18n };

package/dist/src/lib/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './utils';

package/dist/src/lib/utils/utils.d.ts

@@ -0,0 +1,4 @@
+import type { Dimension, WMLayer } from '@opengeoweb/webmap';
+import type { UpdateLayerInfoPayload } from '../types/types';
+export declare function getIsInsideAcceptanceTime(acceptanceTimeInMinutes: number | null | undefined, mapDimensions: Dimension[] | undefined, layerDimensions: Dimension[] | undefined): boolean;
+export declare const getLayerUpdateInfo: (wmLayer: WMLayer, mapId: string) => UpdateLayerInfoPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap-react",
-  "version": "19.0.0",
+  "version": "19.1.1",
   "description": "GeoWeb react wrapper for webmap",
   "license": "Apache-2.0",
   "repository": {
@@ -44,6 +44,7 @@
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]