@opengeoweb/space-weather 13.0.0

package/src/lib/components/Notifications/NotificationRow.stories.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+import { Meta, StoryObj } from '@storybook/react/*';
+import NotificationRow from './NotificationRow';
+declare const meta: Meta<typeof NotificationRow>;
+export default meta;
+type Story = StoryObj<typeof NotificationRow>;
+export declare const Component: Story;
+export declare const NotificationRowDummyDemo: () => React.ReactElement;

package/src/lib/components/Notifications/NotificationTabs.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+import { SWEvent } from '../../types';
+interface NotificationTabsProps {
+    activeTab: string;
+    newNotifications: SWEvent[];
+    onChange: (value: string) => void;
+}
+declare const NotificationTabs: React.FC<NotificationTabsProps>;
+export default NotificationTabs;

package/src/lib/components/Notifications/NotificationTabs.spec.d.ts

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

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

@@ -0,0 +1,10 @@
+import * as React from 'react';
+/**
+ * Notifications
+ * View incoming notifications and issue new notifications following the notification lifecycle
+ *
+ * @example
+ * ``` <Notifications /> ```
+ */
+declare const Notifications: React.FC;
+export default Notifications;

package/src/lib/components/Notifications/Notifications.spec.d.ts

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

package/src/lib/components/Notifications/Notifications.stories.d.ts

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { Meta, StoryObj } from '@storybook/react/*';
+import Notifications from './Notifications';
+declare const meta: Meta<typeof Notifications>;
+export default meta;
+export declare const NotificationsDemoDummyActions: () => React.ReactElement;
+type Story = StoryObj<typeof NotificationsListSnapshot>;
+interface ThemeProps {
+    width?: string;
+}
+declare const NotificationsListSnapshot: ({ width, }: ThemeProps) => React.ReactElement;
+export declare const NotificationsListSnapshotLight: Story;
+export declare const NotificationsListSnapshotDark: Story;
+export declare const NotificationsListSmallSnapshotLight: Story;
+export declare const NotificationsListSmallSnapshotDark: Story;

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

@@ -0,0 +1,3 @@
+export { default as Notifications } from './Notifications';
+export { default as NotificationList } from './NotificationList';
+export { default as NotificationRow } from './NotificationRow';

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

@@ -0,0 +1,2 @@
+export declare const getStatusTagContent: (label: string, categoryDetail?: string, action?: string) => string;
+export declare const getStatusTagColorFromContent: (type: string) => string;

package/src/lib/components/Notifications/utils.spec.d.ts

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

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

@@ -0,0 +1,4 @@
+import React from 'react';
+import { ThemeProviderProps } from '@opengeoweb/theme';
+export declare const SpaceWeatherThemeWrapper: React.FC<ThemeProviderProps>;
+export declare const SpaceWeatherStoreWrapper: React.FC<ThemeProviderProps>;

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

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

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

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { Parameters } from '../../types';
+interface GraphErrorsProps {
+    data: {
+        parameters: (Parameters | undefined)[];
+        error: string;
+    }[];
+    graphHeight: number;
+    chartHeight: number;
+}
+export declare const GraphErrors: React.FC<GraphErrorsProps>;
+export {};

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

@@ -0,0 +1,12 @@
+import * as React from 'react';
+import { GraphItem } from './types';
+interface GraphsProps {
+    data: GraphItem[];
+    beginTime: Date;
+    endTime: Date;
+    graphHeight: number;
+    chartHeight: number;
+    onUserAction: () => void;
+}
+export declare const Graphs: React.FC<GraphsProps>;
+export {};

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

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

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

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { Meta, StoryObj } from '@storybook/react/*';
+import { Graphs } from './Graphs';
+declare const meta: Meta<typeof Graphs>;
+export default meta;
+type Story = StoryObj<typeof Graphs>;
+export declare const Component: Story;
+export declare const GraphsDummyData: () => React.ReactElement;
+export declare const GraphsLightTheme: Story;
+export declare const GraphsDarkTheme: Story;

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

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

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

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

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

@@ -0,0 +1,9 @@
+import { Meta, StoryObj } from '@storybook/react/*';
+import TimeSeries from './TimeSeries';
+declare const meta: Meta<typeof TimeSeries>;
+export default meta;
+type Story = StoryObj<typeof TimeSeries>;
+export declare const TimeSeriesDummyData: Story;
+export declare const TimeSeriesWithAllErrors: Story;
+export declare const TimeSeriesWithTwoErrors: Story;
+export declare const TimeSeriesLoading: Story;

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

