@opengeoweb/time-series 13.0.0

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@opengeoweb/time-series",
+  "version": "13.0.0",
+  "description": "GeoWeb time-series library for the opengeoweb project",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
+  },
+  "dependencies": {
+    "immer": "^10.0.3",
+    "@opengeoweb/shared": "13.0.0",
+    "@reduxjs/toolkit": "^2.6.1",
+    "react-redux": "^9.2.0",
+    "@opengeoweb/webmap": "13.0.0",
+    "@opengeoweb/webmap-react": "13.0.0",
+    "lodash": "^4.17.21",
+    "@opengeoweb/api": "13.0.0",
+    "@opengeoweb/theme": "13.0.0",
+    "@opengeoweb/store": "13.0.0",
+    "echarts-for-react": "^3.0.2",
+    "echarts": "^5.4.3",
+    "react-sortablejs": "^6.1.4",
+    "@opengeoweb/snackbar": "13.0.0",
+    "react-window": "^1.8.10",
+    "react-virtualized-auto-sizer": "^1.0.21",
+    "msw": "^2.7.3",
+    "i18next": "^25.0.1",
+    "react-i18next": "^15.1.1",
+    "@opengeoweb/core": "13.0.0",
+    "@opengeoweb/form-fields": "13.0.0",
+    "@mui/material": "^7.0.1",
+    "react-hook-form": "^7.61.1",
+    "uuid": "^10.0.0",
+    "@turf/turf": "^7.2.0",
+    "@tanstack/react-query": "^5.85.5",
+    "@types/geojson": "^7946.0.14"
+  },
+  "peerDependencies": {
+    "react": "18",
+    "@emotion/react": "*",
+    "@emotion/styled": "*"
+  },
+  "devDependencies": {
+    "eslint-plugin-storybook": "9.0.17"
+  },
+  "module": "./index.esm.js",
+  "type": "module",
+  "main": "./index.esm.js",
+  "types": "./index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+import timeseriesTranslations from '../locales/timeseries.json';
+export * from './lib';
+export { TIME_SERIES_NAMESPACE } from './lib/utils/i18n';
+export { timeseriesTranslations };

package/src/lib/TimeSeriesDemo.stories.d.ts

@@ -0,0 +1,43 @@
+import React from 'react';
+export declare const TimeSeriesEDRFinlandDemo: {
+    (): React.ReactElement;
+    parameters: {
+        zeplinLink: {
+            name: string;
+            link: string;
+        }[];
+    };
+};
+export declare const TimeSeriesEDRNorwayDemo: {
+    (): React.ReactElement;
+    parameters: {
+        zeplinLink: {
+            name: string;
+            link: string;
+        }[];
+    };
+};
+export declare const TimeSeriesEDRMultiViewDemo: {
+    (): React.ReactElement;
+    parameters: {
+        zeplinLink: {
+            name: string;
+            link: string;
+        }[];
+    };
+};
+export declare const TimeSeriesEDRNetherlandsObsDemo: {
+    (): React.ReactElement;
+    parameters: {
+        zeplinLink: {
+            name: string;
+            link: string;
+        }[];
+    };
+};
+export declare const TimeSeriesUKDemo: () => React.ReactElement;
+declare const _default: {
+    title: string;
+    tags: string[];
+};
+export default _default;

package/src/lib/components/ComponentsLookUp/componentsLookUp.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { TimeSeriesService } from '@opengeoweb/shared';
+import { PlotPreset } from '../TimeSeries/types';
+interface InitialTimeseriesProps {
+    plotPreset: PlotPreset;
+    services: TimeSeriesService[];
+    hideLocationMarkers?: boolean;
+}
+export type SupportedComponentTypes = 'TimeSeries';
+export type InitialProps = InitialTimeseriesProps;
+export interface ComponentsLookUpPayload {
+    componentType: SupportedComponentTypes;
+    id: string;
+    title?: string;
+    initialProps: InitialProps;
+}
+/**
+ * The lookup table is for registering your own components with the workspace.
+ * @param payload
+ * @returns
+ */
+export declare const componentsLookUp: ({ id: panelId, componentType, initialProps, }: ComponentsLookUpPayload) => React.ReactElement;
+export {};

