@opengeoweb/store 9.9.0 → 9.10.1

package/package.json

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

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

@@ -36,3 +36,8 @@ export declare const getShouldAllowMultipleShapes: ((state: DrawtoolModuleStore,
 }> & {
     clearCache: () => void;
 };
+export declare const getActiveDrawMode: ((state: DrawtoolModuleStore, id: import("@reduxjs/toolkit").EntityId) => import("dist/libs/webmap-react/src").DrawMode | undefined) & import("reselect").OutputSelectorFields<(args_0: import("./reducer").DrawToolItem | undefined) => import("dist/libs/webmap-react/src").DrawMode | undefined, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

package/src/store/generic/synchronizationActions/actions.d.ts

@@ -5,7 +5,7 @@ import type { SetBboxSyncActionPayload, SetBboxSyncPayload, SetLayerActionsSyncP
  *
  * These actions should not be used by components directly. Components should only use the generic actions.
  */
-export declare const setTimeSync: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetTimePayload, targets: SetTimeSyncPayload[], groups: string[]], SetTimeSyncActionPayload, "GENERIC_SYNC_SETTIME", never, never>;
+export declare const setTimeSync: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[setTimePayload: SetTimePayload | null, targets: SetTimeSyncPayload[], groups: string[]], SetTimeSyncActionPayload, "GENERIC_SYNC_SETTIME", never, never>;
 export declare const setBboxSync: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetBboxPayload, targets: SetBboxSyncPayload[], groups: string[]], SetBboxSyncActionPayload, "GENERIC_SYNC_SETBBOX", never, never>;
 export declare const setLayerActionSync: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SyncLayerPayloads, targets: SyncLayerPayloads[], type: string], SetLayerActionsSyncPayload, "GENERIC_SYNC_SETLAYERACTIONS", never, never>;
 export type GenericSyncActions = ReturnType<typeof setTimeSync> | ReturnType<typeof setBboxSync> | ReturnType<typeof setLayerActionSync>;

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

@@ -18,16 +18,16 @@ export interface SetLayerActionsSyncPayload {
     source: {
         type: string;
         payload: SyncLayerPayloads;
-    };
+    } | null;
     targets: SyncLayerPayloads[];
 }
 export interface SetTimeSyncActionPayload {
-    source: ReturnType<typeof setTime>;
+    source: ReturnType<typeof setTime> | null;
     groups: string[];
     targets: SetTimeSyncPayload[];
 }
 export interface SetBboxSyncActionPayload {
-    source: ReturnType<typeof setBbox>;
+    source: ReturnType<typeof setBbox> | null;
     groups: string[];
     targets: SetBboxSyncPayload[];
 }

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

