@opengeoweb/webmap 2.1.2 → 2.2.0

package/lib/components/WMCanvasBuffer.d.ts

@@ -18,6 +18,7 @@ interface CanvasBBOX {
 export interface CanvasGeoLayer {
     bbox: CanvasBBOX;
     opacity: number;
+    imageAge: number;
     imageSource: string;
 }
 /**
@@ -49,12 +50,11 @@ export declare const getSharedImagesList: () => Record<string, CanvasGeoLayer[]>
  */
 export declare const geClosestBBox: (rect1: CanvasBBOX, rect2: CanvasBBOX) => number;
 /**
- * Sort the imageslist by overlapping area, highest area first
+ * Sort the imageslist by imagedate, newewst image first.
  * @param imagesList
- * @param bbox
  * @returns
  */
-export declare const sortByOverlappingArea: (imagesList: CanvasGeoLayer[], bbox: CanvasBBOX) => CanvasGeoLayer[];
+export declare const sortByImageDate: (imagesList: CanvasGeoLayer[]) => CanvasGeoLayer[];
 /**
  * Function to find the an alternative available image for an image url that is not yet loaded
  * @param imageUrl The image source / url to find an alternative for
@@ -62,7 +62,7 @@ export declare const sortByOverlappingArea: (imagesList: CanvasGeoLayer[], bbox:
  * @param bbox The boundingbox to search this image for
  * @returns A canvasLayer, containing the new image source with its geo properties
  */
-export declare const getAlternativeImage: (imageUrl: string, imageStore: WMImageStore, bbox: CanvasBBOX) => CanvasGeoLayer;
+export declare const getAlternativeImage: (imageUrl: string, imageStore: WMImageStore, _bbox: CanvasBBOX) => CanvasGeoLayer;
 export default class WMCanvasBuffer {
     canvas: HTMLCanvasElement;
     _ctx: CanvasRenderingContext2D;

package/lib/components/WMGetServiceFromStore.d.ts

@@ -1,3 +1,3 @@
 import { WMJSService } from './WMJSService';
-declare const WMGetServiceFromStore: (serviceName: string, xml2jsonrequestURL?: string) => WMJSService;
+declare const WMGetServiceFromStore: (serviceName: string) => WMJSService;
 export default WMGetServiceFromStore;

package/lib/components/WMImage.d.ts

@@ -2,6 +2,11 @@ export interface WMImageOptions {
     randomizer?: boolean;
     headers: Headers[];
 }
+/**
+ * Returns the current time in ms
+ * @returns the current time in ms
+ */
+export declare const getCurrentImageTime: () => number;
 /**
  * WMImage provides an API to the HTML image element. It is used for caching and easier access to images.
  */
@@ -16,6 +21,8 @@ export default class WMImage {
     loadEventCallback: (image: WMImage) => void;
     el: HTMLImageElement;
     headers: Headers[];
+    _imageTimeStampAtError: number;
+    _numFailedAttempts: number;
     /**
      *
      * @param src Optionally set the source URL to load
@@ -32,6 +39,15 @@ export default class WMImage {
      * Returns true if the image is still loading
      */
     isLoading(): boolean;
+    /**
+     * Get the amount of milliseconds since the image experienced an image load.
+     * @returns milliseconds since the image had an error
+     */
+    getLastErrorMSecondsAgo(): number;
+    /**
+     * @returns The number of failed attempts for this image
+     */
+    getNumFailedAttempts(): number;
     /**
      * Set source of image, but it will not load the image yet.
      * @param src URL of the image to load
@@ -54,6 +70,7 @@ export default class WMImage {
      * Start loading the image
      */
     load(): void;
+    forceReload(): void;
     private _getImageWithHeaders;
     private _load;
     private _loadEvent;

package/lib/components/WMJSDimension.d.ts

@@ -1,3 +1,4 @@
+import { DateInterval } from './WMTime';
 interface WMJSDimensionConfig {
     name?: string;
     units?: string;
@@ -24,15 +25,15 @@ export default class WMJSDimension {
     synced: boolean;
     used?: boolean;
     values?: string;
-    timeRangeDuration?: any;
+    private timeRangeDuration?;
     private _initialized;
     private _timeRangeDurationDate;
     private _allDates;
     private _type;
     private _allValues;
-    dimMinValue: string;
-    dimMaxValue: string;
-    dimTimeInterval: any;
+    private dimMinValue;
+    private dimMaxValue;
+    private dimTimeInterval;
     constructor(config?: WMJSDimensionConfig);
     generateAllValues(): number[];
     setTimeValuesForReferenceTime(referenceTimeValueToSet: string, referenceTimeDim: WMJSDimension): void;
@@ -49,6 +50,11 @@ export default class WMJSDimension {
      * @param forceValue When set to false,check if the given value is outside range, and do nothing if this is the case
      */
     setValue(value: string, forceValue?: boolean): void;
+    /**
+     * Returns values of the dimension, according to values defined in WMS specification, e.g. 2011-01-01T00:00:00Z/2012-01-01T00:00:00Z/P1M or list of values.
+     * @returns
+     */
+    getValues(): string;
     setClosestValue(newValue?: any, evenWhenOutsideRange?: boolean): void;
     addTimeRangeDurationToValue(value: string): string;
     setTimeRangeDuration(duration: string): void;
@@ -57,6 +63,11 @@ export default class WMJSDimension {
      * Get dimension value for specified index
      */
     getValueForIndex(index: number): string;
+    /**
+     * Hint about the timestep size / time resolution of this dimension.
+     * @returns The dimTimeInterval
+     */
+    getDimInterval(): DateInterval;
     /**
      * Shorthand functionf or getValueForIndex
      */

package/lib/components/WMJSMap.d.ts

@@ -109,13 +109,11 @@ export default class WMJSMap {
     private proj4;
     private previousMouseButtonState;
     private longlat;
-    xml2jsonrequest: string;
     private tileRenderSettings;
     private drawPending;
     private needsRedraw;
     private buildLayerDimsBusy;
     constructor(_element: HTMLElement);
-    setXML2JSONURL(_xml2jsonrequest: string): void;
     setWMTileRendererTileSettings(_WMTileRendererTileSettings: unknown): void;
     /**
      * Function which make a component ID which is unique over several WebMapJS instances

package/lib/components/WMJSService.d.ts

@@ -1,3 +1,4 @@
+import { Style } from './types';
 export interface GetCapabilitiesJson {
     WMS_Capabilities?: any;
     WMT_MS_Capabilities?: any;
@@ -13,26 +14,26 @@ export declare const getWMSUrl: (service?: string, additionalParams?: {}) => str
 /**
  * Global getcapabilities function
  */
-export declare const WMJSGetCapabilities: (service: string, succes: (param: any) => void, fail: (param: string) => void, xml2jsonrequestURL: string, options: {
+export declare const WMJSGetCapabilities: (service: string, succes: (param: any) => void, fail: (param: string) => void, options: {
     headers?: any;
 }, disableCache?: boolean) => void;
 interface NodeObject {
     text: string;
     leaf: boolean;
     name?: string;
-    path?: string;
+    path?: string[];
     children?: [];
     keywords?: string[];
     abstract?: string;
+    styles?: Style[];
 }
 export declare const sortByKey: (array: NodeObject[], key: string) => NodeObject[];
-export declare const recursivelyFindLayer: (layers: any[], rootNode: any[], path: string) => void;
+export declare const recursivelyFindLayer: (layers: any[], rootNode: any[], path: string[]) => void;
 /**
  * WMJSService Class
  *
  * options:
  *   service
- *   xml2jsonrequestURL
  *   title (optional)
  */
 export declare class WMJSService {
@@ -44,13 +45,11 @@ export declare class WMJSService {
     getcapabilitiesDoc: GetCapabilitiesJson;
     busy: boolean;
     _flatLayerObject: any[];
-    xml2jsonrequestURL: string;
     functionCallbackList: any[];
     _options: any;
     nodeCache: any;
     constructor(options: {
         service: string;
-        xml2jsonrequestURL: string;
         title?: string;
     });
     checkVersion111(jsonData: GetCapabilitiesJson): void;
@@ -64,16 +63,16 @@ export declare class WMJSService {
      * @param succescallback Function called upon succes, cannot be left blank
      * @param failcallback Function called upon failure, cannot be left blank
      */
-    getCapabilities(succescallback: (param: GetCapabilitiesJson) => void, failcallback: (param: unknown) => void, forceReload: boolean, xml2jsonrequestURL: string, options: unknown): void;
+    getCapabilities(succescallback: (param: GetCapabilitiesJson) => void, failcallback: (param: unknown) => void, forceReload: boolean, options: unknown): void;
     checkException(jsonData: GetCapabilitiesJson): string | undefined;
     /**
      * 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, xml2jsonrequestURL?: string, options?: unknown): void;
+    getNodes(succes: (param: unknown) => void, failure: (param: unknown) => 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, xml2jsonrequestURL?: string, options?: any): void;
+    getLayerObjectsFlat(succes: (param: unknown) => void, failure: (param: unknown) => void, forceReload: boolean, options?: any): void;
 }
 export {};

package/lib/components/WMJSTools.d.ts

@@ -1,3 +1,4 @@
+import type { Style, WMSLayerFromGetCapabilities } from './types';
 import type WMLayer from './WMLayer';
 export declare const enableConsoleDebugging = false;
 export declare enum DebugType {
@@ -58,3 +59,9 @@ export declare const getUriAddParam: (baseUrl: string, params: Record<string, an
  * @returns ISO8601 string
  */
 export declare const dateToISO8601: (date: Date) => string;
+/**
+ * Helper function to figure out the styles from the WMS layer object from the WMS GetCapabilties document
+ * @param layerObjectFromWMS The layer object from the WMS GetCapabilities JSON document
+ * @returns Style[] Array of style objects.
+ */
+export declare const addStylesForLayer: (layerObjectFromWMS: WMSLayerFromGetCapabilities) => Style[];

package/lib/components/WMLayer.d.ts

@@ -1,11 +1,9 @@
-/// <reference types="react" />
 /// <reference types="node" />
 import type WMJSMap from './WMJSMap';
 import WMJSDimension from './WMJSDimension';
 import WMProjection from './WMProjection';
-import WMImage from './WMImage';
-import { GetCapabilitiesJson, WMJSService } from './WMJSService';
-import { Style, Dimension } from './types';
+import { GetCapabilitiesJson } from './WMJSService';
+import { Style, Dimension, WMSLayerFromGetCapabilities } from './types';
 export declare enum LayerType {
     mapLayer = "mapLayer",
     baseLayer = "baseLayer",
@@ -29,27 +27,13 @@ export interface LayerOptions {
     transparent?: boolean;
     onReady?: (param: any) => void;
     type?: string;
-    parentMaps?: WMJSMap[];
+    parentMap?: WMJSMap;
     dimensions?: Dimension[];
     headers?: Headers[];
     failure?: (layer: WMLayer, message: string) => void;
     ReactWMJSLayerId?: string;
     onLayerError?: (layer: WMLayer, error: Error, webmapInstance: WMJSMap) => void;
 }
-/**
- * This interface is for reading from the WMS GetCapabilties document, which can have different structures for V1.1.1 and V1.3.0
- */
-interface WMSLayerFromGetCapabilities {
-    Dimension: unknown;
-    Style: unknown;
-    Extent: unknown;
-}
-/**
- * Helper function to figure out the styles from the WMS layer object from the WMS GetCapabilties document
- * @param layerStyles The layer styles object from the WMS GetCapabilities
- * @param layer The WMLayer to configure
- */
-export declare const addStylesForLayer: (layerObjectFromWMS: WMSLayerFromGetCapabilities, layer: WMLayer) => void;
 /**
  * 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.
@@ -73,7 +57,6 @@ export default class WMLayer {
     id: string;
     name?: string;
     ReactWMJSLayerId?: string;
-    reactWebMapJSLayer?: React.ReactElement;
     hasError?: boolean;
     enabled?: boolean;
     lastError?: string;
@@ -83,7 +66,6 @@ export default class WMLayer {
     service: string;
     layerType: LayerType;
     currentStyle?: string;
-    image?: WMImage;
     linkedInfo: {
         layer: string;
         message: string;
@@ -91,7 +73,6 @@ export default class WMLayer {
     headers: Headers[];
     autoupdate: boolean;
     timer: NodeJS.Timeout;
-    WMJSService: WMJSService;
     getmapURL: string;
     getfeatureinfoURL: string;
     getlegendgraphicURL: string;
@@ -107,9 +88,8 @@ export default class WMLayer {
     projectionProperties: WMProjection[];
     queryable: boolean;
     styles: Style[];
-    getCapabilitiesDoc: GetCapabilitiesJson;
     serviceTitle: string;
-    parentMaps: WMJSMap[];
+    parentMap: WMJSMap;
     sldURL: string;
     active: boolean;
     getgraphinfoURL: string;
@@ -121,7 +101,6 @@ export default class WMLayer {
         url: string;
         colorscalerange: Record<string, unknown>[];
     };
-    jsonlayer: this;
     isConfigured: boolean;
     init(): void;
     constructor(options?: LayerOptions);
@@ -138,13 +117,13 @@ export default class WMLayer {
     handleReferenceTime(name: string, value: string, updateMapDimensions?: boolean): void;
     getDimensions(): WMJSDimension[];
     setDimension(name: string, value: string, updateMapDimensions?: boolean): void;
-    __parseGetCapForLayer(layer: WMLayer, getcapabilitiesjson: GetCapabilitiesJson, layerDoneCallback: (layer: WMLayer) => void, fail: (layer: WMLayer, message: string) => void): 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, xml2jsonrequest?: string): void;
+    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
      * @param forceReload Do not use the cache of the WMS GetCapabilties document, but instead fetch new data from the server
@@ -198,4 +177,3 @@ export default class WMLayer {
     setSLDURL(url: string): void;
     display(displayornot: boolean): void;
 }
-export {};

package/lib/components/types.d.ts

@@ -1,6 +1,6 @@
-import WMJSDimension from './WMJSDimension';
+import type WMJSDimension from './WMJSDimension';
 import type WMLayer from './WMLayer';
-import { DateInterval } from './WMTime';
+import type { DateInterval } from './WMTime';
 export declare type WMPosition = {
     x: number;
     y: number;
@@ -35,3 +35,11 @@ export declare type WMLayerType = {
     title?: string;
     headers?: Headers[];
 };
+/**
+ * This interface is for reading from the WMS GetCapabilties document, which can have different structures for V1.1.1 and V1.3.0
+ */
+export interface WMSLayerFromGetCapabilities {
+    Dimension: unknown;
+    Style: unknown;
+    Extent: unknown;
+}

package/package.json

@@ -1,21 +1,21 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
-  "main": "./webmap.umd.js",
-  "module": "./webmap.esm.js",
+  "main": "./index.umd.js",
+  "module": "./index.esm.js",
   "typings": "./index.d.ts",
   "dependencies": {},
   "peerDependencies": {
     "moment": "^2.29.0",
     "throttle-debounce": "^3.0.1",
     "proj4": "^2.6.2",
-    "react": "16.14.0",
-    "@material-ui/core": "^4.11.0"
+    "react": "^17.0.2",
+    "@mui/styles": "^5.2.3"
   }
 }