@opengeoweb/webmap 19.1.0 → 19.2.0

package/dist/src/lib/specs/mockGetCapabilities.d.ts

@@ -0,0 +1,90 @@
+import type { WMSGetCapabilities, LayerProps, LayerTree } from '../components';
+export declare const MOCK_URL_WITH_CHILDREN = "https://mockUrlWithChildren.nl";
+export declare const MOCK_URL_NO_CHILDREN = "https://mockUrlNoChildren.nl";
+export declare const MOCK_URL_WITH_NO_TITLE = "https://mockUrlWithNoTitle.nl";
+export declare const MOCK_URL_WITH_NO_TITLE_OR_NAME = "https://mockUrlWithNoTitleOrName.nl/wms?";
+export declare const MOCK_URL_WITH_SUBCATEGORY = "https://mockUrlWithSubcategory.nl";
+export declare const MOCK_URL_INVALID = "https://notawmsservice.nl";
+export declare const MOCK_URL_SLOW = "https://slowresolve.nl";
+export declare const MOCK_URL_SLOW_FAILS = "https://slowreject.nl";
+export declare const MOCK_URL_DEFAULT = "https://defaultservice.nl";
+export declare const MOCK_URL_DEFAULT2 = "https://defaultservice2.nl";
+export declare const MOCK_URL_HTTP = "http://wmsservice.nl";
+export declare const MOCK_URL_HARMONIE = "WMS130GetCapabilitiesHarmN25";
+export declare const MOCK_URL_WMS130_NOLEGEND = "MOCK_URL_WMS130_NOLEGEND";
+export declare const mockLayersNoChildren: {
+    leaf: boolean;
+    name: null;
+    title: string;
+    path: never[];
+    children: never[];
+};
+export declare const mockLayersWithChildren: {
+    leaf: boolean;
+    name: null;
+    title: string;
+    path: never[];
+    children: {
+        leaf: boolean;
+        name: string;
+        title: string;
+        path: never[];
+        children: never[];
+    }[];
+};
+export declare const mockLayersWithNoTitle: LayerTree;
+export declare const mockLayersWithNoTitleOrName: LayerTree;
+export declare const mockLayersWithSubcategory: {
+    leaf: boolean;
+    name: null;
+    title: string;
+    path: never[];
+    children: ({
+        leaf: boolean;
+        name: string;
+        title: string;
+        path: never[];
+        children: never[];
+    } | {
+        leaf: boolean;
+        name: null;
+        title: string;
+        path: never[];
+        children: ({
+            leaf: boolean;
+            name: string;
+            title: string;
+            path: string[];
+            children: never[];
+        } | {
+            leaf: boolean;
+            name: null;
+            title: string;
+            path: string[];
+            children: {
+                leaf: boolean;
+                name: string;
+                title: string;
+                path: string[];
+                children: never[];
+            }[];
+        })[];
+    })[];
+};
+export declare const mockLayersDefault: {
+    leaf: boolean;
+    name: null;
+    title: string;
+    path: never[];
+    children: never[];
+};
+export declare const mockLayersDefault2: {
+    leaf: boolean;
+    name: null;
+    title: string;
+    path: never[];
+    children: never[];
+};
+export declare const mockGetLayersFromService: (url: string) => Promise<LayerTree>;
+export declare const mockGetLayersFlattenedFromService: (url: string) => Promise<LayerProps[]>;
+export declare const mockGetCapabilitiesFetcher: (serviceUrl: string) => Promise<WMSGetCapabilities>;

package/dist/src/lib/utils/consoleErrorMessages.d.ts

@@ -0,0 +1,12 @@
+export declare const consoleErrorMessages: {
+    noCapabilityElementFound: string;
+    noServiceDefined: string;
+    noWmsCapabilityElementFound: string;
+    noWmsLayerElementFound: string;
+    notAvailableMessage: string;
+    serviceHasError: string;
+    serviceUrlEmpty: string;
+    unableToConnectServer: string;
+    wmsServiceExceptionCode: string;
+    layerNotFoundInService: string;
+};

package/dist/src/lib/utils/fakeMaxAgeResponses.d.ts

@@ -0,0 +1 @@
+export declare const fakeMaxAgeResponsesByLayer: Record<string, number>;

package/dist/src/lib/utils/getCapabilities/getWMSServiceId.d.ts

