@opengeoweb/store 9.10.2 → 9.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/store",
-  "version": "9.10.2",
+  "version": "9.12.0",
   "description": "GeoWeb Store library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -18,7 +18,9 @@
     "immer": "^10.0.3",
     "@redux-eggs/redux-toolkit": "^2.2.0",
     "@redux-eggs/saga-extension": "^2.2.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "@opengeoweb/metronome": "*",
+    "@opengeoweb/timeslider": "*"
   },
   "peerDependencies": {
     "react": "18"

package/src/store/generic/index.d.ts

@@ -14,3 +14,4 @@ export declare const genericActions: {
 export * as genericSelectors from './selectors';
 export * from './synchronizationGroups';
 export * as genericTypes from './types';
+export * from './loadingIndicator';

package/src/store/generic/loadingIndicator/constants.d.ts

@@ -0,0 +1 @@
+export declare const ANY_EDR_SERVICE = "any_edr";

package/src/store/generic/loadingIndicator/index.d.ts

@@ -0,0 +1,3 @@
+export { loadingIndicatorActions, loadingIndicatorReducer } from './reducer';
+export * as loadingIndicatorSelectors from './selectors';
+export * as loadingIndicatorConstants from './constants';

package/src/store/generic/loadingIndicator/reducer.d.ts

@@ -0,0 +1,13 @@
+import { PayloadAction, EntityState } from '@reduxjs/toolkit';
+import { LoadingIndicatorType, SetIsEDRLoadingPayload, SetIsGetCapabilitiesLoadingPayload, SetIsGetMapLoadingPayload } from './types';
+export declare const loadingIndicatorAdapter: import("@reduxjs/toolkit").EntityAdapter<LoadingIndicatorType>;
+export declare const slice: import("@reduxjs/toolkit").Slice<EntityState<LoadingIndicatorType>, {
+    setGetMapIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsGetMapLoadingPayload>) => void;
+    setGetCapabilitiesIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsGetCapabilitiesLoadingPayload>) => void;
+    setEDRIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsEDRLoadingPayload>) => void;
+}, "loadingIndicatorReducer">;
+export declare const loadingIndicatorActions: import("@reduxjs/toolkit").CaseReducerActions<{
+    setGetMapIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsGetMapLoadingPayload>) => void;
+    setGetCapabilitiesIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsGetCapabilitiesLoadingPayload>) => void;
+    setEDRIsLoading: (draft: EntityState<LoadingIndicatorType>, action: PayloadAction<SetIsEDRLoadingPayload>) => void;
+}, "loadingIndicatorReducer">, loadingIndicatorReducer: import("redux").Reducer<EntityState<LoadingIndicatorType>, import("redux").AnyAction>;

package/src/store/generic/loadingIndicator/selectors.d.ts

