@opengeoweb/webmap 19.1.0 → 19.1.1

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

@@ -0,0 +1,22 @@
+import type { 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/dist/src/lib/components/WMLegend.d.ts

@@ -0,0 +1,6 @@
+import WMImageStore from './WMImageStore';
+import type WMLayer from './WMLayer';
+export declare const legendImageStore: WMImageStore;
+export declare const getLegendGraphicURLForLayer: (layer: WMLayer, width?: number, height?: number) => string;
+export declare const getLegendImageStore: () => WMImageStore;
+export declare const drawLegend: (canvasContext: CanvasRenderingContext2D, width: number, height: number, layers: WMLayer[]) => void;

package/dist/src/lib/components/WMListener.d.ts

@@ -0,0 +1,57 @@
+export default class WMListener {
+    private registeredEvents;
+    private _suspendedEvents;
+    private _suspendAllEvents;
+    constructor();
+    /**
+     * Remove events by name and function.
+     * @param name Event name
+     * @param fn  Function pointer to check
+     */
+    removeEventListener(name: string, fn: (param?: unknown) => unknown): number;
+    /**
+     * Remove all events by name
+     * @param name Event name
+     */
+    removeEventListeners(name: string): number;
+    /**
+     * Add multiple functions which will be called after the event with the same name is triggered
+     * @param name: The name of the event to register
+     * @param function: The function to trigger
+     * @param keepOnCall: When false, this event name and function combination is removed once triggered.
+     *                    When true Otherwise keep the event and allow it to be triggered multiple times
+     * @return: true if the event is registerd, false if it already was registered
+     */
+    addEventListener(name: string, functionpointer: (param: unknown) => void, keepOnCall?: boolean): boolean;
+    /**
+     * Destroys this listener, deregistering all events
+     */
+    destroy(): void;
+    /**
+     * Suspend a specific event by name, triggers will not be called
+     * @param name
+     */
+    suspendEvent(name: string): void;
+    /**
+     * Resume a specific event by name, resuming normal operation
+     * @param name
+     */
+    resumeEvent(name: string): void;
+    /**
+     * This listener will not listen to any triggers
+     */
+    suspendEvents(): void;
+    /**
+     * Resume event listening
+     */
+    resumeEvents(): void;
+    /**
+     * Trigger an event with custom parameters
+     * @param name The name of the event to trigger
+     * @param param The parameters to provide to the associated function
+     * @returns The results of the function.
+     */
+    triggerEvent(name: string, param?: unknown): unknown[];
+    private removeFinishedEvents;
+    removeEvents(name: string, fn?: (param?: unknown) => unknown): number;
+}

package/dist/src/lib/components/WMProjection.d.ts

@@ -0,0 +1,17 @@
+import type { Bbox } from './WMBBOX';
+import WMBBOX from './WMBBOX';
+/**
+ * WMProjection Class
+ * Keep all projection information, by a bbox and an srs value.
+ */
+export default class WMProjection {
+    bbox: WMBBOX;
+    srs: string;
+    constructor();
+}
+export interface WMProjectionWH {
+    bbox: Bbox;
+    srs: string;
+    width: number;
+    height: number;
+}

package/dist/src/lib/components/WMTime.d.ts

@@ -0,0 +1,44 @@
+import type { TimeInterval } from './types';
+import type { CustomDate } from './WMTimeTypes';
+/** ************************************************ */
+/** ************************************************ */
+export declare class DateInterval implements TimeInterval {
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    minute: number;
+    second: number;
+    isRegularInterval: boolean;
+    constructor(year: string, month: string, day: string, hour: string, minute: string, second: string);
+    getTime(): number;
+    toISO8601(): string;
+}
+export declare const isValidISOTime: (isotime: string) => boolean;
+export declare const parseTimeValue: (value: string) => number;
+export declare const getTimeValues: (isotime: string) => number[];
+/** ************************************************* */
+/** ************************************************* */
+export declare const parseISO8601DateToDate: (unvalidatedIsotime: string) => CustomDate;
+/** ****************************************************** */
+/** ****************************************************** */
+export declare const parseISO8601IntervalToDateInterval: (_isotime: string) => DateInterval;
+export declare function isTimeOnIntervalStep(time: Date, intervalStart: Date, interval: DateInterval): boolean;
+/** ******************************************************* */
+/** ******************************************************* */
+export declare function getNumberOfTimeSteps(starttime: CustomDate, stoptime: CustomDate, interval: DateInterval): number;
+export declare class ParseISOTimeRangeDuration {
+    private initialized;
+    startTime: CustomDate;
+    stopTime: CustomDate;
+    timeInterval: DateInterval;
+    timeSteps: number;
+    constructor(isoTimeRangeDuration: string, defaultInterval?: string);
+    getTimeSteps(): number;
+    getDateAtTimeStep(currentStep: number): CustomDate;
+    getTimeStepFromISODate(currentISODate: string, throwIfOutsideRange: boolean): number;
+    getTimeStepFromDate(wantedDate: CustomDate, throwIfOutsideRange?: boolean): number;
+    getTimeStepFromDateWithinRange(currentDate: CustomDate): number;
+    getTimeStepFromDateClipped(currentDate: CustomDate): number;
+}
+export declare function calculateTimeIntervalFromList(dateStrings: string[]): DateInterval;

package/dist/src/lib/components/WMTimeTypes.d.ts

@@ -0,0 +1,19 @@
+interface DateInterval {
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    minute: number;
+    second: number;
+    isRegularInterval: boolean;
+    getTime: () => number;
+}
+export interface CustomDate extends Date {
+    add: (dateInterval: DateInterval) => void;
+    substract: (dateInterval: DateInterval) => void;
+    addMultipleTimes: (dateInterval: DateInterval, times: number) => void;
+    substractMultipleTimes: (dateInterval: DateInterval, times: number) => void;
+    toISO8601: () => string;
+    clone: () => CustomDate;
+}
+export {};

package/dist/src/lib/components/WMXMLParser.d.ts

@@ -0,0 +1,9 @@
+type WMJSONDocument = any;
+export declare const WMXMLStringToXMLDocument: (xmlString: string) => XMLDocument;
+export declare const WMXMLtoJSON: (xmlDocument: XMLDocument) => WMJSONDocument;
+export declare const WMXMLStringToJson: (xmlString: string) => WMJSONDocument;
+declare const WMXMLParser: (url: string, headers: {
+    name: string;
+    value: string;
+}[]) => Promise<Record<string, unknown>>;
+export default WMXMLParser;

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

@@ -0,0 +1,25 @@
+import { WMImageStoreLoadType } from './LoadDurationCounter';
+import WMImage from './WMImage';
+import { WMImageEventType } from './WMImageStore';
+import { wmDetermineDimensionMode } from './WMJSDimensionModes';
+import { isDefined, toArray, debugLogger, DebugType, getUriWithParam, getMapDimURL } from './WMJSTools';
+import { LayerType } from './WMLayerTypes';
+import { getLegendGraphicURLForLayer, legendImageStore } from './WMLegend';
+import WMListener from './WMListener';
+import WMProjection from './WMProjection';
+import { parseISO8601DateToDate, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration } from './WMTime';
+import { WMXMLStringToJson } from './WMXMLParser';
+export { default as WMJSDimension, handleDateUtilsISOString, } from './WMJSDimension';
+export { default as WMLayer } from './WMLayer';
+export type { LayerOptions, LayerFoundation, EDRFeatureLayerOptions, } from './WMLayerTypes';
+export { LayerType };
+export { default as WMBBOX } from './WMBBOX';
+export type { Bbox } from './WMBBOX';
+export type { WMProjectionWH } from './WMProjection';
+export { WMProjection };
+export { DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration, isDefined, parseISO8601DateToDate, toArray, getLegendGraphicURLForLayer, legendImageStore, WMImage, debugLogger, DebugType, WMImageEventType, getUriWithParam, getMapDimURL, WMListener, WMXMLStringToJson, WMImageStoreLoadType, wmDetermineDimensionMode, };
+export type * from './types';
+export type * from './WMTimeTypes';
+export * from './WMConstants';
+declare const wmServiceListener: WMListener;
+export { wmServiceListener };

package/dist/src/lib/components/makeHashUrlForGeoReferencedImage.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Makes hashed georeferenced url without width, height and bbox
+ * @param url
+ * @returns
+ */
+export declare const makeHashUrlForGeoReferencedImage: (url: string) => string | undefined;

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

@@ -0,0 +1,231 @@
+import type { Bbox } from './WMBBOX';
+import type WMImage from './WMImage';
+import type WMJSDimension from './WMJSDimension';
+import type WMLayer from './WMLayer';
+export interface AnimationStep {
+    name: string;
+    value: string;
+    requests?: {
+        url: string;
+        headers: Headers[];
+    }[];
+    imagesInPrefetch?: WMImage[];
+}
+export interface WMPosition {
+    x: number;
+    y: number;
+}
+export interface LinkedInfoContent {
+    layer: WMLayer;
+    message?: string;
+}
+export interface LinkedInfo {
+    linkedInfo: LinkedInfoContent;
+}
+export interface TimeInterval {
+    year: number;
+    month: number;
+    day: number;
+    hour: number;
+    minute: number;
+    second: number;
+    isRegularInterval: boolean;
+}
+export interface Dimension {
+    name?: string;
+    units?: string;
+    currentValue: string;
+    maxValue?: string;
+    minValue?: string;
+    timeInterval?: TimeInterval;
+    synced?: boolean;
+    values?: string;
+    unitSymbol?: string;
+    validSyncSelection?: boolean;
+}
+export interface Style {
+    title: string;
+    name: string;
+    legendURL: string;
+    abstract: string;
+}
+export interface GeographicBoundingBox {
+    west: string;
+    east: string;
+    north: string;
+    south: string;
+}
+export interface WMLayerType {
+    setDimension: (name: string, value: string, updateMapDimensions: boolean) => void;
+    getDimension: (name: string) => WMJSDimension;
+    dimensions?: WMJSDimension[];
+    title?: string;
+    headers?: Headers[];
+}
+export interface CoordinateReferenceSystem {
+    name?: string;
+    bbox?: Bbox;
+}
+export interface LayerProps {
+    name: string | null;
+    leaf: boolean;
+    path: string[];
+    title?: string;
+    abstract?: string;
+    keywords?: string[];
+    styles?: Style[];
+    dimensions?: Dimension[];
+    geographicBoundingBox?: GeographicBoundingBox | undefined;
+    queryable?: boolean;
+    crs?: CoordinateReferenceSystem[];
+    ogctype?: OGCTYPE;
+}
+/**
+ * Represents the layers as advertised in the WMS GetCapabilities document
+ */
+export interface LayerTree extends LayerProps {
+    children: LayerTree[];
+}
+export interface WMSBoundingBox {
+    attr: {
+        SRS?: string;
+        CRS?: string;
+        maxy: string;
+        miny: string;
+        maxx: string;
+        minx: string;
+    };
+}
+/**
+ * This interface is for reading from the WMS GetCapabilities document, which can have different structures for V1.1.1 and V1.3.0
+ */
+export interface WMSLayerFromGetCapabilities {
+    attr: {
+        queryable: string;
+        opaque: string;
+        cascaded: string;
+    };
+    Name: {
+        attr: Record<string, unknown>;
+        value: string;
+    };
+    Title: {
+        attr: Record<string, unknown>;
+        value: string;
+    };
+    Dimension: unknown;
+    Style: unknown;
+    Extent: unknown;
+    ScaleHint: unknown;
+    Abstract: {
+        value: string;
+    };
+    KeywordList: {
+        Keyword: unknown;
+    };
+    Layer: WMSLayerFromGetCapabilities | WMSLayerFromGetCapabilities[];
+    EX_GeographicBoundingBox?: {
+        northBoundLatitude: {
+            attr: Record<string, unknown>;
+            value: string;
+        };
+        southBoundLatitude: {
+            attr: Record<string, unknown>;
+            value: string;
+        };
+        westBoundLongitude: {
+            attr: Record<string, unknown>;
+            value: string;
+        };
+        eastBoundLongitude: {
+            attr: Record<string, unknown>;
+            value: string;
+        };
+    };
+    LatLonBoundingBox?: {
+        attr: {
+            maxy: string;
+            miny: string;
+            maxx: string;
+            minx: string;
+        };
+    };
+    BoundingBox?: WMSBoundingBox[];
+    SRS?: {
+        value: string;
+    }[];
+}
+export interface WMSGetCapabilities {
+    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: OGCWMSWMTSGetCapabilities;
+}
+export interface Capability {
+    Layer: WMSLayerFromGetCapabilities;
+    Request: any;
+}
+export interface XLINK {
+    'xlink:href': string;
+}
+export interface Header {
+    name: string;
+    value: string;
+}
+export interface WMTDimension {
+    Identifier?: {
+        value: string;
+    };
+    Default?: {
+        value: string;
+    };
+    Value?: {
+        value: string;
+    } | {
+        value: string;
+    }[];
+}
+export interface WMTLayer {
+    Abstract: {
+        value: string;
+    };
+    Dimension?: WMTDimension[];
+    Identifier: {
+        value: string;
+    };
+    Title: {
+        value: string;
+    };
+}
+export interface WMTSGetCapabilities {
+    Capabilities?: {
+        ServiceIdentification?: {
+            Title?: {
+                value: string;
+            };
+            Abstract?: {
+                value: string;
+            };
+            ServiceType?: {
+                value: string;
+            };
+        };
+        Contents?: {
+            Layer?: WMTLayer | WMTLayer[];
+        };
+    };
+}
+export declare enum OGCTYPE {
+    WMTS = "WMTS",
+    WMS = "WMS"
+}
+export interface OGCWMSWMTSGetCapabilities extends WMSGetCapabilities, WMTSGetCapabilities {
+}

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

@@ -0,0 +1,5 @@
+import webmapTranslations from '../../locales/webmap.json';
+export * from './components';
+export * from './utils';
+export { webmapTranslations };
+export { WEBMAP_NAMESPACE } from './utils/i18n';

package/dist/src/lib/query/fakeApiWmtsQueries.d.ts

@@ -0,0 +1,208 @@
+export declare const wmtsResponseGetCapabilities: {
+    Capabilities: {
+        attr: {
+            xmlns: string;
+            'xmlns:ows': string;
+            'xmlns:xlink': string;
+            'xmlns:xsi': string;
+            'xmlns:gml': string;
+            'xsi:schemaLocation': string;
+            version: string;
+        };
+        ServiceIdentification: {
+            attr: {};
+            Title: {
+                attr: {};
+            };
+            Abstract: {
+                attr: {};
+            };
+            ServiceType: {
+                attr: {};
+                value: string;
+            };
+            ServiceTypeVersion: {
+                attr: {};
+                value: string;
+            };
+            Fees: {
+                attr: {};
+                value: string;
+            };
+            AccessConstraints: {
+                attr: {};
+                value: string;
+            };
+        };
+        OperationsMetadata: {
+            attr: {};
+            Operation: {
+                attr: {
+                    name: string;
+                };
+                DCP: {
+                    attr: {};
+                    HTTP: {
+                        attr: {};
+                        Get: {
+                            attr: {
+                                'xlink:href': string;
+                            };
+                            Constraint: {
+                                attr: {
+                                    name: string;
+                                };
+                                AllowedValues: {
+                                    attr: {};
+                                    Value: {
+                                        attr: {};
+                                        value: string;
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            }[];
+        };
+        Contents: {
+            attr: {};
+            Layer: {
+                attr: {};
+                Title: {
+                    attr: {};
+                    value: string;
+                };
+                Abstract: {
+                    attr: {};
+                };
+                WGS84BoundingBox: {
+                    attr: {};
+                    LowerCorner: {
+                        attr: {};
+                        value: string;
+                    };
+                    UpperCorner: {
+                        attr: {};
+                        value: string;
+                    };
+                };
+                Identifier: {
+                    attr: {};
+                    value: string;
+                };
+                Style: {
+                    attr: {
+                        isDefault: string;
+                    };
+                    Identifier: {
+                        attr: {};
+                        value: string;
+                    };
+                };
+                Format: {
+                    attr: {};
+                    value: string;
+                };
+                Dimension: {
+                    attr: {};
+                    Identifier: {
+                        attr: {};
+                        value: string;
+                    };
+                    Default: {
+                        attr: {};
+                        value: string;
+                    };
+                    Value: {
+                        attr: {};
+                        value: string;
+                    }[];
+                };
+                TileMatrixSetLink: {
+                    attr: {};
+                    TileMatrixSet: {
+                        attr: {};
+                        value: string;
+                    };
+                };
+                ResourceURL: {
+                    attr: {
+                        format: string;
+                        resourceType: string;
+                        template: string;
+                    };
+                };
+            };
+            TileMatrixSet: {
+                attr: {};
+                Identifier: {
+                    attr: {};
+                    value: string;
+                };
+                SupportedCRS: {
+                    attr: {};
+                    value: string;
+                };
+                TileMatrix: {
+                    attr: {};
+                    Identifier: {
+                        attr: {};
+                        value: string;
+                    };
+                    ScaleDenominator: {
+                        attr: {};
+                        value: string;
+                    };
+                    TopLeftCorner: {
+                        attr: {};
+                        value: string;
+                    };
+                    TileWidth: {
+                        attr: {};
+                        value: string;
+                    };
+                    TileHeight: {
+                        attr: {};
+                        value: string;
+                    };
+                    MatrixWidth: {
+                        attr: {};
+                        value: string;
+                    };
+                    MatrixHeight: {
+                        attr: {};
+                        value: string;
+                    };
+                }[];
+            };
+        };
+        ServiceMetadataURL: {
+            attr: {
+                'xlink:href': string;
+            };
+        };
+    };
+};
+export declare const wmtsResponseLayerList: {
+    abstract: string;
+    dimensions: {
+        currentValue: string;
+        defaultValue: string;
+        name: string;
+        units: string;
+        values: string;
+    }[];
+    leaf: boolean;
+    name: string;
+    path: never[];
+    ogctype: string;
+    styles: {
+        abstract: string;
+        legendURL: string;
+        name: string;
+        title: string;
+    }[];
+    title: string;
+}[];
+export declare const fakeWMTSLayerApiHandlers: import("msw").HttpHandler[];

package/dist/src/lib/query/queryConstants.d.ts

@@ -0,0 +1,7 @@
+export declare const QUERYWMS_GETCAPABILITIES = "QUERYWMS_GETCAPABILITIES";
+export declare const QUERYWMS_LAYERSTREE = "QUERYWMS_LAYERSTREE";
+export declare const QUERYWMS_SERVICEINFO = "QUERYWMS_SERVICEINFO";
+export declare const QUERYWMS_LAYERS = "QUERYWMS_LAYERS";
+export declare const QUERYWMS_LAYER = "QUERYWMS_LAYER";
+export declare const QUERYWMS_OGCTYPE = "QUERYWMS_OGCTYPE";
+export declare const queryWMSKeys: string[];