@opengeoweb/webmap-react 11.1.0 → 12.1.0

package/src/lib/components/OpenLayers/tools/index.d.ts

@@ -0,0 +1 @@
+export { ClickOnMapTool } from './ClickOnMapTool';

package/src/lib/components/OpenLayers/types/Timespan.d.ts

@@ -0,0 +1,9 @@
+export interface Timespan {
+    start: number;
+    end: number;
+    step: number;
+}
+export interface TimeContextType {
+    timespan: Timespan;
+    isAnimating: boolean;
+}

package/src/lib/components/OpenLayers/types/WorkerQueue.d.ts

@@ -0,0 +1,6 @@
+export type FinaliseFn = () => void;
+export interface WorkerQueueJob {
+    task: () => Promise<FinaliseFn | void>;
+    cancelled: boolean;
+    dimValue: string;
+}

package/src/lib/components/OpenLayers/useProjectionDropDown.d.ts

@@ -0,0 +1,17 @@
+import { EPSGCode } from '@opengeoweb/shared';
+import { Bbox } from '@opengeoweb/webmap';
+import { View } from 'ol';
+import React from 'react';
+export interface BboxAndSrs {
+    srs: EPSGCode;
+    bbox: Bbox;
+}
+export interface SrsSelectComponentProps {
+    srsAndBBOX: BboxAndSrs;
+    setSrs: (value: string) => void;
+}
+export declare const SrsSelectComponent: React.FC<SrsSelectComponentProps>;
+export declare const useProjectionDropDown: (initCRS?: string) => {
+    view: View;
+    selectComponent: React.ReactElement;
+};

package/src/lib/components/OpenLayers/utils/ShowTimeAwareLayerInfo.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { WMLayer } from '@opengeoweb/webmap';
+import ImageLayer from 'ol/layer/Image';
+import { TimeawareImageSource } from './TimeawareImageSource';
+export interface ShowTimeAwareLayerInfoProps {
+    wmLayer: WMLayer;
+    stepsToCheck: number[];
+    layer: ImageLayer<TimeawareImageSource>;
+    visible: boolean;
+}
+export declare const ShowTimeAwareLayerInfo: React.FC<ShowTimeAwareLayerInfoProps>;

package/src/lib/components/OpenLayers/utils/TimeAwareImageWrapper.d.ts

@@ -0,0 +1,42 @@
+import { Extent } from 'ol/extent';
+import ImageWrapper from 'ol/Image';
+import { Projection } from 'ol/proj';
+import { WMImageStore } from '@opengeoweb/webmap';
+export declare const openLayersGetMapImageStore: WMImageStore;
+interface TimeAwareGeoreferencedImageSrc {
+    src: string;
+    extent: Extent;
+    resolution: number;
+}
+interface TimeAwareGeoreferencedImage {
+    el: HTMLImageElement;
+    extent: Extent;
+    resolution: number;
+    isLoaded: boolean;
+    hasError: boolean;
+    isLoadedWithoutErrors: boolean;
+    isLoading: boolean;
+}
+declare class TimeAwareImageWrapper extends ImageWrapper {
+    private _extentToLoad;
+    private _resolutionToLoad;
+    private _pixelRatioToLoad;
+    private _paramsToLoad;
+    private _dimPropsToLoad;
+    private _getMapUrl;
+    private projection;
+    private _resolvers;
+    private _styleName;
+    private _layerName;
+    constructor(extent: Extent, resolution: number, pixelRatio: number);
+    getWMSGetMapRequestURL(extentToLoad: Extent, resolutionToLoad: number, __pixelRatio: number, projection: Projection | null, getMapUrl: string | null, params: Record<string, string>, layerName: string | null, styleName: string, dimProps: Record<string, string>): TimeAwareGeoreferencedImageSrc;
+    getAlternativeImage(extent: Extent, resolution: number, pixelRatio: number, projection: Projection, getMapUrl: string, params: Record<string, string>, layerName: string, styleName: string, dimsProps: Record<string, string>): TimeAwareGeoreferencedImage | false;
+    hasImage(extent: Extent, resolution: number, pixelRatio: number, projection: Projection, getMapUrl: string, params: Record<string, string>, layerName: string, styleName: string, dimsProps: Record<string, string>): TimeAwareGeoreferencedImage | false;
+    setGeoReferencedImage(image: TimeAwareGeoreferencedImage): void;
+    load(): void;
+    setState(state: number): void;
+    private _rejectAll;
+    private _resolveAll;
+    loadAndResolve(extentToLoad: Extent, resolutionToLoad: number, pixelRatio: number, projection: Projection, getMapUrl: string, params: Record<string, string>, layerName: string, styleName: string, dimProps: Record<string, string>): Promise<void>;
+}
+export default TimeAwareImageWrapper;

