@opengeoweb/store 19.1.0 → 19.1.1

package/dist/src/store/generic/syncGroups/utils.d.ts

@@ -0,0 +1,76 @@
+import type { SyncType } from './types';
+import type { AddLayerPayload, DeleteLayerPayload, MoveLayerPayload, SetAutoLayerIdPayload, SetBaseLayersPayload } from '../../map/types';
+import type { CoreAppStore } from '../../types';
+import type { SyncLayerPayloads, LayerActionPayloadsWithLayerIds } from '../types';
+interface FoundTargets {
+    payload: SyncLayerPayloads;
+    targetId: string;
+    layerId: string;
+}
+/**
+ * Tries to find the layerId's in the other map based on the payload of the action. It works for all layer actions.
+ * @param state
+ * @param mapId
+ * @param targetMapId
+ * @param payload
+ * @returns
+ */
+export declare const getTargetLayerIdFromPayload: (state: CoreAppStore, mapId: string, targetMapId: string, payload: SyncLayerPayloads) => string;
+/**
+ * Local helper function used by getLayerDeleteActionsTargets, getLayerActionsTargets, getAddLayerActionsTargets, getTargetLayerIdFromPayload to find the targets
+ * @param state
+ * @param payload
+ * @param actionType
+ * @param sourceMapId
+ * @returns The found targets
+ */
+export declare const findTargets: (state: CoreAppStore, payload: SyncLayerPayloads, actionType: SyncType, sourceMapId: string) => FoundTargets[];
+/**
+ * These targets are found for layer actions that work with a layerId like: SetLayerName, SetLayerEnabled, SetLayerOpacity, SetLayerDimension and SetLayerStyle
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getLayerActionsTargets: (state: CoreAppStore, payload: LayerActionPayloadsWithLayerIds, actionType: SyncType) => LayerActionPayloadsWithLayerIds[];
+/**
+ * These targets are found for the layer/map action AddLayer. AddLayer does not have a layerId (because it's new)
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getAddLayerActionsTargets: (state: CoreAppStore, payload: AddLayerPayload, actionType: SyncType) => AddLayerPayload[];
+/**
+ * These targets are found for the layer/map action DeleteLayer. The layer is already gone, so there is no layerId anymore. Using layerIndex instead.
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getLayerDeleteActionsTargets: (state: CoreAppStore, payload: DeleteLayerPayload, actionType: SyncType) => DeleteLayerPayload[];
+/**
+ * These targets are found for the layer/map action MoveLayer. Here layers are referenced by newIndex and oldIndex.
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getLayerMoveActionsTargets: (state: CoreAppStore, payload: MoveLayerPayload, actionType: SyncType) => MoveLayerPayload[];
+/**
+ * These targets are found for the map action SetAutoLayerId. It needs both a target mapId and layerId
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getSetAutoLayerIdActionsTargets: (state: CoreAppStore, payload: SetAutoLayerIdPayload, actionType: SyncType) => LayerActionPayloadsWithLayerIds[];
+/**
+ * These targets are found for baselayer actions that work with a mapId like: setBaseLayers
+ * @param state
+ * @param payload
+ * @param actionType
+ * @returns
+ */
+export declare const getMapBaseLayerActionsTargets: (state: CoreAppStore, payload: SetBaseLayersPayload, actionType: SyncType) => SetBaseLayersPayload[];
+export {};

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