@@ -136,6 +136,7 @@ export interface UpdateFeaturePayload extends LayerPayload {
     reason?: string;
     geoJSONIntersectionLayerId?: string;
     geoJSONIntersectionBoundsLayerId?: string;
+    selectionType?: string;
 }
 export interface UpdateFeaturePropertiesPayload extends LayerPayload {
     properties: GeoJSON.GeoJsonProperties;

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

@@ -0,0 +1,30 @@
+import { SetTimeSyncPayload } from '../../generic/synchronizationActions/types';
+/**
+ * Returns the next step for given timerId.
+ * @param timerId The timer id
+ * @param numberOfStepsInAnimation Animation length in steps
+ * @param numStepsToGoForward Amount of steps to go forwards, defaults to 1. Can be positive and negative
+ * @returns
+ */
+export declare const getNextStep: (timerId: string, numberOfStepsInAnimation: number, numStepsToGoForward?: number) => number;
+/**
+ * Set step for the timerId
+ * @param timerId
+ * @param timerStep
+ */
+export declare const setStep: (timerId: string, timerStep: number) => void;
+/**
+ * Gets the current step for the timer
+ * @param timerId
+ * @returns
+ */
+export declare const getCurrentStep: (timerId: string) => number;
+export declare const MAX_NUMBER_STEPS_FORWARD_TO_PREFETCH = 2;
+/**
+ * This prefetches all images connected to the same sync group as provided timerId
+ * @param timerId The timerId
+ * @param animationListValues List of animation steps in isostring to animate
+ * @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;

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

@@ -1,24 +1,34 @@
-import { SagaIterator } from 'redux-saga';
-import { AnimationStep } from '@opengeoweb/webmap';
+import { EventChannel, SagaIterator } from 'redux-saga';
 import { mapActions } from '.';
 import { layerActions } from '../layers';
 import { Layer } from '../layers/types';
-export declare const generateTimeList: (start: Date, end: Date, interval: number) => {
-    name: string;
-    value: string;
-}[];
 export declare const getAnimationEndTime: (animationEndTime: string) => string;
 export declare const isAnimationEndTimeValid: (animationEndTime: string) => boolean;
-export declare function updateMapDraw(mapId: string, draw: string | AnimationStep[] | undefined, initialAnimationStep?: number): void;
 export declare function startAnimationSaga({ payload, }: ReturnType<typeof mapActions.mapStartAnimation>): Generator;
 export declare function stopAnimationSaga({ payload, }: ReturnType<typeof mapActions.mapStopAnimation>): Generator;
 export declare function deleteLayerSaga({ payload, }: ReturnType<typeof layerActions.layerDelete>): SagaIterator;
 export declare function updateAnimation(mapId: string, maxValue: string): SagaIterator;
-export declare function setLayerDimensionsSaga({ payload, }: ReturnType<typeof layerActions.onUpdateLayerInformation>): SagaIterator;
+export declare function updateAnimationWithLatestUpdate({ payload, }: ReturnType<typeof layerActions.onUpdateLayerInformation>): SagaIterator;
 export declare function toggleAutoUpdateSaga({ payload, }: ReturnType<typeof mapActions.toggleAutoUpdate>): SagaIterator;
 export declare function handleBaseLayersSaga(mapId: string, baseLayers: Layer[]): SagaIterator;
 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

@@ -1,6 +1,6 @@
 import type { Bbox, MapPreset, WebMap, WebMapState } from './types';
 import type { CoreAppStore } from '../../types';
-import type { Dimension, Layer } from '../types';
+import type { Dimension, Layer, WebMapAnimationList } from '../types';
 import type { uiTypes } from '../../ui';
 /**
  * Gets the map state by mapId
@@ -692,3 +692,14 @@ export declare const getDockedLayerManagerSize: ((state: any, mapId: any) => imp
 }> & {
     clearCache: () => void;
 };
+/**
+ * Returns the animation list for given map id
+ * @param {object} store store: object - store object
+ * @param {string} mapId mapId: string - Id of the map
+ * @returns {animationList} returnType: WebMapAnimationList, list of timesteps to animate for this map.
+ */
+export declare const getAnimationList: ((state: any, mapId: any) => WebMapAnimationList) & import("reselect").OutputSelectorFields<(args_0: WebMap | undefined, args_1: string | undefined, args_2: string | undefined, args_3: number) => WebMapAnimationList, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

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

@@ -13,11 +13,16 @@ export interface Dimension {
     validSyncSelection?: boolean;
     values?: string;
 }
+export type WebMapAnimationList = {
+    name: string;
+    value: string;
+}[];
 export interface WebMap {
     id: string;
     isAnimating: boolean;
     animationStartTime?: string;
     animationEndTime?: string;
+    timeList?: WebMapAnimationList | undefined;
     isAutoUpdating: boolean;
     shouldEndtimeOverride: boolean;
     srs: string;

package/src/store/testUtils/Providers.d.ts

@@ -1,15 +1,13 @@
 import React from 'react';
-import { ThemeProviderProps } from '@opengeoweb/theme';
 import { Store } from '@reduxjs/toolkit';
 export declare const createStore: () => Store;
-interface ThemeStoreProviderProps extends ThemeProviderProps {
-    store: Store;
-}
 /**
  * A Provider component which provides the GeoWeb theme and store for the core.
  * Note: Should only be used with core components, as the provided store is only for core.
  * @param children
  * @returns
  */
-export declare const ThemeStoreProvider: React.FC<ThemeStoreProviderProps>;
-export {};
+export declare const StoreProvider: React.FC<{
+    children?: React.ReactNode;
+    store: Store;
+}>;

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

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

package/src/store/ui/listener.spec.d.ts

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

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

@@ -1,5 +0,0 @@
-import { SagaIterator } from 'redux-saga';
-export declare function registerMapUISaga(): SagaIterator;
-export declare function unregisterUIMapSaga(): SagaIterator;
-export declare function rootSaga(): SagaIterator;
-export default rootSaga;