package/src/lib/components/ComponentsLookUp/componentsLookUp.stories.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const ComponentsLookUp: {
+    (): React.ReactElement;
+    tags: string[];
+};

package/src/lib/components/ComponentsLookUp/componentsLookup.spec.d.ts

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

package/src/lib/components/ComponentsLookUp/index.d.ts

@@ -0,0 +1 @@
+export * from './componentsLookUp';

package/src/lib/components/Providers/Providers.d.ts

@@ -0,0 +1,32 @@
+import React from 'react';
+import { Store } from '@reduxjs/toolkit';
+import { ThemeProviderProps } from '@opengeoweb/theme';
+import { Theme } from '@mui/material';
+export declare const TimeSeriesThemeWrapper: React.FC<ThemeProviderProps>;
+interface TimeSeriesApiProviderProps {
+    children: React.ReactNode;
+}
+interface TimeSeriesThemeStoreProviderProps {
+    children?: React.ReactNode;
+    theme?: Theme;
+    store: Store;
+}
+interface TimeseriesTranslationWrapperProps {
+    children?: React.ReactNode;
+}
+/**
+ * A Provider component which returns the Api Provider for the TimeSeries library
+ * @param children
+ * @returns
+ */
+export declare const TimeSeriesApiProvider: React.FC<TimeSeriesApiProviderProps>;
+export interface TimeSeriesStoreProviderProps extends ThemeProviderProps {
+    store: Store;
+}
+export declare const TimeSerieStoreProvider: React.FC<{
+    children?: React.ReactNode;
+    store: Store;
+}>;
+export declare const TimeSeriesThemeStoreProvider: React.FC<TimeSeriesThemeStoreProviderProps>;
+export declare const TimeseriesI18nProvider: React.FC<TimeseriesTranslationWrapperProps>;
+export {};

package/src/lib/components/Providers/index.d.ts

@@ -0,0 +1 @@
+export * from './Providers';

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdown.d.ts

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { FeatureCollection, GeometryObject } from 'geojson';
+import { GeoJsonWithService } from '../types';
+interface LocationDropdownProps {
+    splitGeoJson?: GeoJsonWithService[];
+    handleChange: (newSelectedLocation: string) => void;
+    selectedLocation: string;
+    geoJson?: FeatureCollection<GeometryObject>;
+    isDisabled?: boolean;
+}
+export declare const LocationDropdown: React.FC<LocationDropdownProps>;
+export {};

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdown.spec.d.ts

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

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdown.stories.d.ts

@@ -0,0 +1,9 @@
+import type { Meta, StoryObj } from '@storybook/react-webpack5';
+import { LocationDropdown } from './LocationDropdown';
+declare const meta: Meta<typeof LocationDropdown>;
+export default meta;
+type Story = StoryObj<typeof LocationDropdown>;
+export declare const Component: Story;
+export declare const ComponentDark: Story;
+export declare const LocationDropdownDemoLight: Story;
+export declare const LocationDropdownDemoDark: Story;

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdownHeader.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface LocationDropdownHeaderProps {
+    searchTerm: string;
+    setSearchTerm: (value: string) => void;
+}
+export declare const LocationDropdownHeader: React.FC<LocationDropdownHeaderProps>;
+export {};

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdownHeader.spec.d.ts

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

package/src/lib/components/TimeSeries/LocationDropdown/LocationDropdownRenderRow.d.ts

@@ -0,0 +1,3 @@
+import { Feature, GeoJsonProperties, GeometryObject } from 'geojson';
+import { ListChildComponentProps } from 'react-window';
+export declare const renderRow: (features: Feature<GeometryObject, GeoJsonProperties>[], handleChange: (newSelectedLocation: string) => void, selectedLocation: string, isDisabled?: boolean) => (props: ListChildComponentProps) => React.ReactElement;

