@opengeoweb/webmap 4.10.0 → 4.12.0

package/lib/components/WMJSService.d.ts

@@ -1,11 +1,11 @@
-import { Dimension, GeographicBoundingBox, Style } from './types';
+import { LayerProps, LayerTree, WMSLayerFromGetCapabilities } from './types';
 export interface GetCapabilitiesJson {
     WMS_Capabilities?: any;
     WMT_MS_Capabilities?: any;
     ServiceExceptionReport?: any;
 }
 export interface Capability {
-    Layer: any;
+    Layer: WMSLayerFromGetCapabilities;
     Request: any;
     Exception?: any;
 }
@@ -17,20 +17,6 @@ export declare const getWMSUrl: (service?: string, additionalParams?: {}) => str
 export declare const WMJSGetCapabilities: (service: string, succes: (param: any) => void, fail: (param: string) => void, options: {
     headers?: any;
 }, disableCache?: boolean) => void;
-interface NodeObject {
-    title: string;
-    leaf: boolean;
-    name?: string;
-    path?: string[];
-    children?: [];
-    keywords?: string[];
-    abstract?: string;
-    styles?: Style[];
-    dimensions?: Dimension[];
-    geographicBoundingBox?: GeographicBoundingBox;
-}
-export declare const sortByKey: (array: NodeObject[], key: string) => NodeObject[];
-export declare const recursivelyFindLayer: (layers: any[], rootNode: any[], path: string[]) => void;
 /**
  * WMJSService Class
  *
@@ -47,7 +33,7 @@ export declare class WMJSService {
     version: string;
     getcapabilitiesDoc: GetCapabilitiesJson;
     busy: boolean;
-    _flatLayerObject: any[];
+    _flatLayerObject: LayerProps[] | undefined;
     functionCallbackList: any[];
     _options: any;
     nodeCache: any;
@@ -72,10 +58,9 @@ export declare class WMJSService {
      * Calls succes with a hierarchical node structure
      * Calls failure with a string when someting goes wrong
      */
-    getNodes(succes: (param: unknown) => void, failure: (param: unknown) => void, forceReload: boolean, options?: unknown): void;
+    getNodes(succes: (layerTreeStructure: LayerTree) => void, failure: (msg: string) => void, forceReload: boolean, options?: unknown): void;
     /** Calls succes with an array of all layerobjects
      * Calls failure when something goes wrong
      */
-    getLayerObjectsFlat(succes: (param: unknown) => void, failure: (param: unknown) => void, forceReload: boolean, options?: any): void;
+    getLayerObjectsFlat(succes: (layers: LayerProps[]) => void, failure: (message: string) => void, forceReload: boolean, options?: any): void;
 }
-export {};

package/lib/components/WMJSTools.d.ts

@@ -1,4 +1,4 @@
-import type { Dimension, GeographicBoundingBox, Style, WMSLayerFromGetCapabilities } from './types';
+import type { Dimension, GeographicBoundingBox, LayerProps, LayerTree, Style, WMSLayerFromGetCapabilities } from './types';
 import type WMLayer from './WMLayer';
 export declare const enableConsoleDebugging = false;
 export declare enum DebugType {
@@ -67,3 +67,34 @@ export declare const dateToISO8601: (date: Date) => string;
 export declare const addStylesForLayer: (layerObjectFromWMS: WMSLayerFromGetCapabilities) => Style[];
 export declare const addDimensionsForLayer: (layerObjectFromWMS: WMSLayerFromGetCapabilities) => Dimension[];
 export declare const addBoundingBoxForLayer: (layerObjectFromWMS: WMSLayerFromGetCapabilities) => GeographicBoundingBox | undefined;
+/**
+ * Sorts an array with objects by object key.
+ *
+ * @param array Array of objects
+ * @param key The key of the object to use for sorting
+ * @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
+ * @param path The path of the layer in the WMS GetCapabilities tree (Array of strings)
+ * @param isleaf Is this a group layer or an actual layer
+ * @param nestedLayerPath The path of the layer in the WMS GetCapabilities, in this case array of 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/lib/components/WMLayer.d.ts

@@ -3,7 +3,7 @@ import type WMJSMap from './WMJSMap';
 import WMJSDimension from './WMJSDimension';
 import WMProjection from './WMProjection';
 import { GetCapabilitiesJson } from './WMJSService';
-import { Style, Dimension, WMSLayerFromGetCapabilities } from './types';
+import { Style, Dimension, LayerProps, GeographicBoundingBox } from './types';
 export declare enum LayerType {
     mapLayer = "mapLayer",
     baseLayer = "baseLayer",
@@ -40,19 +40,20 @@ export interface LayerOptions {
  * @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: (layerObjectFromWMS: WMSLayerFromGetCapabilities, layer: WMLayer, layerDimNamesToRemove: Set<string>) => void;
+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: (nestedLayerPath: WMSLayerFromGetCapabilities[], wmLayer: WMLayer) => void;
+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: (nestedLayerPath: WMSLayerFromGetCapabilities[], wmLayer: WMLayer) => void;
+export declare const configureDimensions: (layerProps: LayerProps, wmLayer: WMLayer) => void;
+export declare const configureGeographicBoundingBox: (layerProps: LayerProps, wmLayer: WMLayer) => void;
 export default class WMLayer {
     id: string;
     name?: string;
@@ -102,6 +103,7 @@ export default class WMLayer {
         colorscalerange: Record<string, unknown>[];
     };
     isConfigured: boolean;
+    geographicBoundingBox?: GeographicBoundingBox;
     init(): void;
     constructor(options?: LayerOptions);
     getLayerName(): string;
@@ -137,10 +139,6 @@ export default class WMLayer {
      * @returns Promise resolving to a WMLayer object
      */
     setName(name: string): Promise<WMLayer>;
-    getLayerRelative(success: (layer: WMLayer, index: number, length: number) => void, failure: (param: string) => void, prevNext: number): void;
-    autoSelectLayer(success: (layer: WMLayer) => void, failure: (param: string) => void): void;
-    getNextLayer(success: (layer: WMLayer, index: number, length: number) => void, failure: (param: string) => void): void;
-    getPreviousLayer(success: (layer: WMLayer, index: number, length: number) => void, failure: (param: string) => void): void;
     /**
      * Sets the style by its name
      * @param style: The name of the style (not the object)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "4.10.0",
+  "version": "4.12.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -14,6 +14,7 @@
   "peerDependencies": {
     "moment": "^2.29.0",
     "throttle-debounce": "^3.0.1",
-    "proj4": "^2.6.2"
+    "proj4": "^2.6.2",
+    "lodash": "^4.17.20"
   }
 }