@opengeoweb/webmap-react 10.2.1-spike-ol.3 → 11.1.0

package/src/lib/components/OpenLayers/layers/MapViewLayerToOpenLayer.d.ts

@@ -1,22 +0,0 @@
-import { LayerFoundation } from '@opengeoweb/webmap';
-import type { OnInitializeLayerProps } from '../utils/types';
-import { DrawModeExitCallback, FeatureEvent } from '../../MapDraw';
-export interface MapViewLayerToOpenLayerProps extends LayerFoundation {
-    zIndex?: number;
-    isOverlay?: boolean;
-    isBaseLayer?: boolean;
-    onInitializeLayer?: (payload: OnInitializeLayerProps) => void;
-    onLayerReady?: (layerId: string) => void;
-    onLayerError?: (layerId: string, message: string) => void;
-    debugMode?: boolean;
-    id: string;
-    isInEditMode?: boolean;
-    drawMode?: string;
-    updateGeojson?: (geoJson: GeoJSON.FeatureCollection, reason: string) => void;
-    exitDrawModeCallback?: (reason: DrawModeExitCallback, newGeoJSON?: GeoJSON.FeatureCollection) => void;
-    selectedFeatureIndex?: number;
-    onClickFeature?: (event?: FeatureEvent) => void;
-    onHoverFeature?: (event: FeatureEvent) => void;
-}
-export declare const MapViewLayerToOpenLayer: (layerProps: MapViewLayerToOpenLayerProps) => React.ReactElement;
-export declare const OpenLayersLayer: (layerProps: MapViewLayerToOpenLayerProps) => React.ReactElement;

package/src/lib/components/OpenLayers/layers/TiledWMSLayer.d.ts

@@ -1,12 +0,0 @@
-/// <reference types="react" />
-import ImageLayer from 'ol/layer/Image';
-import { LayerFoundation } from '@opengeoweb/webmap';
-export interface TiledWMSLayerProps {
-    url: string;
-    layerName: string;
-    styleName: string;
-    projection?: string;
-    layerOptions: ConstructorParameters<typeof ImageLayer>[0];
-    layerProps?: LayerFoundation;
-}
-export declare const TiledWMSLayer: React.FC<TiledWMSLayerProps>;

package/src/lib/components/OpenLayers/layers/TimeawareImageSourceWMSLayer.d.ts

@@ -1,19 +0,0 @@
-/// <reference types="react" />
-import ImageLayer from 'ol/layer/Image';
-import { Dimension } from '@opengeoweb/webmap';
-import type { OnInitializeLayerProps } from '../utils/types';
-interface TimeawareImageSourceWMSLayerProps {
-    layerId?: string;
-    getCapsURL: string;
-    layerName: string;
-    styleName?: string;
-    layerOptions: ConstructorParameters<typeof ImageLayer>[0];
-    dimensions?: Dimension[];
-    visible?: boolean;
-    onInitializeLayer?: (payload: OnInitializeLayerProps) => void;
-    onLayerReady?: (layerId: string) => void;
-    onLayerError?: (layerId: string, message: string) => void;
-    debugMode?: boolean;
-}
-export declare const TimeawareImageSourceWMSLayer: React.FC<TimeawareImageSourceWMSLayerProps>;
-export {};

package/src/lib/components/OpenLayers/layers/TimeawareImageSourceWMSLayer.spec.d.ts

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

package/src/lib/components/OpenLayers/layers/WMSLayer.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="react" />
-import ImageLayer from 'ol/layer/Image';
-import { LayerFoundation } from '@opengeoweb/webmap';
-export interface WMSLayerProps {
-    url: string;
-    layerName: string;
-    styleName: string;
-    layerOptions: ConstructorParameters<typeof ImageLayer>[0];
-    layerProps?: LayerFoundation;
-}
-export declare const WMSLayer: React.FC<WMSLayerProps>;

package/src/lib/components/OpenLayers/layers/WMTSLayer.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="react" />
-import TileLayer from 'ol/layer/Tile';
-import { LayerFoundation } from '@opengeoweb/webmap';
-export interface WMTSLayerProps {
-    getCapsURL: string;
-    layerName: string;
-    tileMatrixSet: string;
-    layerOptions: ConstructorParameters<typeof TileLayer>[0];
-    layerProps?: LayerFoundation;
-}
-export declare const WMTSLayer: React.FC<WMTSLayerProps>;

package/src/lib/components/OpenLayers/layers/XYZLayer.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-import TileLayer from 'ol/layer/Tile';
-import { LayerFoundation } from '@opengeoweb/webmap';
-export interface XYZLayerProps {
-    urlTemplate: string;
-    layerOptions: ConstructorParameters<typeof TileLayer>[0];
-    layerProps?: LayerFoundation;
-}
-export declare const XYZLayer: React.FC<XYZLayerProps>;

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

@@ -1,8 +0,0 @@
-export * from './TimeawareImageSourceWMSLayer';
-export * from './WMSLayer';
-export * from './WMTSLayer';
-export * from './XYZLayer';
-export * from './DefaultBaseLayers';
-export * from './MapViewLayerToOpenLayer';
-export * from './FeatureLayer';
-export * from './GeoJSONLayer';

