@opengeoweb/store 10.2.1-spike-ol.3 → 11.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/store",
-  "version": "10.2.1-spike-ol.3",
+  "version": "11.1.0",
   "description": "GeoWeb Store library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -8,40 +8,20 @@
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
   "dependencies": {
-    "@emotion/react": "11.14.0",
-    "@emotion/styled": "11.14.0",
-    "@mui/material": "6.4.1",
-    "@mui/system": "6.4.3",
-    "@mui/x-date-pickers": "7.26.0",
+    "@opengeoweb/shared": "*",
+    "react-redux": "^8.1.3",
     "@reduxjs/toolkit": "^1.9.7",
-    "@sentry/react": "8.54.0",
-    "@storybook/core-events": "8.4.2",
-    "@storybook/preview-api": "8.4.2",
-    "@storybook/react": "8.4.2",
-    "@tanstack/query-core": "5.62.7",
-    "@tanstack/react-query": "5.62.7",
-    "@testing-library/react": "16.0.1",
-    "@testing-library/user-event": "14.5.2",
-    "@turf/turf": "^7.2.0",
-    "axios": "1.7.9",
-    "date-fns": "4.1.0",
-    "dompurify": "3.2.4",
-    "i18next": "23.11.5",
+    "@opengeoweb/webmap-react": "*",
+    "@opengeoweb/webmap": "*",
     "immer": "^10.0.3",
-    "jest-canvas-mock": "2.5.2",
-    "jest-date-mock": "1.0.10",
     "lodash": "^4.17.21",
-    "msw": "1.3.3",
-    "ol": "^10.4.0",
-    "proj4": "2.15.0",
-    "re-resizable": "6.10.3",
-    "react": "18.3.1",
-    "react-draggable": "4.4.6",
-    "react-i18next": "15.1.1",
-    "react-redux": "^8.1.3",
-    "react-resize-detector": "9.1.1",
+    "@opengeoweb/metronome": "*",
+    "@opengeoweb/timeslider": "*",
     "react-router-dom": "^6.23.1",
-    "whatwg-fetch": "3.6.20"
+    "@turf/turf": "^7.2.0"
+  },
+  "peerDependencies": {
+    "react": "18"
   },
   "module": "./index.esm.js",
   "type": "module",

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

@@ -1,6 +1,7 @@
+import { SystemScope } from '@opengeoweb/shared';
 import { LoadingIndicatorModuleState } from '../loadingIndicator/types';
 import type { GenericActionPayload } from '../types';
