@opengeoweb/api 9.25.2 → 9.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/api",
-  "version": "9.25.2",
+  "version": "9.26.0",
   "description": "GeoWeb API library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {
@@ -8,7 +8,8 @@
     "url": "git@gitlab.com:opengeoweb/opengeoweb.git"
   },
   "dependencies": {
-    "@opengeoweb/authentication": "*"
+    "@opengeoweb/authentication": "*",
+    "@opengeoweb/store": "*"
   },
   "peerDependencies": {},
   "module": "./index.esm.js",

package/src/index.d.ts

@@ -1,2 +1,4 @@
 export * from '@opengeoweb/authentication';
+export * from './sigmet-airmet-api/api';
+export * from './sigmet-airmet-api/types';
 export { API_NAMESPACE } from './i18n';

package/src/sigmet-airmet-api/api.d.ts

@@ -0,0 +1,8 @@
+import { Credentials } from '@opengeoweb/authentication';
+import { AirmetFromBackend, SigmetFromBackend } from './types';
+import { AirmetConfig, SigmetConfig } from './config-types';
+export declare const getAirmetList: (auth: Credentials) => Promise<AirmetFromBackend[]>;
+export declare const getSigmetList: (auth: Credentials) => Promise<SigmetFromBackend[]>;
+export declare const getlocalProductConfig: <T extends SigmetConfig | AirmetConfig>(configUrl: string) => Promise<T>;
+export declare const getAirmetConfig: (auth: Credentials) => Promise<AirmetConfig>;
+export declare const getSigmetConfig: (auth: Credentials) => Promise<SigmetConfig>;

package/src/sigmet-airmet-api/config-types.d.ts

@@ -0,0 +1,87 @@
+import { MapPreset } from '@opengeoweb/store';
+export interface AllowedUnits {
+    unit_type: string;
+    allowed_units: string[];
+}
+export type FIRLocationGeoJson = GeoJSON.FeatureCollection<GeoJSON.Geometry, {
+    selectionType?: string;
+}>;
+export interface LevelMinMaxType {
+    FT?: number;
+    FL?: number;
+    M?: number;
+}
+export interface MovementMinMaxType {
+    KT?: number;
+    KMH?: number;
+}
+export interface CloudLevelMinMaxType {
+    FT?: number;
+    M?: number;
+}
+export interface SurfaceWindMinMaxType {
+    KT?: number;
+    MPS?: number;
+}
+export interface FIRArea {
+    fir_name: string;
+    fir_location: FIRLocationGeoJson;
+    location_indicator_atsr: string;
+    location_indicator_atsu: string;
+    max_hours_of_validity: number;
+    hours_before_validity: number;
+    level_min?: LevelMinMaxType;
+    level_max?: LevelMinMaxType;
+    level_rounding_FL?: number;
+    level_rounding_FT?: number;
+    level_rounding_M?: number;
+    movement_min?: MovementMinMaxType;
+    movement_max?: MovementMinMaxType;
+    movement_rounding_kt?: number;
+    movement_rounding_kmh?: number;
+    max_polygon_points?: number;
+    units: AllowedUnits[];
+}
+export interface FIRConfigSigmet extends FIRArea {
+    tc_max_hours_of_validity: number;
+    tc_hours_before_validity: number;
+    va_max_hours_of_validity: number;
+    va_hours_before_validity: number;
+    adjacent_firs: string[];
+    area_preset: string;
+}
+export interface FIRConfigAirmet extends FIRArea {
+    cloud_level_min?: CloudLevelMinMaxType;
+    cloud_level_max?: CloudLevelMinMaxType;
+    cloud_lower_level_min?: CloudLevelMinMaxType;
+    cloud_lower_level_max?: CloudLevelMinMaxType;
+    cloud_level_rounding_ft?: number;
+    cloud_level_rounding_m_below?: number;
+    cloud_level_rounding_m_above?: number;
+    wind_direction_rounding?: number;
+    wind_speed_max?: SurfaceWindMinMaxType;
+    wind_speed_min?: SurfaceWindMinMaxType;
+    visibility_max?: number;
+    visibility_min?: number;
+    visibility_rounding_below?: number;
+    visibility_rounding_above?: number;
+}
+type SigmetFIRArea = Record<string, FIRConfigSigmet>;
+type AirmetFIRArea = Record<string, FIRConfigAirmet>;
+export type Firareas = SigmetFIRArea | AirmetFIRArea;
+export interface ProductConfig {
+    location_indicator_mwo: string;
+    active_firs: string[];
+    valid_from_delay_minutes: number;
+    default_validity_minutes: number;
+    fir_areas: Firareas;
+    mapPreset?: MapPreset;
+    omit_change_va_and_rdoact_cloud?: boolean;
+}
+export interface SigmetConfig extends ProductConfig {
+    fir_areas: SigmetFIRArea;
+}
+export interface AirmetConfig extends ProductConfig {
+    fir_areas: AirmetFIRArea;
+}
+export {};