package/src/lib/components/TimeSeries/LocationDropdown/LocationListItem.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+export interface LocationListItemProps {
+    location: string;
+    handleChange: (newSelectedLocation: string) => void;
+    selectedLocation: string;
+    isDisabled?: boolean;
+}
+export declare const LocationListItem: React.FC<LocationListItemProps>;

package/src/lib/components/TimeSeries/LocationDropdown/LocationListItem.spec.d.ts

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

package/src/lib/components/TimeSeries/LocationDropdown/OverflowTooltip.d.ts

@@ -0,0 +1,8 @@
+import React, { ReactNode } from 'react';
+interface OverflowTooltipProps {
+    text: string;
+    textContainerWidth: number;
+    children?: ReactNode;
+}
+export declare const OverflowTooltip: React.FC<OverflowTooltipProps>;
+export {};

package/src/lib/components/TimeSeries/LocationDropdown/testData.d.ts

@@ -0,0 +1,2 @@
+import { GeoJsonWithService } from '../types';
+export declare const testDataWith3Services: GeoJsonWithService[];

package/src/lib/components/TimeSeries/LocationInfo/LocationInfo.d.ts

@@ -0,0 +1,30 @@
+import { Feature, GeometryObject } from 'geojson';
+import { TimeSeriesService } from '@opengeoweb/shared';
+import { MapLocation } from '@opengeoweb/webmap-react';
+export interface ParameterInfo {
+    loading: boolean;
+    parameters: string[];
+}
+export interface CalculatedLocationCollectionInfo {
+    properties: Record<string, string>;
+    parameterIndex: number;
+}
+export interface CalculatedLocationInfo {
+    geometry: GeometryObject;
+    properties: Record<string, string>;
+    collections: CalculatedLocationCollectionInfo[];
+}
+export interface LocationInfoProps {
+    feature?: Feature<GeometryObject> | null;
+    mapPinLocation?: MapLocation;
+    services?: TimeSeriesService[];
+    isOpen: boolean;
+    onClose: () => void;
+    onMouseDown: () => void;
+    order: number;
+}
+export declare const LocationInfo: React.FC<LocationInfoProps>;
+export interface ParameterInfoTextProps {
+    label: string;
+    value: string;
+}

package/src/lib/components/TimeSeries/LocationInfo/LocationInfo.spec.d.ts

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

package/src/lib/components/TimeSeries/LocationInfo/LocationInfo.stories.d.ts

@@ -0,0 +1,10 @@
+import { StoryObj } from '@storybook/react/*';
+import { LocationInfo } from './LocationInfo';
+declare const _default: {
+    title: string;
+    component: import("react").FC<import("./LocationInfo").LocationInfoProps>;
+};
+export default _default;
+type Story = StoryObj<typeof LocationInfo>;
+export declare const LocationInfoDemoLight: Story;
+export declare const LocationInfoDemoDark: Story;

package/src/lib/components/TimeSeries/LocationInfo/LocationInfoButtonConnect.d.ts

@@ -0,0 +1,7 @@
+import * as React from 'react';
+import { TFunction } from 'i18next';
+export interface LocationInfoButtonConnectProps {
+    panelId: string;
+    t: TFunction;
+}
+export declare const LocationInfoButtonConnect: React.FC<LocationInfoButtonConnectProps>;

package/src/lib/components/TimeSeries/LocationInfo/LocationInfoConnect.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const LocationInfoConnect: React.FC;

package/src/lib/components/TimeSeries/LocationSelect/LocationSelectButtonConnect.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface LocationSelectButtonConnectProps {
+    panelId: string;
+}
+export declare const LocationSelectButtonConnect: React.FC<LocationSelectButtonConnectProps>;
+export {};

package/src/lib/components/TimeSeries/LocationSelect/LocationSelectDialogConnect.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const LocationSelectDialogConnect: React.FC;

package/src/lib/components/TimeSeries/LocationSelect/index.d.ts

@@ -0,0 +1 @@
+export * from './LocationSelectDialogConnect';

