@atmosx/event-product-parser 3.0.44 → 3.0.46

package/README.md

@@ -51,14 +51,20 @@ const Client = new Manager({
         CallbackInterval: 30,
         EventsEndpoint: `https://api.weather.gov/alerts/active`,
     },
-    WebhookSettings: [
+    ListenerSettings: [
         {
-            webhook: "https://discord.com/api/webhooks/XXXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", 
-            title: "AtmosphericX - (@atmosx/event-product-parser)", 
-            message: ``, 
-            upload: true,
-            events: [`Severe Thunderstorm Warning`, `Radar Indicated Tornado Warning`, `*Warning`, `*Thunderstorm*`],
-            rate: 5,
+            events: [`*Thunderstorm Warning*`, `* Watch`],
+            webhook: {
+                enabled: true,
+                destination: "https://discord.com/api/XXXXXXXXXX/XXXXXXXXXXX",
+                title: "AtmosphericX - (Thunderstorm Warnings and Watches)",
+                message: "<@&XXXXXXXXXXXXXXXXXXXXX>",
+                ratelimit: 1
+            },
+            uploads: {
+                eas: true,
+                file: true
+            }
         }
     ],
     GlobalSettings: {
@@ -99,9 +105,11 @@ const Client = new Manager({
             NodeLocationFiltering: false,
             IgnoreTestProducts: true,
         },
-        EASSettings: {
-            ArchiveDirectory: null,
-            IntroWavFile: null,
+        ArchiveSettings: {
+            TTL: 600,
+            TextDirectory: `Storage/TextProducts`,
+            EasDirectory: `Storage/EasScenarios`,
+            EasToneout: `tone.wav`,
         }
     }
 })
@@ -121,14 +129,20 @@ const Client = new Manager({
 - **CallbackInterval**: The interval at which the parser will check for new alerts from the National Weather Service API.
 - **EventsEndpoint**: The URL that directs to the API.
 
-### WebhookSettings
-- **webhook**: The URL of the webhook you want to send messages to.
-- **title**: The title of the message you want to send.
-- **message**: The message content you want to send. You can use placeholders like `<@&role_id>` to mention roles in Discord.
-- **eas**: Whether to generate and upload an EAS audio file for the event.
-- **upload**: Whether to upload a JSON file as well with the message containing the event data.
-- **events**: An array of event types that will trigger the webhook when they are received by the parser. If this array is empty, the webhook will be triggered for all events.
-- **rate**: The rate limit in seconds for how often the webhook can be triggered. This is to prevent spamming the webhook with too many messages in a short period of time.
+### ListenerSettings
+- **events**: An array of event types that will trigger the listener when they are received by the parser. If this array is empty, the listener will be triggered for all events.
+
+#### Webhook
+- **enabled**: If the webhook is enabled or not
+- **destination**: Webhook URL
+- **title**: The title of the webhook
+- **message**: The message you'd like to use for the webhook
+- **ratelimit**: How many messages can it send before being ratelimited
+
+#### Uploads
+- **eas**: Whether to enable auto eas generated audio files
+- **file**: Wheather to generate text files
+
 
 ### GlobalSettings
 - **EventManagement**: Whether to enable the event management system which includes filtering, tracking nodes, and custom messages.
@@ -147,11 +161,10 @@ const Client = new Manager({
 - **ListeningStates**: States you'd like to listen to `(Ex. ["IL"])`
 - **NodeLocationFiltering**: If you want tracking nodes to filter out events based on radius. (Miles)\
 - **IgnoreTextProducts**: If you want to ignore test products and events.
-- **ArchiveTTL**: The time to live for archived events. After this time, the events will be automatically deleted from the eas archive.
-- **ArchiveDirectory**: The directory you'd like to store generated EAS audio files.
-- **IntroWavFile**: The PCM16 bit WAV audio file to append to the EAS message.
-
-
+- **TTL**: How long files live for before getting automatically deleted
+- **TextDirectory**: The location to store text products that are generated.
+- **EasDirectory**: The location to store audio eas files that are generated.
+- **EasToneout**: The toneout prefix to use for generated eas messages.
 
 ## Events and Listeners
 
@@ -322,6 +335,24 @@ const nodes = getNodes()
 console.log(nodes)
 ```
 
+### Function `createEvent`
+Creates a new event in the parser.
+```ts
+import { createEvent } from "@atmosx/event-product-parser"
+createEvent({
+    event: `PDS Ice Storm Warning`,
+    status: `Upgraded`,
+    issued: new Date(),
+    expires: new Date(Date.now() + 3600000),
+    locations: `Somewhere USA`,
+    description: `This is a test event sample.`,
+    coordinates: [
+        [-122.4194, 37.7749], 
+        [-122.4194, 37.7749]
+    ]
+})
+```
+
 ### Function `query`
 Queries the event cache (datbase) for specific events based on text.
 ```ts 
@@ -336,18 +367,22 @@ Fetches an EAS audio message for an event (Simulated)
 ```ts
 import { setEasTone } from "@atmosx/event-product-parser"
 const event = {...}
-await setEasTone(event.properties.description, event.properties.metadata.header)
+await setEasTone({message: event.properties.description, header: event.properties.metadata.header, title: `eas_audio_message`})
 ```
 
 
 ## Types
-[Event](./src/@types/type.event.ts)
-[Properties](./src/@types/type.properties.ts)
-[HVTec](./src/@types/type.hvtec.ts)
-[PVTec](./src/@types/type.pvtec.ts)
-[UGC](./src/@types/type.ugc.ts)
-[Stanzas](./src/@types/type.stanza.ts)
-[Attributes](./src/@types/type.attributes.ts)
+[Event](./src/@types/type.event.ts) | 
+[Properties](./src/@types/type.properties.ts)  |
+[HVTec](./src/@types/type.hvtec.ts) |
+[PVTec](./src/@types/type.pvtec.ts) |\
+[UGC](./src/@types/type.ugc.ts) |
+[Stanzas](./src/@types/type.stanza.ts) |
+[Attributes](./src/@types/type.attributes.ts) |
+
+## Supported Events
+`@atmosx/event-product-parser` natively supports and ingests **300+** NWS Text products using VTEC, UGC, and various text parsing techniues.
+If you wish to view all supported products, please see: [SUPPORTED_EVENTS.md](./SUPPORTED_EVENTS.md)
 
 
 ## Performance Recommendations

package/SUPPORTED_EVENTS.md

@@ -0,0 +1,369 @@
+# @atmosx/event-product-parser Supported Events
+
+
+# Event Dictionary
+- Ashfall |
+- Air Stagnation |
+- Beach Hazard |
+- Brisk Wind |
+- Blizzard |
+- Coastal Flood |
+- Debris Flow |
+- Dust Storm |
+- Extreme Cold |
+- Excessive Heat |
+- Extreme Heat |
+- Extreme Wind |
+- Areal Flood |
+- Flash Flood |
+- Dense Fog |
+- Flood |
+- Frost |
+- Fire Weather |
+- Freeze |
+- Gale |
+- Hurricane Force Wind |
+- Heat |
+- Hurricane |
+- High Wind |
+- Hydrologic |
+- Hard Freeze |
+- Ice Storm |
+- Lake Effect Snow |
+- Low Water |
+- Lakeshore Flood |
+- Lake Wind |
+- Special Marine |
+- Earthquake |
+- Dense Fog |
+- Ashfall |
+- Dense Smoke |
+- Small Craft for Rough Bar |
+- Rip Current Risk |
+- Small Craft |
+- Hazardous Seas |
+- Small Craft for Winds |
+- Dense Smoke |
+- Snow Squall |
+- Storm |
+- Storm Surge |
+- High Surf |
+- Severe Thunderstorm |
+- Small Craft for Hazardous Seas |
+- Tornado ||
+- Tropical Storm |
+- Tsunami |
+- Typhoon |
+- Special Weather |
+- Heavy Freezing Spray |
+- Wind Chill |
+- Wind |
+- Winter Storm |
+- Winter Weather |
+- Freezing Fog |
+- Freezing Rain |
+- Freezing Spray |
+- Rawinsonde Data Above 100 Millibars |
+- Alarm Alert Administrative Message |
+- Alert Administrative Message |
+- NWS Administrative Message |
+- Space Environment Advisory |
+- Area Forecast Discussion |
+- Area Forecast Matrices |
+- Area Forecast Product |
+- Fire Weather Matrix |
+- Agricultural Forecast |
+- Agricultural Observations |
+- Space Environment Alert |
+- Air Quality Alert |
+- Air Quality Index Statement |
+- Air Stagnation Advisory |
+- Avalanche Watch |
+- Avalanche Weather Guidance |
+- Avalanche Warning |
+- Area Weather Outlook |
+- Area Weather Summary |
+- Area Weather Update |
+- Airport Weather Warning |
+- Blue Alert |
+- Buoy Report |
+- Coast Guard Observations |
+- Hourly Roundup for Weather Radio |
+- Child Abduction Emergency |
+- Coded City Forecast |
+- Civil Danger Warning |
+- Civil Emergency Message |
+- Monthly Daily Climate Data |
+- Convective Forecast Product |
+- Coastal Flood Warnings Watches Statements |
+- Coast Guard Surface Report |
+- Computer Hurricane Guidance |
+- Climatological Report Annual |
+- Climatological Report Daily |
+- Climatological Report Monthly |
+- Climatological Report Quarterly |
+- Climatological Report Seasonal |
+- Climate Report |
+- Coded Climatological Monthly Means |
+- Coded Analysis and Forecasts
+- Great Lakes Port Forecast
+- Space Environment Products Routine
+- Center Weather Advisory
+- Coastal Waters Forecast
+- Center Weather Statement
+- Space Environment Product Daily
+- Daily Dispersion Outlook 
+- Drought Information Statement
+- Practice Demo Warning
+- Unnumbered Depression Advisory
+- ASOS Daily Summary
+- Dust Storm Warning
+- Extended Forecast 3 to 5 Day
+- Six to Ten Day Weather Outlook Local
+- Tsunami Bulletin
+- Earthquake Report
+- Earthquake Warning
+- Flood Potential Outlook
+- Extended Streamflow Guidance
+- Extended Streamflow Prediction
+- Water Supply Outlook
+- Evacuation Immediate
+- Extreme Wind Warning
+- Aviation Area Forecasts (Regions)
+- Winds Aloft Forecasts
+- Fire Danger Indices
+- Flash Flood Watch
+- Flash Flood Guidance
+- Headwater Guidance
+- Flash Flood Statement
+- Flash Flood Warning
+- National Flood Summary
+- Flood Statement
+- Flood Warning
+- Upper Wind Fallout Forecast
+- Fire Warning
+- Marine Fisheries Service Message
+- Radar Outage Notification
+- Temp POP Guidance
+- Fire Weather Administrative Message
+- Fire Weather Outlook Discussion
+- Fire Weather Forecast
+- Land Management Forecast
+- Miscellaneous Fire Weather Product
+- Fire Weather Notification
+- Fire Weather Observation
+- Fire Weather Spot Forecast
+- Freezing Level Data
+- Great Lakes Forecast
+- Great Lakes Storm Summary
+- Green
+- RFC QPF Data Products
+- Hurricane Local Statement
+- Hydrometeorological Discussion
+- AHPS XML Product
+- Hazardous Materials Warning
+- RFC QPF Verification Products
+- Weather Roundup
+- High Seas Forecast
+- Hazardous Weather Outlook
+- Hourly Weather Roundup
+- Daily Hydrometeorological Products
+- Monthly Hydrometeorological Product
+- Ice Forecast
+- Ice Drift Vectors
+- Administrative Message
+- Ice Observation
+- Keep Alive Message
+- Local Area Emergency
+- Preliminary Local Climatological Data
+- Local Cooperative Observation
+- Law Enforcement Warning
+- Local Forecast
+- Lake Stages
+- Low Level Sounding
+- Low Temperatures
+- Local Storm Report
+- Lightning Data
+- Rawinsonde Mandatory Levels
+- Mean Areal Precipitation
+- Amended Marine Forecast
+- Marine Forecast Matrix
+- Marine Interpretation Message
+- Miscellaneous Local Product
+- Marine Observations
+- Space Environment Product Monthly
+- Marine Product Techniques Development
+- ASOS Monthly Summary Message
+- METAR Observation
+- METAR Test Message
+- Marine Verification Coded Message
+- Marine Weather Statement
+- Marine Weather Message
+- Weather Reconnaissance Flights
+- Short Term Forecast
+- Data Management Message
+- Non Precipitation Warning
+- Nearshore Marine Forecast
+- Nuclear Power Plant Warning
+- NOAA Weather Radio Forecast
+- Other Aviation Products
+- Observations
+- Offshore Aviation Forecast
+- Offshore Forecast
+- Other Marine Products
+- Other Public Products
+- Other Surface Observations
+- Ocean Surface Winds
+- Zone Forecast
+- Point Forecast Matrices
+- Fire Weather Point Forecast Matrices
+- Plain Language Ship Report
+- Prognostic Meteorological Discussion
+- Public Information Statement
+- Probability of Exceedance
+- Heat Index Forecast Tables
+- Pilot Report Collective
+- Preliminary Forecasts
+- Post Storm Hurricane Report
+- Probabilistic Outlook Points
+- Public Severe Weather Outlook
+- Tropical Cyclone Probabilities
+- Quantitative Precipitation Forecast
+- Quantitative Precipitation Statement
+- Revised Digital Forecast
+- Recreational Report
+- Record Report
+- EAS Activation Request
+- Rangeland Fire Danger Forecast
+- RFI Observation
+- Route Forecast
+- Red Flag Warning
+- Radiological Hazard Warning
+- Required Monthly Test
+- Rain Information Statement
+- River Summary
+- River Forecast
+- River Ice Statement
+- Miscellaneous River Product
+- River Recreation Statement
+- River Statement
+- Regional Weather Roundup
+- Regional Weather Summary
+- Required Weekly Test
+- Special Avalanche Bulletin
+- Agricultural Weather Forecast
+- Snow Avalanche Guidance
+- APT Prediction
+- Preliminary Notice of Watch
+- Storm Summary
+- Supplementary Climatological Data
+- Soil Climate Analysis Network
+- Satellite Cloud Product
+- Selected Cities Summary
+- Supplementary Data Observation
+- Special Dispersion Statement
+- Severe Local Storm Watch
+- SPC Watch Point Information
+- State Forecast
+- Tabular State Forecast
+- Rawinsonde Significant Levels
+- Surface Ship Report
+- International SIGMET
+- Satellite Interpretation Message
+- Severe Local Storm Outline
+- Smoke Management Weather Forecast
+- Special Marine Warning
+- Science Operations Officer Product
+- Satellite Precipitation Estimates
+- Storm Strike Probability Bulletin
+- Special Weather Statement
+- Shelter In Place Warning
+- Snow Squall Warning
+- Surf Discussion
+- Surf Forecast
+- Soaring Guidance
+- Synoptic Surface Observation
+- Weather Statistical Summary
+- Satellite Tropical Disturbance Summary
+- Road Condition Report
+- State Temp Precip Table
+- Spot Forecast Request
+- Space Weather Message
+- Severe Thunderstorm Warning
+- Severe Weather Statement
+- Mesoscale Discussion
+- Day 1 Outlook
+- Day 2 Outlook
+- Day 3 Outlook
+- State Weather Summary
+- Regional Weather Synopsis
+- Terminal Aerodrome Forecast
+- Terminal Alerting Products
+- Travelers Forecast Table
+- Tropical Cyclone Advisory
+- Tropical Cyclone Discussion
+- Tropical Cyclone Position Estimate
+- Tropical Cyclone Marine Aviation Advisory
+- Public Tropical Cyclone Advisory
+- Satellite Tropical Cyclone Summary
+- Tropical Cyclone Update
+- Tropical Cyclone Break Points
+- Tsunami Bulletin
+- Tide Report
+- Tsunami Tide Seismic Acknowledgement
+- Telephone Outage Emergency
+- Tornado Warning
+- Temperature Precipitation Table
+- Tsunami Watch
+- Ultraviolet Index
+- Travelers Forecast
+- Transcribed Weather Broadcast
+- Tropical Weather Discussion
+- Tropical Weather Outlook
+- Tropical Weather Summary
+- Aircraft Reconnaissance
+- Ultraviolet Index
+- Volcanic Activity Advisory
+- Forecast Verification Statistics
+- TAF Verification Product
+- Volcano Warning
+- AIRMETs (Regions)
+- Space Environment Warning
+- Space Environment Watch
+- Weather Watch Clearance Notification
+- Weekly Weather and Crop Report
+- Weekly Data for Agriculture
+- Warning Decision Update
+- Space Environment Product Weekly
+- Watch Outline Update
+- SIGMETs (Regions)
+- Tropical Cyclone SIGMET
+- Volcanic Activity SIGMET
+- Winter Weather Warning
+- Watch Status Report
+- Watch Probabilities
+- Zone Forecast Product
+
+
+# Additional Events (Enhanced)
+- Radar Indicated Tornado Warning |
+- Confirmed Tornado Warning |
+- Radar Confirmed Tornado Warning |
+- PDS Tornado Warning |
+- Tornado Emergency |
+- PDS Blizzard Warning |
+- PDS Ice Storm Warning |
+- PDS Fire Weather Warning |
+- PDS Fire Weather Warning |
+- Special Marine Warning (TPROB) |
+- PDS Tornado Watch |
+- PDS Severe Thunderstorm Watch |
+- Flash Flood Emergency |
+- Considerable Flash Flood Warning |
+- EDS Severe Thunderstorm Warning (TPROB) |
+- EDS Severe Thunderstorm Warning |
+- Destructive Severe Thunderstorm Warning (TPROB) |
+- Destructive Severe Thunderstorm Warning |
+- Considerable Severe Thunderstorm Warning (TPROB)|
+- Considerable Severe Thunderstorm Warning |
+- Severe Thunderstorm Warning (TPROB) |