@opengeoweb/webmap 9.28.1 → 9.29.1

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

@@ -1,69 +1,69 @@
-import { LayerProps, LayerTree, WMSLayerFromGetCapabilities } from './types';
-import WMListener from './WMListener';
-export declare const wmServiceListener: WMListener;
-export interface GetCapabilitiesJson {
-    WMS_Capabilities?: any;
-    WMT_MS_Capabilities?: any;
-    ServiceExceptionReport?: any;
-}
-export interface Capability {
-    Layer: WMSLayerFromGetCapabilities;
-    Request: any;
-}
-export declare const loadGetCapabilitiesViaProxy: (url: string, succes: (jsonData: GetCapabilitiesJson) => void, fail: (param: string) => void, xml2jsonrequestURL: string) => void;
-export declare const getWMSUrl: (service?: string, additionalParams?: {}) => string;
-/**
- * Global getcapabilities function
- */
-export declare const WMJSGetCapabilities: (service: string, succes: (jsonData: GetCapabilitiesJson) => void, fail: (param: string) => void, options: {
-    headers?: {
-        name: string;
-        value: string;
-    }[];
-}, disableCache?: boolean) => void;
-/**
- * WMJSService Class
- *
- * options:
- *   service
- *   title (optional)
- */
-export declare class WMJSService {
-    id: string;
-    service: string;
-    title: string;
-    onlineresource: string;
-    abstract: string;
-    version: string;
-    getcapabilitiesDoc: GetCapabilitiesJson;
-    busy: boolean;
-    _flatLayerObject: LayerProps[] | undefined;
-    functionCallbackList: any[];
-    _options: any;
-    constructor(options: {
-        service: string;
-        title?: string;
-    });
-    checkVersion111(jsonData: GetCapabilitiesJson): void;
-    checkVersion130(jsonData: GetCapabilitiesJson): void;
-    getCapabilityElement(jsonData: GetCapabilitiesJson): Capability;
-    checkVersion(jsonData: GetCapabilitiesJson): string;
-    /**
-     * Does getcapabilities for a service.
-     * When multple getCapabilities for the same service are made,
-     * this method makes one get request and fires all callbacks with the same result.
-     * @param succescallback Function called upon succes, cannot be left blank
-     * @param failcallback Function called upon failure, cannot be left blank
-     */
-    getCapabilities(succescallback: (jsonData: GetCapabilitiesJson) => void, failcallback: (jsonData: string) => void, forceReload: boolean, options: any): void;
-    checkException(jsonData: GetCapabilitiesJson): string | undefined;
-    /**
-     * Calls succes with a hierarchical node structure
-     * Calls failure with a string when someting goes wrong
-     */
-    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: (layers: LayerProps[]) => void, failure: (message: string) => void, forceReload: boolean, options?: any): void;
-}
+import { LayerProps, LayerTree, WMSLayerFromGetCapabilities } from './types';
+import WMListener from './WMListener';
+export declare const wmServiceListener: WMListener;
+export interface GetCapabilitiesJson {
+    WMS_Capabilities?: any;
+    WMT_MS_Capabilities?: any;
+    ServiceExceptionReport?: any;
+}
+export interface Capability {
+    Layer: WMSLayerFromGetCapabilities;
+    Request: any;
+}
+export declare const loadGetCapabilitiesViaProxy: (url: string, succes: (jsonData: GetCapabilitiesJson) => void, fail: (param: string) => void, xml2jsonrequestURL: string) => void;
+export declare const getWMSUrl: (service?: string, additionalParams?: {}) => string;
+/**
+ * Global getcapabilities function
+ */
+export declare const WMJSGetCapabilities: (service: string, succes: (jsonData: GetCapabilitiesJson) => void, fail: (param: string) => void, options: {
+    headers?: {
+        name: string;
+        value: string;
+    }[];
+}, disableCache?: boolean) => void;
+/**
+ * WMJSService Class
+ *
+ * options:
+ *   service
+ *   title (optional)
+ */
+export declare class WMJSService {
+    id: string;
+    service: string;
+    title: string;
+    onlineresource: string;
+    abstract: string;
+    version: string;
+    getcapabilitiesDoc: GetCapabilitiesJson;
+    busy: boolean;
+    _flatLayerObject: LayerProps[] | undefined;
+    functionCallbackList: any[];
+    _options: any;
+    constructor(options: {
+        service: string;
+        title?: string;
+    });
+    checkVersion111(jsonData: GetCapabilitiesJson): void;
+    checkVersion130(jsonData: GetCapabilitiesJson): void;
+    getCapabilityElement(jsonData: GetCapabilitiesJson): Capability;
+    checkVersion(jsonData: GetCapabilitiesJson): string;
+    /**
+     * Does getcapabilities for a service.
+     * When multple getCapabilities for the same service are made,
+     * this method makes one get request and fires all callbacks with the same result.
+     * @param succescallback Function called upon succes, cannot be left blank
+     * @param failcallback Function called upon failure, cannot be left blank
+     */
+    getCapabilities(succescallback: (jsonData: GetCapabilitiesJson) => void, failcallback: (jsonData: string) => void, forceReload: boolean, options: any): void;
+    checkException(jsonData: GetCapabilitiesJson): string | undefined;
+    /**
+     * Calls succes with a hierarchical node structure
+     * Calls failure with a string when someting goes wrong
+     */
+    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: (layers: LayerProps[]) => void, failure: (message: string) => void, forceReload: boolean, options?: any): void;
+}

package/src/lib/components/WMJSService.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

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