package/src/lib/components/TimeSeries/TimeSeriesChart.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { EChartsInstance, EChartsOption } from 'echarts-for-react';
+import { PlotWithData } from './types';
+export declare const useChartHeight: ({ plotsWithData, shouldShowLegend, option, }: {
+    plotsWithData: PlotWithData[];
+    shouldShowLegend: boolean;
+    option: EChartsOption;
+}) => {
+    chartHeight: number;
+    chartRef: React.RefObject<EChartsInstance>;
+    updateHeight: (echartsInstance: EChartsInstance) => void;
+};
+export declare const TimeSeriesChart: React.FC<{
+    plotsWithData: PlotWithData[];
+    animation?: boolean;
+    shouldShowLegend?: boolean;
+}>;

package/src/lib/components/TimeSeries/TimeSeriesChart.spec.d.ts

@@ -0,0 +1 @@
+import 'jest-canvas-mock';

package/src/lib/components/TimeSeries/TimeSeriesChart.stories.d.ts

@@ -0,0 +1,12 @@
+import type { Meta, StoryObj } from '@storybook/react-webpack5';
+import { TimeSeriesChart } from './TimeSeriesChart';
+declare const meta: Meta<typeof TimeSeriesChart>;
+export default meta;
+type Story = StoryObj<typeof TimeSeriesChart>;
+export declare const Component: Story;
+export declare const ThemeChartDemo: Story;
+export declare const StaticChartDemoLight: Story;
+export declare const StaticChartDemoDark: Story;
+export declare const ThemeChartWithNullValues: Story;
+export declare const ChartWithMuchData: Story;
+export declare const ChartWithMuchDataNoLegend: Story;

package/src/lib/components/TimeSeries/TimeSeriesConnect.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { TimeSeriesService } from '@opengeoweb/shared';
+import { Parameter } from './types';
+import { GetLocationsOption } from '../../utils/timeseries-api/hooks';
+export declare const getUniqueServicesFromPreset: (parameters: Parameter[], services: TimeSeriesService[]) => GetLocationsOption[];
+export interface TimeSeriesConnectProps {
+    panelId: string;
+}
+export declare const TimeSeriesConnect: React.FC<TimeSeriesConnectProps>;

package/src/lib/components/TimeSeries/TimeSeriesConnect.integration.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesConnect.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesConnect.stories.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import type { Meta, StoryObj } from '@storybook/react-webpack5';
+import { TimeSeriesConnectProps } from './TimeSeriesConnect';
+declare const TimeSeriesConnectStory: ({ width, ...props }: TimeSeriesConnectProps & {
+    width: number;
+}) => React.ReactElement;
+declare const meta: Meta<typeof TimeSeriesConnectStory>;
+type Story = StoryObj<typeof TimeSeriesConnectStory>;
+export default meta;
+export declare const TimeSeriesMarkersSwitchLarge: Story;
+export declare const TimeSeriesMarkersSwitchSmall: Story;

package/src/lib/components/TimeSeries/TimeSeriesConnectWrapper.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { TimeSeriesStoreType } from '../../store/types';
+interface Props {
+    panelId: string;
+    timeSeriesPreset: TimeSeriesStoreType;
+    hideLocationMarkers?: boolean;
+}
+export declare const TimeSeriesConnectWrapper: React.FC<Props>;
+export {};

package/src/lib/components/TimeSeries/TimeSeriesConnectWrapper.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesMarkersSwitch.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface TimeSeriesMarkersSwitchProps {
+    shouldHideMarkers: boolean;
+    toggleMarkers: (shouldHideMarkers: boolean) => void;
+}
+export declare const TimeSeriesMarkersSwitch: React.FC<TimeSeriesMarkersSwitchProps>;

package/src/lib/components/TimeSeries/TimeSeriesMarkersSwitch.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesTopRowButton.d.ts

@@ -0,0 +1,9 @@
+import { CustomToggleButtonProps } from '@opengeoweb/shared';
+import React from 'react';
+interface TimeSeriesButtonProps extends CustomToggleButtonProps {
+    icon: React.ReactNode;
+    shortText?: string;
+    longText: string;
+}
+export declare const TimeSeriesTopRowButton: import("@emotion/styled").StyledComponent<Omit<TimeSeriesButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, {}, {}>;
+export {};

