atmosx-nwws-parser 1.0.185 → 1.0.191

package/README.md

@@ -12,7 +12,8 @@ npm install atmosx-nwws-parser
 
 ## Usage
 ```js
-const AtmosXWireParser = require(`atmosx-nwws-parser`);
+const AtmosXWireParser = require(`atmosx-nwws-parser`); // CJS 
+import * as AtmosXWireParser from `atmosx-nwws-parser`; // ESM
 ```
 
 ## Configuration and Initialization
@@ -20,7 +21,7 @@ const AtmosXWireParser = require(`atmosx-nwws-parser`);
 There are several settings you can configure when intializing the parser. Below is the test.js example that shows some of the settings you can use:
 
 ```js
-let Client = new AtmosXWireParser({
+let Client = new AtmosXWireParser.Parser({
     alertSettings: { 
         onlyCap: false, // Set to true to only receive CAP messages only
         betterEvents: true, // Set to true to receive better event handling
@@ -64,26 +65,26 @@ Client.onEvent(`onReconnect`, (service: Object) => {});
 
 ## Functions and Methods
 You can also use various functions provided by the parser. Here are some examples:
-```js
-// Debugging function to create your own alert manually
-Client.forwardCustomStanza(stanza: String, attributes: Object);
-```
 
 ```js
 // Function to set the display name of the XMPP client (Will only set upon reconnect)
 Client.setDisplayName(displayName: String);
 ```
 
+```js
+// Function to manually trigger the cache initialization (Usually called automatically on startup if readCache is true)
+Client.initalizeCache() 
+```
+
 ## Error Handling
 The parser can emit various errors. Here are some common errors you might encounter:
 
-**not-authorized**: This error occurs when the parser is not authorized to connect to the XMPP server. Ensure that your username and password are correct.
+**error-database-not-configured**: This error occurs when the database is not configured properly. Please set the database path in the constructor.
 
-**unreachable-host**: This error indicates that the parser cannot reach the XMPP server. Check your internet connection and ensure that the server address is correct.
+**error-reconnecting-too-fast**: This error occurs when the client is attempting to reconnect too fast. Please wait a few seconds before trying again.
 
-**service-error**: This error occurs when there is an issue with the XMPP service. It could be due to server maintenance or other issues. You can try reconnecting after some time.
+**error-connection-lost**: This error occurs when the connection to the XMPP server has been lost. Please try reconnecting manually as the automatic reconnect feature is not setup for offline halt conditions.
 
-**no-database-dir**: This error occurs when the database directory does not exist. Ensure that the directory specified in the `database` setting exists or create it before running the parser.
 
 ## Credits
 This parser is developed and maintained by [K3YOMI](https://github.com/K3YOMI) and the AtmosphericX Team. It is open-source and available for contributions and improvements. If you find any issues or have suggestions, feel free to open an issue or submit a pull request in the repository.

package/{bootstrap.js → bootstrap.ts}

@@ -1,32 +1,69 @@
-module.exports = {
-    cache: {},
-    settings: {},
-    static: {},
-    packages: {},
-    definitions: {}
-}
+/*
+                                            _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                                 
+                                     |_|                                                                                                                
+    
+    Written by: k3yomi@GitHub                        
+*/
 
-module.exports.packages = {
-    fs: require(`fs`),
-    path: require(`path`),
-    events: require(`events`),
-    xmpp: require(`@xmpp/client`),
-    shapefile: require(`shapefile`),
-    xml2js: require(`xml2js`),
-    sqlite3: require(`better-sqlite3`),
-    mStanza: require(`./src/stanza.js`),
-    mVtec: require(`./src/vtec.js`),
-    mUGC: require(`./src/ugc.js`),
-    mText: require(`./src/text.js`),
-    mEvents: require(`./src/events.js`),
 
-}
+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 sqlite3 from 'better-sqlite3';
 
-module.exports.definitions = {
+
+export const packages = {fs, path, events, xmpp, shapefile, xml2js, sqlite3 };
+
+export const statics = {
+    events: new events.EventEmitter(),
+    session: null as any,
+    db: null as any,
+};
+
+export const cache = {
+    lastStanza: Date.now(),
+    session: null as any,
+    lastConnect: null as any,
+    sigHault: false,
+    isConnected: false,
+    attemptingReconnect: false,
+    totalReconnects: 0
+};
+
+export const settings = {
+    alertSettings: {
+        ugcPolygons: false,
+        onlyCap: false,
+        betterEvents: false,
+        expiryCheck: true,
+        filteredAlerts: [],
+    },
+    xmpp: {
+        reconnect: true,
+        reconnectInterval: 60,
+    },
+    cacheSettings: {
+        readCache: false,
+        maxMegabytes: 1,
+        cacheDir: null,
+    },
+    database: path.join(process.cwd(), 'shapefiles.db'),
+};
+
+export const definitions = {
     events: { "AF": "Ashfall", "AS": "Air Stagnation", "BH": "Beach Hazard", "BW": "Brisk Wind", "BZ": "Blizzard", "CF": "Coastal Flood", "DF": "Debris Flow", "DS": "Dust Storm", "EC": "Extreme Cold", "EH": "Excessive Heat", "XH": "Extreme Heat", "EW": "Extreme Wind", "FA": "Areal Flood", "FF": "Flash Flood", "FG": "Dense Fog", "FL": "Flood", "FR": "Frost", "FW": "Fire Weather", "FZ": "Freeze", "GL": "Gale", "HF": "Hurricane Force Wind", "HT": "Heat", "HU": "Hurricane", "HW": "High Wind", "HY": "Hydrologic", "HZ": "Hard Freeze", "IS": "Ice Storm", "LE": "Lake Effect Snow", "LO": "Low Water", "LS": "Lakeshore Flood", "LW": "Lake Wind", "MA": "Special Marine", "MF": "Dense Fog", "MH": "Ashfall", "MS": "Dense Smoke", "RB": "Small Craft for Rough Bar", "RP": "Rip Current Risk", "SC": "Small Craft", "SE": "Hazardous Seas", "SI": "Small Craft for Winds", "SM": "Dense Smoke", "SQ": "Snow Squall", "SR": "Storm", "SS": "Storm Surge", "SU": "High Surf", "SV": "Severe Thunderstorm", "SW": "Small Craft for Hazardous Seas", "TO": "Tornado", "TR": "Tropical Storm", "TS": "Tsunami", "TY": "Typhoon", "UP": "Heavy Freezing Spray", "WC": "Wind Chill", "WI": "Wind", "WS": "Winter Storm", "WW": "Winter Weather", "ZF": "Freezing Fog", "ZR": "Freezing Rain", "ZY": "Freezing Spray" },
     actions: { "W": "Warning", "F": "Forecast", "A": "Watch", "O": "Outlook", "Y": "Advisory", "N": "Synopsis", "S": "Statement"},
     status: { "NEW": "Issued", "CON": "Updated", "EXT": "Extended", "EXA": "Extended", "EXB": "Extended", "UPG": "Upgraded", "COR": "Correction", "ROU": "Routine", "CAN": "Cancelled", "EXP": "Expired" },
-    awips: { SWOMCD: `mesoscale-discussion`, LSR: `local-storm-report`, SPS: `special-weather-statement`, LSR: "local-storm-report"},
+    awips: { SWOMCD: `mesoscale-discussion`, LSR: `local-storm-report`, SPS: `special-weather-statement`},
     expressions: {
         vtec: `[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`,
         wmo: `[A-Z0-9]{6}\\s[A-Z]{4}\\s\\d{6}`,
@@ -74,39 +111,12 @@ module.exports.definitions = {
         "SOURCE...LAW ENFORCEMENT REPORTED.": "Confirmed by Law Enforcement"
     },
     haultingConditions: [
-        { error: "not-authorized", message: "You do not have the proper credentials to access this service.", code: "credential-error"},
-        { error: "unreachable-host", message: "The host could not be reached. Please check your internet connection or the host address.", code: "xmpp-error" },
-        { error: "service-error", message: "An error occurred while connecting to the NOAA Weather Wire Service. Please try again later.", code: "xmpp-error" },
-        { error: "no-database-dir", message: "Database directory is not set. Please set the databaseDir in the metadata.", code: "no-database" },
-        { error: "rapid-reconnect", message: "The client is reconnecting too rapidly. Please wait a moment before trying again.", code: "xmpp-error" }
-    ]
-}
-module.exports.settings = { 
-    alertSettings: {
-        ugcPolygons: false,
-        onlyCap: false,
-        betterEvents: false,
-        expiryCheck: true,
-        filteredAlerts: [],
-    },
-    xmpp: {
-        reconnect: true,
-        reconnectInterval: 60,
-    },
-    cacheSettings: {
-        readCache: false,
-        maxMegabytes: 1,
-        cacheDir: false,
-    },
-    database: module.exports.packages.path.join(process.cwd(), 'shapefiles.db'), 
+        { error: "error-database-not-configured", message: "The database is not configured properly. Please set the database path in the constructor." },
+        { error: "error-reconnecting-too-fast", message: "The client is attempting to reconnect too fast. Please wait a few seconds before trying again." },
+        { error: "error-connection-lost", message: "The connection to the XMPP server has been lost. Please try reconnecting manually as the automatic reconnect feature is not setup for offline hault conditions." },
+    ],
+    messages: {
+        shapefile_creation: `\n\n[NOTICE] DO NOT CLOSE THIS PROJECT UNTIL THE SHAPEFILES ARE DONE COMPLETING!\n\t THIS COULD TAKE A WHILE DEPENDING ON THE SPEED OF YOUR STORAGE!!\n\t 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!\n\n`,
+        shapefile_creation_finished: `\n\n[NOTICE] SHAPEFILES HAVE BEEN SUCCESSFULLY CREATED AND THE DATABASE IS READY FOR USE!\n\n`
+    }
 };
-module.exports.cache = { 
-    lastStanza: new Date().getTime(), 
-    session: null, 
-    sigHault: false,
-    isConnected: false, 
-    attemptingReconnect: false, 
-    totalReconnects: 0 
-};
-
-module.exports.static.events = new module.exports.packages.events.EventEmitter();

package/dist/bootstrap.js

@@ -0,0 +1,153 @@
+"use strict";
+/*
+                                            _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V /
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |
+                                     |_|
+    
+    Written by: k3yomi@GitHub
+*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.definitions = exports.settings = exports.cache = exports.statics = exports.packages = void 0;
+var fs = __importStar(require("fs"));
+var path = __importStar(require("path"));
+var events = __importStar(require("events"));
+var xmpp = __importStar(require("@xmpp/client"));
+var shapefile = __importStar(require("shapefile"));
+var xml2js = __importStar(require("xml2js"));
+var better_sqlite3_1 = __importDefault(require("better-sqlite3"));
+exports.packages = { fs: fs, path: path, events: events, xmpp: xmpp, shapefile: shapefile, xml2js: xml2js, sqlite3: better_sqlite3_1.default };
+exports.statics = {
+    events: new events.EventEmitter(),
+    session: null,
+    db: null,
+};
+exports.cache = {
+    lastStanza: Date.now(),
+    session: null,
+    lastConnect: null,
+    sigHault: false,
+    isConnected: false,
+    attemptingReconnect: false,
+    totalReconnects: 0
+};
+exports.settings = {
+    alertSettings: {
+        ugcPolygons: false,
+        onlyCap: false,
+        betterEvents: false,
+        expiryCheck: true,
+        filteredAlerts: [],
+    },
+    xmpp: {
+        reconnect: true,
+        reconnectInterval: 60,
+    },
+    cacheSettings: {
+        readCache: false,
+        maxMegabytes: 1,
+        cacheDir: null,
+    },
+    database: path.join(process.cwd(), 'shapefiles.db'),
+};
+exports.definitions = {
+    events: { "AF": "Ashfall", "AS": "Air Stagnation", "BH": "Beach Hazard", "BW": "Brisk Wind", "BZ": "Blizzard", "CF": "Coastal Flood", "DF": "Debris Flow", "DS": "Dust Storm", "EC": "Extreme Cold", "EH": "Excessive Heat", "XH": "Extreme Heat", "EW": "Extreme Wind", "FA": "Areal Flood", "FF": "Flash Flood", "FG": "Dense Fog", "FL": "Flood", "FR": "Frost", "FW": "Fire Weather", "FZ": "Freeze", "GL": "Gale", "HF": "Hurricane Force Wind", "HT": "Heat", "HU": "Hurricane", "HW": "High Wind", "HY": "Hydrologic", "HZ": "Hard Freeze", "IS": "Ice Storm", "LE": "Lake Effect Snow", "LO": "Low Water", "LS": "Lakeshore Flood", "LW": "Lake Wind", "MA": "Special Marine", "MF": "Dense Fog", "MH": "Ashfall", "MS": "Dense Smoke", "RB": "Small Craft for Rough Bar", "RP": "Rip Current Risk", "SC": "Small Craft", "SE": "Hazardous Seas", "SI": "Small Craft for Winds", "SM": "Dense Smoke", "SQ": "Snow Squall", "SR": "Storm", "SS": "Storm Surge", "SU": "High Surf", "SV": "Severe Thunderstorm", "SW": "Small Craft for Hazardous Seas", "TO": "Tornado", "TR": "Tropical Storm", "TS": "Tsunami", "TY": "Typhoon", "UP": "Heavy Freezing Spray", "WC": "Wind Chill", "WI": "Wind", "WS": "Winter Storm", "WW": "Winter Weather", "ZF": "Freezing Fog", "ZR": "Freezing Rain", "ZY": "Freezing Spray" },
+    actions: { "W": "Warning", "F": "Forecast", "A": "Watch", "O": "Outlook", "Y": "Advisory", "N": "Synopsis", "S": "Statement" },
+    status: { "NEW": "Issued", "CON": "Updated", "EXT": "Extended", "EXA": "Extended", "EXB": "Extended", "UPG": "Upgraded", "COR": "Correction", "ROU": "Routine", "CAN": "Cancelled", "EXP": "Expired" },
+    awips: { SWOMCD: "mesoscale-discussion", LSR: "local-storm-report", SPS: "special-weather-statement" },
+    expressions: {
+        vtec: "[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",
+        wmo: "[A-Z0-9]{6}\\s[A-Z]{4}\\s\\d{6}",
+        ugc1: "(\\w{2}[CZ](\\d{3}((-|>)\\s?(\n\n)?))+)",
+        ugc2: "(\\d{6}(-|>)\\s?(\n\n)?)",
+        dateline: "/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}"
+    },
+    tags: {
+        "A LARGE AND EXTREMELY DANGEROUS TORNADO": "Large and Dangerous Tornado",
+        "THIS IS A PARTICULARLY DANGEROUS SITUATION": "Particularly Dangerous Situation",
+        "RADAR INDICATED ROTATION": "Radar Indicated Tornado",
+        "WEATHER SPOTTERS CONFIRMED TORNADO": "Confirmed by Storm Spotters",
+        "A SEVERE THUNDERSTORM CAPABLE OF PRODUCING A TORNADO": "Developing Tornado",
+        "LAW ENFORCEMENT CONFIRMED TORNADO": "Reported by Law Enforcement",
+        "A TORNADO IS ON THE GROUND": "Confirmed Tornado",
+        "WEATHER SPOTTERS REPORTED FUNNEL CLOUD": "Confirmed Funnel Cloud by Storm Spotters",
+        "PUBLIC CONFIRMED TORNADO": "Public reports of Tornado",
+        "RADAR CONFIRMED": "Radar Confirmed",
+        "TORNADO WAS REPORTED BRIEFLY ON THE GROUND": "Tornado no longer on ground",
+        "SPOTTERS INDICATE THAT A FUNNEL CLOUD CONTINUES WITH THIS STORM": "Funnel Cloud Continues",
+        "A TORNADO MAY DEVELOP AT ANY TIME": "Potentional still exists for Tornado to form",
+        "LIFE-THREATENING SITUATION": "Life Threating Situation",
+        "COMPLETE DESTRUCTION IS POSSIBLE": "Extremly Damaging Tornado",
+        "POTENTIALLY DEADLY TORNADO": "Deadly Tornado",
+        "RADAR INDICATED": "Radar Indicated",
+        "HAIL DAMAGE TO VEHICLES IS EXPECTED": "Damaging to Vehicles",
+        "EXPECT WIND DAMAGE": "Wind Damage",
+        "FREQUENT LIGHTNING": "Frequent Lightning",
+        "PEOPLE AND ANIMALS OUTDOORS WILL BE INJURED": "Capable of Injuring People and Animals",
+        "TRAINED WEATHER SPOTTERS": "Confirmed by Storm Spotters",
+        "SOURCE...PUBLIC": "Confirmed by Public",
+        "SMALL CRAFT COULD BE DAMAGED": "Potential Damage to Small Craft",
+        "A TORNADO WATCH REMAINS IN EFFECT": "Active Tornado Watch",
+        "TENNIS BALL SIZE HAIL": "Tennis Ball Size Hail",
+        "BASEBALL SIZE HAIL": "Baseball Size Hail",
+        "GOLF BALL SIZE HAIL": "Golf Ball Size Hail",
+        "QUARTER SIZE HAIL": "Quarter Size Hail",
+        "PING PONG BALL SIZE HAIL": "Ping Pong Ball Size Hail",
+        "NICKEL SIZE HAIL": "Nickel Size Hail",
+        "DOPPLER RADAR.": "Confirmed by Radar",
+        "DOPPLER RADAR AND AUTOMATED GAUGES.": "Confirmed by Radar and Gauges",
+        "FLASH FLOODING CAUSED BY THUNDERSTORMS.": "Caused by Thunderstorm",
+        "SOURCE...EMERGENCY MANAGEMENT.": "Confirmed by Emergency Management",
+        "FLASH FLOODING CAUSED BY HEAVY RAIN.": "Caused by heavy rain",
+        "SOURCE...LAW ENFORCEMENT REPORTED.": "Confirmed by Law Enforcement"
+    },
+    haultingConditions: [
+        { error: "error-database-not-configured", message: "The database is not configured properly. Please set the database path in the constructor." },
+        { error: "error-reconnecting-too-fast", message: "The client is attempting to reconnect too fast. Please wait a few seconds before trying again." },
+        { error: "error-connection-lost", message: "The connection to the XMPP server has been lost. Please try reconnecting manually as the automatic reconnect feature is not setup for offline hault conditions." },
+    ],
+    messages: {
+        shapefile_creation: "\n\n[NOTICE] DO NOT CLOSE THIS PROJECT UNTIL THE SHAPEFILES ARE DONE COMPLETING!\n\t THIS COULD TAKE A WHILE DEPENDING ON THE SPEED OF YOUR STORAGE!!\n\t IF YOU CLOSE YOUR PROJECT, THE SHAPEFILES WILL NOT BE CREATED AND YOU WILL NEED TO DELETE ".concat(exports.settings.database, " AND RESTART TO CREATE THEM AGAIN!\n\n"),
+        shapefile_creation_finished: "\n\n[NOTICE] SHAPEFILES HAVE BEEN SUCCESSFULLY CREATED AND THE DATABASE IS READY FOR USE!\n\n"
+    }
+};