@@ -0,0 +1,11 @@
+import type { SetBboxPayload, SetTimePayload, SyncLayerPayloads } from '../types';
+import type { SetBboxSyncActionPayload, SetBboxSyncPayload, SetLayerActionsSyncPayload, SetTimeSyncActionPayload, SetTimeSyncPayload } from './types';
+/**
+ * These actions are fired by the generic/listener.ts, based on generic actions and the synchronizationGroup state.
+ *
+ * These actions should not be used by components directly. Components should only use the generic actions.
+ */
+export declare const setTimeSync: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[setTimePayload: SetTimePayload, 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/dist/src/store/generic/synchronizationActions/types.d.ts

@@ -0,0 +1,43 @@
+import type { setBbox, setTime } from '../actions';
+import type { SyncLayerPayloads } from '../types';
+export interface SetTimeSyncProps {
+    currentTime?: string;
+    timeSliderCenterTime?: number;
+    timeSliderSpan?: number;
+    timeSliderStep?: number;
+    timeSliderAnimationStartTime?: string;
+    timeSliderAnimationEndTime?: string;
+    timeSliderAnimationDelay?: number;
+}
+export interface SetTimeSyncPayload {
+    targetId: string;
+    value: SetTimeSyncProps;
+}
+export interface SetBboxSyncPayload {
+    targetId: string;
+    bbox: {
+        left: number;
+        bottom: number;
+        right: number;
+        top: number;
+    };
+    srs: string;
+}
+export interface SetLayerActionsSyncPayload {
+    source: {
+        type: string;
+        payload: SyncLayerPayloads;
+    } | null;
+    targets: SyncLayerPayloads[];
+}
+export interface SetTimeSyncActionPayload {
+    source: ReturnType<typeof setTime> | null;
+    groups: string[];
+    targets: SetTimeSyncPayload[];
+}
+export interface SetBboxSyncActionPayload {
+    source: ReturnType<typeof setBbox> | null;
+    groups: string[];
+    targets: SetBboxSyncPayload[];
+}
+export type GenericSyncActionPayload = SetBboxSyncPayload | SetTimeSyncPayload | SetLayerActionsSyncPayload;

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

@@ -0,0 +1,24 @@
+import type { SetLayerStylePayload } from '@opengeoweb/webmap-react';
+import type { MapActionOrigin } from '../map/map/enums';
+import type { AddLayerPayload, DeleteLayerPayload, MoveLayerPayload, SetAutoLayerIdPayload, SetBaseLayersPayload, SetLayerDimensionPayload, SetLayerEnabledPayload, SetLayerNamePayload, SetLayerOpacityPayload, SetLayerServicePayload } from '../map/types';
+import type { SetTimeSyncProps } from './synchronizationActions/types';
+export interface SetTimePayload {
+    sourceId: string;
+    origin: string;
+    value: SetTimeSyncProps;
+}
+export interface SetBboxPayload {
+    sourceId: string;
+    bbox: {
+        left: number;
+        bottom: number;
+        right: number;
+        top: number;
+    };
+    srs: string;
+    origin?: MapActionOrigin | string;
+    mapId?: string;
+}
+export type GenericActionPayload = SetBboxPayload | SetTimePayload;
+export type LayerActionPayloadsWithLayerIds = SetLayerOpacityPayload | SetLayerNamePayload | SetLayerServicePayload | SetLayerEnabledPayload | SetLayerDimensionPayload | SetLayerStylePayload | SetAutoLayerIdPayload;
+export type SyncLayerPayloads = LayerActionPayloadsWithLayerIds | AddLayerPayload | MoveLayerPayload | DeleteLayerPayload | SetBaseLayersPayload;

package/dist/src/store/generic/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The removeInPlace() method modifies an array in place, by removing elements that pass the test implemented by the provided function.
+ *
+ * NOTE: This should only be used on draft properties as provided by the immer produce library, as modifying elements in place is bad practice on non draft variables.
+ *
+ * @param inDraftArray The draft array to filter, will be modified in place.
+ * @param condition Function to check each element in the array
+ */
+export declare const removeInPlace: <T>(inDraftArray: T[], condition: (c: T) => boolean) => void;

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

@@ -0,0 +1,22 @@
+export * from './map';
+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 { commonListener } from './common/listener';
+export { unifyReducerMaps, type ReducerMap } from './unifyReducerMaps';
+export * from './router';
+export * from './drawingTool';
+export type * from './types';
+export * as storeTestUtils from './map/storeTestUtils';
+export * from './generic/linking';
+export * as storeUtils from './utils';
+export * from './utils';
+export * from './store';
+export * from './common';

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

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

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

@@ -0,0 +1,6 @@
+export { layerActions, layerReducer } from './reducer';
+export type { LayerActions } from './reducer';
+export * as layerSelectors from './selectors';
+export * as layerTypes from './types';
+export * as layerUtils from './utils';
+export { LayerType } from '@opengeoweb/webmap';

package/dist/src/store/map/layer/listeners.d.ts

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

package/dist/src/store/map/layer/reducer.d.ts

@@ -0,0 +1,94 @@
+import type { Draft, PayloadAction } from '@reduxjs/toolkit';
+import type { SetLayerAcceptanceTimePayload, SetLayerDimensionsPayload, SetLayerStylePayload, UpdateLayerInfoPayload } from '@opengeoweb/webmap-react';
+import type { LayerState, Layer, AddLayerPayload, SetLayerDimensionPayload, SetLayerEnabledPayload, SetLayerOpacityPayload, SetLayerNamePayload, SetLayerServicePayload, SetLayerGeojsonPayload, DeleteLayerPayload, ErrorLayerPayload, SetLayersPayload, SetBaseLayersPayload, AddBaseLayerPayload, AddAvailableBaseLayerPayload, AddAvailableBaseLayersPayload, SetAvailableBaseLayersPayload, SetSelectedFeaturesPayload, SetHoveredFeaturesPayload, UpdateFeaturePayload, ExitFeatureDrawModePayload, ToggleFeatureModePayload, UpdateFeaturePropertiesPayload, DuplicateMapLayerPayload, ShowLayerInfoPayload, SetLayerGeojsonFromLayerPayload, SetLayerOptionsPayload, SetLayerLegendVisibilityPayload } from './types';
+export declare const createLayer: ({ id, opacity, acceptanceTimeInMinutes, enabled, layerType, status, useLatestReferenceTime, ...props }: Layer) => Layer;
+export declare const initialState: LayerState;
+export declare const slice: import("@reduxjs/toolkit").Slice<LayerState, {
+    addLayer: (draft: Draft<LayerState>, action: PayloadAction<AddLayerPayload>) => void;
+    duplicateMapLayer: (draft: Draft<LayerState>, action: PayloadAction<DuplicateMapLayerPayload>) => void;
+    layerChangeDimension: (draft: Draft<LayerState>, action: PayloadAction<SetLayerDimensionPayload>) => void;
+    layerChangeEnabled: (draft: Draft<LayerState>, action: PayloadAction<SetLayerEnabledPayload>) => void;
+    layerChangeOpacity: (draft: Draft<LayerState>, action: PayloadAction<SetLayerOpacityPayload>) => void;
+    layerChangeStyle: (draft: Draft<LayerState>, action: PayloadAction<SetLayerStylePayload>) => void;
+    layerChangeAcceptanceTime: (draft: Draft<LayerState>, action: PayloadAction<SetLayerAcceptanceTimePayload>) => void;
+    layerChangeName: (draft: Draft<LayerState>, action: PayloadAction<SetLayerNamePayload>) => void;
+    layerChangeService: (draft: Draft<LayerState>, action: PayloadAction<SetLayerServicePayload>) => void;
+    layerChangeOptions: (draft: Draft<LayerState>, action: PayloadAction<SetLayerOptionsPayload>) => void;
+    layerChangeGeojson: (draft: Draft<LayerState>, action: PayloadAction<SetLayerGeojsonPayload>) => void;
+    layerSetGeojsonFromLayer: (draft: Draft<LayerState>, action: PayloadAction<SetLayerGeojsonFromLayerPayload>) => void;
+    layerDelete: (draft: Draft<LayerState>, action: PayloadAction<DeleteLayerPayload>) => void;
+    layerError: (draft: Draft<LayerState>, action: PayloadAction<ErrorLayerPayload>) => void;
+    baseLayerDelete: (draft: Draft<LayerState>, action: PayloadAction<DeleteLayerPayload>) => void;
+    setLayers: (draft: Draft<LayerState>, action: PayloadAction<SetLayersPayload>) => void;
+    setBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<SetBaseLayersPayload>) => void;
+    addBaseLayer: (draft: Draft<LayerState>, action: PayloadAction<AddBaseLayerPayload>) => void;
+    layerSetDimensions: (draft: Draft<LayerState>, action: PayloadAction<SetLayerDimensionsPayload>) => void;
+    addAvailableBaseLayer: (draft: Draft<LayerState>, action: PayloadAction<AddAvailableBaseLayerPayload>) => void;
+    addAvailableBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<AddAvailableBaseLayersPayload>) => void;
+    setAvailableBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<SetAvailableBaseLayersPayload>) => void;
+    setUseLatestReferenceTime: (draft: Draft<LayerState>, action: PayloadAction<{
+        id: string;
+        useLatestReferenceTime: boolean;
+    }>) => void;
+    onUpdateLayerInformation: (draft: Draft<LayerState>, action: PayloadAction<UpdateLayerInfoPayload>) => void;
+    orderLayerToFront: (draft: Draft<LayerState>, action: PayloadAction<{
+        layerId: string;
+    }>) => void;
+    setSelectedFeatures: (draft: Draft<LayerState>, action: PayloadAction<SetSelectedFeaturesPayload>) => void;
+    setHoveredFeatures: (draft: Draft<LayerState>, action: PayloadAction<SetHoveredFeaturesPayload>) => void;
+    updateFeature: (draft: Draft<LayerState>, action: PayloadAction<UpdateFeaturePayload>) => void;
+    updateFeatureProperties: (draft: Draft<LayerState>, action: PayloadAction<UpdateFeaturePropertiesPayload>) => void;
+    toggleFeatureMode: (draft: Draft<LayerState>, action: PayloadAction<ToggleFeatureModePayload>) => void;
+    exitFeatureDrawMode: (draft: Draft<LayerState>, action: PayloadAction<ExitFeatureDrawModePayload>) => void;
+    toggleSelectableFeatures: (draft: Draft<LayerState>, action: PayloadAction<{
+        layerId: string;
+    }>) => void;
+    showLayerInfo: (draft: Draft<LayerState>, action: PayloadAction<ShowLayerInfoPayload>) => void;
+    hideLayerInfo: (draft: Draft<LayerState>) => void;
+    SetLayerLegendVisibilityPayload: (draft: Draft<LayerState>, action: PayloadAction<SetLayerLegendVisibilityPayload>) => void;
+}, "layerReducer", "layerReducer", import("@reduxjs/toolkit").SliceSelectors<LayerState>>;
+export declare const layerReducer: import("redux").Reducer<LayerState>, layerActions: import("@reduxjs/toolkit").CaseReducerActions<{
+    addLayer: (draft: Draft<LayerState>, action: PayloadAction<AddLayerPayload>) => void;
+    duplicateMapLayer: (draft: Draft<LayerState>, action: PayloadAction<DuplicateMapLayerPayload>) => void;
+    layerChangeDimension: (draft: Draft<LayerState>, action: PayloadAction<SetLayerDimensionPayload>) => void;
+    layerChangeEnabled: (draft: Draft<LayerState>, action: PayloadAction<SetLayerEnabledPayload>) => void;
+    layerChangeOpacity: (draft: Draft<LayerState>, action: PayloadAction<SetLayerOpacityPayload>) => void;
+    layerChangeStyle: (draft: Draft<LayerState>, action: PayloadAction<SetLayerStylePayload>) => void;
+    layerChangeAcceptanceTime: (draft: Draft<LayerState>, action: PayloadAction<SetLayerAcceptanceTimePayload>) => void;
+    layerChangeName: (draft: Draft<LayerState>, action: PayloadAction<SetLayerNamePayload>) => void;
+    layerChangeService: (draft: Draft<LayerState>, action: PayloadAction<SetLayerServicePayload>) => void;
+    layerChangeOptions: (draft: Draft<LayerState>, action: PayloadAction<SetLayerOptionsPayload>) => void;
+    layerChangeGeojson: (draft: Draft<LayerState>, action: PayloadAction<SetLayerGeojsonPayload>) => void;
+    layerSetGeojsonFromLayer: (draft: Draft<LayerState>, action: PayloadAction<SetLayerGeojsonFromLayerPayload>) => void;
+    layerDelete: (draft: Draft<LayerState>, action: PayloadAction<DeleteLayerPayload>) => void;
+    layerError: (draft: Draft<LayerState>, action: PayloadAction<ErrorLayerPayload>) => void;
+    baseLayerDelete: (draft: Draft<LayerState>, action: PayloadAction<DeleteLayerPayload>) => void;
+    setLayers: (draft: Draft<LayerState>, action: PayloadAction<SetLayersPayload>) => void;
+    setBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<SetBaseLayersPayload>) => void;
+    addBaseLayer: (draft: Draft<LayerState>, action: PayloadAction<AddBaseLayerPayload>) => void;
+    layerSetDimensions: (draft: Draft<LayerState>, action: PayloadAction<SetLayerDimensionsPayload>) => void;
+    addAvailableBaseLayer: (draft: Draft<LayerState>, action: PayloadAction<AddAvailableBaseLayerPayload>) => void;
+    addAvailableBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<AddAvailableBaseLayersPayload>) => void;
+    setAvailableBaseLayers: (draft: Draft<LayerState>, action: PayloadAction<SetAvailableBaseLayersPayload>) => void;
+    setUseLatestReferenceTime: (draft: Draft<LayerState>, action: PayloadAction<{
+        id: string;
+        useLatestReferenceTime: boolean;
+    }>) => void;
+    onUpdateLayerInformation: (draft: Draft<LayerState>, action: PayloadAction<UpdateLayerInfoPayload>) => void;
+    orderLayerToFront: (draft: Draft<LayerState>, action: PayloadAction<{
+        layerId: string;
+    }>) => void;
+    setSelectedFeatures: (draft: Draft<LayerState>, action: PayloadAction<SetSelectedFeaturesPayload>) => void;
+    setHoveredFeatures: (draft: Draft<LayerState>, action: PayloadAction<SetHoveredFeaturesPayload>) => void;
+    updateFeature: (draft: Draft<LayerState>, action: PayloadAction<UpdateFeaturePayload>) => void;
+    updateFeatureProperties: (draft: Draft<LayerState>, action: PayloadAction<UpdateFeaturePropertiesPayload>) => void;
+    toggleFeatureMode: (draft: Draft<LayerState>, action: PayloadAction<ToggleFeatureModePayload>) => void;
+    exitFeatureDrawMode: (draft: Draft<LayerState>, action: PayloadAction<ExitFeatureDrawModePayload>) => void;
+    toggleSelectableFeatures: (draft: Draft<LayerState>, action: PayloadAction<{
+        layerId: string;
+    }>) => void;
+    showLayerInfo: (draft: Draft<LayerState>, action: PayloadAction<ShowLayerInfoPayload>) => void;
+    hideLayerInfo: (draft: Draft<LayerState>) => void;
+    SetLayerLegendVisibilityPayload: (draft: Draft<LayerState>, action: PayloadAction<SetLayerLegendVisibilityPayload>) => void;
+}, "layerReducer">;
+export type LayerActions = ReturnType<typeof layerActions.layerSetDimensions> | ReturnType<typeof layerActions.layerChangeStyle> | ReturnType<typeof layerActions.addAvailableBaseLayer> | ReturnType<typeof layerActions.addAvailableBaseLayers> | ReturnType<typeof layerActions.addBaseLayer> | ReturnType<typeof layerActions.addLayer> | ReturnType<typeof layerActions.baseLayerDelete> | ReturnType<typeof layerActions.onUpdateLayerInformation> | ReturnType<typeof layerActions.layerChangeDimension> | ReturnType<typeof layerActions.layerChangeEnabled> | ReturnType<typeof layerActions.layerChangeGeojson> | ReturnType<typeof layerActions.layerChangeName> | ReturnType<typeof layerActions.layerChangeService> | ReturnType<typeof layerActions.layerChangeOpacity> | ReturnType<typeof layerActions.layerDelete> | ReturnType<typeof layerActions.layerError> | ReturnType<typeof layerActions.setBaseLayers> | ReturnType<typeof layerActions.setLayers> | ReturnType<typeof layerActions.SetLayerLegendVisibilityPayload>;