@atmosx/event-product-parser 3.0.41 → 3.0.44

package/dist/index.d.mts

@@ -3,6 +3,7 @@ type TypeWebhook = {
     title: string;
     message: string;
     upload: boolean;
+    eas: boolean;
     rate: number;
     events: string[];
 };
@@ -57,6 +58,7 @@ type TypeSettings = {
             IgnoreTestProducts: boolean;
         };
         EASSettings: {
+            ArchiveTTL: number;
             ArchiveDirectory: string;
             IntroWavFile: string;
         };
@@ -122,6 +124,8 @@ type TypeEventProperties = {
         pds_watch: boolean;
     };
     spc_parameters: {
+        spc_number: string;
+        spc_concerning: string;
         spc_max_tornado: string;
         spc_max_hail: string;
         spc_max_wind: string;
@@ -190,6 +194,8 @@ type TypeEvent = {
                 issued: string;
                 status: string;
             }[];
+            attachments?: string[];
+            raw: string;
         };
     } & TypeEventProperties;
 };
@@ -212,7 +218,7 @@ interface GenerateEASOptions {
 }
 declare const setEasTone: (options: GenerateEASOptions) => Promise<string>;
 
-interface GetAddChaserOptions {
+interface GetNodeOptions {
     identifier: string;
     delete?: boolean;
     coordinates: {
@@ -220,7 +226,7 @@ interface GetAddChaserOptions {
         latitude: number;
     };
 }
-declare const setNode: (options: GetAddChaserOptions) => void;
+declare const setNode: (options: GetNodeOptions) => void;
 
 declare const getEvents: () => any;
 
@@ -228,6 +234,31 @@ declare const getNodes: () => any;
 
 declare const getRandomEvent: () => any;
 
+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;
+    };
+};
+
+interface QueryOptions {
+    search: string;
+    max?: number;
+}
+declare const query: (options: QueryOptions) => Promise<TypeStanza[]>;
+
 declare const clearEvents: () => void;
 
 declare class Manager {
@@ -236,4 +267,4 @@ declare class Manager {
     trycatch(): void;
 }
 
-export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, setEasTone, setNode, setSettings, startService, stopService };
+export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, query, setEasTone, setNode, setSettings, startService, stopService };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ type TypeWebhook = {
     title: string;
     message: string;
     upload: boolean;
+    eas: boolean;
     rate: number;
     events: string[];
 };
@@ -57,6 +58,7 @@ type TypeSettings = {
             IgnoreTestProducts: boolean;
         };
         EASSettings: {
+            ArchiveTTL: number;
             ArchiveDirectory: string;
             IntroWavFile: string;
         };
@@ -122,6 +124,8 @@ type TypeEventProperties = {
         pds_watch: boolean;
     };
     spc_parameters: {
+        spc_number: string;
+        spc_concerning: string;
         spc_max_tornado: string;
         spc_max_hail: string;
         spc_max_wind: string;
@@ -190,6 +194,8 @@ type TypeEvent = {
                 issued: string;
                 status: string;
             }[];
+            attachments?: string[];
+            raw: string;
         };
     } & TypeEventProperties;
 };
@@ -212,7 +218,7 @@ interface GenerateEASOptions {
 }
 declare const setEasTone: (options: GenerateEASOptions) => Promise<string>;
 
-interface GetAddChaserOptions {
+interface GetNodeOptions {
     identifier: string;
     delete?: boolean;
     coordinates: {
@@ -220,7 +226,7 @@ interface GetAddChaserOptions {
         latitude: number;
     };
 }
-declare const setNode: (options: GetAddChaserOptions) => void;
+declare const setNode: (options: GetNodeOptions) => void;
 
 declare const getEvents: () => any;
 
@@ -228,6 +234,31 @@ declare const getNodes: () => any;
 
 declare const getRandomEvent: () => any;
 
+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;
+    };
+};
+
+interface QueryOptions {
+    search: string;
+    max?: number;
+}
+declare const query: (options: QueryOptions) => Promise<TypeStanza[]>;
+
 declare const clearEvents: () => void;
 
 declare class Manager {
@@ -236,4 +267,4 @@ declare class Manager {
     trycatch(): void;
 }
 
-export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, setEasTone, setNode, setSettings, startService, stopService };
+export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, query, setEasTone, setNode, setSettings, startService, stopService };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atmosx/event-product-parser",
-	"version": "3.0.41",
+	"version": "3.0.44",
 	"description": "NOAA Weather Wire & NWS API Parser - Built for standalone and Project AtmosphericX Integration.",
 	"main": "dist/cjs/index.cjs",
 	"module": "dist/esm/index.mjs",

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