package/src/lib/components/TimeSeries/TimeSeriesTopRowButton.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesTopRowButton.stories.d.ts

@@ -0,0 +1,8 @@
+import type { Meta, StoryObj } from '@storybook/react-webpack5';
+import { TimeSeriesTopRowButton } from './TimeSeriesTopRowButton';
+declare const meta: Meta<typeof TimeSeriesTopRowButton>;
+export default meta;
+type Story = StoryObj<typeof TimeSeriesTopRowButton>;
+export declare const Component: Story;
+export declare const TimeSeriesTopRowButtonDemoLight: Story;
+export declare const TimeSeriesTopRowButtonDemoDark: Story;

package/src/lib/components/TimeSeries/TimeSeriesView.d.ts

@@ -0,0 +1,13 @@
+import { PlotPreset, TimeSeriesService } from '@opengeoweb/shared';
+import React from 'react';
+import { PointerLocation, GeoJsonWithService } from './types';
+interface TimeSeriesViewProps {
+    plotPreset: PlotPreset;
+    selectedLocation: PointerLocation;
+    services: TimeSeriesService[];
+    splitGeoJsonByCollection: GeoJsonWithService[];
+    isLoading?: (startOrFinish: boolean) => void;
+    shouldShowLegend?: boolean;
+}
+export declare const TimeSeriesView: React.FC<TimeSeriesViewProps>;
+export {};

package/src/lib/components/TimeSeries/TimeSeriesView.spec.d.ts

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

package/src/lib/components/TimeSeries/TimeSeriesView.stories.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const FmiSofpDemo: {
+    (): React.ReactElement;
+    tags: string[];
+};

package/src/lib/components/TimeSeries/chartUtils.d.ts

@@ -0,0 +1,35 @@
+import { EChartsOption, XAXisComponentOption, YAXisComponentOption, GridComponentOption, LineSeriesOption, BarSeriesOption, ScatterSeriesOption } from 'echarts';
+import { ParameterWithData, Plot, PlotWithData } from './types';
+export declare const MIN_GRAPH_WIDTH = 300;
+export declare const dateFormatter: (date: string) => string;
+export declare const getTooltipTimeLabel: (date: string) => string;
+interface ParamIntervalType {
+    unit?: string;
+    propertyName?: string;
+    presentation?: string;
+    interval: number;
+    minNumberOfIntervals?: number;
+    maxNumberOfIntervals?: number;
+}
+export declare const paramIntervals: ParamIntervalType[];
+export declare const getYAxis: (plotCharts: PlotChart[]) => YAXisComponentOption[];
+export declare const getXAxis: (plotCharts: PlotChart[], minDate: Date, maxDate: Date) => XAXisComponentOption[];
+export declare const getParameterDisplayName: (parameter: ParameterWithData) => string;
+export declare const roundDecimalValues: (value: number) => string;
+export declare const getOption: (plotsWithData: PlotWithData[]) => EChartsOption;
+export declare const getEChartsSeriesDataByTimestep: (timesteps: Date[], parameter: ParameterWithData) => (number | string)[][];
+export declare const getSeries: (plotCharts: PlotChart[]) => (LineSeriesOption | BarSeriesOption | ScatterSeriesOption)[];
+export declare const getGrid: (plotCharts: PlotChart[]) => GridComponentOption[];
+export declare const Y_AXIS_OFFSET = 80;
+export declare const PLOT_HEIGHT = 150;
+export interface PlotChart extends Plot {
+    parametersByUnit: Record<string, ParameterWithData[]>;
+    countPreviousUnits: number;
+}
+/**
+ * This function iterates over all added plots and paramters, finds the min and max values from all datasets to determine how to set the timespan
+ * @param PlotsWithData Plots that contain fetched parameter data
+ * @returns left and right values for the timespan
+ */
+export declare const CalculateTimeSpan: (plotsWithData: PlotWithData[]) => Record<string, Date>;
+export {};

package/src/lib/components/TimeSeries/chartUtils.spec.d.ts

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