@@ -0,0 +1,4 @@
+import { StreamResponse } from '../../types';
+export declare const createStreamDict: (streams: StreamResponse[]) => Record<string, StreamResponse>;
+export declare const useUserSleeping: (delay?: number) => [boolean, () => void];
+export declare const getGraphHeightInPx: () => number;

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

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

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

@@ -0,0 +1,3 @@
+import * as React from 'react';
+export declare const TimeSeriesHeader: React.FC<Record<string, unknown>>;
+export default TimeSeriesHeader;

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

@@ -0,0 +1,4 @@
+import { ChartResponseType, IncomingData, Dataset } from './types';
+export declare const createDataset: (data: IncomingData["data"]) => Dataset;
+export declare const createSeries: (response: ChartResponseType[]) => Dataset[];
+export declare const mirrorSeries: (dataset: Dataset) => Dataset;

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

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

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

@@ -0,0 +1 @@
+export { default as TimeSeries } from './TimeSeries';

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

@@ -0,0 +1,14 @@
+export declare const curveColors: {
+    kpIndex: string;
+    kpIndexForecast: string;
+    magneticFieldBt: string;
+    magneticFieldBz: string;
+    lineSolarXray: string;
+    lineSolarWindDensity: string;
+    lineSolarWindSpeed: string;
+    areaSolarWindSpeed: string;
+    lineSolarWindPressure: string;
+    areaSolarWindPressure: string;
+    markLines: string;
+    currentTime: string;
+};

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

@@ -0,0 +1,34 @@
+import { TimeseriesParams } from '../../types';
+export type Dataset = (string | number | undefined)[][];
+export type IncomingData = ChartResponseType['data'];
+type GraphType = 'BAR' | 'BAND' | 'LOG' | 'AREA';
+export interface GraphItem {
+    id: string;
+    params: TimeseriesParams[];
+    graphType: GraphType;
+    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: Dataset[];
+}
+export interface ChartResponseType {
+    data: {
+        data: {
+            source?: string;
+            timestamp?: string;
+            value?: number;
+        }[];
+        parameter?: string;
+        stream?: string;
+        unit?: string;
+    };
+}
+export {};

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

@@ -0,0 +1,22 @@
+import { GridComponentOption, XAXisComponentOption, SeriesOption, YAXisComponentOption, DefaultLabelFormatterCallbackParams, TooltipComponentOption } from 'echarts';
+import { GraphItem } from './types';
+export declare const dateFormat = "MM-dd HH:mm";
+export declare const TITLE_KP_FORECAST = "Kp Index Forecast";
+export declare const TITLE_XRAY = "X-ray Solar Flux (W/m\u00B2)";
+export declare const TTTLE_SOLAR_WIND_DENSITY = "Solar Wind Density (1/cm\u00B3)";
+export declare const TITLE_SOLAR_WIND_SPEED = "Solar Wind Speed (km/s)";
+export declare const TITLE_SOLAR_WIND_PRESSURE = "Solar Wind Pressure (nPa)";
+export declare const CHART_LEFT_MARGIN = 32;
+export declare const CHART_RIGHT_MARGIN = 52;
+export declare const CHART_TOP_MARGIN = 20;
+export declare const PLOT_TOP_MARGIN = 24;
+export declare const CHART_BOTTOM_MARGIN = 48;
+export declare const DATA_ZOOM_LABEL_WIDTH = 76;
+export declare const config: GraphItem[];
+export declare const getGrid: (data: GraphItem[], graphHeight: number) => GridComponentOption[];
+export declare const getCurrentTimeMarkers: (data: GraphItem[]) => SeriesOption[];
+export declare const getXAxis: (data: GraphItem[], beginTime: Date, endTime: Date) => XAXisComponentOption[];
+export declare const getYAxis: (data: GraphItem[]) => YAXisComponentOption[];
+export declare const getSeries: (data: GraphItem[]) => SeriesOption[];
+export declare const getTooltipValue: (date: string, param: DefaultLabelFormatterCallbackParams) => string;
+export declare const getTooltip: () => TooltipComponentOption;

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

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

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

@@ -0,0 +1,5 @@
+import * as React from 'react';
+import { Meta } from '@storybook/react/*';
+declare const meta: Meta;
+export default meta;
+export declare const SpaceWeatherDemo: () => React.ReactElement;

package/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 {};