@opengeoweb/cap 9.6.0

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@opengeoweb/cap",
+  "version": "9.6.0",
+  "description": "GeoWeb Common Alerting Protocol (CAP) library for the opengeoweb project",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
+  },
+  "dependencies": {
+    "@redux-eggs/redux-toolkit": "^2.2.0",
+    "@redux-eggs/saga-extension": "^2.2.0",
+    "@opengeoweb/api": "*",
+    "@opengeoweb/core": "*",
+    "frappe-gantt": "^0.6.1",
+    "@mui/material": "5.12.0",
+    "@opengeoweb/shared": "*",
+    "@opengeoweb/store": "*",
+    "react-redux": "^8.1.3",
+    "@opengeoweb/webmap": "*",
+    "@opengeoweb/webmap-react": "*",
+    "date-fns": "^3.3.0",
+    "@mui/system": "^5.15.1",
+    "react-i18next": "^13.5.0",
+    "@reduxjs/toolkit": "^1.9.7",
+    "@opengeoweb/theme": "*",
+    "i18next": "^23.7.11",
+    "@redux-eggs/core": "^2.2.0",
+    "axios": "1.5.0"
+  },
+  "peerDependencies": {
+    "react": "18"
+  },
+  "module": "./index.esm.js",
+  "type": "module",
+  "main": "./index.esm.js"
+}

package/src/index.d.ts

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

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

@@ -0,0 +1,7 @@
+import * as React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const CapDemoFakeApi: React.FC;
+export declare const CapDemoRealApi: React.FC;

package/src/lib/components/CapMapAndList.integration.spec.d.ts

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

package/src/lib/components/ComponentsLookUp/componentsLookUp.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+import { ApiUrls } from '@opengeoweb/api';
+import { InitialMapProps } from '@opengeoweb/core';
+import { CapFeatures } from '../types';
+export type SupportedComponentTypes = 'CapWarningList' | 'CapWarningMap';
+interface InitialProps {
+    mapPreset: {
+        layers?: InitialMapProps['mapPreset']['layers'];
+        proj: {
+            bbox: {
+                left: number;
+                bottom: number;
+                right: number;
+                top: number;
+            };
+            srs: string;
+        };
+    };
+    geoJson: CapFeatures;
+}
+export interface ComponentsLookUpPayload {
+    productConfigKey: string;
+    componentType: SupportedComponentTypes;
+    id: string;
+    initialProps: InitialProps;
+    config: ApiUrls;
+}
+/**
+ * The lookup table is for registering your own components with the workspace.
+ * @param payload
+ * @returns
+ */
+export declare const ComponentsLookUp: ({ componentType, initialProps, productConfigKey, config, id, }: ComponentsLookUpPayload) => React.ReactElement;
+export {};

package/src/lib/components/ComponentsLookUp/componentsLookUp.spec.d.ts

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

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

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

package/src/lib/components/GanttChart/Gantt.d.ts

@@ -0,0 +1,40 @@
+import Gantt from 'frappe-gantt';
+import { Task } from './Task';
+import { ViewMode } from './ViewMode';
+type Options = {
+    view_mode?: ViewMode;
+    header_height?: number;
+    column_width?: number;
+    bar_height?: number;
+    language?: string;
+    step?: number;
+    date_format?: string;
+    bar_corner_radius?: number;
+    arrow_curve?: number;
+    padding?: number;
+    popup_trigger?: string;
+    custom_popup_html?: (task: Task) => string;
+    on_click?: (task: Task) => void;
+    on_view_change?: (mode: ViewMode) => void;
+    on_progress_change?: (task: Task, progress: number) => void;
+    on_date_change?: (task: Task, start: Date, end: Date) => void;
+    view_modes?: string[];
+};
+export default class CustomGantt extends Gantt {
+    private options;
+    private gantt_start;
+    private gantt_end;
+    private tasks;
+    constructor(wrapper: SVGSVGElement, tasks: Task[], options: Options);
+    update_view_scale(view_mode: ViewMode): void;
+    setup_gantt_dates(): void;
+    get_date_info(date: Date, newLastDate: Date, i: number): {
+        upper_text: string;
+        lower_text: string;
+        upper_x: number;
+        upper_y: number;
+        lower_x: number;
+        lower_y: number;
+    };
+}
+export {};

