@atmosx/event-product-parser 2.0.15 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atmosx/event-product-parser",
-	"version": "2.0.015",
+	"version": "3.0.0",
 	"description": "NOAA Weather Wire & NWS API Parser - Built for standalone and Project AtmosphericX Integration.",
 	"main": "dist/cjs/index.cjs",
 	"module": "dist/esm/index.mjs",
@@ -11,7 +11,7 @@
 	},
 	"scripts": {
 		"start": "cd ./test && node ./index.js",
-    	"build": "tsup && cd ./test && node ./index.js",
+		"build": "tsup && cd ./test && node ./index.js",
 		"publish": "tsup && npm publish --access public",
 		"publish-beta": "tsup && npm publish --tag beta --access public"
 	},
@@ -33,11 +33,11 @@
 	"homepage": "https://github.com/AtmosphericX/event-product-parser#readme",
 	"dependencies": {
 		"@xmpp/client": "0.14.0",
-		"axios": "1.13.2",
 		"better-sqlite3": "11.10.0",
 		"croner": "10.0.1",
 		"jszip": "3.10.1",
 		"polygon-clipping": "0.15.7",
+		"request": "^2.88.2",
 		"say": "0.16.0",
 		"shapefile": "0.6.6",
 		"typescript": "5.9.3",

package/src/@building/building.clean.ts

@@ -0,0 +1,30 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 const getCleanedEvent = <T extends Record<string, any>>(event: T): T => {
+    for (const key of Object.keys(event)) {
+        const value = event[key];
+        if (value === null || value === undefined) {
+            delete event[key];
+        } else if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+            (event as Record<string, any>)[key] = getCleanedEvent(value as Record<string, any>) as any;
+        }
+    }
+    return event;
+};

package/src/@building/building.create.ts

@@ -0,0 +1,42 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { TypeStanzaCompiled } from "../@types/types.compiled"
+import { TypeSettings } from "../@types/types.settings"
+import { bootstrap } from "../bootstrap"
+import { text } from "../@events/events.text"
+import { ugc } from "../@events/events.ugc"
+import { vtec } from "../@events/events.vtec"
+import { api } from "../@events/events.api"
+
+export const createEvent = async (stanza: TypeStanzaCompiled): Promise<void | string> => {
+    const settings = bootstrap.settings as TypeSettings
+    const StanzaSettings = settings.NOAAWeatherWireServiceSettings.StanzaSettings;
+
+    const isVtecEvent = (stanza.isVTEC && stanza.isUGC)
+    const isUgcEvent = (!stanza.isVTEC && stanza.isUGC)
+    const isTextEvent = (!stanza.isVTEC && !stanza.isUGC)
+    const isNWWS = (stanza.isNWWS)
+
+    if (!isNWWS) return await api(stanza)
+    if (!StanzaSettings.DisableVTEC && isVtecEvent) return await vtec(stanza)
+    if (!StanzaSettings.DisableUGC && isUgcEvent) return await ugc(stanza);
+    if (!StanzaSettings.DisableText && isTextEvent) return await text(stanza);
+    return 'nothing picked';
+}

package/src/@building/building.enhance.ts

@@ -0,0 +1,56 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { TypeEvent } from "../@types/type.event";
+import { TypeSettings } from "../@types/types.settings";
+import { bootstrap } from "../bootstrap"
+import { betterEventNames } from "../@dictionaries/dictionaries.betterEventNames"
+
+export const getEventEnhancedName = (event: TypeEvent): string => {
+    const configurations = bootstrap.settings as TypeSettings
+    let name = event?.properties?.event
+
+    if (!configurations?.GlobalSettings?.BetterEventNames) {
+        return name 
+    }
+
+    const damage = event?.properties?.parameters?.damage_threat
+    const tornado = event?.properties?.parameters.tornado_threat;
+    const description = event?.properties?.description?.toLowerCase()
+    for (const [eventKey, eventConfig] of Object.entries(betterEventNames)) {
+        if (eventKey !== name) continue;
+        for (const [paramKey, paramValue] of Object.entries(eventConfig)) {
+            let matches = true;
+            if (paramValue?.description) {
+                if (!description.includes(paramValue.description.toLowerCase())) matches = false;
+            }
+            if (paramValue?.damage) {
+                if (paramValue.damage !== damage) matches = false;
+            }
+            if (paramValue?.tornado) {
+                if (paramValue.tornado !== tornado) matches = false;
+            }
+            if (matches) {
+                name = paramKey;
+                break;
+            }
+        }
+    }
+    return name;
+}

package/src/@building/building.geometry.ts

