@opengeoweb/store 9.28.1 → 9.29.0

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

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

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

@@ -1,233 +1,233 @@
-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 {
-    name?: string;
-    units?: string;
-    currentValue: string;
-    maxValue?: string;
-    minValue?: string;
-    timeInterval?: TimeInterval;
-    synced?: boolean;
-    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;
-    bbox: Bbox;
-    mapLayers: string[];
-    baseLayers: string[];
-    overLayers: string[];
-    featureLayers: string[];
-    dimensions?: Dimension[];
-    autoUpdateLayerId?: string;
-    autoTimeStepLayerId?: string;
-    timeSliderSpan?: number;
-    timeStep?: number;
-    animationDelay?: number;
-    timeSliderWidth?: number;
-    timeSliderCenterTime?: number;
-    timeSliderSecondsPerPx?: number;
-    isTimestepAuto?: boolean;
-    isTimeSpanAuto?: boolean;
-    isAnimationLengthAuto?: boolean;
-    isTimeSliderHoverOn?: boolean;
-    isTimeSliderVisible?: boolean;
-    shouldShowZoomControls?: boolean;
-    mapPinLocation?: MapLocation;
-    disableMapPin?: boolean;
-    displayMapPin?: boolean;
-    legendId?: string;
-    dockedLayerManagerSize?: DockedLayerManagerSize;
-}
-export type DockedLayerManagerSize = 'sizeSmall' | 'sizeMedium' | 'sizeLarge' | '';
-export interface WebMapState {
-    byId: Record<string, WebMap>;
-    allIds: string[];
-}
-export interface Bbox {
-    left: number;
-    right: number;
-    top: number;
-    bottom: number;
-}
-export declare enum AnimationLength {
-    Minutes15 = 15,
-    Minutes30 = 30,
-    Hours1 = 60,
-    Hours2 = 120,
-    Hours3 = 180,
-    Hours6 = 360,
-    Hours12 = 720,
-    Hours24 = 1440
-}
-export interface AnimationPayloadType {
-    duration?: number;
-    interval?: number;
-    speed?: SpeedFactorType;
-    endTime?: string;
-    shouldEndtimeOverride?: boolean;
-}
-export interface MapPreset {
-    layers?: Layer[];
-    activeLayerId?: string;
-    autoTimeStepLayerId?: string;
-    autoUpdateLayerId?: string;
-    proj?: {
-        bbox: Bbox;
-        srs: string;
-    };
-    dimensions?: Dimension[];
-    shouldAnimate?: boolean;
-    shouldAutoUpdate?: boolean;
-    showTimeSlider?: boolean;
-    displayMapPin?: boolean;
-    shouldShowZoomControls?: boolean;
-    toggleTimestepAuto?: boolean;
-    animationPayload?: AnimationPayloadType;
-    shouldShowLegend?: boolean;
-    shouldShowLayerManager?: boolean;
-    shouldShowDockedLayerManager?: boolean;
-    dockedLayerManagerSize?: DockedLayerManagerSize;
-}
-export interface MapPresetInitialProps {
-    mapPreset: MapPreset;
-    syncGroupsIds?: string[];
-}
-export interface MoveLayerPayload {
-    mapId: string;
-    oldIndex: number;
-    newIndex: number;
-    origin: string;
-}
-export interface TimeListType {
-    name: string;
-    value: string;
-}
-export interface SetMapAnimationStartPayload {
-    mapId: string;
-    start?: string;
-    initialTime?: string;
-    end?: string;
-    interval?: number;
-    timeList?: TimeListType[];
-    origin?: MapActionOrigin;
-}
-export interface SetMapAnimationStopPayload {
-    mapId: string;
-    origin?: MapActionOrigin;
-}
-export interface SetAutoLayerIdPayload {
-    mapId: string;
-    layerId?: string;
-    autoUpdateLayerId?: string;
-    autoTimeStepLayerId?: string;
-    origin?: LayerActionOrigin | string;
-}
-export interface ToggleAutoUpdatePayload {
-    mapId: string;
-    shouldAutoUpdate: boolean;
-    origin?: MapActionOrigin;
-}
-export interface SetEndTimeOverriding {
-    mapId: string;
-    shouldEndtimeOverride: boolean;
-}
-export interface SetTimeSliderSpanPayload {
-    mapId: string;
-    timeSliderSpan: number;
-}
-export interface SetTimeStepPayload {
-    mapId: string;
-    timeStep?: number;
-    origin?: MapActionOrigin;
-}
-export interface SetAnimationDelayPayload {
-    mapId: string;
-    animationDelay: number;
-    origin?: MapActionOrigin;
-}
-export interface SetAnimationStartTimePayload {
-    mapId: string;
-    animationStartTime: string;
-    origin?: MapActionOrigin;
-}
-export interface SetAnimationEndTimePayload {
-    mapId: string;
-    animationEndTime: string;
-    origin?: MapActionOrigin;
-}
-export interface ToggleTimestepAutoPayload {
-    mapId: string;
-    timestepAuto: boolean;
-    origin?: MapActionOrigin;
-}
-export interface ToggleTimeSpanAutoPayload {
-    mapId: string;
-    timeSpanAuto: boolean;
-    origin?: MapActionOrigin;
-}
-export interface ToggleAnimationLengthAutoPayload {
-    mapId: string;
-    autoAnimationLength: boolean;
-    origin?: MapActionOrigin;
-}
-export interface ToggleTimeSliderHoverPayload {
-    mapId: string;
-    isTimeSliderHoverOn: boolean;
-}
-export interface ToggleTimeSliderIsVisiblePayload {
-    mapId: string;
-    isTimeSliderVisible: boolean;
-    origin?: MapActionOrigin;
-}
-export interface SetTimeSliderWidthPayload {
-    mapId: string;
-    timeSliderWidth: number;
-}
-export interface SetTimeSliderCenterTimePayload {
-    mapId: string;
-    timeSliderCenterTime: number;
-}
-export interface SetTimeSliderSecondsPerPxPayload {
-    mapId: string;
-    timeSliderSecondsPerPx: number;
-}
-export interface ToggleZoomControlsPayload {
-    mapId: string;
-    shouldShowZoomControls: boolean;
-}
-export interface DisableMapPinPayload {
-    mapId: string;
-    disableMapPin: boolean;
-}
-export interface ToggleMapPinIsVisiblePayload {
-    mapId: string;
-    displayMapPin: boolean;
-}
-export interface SetMapPresetPayload {
-    mapId: string;
-    initialProps: MapPresetInitialProps;
-}
-export interface SetDockedLayerManagerSize {
-    mapId: string;
-    dockedLayerManagerSize: DockedLayerManagerSize;
-}
-export interface ISO8601Interval {
-    startTime: string;
-    endTime: string;
-    duration: string;
-}
+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 {
+    name?: string;
+    units?: string;
+    currentValue: string;
+    maxValue?: string;
+    minValue?: string;
+    timeInterval?: TimeInterval;
+    synced?: boolean;
+    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;
+    bbox: Bbox;
+    mapLayers: string[];
+    baseLayers: string[];
+    overLayers: string[];
+    featureLayers: string[];
+    dimensions?: Dimension[];
+    autoUpdateLayerId?: string;
+    autoTimeStepLayerId?: string;
+    timeSliderSpan?: number;
+    timeStep?: number;
+    animationDelay?: number;
+    timeSliderWidth?: number;
+    timeSliderCenterTime?: number;
+    timeSliderSecondsPerPx?: number;
+    isTimestepAuto?: boolean;
+    isTimeSpanAuto?: boolean;
+    isAnimationLengthAuto?: boolean;
+    isTimeSliderHoverOn?: boolean;
+    isTimeSliderVisible?: boolean;
+    shouldShowZoomControls?: boolean;
+    mapPinLocation?: MapLocation;
+    disableMapPin?: boolean;
+    displayMapPin?: boolean;
+    legendId?: string;
+    dockedLayerManagerSize?: DockedLayerManagerSize;
+}
+export type DockedLayerManagerSize = 'sizeSmall' | 'sizeMedium' | 'sizeLarge' | '';
+export interface WebMapState {
+    byId: Record<string, WebMap>;
+    allIds: string[];
+}
+export interface Bbox {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+}
+export declare enum AnimationLength {
+    Minutes15 = 15,
+    Minutes30 = 30,
+    Hours1 = 60,
+    Hours2 = 120,
+    Hours3 = 180,
+    Hours6 = 360,
+    Hours12 = 720,
+    Hours24 = 1440
+}
+export interface AnimationPayloadType {
+    duration?: number;
+    interval?: number;
+    speed?: SpeedFactorType;
+    endTime?: string;
+    shouldEndtimeOverride?: boolean;
+}
+export interface MapPreset {
+    layers?: Layer[];
+    activeLayerId?: string;
+    autoTimeStepLayerId?: string;
+    autoUpdateLayerId?: string;
+    proj?: {
+        bbox: Bbox;
+        srs: string;
+    };
+    dimensions?: Dimension[];
+    shouldAnimate?: boolean;
+    shouldAutoUpdate?: boolean;
+    showTimeSlider?: boolean;
+    displayMapPin?: boolean;
+    shouldShowZoomControls?: boolean;
+    toggleTimestepAuto?: boolean;
+    animationPayload?: AnimationPayloadType;
+    shouldShowLegend?: boolean;
+    shouldShowLayerManager?: boolean;
+    shouldShowDockedLayerManager?: boolean;
+    dockedLayerManagerSize?: DockedLayerManagerSize;
+}
+export interface MapPresetInitialProps {
+    mapPreset: MapPreset;
+    syncGroupsIds?: string[];
+}
+export interface MoveLayerPayload {
+    mapId: string;
+    oldIndex: number;
+    newIndex: number;
+    origin: string;
+}
+export interface TimeListType {
+    name: string;
+    value: string;
+}
+export interface SetMapAnimationStartPayload {
+    mapId: string;
+    start?: string;
+    initialTime?: string;
+    end?: string;
+    interval?: number;
+    timeList?: TimeListType[];
+    origin?: MapActionOrigin;
+}
+export interface SetMapAnimationStopPayload {
+    mapId: string;
+    origin?: MapActionOrigin;
+}
+export interface SetAutoLayerIdPayload {
+    mapId: string;
+    layerId?: string;
+    autoUpdateLayerId?: string;
+    autoTimeStepLayerId?: string;
+    origin?: LayerActionOrigin | string;
+}
+export interface ToggleAutoUpdatePayload {
+    mapId: string;
+    shouldAutoUpdate: boolean;
+    origin?: MapActionOrigin;
+}
+export interface SetEndTimeOverriding {
+    mapId: string;
+    shouldEndtimeOverride: boolean;
+}
+export interface SetTimeSliderSpanPayload {
+    mapId: string;
+    timeSliderSpan: number;
+}
+export interface SetTimeStepPayload {
+    mapId: string;
+    timeStep?: number;
+    origin?: MapActionOrigin;
+}
+export interface SetAnimationDelayPayload {
+    mapId: string;
+    animationDelay: number;
+    origin?: MapActionOrigin;
+}
+export interface SetAnimationStartTimePayload {
+    mapId: string;
+    animationStartTime: string;
+    origin?: MapActionOrigin;
+}
+export interface SetAnimationEndTimePayload {
+    mapId: string;
+    animationEndTime: string;
+    origin?: MapActionOrigin;
+}
+export interface ToggleTimestepAutoPayload {
+    mapId: string;
+    timestepAuto: boolean;
+    origin?: MapActionOrigin;
+}
+export interface ToggleTimeSpanAutoPayload {
+    mapId: string;
+    timeSpanAuto: boolean;
+    origin?: MapActionOrigin;
+}
+export interface ToggleAnimationLengthAutoPayload {
+    mapId: string;
+    autoAnimationLength: boolean;
+    origin?: MapActionOrigin;
+}
+export interface ToggleTimeSliderHoverPayload {
+    mapId: string;
+    isTimeSliderHoverOn: boolean;
+}
+export interface ToggleTimeSliderIsVisiblePayload {
+    mapId: string;
+    isTimeSliderVisible: boolean;
+    origin?: MapActionOrigin;
+}
+export interface SetTimeSliderWidthPayload {
+    mapId: string;
+    timeSliderWidth: number;
+}
+export interface SetTimeSliderCenterTimePayload {
+    mapId: string;
+    timeSliderCenterTime: number;
+}
+export interface SetTimeSliderSecondsPerPxPayload {
+    mapId: string;
+    timeSliderSecondsPerPx: number;
+}
+export interface ToggleZoomControlsPayload {
+    mapId: string;
+    shouldShowZoomControls: boolean;
+}
+export interface DisableMapPinPayload {
+    mapId: string;
+    disableMapPin: boolean;
+}
+export interface ToggleMapPinIsVisiblePayload {
+    mapId: string;
+    displayMapPin: boolean;
+}
+export interface SetMapPresetPayload {
+    mapId: string;
+    initialProps: MapPresetInitialProps;
+}
+export interface SetDockedLayerManagerSize {
+    mapId: string;
+    dockedLayerManagerSize: DockedLayerManagerSize;
+}
+export interface ISO8601Interval {
+    startTime: string;
+    endTime: string;
+    duration: string;
+}

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

