@opengeoweb/time-series 13.0.0

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

@@ -0,0 +1,64 @@
+import { 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, clipInterval?: [number, number]) => [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[];
+interface EdrParameter {
+    id: string;
+    description: string;
+    type: string;
+    collectionId: string;
+    observedProperty: {
+        label: string;
+    };
+    unit?: {
+        label: string;
+        symbol: {
+            type: string;
+            value: string;
+        };
+    };
+}
+export type EdrParameters = Record<string, EdrParameter>;
+export declare const getFeatureClass: (geometryType: Geometry["type"]) => MapFeatureClass;
+export declare const getServiceById: (services: TimeSeriesService[] | undefined, serviceId: string | undefined) => TimeSeriesService | undefined;
+export declare const getDetailsForCollectionId: (collections: TimeseriesCollectionDetail[], collectionId: string) => TimeseriesCollectionDetail | undefined;
+/**
+ * This function clips the dates in the EDR interval string to a less wide  time range.
+ *
+ * @param interval EDR interval, e.g. ["startdate_as_isostring","enddate_as_isostring"]
+ * @param maxHoursBefore Clips to maximum hours before the given date
+ * @param maxHoursAfter Clip to maximum hours after the given date
+ * @param date The date to use to clip arround, defaults to Date.now()
+ * @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];
+/**
+ * Find nearest point to the target location in timeseries.
+ * Uses equirectangular distance approximation which is not accurate for long
+ * distances, but works for finding nearby locations in timeseries.
+ *
+ * @param targetLocation target location the user has clicked
+ * @param pointFeatures features to search through
+ * @param maxDistanceKm maximum distance to consider
+ * @returns feature nearest to the target location or null if none are within the maximum distance
+ */
+export declare const findNearestPoint: (targetLocation: PointerLocation, pointFeatures: Feature<GeometryObject>[], maxDistanceKm?: number) => Feature<GeometryObject> | null;
+export declare const getFeatureCenterPoint: (feature: Feature<GeometryObject>) => Position;
+export declare const getLocationPositionPath: (collectionId: string, instanceId: string) => string;
+export {};

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

@@ -0,0 +1,2 @@
+import { EDRParameters } from '../components/TimeSeries/types';
+export declare const edrParameterUnitTestValues: EDRParameters;

package/src/lib/utils/fakeData/mockDimensions.d.ts

@@ -0,0 +1,2 @@
+import { CustomDimension } from '../../components/TimeSeries/types';
+export declare const mockDimensions: CustomDimension[];

package/src/lib/utils/fakeData/mockGeoJSON.d.ts

@@ -0,0 +1,2 @@
+import { FeatureCollection, Point } from 'geojson';
+export declare const mockGeoJSON: FeatureCollection<Point>;

package/src/lib/utils/fakeData/mockTimeSeriesServices.d.ts

@@ -0,0 +1,2 @@
+import { TimeSeriesService } from '@opengeoweb/shared';
+export declare const mockTimeSeriesServices: TimeSeriesService[];

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

@@ -0,0 +1,6 @@
+import i18n from 'i18next';
+import { UseTranslationResponse } from 'react-i18next';
+export declare const TIME_SERIES_NAMESPACE = "timeseries";
+export declare const initTimeseriesI18n: () => void;
+export declare const translateKeyOutsideComponents: (key: string, params?: Record<string, string | number> | undefined) => string;
+export declare const useTimeseriesTranslation: () => UseTranslationResponse<typeof TIME_SERIES_NAMESPACE, typeof i18n>;

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

@@ -0,0 +1,3 @@
+import { TimeSeriesService } from '@opengeoweb/shared';
+export declare const getUserAddedEDRServices: () => TimeSeriesService[];
+export declare const setUserAddedEDRServices: (services: TimeSeriesService[]) => void;

package/src/lib/utils/localStorage.spec.d.ts

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

package/src/lib/utils/mocks/handlers.d.ts

@@ -0,0 +1,187 @@
+import { EDRCollection, EDRInstance, EDRPositionResponse, Parameter } from '../../components/TimeSeries/types';
+export declare const EDR_FINLAND_NAME = "EDR Finland";
+export declare const EDR_FINLAND_DESCRIPTION = "EDR Finland Description";
+export declare const EDR_FINLAND_URL = "https://opendata.fmi.fi/edr";
+export declare const EDR_FINLAND_ECMWF_COLLECTION_ID = "ecmwf";
+export declare const EDR_NORWAY_URL = "https://interpol.met.no";
+export declare const EDR_NORWAY_COLLECTION_ID = "meps-det-vdiv";
+export declare const EDR_KNMIGEOSERVICES_URL = "https://geoservices.knmi.nl/edr";
+export declare const EDR_KNMIGEOSERVICES_COLLECTION_ID = "uwcw_ha43_dini_5p5km_hagl";
+export declare const EDR_COLLECTIONS_TEST_URL = "https://collection-test.opengeoweb.com/edr";
+export declare const EDR_COLLECTION_NO_INSTANCES_ID = "without_instances";
+export declare const EDR_COLLECTION_INSTANCES_LOCATIONS = "instances_locations";
+export declare const EDR_COLLECTION_INSTANCES_POSITION = "instances_position";
+export declare const EDR_COLLECTION_INSTANCES_LOCATIONS_AND_POSITION = "instances_locations_and_position";
+export declare const latestInstanceIdMock = "20230927T120000";
+export declare const latestInstanceMock: EDRInstance;
+export declare const oldInstanceMock: EDRInstance;
+export declare const helsinkiLat = 60.192059;
+export declare const helsinkiLon = 24.945831;
+export declare const helsinki = "Helsinki";
+export declare const parameterNameMock = "Temperature";
+export declare const parameterUnitMock = "\u02DAC";
+export declare const parameterMock: Parameter;
+export declare const timestepMock: string[];
+export declare const valueMock: number[];
+export declare const valueMock2: number[];
+export declare const edrParameterTestDataQueries: {
+    position: {
+        link: {
+            variables: {
+                output_formats: string[];
+            };
+        };
+    };
+    locations: {
+        link: {
+            variables: {
+                output_formats: string[];
+            };
+        };
+    };
+};
+export declare const finlandEcmwfInstances: {
+    instances: ({
+        id: string;
+        data_queries: {
+            position: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+            locations: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+        };
+        parameter_names: {
+            id1: {
+                id: string;
+            };
+            id2?: undefined;
+        };
+    } | {
+        id: string;
+        data_queries: {
+            position: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+            locations: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+        };
+        parameter_names: {
+            id2: {
+                id: string;
+            };
+            id1?: undefined;
+        };
+    })[];
+};
+export declare const knmiUwcwHa43DInifInstances: {
+    instances: ({
+        id: string;
+        data_queries: {
+            position: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+            locations: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+        };
+        parameter_names: {
+            id1: {
+                id: string;
+            };
+            id2?: undefined;
+        };
+    } | {
+        id: string;
+        data_queries: {
+            position: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+            locations: {
+                link: {
+                    variables: {
+                        output_formats: string[];
+                    };
+                };
+            };
+        };
+        parameter_names: {
+            id2: {
+                id: string;
+            };
+            id1?: undefined;
+        };
+    })[];
+};
+export declare const edrPositionResponseMock: EDRPositionResponse;
+export declare const edrLocationResponseMock: EDRPositionResponse;
+export declare const mockLocations: {
+    features: {
+        id: string;
+        geometry: {
+            type: string;
+            coordinates: number[];
+        };
+        properties: {
+            name: string;
+        };
+    }[];
+};
+export declare const collectionsMockNorway: EDRCollection;
+export declare const collectionsMockFinland: EDRCollection;
+export declare const edrEndpoints: import("msw").HttpHandler[];
+export declare const edrTestCollectionNoInstancesMock: {};
+export declare const edrTestCollectionNoInstancesLocationsMock: {
+    type: string;
+    features: ({
+        type: string;
+        geometry: {
+            type: string;
+            coordinates: number[];
+        };
+        properties: {
+            name: string;
+        };
+        id: string;
+    } | {
+        id: string;
+        type: string;
+        properties: {
+            name: string;
+        };
+        geometry: {
+            type: string;
+            coordinates: number[][][];
+        };
+    })[];
+};
+export declare const unsupportedEndpoints: import("msw").HttpHandler[];

package/src/lib/utils/mocks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './handlers';
+export * from './server';

package/src/lib/utils/mocks/server.d.ts

@@ -0,0 +1 @@
+export declare const serverMock: import("msw/node").SetupServerApi;

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

@@ -0,0 +1,39 @@
+import { GeometryObject } from 'geojson';
+import { TimeSeriesService } from '@opengeoweb/shared';
+import { EDRCollection, EDRInstance, EDRPositionResponse, Parameter, PointerLocation } from '../../components/TimeSeries/types';
+import { TimeseriesCollectionDetail } from '../../components/TimeSeriesSelect/utils';
+export interface LocationsResult {
+    features: {
+        id: string;
+        type: 'Feature';
+        geometry: GeometryObject;
+        properties: {
+            datetime: string;
+            detail?: string;
+            name?: string;
+            NAME?: string;
+            Name?: string;
+            'parameter-name'?: string[];
+        };
+    }[];
+}
+export declare const getLocations: (serviceUrl: string, collectionId: string) => Promise<LocationsResult>;
+export interface EDRServiceInformation {
+    title?: string;
+    description?: string;
+}
+export declare const getServiceInformation: (serviceUrl: string) => Promise<EDRServiceInformation>;
+interface LinkObject {
+    title: string;
+    href: string;
+    rel: string;
+    type: string;
+}
+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) => Promise<EDRPositionResponse | null>;
+export {};

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