package/src/sigmet-airmet-api/definitions.d.ts

@@ -0,0 +1,141 @@
+export type DateType = string;
+export type ICAOLocation = string;
+export type MWOLocation = string;
+export type ATSULocation = string;
+export type ATSRLocation = string;
+/**
+ * ProductStatus is returned by the backend. The backend fills in  this property.
+ * For the backend, it should only need to store 'DRAFT' | 'PUBLISHED' | 'CANCELLED' in its DB.
+ * The backend should derive and return the status 'EXPIRED' from the product properties.
+ *
+ * Note: ProductStatus from the backend should be refreshed regularly to display status updates. */
+export declare enum ProductStatus {
+    DRAFT = "DRAFT",
+    PUBLISHED = "PUBLISHED",
+    CANCELLED = "CANCELLED",
+    EXPIRED = "EXPIRED",
+    DISCARDED = "DISCARDED"
+}
+/**
+ * ProductSequence is a sequence label with a counter of the SIGMETs/AIRMETs issued on a day (starting at with 1 01:00),
+ * max 3 characters long; first character should be a capital letter,
+ * others are numbers: A01-A99, 01-99 or 1-99 */
+export type ProductSequenceId = string;
+/**
+ *  ProductCanbe lifecycle is determined by the backend. E.g. the backend fills in these properties:
+ * 'DRAFTED': product can be saved as draft
+ * 'DISCARDED': This product can be thrown away
+ * 'PUBLISHED': product can be PUBLISHED
+ * 'CANCELLED': product can be CANCELLED */
+export type ProductCanbe = 'DRAFTED' | 'DISCARDED' | 'PUBLISHED' | 'CANCELLED';
+export type ObservationOrForcast = 'OBS' | 'FCST';
+export declare enum LevelUnits {
+    'FT' = "ft",
+    'M' = "m",
+    'FL' = "FL"
+}
+export declare enum CloudLevelUnits {
+    'FT' = "ft",
+    'M' = "m"
+}
+/** Change type of the Product, can be:
+ * INTSF:Intensifying
+ * WKN: Weakening
+ * NC: No change */
+export type Change = 'INTSF' | 'WKN' | 'NC';
+export type LevelInfoMode = 'AT' | 'BETW' | 'BETW_SFC' | 'TOPS' | 'TOPS_ABV' | 'TOPS_BLW' | 'ABV';
+/**
+ * The possible phenomena for the sigmet
+ */
+export declare enum SigmetPhenomena {
+    'EMBD_TS' = "Embedded thunderstorm(s)",
+    'EMBD_TSGR' = "Embedded thunderstorm(s) with hail",
+    'FRQ_TS' = "Frequent thunderstorm(s)",
+    'FRQ_TSGR' = "Frequent thunderstorm(s) with hail",
+    'HVY_DS' = "Heavy duststorm",
+    'HVY_SS' = "Heavy sandstorm",
+    'OBSC_TS' = "Obscured thunderstorm(s)",
+    'OBSC_TSGR' = "Obscured thunderstorm(s) with hail",
+    'RDOACT_CLD' = "Radioactive cloud",
+    'SEV_ICE' = "Severe icing",
+    'SEV_ICE_FRZ_RN' = "Severe icing due to freezing rain",
+    'SEV_MTW' = "Severe mountain wave",
+    'SEV_TURB' = "Severe turbulence",
+    'SQL_TS' = "Squall line",
+    'SQL_TSGR' = "Squall line thunderstorm(s) with hail",
+    'VA_CLD' = "Volcanic ash cloud"
+}
+/**
+ * The possible phenomena for the airmet
+ */
+export declare enum AirmetPhenomena {
+    'SFC_VIS' = "Surface visibility",
+    'SFC_WIND' = "Surface wind",
+    'OVC_CLD' = "Overcast cloud",
+    'BKN_CLD' = "Broken cloud",
+    'ISOL_CB' = "Isolated cumulonimbus cloud",
+    'OCNL_CB' = "Occasional cumulonimbus cloud",
+    'FRQ_CB' = "Frequent cumulonimbus cloud",
+    'ISOL_TS' = "Isolated thunderstorm(s)",
+    'OCNL_TS' = "Occasional thunderstorm(s)",
+    'ISOL_TSGR' = "Isolated thunderstorm(s) with hail",
+    'OCNL_TSGR' = "Occasional thunderstorm(s) with hail",
+    'ISOL_TCU' = "Isolated towering cumulus cloud",
+    'OCNL_TCU' = "Occasional towering cumulus cloud",
+    'FRQ_TCU' = "Frequent towering cumulus cloud",
+    'MOD_ICE' = "Moderate icing",
+    'MOD_MTW' = "Moderate mountain wave",
+    'MOD_TURB' = "Moderate turbulence",
+    'MT_OBSC' = "Mountains obscured"
+}
+export type SigmetMovementType = 'STATIONARY' | 'MOVEMENT' | 'FORECAST_POSITION' | 'NO_VA_EXP';
+export type AirmetMovementType = 'STATIONARY' | 'MOVEMENT';
+export declare enum MovementUnit {
+    'KT' = "kt",
+    'KMH' = "kmh"
+}
+export declare enum WindUnit {
+    'KT' = "kt",
+    'MPS' = "mps"
+}
+export declare enum Direction {
+    'N' = "N",
+    'NNE' = "NNE",
+    'NE' = "NE",
+    'ENE' = "ENE",
+    'E' = "E",
+    'ESE' = "ESE",
+    'SE' = "SE",
+    'SSE' = "SSE",
+    'S' = "S",
+    'SSW' = "SSW",
+    'SW' = "SW",
+    'WSW' = "WSW",
+    'W' = "W",
+    'WNW' = "WNW",
+    'NW' = "NW",
+    'NNW' = "NNW"
+}
+export type VisibilityUnit = 'm';
+export declare enum VisibilityCause {
+    'DZ' = "Drizzle",
+    'DU' = "Dust",
+    'PO' = "Dust or sand devil",
+    'DS' = "Dust storm",
+    'FG' = "Fog",
+    'FC' = "Funnel clouds",
+    'GR' = "Hail",
+    'HZ' = "Haze",
+    'PL' = "Ice pellets",
+    'BR' = "Mist",
+    'RA' = "Rain",
+    'SA' = "Sand",
+    'SS' = "Sand storm",
+    'FU' = "Smoke",
+    'SN' = "Snow",
+    'SG' = "Snow grains",
+    'GS' = "Soft hail",
+    'SQ' = "Squalls",
+    'VA' = "Volcanic Ash"
+}
+export type CloudLevelInfoMode = 'BETW' | 'BETW_SFC' | 'BETW_SFC_ABV' | 'BETW_ABV';