@@ -1,85 +1,85 @@
-import { TimeInterval } from '@opengeoweb/webmap';
-import { SpeedFactorType } from '@opengeoweb/timeslider';
-import { Bbox, Dimension } from './types';
-import type { WebMapState, WebMap, ISO8601Interval, WebMapAnimationList } from '../types';
-import type { Layer } from '../layers/types';
-export declare const dateFormat = "yyyy-MM-dd'T'HH:mm:ss'Z'";
-export interface CreateMapProps {
-    id: string;
-    isAnimating?: boolean;
-    animationStartTime?: string;
-    animationEndTime?: string;
-    isAutoUpdating?: boolean;
-    shouldEndtimeOverride?: boolean;
-    srs?: string;
-    bbox?: Bbox;
-    mapLayers?: string[];
-    baseLayers?: string[];
-    overLayers?: string[];
-    featureLayers?: string[];
-    dimensions?: Dimension[];
-    autoTimeStepLayerId?: string;
-    autoUpdateLayerId?: string;
-    timeSliderSpan?: number;
-    timeStep?: number;
-    animationDelay?: number;
-    timeSliderWidth?: number;
-    timeSliderCenterTime?: number;
-    timeSliderSecondsPerPx?: number;
-    isTimestepAuto?: boolean;
-    isTimeSpanAuto?: boolean;
-    isTimeSliderHoverOn?: boolean;
-    isTimeSliderVisible?: boolean;
-    displayMapPin?: boolean;
-    disableMapPin?: boolean;
-    shouldShowZoomControls?: boolean;
-}
-export declare const createMap: ({ id, isAnimating, animationStartTime, animationEndTime, isAutoUpdating, shouldEndtimeOverride, bbox, srs, baseLayers, overLayers, mapLayers, featureLayers, dimensions, autoUpdateLayerId, autoTimeStepLayerId, timeSliderSpan, timeStep, animationDelay, timeSliderWidth, timeSliderCenterTime, timeSliderSecondsPerPx, isTimestepAuto, isTimeSpanAuto, isTimeSliderHoverOn, isTimeSliderVisible, displayMapPin, disableMapPin, shouldShowZoomControls, }: CreateMapProps) => WebMap;
-export declare const checkValidLayersPayload: (layers: Layer[], mapId: string) => boolean;
-/**
- * This will get the map from the map draftstate.
- * If the mapId is not found, it registers one and returns it.
- * @param mapId The mapID
- * @param draft Draft map state
- */
-export declare const getDraftMapById: (mapId: string, draft: WebMapState) => WebMap;
-/**
- * Sets the map dimension in the state.
- * It will add dimensions to the map if they are missing.
- * If will update the existing dimensions if overwriteCurrentValue is set to true
- * @param draft The map draft state
- * @param mapId The mapId to update the dimensions for
- * @param dimensionFromAction  The dimension from the action
- * @param overwriteCurrentValue True to overwrite existing value. False to add a new dimension if one is not there yet.
- */
-export declare const produceDraftStateSetWebMapDimension: (draft: WebMapState, mapId: string, dimensionFromAction: Dimension, overwriteCurrentValue: boolean) => void;
-/**
- * Find the mapId belonging to a layerId
- * @param draft The WebMapState containing the state of all maps.
- * @param layerId The layer Id to find in the maps
- */
-export declare const findMapIdFromLayerId: (mapState?: WebMapState, layerId?: string) => string | null;
-export declare const produceDraftStateSetMapDimensionFromLayerChangeDimension: (draft: WebMapState, layerId: string, dimension: Dimension) => void;
-/**
- * Returns array with new order of swapped elements
- * @param array Array with ids
- * @param oldIndex Old index of element in array
- * @param newIndex New index of element in array
- */
-export declare function moveArrayElements<T>(array: T[], oldIndex: number, newIndex: number): T[];
-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;
-/**
- * @param animationStart
- * @param animationEnd
- * @param iso8601Intervals
- * @returns WebMapAnimationList with time points
- */
-export declare const generateAnimationList: (unixAnimationStart: number, unixAnimationEnd: number, timeValues: string | undefined) => WebMapAnimationList;
-/**
- * Parses the time dimension values string to an array of ISO8601 intervals
- * @param timeInterval
- * @returns An array of ISO8601 intervals
- */
-export declare const parseTimeDimToISO8601Interval: (timeInterval: string | undefined) => ISO8601Interval[];
+import { TimeInterval } from '@opengeoweb/webmap';
+import { SpeedFactorType } from '@opengeoweb/timeslider';
+import { Bbox, Dimension } from './types';
+import type { WebMapState, WebMap, ISO8601Interval, WebMapAnimationList } from '../types';
+import type { Layer } from '../layers/types';
+export declare const dateFormat = "yyyy-MM-dd'T'HH:mm:ss'Z'";
+export interface CreateMapProps {
+    id: string;
+    isAnimating?: boolean;
+    animationStartTime?: string;
+    animationEndTime?: string;
+    isAutoUpdating?: boolean;
+    shouldEndtimeOverride?: boolean;
+    srs?: string;
+    bbox?: Bbox;
+    mapLayers?: string[];
+    baseLayers?: string[];
+    overLayers?: string[];
+    featureLayers?: string[];
+    dimensions?: Dimension[];
+    autoTimeStepLayerId?: string;
+    autoUpdateLayerId?: string;
+    timeSliderSpan?: number;
+    timeStep?: number;
+    animationDelay?: number;
+    timeSliderWidth?: number;
+    timeSliderCenterTime?: number;
+    timeSliderSecondsPerPx?: number;
+    isTimestepAuto?: boolean;
+    isTimeSpanAuto?: boolean;
+    isTimeSliderHoverOn?: boolean;
+    isTimeSliderVisible?: boolean;
+    displayMapPin?: boolean;
+    disableMapPin?: boolean;
+    shouldShowZoomControls?: boolean;
+}
+export declare const createMap: ({ id, isAnimating, animationStartTime, animationEndTime, isAutoUpdating, shouldEndtimeOverride, bbox, srs, baseLayers, overLayers, mapLayers, featureLayers, dimensions, autoUpdateLayerId, autoTimeStepLayerId, timeSliderSpan, timeStep, animationDelay, timeSliderWidth, timeSliderCenterTime, timeSliderSecondsPerPx, isTimestepAuto, isTimeSpanAuto, isTimeSliderHoverOn, isTimeSliderVisible, displayMapPin, disableMapPin, shouldShowZoomControls, }: CreateMapProps) => WebMap;
+export declare const checkValidLayersPayload: (layers: Layer[], mapId: string) => boolean;
+/**
+ * This will get the map from the map draftstate.
+ * If the mapId is not found, it registers one and returns it.
+ * @param mapId The mapID
+ * @param draft Draft map state
+ */
+export declare const getDraftMapById: (mapId: string, draft: WebMapState) => WebMap;
+/**
+ * Sets the map dimension in the state.
+ * It will add dimensions to the map if they are missing.
+ * If will update the existing dimensions if overwriteCurrentValue is set to true
+ * @param draft The map draft state
+ * @param mapId The mapId to update the dimensions for
+ * @param dimensionFromAction  The dimension from the action
+ * @param overwriteCurrentValue True to overwrite existing value. False to add a new dimension if one is not there yet.
+ */
+export declare const produceDraftStateSetWebMapDimension: (draft: WebMapState, mapId: string, dimensionFromAction: Dimension, overwriteCurrentValue: boolean) => void;
+/**
+ * Find the mapId belonging to a layerId
+ * @param draft The WebMapState containing the state of all maps.
+ * @param layerId The layer Id to find in the maps
+ */
+export declare const findMapIdFromLayerId: (mapState?: WebMapState, layerId?: string) => string | null;
+export declare const produceDraftStateSetMapDimensionFromLayerChangeDimension: (draft: WebMapState, layerId: string, dimension: Dimension) => void;
+/**
+ * Returns array with new order of swapped elements
+ * @param array Array with ids
+ * @param oldIndex Old index of element in array
+ * @param newIndex New index of element in array
+ */
+export declare function moveArrayElements<T>(array: T[], oldIndex: number, newIndex: number): T[];
+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;
+/**
+ * @param animationStart
+ * @param animationEnd
+ * @param iso8601Intervals
+ * @returns WebMapAnimationList with time points
+ */
+export declare const generateAnimationList: (unixAnimationStart: number, unixAnimationEnd: number, timeValues: string | undefined) => WebMapAnimationList;
+/**
+ * Parses the time dimension values string to an array of ISO8601 intervals
+ * @param timeInterval
+ * @returns An array of ISO8601 intervals
+ */
+export declare const parseTimeDimToISO8601Interval: (timeInterval: string | undefined) => ISO8601Interval[];

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

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