@@ -0,0 +1 @@
+export declare const timeseriesEndpoints: import("msw").HttpHandler[];

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

@@ -0,0 +1,30 @@
+import { PlotPreset, TimeSeriesService } from '@opengeoweb/shared';
+import { UseQueryResult } from '@tanstack/react-query';
+import { FeatureCollection, GeoJsonProperties, Geometry } from 'geojson';
+import { EDRServiceInformation } from './api';
+import { TimeseriesCollectionDetail } from '../../components/TimeSeriesSelect/utils';
+import { EDRCollection, EDRInstance, GeoJsonWithService, PlotWithData, PointerLocation } from '../../components/TimeSeries/types';
+interface CombinedResult<T> {
+    data: T | undefined;
+    isFetching: boolean;
+    error: Error | null | undefined;
+}
+export declare const useGetCollectionDetails: (services: TimeSeriesService[]) => CombinedResult<TimeseriesCollectionDetail[]>;
+export declare const useGetPlotsWithData: (plotsWithoutData: PlotPreset, selectedLocation: PointerLocation, services: TimeSeriesService[], splitGeoJsonByCollection: GeoJsonWithService[]) => {
+    data: PlotWithData[] | undefined;
+    isFetching: boolean;
+    error: Error | null | undefined;
+};
+export interface GetLocationsOption {
+    service: TimeSeriesService;
+    collectionId: string;
+}
+export declare const useGetLocations: (options: GetLocationsOption[]) => {
+    data: (FeatureCollection<Geometry, GeoJsonProperties> | 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 {};

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

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