package/src/lib/components/OpenLayers/utils/TimeawareImageSource.d.ts

@@ -0,0 +1,50 @@
+import { Extent } from 'ol/extent';
+import ImageWrapper from 'ol/Image';
+import { Projection } from 'ol/proj';
+import ImageSource from 'ol/source/Image';
+import TimeAwareImageWrapper from './TimeAwareImageWrapper';
+export declare const initImageWrapper: () => TimeAwareImageWrapper;
+interface TimeawareImageSourceOptions {
+    wmsUrl: string;
+    params?: Record<string, string>;
+    layerName: string;
+    dimProps?: Record<string, string>;
+    styleName?: string | undefined;
+    timeStampsToPrefetch?: string[];
+    visible?: boolean;
+}
+export declare class TimeawareImageSource extends ImageSource {
+    private _wmsUrl;
+    private _extraWMSParams;
+    private _timeStampsToPrefetch;
+    private _prefetchWorkers;
+    private _wantedExtent;
+    private _wantedResolution;
+    private _previousPrefetchExtent;
+    private _dimProperties;
+    private _imWrapperEmptyButLoading;
+    private _imWrapperForOlSource;
+    private _imWrapperForAltImage;
+    private _styleName;
+    private _layerName;
+    private debouncedPrefetch;
+    private _wantedPixelRatio;
+    private _wantedProjection;
+    private _imWrapperForPrefetch;
+    constructor({ wmsUrl, timeStampsToPrefetch, layerName, styleName, dimProps, params, visible, }: TimeawareImageSourceOptions);
+    private prefetch;
+    triggerPrefetch(extent: Extent, resolution: number, pixelRatio: number, projection: Projection): void;
+    getImage(extent: Extent, resolution: number, pixelRatio: number, projection: Projection): ImageWrapper;
+    setDimProps(params: Record<string, string>): void;
+    /**
+     * Check if an image is available and loaded for requested date.
+     * @param timeStampsToPrefetch
+     * @returns
+     */
+    hasImageForTimeValue(timeStampsToPrefetch: string): boolean;
+    loadImageForTimeValue(timeStampsToPrefetch: string): void;
+    setStyle(styleName: string): void;
+    setLayerName(layerName: string): void;
+    setTimeValuesValuesToPrefetch(timeStampsToPrefetch: string[]): void;
+}
+export {};

package/src/lib/components/OpenLayers/utils/WorkerQueue.d.ts

@@ -0,0 +1,14 @@
+import { WorkerQueueJob } from '../types/WorkerQueue';
+export declare class WorkerQueue {
+    maxConcurrency: number;
+    tasksInProcess: WorkerQueueJob[];
+    taskQueue: WorkerQueueJob[];
+    private disposed;
+    constructor(concurrency: number);
+    dispose(): void;
+    ensureWork(): void;
+    clearJobs(): void;
+    addJobs(work: WorkerQueueJob[]): void;
+    addJobsWithoutReorder(work: WorkerQueueJob[]): void;
+    private _startJob;
+}

package/src/lib/components/OpenLayers/utils/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const MAX_NUMBER_TO_PREFETCH = 200;
+export declare const MAX_NUMBER_STEPS_IN_TIMESLIDER_TO_PREFETCH = 10000;
+export declare const NUMBER_PREFETCH_WORKERS = 4;
+export declare const NUM_IMAGES_TO_CACHE = 10000;
+export declare const WMS_EXTENT_RATIO_TO_VIEWPORT = 1.2;
+export declare const TIMEAWAREIMAGEWRAPPER_IMAGEDIDNOTLOADSUCCESFULLY = "Image did not load succesfully";

package/src/lib/components/OpenLayers/utils/makeDimValuesToPrefetch.d.ts

