@opengeoweb/cap 19.1.0 → 19.1.1

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+import capTranslations from '../locales/cap.json';
+export * from './lib';
+export { CAP_NAMESPACE } from './lib/utils/i18n';
+export { capTranslations };

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

@@ -0,0 +1,32 @@
+import React from 'react';
+import type { InitialMapProps } from '@opengeoweb/core';
+import type { 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;
+}
+/**
+ * The lookup table is for registering your own components with the workspace.
+ * @param payload
+ * @returns
+ */
+export declare const ComponentsLookUp: ({ componentType, initialProps, productConfigKey, id, }: ComponentsLookUpPayload) => React.ReactElement;
+export {};

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

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

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

@@ -0,0 +1,40 @@
+import Gantt from 'frappe-gantt';
+import type { Task } from './Task';
+import { ViewMode } from './ViewMode';
+interface 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/dist/src/lib/components/GanttChart/GanttModule.d.ts

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

package/dist/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;
+interface 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;
+}
+interface 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/dist/src/lib/components/GanttChart/GanttWrapper.d.ts

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

package/dist/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/dist/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/dist/src/lib/components/GanttChart/mockTasks.d.ts

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

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

@@ -0,0 +1,5 @@
+import type { CustomFeature } from '../types';
+import type { 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/dist/src/lib/components/MapViewCap/MapViewCapConnect.d.ts

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

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

@@ -0,0 +1,17 @@
+import React from 'react';
+import type { 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/dist/src/lib/components/MapViewCap/index.d.ts

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

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

@@ -0,0 +1,32 @@
+import type { Theme } from '@mui/material';
+import type { Store } from '@reduxjs/toolkit';
+import { QueryClient } from '@tanstack/react-query';
+import type i18n from 'i18next';
+import React from 'react';
+import type { ThemeProviderProps } from '@opengeoweb/theme';
+export declare const CapThemeWrapper: React.FC<ThemeProviderProps>;
+interface CapQueryClientProviderProps {
+    children: React.ReactNode;
+    customClient?: QueryClient;
+}
+interface CapThemeStoreProviderProps extends CapQueryClientProviderProps {
+    theme?: Theme;
+    store: Store;
+    i18nInstance?: typeof i18n;
+}
+interface CapTranslationsWrapperProps {
+    children?: React.ReactNode;
+    i18nInstance?: typeof i18n;
+}
+/**
+ * A Provider component which returns the QueryClientProvider for the Cap library
+ * @param children
+ * @returns
+ */
+export declare const CapQueryClientProvider: React.FC<CapQueryClientProviderProps>;
+export interface CapStoreProviderProps extends ThemeProviderProps {
+    store: Store;
+}
+export declare const CapThemeStoreProvider: React.FC<CapThemeStoreProviderProps>;
+export declare const CapI18nProvider: React.FC<CapTranslationsWrapperProps>;
+export {};

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

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

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

@@ -0,0 +1,10 @@
+import React from 'react';
+import type { CapPresets } from '../types';
+import type { CapAlert } from '../../store/types';
+interface WarningListCapProps {
+    capWarningPresets: CapPresets;
+    alerts: CapAlert[];
+    isPending?: boolean;
+}
+export declare const WarningListCap: React.FC<WarningListCapProps>;
+export {};

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

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

package/dist/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/dist/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/dist/src/lib/components/WarningListCap/WarningListRowCap/WarningListRowCapConnect.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+import type { CapAlert } from '../../../store/types';
+import type { CapPresets } from '../../types';
+interface WarningListRowCapConnectProps {
+    alert: CapAlert;
+    capWarningPresets: CapPresets;
+}
+export declare const WarningListRowCapConnect: React.FC<WarningListRowCapConnectProps>;
+export {};

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

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

package/dist/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/dist/src/lib/components/types.d.ts

@@ -0,0 +1,69 @@
+export interface CapPresets {
+    pollInterval: number;
+    feeds: Feed[];
+}
+interface Feed {
+    feedAddress: string;
+    feedType: string;
+}
+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: 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/dist/src/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components/ComponentsLookUp';
+export * from './store';

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

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

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

@@ -0,0 +1,3 @@
+import type { Store } from '@reduxjs/toolkit';
+import type { CoreAppStore } from '@opengeoweb/store';
+export declare const createMockStore: (mockState?: CoreAppStore) => Store;

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

@@ -0,0 +1,15 @@
+import type { Language } from '../components/types';
+export interface CapAlert {
+    feedAddress: string;
+    identifier: string;
+    severity: string;
+    certainty: string;
+    onset: string;
+    expires: string;
+    languages: Language[];
+}
+export interface CapFeed {
+    id: string;
+    lastUpdated: number;
+    alertIds: string[];
+}

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

@@ -0,0 +1,2 @@
+import type { CustomFeature } from '../components/types';
+export declare const addColors: (features: CustomFeature[]) => CustomFeature[];

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

@@ -0,0 +1,2 @@
+import type { CustomFeature } from '../components/types';
+export declare const addFeedAddressToCustomGeoJSonFeature: (feedAddress: string, features: CustomFeature[]) => CustomFeature[];

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

@@ -0,0 +1,12 @@
+import type { CapAlert, CapPresets, CustomFeature } from '../../components/types';
+export interface FeedAddressLink {
+    feedAddress: string;
+    link: string;
+}
+export interface CapAlertAndFeatures {
+    alert: CapAlert;
+    features: CustomFeature[];
+}
+export declare const getConfig: (productConfigKey: string) => Promise<CapPresets>;
+export declare const getFeedLinks: (feedAddress: string) => Promise<FeedAddressLink[]>;
+export declare const getSingleAlert: (alertUrl: FeedAddressLink) => Promise<CapAlertAndFeatures>;

package/dist/src/lib/utils/cap-api/fakeApi.d.ts

@@ -0,0 +1,2 @@
+export declare const generateAlertId: () => string;
+export declare const capApiEndpoints: import("msw").HttpHandler[];

package/dist/src/lib/utils/cap-api/hooks.d.ts

@@ -0,0 +1,10 @@
+import type { UseQueryResult } from '@tanstack/react-query';
+import type { CapAlertAndFeatures } from './api';
+import type { CapPresets } from '../../components/types';
+interface CombinePendingResult<T> {
+    results: T;
+    pending: boolean;
+}
+export declare const useGetConfig: (productConfigKey: string) => UseQueryResult<CapPresets>;
+export declare const useAllFeedAlerts: (capPresets: CapPresets) => CombinePendingResult<CapAlertAndFeatures[]>;
+export {};

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

@@ -0,0 +1,10 @@
+import type { CapPresets } from '../components/types';
+interface Language {
+    language: string;
+    event: string;
+    senderName: string;
+    headline: string;
+    description: string;
+}
+export declare const findEventIndexInLanguage: (language: string, languages: Language[], capWarningPresets: CapPresets, feedAddressFromProps: string) => number;
+export {};

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

@@ -0,0 +1,3 @@
+import type { FeatureEvent } from '@opengeoweb/webmap-react';
+import type { CustomFeature } from '../components/types';
+export declare const highlightGeoJson: (currentFeatures: Record<string, CustomFeature[]>, featureResults?: FeatureEvent) => Record<string, CustomFeature[]>;

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

@@ -0,0 +1,6 @@
+import i18n from 'i18next';
+import type { UseTranslationResponse } from 'react-i18next';
+export declare const CAP_NAMESPACE = "cap";
+export declare const initCapI18n: () => typeof i18n;
+export declare const useCapTranslation: () => UseTranslationResponse<typeof CAP_NAMESPACE, typeof i18n>;
+export { i18n };

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

@@ -0,0 +1,2 @@
+import type { CapAlert } from '../components/types';
+export declare const mockAlert: CapAlert;

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

@@ -0,0 +1,3 @@
+import type { CapPresets, CapWarnings } from '../components/types';
+export declare const mockCapWarningPresets: CapPresets;
+export declare const mockCapWarnings: CapWarnings;

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

@@ -0,0 +1,2 @@
+import type { CapFeatures } from '../components/types';
+export declare const mockGeoJson: CapFeatures;

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

@@ -0,0 +1,3 @@
+import type { CapFeatures, CustomFeature } from '../components/types';
+export declare const mockGeoJsonMultipleFeatures: CapFeatures;
+export declare const mockGeoJsonMultipleFeaturesById: Record<string, CustomFeature[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/cap",
-  "version": "19.1.0",
+  "version": "19.1.1",
   "description": "GeoWeb Common Alerting Protocol (CAP) library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -48,6 +48,7 @@
   },
   "files": [
     "dist",
+    "!dist/package.json",
     "README.md",
     "package.json"
   ]