@opengeoweb/store 11.1.0 → 12.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/store",
-  "version": "11.1.0",
+  "version": "12.1.0",
   "description": "GeoWeb Store library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -8,16 +8,17 @@
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
   "dependencies": {
-    "@opengeoweb/shared": "*",
+    "@opengeoweb/shared": "12.1.0",
     "react-redux": "^8.1.3",
     "@reduxjs/toolkit": "^1.9.7",
-    "@opengeoweb/webmap-react": "*",
-    "@opengeoweb/webmap": "*",
+    "@opengeoweb/webmap-react": "12.1.0",
+    "@opengeoweb/webmap": "12.1.0",
     "immer": "^10.0.3",
     "lodash": "^4.17.21",
-    "@opengeoweb/metronome": "*",
-    "@opengeoweb/timeslider": "*",
+    "@opengeoweb/metronome": "12.1.0",
+    "@opengeoweb/timeslider": "12.1.0",
     "react-router-dom": "^6.23.1",
+    "ol": "^10.4.0",
     "@turf/turf": "^7.2.0"
   },
   "peerDependencies": {

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

@@ -1,5 +1,5 @@
 import type { CoreAppStore } from '../types';
-import type { LinkedState, SynchronizationGroupState, SynchronizationSource } from './syncGroups/types';
+import type { LinkedState, PotentialData, SynchronizationGroupState, SynchronizationSource } from './syncGroups/types';
 export declare const getSynchronizationGroupStore: ((state: CoreAppStore) => SynchronizationGroupState) & import("reselect").OutputSelectorFields<(args_0: SynchronizationGroupState) => SynchronizationGroupState, {
     clearCache: () => void;
 }> & {
@@ -16,7 +16,7 @@ export declare const getLinkedMaps: ((state: any, panelId: string) => string[])
     clearCache: () => void;
 };
 export declare const getLinkedFeatureProviders: (linkedState: LinkedState, mapId: string) => string[];
-export declare const selectSharedData: ((state: any, panelId: string) => import("./syncGroups/types").PotentialData) & import("reselect").OutputSelectorFields<(args_0: LinkedState, args_1: string) => import("./syncGroups/types").PotentialData, {
+export declare const selectSharedData: ((state: any, panelId: string) => PotentialData) & import("reselect").OutputSelectorFields<(args_0: LinkedState, args_1: string) => PotentialData, {
     clearCache: () => void;
 }> & {
     clearCache: () => void;
@@ -59,9 +59,8 @@ export declare const getSelectedFeature: ((state: SynchronizationGroupState, map
     lat: number;
     lon: number;
     id: string;
-    serviceId: any;
-    collectionId: any;
     name: any;
+    occurrences: any;
 } | null) & import("reselect").OutputSelectorFields<(args_0: {
     features: {
         id: string;
@@ -73,11 +72,15 @@ export declare const getSelectedFeature: ((state: SynchronizationGroupState, map
     lat: number;
     lon: number;
     id: string;
-    serviceId: any;
-    collectionId: any;
     name: any;
+    occurrences: any;
 } | null, {
     clearCache: () => void;
 }> & {
     clearCache: () => void;
 };
+export declare const getSelectedFeatureAsGeoJSON: ((state: SynchronizationGroupState, mapId: string) => import("geojson").Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties> | null | undefined) & import("reselect").OutputSelectorFields<(args_0: PotentialData) => import("geojson").Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties> | null | undefined, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};

package/src/store/index.d.ts

@@ -3,6 +3,7 @@ export * from './ui';
 export * from './generic';
 export { genericListener } from './generic/listener';
 export { mapListener } from './map/map/listener';
+export { openlayersListener } from './mapStore/openlayers/listener';
 export { serviceListener } from './map/service/listener';
 export { routerListener } from './router/listener';
 export { drawingToolListener } from './drawingTool/listener';

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

@@ -1,5 +1,5 @@
 export * from './service';
 export * from './map';
 export * from './layer';
-export type { WebMapStateModuleState, MapPreset, MapPresetInitialProps, } from './types';
+export type { WebMapStateModuleState, MapPreset, MapPresetInitialProps, TimeSliderStartCenterEndTime, } from './types';
 export * as storeTestSettings from './storeTestSettings';

package/src/store/map/map/olMapListenerAnimationUtils.d.ts

@@ -0,0 +1,46 @@
+import { Dispatch, ListenerEffectAPI } from '@reduxjs/toolkit';
+import { ReduxLayer } from '../types';
+import { CoreAppStore } from '../../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;
+/**
+ * Handles dwell at the end of the animation loop sequence. The number of steps to wait till proceed can be set by the dwell parameter.
+ * @param timerId The timer id
+ * @param numberOfStepsInAnimation Number of steps in the animation
+ * @param dwell The number of steps to wait at the end of the animation sequence before to continue
+ * @returns
+ */
+export declare const handleTimerDwell: (timerId: string, numberOfStepsInAnimation: number, dwell?: number) => boolean;
+/**
+ * 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;
+/**
+ * Checks if the next step is available for all provided layers
+ * @param reduxLayers
+ * @param nextTimeString
+ * @returns
+ */
+export declare const isNextStepAvailable: (reduxLayers: ReduxLayer[], nextTimeString: string) => boolean;
+/**
+ * This handler 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
+ * @param listenerApi ListenerEffectAPI<CoreAppStore, Dispatch, unknown> listenerApi as received from listener
+ */
+export declare const olMetronomeHandler: (timerIds: string[], listenerApi: ListenerEffectAPI<CoreAppStore, Dispatch, unknown>) => void;

package/src/store/map/map/olMapListenerAnimationUtils.spec.d.ts

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

package/src/store/map/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, ReduxLayer, WebMapAnimationList } from '../types';
+import type { Dimension, Layer, ReduxLayer, TimeSliderStartCenterEndTime, WebMapAnimationList } from '../types';
 import type { uiTypes } from '../../ui';
 /**
  * Gets the map state by mapId
@@ -429,6 +429,11 @@ export declare const getMapTimeSliderCenterTime: ((state: CoreAppStore, mapId: s
 }> & {
     clearCache: () => void;
 };
+export declare const getMapTimeSliderStartCenterEndAndStep: ((state: CoreAppStore, mapId: string) => TimeSliderStartCenterEndTime) & import("reselect").OutputSelectorFields<(args_0: WebMap | undefined) => TimeSliderStartCenterEndTime, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 /**
  * Returns the number of seconds per pixel on the time slider
  *

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

@@ -241,3 +241,9 @@ export interface ISO8601Interval {
 export interface SetDefaultMapSettingsPayload {
     preset: MapPreset;
 }
+export interface TimeSliderStartCenterEndTime {
+    start: number;
+    center: number;
+    end: number;
+    step: number;
+}

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

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

package/src/store/mapStore/openlayers/listener.spec.d.ts

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

package/src/store/mapStore/openlayers/syncGroupViewStore.d.ts

@@ -0,0 +1,26 @@
+import { Observable, View } from 'ol';
+export declare const copyView: (view: View) => View;
+/**
+ * The StoredView objects keep references to OpenLayers View objects that may be shared
+ * between multiple maps (when maps are pan/zoom synced).
+ * This file then offers and API for each map to retrieve the StoredView object
+ * that is relevant for the current workspace configuration.
+ *
+ * React is functional, but OpenLayers is object oriented.
+ * This component sits in between the two and thus you can make an argument for either style.
+ * Object oriented was chosen since:
+ * - This allows us to use OpenLayers's Observable as a base class to provide event handling,
+ *   which is useful for the implementation.
+ * - For this mechanism to work smoothly with OpenLayers,
+ *   we need to pass the exact same View object reference for all maps that are synchronized. Redux stores cannot be used in this context and prop drilling and/or context providers would likely lead to more invasive implementations.
+ */
+export declare class StoredView extends Observable {
+    name: string;
+    view: View;
+    constructor(name: string, view: View);
+    setView(view: View): void;
+}
+export declare const clearSyncGroupViewStore: () => void;
+export declare const getViewObjectForMapId: (id: string) => StoredView;
+export declare const createViewObjectForNewMap: (createFromId: string, newId: string) => void;
+export declare const getViewObjectForSyncGroup: (id: string) => StoredView;

package/src/store/store.d.ts

@@ -19,6 +19,7 @@ export declare const storeReducerMap: {
 };
 export declare const storeMiddlewares: (ListenerMiddleware<import("./types").CoreAppStore, import("@reduxjs/toolkit").ThunkDispatch<import("./types").CoreAppStore, unknown, import("redux").AnyAction>, unknown> | ListenerMiddleware<import("./router/types").RouterModuleStore, import("@reduxjs/toolkit").ThunkDispatch<import("./router/types").RouterModuleStore, unknown, import("redux").AnyAction>, unknown>)[];
 export declare const createMockStore: (mockState?: WebMapStateModuleState | SynchronizationGroupModuleState | LoadingIndicatorModuleState | UIModuleState | DrawtoolModuleStore) => ToolkitStore;
+export { getViewObjectForSyncGroup, getViewObjectForMapId, createViewObjectForNewMap, } from './mapStore/openlayers/syncGroupViewStore';
 /**
  * This creates an OpenGeoWeb redux store for redux connected components
  *

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

@@ -7,6 +7,7 @@ export declare enum DialogTypes {
     TimeSeriesSelect = "timeSeriesSelect",
     TimeSeriesManager = "timeSeriesManager",
     TimeseriesInfo = "timeseriesInfo",
+    TimeseriesLocationInfo = "timeseriesLocationInfo",
     KeywordFilter = "keywordFilter",
     DimensionSelectEnsembleMember = "dimensionSelect-ensemble_member",
     DimensionSelectElevation = "dimensionSelect-elevation",