package/src/lib/components/GanttChart/GanttModule.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { CapPresets } from '../types';
+interface GanttModuleProps {
+    capWarningPresets: CapPresets;
+}
+declare const GanttModule: React.FC<GanttModuleProps>;
+export default GanttModule;

package/src/lib/components/GanttChart/GanttModule.spec.d.ts

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

package/src/lib/components/GanttChart/GanttModule.stories.d.ts

@@ -0,0 +1,6 @@
+import * as React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const GanttDemoRealApi: React.FC;

package/src/lib/components/GanttChart/GanttReactWrapper.d.ts

@@ -0,0 +1,37 @@
+import React from 'react';
+import { Task } from './Task';
+import { ViewMode } from './ViewMode';
+export declare const renderDate: (date: Date) => string;
+export declare const renderTime: (date: Date) => string;
+type GanttReactWrapperProps = {
+    tasks: Task[];
+    viewMode?: ViewMode;
+    onTasksChange?: (tasks: Task[]) => void;
+    onClick?: (task: Task) => void;
+    onDateChange?: (task: Task, start: Date, end: Date) => void;
+    onProgressChange?: (task: Task, progress: number) => void;
+    onViewChange?: (mode: ViewMode) => void;
+};
+type FrappeGanttState = {
+    viewMode: ViewMode;
+    tasks: Task[];
+};
+export declare class GanttReactWrapper extends React.Component<GanttReactWrapperProps, FrappeGanttState> {
+    private _target;
+    private _svg;
+    private _gantt;
+    static defaultProps: {
+        viewMode: ViewMode;
+        onTasksChange: () => void;
+        onClick: () => void;
+        onDateChange: () => void;
+        onProgressChange: () => void;
+        onViewChange: () => void;
+    };
+    constructor(props: GanttReactWrapperProps);
+    static getDerivedStateFromProps(nextProps: GanttReactWrapperProps): FrappeGanttState;
+    componentDidMount(): void;
+    componentDidUpdate(): void;
+    render(): React.ReactElement;
+}
+export {};

package/src/lib/components/GanttChart/GanttWrapper.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import { Task } from './Task';
+import { ViewMode } from './ViewMode';
+interface GantWrapperProps {
+    tasks: Task[];
+    defaultViewMode?: ViewMode;
+}
+declare const GantWrapper: React.FC<GantWrapperProps>;
+export default GantWrapper;

package/src/lib/components/GanttChart/GanttWrapper.spec.d.ts

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

package/src/lib/components/GanttChart/GanttWrapper.stories.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const GanttDemo: () => React.ReactElement;
+export declare const GanttDemoDark: () => React.ReactElement;
+export declare const GanttDemoEmptyList: () => React.ReactElement;

package/src/lib/components/GanttChart/Task.d.ts

@@ -0,0 +1,29 @@
+export declare class Task {
+    private _dependencies;
+    id: string;
+    name: string;
+    start: string;
+    end: string;
+    _end: Date;
+    _start: Date;
+    severity: 'Minor' | 'Moderate' | 'Severe' | 'Extreme';
+    title: string;
+    description: string;
+    author: string;
+    area: string;
+    phenomenon: string;
+    constructor(options?: Partial<Task>);
+    /**
+     * Progress in percentage
+     */
+    private _progress;
+    get progress(): number;
+    set progress(value: number);
+    /**
+     * A css custom class for the task chart bar
+     */
+    custom_class?: string;
+    setDependencies(value: string | string[]): void;
+    set dependencies(value: string[] | string);
+    get dependencies(): string[] | string;
+}

package/src/lib/components/GanttChart/ViewMode.d.ts