@@ -0,0 +1,10 @@
+import { WMJSDimension, Dimension, WMLayer } from '@opengeoweb/webmap';
+import { Timespan } from '../types/Timespan';
+export declare const makeDimValuesToPrefetch: (wmTimeDim: WMJSDimension, stepsToCheck: number[], isAnimating: boolean) => string[];
+export declare const getDimensionParamsForWMS: (dimensions: Dimension[] | undefined, wmLayer: WMLayer | null) => Record<string, string>;
+/**
+ * Calculates number of timesteps for given timespan
+ * @param timespan Object of Timespan, with start/stop/end in milliseconds
+ * @returns Timestams array in milliseconds
+ */
+export declare const getTimeStepsToCheckMemoized: ((timespan: Timespan) => number[]) & import("lodash").MemoizedFunction;

package/src/lib/components/OpenLayers/utils/makeDimValuesToPrefetch.spec.d.ts

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

package/src/lib/components/OpenLayers/utils/projections.d.ts

@@ -0,0 +1,16 @@
+import { LayerProps } from '@opengeoweb/webmap';
+export declare const initializeOpenLayersProjections: () => void;
+/**
+ * Returns a preferred projection to use with a particular layer. It will search the layer props for
+ * a supported srs that either matches the current view srs or an srs that geoweb has reprojection math
+ * for. The first priority is the view srs and then any of the other supported srs. If no shared SRS
+ * is found, the function will return EPSG:3857 since that is almost always supported. There may be
+ * layers for which we do not have LayerProps for (for example layers not visible in a GetCapabilities
+ * document for a service) and thus defaulting to EPSG:3857 makes sense.
+ *
+ * @param viewSrs
+ * @param layerProps
+ * @returns
+ */
+export declare const selectPreferredWMSProjection: (viewSrs: string, layerProps: LayerProps | null) => string;
+export declare const useProjection: () => string | undefined;

package/src/lib/components/OpenLayers/utils/setMapCenter.d.ts

@@ -0,0 +1,2 @@
+import { Map } from 'ol';
+export declare const setMapCenter: (map: Map, lon: number, lat: number) => void;

package/src/lib/components/OpenLayers/utils/types.d.ts

@@ -0,0 +1,15 @@
+import { Feature } from 'ol';
+import { Dimension } from '@opengeoweb/webmap';
+export interface HoverSelect {
+    onHover?: (f: Feature | undefined) => void;
+    active: boolean;
+}
+export interface ClickOnFeature {
+    onClick: (f: Feature[]) => void;
+    hitTolerance?: number;
+}
+export interface OnInitializeLayerProps {
+    layerId: string;
+    style: string;
+    dimensions: Dimension[];
+}

package/src/lib/components/OpenLayers/utils/viewUtils.d.ts

@@ -0,0 +1,11 @@
+import { Bbox } from '@opengeoweb/webmap';
+import { FeatureCollection, Geometry, GeoJsonProperties } from 'geojson';
+import { View } from 'ol';
+export declare const setViewFromExtent: (view: View, bbox: Bbox) => void;
+export declare const setViewFromFeature: (view: View, geojsonFeature: FeatureCollection<Geometry, GeoJsonProperties> | undefined) => void;
+export declare const makeView: (projectionCode?: string) => View;
+export declare const viewUtils: {
+    setViewFromExtent: (view: View, bbox: Bbox) => void;
+    setViewFromFeature: (view: View, geojsonFeature: FeatureCollection<Geometry, GeoJsonProperties> | undefined) => void;
+    makeView: (projectionCode?: string) => View;
+};

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

