@atmosx/event-product-parser 3.0.47 → 3.0.51

package/src/@parsers/@ugc/ugc.coordinates.ts

@@ -16,8 +16,9 @@
     Internal Package: @atmosx/event-product-parser
 
 */
-import { union } from "polygon-clipping";
+
 import { bootstrap } from "../../bootstrap";
+import { union } from "polygon-clipping";
 
 interface CoordinatesOptions {
     zones: string[]

package/src/@parsers/@ugc/ugc.getCache.ts

@@ -0,0 +1,24 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { bootstrap } from "../../bootstrap";
+
+export const getCache = (key: string) => {
+    return bootstrap.cache.ugc.get(key);
+};

package/src/@parsers/@ugc/ugc.locations.ts

@@ -18,12 +18,40 @@
 */
 
 import { bootstrap } from "../../bootstrap";
+import { getCache } from "./ugc.getCache";
+import { setCache } from "./ugc.setCache";
 
 export const getLocations = async (zones: string[]): Promise<string[]> => {
-    const sites = Array.from(new Set(zones));
-    const placeholders = sites.map(() => '?').join(',');
-    const rows = await bootstrap.database
-        .prepare(`SELECT id, location FROM shapefiles WHERE id IN (${placeholders})`)
-        .all(...sites)
-    return rows.map((row: any) => row.location).sort();
-}
+    const uniqueZones = Array.from(new Set(zones));
+
+    const results: string[] = [];
+    const missing: string[] = [];
+
+    for (let i = 0; i < uniqueZones.length; i++) {
+        const zone = uniqueZones[i];
+        const cached = getCache(zone);
+
+        if (cached) {
+            for (let j = 0; j < cached.length; j++) {
+                results.push(cached[j]);
+            }
+        } else {
+            missing.push(zone);
+        }
+    }
+
+    if (missing.length > 0) {
+        const rows = await bootstrap.database
+            .prepare(
+                `SELECT id, location FROM shapefiles WHERE id IN (${missing.map(() => '?').join(',')})`
+            )
+            .all(...missing);
+
+        for (let i = 0; i < rows.length; i++) {
+            const r = rows[i] as any;
+            setCache(r.id, [r.location]);
+            results.push(r.location);
+        }
+    }
+    return results;
+};

package/src/@parsers/@ugc/ugc.setCache.ts