@@ -0,0 +1,9 @@
+export declare enum ViewMode {
+    Hour = "Hour",
+    QuarterDay = "Quarter Day",
+    HalfDay = "Half Day",
+    Day = "Day",
+    Week = "Week",
+    Month = "Month",
+    Year = "Year"
+}

package/src/lib/components/GanttChart/mockTasks.d.ts

@@ -0,0 +1,2 @@
+import { Task } from './Task';
+export declare const tasks: Task[];

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

@@ -0,0 +1,5 @@
+import { CustomFeature } from '../types';
+import { Task } from './Task';
+export declare const convertSeverityToColorClass: (severity: Task['severity']) => string;
+export declare const getEndDateFromHeadline: (headline: string) => Date;
+export declare const convertFeaturesToTasks: (features: CustomFeature[]) => Task[];

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

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

package/src/lib/components/MapViewCap/MapViewCapConnect.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { InitialMapProps } from '@opengeoweb/core';
+import { CapPresets } from '../types';
+interface MapViewCapConnectProps {
+    id?: string;
+    title?: string;
+    bbox?: {
+        left: number;
+        bottom: number;
+        right: number;
+        top: number;
+    };
+    srs?: string;
+    capWarningPresets?: CapPresets;
+    layers?: InitialMapProps['mapPreset']['layers'];
+}
+export declare const MapViewCapConnect: React.FC<MapViewCapConnectProps>;
+export {};

package/src/lib/components/MapViewCap/MapViewCapConnect.spec.d.ts

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

package/src/lib/components/MapViewCap/MapViewCapConnect.stories.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const MapViewCapConnectDemo: React.FC;

package/src/lib/components/MapViewCap/MapViewCapConnectWrapper.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+import { InitialMapProps } from '@opengeoweb/core';
+interface MapViewCapConnectWrapperProps {
+    id?: string;
+    title?: string;
+    bbox?: {
+        left: number;
+        bottom: number;
+        right: number;
+        top: number;
+    };
+    srs?: string;
+    productConfigKey?: string;
+    layers?: InitialMapProps['mapPreset']['layers'];
+}
+export declare const MapViewCapConnectWrapper: React.FC<MapViewCapConnectWrapperProps>;
+export {};

package/src/lib/components/MapViewCap/MapViewCapConnectWrapper.spec.d.ts

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

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

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

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

@@ -0,0 +1,30 @@
+import React from 'react';
+import { Store } from '@reduxjs/toolkit';
+import { ThemeProviderProps } from '@opengeoweb/theme';
+import { Theme } from '@mui/material';
+export declare const CapThemeWrapper: React.FC<ThemeProviderProps>;
+interface CapApiProviderProps {
+    children: React.ReactNode;
+    createApi?: () => void;
+}
+interface CapThemeStoreProviderProps {
+    children?: React.ReactNode;
+    theme?: Theme;
+    store: Store;
+}
+interface CapTranslationsWrapperProps {
+    children?: React.ReactNode;
+}
+/**
+ * A Provider component which returns the Api Provider for the Cap library
+ * @param children
+ * @returns
+ */
+export declare const CapApiProvider: React.FC<CapApiProviderProps>;
+export interface CapStoreProviderProps extends ThemeProviderProps {
+    store: Store;
+}
+export declare const CapThemeStoreProvider: React.FC<CapThemeStoreProviderProps>;
+export declare const CapTranslationsWrapper: React.FC<CapTranslationsWrapperProps>;
+export declare const CapI18nProvider: React.FC<CapTranslationsWrapperProps>;
+export {};

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

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

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

@@ -0,0 +1,8 @@
+import React from 'react';
+import { CapPresets } from '../types';
+interface WarningListCapProps {
+    capWarningPresets?: CapPresets;
+    alertIds: string[];
+}
+export declare const WarningListCap: React.FC<WarningListCapProps>;
+export {};

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

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

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

@@ -0,0 +1,6 @@
+import React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const WarningListCapDemo: React.FC;

package/src/lib/components/WarningListCap/WarningListCapConnect.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { CapPresets } from '../types';
+interface WarningListCapConnectProps {
+    capWarningPresets: CapPresets;
+}
+export declare const WarningListCapConnect: React.FC<WarningListCapConnectProps>;
+export {};

