@opengeoweb/time-series 13.2.1 → 14.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/time-series",
-  "version": "13.2.1",
+  "version": "14.0.0",
   "description": "GeoWeb time-series library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -9,26 +9,26 @@
   },
   "dependencies": {
     "immer": "^10.0.3",
-    "@opengeoweb/shared": "13.2.1",
+    "@opengeoweb/shared": "14.0.0",
     "@reduxjs/toolkit": "^2.6.1",
     "react-redux": "^9.2.0",
-    "@opengeoweb/webmap": "13.2.1",
-    "@opengeoweb/webmap-react": "13.2.1",
+    "@opengeoweb/webmap": "14.0.0",
+    "@opengeoweb/webmap-react": "14.0.0",
     "lodash": "^4.17.21",
-    "@opengeoweb/api": "13.2.1",
-    "@opengeoweb/theme": "13.2.1",
-    "@opengeoweb/store": "13.2.1",
+    "@opengeoweb/api": "14.0.0",
+    "@opengeoweb/theme": "14.0.0",
+    "@opengeoweb/store": "14.0.0",
     "echarts-for-react": "^3.0.2",
     "echarts": "^5.4.3",
     "react-sortablejs": "^6.1.4",
-    "@opengeoweb/snackbar": "13.2.1",
+    "@opengeoweb/snackbar": "14.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.2.1",
-    "@opengeoweb/form-fields": "13.2.1",
+    "@opengeoweb/core": "14.0.0",
+    "@opengeoweb/form-fields": "14.0.0",
     "@mui/material": "^7.0.1",
     "react-hook-form": "^7.61.1",
     "uuid": "^10.0.0",

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

@@ -1,3 +1,5 @@
+import { syncGroupsTypes } from '@opengeoweb/store';
+import { MapFeatureClass } from '@opengeoweb/webmap-react';
 import { FeatureCollection, GeometryObject } from 'geojson';
 export interface Geometry {
     type: string;
@@ -8,6 +10,14 @@ export interface Properties {
     propertyName: string;
     values: number[];
 }
+export interface UseGetLocationReturnTypeProperties {
+    name?: string;
+    detail?: string;
+    serviceId: string;
+    collectionId: string;
+    parameterName?: string[];
+    mapFeatureClass: MapFeatureClass;
+}
 export interface ObservationProperties {
     timestep: string[];
     observedPropertyName: string;
@@ -44,6 +54,7 @@ export interface Parameter {
     plotId: string;
     unit?: string;
     propertyName: string;
+    propertyLabel?: string;
     plotType: PlotType | 'area';
     enabled?: boolean;
     color?: string;
@@ -67,19 +78,9 @@ export interface PointerLocation {
     lon: number;
     lat: number;
 }
-export interface Occurrence {
-    id: string;
-    properties: OccurrenceProperties;
-}
-export interface OccurrenceProperties {
-    name: string;
-    serviceId: string;
-    collectionId: string;
-    parameterName?: string;
-}
 export interface TimeSeriesLocation extends PointerLocation {
     id?: string;
-    occurrences?: Occurrence[];
+    occurrences?: syncGroupsTypes.Occurrence[];
 }
 export declare const isTimeSeriesLocation: (obj: PointerLocation | TimeSeriesLocation) => obj is TimeSeriesLocation;
 export interface EDRAxes {
@@ -103,6 +104,7 @@ export interface EDRObservedProperty {
 export type EDRI18nString = string | Record<string, string>;
 export interface EDRParameter {
     id: string;
+    label?: string;
     observedProperty?: EDRObservedProperty;
     unit?: {
         label?: EDRI18nString;
@@ -132,27 +134,29 @@ export interface EDRPositionResponseCoverageCollection {
     parameters: EDRParameters;
     type: string;
 }
+export interface EDRDataQueriesObject {
+    cube?: object;
+    locations?: object;
+    position?: object;
+    instances?: object;
+}
+export interface EDRExtentObject {
+    temporal?: {
+        interval: string[][];
+        trs: string;
+        values: string[];
+    };
+    spatial?: {
+        crs: string;
+        bbox: [number, number, number, number] | [[number, number, number, number]];
+    };
+    custom?: CustomDimension[];
+}
 export interface EDRCollection {
     parameter_names?: object;
     parameters?: object;
-    data_queries?: {
-        cube?: object;
-        locations?: object;
-        position?: object;
-        instances?: object;
-    };
-    extent?: {
-        temporal?: {
-            interval: string[][];
-            trs: string;
-            values: string[];
-        };
-        spatial: {
-            crs: string;
-            bbox: [number, number, number, number];
-        };
-        custom?: CustomDimension[];
-    };
+    data_queries?: EDRDataQueriesObject;
+    extent?: EDRExtentObject;
     id: string;
     title: string;
     description: string;
@@ -213,6 +217,7 @@ export type EdrCollections = Record<string, {
 }>;
 export interface SelectParameter {
     propertyName: string;
+    propertyLabel?: string;
     unit: string;
     plotType: PlotType;
     serviceId: string;

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

@@ -1,15 +1,21 @@
-import { Plot, PlotParameter, TimeSeriesService } from '@opengeoweb/shared';
-import { FeatureCollection, GeoJsonProperties, GeometryObject } from 'geojson';
-import { GeoJsonWithService, Parameter, ParameterWithData, PlotWithData, PointerLocation, TimeSeriesLocation } from './types';
-import { TimeseriesCollectionDetail } from '../TimeSeriesSelect/utils';
-export declare const createGeoJsonArrays: (locations: (FeatureCollection<GeometryObject, GeoJsonProperties> | undefined)[], services: TimeSeriesService[] | undefined, hideFeatures: boolean, memoizedSelectedFeature: TimeSeriesLocation | null) => {
-    combinedGeoJson: FeatureCollection<GeometryObject, GeoJsonProperties>;
+import { Plot, PlotParameter, PlotPreset, TimeSeriesService } from '@opengeoweb/shared';
+import { FeatureCollection, GeometryObject } from 'geojson';
+import { syncGroupsTypes } from '@opengeoweb/store';
+import { EDRPositionResponse, EDRPositionResponseCoverageCollection, GeoJsonWithService, Parameter, ParameterWithData, PlotWithData, PointerLocation, TimeSeriesLocation, UseGetLocationReturnTypeProperties } from './types';
+export declare const createGeoJsonArrays: (locations: (FeatureCollection<GeometryObject, UseGetLocationReturnTypeProperties> | undefined)[], services: TimeSeriesService[] | undefined, hideFeatures: boolean, memoizedSelectedFeature: TimeSeriesLocation | null) => {
+    combinedGeoJson: FeatureCollection<GeometryObject, syncGroupsTypes.PotentialDataProperties>;
 };
-export declare const getEdrParameter: (presetParameter: Parameter, serviceUrl: string, location: PointerLocation, collection: TimeseriesCollectionDetail) => Promise<ParameterWithData | null>;
-export declare const fetchParameter: (parameter: PlotParameter, selectedLocation: PointerLocation, service: TimeSeriesService, geojsonMap: Map<string, GeoJsonWithService>, collection?: TimeseriesCollectionDetail) => Promise<ParameterWithData | null>;
+export declare const getNearbyLocation: (parameter: Parameter, service: TimeSeriesService, selectedLocation: PointerLocation, geojsonMap: Map<string, GeoJsonWithService>) => TimeSeriesLocation | null;
 export declare const getPlotsWithParameters: (plots: Plot[], parameters: ParameterWithData[]) => PlotWithData[];
-export declare function consolidateFeatures(features: {
+export declare function consolidateFeatures<P>(features: {
     id: string;
-    geoJSON: FeatureCollection<GeometryObject>;
-}[]): FeatureCollection<GeometryObject>;
+    geoJSON: FeatureCollection<GeometryObject, P>;
+}[]): FeatureCollection<GeometryObject, P>;
 export declare const combineParametersWithData: (parameters: Parameter[], data: ParameterWithData[]) => ParameterWithData[];
+export interface ParameterCollectionQueryData {
+    serviceId: string;
+    service: TimeSeriesService;
+    collectionId: string;
+}
+export declare const extractUsedCollections: (plotsWithoutData: PlotPreset, services: TimeSeriesService[]) => Record<string, ParameterCollectionQueryData>;
+export declare const extractDataFromfetchEdrParameterResponse: (edrResponse: EDRPositionResponse | EDRPositionResponseCoverageCollection | null, parameter: PlotParameter) => ParameterWithData | null;

package/src/lib/components/TimeSeriesManager/ParameterInfo/ParameterInfoDialog.d.ts

@@ -2,16 +2,15 @@ import React from 'react';
 import { TimeSeriesService } from '@opengeoweb/shared';
 import { uiTypes } from '@opengeoweb/store';
 import { EDRInstance, Parameter } from '../../TimeSeries/types';
-export type InstanceInformation = {
-    isLoading: true;
-} | {
-    isLoading: false;
-    instances: EDRInstance[];
-};
+import { TimeseriesCollectionDetail } from '../../TimeSeriesSelect/utils';
 export interface ParameterInfoDialogProps {
     currentParameterInfo: Parameter;
     relatedService: TimeSeriesService | undefined;
-    instanceInformation: InstanceInformation;
+    collectionInformation: TimeseriesCollectionDetail | undefined;
+    isLoadingCollectionInformation: boolean;
+    instanceInformation: EDRInstance[] | undefined;
+    isLoadingInstanceInformation: boolean;
+    supportsInstances: boolean;
     onClose: () => void;
     isOpen: boolean;
     onMouseDown?: () => void;
@@ -21,7 +20,12 @@ export interface ParameterInfoDialogProps {
 }
 export declare const ParameterInfoDialog: React.FC<ParameterInfoDialogProps>;
 export declare const QueryInfoElement: React.FC<{
-    instanceInformation: InstanceInformation;
+    queryInformation: TimeseriesCollectionDetail | undefined;
+    isLoadingCollectionInformation: boolean;
+}>;
+export declare const DimensionInfoElement: React.FC<{
+    instanceInformation: EDRInstance[] | undefined;
+    isLoading: boolean;
 }>;
 export interface ParameterInfoTextProps {
     label: string;

package/src/lib/components/TimeSeriesSelect/TimeSeriesSelectList.d.ts

@@ -1,7 +1,7 @@
-import { FC } from 'react';
-import { Parameter, Plot } from '../TimeSeries/types';
-import { TimeseriesCollectionDetail } from './utils';
-import { ServiceFilterChipsObjectEntities } from '../../store/types';
+import type { FC } from 'react';
+import type { TimeseriesCollectionDetail } from './utils';
+import type { ServiceFilterChipsObjectEntities } from '../../store/types';
+import type { Parameter, Plot } from '../TimeSeries/types';
 export declare const NO_RESULTS_FOUND_MESSAGE = "No parameters found";
 export declare const DEFAULT_DIALOG_HEIGHT = 500;
 interface TimeSeriesSelectListProps {

package/src/lib/components/TimeSeriesSelect/TimeSeriesSelectListConnect.d.ts

@@ -5,6 +5,7 @@ interface TimeSeriesSelectListConnectProps {
     selectPlot: Plot;
     handleAddOrRemoveClick: (parameter: Parameter, plotHasParameter: boolean) => void;
     services: TimeSeriesService[];
+    isOpen: boolean;
 }
 export declare const TimeSeriesSelectListConnect: FC<TimeSeriesSelectListConnectProps>;
 export {};

package/src/lib/components/TimeSeriesSelect/utils.d.ts

@@ -1,13 +1,14 @@
 import { EDRInstance } from '@opengeoweb/shared';
 import { ServiceFilterChipsObjectEntities } from '../../store/types';
-import { CustomDimension, EDRCollection, SelectParameter } from '../TimeSeries/types';
+import { CustomDimension, EDRDataQueriesObject, EDRExtentObject, SelectParameter } from '../TimeSeries/types';
 export interface TimeseriesCollectionDetail {
     collectionId: string;
-    collectionDetails: EDRCollection;
     serviceId: string;
-    parameters: SelectParameter[];
     serviceName: string;
+    parameters: SelectParameter[];
+    dataQueries?: EDRDataQueriesObject;
     customDimensions?: CustomDimension[];
     allInstances?: EDRInstance[];
+    extent?: EDRExtentObject;
 }
 export declare const filterCollectionsParametersFromService: (collectionList: TimeseriesCollectionDetail[], searchString: string, serviceFilterChips: ServiceFilterChipsObjectEntities, allFilterChipsEnabled: boolean) => TimeseriesCollectionDetail[];

package/src/lib/utils/edrUtils.d.ts

@@ -1,26 +1,22 @@
-import { TimeSeriesService } from '@opengeoweb/shared';
+import { PlotParameter, TimeSeriesService } from '@opengeoweb/shared';
 import { Feature, Geometry, GeometryObject, Position } from 'geojson';
 import { MapFeatureClass } from '@opengeoweb/webmap-react';
 import { type EDRCollection, type EDRInstance, type EDRParameter, type Parameter, type PointerLocation, type SelectParameter } from '../components/TimeSeries/types';
 import { TimeseriesCollectionDetail } from '../components/TimeSeriesSelect/utils';
 export declare const createUrl: (baseUrl: string, pathToAdd?: string, queryParameters?: [string, string][]) => string;
 export declare const supportedOutputFormat = "CoverageJSON";
-export declare const getBaseQueryParamArray: (parameter: Parameter, instance: EDRInstance, collection: TimeseriesCollectionDetail, clipInterval?: [number, number]) => [string, string][];
+export declare const getBaseQueryParamArray: (parameter: Parameter, instance: EDRInstance, collection: TimeseriesCollectionDetail, intervalParam: string) => [string, string][];
 export declare const latestInstance: (instances: EDRInstance[]) => EDRInstance | null;
 export declare const isSupportedInstance: (instances: EDRInstance) => boolean;
 export declare const listSupportedInstances: (instances: EDRInstance[]) => EDRInstance[];
 export declare const getUnit: (param: EDRParameter, lang: string, fallbackLang: string) => string;
 export declare const constructParameterObject: (serviceId: string, collectionId: string, parametersById: EdrParameters) => SelectParameter[];
-export interface InstancesForCollection {
-    latestInstance: EDRInstance;
-    allInstances: EDRInstance[];
-    collectionId: string;
-    serviceId: string;
-}
-export declare const getParametersFromCollections: (service: TimeSeriesService, collections?: EDRCollection[], instances?: InstancesForCollection[]) => TimeseriesCollectionDetail[];
+export declare const getCollectionDetails: (service: TimeSeriesService, collection: EDRCollection, instances?: EDRInstance[]) => TimeseriesCollectionDetail;
+export declare const getServiceCollectionDetails: (service: TimeSeriesService, collections?: EDRCollection[]) => TimeseriesCollectionDetail[];
 interface EdrParameter {
     id: string;
     description: string;
+    label?: string;
     type: string;
     collectionId: string;
     observedProperty: {
@@ -48,6 +44,7 @@ export declare const getDetailsForCollectionId: (collections: TimeseriesCollecti
  * @returns Clipped EDR interval, e.g. ["startdate_as_isostring","enddate_as_isostring"]
  */
 export declare const clipEdrInterval: (interval: string[] | undefined, maxHoursBefore?: number, maxHoursAfter?: number, date?: number) => [string, string];
+export declare const constructTimeInterval: (collection: TimeseriesCollectionDetail | undefined, instance: EDRInstance, parameter: PlotParameter) => string;
 /**
  * Find nearest point to the target location in timeseries.
  * Uses equirectangular distance approximation which is not accurate for long

package/src/lib/utils/timeseries-api/api.d.ts

@@ -1,6 +1,6 @@
 import { GeometryObject } from 'geojson';
-import { TimeSeriesService } from '@opengeoweb/shared';
-import { EDRCollection, EDRInstance, EDRPositionResponse, EDRPositionResponseCoverageCollection, Parameter, PointerLocation } from '../../components/TimeSeries/types';
+import { PlotParameter, TimeSeriesService } from '@opengeoweb/shared';
+import { EDRCollection, EDRInstance, EDRPositionResponse, EDRPositionResponseCoverageCollection, GeoJsonWithService, PointerLocation } from '../../components/TimeSeries/types';
 import { TimeseriesCollectionDetail } from '../../components/TimeSeriesSelect/utils';
 export interface LocationsResult {
     features: {
@@ -33,7 +33,9 @@ export declare const getCollections: (serviceUrl: string) => Promise<{
     links: LinkObject[];
     collections: EDRCollection[];
 }>;
-export declare const getSupportedInstances: (serviceUrl?: string, collectionId?: string, useCollectionFallback?: boolean) => Promise<EDRInstance[]>;
-export declare const fetchParametersForService: (service: TimeSeriesService) => Promise<TimeseriesCollectionDetail[]>;
-export declare const fetchEdrParameter: (serviceUrl: string, parameter: Parameter, location: PointerLocation, instance: EDRInstance, collection: TimeseriesCollectionDetail) => Promise<EDRPositionResponse | EDRPositionResponseCoverageCollection | null>;
+export declare const getCollection: (serviceUrl: string, collectionId: string) => Promise<EDRCollection>;
+export declare const getInstances: (serviceUrl: string, collectionId: string) => Promise<{
+    instances: EDRInstance[];
+}>;
+export declare const fetchEdrParameter: (parameter: PlotParameter, location: PointerLocation, service: TimeSeriesService, geojsonMap: Map<string, GeoJsonWithService>, intervalParam: string, collection: TimeseriesCollectionDetail, instance: EDRInstance) => Promise<EDRPositionResponse | EDRPositionResponseCoverageCollection | null>;
 export {};

package/src/lib/utils/timeseries-api/hooks.d.ts

@@ -1,15 +1,55 @@
 import { PlotPreset, TimeSeriesService } from '@opengeoweb/shared';
 import { UseQueryResult } from '@tanstack/react-query';
-import { FeatureCollection, GeoJsonProperties, Geometry } from 'geojson';
+import { FeatureCollection, Geometry } from 'geojson';
 import { EDRServiceInformation } from './api';
 import { TimeseriesCollectionDetail } from '../../components/TimeSeriesSelect/utils';
-import { EDRCollection, EDRInstance, GeoJsonWithService, PlotWithData, PointerLocation } from '../../components/TimeSeries/types';
+import { EDRCollection, EDRInstance, GeoJsonWithService, PlotWithData, PointerLocation, UseGetLocationReturnTypeProperties } from '../../components/TimeSeries/types';
+import { ParameterCollectionQueryData } from '../../components/TimeSeries/utils';
 interface CombinedResult<T> {
     data: T | undefined;
     isFetching: boolean;
     error: Error | null | undefined;
 }
-export declare const useGetCollectionDetails: (services: TimeSeriesService[]) => CombinedResult<TimeseriesCollectionDetail[]>;
+export declare const timeseriesEDRQueryOptions: {
+    readonly getServiceInformationQuery: (serviceUrl: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<EDRServiceInformation, Error, EDRServiceInformation, string[]>, "queryFn"> & {
+        queryFn?: import("@tanstack/react-query").QueryFunction<EDRServiceInformation, string[], never> | undefined;
+    } & {
+        queryKey: string[] & {
+            [dataTagSymbol]: EDRServiceInformation;
+            [dataTagErrorSymbol]: Error;
+        };
+    };
+    readonly getCollectionsQuery: (serviceUrl: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<EDRCollection[], Error, EDRCollection[], string[]>, "queryFn"> & {
+        queryFn?: import("@tanstack/react-query").QueryFunction<EDRCollection[], string[], never> | undefined;
+    } & {
+        queryKey: string[] & {
+            [dataTagSymbol]: EDRCollection[];
+            [dataTagErrorSymbol]: Error;
+        };
+    };
+    readonly getCollectionDetailsQuery: (service: TimeSeriesService, collectionId: string) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<TimeseriesCollectionDetail, Error, TimeseriesCollectionDetail, string[]>, "queryFn"> & {
+        queryFn?: import("@tanstack/react-query").QueryFunction<TimeseriesCollectionDetail, string[], never> | undefined;
+    } & {
+        queryKey: string[] & {
+            [dataTagSymbol]: TimeseriesCollectionDetail;
+            [dataTagErrorSymbol]: Error;
+        };
+    };
+    readonly getInstancesQuery: (serviceUrl: string, collectionId: string, supportsInstances?: boolean) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<EDRInstance[], Error, EDRInstance[], string[]>, "queryFn"> & {
+        queryFn?: import("@tanstack/react-query").QueryFunction<EDRInstance[], string[], never> | undefined;
+    } & {
+        queryKey: string[] & {
+            [dataTagSymbol]: EDRInstance[];
+            [dataTagErrorSymbol]: Error;
+        };
+    };
+};
+export declare const useGetServiceInformation: (serviceUrl: string) => UseQueryResult<EDRServiceInformation>;
+export declare const useGetCollections: (serviceUrl: string) => UseQueryResult<EDRCollection[]>;
+export declare const useGetDetailsForCollection: (service: TimeSeriesService, collectionId: string) => UseQueryResult<TimeseriesCollectionDetail>;
+export declare const useGetInstances: (serviceUrl: string, collectionId: string, supportsInstances?: boolean) => UseQueryResult<EDRInstance[]>;
+export declare const useGetServiceCollectionDetails: (services: TimeSeriesService[], isOpen: boolean) => CombinedResult<TimeseriesCollectionDetail[]>;
+export declare const useGetCollectionsAndInstanceDetails: (queryData: Record<string, ParameterCollectionQueryData>) => CombinedResult<TimeseriesCollectionDetail[]>;
 export declare const useGetPlotsWithData: (plotsWithoutData: PlotPreset, selectedLocation: PointerLocation, services: TimeSeriesService[], splitGeoJsonByCollection: GeoJsonWithService[]) => {
     data: PlotWithData[] | undefined;
     isFetching: boolean;
@@ -20,11 +60,8 @@ export interface GetLocationsOption {
     collectionId: string;
 }
 export declare const useGetLocations: (options: GetLocationsOption[]) => {
-    data: (FeatureCollection<Geometry, GeoJsonProperties> | undefined)[];
+    data: (FeatureCollection<Geometry, UseGetLocationReturnTypeProperties> | undefined)[];
     isFetching: boolean;
     error: Error | null | undefined;
 };
-export declare const useGetServiceInformation: (serviceUrl: string) => UseQueryResult<EDRServiceInformation>;
-export declare const useGetCollections: (serviceUrl: string) => UseQueryResult<EDRCollection[]>;
-export declare const useGetInstances: (serviceUrl?: string, collectionId?: string) => UseQueryResult<EDRInstance[]>;
 export {};