package/src/sigmet-airmet-api/types.d.ts

@@ -0,0 +1,98 @@
+import { AirmetMovementType, AirmetPhenomena, ATSRLocation, ATSULocation, Change, CloudLevelInfoMode, CloudLevelUnits, DateType, Direction, ICAOLocation, LevelInfoMode, LevelUnits, MovementUnit, MWOLocation, ObservationOrForcast, ProductCanbe, ProductSequenceId, ProductStatus, SigmetMovementType, SigmetPhenomena, VisibilityCause, VisibilityUnit, WindUnit } from './definitions';
+export interface LevelType {
+    value: number;
+    unit: LevelUnits;
+}
+export interface CloudLevelType {
+    value: number;
+    unit: CloudLevelUnits;
+}
+export interface Coordinate {
+    latitude: number;
+    longitude: number;
+}
+export interface BaseProduct {
+    validDateStart: DateType;
+    validDateEnd: DateType;
+    firName: ICAOLocation;
+    locationIndicatorMWO: MWOLocation;
+    locationIndicatorATSU: ATSULocation;
+    locationIndicatorATSR: ATSRLocation;
+    uuid?: string;
+    sequence?: ProductSequenceId;
+    issueDate?: DateType;
+}
+interface Product extends BaseProduct {
+    status: ProductStatus;
+    isObservationOrForecast?: ObservationOrForcast;
+    observationOrForecastTime?: DateType;
+    change?: Change;
+    levelInfoMode?: LevelInfoMode;
+    level?: LevelType;
+    lowerLevel?: LevelType;
+    firGeometry?: GeoJSON.FeatureCollection;
+    startGeometry: GeoJSON.FeatureCollection;
+    startGeometryIntersect: GeoJSON.FeatureCollection;
+    movementSpeed?: number;
+    movementUnit?: MovementUnit;
+    movementDirection?: Direction;
+}
+export interface Sigmet extends Product {
+    phenomenon: SigmetPhenomena;
+    type: 'NORMAL' | 'TEST' | 'EXERCISE' | 'SHORT_TEST' | 'SHORT_VA_TEST';
+    endGeometry?: GeoJSON.FeatureCollection;
+    endGeometryIntersect?: GeoJSON.FeatureCollection;
+    movementType?: SigmetMovementType;
+    /** Extra properties in case of va SIGMET */
+    vaSigmetVolcanoName?: string;
+    vaSigmetVolcanoCoordinates?: Coordinate;
+    /** Extra properties in case of cancel va SIGMET, if set to unknown, property not set */
+    vaSigmetMoveToFIR?: ICAOLocation;
+}
+/**
+ * To cancel a published sigmet
+ * To cancel a published sigmet, we send a cancel sigmet with all the mandatory properties from the basesigmet. */
+export interface CancelSigmet extends BaseProduct {
+    cancelsSigmetSequenceId: ProductSequenceId;
+    validDateStartOfSigmetToCancel: DateType;
+    validDateEndOfSigmetToCancel: DateType;
+    status: ProductStatus.PUBLISHED;
+    /** Extra properties in case of cancel va SIGMET, if set to unknown, property not set */
+    vaSigmetMoveToFIR?: ICAOLocation;
+}
+export interface Airmet extends Product {
+    phenomenon: AirmetPhenomena;
+    status: ProductStatus;
+    type: 'NORMAL' | 'TEST' | 'EXERCISE';
+    movementType: AirmetMovementType;
+    windSpeed?: number;
+    windUnit?: WindUnit;
+    windDirection?: number;
+    visibilityValue?: number;
+    visibilityCause?: VisibilityCause;
+    visibilityUnit?: VisibilityUnit;
+    cloudLevelInfoMode?: CloudLevelInfoMode;
+    cloudLevel?: CloudLevelType;
+    cloudLowerLevel?: CloudLevelType;
+}
+export interface CancelAirmet extends BaseProduct {
+    cancelsAirmetSequenceId: ProductSequenceId;
+    validDateStartOfAirmetToCancel: DateType;
+    validDateEndOfAirmetToCancel: DateType;
+    status: ProductStatus.PUBLISHED;
+}
+export interface SigmetFromBackend {
+    sigmet: Sigmet | CancelSigmet;
+    creationDate: DateType;
+    lastUpdateDate: DateType;
+    uuid: string;
+    canbe: ProductCanbe[];
+}
+export interface AirmetFromBackend {
+    airmet: Airmet | CancelAirmet;
+    creationDate: DateType;
+    lastUpdateDate: DateType;
+    uuid: string;
+    canbe: ProductCanbe[];
+}
+export {};

package/src/utils.d.ts

@@ -0,0 +1,2 @@
+import { Credentials } from '@opengeoweb/authentication';
+export declare const getHeaders: (auth: Credentials) => HeadersInit;