@atmosx/event-product-parser 3.0.3 → 3.0.6

package/dist/index.d.ts

@@ -1,239 +0,0 @@
-type TypeWebhook = {
-    webhook: string;
-    title: string;
-    message: string;
-    upload: boolean;
-    rate: number;
-    events: string[];
-};
-
-type TypeSettings = {
-    Database: string;
-    EnableWireService: boolean;
-    EnableJournal: boolean;
-    NOAAWeatherWireServiceSettings: {
-        ReconnectionSettings: {
-            Enabled: boolean;
-            ReconnectionInterval: number;
-        };
-        CredentialSettings: {
-            Username: string | void;
-            Password: string | void;
-            Nickname: string | void;
-        };
-        CacheSettings: {
-            Enabled: boolean;
-            MaxDatabaseHistory: number;
-            MaxRetentionHistory: number;
-        };
-        StanzaSettings: {
-            DisableUGC: boolean;
-            DisableVTEC: boolean;
-            DisableText: boolean;
-        };
-    };
-    NationalWeatherServiceSettings: {
-        CallbackInterval: number;
-        EventsEndpoint: string;
-    };
-    GlobalSettings: {
-        EventManagement: boolean;
-        BetterEventNames: boolean;
-        DisableGeometryParsing: boolean;
-        UseShapefileCoordinates: boolean;
-        SPCWatchesOnly: boolean;
-        ShapefileSkipPoints: number;
-        NodeTTL: number;
-        NodeMinDistance: number;
-        WebhookSettings?: TypeWebhook;
-        EventFiltering: {
-            ListeningEvents: string[];
-            ListeningICAO: string[];
-            ListeningUGC: string[];
-            ListeningStates: string[];
-            IgnoredICAO: string[];
-            IgnoredEvents: string[];
-            NodeLocationFiltering: boolean;
-            IgnoreTestProducts: boolean;
-        };
-        EASSettings: {
-            ArchiveDirectory: string;
-            IntroWavFile: string;
-        };
-    };
-};
-
-declare const setSettings: (newSettings: TypeSettings) => TypeSettings;
-
-type TypeAttributes = {
-    xmlns: string;
-    id: string;
-    issue: string;
-    ttaaii: string;
-    cccc: string;
-    awipsid: string;
-};
-
-type TypeEventProperties = {
-    locations: string;
-    description: string;
-    attributes: TypeAttributes;
-    geocode: {
-        office: {
-            name: string;
-            office: string;
-        };
-        organization: string;
-        ugc: string[];
-        polygon: string;
-        polygon_generated: boolean;
-    };
-    parameters: {
-        tags: string[];
-        instructions: string;
-        source: string;
-        hazards: string;
-        impacts: string;
-        estimated_hail_size: string;
-        estimated_wind_gusts: string;
-        damage_threat: string;
-        tornado_threat: string;
-        flood_threat: string;
-        wind_threat: string;
-        hail_threat: string;
-        max_hail_inches?: string;
-        max_wind_gusts_surface_knots?: string;
-        max_tops_x100feet?: string;
-        mean_storm_motion_vector?: string;
-        particularly_dangerous_situation?: string;
-    };
-    watch_parameters?: {
-        watch_number: string;
-        watch_type: string;
-        additional_tornadoes_probability: string;
-        strong_tornadoes_probability: string;
-        severe_wind_probability: string;
-        severe_hail_probability: string;
-        hail_2in_probability: string;
-        combined_hail_wind_probability: string;
-        max_hail_in: string;
-        max_wind_surface: string;
-        max_tops_x100feet: string;
-        pds_watch: boolean;
-    };
-    spc_parameters: {
-        spc_max_tornado: string;
-        spc_max_hail: string;
-        spc_max_wind: string;
-        spc_watch_issuance: string;
-    };
-};
-
-type TypeHVTEC = {
-    hvtec: string;
-    severity: string;
-    cause: string;
-    record: string;
-};
-
-type TypePVTEC = {
-    vtec: string;
-    product: string;
-    tracking: string;
-    event: string;
-    status: string;
-    organization: string;
-    expires: string;
-    is_watch: boolean;
-    prediction_center: boolean;
-};
-
-type TypeEvent = {
-    type: string;
-    geometry: {
-        type: string;
-        coordinates: number[][];
-    };
-    properties: {
-        event: string;
-        parent: string;
-        status: string;
-        issued: string;
-        expires: string;
-        status_metadata?: {
-            is_issued?: boolean;
-            is_updated?: boolean;
-            is_expired?: boolean;
-            is_test?: boolean;
-            is_statement?: boolean;
-        };
-        metadata: {
-            ms: number;
-            source: string;
-            tracking: string;
-            hash?: string;
-            header: string;
-            vtec: TypePVTEC | null;
-            hvtec: TypeHVTEC[];
-            nodes?: {
-                id?: string | number;
-                coordinates: [number, number];
-                nearest: [number, number];
-                miles: number | null;
-                kilometers: number | null;
-                proximity: boolean;
-            }[];
-            filtered_proximity?: boolean;
-            updated?: number;
-            history: {
-                description: string;
-                issued: string;
-                status: string;
-            }[];
-        };
-    } & TypeEventProperties;
-};
-
-interface GetGeometryResponse {
-    type: `Polygon` | `MultiPolygon`;
-    coordinates: any[];
-}
-declare const getEventGeometry: (event: TypeEvent) => Promise<GetGeometryResponse>;
-
-declare const getCleanedEvent: <T extends Record<string, any>>(event: T) => T;
-
-declare const startService: (settings: TypeSettings) => Promise<void>;
-
-declare const stopService: () => Promise<void>;
-
-interface GenerateEASOptions {
-    message: string;
-    header: string;
-}
-declare const setEasTone: (options: GenerateEASOptions) => Promise<string>;
-
-interface GetAddChaserOptions {
-    identifier: string;
-    delete?: boolean;
-    coordinates: {
-        longitude: number;
-        latitude: number;
-    };
-}
-declare const setNode: (options: GetAddChaserOptions) => void;
-
-declare const getEvents: () => any;
-
-declare const getNodes: () => any;
-
-declare const getRandomEvent: () => any;
-
-declare const clearEvents: () => void;
-
-declare class Manager {
-    constructor(settings: TypeSettings);
-    on(event: string, callback: () => void): void;
-    trycatch(): void;
-}
-
-export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, setEasTone, setNode, setSettings, startService, stopService };