-import { SYNCGROUPS_TYPE_SETBBOX, SYNCGROUPS_TYPE_SETTIME, SYNCGROUPS_TYPE_SETLAYERACTIONS } from './constants';
+import { SYNCGROUPS_TYPE_SETBBOX, SYNCGROUPS_TYPE_SETLAYERACTIONS, SYNCGROUPS_TYPE_SETTIME } from './constants';
 export interface Group {
     id: string;
     selected: string[];
@@ -47,7 +48,6 @@ export interface LinkedState {
     links: Record<string, string[]>;
     sharedData: Record<string, PotentialData>;
 }
-type Origin = 'user' | 'system';
 export type SynchronizationSourcePayLoadByType = Record<string, GenericActionPayload>;
 export interface SynchronizationSource {
     types: SyncType[];
@@ -88,12 +88,12 @@ export interface SyncGroupTarget {
     [key: string]: unknown;
 }
 export interface SyncGroupAddTargetPayload extends SyncGroupTarget {
-    origin?: Origin;
+    origin?: SystemScope;
 }
 export interface SyncGroupRemoveTargetPayload {
     groupId: string;
     targetId: string;
-    origin?: Origin;
+    origin?: SystemScope;
 }
 export interface SyncGroupLinkTargetPayload extends SyncGroupTarget {
     linked: boolean;
@@ -102,7 +102,7 @@ export interface SyncGroupAddGroupPayload {
     groupId: string;
     title: string;
     type: SyncType;
-    origin?: Origin;
+    origin?: SystemScope;
 }
 export interface SyncGroupRemoveGroupPayload {
     groupId: string;
@@ -112,7 +112,7 @@ export interface SyncGroupSetViewStatePayload {
 }
 export interface SyncGroupToggleIsTimeScrollingEnabled {
     isTimeScrollingEnabled: boolean;
-    origin?: Origin;
+    origin?: SystemScope;
 }
 export declare const SyncGroupTypeList: string[];
 export declare enum SyncGroupActionOrigin {
@@ -136,4 +136,3 @@ export interface AddSharedData {
 export interface DeleteSharedData {
     panelId: string;
 }
-export {};

package/src/store/index.d.ts

@@ -3,12 +3,12 @@ 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';
 export { layersListener } from './map/layer/listeners';
 export { metronomeListener } from './map/map/metronomeListener';
+export { unifyReducerMaps, type ReducerMap } from './unifyReducerMaps';
 export * from './router';
 export * from './drawingTool';
 export * from './types';

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, TimeSliderStartCenterEndTime, } from './types';
+export type { WebMapStateModuleState, MapPreset, MapPresetInitialProps, } from './types';
 export * as storeTestSettings from './storeTestSettings';

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

@@ -129,7 +129,7 @@ export interface SetAvailableBaseLayersPayload extends AddAvailableBaseLayersPay
     mapId: string;
 }
 export interface ErrorLayerPayload extends LayerPayload {
-    error: Error;
+    error: string;
 }
 export interface UpdateLayerInfo extends Action {
     type: `layerReducer/onUpdateLayerInformation`;

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, TimeSliderStartCenterEndTime, WebMapAnimationList } from '../types';
+import type { Dimension, Layer, ReduxLayer, WebMapAnimationList } from '../types';
 import type { uiTypes } from '../../ui';
 /**
  * Gets the map state by mapId
@@ -429,11 +429,6 @@ 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,9 +241,3 @@ export interface ISO8601Interval {
 export interface SetDefaultMapSettingsPayload {
     preset: MapPreset;
 }
-export interface TimeSliderStartCenterEndTime {
-    start: number;
-    center: number;
-    end: number;
-    step: number;
-}

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

@@ -1,22 +1,22 @@
+import { SystemScope } from '@opengeoweb/shared';
 import { LayerProps } from '@opengeoweb/webmap';
 export interface InitialService {
     id: string;
     name: string;
     url: string;
-    scope?: ServiceScope;
+    scope?: SystemScope;
     abstract?: string;
 }
 export type NoIdService = Omit<InitialService, 'id'>;
 export type UserAddedServices = Record<string, NoIdService>;
 export type Services = Record<string, ReduxService>;
-export type ServiceScope = 'user' | 'system';
 export interface ReduxService {
     id?: string;
     name?: string;
     serviceUrl?: string;
     active?: boolean;
     layers?: ServiceLayer[];
-    scope?: ServiceScope;
+    scope?: SystemScope;
 }
 /**
   Used in the services object of webmap to keep a list of available layers in the service
@@ -32,7 +32,7 @@ export interface SetLayersForServicePayload {
     serviceUrl: string;
     abstract?: string;
     layers: ServiceLayer[];
-    scope: ServiceScope;
+    scope: SystemScope;
     isUpdating?: boolean;
 }
 export interface MapStoreRemoveServicePayload {

package/src/store/store.d.ts

@@ -1,9 +1,12 @@
+import { DevToolsEnhancerOptions, EnhancerArray, ListenerMiddleware, StoreEnhancer } from '@reduxjs/toolkit';
 import { ToolkitStore } from '@reduxjs/toolkit/dist/configureStore';
+import { ExtractDispatchExtensions } from '@reduxjs/toolkit/dist/tsHelpers';
 import { WebMapStateModuleState } from './map';
 import { SynchronizationGroupModuleState } from './generic/syncGroups/types';
 import { LoadingIndicatorModuleState } from './generic/loadingIndicator/types';
 import { UIModuleState } from './ui/types';
 import { DrawtoolModuleStore } from './drawingTool/reducer';
+import { ReducerMap } from './unifyReducerMaps';
 export declare const storeReducerMap: {
     webmap: import("redux").Reducer<import("./map/types").WebMapState>;
     services: import("redux").Reducer<import("./map/types").ServiceState>;
@@ -14,6 +17,20 @@ export declare const storeReducerMap: {
     drawingtools: import("redux").Reducer<import("./drawingTool/reducer").DrawingToolState>;
     router: import("redux").Reducer<{}>;
 };
-export declare const storeMiddlewares: (import("@reduxjs/toolkit").ListenerMiddleware<import("./types").CoreAppStore, import("@reduxjs/toolkit").ThunkDispatch<import("./types").CoreAppStore, unknown, import("redux").AnyAction>, unknown> | import("@reduxjs/toolkit").ListenerMiddleware<import("./router/types").RouterModuleStore, import("@reduxjs/toolkit").ThunkDispatch<import("./router/types").RouterModuleStore, unknown, import("redux").AnyAction>, unknown>)[];
+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
+ *
+ * @param preloadedState Initial state for your application
+ * @param extraReducers Additional reducers, you can pass your own reducers. See apps/geoweb/src/app/store.ts for how it is used in GeoWeb.
+ * @param extraMiddleWares Additional middlewares
+ * @param extraEnhancer Custom enhancers
+ * @param enableDevTools Set to true to enable redux devtools.
+ * @returns A redux store you can use with the core components
+ */
+export declare const configureOpenGeoWebStore: (preloadedState?: object, extraReducers?: ReducerMap, extraMiddleWares?: ListenerMiddleware[], extraEnhancers?: EnhancerArray<[
+    StoreEnhancer<{
+        dispatch: ExtractDispatchExtensions<unknown>;
+    }>
+]>, enableDevTools?: boolean | DevToolsEnhancerOptions) => ToolkitStore;

package/src/store/unifyReducerMaps.d.ts

@@ -0,0 +1,3 @@
+import { Action, Reducer } from '@reduxjs/toolkit';
+export type ReducerMap = Record<string, Reducer<any, Action<unknown>>>;
+export declare const unifyReducerMaps: (reducerMaps: ReducerMap[]) => ReducerMap;

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

@@ -1,46 +0,0 @@
-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/mapStore/openlayers/listener.d.ts

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

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

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

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