@opengeoweb/webmap 9.35.0 → 9.35.1-spike-oltanstack.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "9.35.0",
+  "version": "9.35.1-spike-oltanstack.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -9,6 +9,7 @@
   },
   "dependencies": {
     "@opengeoweb/shared": "*",
+    "@tanstack/query-core": "^5.61.5",
     "proj4": "^2.9.2",
     "lodash": "^4.17.21",
     "i18next": "^23.11.5"

package/src/index.d.ts

@@ -1 +1,14 @@
+import WMImageStore from './lib/components/WMImageStore';
+import { mockGetCapabilities } from './lib/specs';
 export * from './lib';
+export * as webmapUtils from './lib/utils/utils';
+export * as webmapTestSettings from './lib/specs';
+export { mockGetCapabilities };
+declare const privateWebMapUtils: {
+    privateWmsGetCapabilities: (serviceUrl: string, headers?: import("./lib").Header[], forceReload?: boolean) => Promise<import("./lib").GetCapabilitiesJson>;
+    privateGetWMSServiceInfo: (getCapabilitiesJson: import("./lib").GetCapabilitiesJson, serviceUrl: string) => import("./lib").WMSServiceInfo;
+    privateWmsGetLayerTree: (jsonData: import("./lib").GetCapabilitiesJson) => import("./lib").LayerTree;
+    privateWmsFlattenLayerTree: (layerTree: import("./lib").LayerTree) => import("./lib").LayerProps[];
+};
+export { privateWebMapUtils };
+export { WMImageStore };

package/src/lib/components/WMJSTools.d.ts

@@ -1,4 +1,4 @@
-import type { Dimension, GeographicBoundingBox, LayerProps, LayerTree, Style, WMSLayerFromGetCapabilities } from './types';
+import type { Dimension, GeographicBoundingBox, LayerProps, Style, WMSLayerFromGetCapabilities } from './types';
 import type WMLayer from './WMLayer';
 export declare const enableConsoleDebugging = false;
 export declare enum DebugType {
@@ -75,12 +75,6 @@ export declare const addBoundingBoxForLayer: (layerObjectFromWMS: WMSLayerFromGe
  * @returns Sorted array.
  */
 export declare function sortArrayOfObjectsByKey<ArrayOfObjects>(array: ArrayOfObjects[], key: string): ArrayOfObjects[];
-/**
- * A LayerTree with deeply nested children will be flattened into a 1D array. Children properties are removed and result is sorted alphabetically by the layers title.
- * @param layerTree a WMS LayerTree
- * @returns Flat array of layers as LayerProps[]
- */
-export declare const flattenLayerTree: (layerTree: LayerTree) => LayerProps[];
 /**
  * Makes a LayerProps object from the WMSLayerFromGetCapabilities and nestedLayerPath
  * @param layer WMSLayerFromGetCapabilities
@@ -90,11 +84,3 @@ export declare const flattenLayerTree: (layerTree: LayerTree) => LayerProps[];
  * @returns
  */
 export declare const makeNodeLayerFromWMSGetCapabilityLayer: (layer: WMSLayerFromGetCapabilities, path?: string[], isleaf?: boolean, nestedLayerPath?: LayerProps[]) => LayerProps;
-/**
- * Builds a standardized LayerTree object based on WMSLayerFromGetCapabilities object.
- * @param wmsLayer The WMSLayerFromGetCapabilities object
- * @param nestedPath - Optional, only to be used by buildLayerTreeFromNestedWMSLayer
- * @param nestedLayerPath - Optional, only to be used by buildLayerTreeFromNestedWMSLayer
- * @returns A LayerTree object.
- */
-export declare const buildLayerTreeFromNestedWMSLayer: (wmsLayer: WMSLayerFromGetCapabilities, nestedPath?: string[], nestedLayerPath?: LayerProps[]) => LayerTree;

package/src/lib/components/WMLayer.d.ts

@@ -1,74 +1,9 @@
 /// <reference types="node" />
-import { FeatureCollection } from 'geojson';
 import type IWMJSMap from './IWMJSMap';
 import WMJSDimension from './WMJSDimension';
 import WMProjection from './WMProjection';
-import { GetCapabilitiesJson } from './WMJSService';
-import { Style, Dimension, LayerProps, GeographicBoundingBox } from './types';
-import type { TileServerSettings } from '../utils/tilesettings';
-export declare enum LayerType {
-    mapLayer = "mapLayer",
-    baseLayer = "baseLayer",
-    overLayer = "overLayer",
-    featureLayer = "featureLayer"
-}
-export interface TiledLayerFoundation {
-    tileServer?: TileServerSettings;
-}
-export interface LayerFoundation extends TiledLayerFoundation {
-    acceptanceTimeInMinutes?: number;
-    dimensions?: Dimension[];
-    enabled?: boolean;
-    format?: string;
-    id?: string;
-    layerType?: LayerType;
-    name?: string;
-    opacity?: number;
-    service?: string;
-    style?: string;
-    title?: string;
-    type?: string;
-    geojson?: FeatureCollection;
-}
-export interface LayerOptions extends LayerFoundation {
-    id: string;
-    layerType: LayerType;
-    service: string;
-    active?: boolean;
-    getgraphinfoURL?: string;
-    currentStyle?: string;
-    sldURL?: string;
-    keepOnTop?: boolean;
-    transparent?: boolean;
-    onReady?: (param: LayerOptions) => void;
-    parentMap?: IWMJSMap;
-    headers?: Headers[];
-    failure?: (layer: WMLayer, message: string) => void;
-    ReactWMJSLayerId?: string;
-    onLayerError?: (layer: WMLayer, error: Error, webmapInstance: IWMJSMap) => void;
-    onLayerReady?: (layer: WMLayer, webmap?: IWMJSMap) => void;
-    geojson?: GeoJSON.FeatureCollection;
-}
-/**
- * Helper function to figure out the dimensions from the WMS layer object (From WMS GetCapabilities). Parses both WMS 1.1.1 and WMS 1.3.0.
- * @param layerObjectFromWMS The corresponding layer object from the WMS GetCapabilities.
- * @param layer THe WMLayer to configure
- * @param layerDimNamesToRemove A set of dimensions names which are flagged for removal, this function removes the dimension from the set if found in the layer.
- */
-export declare const addDimsForLayer: (layerProps: LayerProps, layer: WMLayer, layerDimNamesToRemove: Set<string>) => void;
-/**
- * Helper function to configure the WMS Styles from the WMS GetCapabilities document.
- * @param nestedLayerPath Array of WMS Layers from `[Root WMS Layer] => [Parent(s) WMS Layer] => [This WMS layer]`.
- * @param wmLayer The WMLayer object to configure
- */
-export declare const configureStyles: (layerProps: LayerProps, wmLayer: WMLayer) => void;
-/**
- * Helper function to configure the dimensions for this layer from the WMS GetCapabilities document.
- * @param nestedLayerPath Array of WMS Layers from `[Root WMS Layer] => [Parent(s) WMS Layer] => [This WMS layer]`.
- * @param wmLayer The WMLayer object to configure
- */
-export declare const configureDimensions: (layerProps: LayerProps, wmLayer: WMLayer) => void;
-export declare const configureGeographicBoundingBox: (layerProps: LayerProps, wmLayer: WMLayer) => void;
+import { Style, GeographicBoundingBox, GetCapabilitiesJson } from './types';
+import type { LayerType, LayerOptions } from './WMLayerTypes';
 export default class WMLayer {
     id: string;
     name?: string;
@@ -125,7 +60,7 @@ export default class WMLayer {
     constructor(options?: LayerOptions);
     getLayerName(): string;
     toggleAutoUpdate(): void;
-    setAutoUpdate(val: boolean, interval?: number, callback?: () => void): void;
+    setAutoUpdate(val: boolean, interval?: number): void;
     setOpacity(opacityValue: number): void;
     getOpacity(): number;
     remove(): void;
@@ -134,19 +69,12 @@ export default class WMLayer {
     handleReferenceTime(name: string, value: string, updateMapDimensions?: boolean): void;
     getDimensions(): WMJSDimension[];
     setDimension(name: string, value: string, updateMapDimensions?: boolean): void;
-    __parseGetCapForLayer(getcapabilitiesjson: GetCapabilitiesJson, layerDoneCallback: (layer: WMLayer) => void, fail: (layer: WMLayer, message: string) => void): void;
-    /**
-     * Calls success with a configured layer object
-     * Calls options.failure with error message.
-     * Throws string exceptions when someting goes wrong
-     */
-    parseLayer(_layerDoneCallback: (layer: WMLayer) => void, forceReload: boolean, origin: string): void;
-    /**
-     * A Promise to parse the layer, it will fetch the WMS GetCapabilities document, configure the layer and resolve to a WMLayer object
+    _setWMSGetCapabilities(getCapabilitiesJson: GetCapabilitiesJson): void;
+    /** A Promise to parse the layer, it will fetch the WMS GetCapabilities document, configure the layer and resolve to a WMLayer object
      * @param forceReload Do not use the cache of the WMS GetCapabilities document, but instead fetch new data from the server
      * @returns WMLayer object
      */
-    parseLayerPromise(forceReload?: boolean): Promise<WMLayer>;
+    parseLayer(forceReload?: boolean): Promise<WMLayer>;
     cloneLayer(): WMLayer;
     /**
      * Set or change the name of this layer. This involves re-parsing the WMS GetCapabilities document and updating the affected layer properties. When done, it resolves the WMLayer

package/src/lib/components/WMLayerTypes.d.ts

@@ -0,0 +1,57 @@
+import type { FeatureCollection } from 'geojson';
+import type { TileServerSettings } from '../utils';
+import type IWMJSMap from './IWMJSMap';
+import type { Dimension } from './types';
+import type WMLayer from './WMLayer';
+export declare enum LayerType {
+    mapLayer = "mapLayer",
+    baseLayer = "baseLayer",
+    overLayer = "overLayer",
+    featureLayer = "featureLayer"
+}
+export interface TiledLayerFoundation {
+    tileServer?: TileServerSettings;
+}
+export interface LayerFoundation extends TiledLayerFoundation {
+    acceptanceTimeInMinutes?: number;
+    dimensions?: Dimension[];
+    enabled?: boolean;
+    format?: string;
+    id?: string;
+    layerType?: LayerType;
+    name?: string;
+    opacity?: number;
+    service?: string;
+    style?: string;
+    title?: string;
+    type?: string;
+    geojson?: FeatureCollection;
+}
+export interface LayerOptions extends LayerFoundation {
+    id: string;
+    layerType: LayerType;
+    service: string;
+    getmapURL?: string;
+    active?: boolean;
+    getgraphinfoURL?: string;
+    currentStyle?: string;
+    sldURL?: string;
+    keepOnTop?: boolean;
+    transparent?: boolean;
+    onReady?: (param: LayerOptions) => void;
+    parentMap?: IWMJSMap;
+    headers?: Headers[];
+    failure?: (layer: WMLayer, message: string) => void;
+    ReactWMJSLayerId?: string;
+    onLayerError?: (layer: WMLayer, error: Error, webmapInstance: IWMJSMap) => void;
+    onLayerReady?: (layer: WMLayer, webmap?: IWMJSMap) => void;
+    geojson?: GeoJSON.FeatureCollection;
+}
+export interface WMSLayerDimInfo {
+    name: string;
+    units: string;
+    unitSymbol: string;
+    value: string;
+    default: string;
+    linkDimensionToMap: boolean;
+}

package/src/lib/components/WMLayerUtils.d.ts

@@ -0,0 +1,22 @@
+import { LayerProps } from './types';
+import type WMLayer from './WMLayer';
+/**
+ * Helper function to figure out the dimensions from the WMS layer object (From WMS GetCapabilities). Parses both WMS 1.1.1 and WMS 1.3.0.
+ * @param layerObjectFromWMS The corresponding layer object from the WMS GetCapabilities.
+ * @param layer THe WMLayer to configure
+ * @param layerDimNamesToRemove A set of dimensions names which are flagged for removal, this function removes the dimension from the set if found in the layer.
+ */
+export declare const addDimsForLayer: (layerProps: LayerProps, layer: WMLayer, layerDimNamesToRemove: Set<string>) => void;
+/**
+ * Helper function to configure the WMS Styles from the WMS GetCapabilities document.
+ * @param nestedLayerPath Array of WMS Layers from `[Root WMS Layer] => [Parent(s) WMS Layer] => [This WMS layer]`.
+ * @param wmLayer The WMLayer object to configure
+ */
+export declare const configureStyles: (layerProps: LayerProps, wmLayer: WMLayer) => void;
+/**
+ * Helper function to configure the dimensions for this layer from the WMS GetCapabilities document.
+ * @param nestedLayerPath Array of WMS Layers from `[Root WMS Layer] => [Parent(s) WMS Layer] => [This WMS layer]`.
+ * @param wmLayer The WMLayer object to configure
+ */
+export declare const configureDimensions: (layerProps: LayerProps, wmLayer: WMLayer) => void;
+export declare const configureGeographicBoundingBox: (layerProps: LayerProps, wmLayer: WMLayer) => void;

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

@@ -1,24 +1,27 @@
 import type IWMJSMap from './IWMJSMap';
 import { isDefined, WMJScheckURL, URLDecode, URLEncode, toArray, debugLogger, DebugType, getUriWithParam } from './WMJSTools';
-import WMGetServiceFromStore from './WMGetServiceFromStore';
 import { parseISO8601DateToDate, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration } from './WMTime';
 import WMImage from './WMImage';
 import { getLegendGraphicURLForLayer, legendImageStore } from './WMLegend';
 import { WMImageEventType } from './WMImageStore';
-import { WMJSService, wmServiceListener } from './WMJSService';
 import WMListener from './WMListener';
 import WMJSMap from './WMJSMap';
 import WMProjection from './WMProjection';
+import { LayerType } from './WMLayerTypes';
+import { WMXMLStringToJson } from './WMXMLParser';
 export { default as WMJSDimension, handleDateUtilsISOString, } from './WMJSDimension';
-export { default as WMLayer, LayerType } from './WMLayer';
-export type { LayerOptions, LayerFoundation } from './WMLayer';
+export { default as WMLayer } from './WMLayer';
+export type { LayerOptions, LayerFoundation } from './WMLayerTypes';
+export { LayerType };
 export { default as WMBBOX } from './WMBBOX';
 export type { Bbox } from './WMBBOX';
 export type { WMProjectionWH } from './WMProjection';
 export { WMProjection };
-export { IWMJSMap, WMJSMap, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration, isDefined, WMGetServiceFromStore, WMJScheckURL, URLEncode, URLDecode, parseISO8601DateToDate, toArray, getLegendGraphicURLForLayer, legendImageStore, WMImage, debugLogger, DebugType, WMImageEventType, WMJSService, getUriWithParam, wmServiceListener, WMListener, };
+export { IWMJSMap, WMJSMap, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration, isDefined, WMJScheckURL, URLEncode, URLDecode, parseISO8601DateToDate, toArray, getLegendGraphicURLForLayer, legendImageStore, WMImage, debugLogger, DebugType, WMImageEventType, getUriWithParam, WMListener, WMXMLStringToJson, };
 export * from './types';
 export * from './WMTimeTypes';
 export * from './WMConstants';
 export * from './WMJSMapHelpers';
 export * from './WMCanvasDrawFunctions';
+declare const wmServiceListener: WMListener;
+export { wmServiceListener };

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

@@ -72,7 +72,7 @@ export interface LayerProps {
     name: string | null;
     leaf: boolean;
     path: string[];
-    title: string;
+    title?: string;
     abstract?: string;
     keywords?: string[];
     styles?: Style[];
@@ -172,3 +172,28 @@ export interface IWMProj4 {
     crs: string;
     proj4: typeof proj4;
 }
+export interface GetCapabilitiesJson {
+    WMS_Capabilities?: any;
+    WMT_MS_Capabilities?: any;
+    ServiceExceptionReport?: any;
+}
+export interface WMSServiceInfo {
+    id?: string;
+    version: string;
+    abstract: string;
+    title: string;
+    onlineresource: string;
+    getmapURL: string;
+    getCapabilitiesJson: GetCapabilitiesJson;
+}
+export interface Capability {
+    Layer: WMSLayerFromGetCapabilities;
+    Request: any;
+}
+export interface XLINK {
+    'xlink:href': string;
+}
+export interface Header {
+    name: string;
+    value: string;
+}

package/src/lib/query/queryWMS.d.ts

@@ -0,0 +1,51 @@
+import { GetCapabilitiesJson, LayerProps, LayerTree, WMSServiceInfo } from '../components/types';
+/**
+ * Invalidates the tanstack store for this getcapabilities service. Used to force refetch.
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @returns {Promise<void>}
+ */
+export declare const invalidateWMSGetCapabilities: (serviceUrl: string) => Promise<void>;
+/**
+ * Fetches the WMS GetCapabilities document and converts it to a json object. It is cached by TanStack.
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @returns {Promise<GetCapabilitiesJson>}
+ */
+export declare const queryWMSGetCapabilities: (serviceUrl: string) => Promise<GetCapabilitiesJson>;
+/**
+ * Gets the layer tree in hierarchical order for a WMS service. Cached by TanStack. Uses the same store as in queryWMSGetCapabilities.
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @returns {Promise<LayerTree>}
+ */
+export declare const queryWMSLayersTree: (serviceUrl: string) => Promise<LayerTree>;
+/**
+ * Gets the flat layer list (without hierarchy) for a WMS service. Cached by TanStack. Uses the same store as in queryWMSGetCapabilities.
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @param {boolean} [forceReload=false]
+ * @returns {Promise<LayerProps[]>}
+ */
+export declare const queryWMSLayers: (serviceUrl: string, forceReload?: boolean) => Promise<LayerProps[]>;
+/**
+ * Returns details about the WMS service
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @returns {Promise<WMSServiceInfo>}
+ */
+export declare const queryWMSServiceInfo: (serviceUrl: string) => Promise<WMSServiceInfo>;
+/**
+ * Returns specific layer from the WMS service
+ *
+ * @async
+ * @param {string} serviceUrl
+ * @param {string} name
+ * @returns {Promise<LayerProps>}
+ */
+export declare const queryWMSLayer: (serviceUrl: string, name: string) => Promise<LayerProps>;

package/src/lib/specs/getCapabilitySpecs/WMS130GetCapabilitiesRadarTestWithInheritLayerpropsToLayerTree.d.ts

@@ -0,0 +1,71 @@
+declare const _default: {
+    name: null;
+    title: string;
+    leaf: boolean;
+    path: never[];
+    keywords: never[];
+    abstract: undefined;
+    styles: {
+        title: string;
+        name: string;
+        legendURL: string;
+        abstract: string;
+    }[];
+    dimensions: {
+        name: string;
+        units: string;
+        currentValue: string;
+        values: string;
+        unitSymbol: undefined;
+    }[];
+    geographicBoundingBox: undefined;
+    queryable: boolean;
+    crs: {
+        name: string;
+        bbox: {
+            left: number;
+            right: number;
+            bottom: number;
+            top: number;
+        };
+    }[];
+    children: {
+        name: string;
+        title: string;
+        leaf: boolean;
+        path: string[];
+        keywords: never[];
+        abstract: undefined;
+        styles: {
+            title: string;
+            name: string;
+            legendURL: string;
+            abstract: string;
+        }[];
+        dimensions: {
+            name: string;
+            units: string;
+            currentValue: string;
+            values: string;
+            unitSymbol: undefined;
+        }[];
+        geographicBoundingBox: {
+            east: string;
+            west: string;
+            north: string;
+            south: string;
+        };
+        queryable: boolean;
+        crs: {
+            name: string;
+            bbox: {
+                left: number;
+                right: number;
+                bottom: number;
+                top: number;
+            };
+        }[];
+        children: never[];
+    }[];
+};
+export default _default;