@atmosx/event-product-parser 3.0.4 → 3.0.7

package/src/{@types/types.settings.ts → types/Settings.ts}

@@ -11,18 +11,23 @@
     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
+    Documentation: https://atmosphericx.scriptkitty.cafe/documentation
 
-    Internal Package: @atmosx/event-product-parser
+    Independent Package: @atmosx/event-product-parser
 
 */
 
-import { TypeWebhook } from "./types.webhook"
+import { TypeActions } from "Types/Actions"
+
+type TypeTimezones = string | "CST" | "CDT" | "MDT" | "MST" | "EST" | "EDT" | "HST" | "HDT" | "PDT" | "UTC"
 
 export type TypeSettings = {
+    Timezone?: TypeTimezones
     Database: string
+    DebugDisableAllEvents: boolean
     EnableWireService: boolean
     EnableJournal: boolean
+    EnableDebugging: boolean
     NOAAWeatherWireServiceSettings: {
         ReconnectionSettings: {
             Enabled: boolean
@@ -48,16 +53,37 @@ export type TypeSettings = {
         CallbackInterval: number
         EventsEndpoint: string
     }
+    BroadcastifySettings: {
+        BroadcastifyAttachments: boolean
+        BroadcastifyDatabase: string
+        BroadcastifyTags: string[]
+    },
+    BoundarySettings: {
+        BoundaryDatabase: string
+        CityDatabase: string
+    },
+    NotifyServer: {
+        Enabled: boolean
+        Server: string
+        MediaStorage: {
+            TEXT?: string
+            JSON?: string
+            AUDIO?: string
+            IMAGE?: string
+        }
+        Credentials?: {
+            Username: string | void
+            Password: string | void
+        }
+    }
+    ActionSettings?: TypeActions[]
     GlobalSettings: {
         EventManagement: boolean
-        BetterEventNames: boolean
         DisableGeometryParsing: boolean
         UseShapefileCoordinates: boolean
         SPCWatchesOnly: boolean
-        ShapefileSkipPoints: number
         NodeTTL: number
-        NodeMinDistance: number
-        WebhookSettings?: TypeWebhook
+        NodeMaxDistance: number
         EventFiltering: {
             ListeningEvents: string[]
             ListeningICAO: string[]
@@ -68,9 +94,15 @@ export type TypeSettings = {
             NodeLocationFiltering: boolean
             IgnoreTestProducts: boolean
         },
-        EASSettings: {
-            ArchiveDirectory: string,
-            IntroWavFile: string,
+        Themes: { Event: string, RGB: string }[]
+        ArchiveSettings: {
+            TTL: number
+            ImageDirectory: string
+            JSONDirectory: string
+            TextDirectory: string
+            AudioDirectory: string
+            Logo: string
+            AudioToneout: string
         }
     }
 }

package/src/{@types/types.compiled.ts → types/StanzaCompiled.ts}

@@ -11,25 +11,26 @@
     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
+    Documentation: https://atmosphericx.scriptkitty.cafe/documentation
 
-    Internal Package: @atmosx/event-product-parser
+    Independent Package: @atmosx/event-product-parser
 
 */
 
-import { TypeAttributes } from "./types.attributes"
+import { TypeAttributes } from "StaticTypes/Attributes"
 
 export type TypeStanzaCompiled = {
-    message?: string
-    attributes?: TypeAttributes
-    isCapEvent?: boolean
-    isVTEC?: boolean
-    isUGC?: boolean
-    isCapAreaDescription?: boolean
-    isIgnored?: boolean
-    isNWWS?: boolean
-    getType?: {
-        type: string
-        prefix: string
+    Message?: string
+    Attributes?: TypeAttributes
+    CapEvent?: boolean
+    VTEC?: boolean
+    UGC?: boolean
+    CapAreaDescription?: boolean
+    Ignored?: boolean
+    NWWS?: boolean
+    Type?: {
+        Type: string
+        Prefix: string
+        Discovered: boolean
     }
 }

package/src/{@types/types.ugc.ts → types/UGC.ts}

@@ -11,14 +11,14 @@
     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
+    Documentation: https://atmosphericx.scriptkitty.cafe/documentation
 
-    Internal Package: @atmosx/event-product-parser
+    Independent Package: @atmosx/event-product-parser
 
 */
 
 export type TypeUGC = { 
-    zones: string[]
-    locations: string[]
-    expires: string
+    Zones: string[]
+    Locations: string[]
+    Expires: string
 }

package/src/{@modules/@utilities/utilities.getSettings.ts → types/VTEC.ts}

@@ -11,15 +11,20 @@
     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
+    Documentation: https://atmosphericx.scriptkitty.cafe/documentation
 
-    Internal Package: @atmosx/event-product-parser
+    Independent Package: @atmosx/event-product-parser
 
 */
 
-import { TypeSettings } from '../../@types/types.settings'
-import { bootstrap } from "../../bootstrap"
-
-export const getSettings = (): TypeSettings => {
-    return bootstrap.settings;
+export type TypeVTEC = { 
+    Raw: string
+    ProductType: string
+    Tracking: string
+    Event: string
+    Status: string
+    WMO: string
+    Expires: string
+    Watch: boolean
+    PredictionCenter: boolean
 }

package/tools/build.js

@@ -0,0 +1,47 @@
+const { spawn } = require("child_process");
+const watch = process.argv.includes("--watch");
+
+const commands = [
+    {
+        name: "esm",
+        args: [
+            "--bundle",
+            "--platform=node",
+            "--target=node22",
+            "--format=esm",
+            "--external:better-sqlite3",
+            "--external:sharp",
+            "--out-extension:.js=.mjs",
+            "--outdir=dist/esm",
+            ...(watch ? ["--watch"] : []),
+            "./src/index.ts",
+        ],
+    },
+    {
+        name: "cjs",
+        args: [
+            "--bundle",
+            "--platform=node",
+            "--target=node22",
+            "--format=cjs",
+            "--external:better-sqlite3",
+            "--external:sharp",
+            "--out-extension:.js=.cjs",
+            "--outdir=dist/cjs",
+            ...(watch ? ["--watch"] : []),
+            "./src/index.ts",
+        ],
+    },
+];
+
+function runBuild({ name, args }) {
+    return new Promise((resolve, reject) => {
+        const proc = spawn("esbuild", args, {
+            shell: true,
+            stdio: "inherit",
+        });
+        proc.on("error", reject);
+    });
+}
+
+Promise.all(commands.map(runBuild)).catch((err) => { console.error(err); process.exit(1); });

package/tsconfig.json

@@ -8,7 +8,34 @@
 		"declarationDir": "dist/types",
 		"esModuleInterop": true,
 		"allowSyntheticDefaultImports": true,
-		"skipLibCheck": true
+		"skipLibCheck": true,
+		"strict": true,
+        "strictNullChecks": false, // Note: I use optional changing and heavily rely on `null` and `undefined` values in the codebase. Please do not set this to true unless you want the compiler to throw a fucking temper tantrum every time you try to access a property of an object that may or may not be null or undefined. I have better things to do than to deal with that nonsense.
+		"noImplicitAny": true,
+		"paths": {
+			"@ParsingHVTEC/*": ["./src/parsers/hvtec/*"],
+			"@ParsingVTEC/*": ["./src/parsers/vtec/*"],
+			"@ParsingUGC/*": ["./src/parsers/ugc/*"],
+			"@ParsingText/*": ["./src/parsers/text/*"],
+			"@Database/*": ["./src/components/database/*"],
+			"@Audio/*": ["./src/components/audio/*"],
+			"@AudioComponents/*": ["./src/components/audio/components/*"],
+			"@Image/*": ["./src/components/images/*"],
+			"@ImageModules/*": ["./src/components/images/modules/*"],
+			"@ImageComponents/*": ["./src/components/images/components/*"],
+			"@Stanza/*": ["./src/components/stanza/*"],
+			"@Utilities/*": ["./src/components/utilities/*"],
+			"@XMPP/*": ["./src/components/xmpp/*"],
+			"@Manager/*": ["./src/manager/*"],
+			"@Tasks/*": ["./src/tasks/*"],
+			"@Events/*": ["./src/events/*"],
+			"@Enums/*": ["./src/enums/*"],
+			"@Core/*": ["./src/core/*"],
+			"@Building/*": ["./src/building/*"],
+			"Types/*": ["./src/types/*"],
+			"StaticTypes/*": ["./src/static/*"],
+			"@Bootstrap": ["./src/bootstrap.ts"],
+		}
 	},
 	"include": ["src"]
 }

package/dist/index.d.mts

@@ -1,239 +0,0 @@
-type TypeWebhook = {
-    webhook: string;
-    title: string;
-    message: string;
-    upload: boolean;
-    rate: number;
-    events: string[];
-};
-
-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;
-    };
-    GlobalSettings: {
-        EventManagement: boolean;
-        BetterEventNames: boolean;
-        DisableGeometryParsing: boolean;
-        UseShapefileCoordinates: boolean;
-        SPCWatchesOnly: boolean;
-        ShapefileSkipPoints: number;
-        NodeTTL: number;
-        NodeMinDistance: number;
-        WebhookSettings?: TypeWebhook;
-        EventFiltering: {
-            ListeningEvents: string[];
-            ListeningICAO: string[];
-            ListeningUGC: string[];
-            ListeningStates: string[];
-            IgnoredICAO: string[];
-            IgnoredEvents: string[];
-            NodeLocationFiltering: boolean;
-            IgnoreTestProducts: boolean;
-        };
-        EASSettings: {
-            ArchiveDirectory: string;
-            IntroWavFile: 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;
-    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;
-    };
-    spc_parameters: {
-        spc_max_tornado: string;
-        spc_max_hail: string;
-        spc_max_wind: string;
-        spc_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[];
-            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;
-            }[];
-        };
-    } & 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;
-}
-declare const setEasTone: (options: GenerateEASOptions) => Promise<string>;
-
-interface GetAddChaserOptions {
-    identifier: string;
-    delete?: boolean;
-    coordinates: {
-        longitude: number;
-        latitude: number;
-    };
-}
-declare const setNode: (options: GetAddChaserOptions) => void;
-
-declare const getEvents: () => any;
-
-declare const getNodes: () => any;
-
-declare const getRandomEvent: () => any;
-
-declare const clearEvents: () => void;
-
-declare class Manager {
-    constructor(settings: TypeSettings);
-    on(event: string, callback: () => void): void;
-    trycatch(): void;
-}
-
-export { Manager, type TypeEvent, clearEvents, Manager as default, getCleanedEvent, getEventGeometry, getEvents, getNodes, getRandomEvent, setEasTone, setNode, setSettings, startService, stopService };