@@ -0,0 +1,42 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { getSettings } from "../@modules/@utilities/utilities.getSettings";
+import { TypeSettings } from "../@types/types.settings"
+import { TypeEvent } from "../@types/type.event"
+import { getZonePolygon } from "../@parsers/@ugc/ugc.coordinates";
+
+interface GetGeometryResponse { 
+    type: `Polygon` | `MultiPolygon`
+    coordinates: any[]
+}
+
+export const getEventGeometry = async (event: TypeEvent): Promise<GetGeometryResponse> => {
+    const settings = getSettings() as TypeSettings
+    const generated = event?.properties?.geocode?.polygon ?? null;
+    const ugc = event?.properties?.geocode?.ugc ?? null;
+    let geo: GetGeometryResponse = {
+        type: `Polygon`,
+        coordinates: generated != null ? JSON.parse(Buffer.from(generated, 'base64').toString('utf-8')) : null
+    }
+    if (settings.GlobalSettings.UseShapefileCoordinates && generated == null && ugc != null) { 
+        geo = await getZonePolygon({zones: ugc, isUnion: false})
+    }
+    return geo;
+}

package/src/@building/building.headers.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
+
+*/
+
+import { TypePVTEC } from "../@types/types.pvtec";
+import { TypeEventProperties } from "../@types/type.properties";
+
+interface GetHeaderOptions {
+    properties: TypeEventProperties
+    vtec?: TypePVTEC
+    getType: {
+        type: string
+        prefix: string
+    }
+}
+
+export const getEventHeader = (options: GetHeaderOptions): string => {
+    const properties = options.properties
+    const vtec = options.vtec ?? null
+    const ugc = properties.geocode.ugc != null ? properties.geocode.ugc.join(`-`) : `0`;
+    return `ZCZC-ATMOSX-${options.getType.prefix}-${ugc}-${vtec?.status ?? `Issued`}-${new Date().toISOString().replace(/[-:]/g, '').split('.')[0]}-${properties.geocode.office.office ?? `KWNS`}`
+}

package/src/@building/building.office.ts

@@ -0,0 +1,43 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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/types.attributes";
+import { TypePVTEC } from "../@types/types.pvtec";
+import { officeICAOs } from "../@dictionaries/dictionaries.officeICAOs";
+
+interface GetOfficeOptions { 
+    attributes: TypeAttributes
+    organization: string
+    pVtec: TypePVTEC
+}
+
+interface GetOfficeResponse { 
+    office: string | null
+    name: string | null
+}
+
+export const getEventOffice = (options: GetOfficeOptions): GetOfficeResponse => {
+    const office = options.pVtec != null 
+        ? options.pVtec?.tracking?.split(`-`)[0] : (options.attributes?.cccc || 
+            (options.organization != null ? 
+                (Array.isArray(options.organization) ? options.organization?.[0] : options.organization) 
+        : null));
+    const name = officeICAOs?.[office] ?? null;
+    return { office, name };
+}

package/src/@building/building.polygon.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
+
+*/
+
+
+import { TypeEvent } from "../@types/type.event"
+import { getEventGeometry } from "./building.geometry"
+import { bootstrap } from "../bootstrap"
+import { getShapeNearestPoint } from "../@modules/@utilities/utilities.getShapeNearestPoint"
+
+interface GetEventNodesResponse { 
+    nodes: {
+        id?: string | number
+        coordinates: [number, number]
+        nearest: [number, number]
+        miles: number | null
+        kilometers: number | null
+        proximity: boolean
+    }[]
+    filtered: boolean
+    updated: number
+}
+
+export const getEventNodes = async (event: TypeEvent): Promise<GetEventNodesResponse> => {
+    const metadata = { nodes: [], proximity: false, filtered: false }
+    const geometry = await getEventGeometry(event);
+    if (!geometry || !geometry.coordinates) {
+        return { nodes: [], filtered: false, updated: Date.now() }
+    }
+    const nodes = bootstrap.cache.nodes.features;
+    for (const node of nodes) {
+        const [longitude, latitude] = node.geometry.coordinates;
+        const getPoint = getShapeNearestPoint(geometry.coordinates, [longitude, latitude])
+        const miles = getPoint.distance ?? null;
+        const kilometers = Number((miles * 1.609344).toFixed(3));
+
+        const info = {
+            id: node.properties?.identifier,
+            coordinates: [longitude, latitude],
+            nearest: getPoint.point,
+            miles,
+            kilometers,
+            proximity: getPoint.proximity
+        }
+        metadata.nodes.push(info)
+        if (bootstrap.settings.GlobalSettings.EventFiltering.NodeLocationFiltering && miles < bootstrap.settings.GlobalSettings.NodeMinDistance) {
+            metadata.proximity = true;
+            info.proximity = true;
+        }
+    }
+    return {
+        nodes: metadata.nodes,
+        filtered: metadata.proximity,
+        updated: Date.now()
+    }
+}

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