@@ -0,0 +1,28 @@
+/*
+              _                             _               _     __   __
+         /\  | |                           | |             (_)    \ \ / /
+        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ 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 { bootstrap } from "../../bootstrap";
+
+export const setCache = (key: string, value: string[]) => {
+	if (bootstrap.cache.ugc.size >= 5000) {
+        const firstKey = bootstrap.cache.ugc.keys().next().value;
+        bootstrap.cache.ugc.delete(firstKey);
+    }
+    bootstrap.cache.ugc.set(key, value);
+};

package/src/@types/type.settings.ts

@@ -23,6 +23,7 @@ export type TypeSettings = {
     Database: string
     EnableWireService: boolean
     EnableJournal: boolean
+    EnableDebugging: boolean
     NOAAWeatherWireServiceSettings: {
         ReconnectionSettings: {
             Enabled: boolean

package/src/bootstrap.ts

@@ -21,7 +21,7 @@ import path from 'path'
 import { EventEmitter } from 'node:events';
 
 export const bootstrap = {
-    version: `3.0.47`,
+    version: `3.0.51`,
     isReady: true,
     ratelimits: {},
     session_xmpp: null,
@@ -42,10 +42,13 @@ export const bootstrap = {
         events: {type: "FeatureCollection", features: []},
         nodes: {type: "FeatureCollection", features: []},
         hashes: [],
+        processed: [],
+        ugc: new Map<string, string[]>()
     },
     settings: {
         Database: path.join(process.cwd(), 'shapefiles.db'),
         EnableWireService: true,
+        EnableDebugging: false,
         EnableJournal: true,
         NOAAWeatherWireServiceSettings: {
             ReconnectionSettings: {

package/test.js

@@ -4,6 +4,7 @@ const Client = new Manager({
     Database: `shapefiles.db`,
     EnableWireService: false,
     EnableJournal: true,
+    EnableDebugging: false,
     NOAAWeatherWireServiceSettings: {
         ReconnectionSettings: {
             Enabled: true,
@@ -61,30 +62,23 @@ const Client = new Manager({
         NodeMinDistance: 120,
         EventFiltering: {
             ListeningEvents: [
-                "Tornado Emergency", "PDS Tornado Warning", "Tornado Warning",
-                "Confirmed Tornado Warning", "Radar Indicated Tornado Warning",
-                "Special Marine Warning (TPROB)", "PDS Tornado Watch", "Tornado Watch",
-                "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)", "Severe Thunderstorm Warning",
-                "Severe Thunderstorm Watch",
-                "Flash Flood Emergency", "Flash Flood Warning",
-                "Flash Flood Watch",
-                "Tsunami Warning", "Tsunami Watch",
-                "Tsunami Advisory", "Special Marine Warning",
-                "Earthquake Warning",
-                "Hurricane Warning", "Hurricane Watch",
-                "Tropical Storm Warning",
-                "Winter Storm Warning", "Blizzard Warning",
-                "Ice Storm Warning", "Snow Squall Warning",
-                "Winter Weather Advisory", "Extreme Cold Watch"
+                "*Severe Thunderstorm Warning*",
+                "*Blizzard*", "*Ice Storm*", "*Winter Storm*", "*Snow Squall*",
+                "Tornado Emergency", "*Tornado Warning*",
+                "Special Weather Statement", "Marine Weather Statement",
+                "*Tsunami*", "*Hurricane*", "*Tropical Storm*", "*Special Marine*",
+                "*Flash Flood Warning*", "*Flash Flood Watch*", "*Flash Flood Advisory*",
+                "Mesoscale Discussion",
+                "SPC Day 1 Outlook", "SPC Day 2 Outlook", "SPC Day 3 Outlook",
+                "PDS Tornado Watch", "Tornado Watch", "Severe Thunderstorm Watch", "Flash Flood Watch", "PDS Severe Thunderstorm Watch",
+                "*Administrative*", "National Weather Service Policy",
+                "Fire Weather Warning", "Fire Weather Watch", "Fire Weather Advisory",
             ],
-            ListeningICAO: [],
+            ListeningICAO: [`KLOT`],
             IgnoredICAO: [],
             IgnoredEvents: [],
-            ListeningUGC: [],
-            ListeningStates: [],
+            ListeningUGC: [`WIC001`],
+            ListeningStates: [`MO`, `IA`],
             NodeLocationFiltering: false,
             IgnoreTestProducts: true,
         },

package/tsup.config.ts

@@ -4,7 +4,7 @@ export default defineConfig({
 	entry: ['src/index.ts'],
 	outDir: 'dist',
 	format: ['esm', 'cjs'],
-	dts: true,
+	dts: false,
 	noExternal: ["@xmpp/client", "@xmpp/sasl", "@xmpp/sasl-plain"],
 	clean: true,
 	outExtension({ format }) {

package/dist/index.d.mts

@@ -1,299 +0,0 @@
-type TypeListener = {
-    events: string[];
-    webhook?: {
-        enabled: boolean;
-        destination: string;
-        ratelimit: number;
-        title: string;
-        message: string;
-    };
-    uploads?: {
-        file?: boolean;
-        eas?: boolean;
-        event?: boolean;
-    };
-};
-
-type TypeSettings = {
-    Database: string;
-    EnableWireService: boolean;
-    EnableJournal: boolean;
-    NOAAWeatherWireServiceSettings: {
-        ReconnectionSettings: {
-            Enabled: boolean;
-            ReconnectionInterval: number;
-        };
-        CredentialSettings: {
-            Username: string | void;
-            Password: string | void;
-            Nickname: string | void;
-        };
-        CacheSettings: {
-            Enabled: boolean;
-            MaxDatabaseHistory: number;
-            MaxRetentionHistory: number;
-        };
-        StanzaSettings: {
-            DisableUGC: boolean;
-            DisableVTEC: boolean;
-            DisableText: boolean;
-        };
-    };
-    NationalWeatherServiceSettings: {
-        CallbackInterval: number;
-        EventsEndpoint: string;
-    };
-    BroadcastifySettings: {
-        BroadcastifyAttachments: boolean;
-        BroadcastifyDatabase: string;
-        BroadcastifyTags: string[];
-    };
-    GlobalSettings: {
-        EventManagement: boolean;
-        BetterEventNames: boolean;
-        DisableGeometryParsing: boolean;
-        UseShapefileCoordinates: boolean;
-        SPCWatchesOnly: boolean;
-        ShapefileSkipPoints: number;
-        NodeTTL: number;
-        NodeMinDistance: number;
-        ListenerSettings?: TypeListener[];
-        EventFiltering: {
-            ListeningEvents: string[];
-            ListeningICAO: string[];
-            ListeningUGC: string[];
-            ListeningStates: string[];
-            IgnoredICAO: string[];
-            IgnoredEvents: string[];
-            NodeLocationFiltering: boolean;
-            IgnoreTestProducts: boolean;
-        };
-        ArchiveSettings: {
-            TTL: number;
-            EventDirectory: string;
-            TextDirectory: string;
-            EasDirectory: string;
-            EasToneout: string;
-        };
-    };
-};
-
-declare const setSettings: (newSettings: TypeSettings) => TypeSettings;
-
-type TypeAttributes = {
-    xmlns: string;
-    id: string;
-    issue: string;
-    ttaaii: string;
-    cccc: string;
-    awipsid: string;
-};
-
-type TypeEventProperties = {
-    locations: string;
-    locations_array: string[];
-    description: string;
-    attributes?: TypeAttributes;
-    geocode: {
-        office: {
-            name: string;
-            office: string;
-        };
-        organization: string;
-        ugc: string[];
-        polygon: string;
-        polygon_generated: boolean;
-    };
-    parameters?: {
-        tags: string[];
-        instructions: string;
-        source: string;
-        hazards: string;
-        impacts: string;
-        estimated_hail_size: string;
-        estimated_wind_gusts: string;
-        damage_threat: string;
-        tornado_threat: string;
-        flood_threat: string;
-        wind_threat: string;
-        hail_threat: string;
-        max_hail_inches?: string;
-        max_wind_gusts_surface_knots?: string;
-        max_tops_x100feet?: string;
-        mean_storm_motion_vector?: string;
-        particularly_dangerous_situation?: string;
-    };
-    watch_parameters?: {
-        watch_number: string;
-        watch_type: string;
-        additional_tornadoes_probability: string;
-        strong_tornadoes_probability: string;
-        severe_wind_probability: string;
-        severe_hail_probability: string;
-        hail_2in_probability: string;
-        combined_hail_wind_probability: string;
-        max_hail_in: string;
-        max_wind_surface: string;
-        max_tops_x100feet: string;
-        pds_watch: boolean;
-    };
-    discussion_parameters?: {
-        discussion_number: string;
-        discussion_concerning: string;
-        discussion_max_tornado: string;
-        discussion_max_hail: string;
-        discussion_max_wind: string;
-        discussion_watch_issuance: string;
-    };
-};
-
-type TypeHVTEC = {
-    hvtec: string;
-    severity: string;
-    cause: string;
-    record: string;
-};
-
-type TypePVTEC = {
-    vtec: string;
-    product: string;
-    tracking: string;
-    event: string;
-    status: string;
-    organization: string;
-    expires: string;
-    is_watch: boolean;
-    prediction_center: boolean;
-};
-
-type TypeEvent = {
-    type: string;
-    geometry: {
-        type: string;
-        coordinates: number[][];
-    };
-    properties: {
-        event: string;
-        parent: string;
-        status: string;
-        issued: string;
-        expires: string;
-        status_metadata?: {
-            is_issued?: boolean;
-            is_updated?: boolean;
-            is_expired?: boolean;
-            is_test?: boolean;
-            is_statement?: boolean;
-        };
-        metadata: {
-            ms: number;
-            source: string;
-            tracking: string;
-            hash?: string;
-            header: string;
-            vtec?: TypePVTEC | null;
-            hvtec?: TypeHVTEC[] | null;
-            nodes?: {
-                id?: string | number;
-                coordinates: [number, number];
-                nearest: [number, number];
-                miles: number | null;
-                kilometers: number | null;
-                proximity: boolean;
-            }[];
-            filtered_proximity?: boolean;
-            updated?: number;
-            history: {
-                description: string;
-                issued: string;
-                status: string;
-            }[];
-            attachments?: {
-                name: string;
-                link: string;
-            }[];
-            raw: string;
-        };
-    } & TypeEventProperties;
-};
-
-interface GetGeometryResponse {
-    type: `Polygon` | `MultiPolygon`;
-    coordinates: any[];
-}
-declare const getEventGeometry: (event: TypeEvent) => Promise<GetGeometryResponse>;
-
-declare const getCleanedEvent: <T extends Record<string, any>>(event: T) => T;
-
-declare const startService: (configurations: TypeSettings) => Promise<void>;
-
-declare const stopService: () => Promise<void>;
-
-interface GenerateEASOptions {
-    message: string;
-    header: string;
-    title: string;
-}
-declare const setEasTone: (options: GenerateEASOptions) => Promise<string>;
-
-interface GetNodeOptions {
-    identifier: string;
-    delete?: boolean;
-    coordinates: {
-        longitude: number;
-        latitude: number;
-    };
-}
-declare const setNode: (options: GetNodeOptions) => void;
-
-declare const getEvents: () => any;
-
-declare const getNodes: () => any;
-
-interface CreateEventOptions {
-    event: string;
-    status: string;
-    issued: Date;
-    expires: Date;
-    locations: string;
-    description: string;
-    coordinates: number[][];
-}
-declare const createEvent: (options: CreateEventOptions) => void;
-
-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 {
-    constructor(settings: TypeSettings);
-    on(event: string, callback: () => void): void;
-    trycatch(): void;
-}
-
-export { Manager, type TypeEvent, clearEvents, createEvent, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, query, setEasTone, setNode, setSettings, startService, stopService };