atmosx-nwws-parser 1.0.156 → 1.0.181

package/README.md

@@ -12,7 +12,7 @@ npm install atmosx-nwws-parser
 
 ## Usage
 ```js
-const AtmosXWireParser = require(`atmosx-nwws-parser`); // or require(`@k3y0mi/nwws-parser`);
+const AtmosXWireParser = require(`atmosx-nwws-parser`);
 ```
 
 ## Configuration and Initialization
@@ -25,6 +25,8 @@ let Client = new AtmosXWireParser({
         onlyCap: false, // Set to true to only receive CAP messages only
         betterEvents: true, // Set to true to receive better event handling
         ugcPolygons: false, // Set to true to receive UGC Polygons instead of reading from raw products. 
+        expiryCheck: true, // Set to true to check for expired alerts and remove them from the list
+        filteredAlerts: [] // Alerts you want to only log, leave empty to receive all alerts (Ex. ["Tornado Warning", "Radar Indicated Tornado Warning"])
     },
     xmpp: {
         reconnect: true, // Set to true to enable automatic reconnection if you lose connection
@@ -32,6 +34,7 @@ let Client = new AtmosXWireParser({
     },
     cacheSettings: {
         maxMegabytes: 2, // Maximum cache size in megabytes
+        readCache: false, // Set to true if you wish to reupload the cache from earlier (Now supports reading from CAP, SPS, and Alerts)
         cacheDir: `./cache`, // Directory for cache files
     },
     authentication: {

package/bootstrap.js

@@ -78,6 +78,7 @@ module.exports.definitions = {
         { 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 = { 
@@ -85,12 +86,15 @@ module.exports.settings = {
         ugcPolygons: false,
         onlyCap: false,
         betterEvents: false,
+        expiryCheck: true,
+        filteredAlerts: [],
     },
     xmpp: {
         reconnect: true,
         reconnectInterval: 60,
     },
     cacheSettings: {
+        readCache: false,
         maxMegabytes: 1,
         cacheDir: false,
     },

package/index.js

@@ -14,7 +14,6 @@
 let loader = require(`./bootstrap.js`);
 
 class NoaaWeatherWireServiceCore { 
-
     constructor(metadata={}) {
         this.packages = loader.packages;
         this.metadata = metadata;
@@ -25,6 +24,30 @@ class NoaaWeatherWireServiceCore {
             loader.static.events.emit(`onError`, { error: error.stack || error.message || `An unknown error occurred`, code: `uncaught-exception` });
         });
         this.initializeDatabase([{ id: `C`, file: `USCounties` }, { id: `Z`, file: `ForecastZones` }, { id: `Z`, file: `FireZones` }, { id: `Z`, file: `OffShoreZones` }, { id: `Z`, file: `FireCounties` }, { id: `Z`, file: `Marine` }]);
+        
+        if (loader.settings.cacheSettings.readCache && loader.settings.cacheSettings.cacheDir) {
+            let target = `${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-defaults-raw-vtec.bin`;
+            let targetCap = `${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-defaults-cap-vtec.bin`;
+            let targetStatements = `${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-special-weather-statements-raw.bin`;
+            let targetMesoscale = `${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-mesoscale-discussions-raw.bin`;
+            let targetStormReports = `${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-local-storm-reports-raw.bin`;
+            if (loader.packages.fs.existsSync(target) && !loader.settings.alertSettings.onlyCap) {
+                this.forwardCustomStanza(loader.packages.fs.readFileSync(target, 'utf8'), { awipsid: 'alert', isCap: false, raw: true, issue: undefined });
+            }
+            if (loader.packages.fs.existsSync(targetCap) && loader.settings.alertSettings.onlyCap) {
+                this.forwardCustomStanza(loader.packages.fs.readFileSync(targetCap, 'utf8'), { awipsid: 'alert', isCap: true, raw: false, issue: undefined });
+            }
+            if (loader.packages.fs.existsSync(targetStatements)) {
+                this.forwardCustomStanza(loader.packages.fs.readFileSync(targetStatements, 'utf8'), { awipsid: 'SPS001', isCap: false, raw: true, issue: undefined });
+            }
+            if (loader.packages.fs.existsSync(targetMesoscale)) {
+                this.forwardCustomStanza(loader.packages.fs.readFileSync(targetMesoscale, 'utf8'), { awipsid: 'SWOMCD001', isCap: false, raw: true, issue: undefined });
+            }
+            if (loader.packages.fs.existsSync(targetStormReports)) {
+                this.forwardCustomStanza(loader.packages.fs.readFileSync(targetStormReports, 'utf8'), { awipsid: 'LSR001', isCap: false, raw: true, issue: undefined });
+            }
+        }
+        
         setInterval(() => { 
             if (loader.settings.cacheSettings.cacheDir) { this.garbageCollect(loader.settings.cacheSettings.maxMegabytes || 1); }
             if (loader.settings.xmpp.reconnect) { this.isReconnectEligible(loader.settings.xmpp.reconnectInterval) }
@@ -94,7 +117,7 @@ class NoaaWeatherWireServiceCore {
             domain: `nwws-oi.weather.gov`, 
             username: metadata.username || ``,
             password: metadata.password || ``,
-        }).setMaxListeners(0);
+        })
     }
 
     /**
@@ -107,6 +130,14 @@ class NoaaWeatherWireServiceCore {
         if (this.metadata.authentication.display == undefined) this.metadata.authentication.display = this.metadata.authentication.username || ``;
         this.initializeClient({ username: this.metadata.authentication.username, password: this.metadata.authentication.password, display: this.metadata.authentication.display });
         loader.static.session.on(`online`, async () => {
+            if (loader.static.lastConnect && (new Date().getTime() - loader.static.lastConnect) < 10 * 1000) {
+                setTimeout(async () => {
+                    await loader.static.session.stop().catch(() => {});
+                    await loader.static.session.start().catch(() => {});
+                }, 2 * 1000);
+                throw new Error(`rapid-reconnect`);
+            }
+            loader.static.lastConnect = new Date().getTime();
             loader.cache.isConnected = true;
             loader.static.session.send(loader.packages.xmpp.xml('presence', { to: `nwws@conference.nwws-oi.weather.gov/${this.metadata.authentication.display}`, xmlns: 'http://jabber.org/protocol/muc' }))
             loader.static.session.send(loader.packages.xmpp.xml('presence', { to: `nwws@conference.nwws-oi.weather.gov`, type: 'available' }))
@@ -116,9 +147,11 @@ class NoaaWeatherWireServiceCore {
             }
         })
         loader.static.session.on(`offline`, () => {
+            loader.static.session.stop().catch(() => {});
+            loader.cache.isConnected = false;
             throw new Error(`unreachable-host`);
         })
-        loader.static.session.on(`error`, (error) => {
+        loader.static.session.on(`error`, async (error) => {
             throw new Error(error.message || `service-error`);
         })
         loader.static.session.on(`stanza`, (stanza) => {
@@ -220,7 +253,7 @@ class NoaaWeatherWireServiceCore {
       */
 
     onEvent = function(event, listener) {
-        loader.static.events.on(event, listener);
+        loader.static.events.on(event, listener)
         return () => { loader.static.events.off(event, listener); };
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "atmosx-nwws-parser",
-  "version": "1.0.156",
+  "version": "1.0.181",
   "description": "NOAA Weather Wire Parser",
   "main": "index.js",
   "scripts": {

package/src/events.js

@@ -26,11 +26,14 @@ class NoaaWeatherWireServiceEvents {
         let tags = [`No tags found`];
         let eventName = event.properties.event
         let dmgTheat = event.properties.parameters.thunderstormDamageThreat?.[0] || event.properties.parameters.tornadoDamageThreat?.[0] || `N/A`;
+        let torThreat = event.properties.parameters.tornadoDetection || `N/A`;
         let description = event.properties.description.toLowerCase() || `No description available.`;
         if (description.includes(`flash flood emergency`) && eventName == `Flash Flood Warning`) eventName = `Flash Flood Emergency`;
-        if (description.includes(`particularly dangerous situation`) && eventName == `Tornado Warning` && dmgTheat == `CONSIDERABLE`) eventName = `Particularly Dangerous Situation Tornado Warning`;
-        if (description.includes(`particularly dangerous situation`) && eventName == `Tornado Watch`) eventName = `Particularly Dangerous Situation Tornado Watch`;
+        if (description.includes(`particularly dangerous situation`) && eventName == `Tornado Warning` && dmgTheat == `CONSIDERABLE`) eventName = `PDS Tornado Warning`;
+        if (description.includes(`particularly dangerous situation`) && eventName == `Tornado Watch`) eventName = `PDS Tornado Watch`;
+        if (description.includes(`extremely dangerous situation`) && eventName == `Severe Thunderstorm Warning`) eventName = `EDS Severe Thunderstorm Warning`;
         if (description.includes(`tornado emergency`) && eventName == `Tornado Warning` && dmgTheat == `CATASTROPHIC`) eventName = `Tornado Emergency`;
+
         if (eventName == `Tornado Warning`) {
             eventName = `Radar Indicated Tornado Warning`;
             if (event.properties.parameters.tornadoDetection == `RADAR INDICATED`) eventName = `Radar Indicated Tornado Warning`;
@@ -39,6 +42,10 @@ class NoaaWeatherWireServiceEvents {
         if (eventName == `Severe Thunderstorm Warning`) {
             if (dmgTheat == `CONSIDERABLE`) eventName = `Considerable Severe Thunderstorm Warning`;
             if (dmgTheat == `DESTRUCTIVE`) eventName = `Destructive Severe Thunderstorm Warning`;
+            if (torThreat == `POSSIBLE`) eventName = `${eventName} (TPROB)`;
+        }
+        if (eventName == `Flash Flood Warning`) {
+            if (dmgTheat == `CONSIDERABLE`) eventName = `Considerable Flash Flood Warning`;
         }
         for (let [key, value] of Object.entries(loader.definitions.tags)) {
             if (event.properties.description.toLowerCase().includes(key.toLowerCase())) {
@@ -64,6 +71,15 @@ class NoaaWeatherWireServiceEvents {
                 alerts[i].properties.tags = tags;
             }
         }
+        if (loader.settings.alertSettings.filteredAlerts && loader.settings.alertSettings.filteredAlerts.length > 0) {
+            let pSet = new Set((loader.settings.alertSettings.filteredAlerts || []).map(p => String(p).toLowerCase()));
+            alerts = alerts.filter(alert => pSet.has(String(alert.properties?.event || '').toLowerCase()));
+        }
+        if (loader.settings.alertSettings.expiryCheck) {
+            alerts = alerts.filter(alert => 
+                new Date(alert.properties.expires) > new Date()
+            );
+        }
         if (alerts.length === 0) { return; }
         loader.static.events.emit(`onAlert`, alerts);
     }
@@ -76,47 +92,52 @@ class NoaaWeatherWireServiceEvents {
       */
     
     newCapEvent = async function(stanza) { 
-        let message = stanza.message.substring(stanza.message.indexOf(`<?xml version="1.0"`), stanza.message.length);
-        let data = loader.packages.xml2js.Parser();
-        let result = await data.parseStringPromise(message);
-        let tracking = result.alert.info[0].parameter.find(p => p.valueName[0] == "VTEC")?.value[0] || "N/A";
-        let action = "N/A";
-        if (tracking !== "N/A") {
-            let splitVTEC = tracking.split(".");
-            tracking = `${splitVTEC[2]}-${splitVTEC[3]}-${splitVTEC[4]}-${splitVTEC[5]}`;
-            action = loader.definitions.status[splitVTEC[1]];
-        } else {
-            action = result.alert.msgType[0];
-            tracking = `${result.alert.info[0].parameter.find(p => p.valueName[0] == "WMOidentifier")?.value[0]}-${result.alert.info[0].area[0].geocode.filter(g => g.valueName[0] == "UGC").map(g => g.value[0]).join("-")}`;
-        }
-        let alert = {
-            id: `Wire-${tracking}`,
-            tracking: tracking,
-            action: action,
-            history: [{ description: result.alert.info[0].description[0], action: action, issued: new Date(stanza.attributes.issue) }],
-            properties: {
-                areaDesc: result.alert.info[0].area[0].areaDesc[0],
-                expires: new Date(result.alert.info[0].expires[0]),
-                sent: new Date(result.alert.sent[0]),
-                messageType: action,
-                event: result.alert.info[0].event[0],
-                sender: result.alert.sender[0],
-                senderName: result.alert.info[0].senderName[0],
-                description: result.alert.info[0].description[0],
-                geocode: { UGC: result.alert.info[0].area[0].geocode.filter(g => g.valueName[0] == "UGC").map(g => g.value[0]) },
-                parameters: {
-                    WMOidentifier: [result.alert.info[0].parameter.find(p => p.valueName[0] == "WMOidentifier")?.value[0] || "N/A"],
-                    tornadoDetection: result.alert.info[0].parameter.find(p => p.valueName[0] == "tornadoDetection")?.value[0] || result.alert.info[0].parameter.find(p => p.valueName[0] == "waterspoutDetection")?.value[0] || "N/A",
-                    maxHailSize: result.alert.info[0].parameter.find(p => p.valueName[0] == "maxHailSize")?.value[0] || "N/A",
-                    maxWindGust: result.alert.info[0].parameter.find(p => p.valueName[0] == "maxWindGust")?.value[0] || "N/A",
-                    thunderstormDamageThreat: [result.alert.info[0].parameter.find(p => p.valueName[0] == "thunderstormDamageThreat")?.value[0] || result.alert.info[0].parameter.find(p => p.valueName[0] == "tornadoDamageThreat")?.value[0] || "N/A"],
+        let message = stanza.message.match(/<\?xml[\s\S]*?<\/alert>/g) ?.map(xml => xml.trim()) || [];
+        let alerts = []
+        for (let msg of message) {
+            msg = msg.substring(msg.indexOf(`<?xml version="1.0"`), msg.lastIndexOf(`>`) + 1);
+            let data = loader.packages.xml2js.Parser();
+            let result = await data.parseStringPromise(msg);
+            let tracking = result.alert.info[0].parameter.find(p => p.valueName[0] == "VTEC")?.value[0] || "N/A";
+            let action = "N/A";
+            if (tracking !== "N/A") {
+                let splitVTEC = tracking.split(".");
+                tracking = `${splitVTEC[2]}-${splitVTEC[3]}-${splitVTEC[4]}-${splitVTEC[5]}`;
+                action = loader.definitions.status[splitVTEC[1]];
+            } else {
+                action = result.alert.msgType[0];
+                tracking = `${result.alert.info[0].parameter.find(p => p.valueName[0] == "WMOidentifier")?.value[0]}-${result.alert.info[0].area[0].geocode.filter(g => g.valueName[0] == "UGC").map(g => g.value[0]).join("-")}`;
+            }
+            let alert = {
+                id: `Wire-${tracking}`,
+                tracking: tracking,
+                action: action,
+                history: [{ description: result.alert.info[0].description[0], action: action, issued: new Date(stanza.attributes.issue) }],
+                properties: {
+                    areaDesc: result.alert.info[0].area[0].areaDesc[0],
+                    expires: new Date(result.alert.info[0].expires[0]),
+                    sent: new Date(result.alert.sent[0]),
+                    messageType: action,
+                    event: result.alert.info[0].event[0],
+                    sender: result.alert.sender[0],
+                    senderName: result.alert.info[0].senderName[0],
+                    description: result.alert.info[0].description[0],
+                    geocode: { UGC: result.alert.info[0].area[0].geocode.filter(g => g.valueName[0] == "UGC").map(g => g.value[0]) },
+                    parameters: {
+                        WMOidentifier: [result.alert.info[0].parameter.find(p => p.valueName[0] == "WMOidentifier")?.value[0] || "N/A"],
+                        tornadoDetection: result.alert.info[0].parameter.find(p => p.valueName[0] == "tornadoDetection")?.value[0] || result.alert.info[0].parameter.find(p => p.valueName[0] == "waterspoutDetection")?.value[0] || "N/A",
+                        maxHailSize: result.alert.info[0].parameter.find(p => p.valueName[0] == "maxHailSize")?.value[0] || "N/A",
+                        maxWindGust: result.alert.info[0].parameter.find(p => p.valueName[0] == "maxWindGust")?.value[0] || "N/A",
+                        thunderstormDamageThreat: [result.alert.info[0].parameter.find(p => p.valueName[0] == "thunderstormDamageThreat")?.value[0] || result.alert.info[0].parameter.find(p => p.valueName[0] == "tornadoDamageThreat")?.value[0] || "N/A"],
+                    },
                 },
-            },
-        };
-        if (result.alert.info[0].area[0].polygon) {
-            alert.geometry = { type: "Polygon", coordinates: [result.alert.info[0].area[0].polygon[0].split(" ").map(coord => { let [lat, lon] = coord.split(",").map(parseFloat); return [lon, lat]; })] };
+            };
+            if (result.alert.info[0].area[0].polygon) {
+                alert.geometry = { type: "Polygon", coordinates: [result.alert.info[0].area[0].polygon[0].split(" ").map(coord => { let [lat, lon] = coord.split(",").map(parseFloat); return [lon, lat]; })] };
+            }
+            alerts.push(alert);
         }
-        this.onFinished([alert]);
+        this.onFinished(alerts);
     }
 
     /**
@@ -142,6 +163,7 @@ class NoaaWeatherWireServiceEvents {
                     let getHail = loader.packages.mText.getString(msg, `MAX HAIL SIZE...`, [`IN`]) || loader.packages.mText.getString(msg, `HAIL...`, [`IN`]);
                     let getGusts = loader.packages.mText.getString(msg, `MAX WIND GUST...`) || loader.packages.mText.getString(msg, `WIND...`);
                     let getThreat = loader.packages.mText.getString(msg, `DAMAGE THREAT...`);
+                    let getTempIssue = loader.packages.mText.getString(msg, `ISSUED TIME...`);
                     let senderOffice = loader.packages.mText.getOffice(msg) || vtec.tracking.split(`-`)[0];
                     let getCoordinates = loader.packages.mText.getPolygonCoordinates(msg);
                     let getDescription = loader.packages.mText.getCleanDescription(msg, vtec);
@@ -153,8 +175,8 @@ class NoaaWeatherWireServiceEvents {
                         history: [{description: getDescription, action: vtec.status, issued: new Date(vtec.issued)}],
                         properties: {
                             areaDesc: mUgc.locations.join(`; `) || `N/A`,
-                            expires: new Date(vtec.expires) == `Invalid Date` ? new Date(new Date().getTime() + 999999 * 60 * 60 * 1000) : new Date(vtec.expires),
-                            sent: new Date(vtec.issued),
+                            expires: new Date(vtec.expires) == `Invalid Date` ? new Date(9999, 0, 1) : new Date(vtec.expires),
+                            sent: new Date(vtec.issued) == `Invalid Date` ? getTempIssue ? new Date(getTempIssue) : new Date(vtec.issued) : new Date(vtec.issued),
                             messageType: vtec.status, 
                             event: vtec.event || `Unknown Event`,
                             sender: senderOffice,

package/src/stanza.js

@@ -28,7 +28,7 @@ class NoaaWeatherWireServiceStanza {
             if (isDebug != false) {
                 let message = isDebug.stanza
                 let attributes = isDebug.attrs;
-                let isCap = message.includes(`<?xml version="1.0"`)
+                let isCap = isDebug.isCap || message.includes(`<?xml version="1.0"`);
                 let hasCapArea = message.includes(`<areaDesc>`);
                 let hasVtec = message.match(loader.definitions.expressions.vtec) != null;
                 let getId = this.getAwipsType(attributes)
@@ -96,7 +96,7 @@ class NoaaWeatherWireServiceStanza {
 
     saveCache = function(message, attributes, type, isCap, isVtec) {
         if (!loader.settings.cacheSettings.cacheDir) return;
-        loader.packages.fs.appendFileSync(`${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-${type}s-${isCap ? 'cap' : 'raw'}${isVtec ? '-vtec' : ''}.bin`, `=================================================\n${new Date().toISOString().replace(/[:.]/g, '-')}\n\n[${JSON.stringify(attributes)}]\n=================================================\n\n${message}\n\n`, `utf8`);
+        loader.packages.fs.appendFileSync(`${loader.settings.cacheSettings.cacheDir}/nwws-raw-category-${type}s-${isCap ? 'cap' : 'raw'}${isVtec ? '-vtec' : ''}.bin`, `=================================================\n${new Date().toISOString().replace(/[:.]/g, '-')}\n=================================================\n\n${message}\nISSUED TIME...${new Date(attributes.issue).toISOString()}\n\n`, 'utf8');
     }
 }
 

package/src/vtec.js

@@ -35,7 +35,7 @@ class NoaaWeatherWireServiceVtec {
 				status: this.getEventStatus(splitVTEC),
 				wmo: message.match(new RegExp(loader.definitions.expressions.wmo, 'gimu')),
 				expires: this.getExpires(vtecDates),
-				issued: attributes.issue
+				issued: attributes.issue 
 			};
 		});
       	return vtecs;

package/test.js

@@ -5,6 +5,8 @@ let Client = new AtmosXWireParser({
         onlyCap: false, // Set to true to only receive CAP messages only
         betterEvents: true, // Set to true to receive better event handling
         ugcPolygons: false, // Set to true to receive UGC Polygons instead of reading from raw products. 
+        expiryCheck: true, // Set to true to filter out expired alerts
+        filteredAlerts: [] // Alerts you want to only log, leave empty to receive all alerts (Ex. ["Tornado Warning", "Radar Indicated Tornado Warning"])
     },
     xmpp: {
         reconnect: true, // Set to true to enable automatic reconnection if you lose connection
@@ -13,6 +15,7 @@ let Client = new AtmosXWireParser({
     cacheSettings: {
         maxMegabytes: 2, // Maximum cache size in megabytes
         cacheDir: `./cache`, // Directory for cache files
+        readCache: false, // Set to true if you wish to reupload the cache from earlier
     },
     authentication: {
         username: `USERNAME_HERE`, // Your XMPP username