@@ -0,0 +1,89 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { 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/@building/building.signature.ts

@@ -0,0 +1,78 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { TypeEvent } from "../@types/type.event";
+import { statusCorrelationText } from "../@dictionaries/dictionaries.statusCorrelationText";
+import { eventCancelMessages } from "../@dictionaries/dictionaries.eventCancelMessages";
+import { test_signatures} from "../@dictionaries/dictionaries.test_signatures"
+import { eventProducts } from "../@dictionaries/dictionaries.eventProducts";
+import { hailStrings } from "../@dictionaries/dictionaries.hailStrings"
+import { getFormattedTime } from "../@modules/@utilities/utilities.getFormattedTime";
+
+
+/*
+export const hailStrings: Record<string, string> = {
+    "0.75": "Penny",
+    "0.88": "Nickel",
+    "1.00": "Quarter",
+    "1.25": "Half Dollar",
+    "1.50": "Ping Pong Ball",
+    "1.75": "Golf Ball",
+    "2.00": "Hen Egg",
+    "2.50": "Tennis Ball",
+    "2.75": "Baseball",
+    "4.00": "CD/DVD"
+}
+    */
+
+export const getEventSignature = (event: TypeEvent): TypeEvent => {
+    const properties = event?.properties;
+    const vtec = event?.properties?.metadata?.vtec
+    const status = statusCorrelationText
+        .find((c: { type: string }) => c.type === properties?.status);
+    const csig = eventCancelMessages.find(sig => properties.description.toLowerCase().includes(sig.toLowerCase()));
+    properties.status_metadata = { ...properties.status_metadata, is_issued: true, is_test: false};
+
+    if (properties.parameters.estimated_hail_size) { 
+        properties.parameters.estimated_hail_size += ` (${hailStrings[properties.parameters.estimated_hail_size]})`
+    }
+
+    if (status) { 
+        properties.status = status.name ?? properties.status; 
+        properties.status_metadata = { ...properties.status_metadata, is_updated: !!status.isUpdate, is_issued: !!status.isIssued, is_expired: !!status.isCancel };
+    }
+    if (csig) {
+        properties.status_metadata = { ...properties.status_metadata, is_expired: true };
+    }
+    if (vtec) {
+        const getProduct = vtec.split(`.`)[0]?.replace(`/`, ``)
+        const isTestProduct = eventProducts[getProduct] == `Test Product`
+        if (isTestProduct || test_signatures.some(sig => properties.description?.toLowerCase().includes(sig.toLowerCase()) || properties?.parameters?.instructions?.toLowerCase().includes(sig.toLowerCase()))) {
+            properties.status_metadata = { ...properties.status_metadata, is_test: true }
+        }    
+    }
+    if (new Date(properties.expires).getTime() < Date.now()) {
+        properties.status_metadata = { ...properties.status_metadata, is_expired: true };
+    }  
+    properties.status_metadata = {
+        ...properties.status_metadata,
+    }
+    
+    return event
+}

package/src/@building/building.tags.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
+
+*/
+
+import { eventTags } from "../@dictionaries/dictionaries.eventTags";
+
+export const getEventTags = (message: string): string[] => {
+    return Object.entries(eventTags).filter(([key]) => message?.toLowerCase().includes(key.toLowerCase())).map(([, value]) => value)
+}

package/src/@building/building.tracking.ts

@@ -0,0 +1,68 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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/types.attributes";
+import { TypeEventProperties } from "../@types/type.properties";
+import { TypeStanzaCompiled } from "../@types/types.compiled";
+import { TypePVTEC } from "../@types/types.pvtec";
+
+interface GetTrackingOptions { 
+    type: `RAW` | `VTEC` | `API`
+    stanza?: TypeStanzaCompiled
+    attributes?: TypeAttributes
+    properties?: TypeEventProperties
+    organization?: {
+        wmoidentifier: string
+        featureId: string
+    }
+    vtec?: TypePVTEC
+}
+
+export const getEventTracking = (options: GetTrackingOptions): string => {
+    const proprties = options.properties
+    const attributes = options.attributes
+    const stanza = options.stanza
+    const vtec = options.vtec
+    if (options.type === `RAW`) { 
+        const getWatchNumber = proprties.watch_parameters.watch_number ?? null
+        if (getWatchNumber) {
+            return `${proprties.geocode.office.office}-${stanza.getType.prefix}-A-${getWatchNumber}`
+        }
+        return `${proprties.geocode.office.office}-${attributes.ttaaii}-${attributes.id.slice(-4).replace(`.`, ``) ?? '0'}`
+    }
+    if (options.type === `VTEC`) {
+        return vtec.tracking;
+    }
+    if (options.type === `API`) {
+        if (options.vtec) { 
+            const vtecValue = Array.isArray(options.vtec) 
+                ? options.vtec[0] : options.vtec;
+            const splitPVTEC = vtecValue.split('.');
+            return `${splitPVTEC[2]}-${splitPVTEC[3]}-${splitPVTEC[4]}-${splitPVTEC[5]}`;
+        }
+        const wmoMatch = options.organization?.wmoidentifier?.match(/([A-Z]{4}\d{2})\s+([A-Z]{4})/);
+        const station = wmoMatch?.[2] ?? 'N/A';
+        if (options.organization.featureId) {
+            const idMatch = options.organization.featureId.match(/([a-f0-9]+)\.(\d+)\.(\d+)$/);
+            return `${station}-${idMatch?.[1] ?? 'N/A'}`;
+        }
+        const id = wmoMatch?.[1] ?? 'N/A';
+        return `${station}-${id}`;
+    }
+}