@@ -46,6 +46,7 @@ export interface MapLocation {
     screenOffsetY?: number;
     projectionX?: number;
     projectionY?: number;
+    resolution?: number;
     srs?: string;
     id?: string;
     serviceId?: string;

package/src/lib/components/WebMapMapView/MapView.VFXData.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const MapViewVFX: Story;

package/src/lib/components/{MapView/MapView.Error.stories.d.ts → WebMapMapView/WebMapMapView.Error.stories.d.ts}

@@ -1,8 +1,8 @@
 import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
 export default meta;
-type Story = StoryObj<typeof MapView>;
+type Story = StoryObj<typeof WebMapMapView>;
 export declare const Component: Story;
 export declare const MapError: Story;
 export declare const MapWithDuplicateLayerIdsError: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.MapPin.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const SetMapPin: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.Passive.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const PassiveMap: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.ProfileSounding.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const MapViewProfile: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.RadarAnimation.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const RadarAnimation: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.RadarData.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const MapViewRadar: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.SetProjectionBBox.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const SetProjectionBBox: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.SetProjectionBBoxLocalState.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const SetProjectionBBoxLocalState: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.ShiftToZoom.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const HoldShiftToZoom: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.ShowLayerInfo.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export declare const MapWithShowLayerInfoEnabled: Story;

package/src/lib/components/WebMapMapView/WebMapMapView.TiledBaseLayers.stories.d.ts

@@ -0,0 +1,17 @@
+import type { Meta, StoryObj } from '@storybook/react';
+import { MapView as WebMapMapView } from '../MapView';
+declare const meta: Meta<typeof WebMapMapView>;
+export default meta;
+type Story = StoryObj<typeof WebMapMapView>;
+export interface MapDropDownItem {
+    name: string;
+    title: string;
+}
+export interface MapDropDownProps {
+    value: string;
+    change: (updatedValue: string) => void;
+    options: MapDropDownItem[];
+    top?: number;
+    left?: number;
+}
+export declare const MapViewTiledBaseLayers: Story;

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

@@ -10,3 +10,4 @@ export * from './MapControls';
 export * from './MapWarning';
 export * from './MapDimensionSelect';
 export * from './LayerInfo';
+export * from './OpenLayers';

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

@@ -0,0 +1,4 @@
+export * from './useHooksGetCapabilities';
+export * from './useSetInterValWhenVisible';
+export * from './useViewFromLayer';
+export * from './useAnimationForLayer';

package/src/lib/hooks/useAnimationForLayer.d.ts

@@ -0,0 +1,3 @@
+import { Dimension } from '@opengeoweb/webmap';
+import type { OpenLayersLayerProps } from '../components/OpenLayers/layers';
+export declare const useAnimationForLayer: (layerProps: OpenLayersLayerProps, intervalInMs: number, numStepsTillLatest?: number, checkForUpdatesMs?: number) => Dimension[];

package/src/lib/hooks/useHooksGetCapabilities.d.ts

@@ -51,7 +51,7 @@ export declare const useGetWMSLayerStyleList: (serviceUrl: string, name: string)
  * @param {string} name
  * @returns {(WMLayer | null)}
  */
-export declare const useGetWMLayerInstance: (serviceUrl: string, name: string, id?: string) => WMLayer | null;
+export declare const useGetWMLayerInstance: (serviceUrl: string, name: string, id?: string, onLayerError?: (layerId: string, message: string) => void) => WMLayer | null;
 /**
  * Used for querying WMTS GetCapabilities documents
  * @param serviceUrl

package/src/lib/hooks/useSetInterValWhenVisible.d.ts

@@ -0,0 +1 @@
+export declare const useSetIntervalWhenVisible: (autoUpdate: () => void, refetchInterval: number, shouldAutoFetch?: boolean) => void;

package/src/lib/hooks/useViewFromLayer.d.ts

@@ -0,0 +1,7 @@
+import { View } from 'ol';
+import type { OpenLayersLayerProps } from '../components/OpenLayers/layers';
+export declare const useViewFromLayer: (layerProps: OpenLayersLayerProps, baseView?: {
+    projection: string;
+    zoom: number;
+    center: number[];
+}) => View;

package/src/lib/index.d.ts

@@ -1,4 +1,4 @@
 export * from './components';
 export * from './layers';
-export * from './hooks/useHooksGetCapabilities';
+export * from './hooks';
 export { WEBMAP_REACT_NAMESPACE } from './utils/i18n';

package/src/lib/components/MapView/MapView.MapPin.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const SetMapPin: Story;

package/src/lib/components/MapView/MapView.Passive.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const PassiveMap: Story;

package/src/lib/components/MapView/MapView.ProfileSounding.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from './MapView';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const MapViewProfile: Story;

package/src/lib/components/MapView/MapView.RadarAnimation.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const RadarAnimation: Story;

package/src/lib/components/MapView/MapView.RadarData.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from './MapView';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const MapViewRadar: Story;

package/src/lib/components/MapView/MapView.SetProjectionBBox.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const SetProjectionBBox: Story;

package/src/lib/components/MapView/MapView.SetProjectionBBoxLocalState.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const SetProjectionBBoxLocalState: Story;

package/src/lib/components/MapView/MapView.ShiftToZoom.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const HoldShiftToZoom: Story;

package/src/lib/components/MapView/MapView.ShowLayerInfo.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from '.';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const MapWithShowLayerInfoEnabled: Story;

package/src/lib/components/MapView/MapView.VFXData.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { MapView } from './MapView';
-declare const meta: Meta<typeof MapView>;
-export default meta;
-type Story = StoryObj<typeof MapView>;
-export declare const MapViewVFX: Story;