package/src/@building/building.properties.ts

@@ -1,89 +0,0 @@
-/*
-              _                             _               _     __   __
-         /\  | |                           | |             (_)    \ \ / /
-        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
-       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
-      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
-     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
-                                     | |                            
-                                     |_|                                                                                                                
-
-    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, & CJ Ziegler)
-    Discord: https://atmosphericx-discord.scriptkitty.cafe
-    Ko-Fi: https://ko-fi.com/k3yomi
-    Documentation: http://localhost/documentation | https://atmosphericx.scriptkitty.cafe/documentation
-
-    Internal Package: @atmosx/event-product-parser
-
-*/
-
-import { TypeEventProperties } from "../@types/type.properties";
-import { TypeAttributes } from "../@types/types.attributes";
-import { TypeUGC } from "../@types/types.ugc";
-import { TypePVTEC } from "../@types/types.pvtec";
-import { TypeHVTEC } from "../@types/types.hvtec";
-import { regExp } from "../@dictionaries/dictionaries.regExp";
-import { getDescriptionFromProduct } from "../@parsers/@text/text.getDescriptionFromProduct";
-import { getPolygonFromProduct } from "../@parsers/@text/text.getPolygonFromProduct";
-import { getTextFromProduct } from "../@parsers/@text/text.getTextFromProduct";
-import { getEventOffice } from "./building.office";
-import { getEventTags } from "./building.tags";
-
-interface GetPropertiesOptions { 
-    message: string
-    attributes: TypeAttributes
-    ugc?: TypeUGC
-    pVtec?: TypePVTEC
-    hVtec?: TypeHVTEC
-}
-
-export const properties = (options: GetPropertiesOptions): TypeEventProperties => {
-    const organization = options.message.match(regExp.wmo)?.[0] ?? null
-    const polygons = getPolygonFromProduct(options.message)
-    return { 
-        locations: options?.ugc?.locations?.join(`; `) ?? null,
-        description: getDescriptionFromProduct({ message: options.message, handle: options?.pVtec?.vtec ?? null }),
-        attributes: options.attributes,
-        geocode: {
-            office: getEventOffice({ attributes: options.attributes, organization: organization, pVtec: options.pVtec }),
-            organization: organization,
-            ugc: options?.ugc?.zones ?? [],
-            polygon: polygons.length > 0 ? Buffer.from(JSON.stringify([polygons])).toString('base64') : null,
-            polygon_generated: polygons.length > 0 ? true : false
-        },
-        parameters: {
-            tags: getEventTags(options.message),
-            instructions: getTextFromProduct({ message: options.message, find: [`For your protection`, `do not`, `use extreme caution`], append: `...`, removal: [`.`]})  ?? null,
-            source: getTextFromProduct({ message: options.message, find: [`SOURCE...`], removal: [`.`]}) ?? null,
-            hazards: getTextFromProduct({ message: options.message, find: [`HAZARD...`], removal: [`.`]}) ?? null,
-            impacts: getTextFromProduct({ message: options.message, find: [`IMPACT...`], removal: [`.`]}) ?? null,
-            estimated_hail_size: getTextFromProduct({ message: options.message, find: [`MAX HAIL SIZE...`, `HAIL...`], removal: ['in']}) ?? null,
-            estimated_wind_gusts: getTextFromProduct({ message: options.message, find: [`MAX WIND GUST...`, `WIND...`]}) ?? null,
-            damage_threat: getTextFromProduct({ message: options.message, find: [`DAMAGE THREAT...`], removal: []}) ?? null,
-            tornado_threat: getTextFromProduct({ message: options.message, find: [`TORNADO...`, `WATERSPOUT...`] }) ?? null,
-            flood_threat: getTextFromProduct({ message: options.message, find: [`FLASH FLOOD...`]}) ?? null,
-            wind_threat: getTextFromProduct({ message: options.message, find: [`WIND THREAT...`]}) ?? null,
-            hail_threat: getTextFromProduct({ message: options.message, find: [`HAIL THREAT...`], removal: []}) ?? null,
-        },
-        spc_parameters: {
-            spc_max_tornado: getTextFromProduct({ message: options.message, find: [`MOST PROBABLE PEAK TORNADO INTENSITY...`] }) ?? null,
-            spc_max_hail: getTextFromProduct({ message: options.message, find: [`MOST PROBABLE PEAK HAIL SIZE...`] }) ?? null,
-            spc_max_wind: getTextFromProduct({ message: options.message, find: [`MOST PROBABLE PEAK WIND GUST...`] }) ?? null,
-            spc_watch_issuance: getTextFromProduct({ message: options.message, find: [`Probability of Watch Issuance...`], removal: [`percent`]}) ?? null,
-        },
-        watch_parameters: {
-            watch_number: getTextFromProduct({ message: options.message, find: [`ITIES FOR`, `UPDATE FOR`, `Watch Number `], removal: [`%`, `<`, `:`] })?.replace(/(WT|WS|)/g, '')?.trim() ?? null,
-            watch_type: options.message.includes(`TORNADO WATCH`) ? `Tornado` : options?.message.includes(`SEVERE`) ? `Severe` : null,
-            additional_tornadoes_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 2 OR MORE TORNADOES`], removal: [`%`, `<`, `:`] }) ?? null,
-            strong_tornadoes_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 1 OR MORE STRONG /EF2-EF5/ TORNADOES`], removal: [`%`, `<`, `:`] }) ?? null,
-            severe_wind_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 10 OR MORE SEVERE WIND EVENTS`], removal: [`%`, `<`, `:`] }) ?? null,
-            severe_hail_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 10 OR MORE SEVERE HAIL EVENTS`], removal: [`%`, `<`, `:`] }) ?? null,
-            hail_2in_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 1 OR MORE HAIL EVENTS >= 2 INCHES`], removal: [`%`, `<`, `:`] }) ?? null,
-            combined_hail_wind_probability: getTextFromProduct({ message: options.message, find: [`PROB OF 6 OR MORE COMBINED SEVERE HAIL/WIND EVENTS`], removal: [`%`, `<`, `:`] }) ?? null,
-            max_hail_in: getTextFromProduct({ message: options.message, find: [`MAX HAIL /INCHES/`], removal: [`%`, `<`, `:`] }) ?? null,
-            max_wind_surface:  getTextFromProduct({ message: options.message, find: [`MAX WIND GUSTS SURFACE /KNOTS/`], removal: [`%`, `<`, `:`] }) ?? null,
-            max_tops_x100feet:  getTextFromProduct({ message: options.message, find: [`MAX TOPS /X 100 FEET/`], removal: [`%`, `<`, `:`] }) ?? null,
-            pds_watch: (getTextFromProduct({ message: options.message, find: [`PARTICULARLY DANGEROUS SITUATION`], removal: [`%`, `<`, `:`] }) === `YES`)
-        }
-    }
-}

package/src/@dictionaries/dictionaries.betterEventNames.ts

@@ -1,99 +0,0 @@
-/*
-              _                             _               _     __   __
-         /\  | |                           | |             (_)    \ \ / /
-        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
-       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
-      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
-     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
-                                     | |                            
-                                     |_|                                                                                                                
-
-    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, & CJ Ziegler)
-    Discord: https://atmosphericx-discord.scriptkitty.cafe
-    Ko-Fi: https://ko-fi.com/k3yomi
-    Documentation: http://localhost/documentation | https://atmosphericx.scriptkitty.cafe/documentation
-
-    Internal Package: @atmosx/event-product-parser
-
-*/
-
-type EnhancedEventType = {
-    description?: string
-    append?: boolean
-    tornado?: string
-    damage?: string
-}
-
-export const betterEventNames: Record<string, Record<string, EnhancedEventType>> = {
-    "Tornado Warning": {
-        "Tornado Emergency": { 
-            description: "tornado emergency"
-        },
-        "PDS Tornado Warning": { 
-            description: "particularly dangerous situation", 
-            damage: `CONSIDERABLE`
-        },
-        "Radar Confirmed Tornado Warning": {
-            description: "source...radar confirmed tornado.",
-            tornado: `OBSERVED`
-        },
-        "Confirmed Tornado Warning": { 
-            tornado: `OBSERVED`
-        },
-        "Radar Indicated Tornado Warning": { },
-    },
-    "Blizzard Warning": {
-        "PDS Blizzard Warning": {
-            description: "particularly dangerous situation", 
-        },
-    },
-    "Ice Storm Warning": {
-        "PDS Ice Storm Warning": {
-            description: "particularly dangerous situation", 
-        },
-    },
-    "Special Marine Warning": {
-        "Special Marine Warning (TPROB)": { 
-            tornado: `POSSIBLE`
-        },
-    },
-    "Tornado Watch": {
-        "PDS Tornado Watch": { 
-            description: "particularly dangerous situation"
-        }
-    },
-    "Flash Flood Warning": {
-        "Flash Flood Emergency": { 
-            description: "flash flood emergency" 
-        },
-        "Considerable Flash Flood Warning": { 
-            damage: `CONSIDERABLE`
-        },
-    },
-    "Severe Thunderstorm Warning": {
-        "EDS Severe Thunderstorm Warning (TPROB)": { 
-            description: "extremely dangerous situation",
-            tornado: "POSSIBLE"
-        },
-        "EDS Severe Thunderstorm Warning": {
-            description: "extremely dangerous situation"
-        },
-        "Destructive Severe Thunderstorm Warning (TPROB)": {
-            damage: `DESTRUCTIVE`,
-            tornado: `POSSIBLE`
-        },
-        "Destructive Severe Thunderstorm Warning": {
-            damage: `DESTRUCTIVE`
-        },
-        "Considerable Severe Thunderstorm Warning (TPROB)": {
-            damage: `CONSIDERABLE`,
-            tornado: `POSSIBLE`
-        },
-        "Considerable Severe Thunderstorm Warning": {
-            damage: `CONSIDERABLE`
-        },
-        "Severe Thunderstorm Warning (TPROB)": {
-            tornado: `POSSIBLE`
-        },
-    },
-}