package/src/lib/components/WarningListCap/WarningListCapConnectWrapper.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface WarningListCapConnectWrapperProps {
+    productConfigKey: string;
+}
+export declare const WarningListCapConnectWrapper: React.FC<WarningListCapConnectWrapperProps>;
+export {};

package/src/lib/components/WarningListCap/WarningListCapConnectWrapper.spec.d.ts

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

package/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCap.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+export interface WarningListRowCapProps {
+    event: string;
+    severity: string;
+    expires: string;
+}
+export declare const WarningListRowCap: React.FC<WarningListRowCapProps>;

package/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCap.spec.d.ts

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

package/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCap.stories.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+declare const _default: {
+    title: string;
+};
+export default _default;
+export declare const WarningListRowCapDemo: React.FC;

package/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCapConnect.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { CapPresets } from '../../types';
+interface WarningListRowCapConnectProps {
+    alertId: string;
+    capWarningPresets: CapPresets;
+}
+export declare const WarningListRowCapConnect: React.FC<WarningListRowCapConnectProps>;
+export {};

package/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCapConnect.spec.d.ts

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

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

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

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

@@ -0,0 +1,47 @@
+export interface CapData {
+    alert: {
+        identifier: string;
+        feedAddress: string;
+        sent: string;
+        status: string;
+        msgType: string;
+        scope: string;
+        code: string[];
+        references: string;
+        info: Info[];
+    };
+}
+interface Info {
+    language: string;
+    category: string;
+    event: string;
+    urgency: string;
+    severity: string;
+    certainty: string;
+    eventCode: {
+        valueName: string;
+        value: string;
+    };
+    onset: string;
+    expires: string;
+    senderName: string;
+    headline: string;
+    description: string;
+    web: string;
+    contact: string;
+    parameter: Parameter[];
+    area: Area | Area[];
+}
+interface Parameter {
+    valueName: string;
+    value: number | string;
+}
+interface Area {
+    areaDesc: string;
+    polygon: string | string[];
+    geocode: {
+        valueName: string;
+        value: string | number;
+    };
+}
+export {};

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

@@ -0,0 +1,73 @@
+export interface CapPresets {
+    pollInterval: number;
+    feeds: Feed[];
+}
+interface Feed {
+    feedAddress: string;
+    feedType: string;
+    languagePriority: string;
+}
+export interface FeedLastUpdated {
+    lastUpdated: number;
+}
+export interface CapWarnings {
+    alert: CapAlert;
+    features: CapFeatures;
+}
+export interface CapAlert {
+    feedAddress: string;
+    identifier: string;
+    severity: string;
+    certainty: string;
+    onset: string;
+    expires: string;
+    languages: Language[];
+}
+export interface CapFeatures extends GeoJSON.FeatureCollection {
+    type: 'FeatureCollection';
+    features: Array<CustomFeature>;
+}
+export interface CustomFeature {
+    type: 'Feature';
+    geometry: GeoJSON.Geometry;
+    id?: string | number;
+    properties: CustomProperties;
+}
+interface CustomProperties {
+    fill?: string;
+    stroke?: string;
+    'stroke-width'?: number;
+    'stroke-opacity'?: number;
+    details: CustomDetails;
+}
+export interface CustomDetails {
+    feedAddress: string;
+    identifier: string;
+    senderName?: string;
+    severity: string;
+    certainty: string;
+    onset: string;
+    expires: string;
+    languages: Language[];
+}
+export interface Language {
+    areaDesc: string;
+    language: string;
+    event: string;
+    senderName: string;
+    headline: string;
+    description: string;
+}
+interface SeverityStyle {
+    border?: string;
+    background?: string;
+    fill?: string;
+    stroke?: string;
+}
+export interface SeverityStyles {
+    Extreme: SeverityStyle;
+    Severe: SeverityStyle;
+    Moderate: SeverityStyle;
+    Minor: SeverityStyle;
+}
+export {};

