@opengeoweb/space-weather 19.1.0 → 19.2.0

package/dist/src/lib/types.d.ts

@@ -0,0 +1,207 @@
+export type Streams = 'xray' | 'rtsw_mag' | 'rtsw_wind' | 'kp' | 'kpforecast';
+export type Parameters = 'solar_x_ray_flux_long' | 'solar_x_ray_flux_short' | 'proton_density' | 'bx_gsm' | 'by_gsm' | 'bz_gsm' | 'bt' | 'kp' | 'kpforecast' | 'proton_pressure' | 'proton_speed' | 'proton_temperature';
+export type Source = 'GOES-16' | 'GOES-17' | 'ACE' | 'DSCOVR' | 'GFZ';
+export interface Threshold {
+    title: string;
+    value: number;
+    color?: string;
+}
+export interface DataObject {
+    source: string;
+    timestamp: string;
+    value: number;
+}
+export interface TimeseriesResponseData {
+    data: DataObject[];
+    parameter: string;
+    stream: string;
+    unit: string;
+}
+export interface TimeseriesParams {
+    stream?: Streams;
+    parameter?: Parameters;
+    source?: Source;
+    time_start?: string;
+    time_stop?: string;
+}
+export interface StreamResponse {
+    end: string;
+    hasactive: boolean;
+    params: {
+        name: Parameters;
+        unit: string;
+    }[];
+    sources: Source[];
+    start: string;
+    stream: Streams;
+}
+export declare enum SWErrors {
+    USER_CANCELLED = "User Cancelled"
+}
+export declare enum EventCategory {
+    XRAY_RADIO_BLACKOUT = "Radio Blackout",
+    GEOMAGNETIC = "Geomagnetic",
+    PROTON_FLUX = "Proton Flux",
+    ELECTRON_FLUX = "Electron Flux"
+}
+export declare enum EventCategoryDetail {
+    GEOMAGNETIC_STORM = "Geomagnetic Storm",
+    GEOMAGNETIC_SUDDEN_IMPULSE = "Geomagnetic Sudden Impulse",
+    KP_INDEX = "Kp Index",
+    PROTON_FLUX_100 = "Proton Flux 100MeV",
+    PROTON_FLUX_10 = "Proton Flux 10MeV",
+    ELECTRON_FLUX_2 = "Electron Flux 2MeV",
+    ELECTRON_FLUENCE = "Electron Fluence"
+}
+export declare const EventCategoryDetails: {
+    XRAY_RADIO_BLACKOUT: string[];
+    GEOMAGNETIC: string[];
+    PROTON_FLUX: string[];
+    ELECTRON_FLUX: string[];
+};
+interface OriginatorParam {
+    originator: string;
+    category?: never;
+}
+interface CategoryParam {
+    originator?: never;
+    category: string;
+}
+export type EventCategoryParams = OriginatorParam | CategoryParam | Record<string, never>;
+export declare enum NotificationLabel {
+    ALERT = "Alert",
+    WARNING = "Warning"
+}
+export declare const EventLabels: {
+    '': string[];
+    GEOMAGNETIC_STORM: string[];
+    ELECTRON_FLUENCE: string[];
+    ELECTRON_FLUX_2: string[];
+    GEOMAGNETIC_SUDDEN_IMPULSE: string[];
+    KP_INDEX: string[];
+    PROTON_FLUX_100: string[];
+    PROTON_FLUX_10: string[];
+};
+export declare const ThresholdUnits: {
+    XRAY_RADIO_BLACKOUT: string;
+    PROTON_FLUX: string;
+    ELECTRON_FLUX_2: string;
+    ELECTRON_FLUENCE: string;
+};
+export declare const ThresholdValues: {
+    XRAY_RADIO_BLACKOUT: number[];
+    GEOMAGNETIC: number[];
+    PROTON_FLUX: number[];
+};
+export declare const EventLevels: {
+    XRAY_RADIO_BLACKOUT: string[];
+    GEOMAGNETIC: string[];
+    PROTON_FLUX: string[];
+};
+export declare const XrayClasses: string[];
+export type DiscardDraftNotification = {
+    notificationid: string;
+    eventid: string;
+};
+export interface SWNotification {
+    label: string;
+    changestateto: string;
+    category: string;
+    categorydetail: string;
+    neweventlevel?: string;
+    neweventstart: string;
+    neweventend?: string;
+    threshold?: number;
+    thresholdunit?: string;
+    datasource?: string;
+    impulsetime?: string;
+    initialgscale?: string;
+    magnetometerdeflection?: number;
+    observedpolaritybz?: number;
+    observedsolarwind?: number;
+    peakclass?: string;
+    peakflux?: number;
+    peakfluxtime?: string;
+    xrayclass?: string;
+    shocktime?: string;
+    draft?: boolean;
+    message: string;
+    title?: string;
+    notificationid?: string;
+    eventid?: string;
+    issuetime?: string;
+    originator?: string;
+}
+/**
+ * SWEventLifeCycle is to aggregate an SWEvent. Its state is derived inside the backend from 1 or more Notifications.
+ * The notifications property will list both notifications ->  the issue and the summary.
+ */
+export interface SWEventLifeCycle {
+    eventid: string;
+    firstissuetime?: string;
+    lastissuetime?: string;
+    state: string;
+    label: string;
+    owner: string;
+    eventstart: string;
+    eventend?: string;
+    eventlevel?: string;
+    canbe?: string[];
+    draft?: boolean;
+    notifications?: SWNotification[];
+}
+/**
+ * Event is a aggregation of lifecycles which belong together, e.g. a KNMI lifecycle which is based on a MetOffice lifecycle. Lifecycles itself are based on several Notifications.
+ * Event is used in the Notification List to represent a single list item with both incoming (external provider) lifecycle and outgoing (internal provider) lifecycle.
+ */
+export interface SWEvent {
+    eventid: string;
+    category: string;
+    categorydetail: string;
+    originator: string;
+    notacknowledged?: boolean;
+    lifecycles?: {
+        externalprovider?: SWEventLifeCycle;
+        internalprovider?: SWEventLifeCycle;
+    };
+}
+/**
+ * Bulletin types
+ */
+export interface BulletinProbability {
+    day1: number;
+    day2: number;
+    day3: number;
+    day4: number;
+}
+export interface BulletinCategory {
+    previously_exceeded: string;
+    probabilities: BulletinProbability[];
+    simplified_summary: string;
+    status: string;
+    summary: string;
+    timestamp: string;
+    type: string;
+}
+export interface BulletinOverview {
+    content: string;
+    simplified_content: string;
+    timestamp: string;
+    type: string;
+}
+export interface BulletinMessage {
+    categories: BulletinCategory[];
+    overview: BulletinOverview;
+    status: string;
+}
+export interface Bulletin {
+    bulletin_id: string;
+    id: string;
+    time: number;
+    message: BulletinMessage;
+}
+export declare enum BulletinType {
+    technical = "TECHNICAL",
+    plain = "PLAIN"
+}
+export {};

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

@@ -0,0 +1,367 @@
+import type { 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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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: "BAR" | "BAND" | "LOG" | "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/dist/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/dist/src/lib/utils/fakedata.d.ts

@@ -0,0 +1,21 @@
+import type { 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/dist/src/lib/utils/i18n.d.ts

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

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

@@ -0,0 +1,16 @@
+import type { Credentials } from '@opengeoweb/authentication';
+import type { 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/dist/src/lib/utils/spaceweather-api/fakeApi.d.ts

@@ -0,0 +1,8 @@
+import type { 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/dist/src/lib/utils/spaceweather-api/hooks.d.ts

@@ -0,0 +1,38 @@
+import type { UseMutationResult, UseQueryResult } from '@tanstack/react-query';
+import type { FieldValues, UseFormSetValue } from 'react-hook-form';
+import type { 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/dist/src/lib/utils/storybookUtils.d.ts

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