@@ -0,0 +1,10 @@
+export declare const _generateServiceId: () => string;
+export declare const _serviceIdLookupMap: Map<string, string>;
+/**
+ * Returns the id corresponding to a WMS service url. It ensures that the id is unique across services.
+ * The id can be used as a key in the redux store.
+ *
+ * @param {string} serviceUrl Link to a WMS service
+ * @returns {string} Returns the corresponding id
+ */
+export declare const getWMSServiceId: (serviceUrl: string) => string;

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

@@ -0,0 +1,4 @@
+export { invalidateWMSGetCapabilities, queryWMSGetCapabilities, queryWMSLayersTree, queryWMSLayers, queryWMSServiceInfo, queryWMSLayer, } from '../../query/queryWMS';
+export { wmsQueryClient } from './wmsQueryClient';
+export { setWMSGetCapabilitiesFetcher } from './utils';
+export { getWMSServiceId } from './getWMSServiceId';

package/dist/src/lib/utils/getCapabilities/utils.d.ts

@@ -0,0 +1,64 @@
+import type { Capability, WMSGetCapabilities, Header, LayerProps, LayerTree, WMSLayerFromGetCapabilities, WMSServiceInfo, WMTSGetCapabilities, OGCWMSWMTSGetCapabilities } from '../../components/types';
+/**
+ * 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 privateWmsFlattenLayerTree: (layerTree: LayerTree) => LayerProps[];
+export declare const privateGetOGCCapabilitiesUrl: (url?: string, service?: string, additionalParams?: {}) => string;
+export declare const privateWmsGetCapabilities: (serviceUrl: string, headers?: Header[], forceReload?: boolean) => Promise<WMSGetCapabilities>;
+export declare const privateWmtsGetCapabilities: (serviceUrl: string, headers?: Header[], forceReload?: boolean) => Promise<string>;
+/**
+ * privateWmsGetCapabilityElement
+ * @param jsonData
+ * @returns
+ */
+export declare const privateWmsGetCapabilityElement: (jsonData: WMSGetCapabilities) => Capability;
+export declare const privateCheckException: (jsonData: WMSGetCapabilities) => string | undefined;
+export declare const privateWmsGetRootLayerFromGetCapabilities: (jsonData: WMSGetCapabilities) => WMSLayerFromGetCapabilities;
+export declare const privateCheckVersion130: (jsonData: WMSGetCapabilities) => void;
+export declare const privateCheckVersion: (jsonData: WMSGetCapabilities) => string | null;
+/**
+ * Returns a LayerTree object representing hierarchical structure of Lahyers in the WMS GetCapabilities document
+ * @param jsonData WMSGetCapabilities
+ * @returns LayerTree
+ */
+export declare const privateWmsGetLayerTree: (jsonData: OGCWMSWMTSGetCapabilities) => LayerTree | null;
+/**
+ * Builds a standardized LayerTree object based on WMSLayerFromGetCapabilities object.
+ * @param wmsLayer The WMSLayerFromGetCapabilities object
+ * @param nestedPath - Optional, only to be used by privateWmsBuildLayerTreeFromNestedWMSLayer
+ * @param nestedLayerPath - Optional, only to be used by privateWmsBuildLayerTreeFromNestedWMSLayer
+ * @returns A LayerTree object.
+ */
+export declare const privateWmsBuildLayerTreeFromNestedWMSLayer: (wmsLayer: WMSLayerFromGetCapabilities, nestedPath?: string[], nestedLayerPath?: LayerProps[]) => LayerTree;
+export type GetCapabilitiesFunctionType = (serviceUrl: string) => Promise<WMSGetCapabilities>;
+export declare const setWMSGetCapabilitiesFetcher: (functionToSet: GetCapabilitiesFunctionType | null) => void;
+/**
+ * Returns details about the WMS service. You are encouraged to use queryWMSServiceInfo instead.
+ * @param getCapabilitiesJson
+ * @param serviceUrl
+ * @returns
+ */
+export declare const privateGetWMSServiceInfo: (getCapabilitiesJson: WMSGetCapabilities, serviceUrl: string) => WMSServiceInfo;
+/**
+ * Returns details about the WMTS service. You are encouraged to use queryWMSServiceInfo instead.
+ * @param getCapabilitiesJson
+ * @param serviceUrl
+ * @returns
+ */
+export declare const privateGetWMTSServiceInfo: (getCapabilitiesJson: WMTSGetCapabilities, serviceUrl: string) => WMSServiceInfo;
+/**
+ * Makes a uniform and harmonized URL used as caching key in TanStack
+ * @param serviceUrl
+ * @returns
+ */
+export declare const makeQueryKeyFroMServiceUrl: (serviceUrl: string) => string;
+/**
+ * Parses WMTS GetCapabilities and returns an array of LayerProps
+ * @param getCapabilities
+ * @returns
+ */
+export declare const handleWMTSGetCapabilities: (getCapabilities: WMTSGetCapabilities) => LayerProps[];
+export declare const handleWMTSGetCapabilitiesForLayer: (getCapabilities: WMTSGetCapabilities, layerName: string) => LayerProps | undefined;

