@opengeoweb/space-weather 13.0.0

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

@@ -0,0 +1,367 @@
+import { GraphItem } from '../components/TimeSeries/types';
+export declare const solarWindSpeedDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const solarWindSpeedDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const solarWindPressureDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const solarWindPressureDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const solarWindDensityDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const solarWindDensityDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const kpIndexDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const kpIndexDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const kpIndexForecastDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const kpIndexForecastDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const xRayFluxDummyData: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const xRayFluxDummyDataFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const interplanetaryMagneticFieldBt: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const interplanetaryMagneticFieldBz: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const xrayWithSeries: GraphItem;
+export declare const xrayWithSeriesFixedDates: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const windPressureWithSeries: GraphItem;
+export declare const windPressureWithSeriesFixedDates: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const barGraphWithSeries: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const barGraphWithSeriesFixedDates: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const areaGraphWithSeries: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const areaGraphWithSeriesFixedDates: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const logGraphWithSeries: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const windDensityWithSeries: {
+    tickValues: undefined;
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    end?: string;
+};
+export declare const windDensityWithSeriesFixedDates: {
+    tickValues: undefined;
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    end?: string;
+};
+export declare const logGraphWithSeriesFixedDates: {
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+    series: import("../components/TimeSeries/types").Dataset[];
+};
+export declare const bandGraphWithSeries: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};
+export declare const interplanetaryMagneticFieldBtFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const interplanetaryMagneticFieldBzFixedDates: {
+    parameter: string;
+    stream: string;
+    unit: string;
+    data: {
+        timestamp: string;
+        value: number;
+        source: string;
+    }[];
+};
+export declare const bandGraphWithSeriesFixedDates: {
+    series: import("../components/TimeSeries/types").Dataset[];
+    id: string;
+    params: import("../types").TimeseriesParams[];
+    graphType: "LOG" | "BAR" | "BAND" | "AREA";
+    title: string;
+    yMinValue: number;
+    yMaxValue: number;
+    threshold?: {
+        title: string;
+        value: number | string;
+        color?: string;
+    }[];
+    columns: string[] | string[][];
+    tickValues?: (value: number) => number | string;
+    end?: string;
+};

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

@@ -0,0 +1,4 @@
+export declare const getBeginTime: () => Date;
+export declare const getEndTime: () => Date;
+export declare const beginTime: Date;
+export declare const endTime: Date;

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

@@ -0,0 +1,21 @@
+import { Bulletin, SWEvent } from '../types';
+export declare const fakeEventList: SWEvent[];
+export declare const fakeEventListFixedDates: SWEvent[];
+export declare const fakeBulletins: Bulletin[];
+export declare const mockEventUnacknowledgedExternal: SWEvent;
+export declare const mockEventAcknowledgedExternal: SWEvent;
+export declare const mockEvent: SWEvent;
+export declare const mockEventMissingData: SWEvent;
+export declare const mockEventWarning: SWEvent;
+export declare const mockDraftEvent: SWEvent;
+export declare const mockEventInternal: SWEvent;
+export declare const mockBulletin: Bulletin;
+export declare const mockEventAcknowledgedExternalDraft: SWEvent;
+export declare const mockBulletinHistory: {
+    isLoading: boolean;
+    error: null;
+    fetchApiData: () => Promise<void>;
+    result: Bulletin[];
+};
+export declare const mockEventExternalWithEmptyInternalNotifications: SWEvent;
+export declare const mockEventExternalMultipleNotificationsWithoutInternalProvider: SWEvent;

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

@@ -0,0 +1,7 @@
+import i18n from 'i18next';
+import { UseTranslationResponse } from 'react-i18next';
+export declare const SPACE_WEATHER_NAMESPACE = "spaceweather";
+export declare const initSpaceweatherI18n: () => void;
+export declare const translateKeyOutsideComponents: (key: string, params?: Record<string, string | number> | undefined) => string;
+export declare const useSpaceweatherTranslation: () => UseTranslationResponse<typeof SPACE_WEATHER_NAMESPACE, typeof i18n>;
+export { i18n };

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