@@ -17,8 +17,8 @@
 
 */
 
-import { TypeStanzaCompiled } from "../@types/types.compiled"
-import { TypeSettings } from "../@types/types.settings"
+import { TypeStanzaCompiled } from "../@types/type.compiled"
+import { TypeSettings } from "../@types/type.settings"
 import { bootstrap } from "../bootstrap"
 import { text } from "../@events/events.text"
 import { ugc } from "../@events/events.ugc"

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

@@ -18,7 +18,7 @@
 */
 
 import { TypeEvent } from "../@types/type.event";
-import { TypeSettings } from "../@types/types.settings";
+import { TypeSettings } from "../@types/type.settings";
 import { bootstrap } from "../bootstrap"
 import { betterEventNames } from "../@dictionaries/dictionaries.betterEventNames"
 

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

@@ -18,7 +18,7 @@
 */
 
 import { getSettings } from "../@modules/@utilities/utilities.getSettings";
-import { TypeSettings } from "../@types/types.settings"
+import { TypeSettings } from "../@types/type.settings"
 import { TypeEvent } from "../@types/type.event"
 import { getZonePolygon } from "../@parsers/@ugc/ugc.coordinates";
 

package/src/@building/building.headers.ts

@@ -17,7 +17,7 @@
 
 */
 