package/dist/src/lib/utils/getCapabilities/wmsQueryClient.d.ts

@@ -0,0 +1,7 @@
+import { QueryClient } from '@tanstack/query-core';
+/**
+ * This is the default TanStack QueryClient used for the query functions.
+ * It can be used in react by a provider to provide the query client to the hook functions.
+ * This ensures that TanStack keeps the same store for both the hooks and the query functions.
+ */
+export declare const wmsQueryClient: QueryClient;

package/dist/src/lib/utils/i18n.d.ts

@@ -0,0 +1,6 @@
+import type { TFunction } from 'i18next';
+import i18n from 'i18next';
+export declare const WEBMAP_NAMESPACE = "webmap";
+export declare const initWebmapTestI18n: () => void;
+export { i18n };
+export declare const translateInTestsAndStories: (t: TFunction | undefined, key: string, params?: Record<string, string | number> | undefined) => string;

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

@@ -0,0 +1,3 @@
+export * from './tilesettings';
+export * from './utils';
+export * from './getCapabilities';

package/dist/src/lib/utils/tilesettings.d.ts

@@ -0,0 +1,27 @@
+import type { EPSGCode } from '@opengeoweb/shared';
+export interface TileSettings {
+    home: string;
+    minLevel: number;
+    maxLevel: number;
+    tileServerType: string;
+    copyRight: string;
+    origX?: number;
+    origY?: number;
+    resolution?: number;
+    title?: string;
+    tileSize?: number;
+    tileServerFormat?: string;
+    tms?: boolean;
+    urlTemplate?: (basePath: string) => string;
+}
+export type TileSettingPerProjection = {
+    [key in EPSGCode]?: TileSettings;
+};
+export interface Title {
+    title?: string;
+}
+export interface TileServerDefinition extends Title, TileSettingPerProjection {
+}
+export type TileServerMap = Map<string, TileServerDefinition>;
+export type TileServerSettings = Record<string, TileServerDefinition>;
+export declare const tilesettings: TileServerSettings;

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

@@ -0,0 +1,31 @@
+import type { WMJSDimension, WMLayer } from '../components';
+export declare const generateLayerId: () => string;
+export declare const generateMapId: () => string;
+export declare const generateTimesliderId: () => string;
+/**
+ * Registers a WMJSLayer in a lookuptable with a layerId
+ * @param {WMLayer} wmLayer
+ * @param {string} layerId
+ */
+export declare const registerWMLayer: (wmLayer: WMLayer, layerId: string) => void;
+/**
+ * Get the WMLayer from the lookuptable with layerId
+ * @param {string} layerId
+ */
+export declare const getWMLayerById: (layerId: string) => WMLayer;
+export declare const unRegisterWMJSLayer: (layerId: string) => void;
+export declare const unRegisterAllWMJSLayersAndMaps: () => void;
+/**
+ * Returns the WMJSDimension object for given layerId and dimension name
+ * @param layerId The layerId
+ * @param dimensionName The dimension to lookup
+ */
+export declare const getWMJSDimensionForLayerAndDimension: (layerId: string, dimensionName: string | undefined) => WMJSDimension | undefined;
+/**
+ * Gets the WMJSTimeDimension for given activeLayerId and dimensions list
+ * @param layerId: The layer id to search the WMJSDimension for
+ * @return: The WMJSDimension if found, otherwise null
+ */
+export declare const getWMJSTimeDimensionForLayerId: (layerId: string) => WMJSDimension;
+export declare const roundWithTimeStep: (unixTime: number, timeStep: number, type?: string) => number;
+export declare const getCorrectWMSDimName: (origDimName: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "19.1.0",
+  "version": "19.2.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -28,6 +28,7 @@
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]