@opengeoweb/core 4.22.1 → 5.0.0

package/src/lib/store/mapStore/map/types.d.ts

@@ -1,5 +1,6 @@
 import { TimeInterval } from '@opengeoweb/webmap';
 import type { Layer, LayerActionOrigin } from '../types';
+import { Span, MapActionOrigin } from './enums';
 export interface Dimension {
     name?: string;
     units?: string;
@@ -27,13 +28,13 @@ export interface WebMap {
     dimensions?: Dimension[];
     autoUpdateLayerId?: string;
     autoTimeStepLayerId?: string;
-    timeSliderScale?: Scale;
+    timeSliderSpan?: Span;
     timeStep?: number;
     animationDelay?: number;
+    timeSliderWidth?: number;
     timeSliderCenterTime?: number;
     timeSliderUnfilteredSelectedTime?: number;
     timeSliderSecondsPerPx?: number;
-    timeSliderDataScaleToSecondsPerPx?: number;
     isTimestepAuto?: boolean;
     isTimeSliderHoverOn?: boolean;
     isTimeSliderVisible?: boolean;
@@ -59,21 +60,6 @@ export interface Bbox {
     top: number;
     bottom: number;
 }
-export declare enum Scale {
-    Minutes5 = 0,
-    Hour = 1,
-    Hours3 = 2,
-    Hours6 = 3,
-    Hours12 = 4,
-    Day = 5,
-    Days2 = 6,
-    Week = 7,
-    Weeks2 = 8,
-    Month = 9,
-    Months3 = 10,
-    Year = 11,
-    DataScale = 12
-}
 export declare enum AnimationLength {
     Minutes15 = 15,
     Minutes30 = 30,
@@ -92,9 +78,6 @@ export interface AnimationPayloadType {
     endTime?: string;
     shouldEndtimeOverride?: boolean;
 }
-export declare enum MapActionOrigin {
-    map = "map"
-}
 export interface MapPreset {
     layers?: Layer[];
     activeLayerId?: string;
@@ -175,9 +158,9 @@ export interface SetEndTimeOverriding {
     mapId: string;
     shouldEndtimeOverride: boolean;
 }
-export interface SetTimeSliderScalePayload {
+export interface SetTimeSliderSpanPayload {
     mapId: string;
-    timeSliderScale: Scale;
+    timeSliderSpan: Span;
 }
 export interface SetTimeStepPayload {
     mapId: string;
@@ -211,6 +194,10 @@ export interface ToggleTimeSliderIsVisiblePayload {
     isTimeSliderVisible: boolean;
     origin?: MapActionOrigin;
 }
+export interface SetTimeSliderWidthPayload {
+    mapId: string;
+    timeSliderWidth: number;
+}
 export interface SetTimeSliderCenterTimePayload {
     mapId: string;
     timeSliderCenterTime: number;
@@ -223,10 +210,6 @@ export interface SetTimeSliderSecondsPerPxPayload {
     mapId: string;
     timeSliderSecondsPerPx: number;
 }
-export interface SetTimeSliderDataScaleToSecondsPerPxPayload {
-    mapId: string;
-    timeSliderDataScaleToSecondsPerPx: number;
-}
 export interface ToggleZoomControlsPayload {
     mapId: string;
     shouldShowZoomControls: boolean;

package/src/lib/store/mapStore/map/utils.d.ts

@@ -1,7 +1,8 @@
 import { TimeInterval } from '@opengeoweb/webmap';
-import { Bbox, Dimension, Scale } from './types';
-import { WebMapState, WebMap } from '../types';
-import { Layer } from '../layers/types';
+import { Bbox, Dimension } from './types';
+import { Scale, Span } from './enums';
+import type { WebMapState, WebMap, SpeedFactorType } from '../types';
+import type { Layer } from '../layers/types';
 interface CreateMapProps {
     id: string;
     isAnimating?: boolean;
@@ -18,12 +19,12 @@ interface CreateMapProps {
     dimensions?: Dimension[];
     autoTimeStepLayerId?: string;
     autoUpdateLayerId?: string;
-    timeSliderScale?: Scale;
+    timeSliderSpan?: Span;
     timeStep?: number;
     animationDelay?: number;
+    timeSliderWidth?: number;
     timeSliderCenterTime?: number;
     timeSliderSecondsPerPx?: number;
-    timeSliderDataScaleToSecondsPerPx?: number;
     isTimestepAuto?: boolean;
     isTimeSliderHoverOn?: boolean;
     isTimeSliderVisible?: boolean;
@@ -31,7 +32,7 @@ interface CreateMapProps {
     disableMapPin?: boolean;
     shouldShowZoomControls?: boolean;
 }
-export declare const createMap: ({ id, isAnimating, animationStartTime, animationEndTime, isAutoUpdating, isEndTimeOverriding, bbox, srs, baseLayers, overLayers, mapLayers, featureLayers, dimensions, autoUpdateLayerId, autoTimeStepLayerId, timeSliderScale, timeStep, animationDelay, timeSliderCenterTime, timeSliderSecondsPerPx, timeSliderDataScaleToSecondsPerPx, isTimestepAuto, isTimeSliderHoverOn, isTimeSliderVisible, displayMapPin, disableMapPin, shouldShowZoomControls, }: CreateMapProps) => WebMap;
+export declare const createMap: ({ id, isAnimating, animationStartTime, animationEndTime, isAutoUpdating, isEndTimeOverriding, bbox, srs, baseLayers, overLayers, mapLayers, featureLayers, dimensions, autoUpdateLayerId, autoTimeStepLayerId, timeSliderSpan, timeStep, animationDelay, timeSliderWidth, timeSliderCenterTime, timeSliderSecondsPerPx, isTimestepAuto, isTimeSliderHoverOn, isTimeSliderVisible, displayMapPin, disableMapPin, shouldShowZoomControls, }: CreateMapProps) => WebMap;
 export declare const checkValidLayersPayload: (layers: Layer[], mapId: string) => boolean;
 /**
  * This will get the map from the map draftstate.
@@ -66,4 +67,32 @@ export declare const produceDraftStateSetMapDimensionFromLayerChangeDimension: (
 export declare function moveArrayElements(array: string[], oldIndex: number, newIndex: number): string[];
 export declare const getTimeStepFromDataInterval: (timeInterval: TimeInterval) => number;
 export declare const getActiveLayerTimeStep: (timeDimension: Dimension | undefined) => number | undefined;
+export declare const getSpeedFactor: (speedDelay: number) => SpeedFactorType;
+/**
+ * Returns speed delay for given speedFactor. For options, see defined above in "speedFactors"
+ */
+export declare const getSpeedDelay: (speedFactor: SpeedFactorType) => number;
+export declare const roundWithTimeStep: (unixTime: number, timeStep: number, type?: string | undefined) => number;
+/**
+ * In this Map collection all fundamental scales
+ * (Scale.Minutes5 ... Scale.Year) are mapped with their corresponding
+ * secondsPerPx numbers.
+ * @returns a Map including information explained above
+ */
+export declare const secondsPerPxToScale: Map<number, Scale>;
+export declare const secondsToSpan: Map<number, Span>;
+/**
+ * Here secondsPerPxToScale is converted to an iterator object and
+ * then keys are turned to values and values turned to keys
+ * to make it easier in some parts GeoWeb to fetch a secondsPerpx for
+ * a certain fundamental scale (Scale.Minutes5 ... Scale.year)
+ * @returns an Object, where names are fundamental scale values (0 - 7) and
+ * values are their corresponding secondsPerPx numbers.
+ */
+export declare const scaleToSecondsPerPx: {
+    [x in Scale]: number;
+};
+export declare const spanToSeconds: {
+    [x in Span]: number;
+};
 export {};

package/src/lib/store/mapStore/service/index.d.ts

@@ -1,2 +1,3 @@
 export { serviceActions } from './reducer';
 export * as serviceSelectors from './selectors';
+export * as serviceTypes from './types';

package/src/lib/store/mapStore/utils/helpers.d.ts

@@ -1,5 +1,5 @@
 import { WMJSMap, WMLayer } from '@opengeoweb/webmap';
-import { Dimension, WMJSDimension } from '../types';
+import type { Dimension, WMJSDimension } from '../types';
 export declare const dateFormat = "YYYY-MM-DDTHH:mm:ss[Z]";
 export declare const generateLayerId: () => string;
 export declare const generateMapId: () => string;

package/src/lib/store/mapStore/utils/index.d.ts

@@ -0,0 +1 @@
+export * as mapStoreUtils from './helpers';

package/src/lib/store/snackbar/index.d.ts

@@ -1,2 +1,3 @@
 export { snackbarActions } from './reducer';
 export * as snackbarSelectors from './selectors';
+export * as snackbarTypes from './types';

package/src/lib/store/ui/index.d.ts

@@ -1,2 +1,3 @@
 export { uiActions, reducer as uiReducer } from './reducer';
 export * as uiSelectors from './selectors';
+export * as uiTypes from './types';

package/src/lib/store/ui/selectors.d.ts

@@ -1,5 +1,5 @@
-import { AppStore } from '../../types/types';
-import { UIStoreType, UIType } from './types';
+import type { AppStore } from '../../types/types';
+import type { UIStoreType, UIType } from './types';
 export declare const getUiStore: (store: AppStore) => UIStoreType;
 /**
  * Gets the active map Id and wether a dialog is open or closed

package/src/lib/store/ui/types.d.ts

@@ -1,4 +1,4 @@
-import { MapActionOrigin } from '../mapStore/types';
+import { MapActionOrigin } from '../mapStore/map/enums';
 declare type LegendDialogType = string;
 declare type GetFeatureInfoDialogType = string;
 export declare enum DialogTypes {

package/src/lib/storybookUtils/HelperComponents.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { Layer } from '../store/mapStore/layers/types';
+import { layerTypes } from '../store';
 declare type ExampleLayer = {
     title: string;
-    layers: Layer[];
+    layers: layerTypes.Layer[];
 };
 interface ActionCardProps {
     onClickBtn?: (action: ExampleLayer) => void;

package/src/lib/storybookUtils/defaultStorySettings.d.ts

@@ -1,4 +1,4 @@
-import { Layer, Bbox, DeleteLayerPayload, SetLayerDimensionPayload, SetLayerEnabledPayload, SetLayerStylePayload, SetLayerNamePayload, SetLayerOpacityPayload } from '../store/mapStore/types';
+import { layerTypes, mapTypes } from '../store';
 import { LayerActions } from '../store/mapStore/layers/reducer';
 export declare const initialBbox: {
     srs: string;
@@ -9,12 +9,12 @@ export declare const initialBbox: {
         top: number;
     };
 };
-export declare const handleLayerActionsCallback: (payload: DeleteLayerPayload | SetLayerDimensionPayload | SetLayerEnabledPayload | SetLayerStylePayload | SetLayerNamePayload | SetLayerOpacityPayload) => LayerActions;
+export declare const handleLayerActionsCallback: (payload: layerTypes.DeleteLayerPayload | layerTypes.SetLayerDimensionPayload | layerTypes.SetLayerEnabledPayload | layerTypes.SetLayerStylePayload | layerTypes.SetLayerNamePayload | layerTypes.SetLayerOpacityPayload) => LayerActions;
 interface UseDefaultMapSettingsProps {
     mapId?: string;
-    layers?: Layer[];
-    baseLayers?: Layer[];
-    bbox?: Bbox;
+    layers?: layerTypes.Layer[];
+    baseLayers?: layerTypes.Layer[];
+    bbox?: mapTypes.Bbox;
     srs?: string;
     shouldAutoUpdate?: boolean;
 }

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

@@ -1,6 +1,5 @@
-import { WebMapStateModuleState } from '../store/mapStore/types';
-import { SynchronizationGroupModuleState } from '../store/generic/synchronizationGroups/types';
-import { UIModuleState } from '../store/ui/types';
-import { LayerSelectModuleState } from '../store/layerSelect/types';
-export interface AppStore extends SynchronizationGroupModuleState, UIModuleState, WebMapStateModuleState, LayerSelectModuleState {
+import type { WebMapStateModuleState } from '../store/mapStore/types';
+import type { SynchronizationGroupModuleState } from '../store/generic/synchronizationGroups/types';
+import { uiTypes, layerSelectTypes } from '../store';
+export interface AppStore extends SynchronizationGroupModuleState, uiTypes.UIModuleState, WebMapStateModuleState, layerSelectTypes.LayerSelectModuleState {
 }

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

@@ -1,5 +1,5 @@
 import { LayerTree } from '@opengeoweb/webmap';
-import { ServiceLayer } from '../../store/mapStore/types';
+import { serviceTypes } from '../../store';
 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";
@@ -85,4 +85,4 @@ export declare const mockLayersDefault2: {
     children: never[];
 };
 export declare const getLayersFromService: (url: string) => Promise<LayerTree>;
-export declare const getLayersFlattenedFromService: (url: string) => Promise<ServiceLayer[]>;
+export declare const getLayersFlattenedFromService: (url: string) => Promise<serviceTypes.ServiceLayer[]>;

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

@@ -1,7 +1,6 @@
 import { CoordinateReferenceSystem, LayerOptions, Style, WMLayer } from '@opengeoweb/webmap';
 import { Service } from '../components/WMSLoader/services';
-import { ActiveLayerObject } from '../store/layerSelect/types';
-import { Layer, LayerType, Services } from '../store/mapStore/types';
+import { layerTypes, serviceTypes, layerSelectTypes } from '../store';
 export declare const defaultReduxLayerRadarColor: {
     service: string;
     name: string;
@@ -9,7 +8,7 @@ export declare const defaultReduxLayerRadarColor: {
     format: string;
     style: string;
     enabled: boolean;
-    layerType: LayerType;
+    layerType: layerTypes.LayerType;
     dimensions: never[];
     styles: {
         title: string;
@@ -26,7 +25,7 @@ export declare const defaultReduxLayerRadarKNMI: {
     format: string;
     style: string;
     enabled: boolean;
-    layerType: LayerType;
+    layerType: layerTypes.LayerType;
     dimensions: {
         name: string;
         units: string;
@@ -45,17 +44,17 @@ export declare const makeGeoservicesRadarLayer: () => WMLayer;
 export declare const styleListForRADNL25PCPCMLayer: Style[];
 export declare const crsListForRADNL25PCPCMLayer: CoordinateReferenceSystem[];
 export declare const styleListForRADNLOPERR25PCPRRL3KNMILayer: Style[];
-export declare const defaultReduxServices: Services;
-export declare const defaultReduxActiveLayers: ActiveLayerObject[];
-export declare const defaultReduxActiveLayersWithoutOptionalVariables: ActiveLayerObject[];
-export declare const multiDimensionLayer: Layer;
-export declare const flDimensionLayer: Layer;
+export declare const defaultReduxServices: serviceTypes.Services;
+export declare const defaultReduxActiveLayers: layerSelectTypes.ActiveLayerObject[];
+export declare const defaultReduxActiveLayersWithoutOptionalVariables: layerSelectTypes.ActiveLayerObject[];
+export declare const multiDimensionLayer: layerTypes.Layer;
+export declare const flDimensionLayer: layerTypes.Layer;
 export declare const WmMultiDimensionLayer: WMLayer;
-export declare const multiDimensionLayer2: Layer;
-export declare const multiDimensionLayer3: Layer;
+export declare const multiDimensionLayer2: layerTypes.Layer;
+export declare const multiDimensionLayer3: layerTypes.Layer;
 export declare const WmMultiDimensionLayer2: WMLayer;
 export declare const WmMultiDimensionLayer3: WMLayer;
-export declare const WmMultiDimensionServices: Services;
+export declare const WmMultiDimensionServices: serviceTypes.Services;
 export declare const layerWithoutTimeDimension: LayerOptions;
 export declare const WmLayerWithoutTimeDimension: WMLayer;
 export declare const defaultTestServices: Service[];

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

@@ -1,9 +1,9 @@
 import { Service } from '../components/WMSLoader/services';
-import { Layer } from '../store/mapStore/types';
+import { layerTypes } from '../store';
 declare type FilteredLayerList = {
-    mapLayers: Layer[];
-    baseLayers: Layer[];
-    overLayers?: Layer[];
+    mapLayers: layerTypes.Layer[];
+    baseLayers: layerTypes.Layer[];
+    overLayers?: layerTypes.Layer[];
 };
 interface FilteredMapPresets extends FilteredLayerList {
     services?: Service[];
@@ -15,15 +15,15 @@ export interface InitialAppPresetProps {
     presetName?: string;
     services?: Service[];
     baseServices?: Service[];
-    layers?: Layer[];
-    baseLayers?: Layer[];
+    layers?: layerTypes.Layer[];
+    baseLayers?: layerTypes.Layer[];
 }
 export interface InitialAppPreset {
     preset: InitialAppPresetProps;
 }
 export declare const parseBoolean: (value: string | boolean) => boolean;
-export declare const parseLayer: (layer: Layer) => Layer;
-export declare const filterLayers: (layers?: Layer[], layerParser?: (layer: Layer) => Layer) => FilteredLayerList;
+export declare const parseLayer: (layer: layerTypes.Layer) => layerTypes.Layer;
+export declare const filterLayers: (layers?: layerTypes.Layer[], layerParser?: (layer: layerTypes.Layer) => layerTypes.Layer) => FilteredLayerList;
 export declare const filterServices: (presetArray: Service[]) => Service[];
 export declare const filterMapPresets: (initialAppPreset: InitialAppPreset) => FilteredMapPresets;
 export declare const getInitialAppPresets: (mapPreset: InitialAppPreset, defaultInitialPresets: InitialAppPreset) => InitialAppPresetProps;