package/src/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './components/ComponentsLookUp';
+export { default as capModuleConfig } from './store/config';
+export type { CapModule } from './store/config';
+export { reducer as capReducer } from './store/reducer';

package/src/lib/store/config.d.ts

@@ -0,0 +1,6 @@
+import { Egg } from '@redux-eggs/core';
+import { Store } from '@reduxjs/toolkit';
+import { CapModule } from './types';
+export type { CapModule };
+declare const capModuleConfig: Egg<Store<CapModule>>;
+export default capModuleConfig;

package/src/lib/store/index.d.ts

@@ -0,0 +1,3 @@
+export { capActions } from './reducer';
+export * as capSelectors from './selectors';
+export * from './mockStore';

package/src/lib/store/mockStore.d.ts

@@ -0,0 +1,21 @@
+import { CapStore } from './types';
+export declare const mockCapStateWithAlerts: CapStore;
+export declare const mockCapStateWithFeeds: {
+    alerts: {
+        ids: never[];
+        entities: {};
+    };
+    feeds: {
+        ids: string[];
+        entities: {
+            'https://alerts.fmi.fi/cap/feed/rss_en-GB.rss': {
+                id: string;
+                lastUpdated: number;
+            };
+            'https://api.met.no/weatherapi/metalerts/1.1': {
+                id: string;
+                lastUpdated: number;
+            };
+        };
+    };
+};

package/src/lib/store/reducer.d.ts

@@ -0,0 +1,13 @@
+import { Draft, PayloadAction } from '@reduxjs/toolkit';
+import { CapFeed, CapFeedState, CapAlert, CapAlertState, AddManyAlertsToFeedPayload, FeedLastUpdatedPayload, CapStore } from './types';
+export declare const feedAdapter: import("@reduxjs/toolkit").EntityAdapter<CapFeed>;
+export declare const feedInitialState: CapFeedState;
+export declare const alertAdapter: import("@reduxjs/toolkit").EntityAdapter<CapAlert>;
+export declare const alertInitialState: CapAlertState;
+export declare const initialState: CapStore;
+export declare const reducer: import("redux").Reducer<CapStore, import("redux").AnyAction>;
+export declare const capActions: import("@reduxjs/toolkit").CaseReducerActions<{
+    addManyAlerts: (draft: Draft<CapStore>, action: PayloadAction<CapAlert[]>) => void;
+    addManyAlertsToFeed: (draft: Draft<CapStore>, action: PayloadAction<AddManyAlertsToFeedPayload>) => void;
+    setFeedLastUpdatedTimes: (draft: Draft<CapStore>, action: PayloadAction<FeedLastUpdatedPayload[]>) => void;
+}, "capReducer">;

package/src/lib/store/reducer.spec.d.ts

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

package/src/lib/store/selector.spec.d.ts

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

package/src/lib/store/selectors.d.ts

@@ -0,0 +1,15 @@
+import { CoreAppStore } from '@opengeoweb/store';
+import { CapAlert, CapModule, CapStore, CapFeed } from './types';
+export declare const getCapStore: (store: CapModule) => CapStore;
+export declare const getCapFeedById: (state: CapModule, id: import("@reduxjs/toolkit").EntityId) => CapFeed | undefined, getCapFeeds: (state: CapModule) => CapFeed[];
+export declare const getAlertById: (state: CapModule, id: import("@reduxjs/toolkit").EntityId) => CapAlert | undefined, getAlerts: (state: CapModule) => CapAlert[], getAlertIds: (state: CapModule) => import("@reduxjs/toolkit").EntityId[];
+export declare const getAlertsInEffect: ((state: CapModule & CoreAppStore, selectedTime: string) => CapAlert[]) & import("reselect").OutputSelectorFields<(args_0: CapAlert[], args_1: string) => CapAlert[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export declare const getLastUpdatedTimes: ((state: CapModule) => number[]) & import("reselect").OutputSelectorFields<(args_0: CapFeed[]) => number[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};