@@ -0,0 +1,16 @@
+import { Credentials } from '@opengeoweb/authentication';
+import { Bulletin, DiscardDraftNotification, EventCategoryParams, StreamResponse, SWEvent, SWNotification, TimeseriesParams, TimeseriesResponseData } from '../../types';
+export declare const getBulletinHistoryList: (auth: Credentials) => Promise<Bulletin[]>;
+export declare const getBulletin: (auth: Credentials) => Promise<Bulletin>;
+export declare const getEventList: (auth: Credentials, params: EventCategoryParams) => Promise<SWEvent[]>;
+export declare const getEvent: (auth: Credentials, eventid: string) => Promise<SWEvent>;
+export declare const getNewNotifications: (auth: Credentials) => Promise<SWEvent[]>;
+export declare const postNotification: (auth: Credentials, data: SWNotification) => Promise<void>;
+export declare const postDiscardDraftNotification: (auth: Credentials, data: DiscardDraftNotification) => Promise<void>;
+export declare const postSetAcknowledged: (auth: Credentials, eventid: string) => Promise<void>;
+export declare const postPopulateTemplateContent: (auth: Credentials, data: SWNotification) => Promise<{
+    title: string;
+    message: string;
+}>;
+export declare const getStreams: (auth: Credentials) => Promise<StreamResponse[]>;
+export declare const getTimeSeries: (auth: Credentials, data: TimeseriesParams) => Promise<TimeseriesResponseData>;

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

@@ -0,0 +1,8 @@
+import { TimeseriesResponseData } from '../../types';
+export declare const MOCK_USERNAME = "user.name";
+export declare const getDummyTimeSerie: (stream: string, parameter: string) => TimeseriesResponseData;
+export declare const bulletinEndpoints: import("msw").HttpHandler[];
+export declare const notificationEndpoints: import("msw").HttpHandler[];
+export declare const fixedNotificationDateEndpoint: import("msw").HttpHandler[];
+export declare const timeseriesEndpoints: import("msw").HttpHandler[];
+export declare const requestHandlers: import("msw").HttpHandler[];

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

@@ -0,0 +1,38 @@
+import { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
+import { FieldValues, UseFormSetValue } from 'react-hook-form';
+import { Bulletin, DiscardDraftNotification, EventCategoryParams, StreamResponse, SWEvent, SWNotification, TimeseriesParams, TimeseriesResponseData } from '../../types';
+export declare const useBulletin: () => UseQueryResult<Bulletin>;
+export declare const useBulletinHistory: () => UseQueryResult<Bulletin[]>;
+export declare const useEventList: (params: EventCategoryParams) => UseQueryResult<SWEvent[]>;
+export declare const useEvent: (eventid: string) => UseQueryResult<SWEvent>;
+export declare const useNewNotifications: () => UseQueryResult<SWEvent[]>;
+type PostReturnType<T> = UseMutationResult<void, Error, T>;
+interface BasePostNotificationProps {
+    setError: (value: string) => void;
+}
+interface PostNotificationProps extends BasePostNotificationProps {
+    data: SWNotification;
+    toggleDialogOpen: (formSaved?: boolean) => void;
+}
+export declare const usePostNotification: () => PostReturnType<PostNotificationProps>;
+interface PostDiscardDraftNotificationProps extends BasePostNotificationProps {
+    data: DiscardDraftNotification;
+    toggleDialogOpen: (formSaved?: boolean) => void;
+}
+export declare const useDiscardDraftNotification: () => PostReturnType<PostDiscardDraftNotificationProps>;
+interface PostSetAcknowledgedProps {
+    data: string;
+}
+export declare const useSetAcknowledged: () => PostReturnType<PostSetAcknowledgedProps>;
+interface PostPopulateTemplateContentProps extends BasePostNotificationProps {
+    data: SWNotification;
+    setValue: UseFormSetValue<FieldValues>;
+}
+type UsePopulateReturnType<T> = UseMutationResult<{
+    title: string;
+    message: string;
+}, Error, T>;
+export declare const usePopulateTemplateContent: () => UsePopulateReturnType<PostPopulateTemplateContentProps>;
+export declare const useGetStreams: (isDisabled?: boolean) => UseQueryResult<StreamResponse[]>;
+export declare const useGetTimeSeries: (options: TimeseriesParams[]) => UseQueryResult<TimeseriesResponseData>[];
+export {};

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

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