@@ -0,0 +1,22 @@
+import { LoadingIndicatorModuleState, LoadingIndicatorType } from './types';
+export declare const selectLoadingIndicatorById: (state: LoadingIndicatorModuleState, id: import("@reduxjs/toolkit").EntityId) => LoadingIndicatorType | undefined;
+export declare const isGetMapLoading: ((state: LoadingIndicatorModuleState, id: import("@reduxjs/toolkit").EntityId) => boolean) & import("reselect").OutputSelectorFields<(args_0: LoadingIndicatorType | undefined) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const isGetCapabilitiesLoading: ((state: LoadingIndicatorModuleState, id: import("@reduxjs/toolkit").EntityId) => boolean) & import("reselect").OutputSelectorFields<(args_0: LoadingIndicatorType | undefined) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const isEDRLoading: ((state: LoadingIndicatorModuleState, id: import("@reduxjs/toolkit").EntityId) => boolean) & import("reselect").OutputSelectorFields<(args_0: LoadingIndicatorType | undefined) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const isLoading: ((state: LoadingIndicatorModuleState, id: import("@reduxjs/toolkit").EntityId) => boolean) & import("reselect").OutputSelectorFields<(args_0: boolean, args_1: boolean, args_2: boolean, args_3: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

package/src/store/generic/loadingIndicator/types.d.ts

@@ -0,0 +1,22 @@
+import { EntityState } from '@reduxjs/toolkit';
+export interface LoadingIndicatorType {
+    id: string;
+    isGetMapLoading: boolean;
+    isGetCapabilitiesLoading: boolean;
+    isEDRLoading: boolean;
+}
+export interface LoadingIndicatorModuleState {
+    loadingIndicatorStore?: EntityState<LoadingIndicatorType>;
+}
+export interface SetIsGetMapLoadingPayload {
+    id: string;
+    isGetMapLoading: boolean;
+}
+export interface SetIsGetCapabilitiesLoadingPayload {
+    id: string;
+    isGetCapabilitiesLoading: boolean;
+}
+export interface SetIsEDRLoadingPayload {
+    id: string;
+    isEDRLoading: boolean;
+}

package/src/store/index.d.ts

@@ -3,7 +3,6 @@ export * from './ui';
 export * from './generic';
 export { rootSaga as genericSaga } from './generic/sagas';
 export * from './router';
-export * from './app';
 export * from './drawingtool';
 export * from './types';
 export * as storeTestUtils from './mapStore/storeTestUtils';

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

@@ -32,7 +32,6 @@ export declare const mapStoreActions: {
     }, "mapReducer/setAutoUpdateLayerId">;
     setTimeSliderWidth: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetTimeSliderWidthPayload, "mapReducer/setTimeSliderWidth">;
     setTimeSliderCenterTime: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetTimeSliderCenterTimePayload, "mapReducer/setTimeSliderCenterTime">;
-    setTimeSliderUnfilteredSelectedTime: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetTimeSliderUnfilteredSelectedTimePayload, "mapReducer/setTimeSliderUnfilteredSelectedTime">;
     setTimeSliderSecondsPerPx: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetTimeSliderSecondsPerPxPayload, "mapReducer/setTimeSliderSecondsPerPx">;
     toggleAutoUpdate: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").ToggleAutoUpdatePayload, "mapReducer/toggleAutoUpdate">;
     setEndTimeOverriding: import("@reduxjs/toolkit").ActionCreatorWithPayload<import("./types").SetEndTimeOverriding, "mapReducer/setEndTimeOverriding">;

package/src/store/mapStore/layers/types.d.ts

@@ -88,7 +88,7 @@ export interface SetLayerGeojsonPayload extends LayerPayload {
 }
 export interface DeleteLayerPayload extends LayerPayload {
     mapId: string;
-    layerIndex: number;
+    layerIndex?: number;
     origin?: LayerActionOrigin | SyncGroupActionOrigin.delete;
 }
 export interface AddLayerPayload {

package/src/store/mapStore/map/constants.d.ts

@@ -1,6 +1 @@
-export declare const defaultAnimationDelayAtStart = 250;
-export declare const defaultDelay = 1000;
-export declare const defaultTimeStep = 60;
-export declare const defaultSecondsPerPx = 80;
-export declare const defaultTimeSpan: number;
 export declare const IS_LEGEND_OPEN_BY_DEFAULT = false;

package/src/store/mapStore/map/enums.d.ts

@@ -1,23 +1,3 @@
-export declare enum Scale {
-    Minutes5 = 0,
-    Hour = 1,
-    Hours3 = 2,
-    Hours6 = 3,
-    Day = 4,
-    Week = 5,
-    Month = 6,
-    Year = 7
-}
-export declare enum AnimationLength {
-    Minutes15 = 15,
-    Minutes30 = 30,
-    Hours1 = 60,
-    Hours2 = 120,
-    Hours3 = 180,
-    Hours6 = 360,
-    Hours12 = 720,
-    Hours24 = 1440
-}
 export declare enum MapActionOrigin {
     map = "map"
 }

package/src/store/mapStore/map/index.d.ts

@@ -11,26 +11,13 @@ export declare const mapUtils: {
     findMapIdFromLayerId: (mapState?: mapTypes.WebMapState | undefined, layerId?: string | undefined) => string | null;
     produceDraftStateSetMapDimensionFromLayerChangeDimension: (draft: mapTypes.WebMapState, layerId: string, dimension: mapTypes.Dimension) => void;
     getTimeStepFromDataInterval: (timeInterval: import("dist/libs/webmap/src").TimeInterval) => number;
-    getSpeedFactor: (speedDelay: number) => mapTypes.SpeedFactorType;
+    getSpeedFactor: (speedDelay: number) => import("dist/libs/timeslider/src").SpeedFactorType;
     getAnimationDuration: (animationEndTime: string | undefined, animationStartTime: string | undefined) => number;
-    getSpeedDelay: (speedFactor: mapTypes.SpeedFactorType) => number;
-    roundWithTimeStep: (unixTime: number, timeStep: number, type?: string | undefined) => number;
-    secondsPerPxToScale: Map<number, import("./enums").Scale>;
-    scaleToSecondsPerPx: {
-        0: number;
-        1: number;
-        2: number;
-        3: number;
-        4: number;
-        5: number;
-        6: number;
-        7: number;
-    };
 };
 export { mapTypes };
 export { mapActions, reducer as webmapReducer } from './reducer';
 export * as mapSelectors from './selectors';
 export * as mapEnums from './enums';
-export * as mapConstants from './constants';
+export * from './constants';
 export { defaultLayers } from '@opengeoweb/webmap-react';
 export * as filterLayers from './filterLayers';

package/src/store/mapStore/map/listener.d.ts

@@ -0,0 +1,2 @@
+import { CoreAppStore } from '../../types';
+export declare const metronomeListener: import("@reduxjs/toolkit").ListenerMiddlewareInstance<CoreAppStore, import("@reduxjs/toolkit").ThunkDispatch<CoreAppStore, unknown, import("redux").AnyAction>, unknown>;

package/src/store/mapStore/map/{mapSagaAnimationUtils.d.ts → mapListenerAnimationUtils.d.ts}

@@ -27,4 +27,4 @@ export declare const MAX_NUMBER_STEPS_FORWARD_TO_PREFETCH = 2;
  * @param targets List of targets to check
  * @returns True if all maps are ready to go forward, false if the map has no data to display yet.
  */
-export declare const prefetchAnimationTargetsForSaga: (timerId: string, animationListValues: string[], targets: SetTimeSyncPayload[]) => boolean;
+export declare const prefetchAnimationTargetsForMetronome: (timerId: string, animationListValues: string[], targets: SetTimeSyncPayload[]) => boolean;

package/src/store/mapStore/map/mapListenerAnimationUtils.spec.d.ts

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

package/src/store/mapStore/map/reducer.d.ts

@@ -1,7 +1,7 @@
 import { PayloadAction, Draft } from '@reduxjs/toolkit';
 import { MapPinLocationPayload, SetBboxPayload, SetStepBackWardOrForward, UpdateAllMapDimensionsPayload } from '@opengeoweb/webmap-react';
 import type { WebMapState, SetAutoLayerIdPayload, SetMapAnimationStartPayload, SetMapAnimationStopPayload, SetTimeSliderSpanPayload, SetTimeStepPayload, SetAnimationStartTimePayload, SetAnimationEndTimePayload, SetAnimationDelayPayload, MoveLayerPayload, SetTimeSliderWidthPayload, SetTimeSliderCenterTimePayload, SetEndTimeOverriding, ToggleAutoUpdatePayload, ToggleTimestepAutoPayload, ToggleTimeSpanAutoPayload, ToggleTimeSliderHoverPayload, DisableMapPinPayload, SetTimeSliderSecondsPerPxPayload, ToggleTimeSliderIsVisiblePayload, SetDockedLayerManagerSize } from './types';
-import { ToggleMapPinIsVisiblePayload, ToggleZoomControlsPayload, SetTimeSliderUnfilteredSelectedTimePayload } from '../types';
+import { ToggleMapPinIsVisiblePayload, ToggleZoomControlsPayload } from '../types';
 /**
  * Checks if the layer id is already taken in one of the maps.
  * @param state The WebMapState
@@ -39,7 +39,6 @@ export declare const slice: import("@reduxjs/toolkit").Slice<WebMapState, {
     }>) => void;
     setTimeSliderWidth: (draft: Draft<WebMapState>, action: PayloadAction<SetTimeSliderWidthPayload>) => void;
     setTimeSliderCenterTime: (draft: Draft<WebMapState>, action: PayloadAction<SetTimeSliderCenterTimePayload>) => void;
-    setTimeSliderUnfilteredSelectedTime: (draft: Draft<WebMapState>, action: PayloadAction<SetTimeSliderUnfilteredSelectedTimePayload>) => void;
     setTimeSliderSecondsPerPx: (draft: Draft<WebMapState>, action: PayloadAction<SetTimeSliderSecondsPerPxPayload>) => void;
     toggleAutoUpdate: (draft: Draft<WebMapState>, action: PayloadAction<ToggleAutoUpdatePayload>) => void;
     setEndTimeOverriding: (draft: Draft<WebMapState>, action: PayloadAction<SetEndTimeOverriding>) => void;
@@ -88,7 +87,6 @@ export declare const mapActions: {
     }, "mapReducer/setAutoUpdateLayerId">;
     setTimeSliderWidth: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetTimeSliderWidthPayload, "mapReducer/setTimeSliderWidth">;
     setTimeSliderCenterTime: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetTimeSliderCenterTimePayload, "mapReducer/setTimeSliderCenterTime">;
-    setTimeSliderUnfilteredSelectedTime: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetTimeSliderUnfilteredSelectedTimePayload, "mapReducer/setTimeSliderUnfilteredSelectedTime">;
     setTimeSliderSecondsPerPx: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetTimeSliderSecondsPerPxPayload, "mapReducer/setTimeSliderSecondsPerPx">;
     toggleAutoUpdate: import("@reduxjs/toolkit").ActionCreatorWithPayload<ToggleAutoUpdatePayload, "mapReducer/toggleAutoUpdate">;
     setEndTimeOverriding: import("@reduxjs/toolkit").ActionCreatorWithPayload<SetEndTimeOverriding, "mapReducer/setEndTimeOverriding">;

package/src/store/mapStore/map/sagas.d.ts

@@ -1,4 +1,4 @@
-import { EventChannel, SagaIterator } from 'redux-saga';
+import { SagaIterator } from 'redux-saga';
 import { mapActions } from '.';
 import { layerActions } from '../layers';
 import { Layer } from '../layers/types';
@@ -14,21 +14,5 @@ export declare function handleBaseLayersSaga(mapId: string, baseLayers: Layer[])
 export declare function setMapPresetSaga({ payload, }: ReturnType<typeof mapActions.setMapPreset>): SagaIterator;
 export declare function unregisterMapSaga({ payload, }: ReturnType<typeof mapActions.unregisterMap>): Generator;
 export declare function setStepBackwardOrForwardSaga({ payload, }: ReturnType<typeof mapActions.setStepBackwardOrForward>): Generator;
-/**
- * This saga is triggered by the metronome. An array of timerIds is given as argument.
- * It will update the animation loop of multiple maps and sliders
- * It will prefetch images for maps
- * @param timerIds string[] array of timerIds
- */
-export declare function metronomeSaga(timerIds: string[]): SagaIterator;
-/**
- * Creates a channel for the metronome
- * @returns
- */
-export declare function metronomeTicker(): EventChannel<string[]>;
-/**
- * Makes a saga channel for the metronome ticker
- */
-export declare function metronomeSagaWithChannel(): SagaIterator;
 export declare function rootSaga(): SagaIterator;
 export default rootSaga;

package/src/store/mapStore/map/selectors.d.ts

@@ -414,20 +414,6 @@ export declare const getMapTimeSliderCenterTime: ((state: any, mapId: any) => nu
 }> & {
     clearCache: () => void;
 };
-/**
- * Returns the unfiltered selected time of time slider
- * This is not used to set the selected time itself, which is controlled by TimeBounds where values are rounded.
- *
- * Example: selectedTime = getTimeSliderUnfliteredSelectedTime(store, 'mapid_1')
- * @param {object} store store: object - store object
- * @param {string} mapId mapId: string - Id of the map
- * @returns {number} returnType: number - unfiltered selected time as a unix timestamp
- */
-export declare const getTimeSliderUnfilteredSelectedTime: ((state: any, mapId: any) => number | undefined) & import("reselect").OutputSelectorFields<(args_0: WebMap | undefined, args_1: number) => number | undefined, {
-    clearCache: () => void;
-}> & {
-    clearCache: () => void;
-};
 /**
  * Returns the number of seconds per pixel on the time slider
  *

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

@@ -1,5 +1,6 @@
 import { TimeInterval } from '@opengeoweb/webmap';
 import { MapLocation } from '@opengeoweb/webmap-react';
+import { SpeedFactorType } from '@opengeoweb/timeslider';
 import type { Layer, LayerActionOrigin } from '../types';
 import { MapActionOrigin } from './enums';
 export interface Dimension {
@@ -39,7 +40,6 @@ export interface WebMap {
     animationDelay?: number;
     timeSliderWidth?: number;
     timeSliderCenterTime?: number;
-    timeSliderUnfilteredSelectedTime?: number;
     timeSliderSecondsPerPx?: number;
     isTimestepAuto?: boolean;
     isTimeSpanAuto?: boolean;
@@ -73,7 +73,6 @@ export declare enum AnimationLength {
     Hours12 = 720,
     Hours24 = 1440
 }
-export type SpeedFactorType = 0.1 | 0.2 | 0.5 | 1 | 2 | 4 | 8 | 16;
 export interface AnimationPayloadType {
     duration?: number;
     interval?: number;
@@ -197,10 +196,6 @@ export interface SetTimeSliderCenterTimePayload {
     mapId: string;
     timeSliderCenterTime: number;
 }
-export interface SetTimeSliderUnfilteredSelectedTimePayload {
-    mapId: string;
-    timeSliderUnfilteredSelectedTime: number;
-}
 export interface SetTimeSliderSecondsPerPxPayload {
     mapId: string;
     timeSliderSecondsPerPx: number;

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

@@ -1,7 +1,7 @@
 import { TimeInterval } from '@opengeoweb/webmap';
+import { SpeedFactorType } from '@opengeoweb/timeslider';
 import { Bbox, Dimension } from './types';
-import { Scale } from './enums';
-import type { WebMapState, WebMap, SpeedFactorType } from '../types';
+import type { WebMapState, WebMap } from '../types';
 import type { Layer } from '../layers/types';
 export declare const dateFormat = "yyyy-MM-dd'T'HH:mm:ss'Z";
 export interface CreateMapProps {
@@ -70,25 +70,3 @@ export declare function moveArrayElements<T>(array: T[], oldIndex: number, newIn
 export declare const getTimeStepFromDataInterval: (timeInterval: TimeInterval) => number;
 export declare const getSpeedFactor: (speedDelay: number) => SpeedFactorType;
 export declare const getAnimationDuration: (animationEndTime: string | undefined, animationStartTime: string | undefined) => number;
-/**
- * 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) => 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>;
-/**
- * Creates a reverse mapping of scales to their corresponding secondsPerPx
- * values 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;
-};

package/src/store/types.d.ts

@@ -2,5 +2,6 @@ import type { WebMapStateModuleState } from './mapStore/types';
 import type { SynchronizationGroupModuleState } from './generic/synchronizationGroups/types';
 import type { uiTypes } from '.';
 import type { DrawtoolModuleStore } from './drawingtool';
-export interface CoreAppStore extends SynchronizationGroupModuleState, uiTypes.UIModuleState, WebMapStateModuleState, DrawtoolModuleStore {
+import type { LoadingIndicatorModuleState } from './generic/loadingIndicator/types';
+export interface CoreAppStore extends SynchronizationGroupModuleState, LoadingIndicatorModuleState, uiTypes.UIModuleState, WebMapStateModuleState, DrawtoolModuleStore {
 }

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

@@ -70,7 +70,23 @@ export declare const getDialogSource: ((state: CoreAppStore, dialogType: string)
  * @param {object} store store object from which the window state will be extracted
  * @returns {string} active window id
  */
-export declare const getActiveWindowId: (store: CoreAppStore) => string;
+export declare const getActiveWindowId: ((state: CoreAppStore) => string) & import("reselect").OutputSelectorFields<(args_0: UIStoreType) => string, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+/**
+ * Gets if this is the active window
+ *
+ * Example: getIsActiveWindowId(store, viewId)
+ * @param {object} store store object from which the window state will be extracted
+ * @returns {string} active window id
+ */
+export declare const getIsActiveWindowId: ((state: CoreAppStore, viewId: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: UIStoreType, args_1: string) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 export declare const getDialogIsLoading: ((state: CoreAppStore, dialogType: string) => boolean) & import("reselect").OutputSelectorFields<(args_0: UIType) => boolean, {
     clearCache: () => void;
 }> & {

package/src/store/app/config.d.ts

@@ -1,4 +0,0 @@
-import { Store } from '@reduxjs/toolkit';
-import { Egg } from '@redux-eggs/core';
-import { AppModuleStore } from './types';
-export declare const appModuleConfig: Egg<Store<AppModuleStore>>;

package/src/store/app/index.d.ts

@@ -1,2 +0,0 @@
-export { appActions } from './reducer';
-export * from './config';

package/src/store/app/reducer.d.ts

@@ -1,15 +0,0 @@
-import { Draft } from '@reduxjs/toolkit';
-interface InitialState {
-    isInitialised: boolean;
-}
-export declare const initialState: {
-    isInitialised: boolean;
-};
-export declare const reducer: import("redux").Reducer<{
-    isInitialised: boolean;
-}, import("redux").AnyAction>;
-export declare const appActions: import("@reduxjs/toolkit").CaseReducerActions<{
-    initialiseApp: (draft: Draft<InitialState>) => void;
-}, "app">;
-export type AppActions = ReturnType<typeof appActions.initialiseApp>;
-export {};

package/src/store/app/types.d.ts

@@ -1,6 +0,0 @@
-export interface AppStoreState {
-    isInitialised: boolean;
-}
-export interface AppModuleStore {
-    app?: AppStoreState;
-}