-import { TypePVTEC } from "../@types/types.pvtec";
+import { TypePVTEC } from "../@types/type.pvtec";
 import { TypeEventProperties } from "../@types/type.properties";
 
 interface GetHeaderOptions {

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

@@ -17,8 +17,8 @@
 
 */
 
-import { TypeAttributes } from "../@types/types.attributes";
-import { TypePVTEC } from "../@types/types.pvtec";
+import { TypeAttributes } from "../@types/type.attributes";
+import { TypePVTEC } from "../@types/type.pvtec";
 import { officeICAOs } from "../@dictionaries/dictionaries.officeICAOs";
 
 interface GetOfficeOptions { 
@@ -34,7 +34,7 @@ interface GetOfficeResponse {
 
 export const getEventOffice = (options: GetOfficeOptions): GetOfficeResponse => {
     const office = options.pVtec != null 
-        ? options.pVtec?.tracking?.split(`-`)[0] : (options.attributes?.cccc ??
+        ? options.pVtec?.tracking?.split(`.`)[0] : (options.attributes?.cccc ??
             (options.organization != null ? 
                 (Array.isArray(options.organization) ? options.organization?.[0] : options.organization) 
         : null));

package/src/@building/building.outlooks.ts

@@ -0,0 +1,36 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, & 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 { getLatestIssuance } from "../@modules/@utilities/utilities.getLatestIssuance";
+
+export const getEventAttachments = (event: TypeEvent): string[] | null => {
+    const latestTime = getLatestIssuance();
+    const validEvents = [
+        { target: "Day 1", attachment: `https://www.spc.noaa.gov/products/outlook/day1otlk_${latestTime}.png` },
+        { target: "Day 2", attachment: `https://www.spc.noaa.gov/products/outlook/day2otlk.png` },
+        { target: "Day 3", attachment: `https://www.spc.noaa.gov/products/outlook/day3otlk.png` },
+        { target: "Mesoscale Discussion", attachment: `https://www.spc.noaa.gov/products/md/mcd${event?.properties?.spc_parameters?.spc_number}.png` },
+    ]
+    const isValid = validEvents.find(outlook => outlook.target == event.properties.event);
+    if (isValid) {
+        return isValid?.attachment ? [isValid.attachment] : [];
+    }
+    return null;
+}

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

@@ -18,10 +18,10 @@
 */
 
 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 { TypeAttributes } from "../@types/type.attributes";
+import { TypeUGC } from "../@types/type.ugc";
+import { TypePVTEC } from "../@types/type.pvtec";
+import { TypeHVTEC } from "../@types/type.hvtec";
 import { regExp } from "../@dictionaries/dictionaries.regExp";
 import { getDescriptionFromProduct } from "../@parsers/@text/text.getDescriptionFromProduct";
 import { getPolygonFromProduct } from "../@parsers/@text/text.getPolygonFromProduct";
@@ -40,7 +40,7 @@ interface GetPropertiesOptions {
 export const properties = (options: GetPropertiesOptions): TypeEventProperties => {
     const organization = options.message.match(regExp.wmo)?.[0] ?? null
     const polygons = getPolygonFromProduct(options.message)
-    return { 
+    const properties = {
         locations: options?.ugc?.locations?.join(`; `) ?? null,
         description: getDescriptionFromProduct({ message: options.message, handle: options?.pVtec?.vtec ?? null }),
         attributes: options.attributes,
@@ -66,6 +66,8 @@ export const properties = (options: GetPropertiesOptions): TypeEventProperties =
             hail_threat: getTextFromProduct({ message: options.message, find: [`HAIL THREAT...`], removal: []}) ?? null,
         },
         spc_parameters: {
+            spc_number: getTextFromProduct({ message: options.message, find: [`Mesoscale Discussion `], removal: [`Mesoscale Discussion`, `Number`, `...`] }) ?? null,
+            spc_concerning: getTextFromProduct({ message: options.message, find: [`Concerning...`] }) ?? null,
             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,
@@ -86,4 +88,8 @@ export const properties = (options: GetPropertiesOptions): TypeEventProperties =
             pds_watch: (getTextFromProduct({ message: options.message, find: [`PARTICULARLY DANGEROUS SITUATION`], removal: [`%`, `<`, `:`] }) === `YES`)
         }
     }
+    if (isNaN(Number(properties.watch_parameters.watch_number))) {
+        properties.watch_parameters.watch_number = null
+    }
+    return properties;
 }

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

@@ -17,10 +17,10 @@
 
 */
 
-import { TypeAttributes } from "../@types/types.attributes";
+import { TypeAttributes } from "../@types/type.attributes";
 import { TypeEventProperties } from "../@types/type.properties";
-import { TypeStanzaCompiled } from "../@types/types.compiled";
-import { TypePVTEC } from "../@types/types.pvtec";
+import { TypeStanzaCompiled } from "../@types/type.compiled";
+import { TypePVTEC } from "../@types/type.pvtec";
 
 interface GetTrackingOptions { 
     type: `RAW` | `VTEC` | `API`
@@ -35,16 +35,16 @@ interface GetTrackingOptions {
 }
 
 export const getEventTracking = (options: GetTrackingOptions): string => {
-    const proprties = options.properties
+    const properties = 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
+        const getWatchNumber = properties.watch_parameters.watch_number ?? null
         if (getWatchNumber) {
-            return `${proprties.geocode.office.office}.${stanza.getType.prefix}.A.${getWatchNumber}`
+            return `${properties.geocode.office.office}.${stanza.getType.prefix}.A.${getWatchNumber}`
         }
-        return `${proprties.geocode.office.office}.${attributes.ttaaii}.${attributes.id.slice(-4).replace(`.`, ``) ?? '0'}`
+        return `${properties.geocode.office.office}.${attributes.ttaaii}.${attributes.id.slice(-4).replace(`.`, ``) ?? '0'}`
     }
     if (options.type === `VTEC`) {
         return vtec.tracking;

package/src/@building/building.validate.ts

@@ -19,13 +19,14 @@
 
 import { createHash } from "crypto"
 import { TypeEvent } from "../@types/type.event";
-import { TypeSettings } from "../@types/types.settings";
+import { TypeSettings } from "../@types/type.settings";
 import { bootstrap } from "../bootstrap"
 import { getEventEnhancedName } from "./building.enhance";
 import { getEventSignature } from "./building.signature"
 import { mkEvent } from "../@manager/manager.mkEvent";
 import { rmEvent } from "../@manager/manager.rmEvent";
 import { getEventGeometry } from "./building.geometry";
+import { getEventAttachments } from "./building.outlooks";
 import { updateNode } from "../@manager/manager.updateNodes";
 import { setEventEmit } from "../@modules/@utilities/utilities.setEventEmit";
 
@@ -51,7 +52,8 @@ export const validateEvents = async (events: TypeEvent[]): Promise<void> => {
             delete filteredProperties.metadata.ms;
         }
         filteredProperties.metadata = filteredProperties.metadata ?? {} as any;
-        properties.metadata.hash = createHash("sha256").update(JSON.stringify(filteredProperties)).digest("hex")        
+        properties.metadata.hash = createHash("sha256").update(JSON.stringify(filteredProperties)).digest("hex")  
+        properties.metadata.attachments = getEventAttachments(event)
         setEventEmit({ event: `onProductType${enhancedEventName.replace(/\s+/g, '')}`, metadata: define });
         
         if (properties.status_metadata.is_test) { 

package/src/@core/core.query.ts

@@ -0,0 +1,39 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
+       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
+      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
+     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
+                                     | |                            
+                                     |_|                                                                                                                
+
+    Created with ♥ by the AtmosphericX Team (KiyoWx, StarflightWx, & 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 { TypeStanza } from "../@types/type.stanza";
+import { bootstrap } from "../bootstrap";
+
+interface QueryOptions {
+    search: string
+    max?: number
+}
+
+type RowQuery = {
+    rowid: number
+    stanza: string
+}
+
+export const query = async (options: QueryOptions): Promise<TypeStanza[]> => {
+    const get = await bootstrap.database.prepare(
+        `SELECT * FROM stanzas WHERE stanza LIKE ? LIMIT ?`)
+    .all(`%${options.search}%`, options.max ?? 100) as RowQuery[];
+    const events = get.map((row) => JSON.parse(row.stanza));
+    return events as TypeStanza[];
+}

package/src/@core/core.setNode.ts

@@ -21,13 +21,13 @@ import { bootstrap } from "../bootstrap";
 import { setWarning } from "../@modules/@utilities/utilities.setWarning"
 import { setEventEmit } from "../@modules/@utilities/utilities.setEventEmit";
 
-interface GetAddChaserOptions {
+interface GetNodeOptions {
     identifier: string
     delete?: boolean
     coordinates: { longitude: number; latitude: number }
 }
 
-export const setNode = (options: GetAddChaserOptions) => {
+export const setNode = (options: GetNodeOptions) => {
     const nodes = bootstrap.cache.nodes.features;
     const exists = nodes.find((node) => node.properties.identifier === options.identifier);
     if (options.delete) {

package/src/@core/core.start.ts

@@ -17,7 +17,7 @@
 
 */
 
-import { TypeSettings } from "../@types/types.settings";
+import { TypeSettings } from "../@types/type.settings";
 import { bootstrap } from "../bootstrap";
 import { setWarning } from "../@modules/@utilities/utilities.setWarning"
 import { setSettings } from "../@modules/@utilities/utilities.setSettings"

package/src/@events/events.api.ts

@@ -17,7 +17,7 @@
 
 */
 
-import { TypeStanzaCompiled } from "../@types/types.compiled"
+import { TypeStanzaCompiled } from "../@types/type.compiled"
 import { TypeEvent } from "../@types/type.event";
 import { getEventTracking } from "../@building/building.tracking";
 import { validateEvents } from "../@building/building.validate";
@@ -72,6 +72,8 @@ export const api = async (stanza: TypeStanzaCompiled): Promise<void> => {
                     hail_threat: feature?.properties?.parameters?.hailThreat?.[0] ?? null,
                 },
                 spc_parameters: {
+                    spc_number: getTextFromProduct({ message: feature?.properties?.description, find: [`Mesoscale Discussion `], removal: [`Mesoscale Discussion`, `Number`, `...`] }) ?? null,
+                    spc_concerning: getTextFromProduct({ message: feature?.properties?.description, find: [`Concerning...`] }) ?? null,
                     spc_max_tornado: getTextFromProduct({ message: feature?.properties?.description, find: [`MOST PROBABLE PEAK TORNADO INTENSITY...`] }) ?? null,
                     spc_max_hail: getTextFromProduct({ message: feature?.properties?.description, find: [`MOST PROBABLE PEAK HAIL SIZE...`] }) ?? null,
                     spc_max_wind: getTextFromProduct({ message: feature?.properties?.description, find: [`MOST PROBABLE PEAK WIND GUST...`] }) ?? null,
@@ -98,6 +100,7 @@ export const api = async (stanza: TypeStanzaCompiled): Promise<void> => {
                     header: `ZCZC-ATMOSX-${feature?.properties?.parameters?.WMOidentifier}`,
                     vtec: pVtec,
                     hvtec: null,
+                    raw: feature?.properties?.description,
                     history: [
                         {
                             description: feature?.properties?.description,

package/src/@events/events.text.ts

@@ -17,8 +17,8 @@
 
 */
 
-import { TypeAttributes } from "../@types/types.attributes";
-import { TypeStanzaCompiled } from "../@types/types.compiled"
+import { TypeAttributes } from "../@types/type.attributes";
+import { TypeStanzaCompiled } from "../@types/type.compiled"
 import { TypeEvent } from "../@types/type.event";
 import { properties } from "../@building/building.properties";
 import { getEventHeader } from "../@building/building.headers";
@@ -66,6 +66,7 @@ export const text = async (stanza: TypeStanzaCompiled): Promise<void> => {
                     header: header,
                     vtec: null,
                     hvtec: null,
+                    raw: message,
                     history: [
                         {
                             description: props.description,

package/src/@events/events.ugc.ts

@@ -17,8 +17,8 @@
 
 */
 
-import { TypeAttributes } from "../@types/types.attributes";
-import { TypeStanzaCompiled } from "../@types/types.compiled"
+import { TypeAttributes } from "../@types/type.attributes";
+import { TypeStanzaCompiled } from "../@types/type.compiled"
 import { TypeEvent } from "../@types/type.event";
 import { eventsMatchText } from "../@dictionaries/dictionaries.eventsMatchText";
 import { ugcExtract } from "../@parsers/@ugc/ugc.extract";
@@ -69,6 +69,7 @@ export const ugc = async (stanza: TypeStanzaCompiled): Promise<void> => {
                         header: header,
                         vtec: null,
                         hvtec: null,
+                        raw: message,
                         history: [
                             {
                                 description: props.description,

package/src/@events/events.vtec.ts

@@ -17,11 +17,11 @@
 
 */
 
-import { TypeAttributes } from "../@types/types.attributes";
-import { TypeStanzaCompiled } from "../@types/types.compiled"
+import { TypeAttributes } from "../@types/type.attributes";
+import { TypeStanzaCompiled } from "../@types/type.compiled"
 import { TypeEvent } from "../@types/type.event";
-import { TypePVTEC } from "../@types/types.pvtec";
-import { TypeHVTEC } from "../@types/types.hvtec";
+import { TypePVTEC } from "../@types/type.pvtec";
+import { TypeHVTEC } from "../@types/type.hvtec";
 import { pvExtract } from "../@parsers/@pvtec/pvtec.extract";
 import { hvExtract } from "../@parsers/@hvtec/hvtec.extract";
 import { ugcExtract } from "../@parsers/@ugc/ugc.extract";
@@ -70,6 +70,7 @@ export const vtec = async (stanza: TypeStanzaCompiled): Promise<void> => {
                             header: header,
                             vtec: pv,
                             hvtec: hVtec,
+                            raw: message,
                             history: [
                                 {
                                     description: props.description,