package/src/lib/components/OpenLayers/storyComponents/OlStoryLayout.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import { DrawModeExitCallback } from '../../MapDraw';
-import { MapViewLayerToOpenLayerProps } from '../layers';
-interface OlStoryLayoutProps {
-    layers: MapViewLayerToOpenLayerProps[];
-    children: React.ReactElement;
-    onExitDrawMode: (reason: DrawModeExitCallback) => void;
-}
-export declare const OlStoryLayout: React.FC<OlStoryLayoutProps>;
-export {};

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

@@ -1 +0,0 @@
-export * from './OlStoryLayout';

package/src/lib/components/OpenLayers/styles/useIconStyle.d.ts

@@ -1,21 +0,0 @@
-import { Style } from 'ol/style';
-import { Options } from 'ol/style/Icon';
-interface IconParameters {
-    render?: {
-        fillStyle?: string | CanvasGradient | CanvasPattern;
-        strokeStyle?: string | CanvasGradient | CanvasPattern;
-        lineWidth?: number;
-    };
-    icon?: Omit<Options, 'img'>;
-}
-interface UseIconStyleProps {
-    svgPath: string;
-    options: IconParameters;
-}
-interface IconStyle {
-    icon: Style;
-}
-export declare const deBiltTower: Style;
-export declare const createIconStyle: ((svgPath: string, options: IconParameters) => Style) & import("lodash").MemoizedFunction;
-export declare const useIconStyle: ({ svgPath, options, }: UseIconStyleProps) => IconStyle;
-export {};

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

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-import { StyleLike } from 'ol/style/Style';
-export interface ClickOnMapToolProps {
-    isActive: boolean;
-    isVisible: boolean;
-    layerZIndex?: number;
-    pointStyle: StyleLike;
-    pointSelected: (coords: number[]) => void;
-}
-export declare const ClickOnMapTool: React.FC<ClickOnMapToolProps>;

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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,12 +0,0 @@
-/// <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>;
-    zIndex: number;
-    visible: boolean;
-}
-export declare const ShowTimeAwareLayerInfo: React.FC<ShowTimeAwareLayerInfoProps>;

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

@@ -1,42 +0,0 @@
-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

@@ -1,50 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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 getTimeStepsToCheck: (timespan: Timespan) => number[];
-/**
- * React Hook for calculating the 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 useGetTimeStepsToCheck: (timespan: Timespan) => number[];

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

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

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

@@ -1 +0,0 @@
-export declare const initializeOpenlayersProjections: () => void;

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

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

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

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

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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from '.';
-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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from '.';
-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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from './WebMapMapView';
-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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from '.';
-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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from './WebMapMapView';
-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

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from '.';
-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.ShiftToZoom.stories.d.ts

@@ -1,6 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from '.';
-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.TiledBaseLayers.stories.d.ts

@@ -1,17 +0,0 @@
-import type { Meta, StoryObj } from '@storybook/react';
-import { WebMapMapView } from './WebMapMapView';
-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/WebMapMapView/WebMapMapView.d.ts

@@ -1,9 +0,0 @@
-import * as React from 'react';
-import { ReactMapViewProps } from '../ReactMapView';
-export interface MapViewProps extends ReactMapViewProps {
-    controls?: {
-        zoomControls?: boolean;
-    };
-    isTimeScrollingEnabled?: boolean;
-}
-export declare const WebMapMapView: React.FC<MapViewProps>;

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

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

package/src/lib/components/WebMapMapView/WebMapMapViewLayer.d.ts

@@ -1,16 +0,0 @@
-import * as React from 'react';
-import { LayerFoundation, IWMJSMap, WMLayer } from '@opengeoweb/webmap';
-import { DrawModeExitCallback, FeatureEvent } from '../MapDraw';
-export interface MapViewLayerProps extends LayerFoundation {
-    id: string;
-    onLayerReady?: (layer: WMLayer, webmap?: IWMJSMap) => void;
-    onLayerError?: (layer: WMLayer, error?: Error) => void;
-    isInEditMode?: boolean;
-    drawMode?: string;
-    updateGeojson?: (geoJson: GeoJSON.FeatureCollection, reason: string) => void;
-    exitDrawModeCallback?: (reason: DrawModeExitCallback, newGeoJSON?: GeoJSON.FeatureCollection) => void;
-    selectedFeatureIndex?: number;
-    onClickFeature?: (event?: FeatureEvent) => void;
-    onHoverFeature?: (event: FeatureEvent) => void;
-}
-export declare const WebMapMapViewLayer: React.FC<MapViewLayerProps>;

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

@@ -1,2 +0,0 @@
-export * from './WebMapMapView';
-export * from './WebMapMapViewLayer';

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

@@ -1,2 +0,0 @@
-export * from './useHooksGetCapabilities';
-export * from './useSetInterValWhenVisible';

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

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

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

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

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

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