@@ -1,100 +1,100 @@
-import type { Dimension, GeographicBoundingBox, LayerProps, LayerTree, Style, WMSLayerFromGetCapabilities } from './types';
-import type WMLayer from './WMLayer';
-export declare const enableConsoleDebugging = false;
-export declare enum DebugType {
-    Log = 0,
-    Warning = 1,
-    Error = 2
-}
-export declare const debugLogger: (type: DebugType, message: string, ...optionalParam: unknown[]) => void;
-/**
- * Checks if variable is defined or not
- * @param variable The variable to check
- * @returns true if variable is indeed defined, otherwise false.
- */
-export declare const isDefined: <T>(variable?: T | undefined) => variable is T;
-/**
- * Checks if a variable is null or not
- * @param variable The variable to check
- * @returns true if variable is indeed null, otherwise false.
- */
-export declare const isNull: (variable: any) => boolean;
-/**
- * Converts a variable to an array. If the variable is not an array it will be pushed as the first entry in a new array. If the variable is already an array, nothing will  be done.
- * @param array The variable to convert
- * @returns Always an array
- */
-export declare const toArray: (array: unknown | unknown[]) => any[];
-/**
- * Function which checks wether URL contains a ? token. If not, it is assumed that this token was not provided by the user,
- * manually add the token later.
- * @param url The URL to check
- * @return the fixed URL
- */
-export declare const WMJScheckURL: (url: string) => string;
-export declare const preventdefaultEvent: (e: Event) => void;
-export declare const getMouseXCoordinate: (event: MouseEvent) => number;
-export declare const getMouseYCoordinate: (event: MouseEvent) => number;
-export declare const URLDecode: (encodedURL: string) => string;
-export declare const URLEncode: (plaintext: string) => string;
-export declare const getCorrectWMSDimName: (origDimName: string) => string;
-export declare const getMapDimURL: (layer: WMLayer, dimensionOverride?: Dimension[]) => string;
-/**
- * Parses url and then it it allows for setting / changing key value pairs in that URL (From https://stackoverflow.com/questions/5999118/how-can-i-add-or-update-a-query-string-parameter)
- * @param baseUrl
- * @param params
- * @returns
- */
-export declare const getUriWithParam: (baseUrl: string, params?: Record<string, any>) => string;
-/**
- * Parses url and then it it allows for setting additional key value pairs in that URL (From https://stackoverflow.com/questions/5999118/how-can-i-add-or-update-a-query-string-parameter)
- * @param baseUrl
- * @param params
- * @returns
- */
-export declare const getUriAddParam: (baseUrl: string, params: Record<string, any>) => string;
-/**
- * Converts a JS date to a ISO8601 string
- * @param date
- * @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 GetCapabilities 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[];
-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;
+import type { Dimension, GeographicBoundingBox, LayerProps, LayerTree, Style, WMSLayerFromGetCapabilities } from './types';
+import type WMLayer from './WMLayer';
+export declare const enableConsoleDebugging = false;
+export declare enum DebugType {
+    Log = 0,
+    Warning = 1,
+    Error = 2
+}
+export declare const debugLogger: (type: DebugType, message: string, ...optionalParam: unknown[]) => void;
+/**
+ * Checks if variable is defined or not
+ * @param variable The variable to check
+ * @returns true if variable is indeed defined, otherwise false.
+ */
+export declare const isDefined: <T>(variable?: T | undefined) => variable is T;
+/**
+ * Checks if a variable is null or not
+ * @param variable The variable to check
+ * @returns true if variable is indeed null, otherwise false.
+ */
+export declare const isNull: (variable: any) => boolean;
+/**
+ * Converts a variable to an array. If the variable is not an array it will be pushed as the first entry in a new array. If the variable is already an array, nothing will  be done.
+ * @param array The variable to convert
+ * @returns Always an array
+ */
+export declare const toArray: (array: unknown | unknown[]) => any[];
+/**
+ * Function which checks wether URL contains a ? token. If not, it is assumed that this token was not provided by the user,
+ * manually add the token later.
+ * @param url The URL to check
+ * @return the fixed URL
+ */
+export declare const WMJScheckURL: (url: string) => string;
+export declare const preventdefaultEvent: (event: Event) => void;
+export declare const getMouseXCoordinate: (event: MouseEvent) => number;
+export declare const getMouseYCoordinate: (event: MouseEvent) => number;
+export declare const URLDecode: (encodedURL: string) => string;
+export declare const URLEncode: (plaintext: string) => string;
+export declare const getCorrectWMSDimName: (origDimName: string) => string;
+export declare const getMapDimURL: (layer: WMLayer, dimensionOverride?: Dimension[]) => string;
+/**
+ * Parses url and then it it allows for setting / changing key value pairs in that URL (From https://stackoverflow.com/questions/5999118/how-can-i-add-or-update-a-query-string-parameter)
+ * @param baseUrl
+ * @param params
+ * @returns
+ */
+export declare const getUriWithParam: (baseUrl: string, params?: Record<string, any>) => string;
+/**
+ * Parses url and then it it allows for setting additional key value pairs in that URL (From https://stackoverflow.com/questions/5999118/how-can-i-add-or-update-a-query-string-parameter)
+ * @param baseUrl
+ * @param params
+ * @returns
+ */
+export declare const getUriAddParam: (baseUrl: string, params: Record<string, any>) => string;
+/**
+ * Converts a JS date to a ISO8601 string
+ * @param date
+ * @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 GetCapabilities 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[];
+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/src/lib/components/WMJSTools.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};