@atmosx/event-product-parser 2.0.16 → 3.0.0

package/src/@types/types.compiled.ts

@@ -0,0 +1,35 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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 { TypeAttributes } from "./types.attributes"
+
+export type TypeStanzaCompiled = {
+    message?: string
+    attributes?: TypeAttributes
+    isCapEvent?: boolean
+    isVTEC?: boolean
+    isUGC?: boolean
+    isCapAreaDescription?: boolean
+    isIgnored?: boolean
+    isNWWS?: boolean
+    getType?: {
+        type: string
+        prefix: string
+    }
+}

package/src/@types/types.hash.ts

@@ -0,0 +1,24 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export type TypeHash = {
+    tracking: string
+    hashes: string[]
+    expires: string
+}

package/src/@types/types.hvtec.ts

@@ -0,0 +1,25 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export type TypeHVTEC = { 
+    hvtec: string
+    severity: string
+    cause: string
+    record: string
+}

package/src/@types/types.pvtec.ts

@@ -0,0 +1,29 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export type TypePVTEC = { 
+    vtec: string
+    product: string
+    tracking: string
+    event: string
+    status: string
+    organization: string
+    expires: string
+    prediction_center: boolean
+}

package/src/@types/types.settings.ts

@@ -0,0 +1,71 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export 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: {
+        BetterEventNames: boolean
+        DisableGeometryParsing: boolean
+        UseShapefileCoordinates: boolean
+        ShapefileSkipPoints: number
+        NodeTTL: number
+        NodeMinDistance: number
+        EventFiltering: {
+            ListeningEvents: string[]
+            ListeningICAO: string[]
+            IgnoredICAO: string[]
+            IgnoredEvents: string[]
+            ListeningUGC: string[]
+            ListeningStates: string[]
+            NodeLocationFiltering: boolean
+            IgnoreTestProducts: boolean
+        },
+        EASSettings: {
+            ArchiveDirectory: string | void,
+            IntroWavFile: string | void,
+        }
+    }
+}

package/src/@types/types.stanza.ts

@@ -0,0 +1,37 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export type TypeStanza = {
+    getChild(arg0: string): unknown
+    is(arg0: string): unknown
+    name: string
+    parent: TypeStanza | null
+    children: any
+    attrs: {
+        xmlns: string 
+        id: string
+        issue: string
+        ttaaii: string
+        cccc: string
+        awipsid: string 
+        from: string
+        to: string
+        type: string
+    }
+}

package/src/@types/types.ugc.ts

@@ -0,0 +1,24 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
+
+*/
+
+export type TypeUGC = { 
+    zones: string[]
+    locations: string[]
+    expires: string
+}

package/src/bootstrap.ts

@@ -1,182 +1,101 @@
 /*
-                                            _               _     __   __
+              _                             _               _     __   __
          /\  | |                           | |             (_)    \ \ / /
         /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
        / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
       / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
      /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
-                                     | |                                 
+                                     | |                            
                                      |_|                                                                                                                
-    
-    Written by: k3yomi@GitHub                        
-*/
-
-import * as fs from 'fs';
-import * as path from 'path';
-import * as events from 'events';
-import * as xmpp from '@xmpp/client';
-import * as shapefile from 'shapefile';
-import * as xml2js from 'xml2js';
-import * as jobs from 'croner';
-import * as polygonClipping from 'polygon-clipping';
-import sqlite3 from 'better-sqlite3';
-import crypto from 'crypto';
-import os from 'os';
-import say from 'say';
-import child from 'child_process';
-import jszip from 'jszip';
-
 
-import * as dictEvents from './@dictionaries/events';
-import * as dictAwips from './@dictionaries/awips';
-import * as dictSignatures from './@dictionaries/signatures';
-import * as dictICAOs from './@dictionaries/icao';
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, Everwatch1, & 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
 
+*/
 
-export const packages = {
-    fs, path, events, xmpp, 
-    shapefile, xml2js, sqlite3, jobs, 
-    crypto, os, say, child, polygonClipping, jszip
-};
+import path from 'path'
+import { EventEmitter } from 'node:events';
 
-export const cache = {
+export const bootstrap = {
     isReady: true,
-    sigHalt: false,
-    isConnected: false,
-    attemptingReconnect: false,
-    totalReconnects: 0,
-    lastStanza: null,
-    session: null,
-    lastConnect: null,
-    db: null,
-    lastWarn: null,
-    totalLocationWarns: 0,
-    events: new events.EventEmitter(),
-    isProcessingAudioQueue: false,
-    audioQueue: [],
-};
-
-export const settings = { 
-    database: path.join(process.cwd(), 'shapefiles.db'),
-    is_wire: true,
-    journal: true,
-    noaa_weather_wire_service_settings: {
-        reconnection_settings: {
-            enabled: true,
-            interval: 60,
-        },
-        credentials: {
-            username: null,
-            password: null,
-            nickname: "AtmosphericX Standalone Parser",
-        },   
-        cache: {
-            enabled: true,
-            max_db_history: 5000,
-            max_db_cache_size: 1000,
-        },
-        preferences: {
-            disable_ugc: false,
-            disable_vtec: false,
-            disable_text: false,
-            cap_only: false,
-        }
+    ratelimits: {},
+    session_xmpp: null,
+    database: null,
+    cron: null,
+    listener: new EventEmitter(),
+    ansi_colors: {
+        RED: `\x1b[31m`, GREEN: `\x1b[32m`, YELLOW: `\x1b[33m`,
+        BLUE: `\x1b[34m`, MAGENTA: `\x1b[35m`, CYAN: `\x1b[36m`,
+        WHITE: `\x1b[37m`, RESET: `\x1b[0m`
     },
-    national_weather_service_settings: {
-        interval: 15,
-        endpoint: `https://api.weather.gov/alerts/active`,
+    cache: {
+        lastStanza: null,
+        lastConnect: null,
+        isConnected: false,
+        isReconnecting: false,
+        tReconnects: 0,
+        sigHault: false,
+        events: {type: "FeatureCollection", features: []},
+        nodes: {type: "FeatureCollection", features: []},
+        hashes: [],
     },
-    global_settings: {
-        parent_events_only: true,
-        better_event_parsing: true,
-        ignore_geometry_parsing: false,
-        shapefile_coordinates: false,
-        shapefile_skip: 15,
-        filtering: {
-            events: [],
-            filtered_icao: [],
-            ignored_icao: [],
-            ignored_events: [`Xx`, `Test Message`],
-            ugc_filter: [],
-            state_filter: [],
-            check_expired: true,
-            ignore_test_products: true,
+    settings: {
+        Database: path.join(process.cwd(), 'shapefiles.db'),
+        EnableWireService: true,
+        EnableJournal: true,
+        NOAAWeatherWireServiceSettings: {
+            ReconnectionSettings: {
+                Enabled: true,
+                ReconnectionInterval: 60,
+            },
+            CredentialSettings: {
+                Username: null,
+                Password: null,
+                Nickname: "@atmosx/event-product-parser/3.0",
+            },   
+            CacheSettings: {
+                Enabled: true,
+                MaxDatabaseHistory: 5000,
+                MaxRetentionHistory: 1000,
+            },
+            StanzaSettings: {
+                DisableUGC: false,
+                DisableVTEC: false,
+                DisableText: false,
+            }
+        },
+        NationalWeatherServiceSettings: {
+            CallbackInterval: 15,
+            EventsEndpoint: `https://api.weather.gov/alerts/active`,
         },
-        eas_settings: {
-            directory: null,
-            intro_wav: null,
+        GlobalSettings: {
+            BetterEventNames: true,
+            DisableGeometryParsing: false,
+            UseShapefileCoordinates: false,
+            ShapefileSkipPoints: 15,
+            NodeTTL: 60,
+            NodeMinDistance: 120,
+            EventFiltering: {
+                ListeningEvents: [],
+                ListeningICAO: [],
+                IgnoredICAO: [],
+                IgnoredEvents: [`Xx`, `Test Message`],
+                ListeningUGC: [],
+                ListeningStates: [],
+                NodeLocationFiltering: false,
+                IgnoreTestProducts: true,
+            },
+            EASSettings: {
+                ArchiveDirectory: null,
+                IntroWavFile: null,
+            }
         }
-    }
-};
+    },
+}
+
 
 
-export const definitions = {
-    events: dictEvents.events,
-    actions: dictEvents.actions,
-    status: dictEvents.status,
-    productTypes: dictEvents.types,
-    correlations: dictEvents.status_correlations,
-    offshore: dictEvents.offshore,
-    awips: dictAwips.awips,
-    causes: dictEvents.causes,
-    records: dictEvents.records,
-    severity: dictEvents.severity,
-    cancelSignatures: dictSignatures.cancel_signatures,
-    messageSignatures: dictSignatures.message_signatures,
-    tags: dictSignatures.tags,
-    ICAO: dictICAOs.icaos,
-    enhancedEvents: [
-        {"Tornado Warning": {
-            "Tornado Emergency": { description: "tornado emergency", condition: (tornadoThreatTag: string) => tornadoThreatTag === 'OBSERVED'},
-            "PDS Tornado Warning": { description: "particularly dangerous situation", condition: (damageThreatTag: string) => damageThreatTag === 'CONSIDERABLE'},
-            "Confirmed Tornado Warning": { condition: (tornadoThreatTag: string) => tornadoThreatTag === 'OBSERVED'},
-            "Radar Indicated Tornado Warning": {condition: (tornadoThreatTag: string) => tornadoThreatTag !== 'OBSERVED'},
-        }},
-        {"Special Marine Warning": {
-            "Tornadic Special Marine Warning": {condition: (tornadoThreatTag: string) => tornadoThreatTag === 'POSSIBLE'},
-        }},
-        {"Tornado Watch": {
-            "PDS Tornado Watch": { description: "particularly dangerous situation"}
-        }},
-        {"Flash Flood Warning": {
-            "Flash Flood Emergency": { description: "flash flood emergency", },
-            "Considerable Flash Flood Warning": { condition: (damageThreatTag: string) => damageThreatTag === 'CONSIDERABLE' },
-        }},
-        {"Severe Thunderstorm Warning": {
-            "EDS Severe Thunderstorm Warning": {description: "extremely dangerous situation"},
-            "Destructive Severe Thunderstorm Warning": {condition: (damageThreatTag: string) => damageThreatTag === 'DESTRUCTIVE'},
-            "Considerable Severe Thunderstorm Warning": {condition: (damageThreatTag: string) => damageThreatTag === 'CONSIDERABLE'},
-        }},
-    ],
-    shapefiles_directory: [
-        {name: "us_counties", id: "C", link: "https://www.weather.gov/source/gis/Shapefiles/County/c_16ap26.zip"},
-        {name: "us_states_territories", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/County/s_16ap26.zip"},
-        {name: "fire_weather_zones", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/fz16ap26.zip"},
-        {name: "costal_marine_zones", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/mz16ap26.zip"},
-        {name: "offshore_marine_zones", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/oz16ap26.zip"},
-        {name: "public_forecast_zones", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/z_16ap26.zip"},
-        {name: "county_warning_areas", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/w_16ap26.zip"},
-        {name: "river_forecast_boundaries", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/Misc/rf05mr24.zip"},
-        {name: "high_seas_marine_zones", id: "Z", link: "https://www.weather.gov/source/gis/Shapefiles/WSOM/hz17fe26.zip"}
-    ],
-    regular_expressions: {
-        pvtec: new RegExp(`[OTEX].(NEW|CON|EXT|EXA|EXB|UPG|CAN|EXP|COR|ROU).[A-Z]{4}.[A-Z]{2}.[WAYSFON].[0-9]{4}.[0-9]{6}T[0-9]{4}Z-[0-9]{6}T[0-9]{4}Z`, "g"),
-        hvtec: new RegExp(`[a-zA-Z0-9]{4}.[A-Z0-9].[A-Z]{2}.[0-9]{6}T[0-9]{4}Z.[0-9]{6}T[0-9]{4}Z.[0-9]{6}T[0-9]{4}Z.[A-Z]{2}`, "imu"),
-        wmo: new RegExp(`[A-Z0-9]{6}\\s[A-Z]{4}\\s\\d{6}`, "imu"),
-        ugc1: new RegExp(`(\\w{2}[CZ](\\d{3}((-|>)\\s?(\\n\\n)?))+)`, "imu"),
-        ugc2: new RegExp(`(\\d{6}(-|>)\\s?(\\n\\n)?)`, "imu"),
-        ugc3: new RegExp(`(\\d{6})(?=-|$)`, "imu"),
-        dateline: new RegExp(`\\d{3,4}\\s*(AM|PM)?\\s*[A-Z]{2,4}\\s+[A-Z]{3,}\\s+[A-Z]{3,}\\s+\\d{1,2}\\s+\\d{4}`, "gim"),
-    },
-    messages: {
-        shapefile_creation: `DO NOT EXIT UNTIL THE SHAPEFILES ARE DONE COMPLETING! IF YOU CLOSE YOUR PROJECT, THE SHAPEFILES WILL NOT BE CREATED AND YOU WILL NEED TO DELETE ${settings.database} AND RESTART TO CREATE THEM AGAIN!`,
-        shapefile_creation_finished: `Shapefiles have finished completing and you can now use the parser.`,
-        not_ready: `You can not create another instance without shutting down the current one first, please make sure to call the stop() method first!`,
-        invalid_nickname: `The nickname you provided is invalid, please provide a valid nickname to continue.`,
-        eas_no_directory: `You have not set a directory for EAS audio files to be saved to, please set the 'directory' setting in the global settings to enable EAS audio generation.`,
-        reconnect_too_fast: `The client is attempting to reconnect too fast. This may be due to network instability. Reconnection attempt has been halted for safety.`,
-        dump_cache: `Found {count} cached events and will begin dumping them shortly. This may take a while depending on the number of cached events.`,
-        dump_cache_complete: `Completed dumping all cached alert files.`,
-    }
-};