@atmosx/event-product-parser 2.0.1 → 2.0.11

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+AtmosphericX is an independent, open source project and is **not** affiliated with, endorsed by, or sponsored by any government agency, meteorological organization, emergency management service, or official weather provider. This project may reference, parse, or process publicly available weather data, including but **not** limited to services operated by the National Weather Service (NWS) and the National Oceanic and Atmospheric Administration (NOAA). All trademarks, service marks, and data rights remain the property of their respective owners. AtmosphericX is provided "as is", without warranty of any kind, express or implied, including but **not** limited to:
+
+- Accuracy or completeness of parsed weather data
+- Fitness for a particular purpose
+- Protection against sources and data retrieval
+- Availability or reliability of upstream data sources
+- Protection against service interruptions or data delays
+
+AtmosphericX should **not** be relied upon for life safety decisions, emergency response coordination, aviation, marine navigation, or other critical applications. Always consult official sources for authoritative weather information. By using this software, you acknowledge and agree that the maintainers and contributors are **not** liable for any damages, losses, or consequences resulting from its use.

package/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+This project is community driven and primarily maintained by `k3yomi` and `StarflightWx`
+
+## How to Contribute
+
+At this time, contributions are limited to:
+
+- **Corrections** – Fix broken TypeScript syntax, outdated operations, or errors.  
+- **Additions** – Add new functions, tools, or services.  
+- **Clarity Improvements** – Improve explanations in plain English.  
+- **Documentation** – Add helpful content to the documentation.
+
+## What Will Not Be Accepted
+
+- Content that introduces new packages.  
+- Anything that violates GitHub's Terms of Service.
+
+## How to Submit
+
+1. Fork the repository.  
+2. Create a new branch: `fix/description` or `add/description`.  
+3. Make your changes.  
+4. Open a pull request with a clear description of **what changed and why**.
+
+## Requirements
+
+- Use **plain English first, details later**.  
+- Provide **real working examples only** (do not make up syntax).  
+- Follow the existing **file structure and function signature format**.

package/README.md

@@ -12,8 +12,7 @@
 
 ## Installation (NPM)
 ```bash
-npm install @atmosx/event-product-parser@latest # Latest
-npm install @atmosx/event-product-parser@beta # Beta
+npm install @atmosx/event-product-parser@latest
 ```
 
 ## Example Usage

package/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Reporting Vulnerabilities
+If you discover a security vulnerability or issue in this repository such as exposed sensitive data, misconfigurations, or content that could cause harm. Please report it **immediately and responsibly**.  
+
+**Do not report security issues publicly.**  
+Instead, report privately by emailing **antimal@scriptkitty.cafe**, clearly describing the vulnerability.
+
+## What to Include
+When reporting a vulnerability, please include:  
+- A detailed description of the issue  
+- Affected files (include line numbers if possible)  
+- Any recommendations  
+
+## Response
+All reports will be reviewed and addressed as quickly as possible.  
+This is a community driven project, so response times may vary. Please allow up to a few weeks for a full response.  
+
+## Scope
+This repository **does not contain any credentials, keys, tokens, or personally identifiable information (PII)**.  
+If you discover any such data, report it immediately.

package/dist/cjs/index.cjs

@@ -6513,6 +6513,41 @@ var Database = class {
       }
     });
   }
+  /**
+   * @function loadCollectionCache
+   * @description
+   *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
+   *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
+   *     
+   * @static
+   * @async
+   * @returns {Promise<void>}
+   */
+  static loadCollectionCache() {
+    return __async(this, null, function* () {
+      var _a;
+      try {
+        const settings2 = settings;
+        if (settings2.noaa_weather_wire_service_settings.cache.enabled) {
+          const maxRows = (_a = settings2.noaa_weather_wire_service_settings.cache.max_db_cache_size) != null ? _a : 5e3;
+          const rows = yield cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`).all(maxRows);
+          utils_default.warn(definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
+          const eventsToProcess = rows.map((row) => {
+            return JSON.parse(row.stanza);
+          }).filter((validate) => {
+            if (!validate) return false;
+            const skip = validate.ignore || validate.isCap && !settings2.noaa_weather_wire_service_settings.preferences.cap_only || !validate.isCap && settings2.noaa_weather_wire_service_settings.preferences.cap_only || validate.isCap && !validate.isCapDescription;
+            return !skip;
+          });
+          yield Promise.all(eventsToProcess.map((validate) => events_default.eventHandler(validate)));
+          utils_default.warn(definitions.messages.dump_cache_complete, true);
+          return;
+        }
+      } catch (error) {
+        utils_default.warn(`Failed to load cache: ${error.stack}`);
+      }
+    });
+  }
 };
 var database_default = Database;
 
@@ -6686,41 +6721,6 @@ var Utils = class _Utils {
     cache.lastWarn = Date.now();
     console.warn(`\x1B[33m[ATMOSX-PARSER]\x1B[0m [${(/* @__PURE__ */ new Date()).toLocaleString()}] ${message}`);
   }
-  /**
-   * @function loadCollectionCache
-   * @description
-   *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
-   *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
-   *     
-   * @static
-   * @async
-   * @returns {Promise<void>}
-   */
-  static loadCollectionCache() {
-    return __async(this, null, function* () {
-      var _a;
-      try {
-        const settings2 = settings;
-        if (settings2.noaa_weather_wire_service_settings.cache.enabled) {
-          const maxRows = (_a = settings2.noaa_weather_wire_service_settings.cache.max_db_cache_size) != null ? _a : 5e3;
-          const rows = yield cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`).all(maxRows);
-          this.warn(definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
-          const eventsToProcess = rows.map((row) => {
-            return JSON.parse(row.stanza);
-          }).filter((validate) => {
-            if (!validate) return false;
-            const skip = validate.ignore || validate.isCap && !settings2.noaa_weather_wire_service_settings.preferences.cap_only || !validate.isCap && settings2.noaa_weather_wire_service_settings.preferences.cap_only || validate.isCap && !validate.isCapDescription;
-            return !skip;
-          });
-          yield Promise.all(eventsToProcess.map((validate) => events_default.eventHandler(validate)));
-          this.warn(definitions.messages.dump_cache_complete, true);
-          return;
-        }
-      } catch (error) {
-        _Utils.warn(`Failed to load cache: ${error.stack}`);
-      }
-    });
-  }
   /**
    * @function loadGeoJsonData
    * @description
@@ -7480,7 +7480,7 @@ var Manager = class {
         (() => __async(this, null, function* () {
           try {
             yield xmpp_default.deploySession();
-            yield utils_default.loadCollectionCache();
+            yield database_default.loadCollectionCache();
           } catch (err) {
             const msg = err instanceof Error ? err.message : String(err);
             utils_default.warn(`Failed to initialize NWWS services: ${msg}`);

package/dist/esm/index.mjs

@@ -6501,6 +6501,41 @@ var Database = class {
       }
     });
   }
+  /**
+   * @function loadCollectionCache
+   * @description
+   *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
+   *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
+   *     
+   * @static
+   * @async
+   * @returns {Promise<void>}
+   */
+  static loadCollectionCache() {
+    return __async(this, null, function* () {
+      var _a;
+      try {
+        const settings2 = settings;
+        if (settings2.noaa_weather_wire_service_settings.cache.enabled) {
+          const maxRows = (_a = settings2.noaa_weather_wire_service_settings.cache.max_db_cache_size) != null ? _a : 5e3;
+          const rows = yield cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`).all(maxRows);
+          utils_default.warn(definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
+          const eventsToProcess = rows.map((row) => {
+            return JSON.parse(row.stanza);
+          }).filter((validate) => {
+            if (!validate) return false;
+            const skip = validate.ignore || validate.isCap && !settings2.noaa_weather_wire_service_settings.preferences.cap_only || !validate.isCap && settings2.noaa_weather_wire_service_settings.preferences.cap_only || validate.isCap && !validate.isCapDescription;
+            return !skip;
+          });
+          yield Promise.all(eventsToProcess.map((validate) => events_default.eventHandler(validate)));
+          utils_default.warn(definitions.messages.dump_cache_complete, true);
+          return;
+        }
+      } catch (error) {
+        utils_default.warn(`Failed to load cache: ${error.stack}`);
+      }
+    });
+  }
 };
 var database_default = Database;
 
@@ -6674,41 +6709,6 @@ var Utils = class _Utils {
     cache.lastWarn = Date.now();
     console.warn(`\x1B[33m[ATMOSX-PARSER]\x1B[0m [${(/* @__PURE__ */ new Date()).toLocaleString()}] ${message}`);
   }
-  /**
-   * @function loadCollectionCache
-   * @description
-   *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
-   *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
-   *     
-   * @static
-   * @async
-   * @returns {Promise<void>}
-   */
-  static loadCollectionCache() {
-    return __async(this, null, function* () {
-      var _a;
-      try {
-        const settings2 = settings;
-        if (settings2.noaa_weather_wire_service_settings.cache.enabled) {
-          const maxRows = (_a = settings2.noaa_weather_wire_service_settings.cache.max_db_cache_size) != null ? _a : 5e3;
-          const rows = yield cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`).all(maxRows);
-          this.warn(definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
-          const eventsToProcess = rows.map((row) => {
-            return JSON.parse(row.stanza);
-          }).filter((validate) => {
-            if (!validate) return false;
-            const skip = validate.ignore || validate.isCap && !settings2.noaa_weather_wire_service_settings.preferences.cap_only || !validate.isCap && settings2.noaa_weather_wire_service_settings.preferences.cap_only || validate.isCap && !validate.isCapDescription;
-            return !skip;
-          });
-          yield Promise.all(eventsToProcess.map((validate) => events_default.eventHandler(validate)));
-          this.warn(definitions.messages.dump_cache_complete, true);
-          return;
-        }
-      } catch (error) {
-        _Utils.warn(`Failed to load cache: ${error.stack}`);
-      }
-    });
-  }
   /**
    * @function loadGeoJsonData
    * @description
@@ -7468,7 +7468,7 @@ var Manager = class {
         (() => __async(this, null, function* () {
           try {
             yield xmpp_default.deploySession();
-            yield utils_default.loadCollectionCache();
+            yield database_default.loadCollectionCache();
           } catch (err) {
             const msg = err instanceof Error ? err.message : String(err);
             utils_default.warn(`Failed to initialize NWWS services: ${msg}`);

package/package.json

@@ -1,14 +1,9 @@
 {
 	"name": "@atmosx/event-product-parser",
-	"version": "2.0.01",
+	"version": "2.0.011",
 	"description": "NOAA Weather Wire & NWS API Parser - Built for standalone and Project AtmosphericX Integration.",
 	"main": "dist/cjs/index.cjs",
 	"module": "dist/esm/index.mjs",
-	"types": "dist/index.d.ts",
-	"files": [
-        "dist/**/*",
-        "src/**/*"
-    ],
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/AtmosphericX/event-product-parser",

package/src/@submodules/database.ts

@@ -14,6 +14,7 @@
 import * as loader from '../bootstrap';
 import * as types from '../types';
 import Utils from './utils';
+import EventParser from '../@parsers/events';
 
 export class Database {
 
@@ -157,6 +158,43 @@ export class Database {
             Utils.warn(`Failed to load database: ${msg}`);
         }
     }
+    
+    /**
+     * @function loadCollectionCache
+     * @description
+     *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
+     *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
+     *     
+     * @static
+     * @async
+     * @returns {Promise<void>}
+     */
+    public static async loadCollectionCache(): Promise<void> {
+        try {
+            const settings = loader.settings as types.ClientSettingsTypes;
+            if (settings.noaa_weather_wire_service_settings.cache.enabled) {
+                const maxRows = settings.noaa_weather_wire_service_settings.cache.max_db_cache_size ?? 5000;
+                const rows = await loader.cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`)
+                    .all(maxRows) as { rowid: number; stanza: string }[];
+                Utils.warn(loader.definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
+                const eventsToProcess = rows
+                    .map(row => {return JSON.parse(row.stanza)})
+                    .filter(validate => {
+                        if (!validate) return false;
+                        const skip = validate.ignore ||
+                            (validate.isCap && !settings.noaa_weather_wire_service_settings.preferences.cap_only) ||
+                            (!validate.isCap && settings.noaa_weather_wire_service_settings.preferences.cap_only) ||
+                            (validate.isCap && !validate.isCapDescription);
+                        return !skip;
+                    });
+                await Promise.all(eventsToProcess.map(validate => EventParser.eventHandler(validate)));
+                Utils.warn(loader.definitions.messages.dump_cache_complete, true);
+                return;
+            }
+        } catch (error: any) {
+            Utils.warn(`Failed to load cache: ${error.stack}`);
+        }
+    }
 }
 
 export default Database;

package/src/@submodules/utils.ts

@@ -13,7 +13,6 @@
 
 import * as loader from '../bootstrap';
 import * as types from '../types';
-import StanzaParser from '../@parsers/stanza';
 import EventParser from '../@parsers/events';
 import Xmpp from './xmpp';
 
@@ -52,43 +51,6 @@ export class Utils {
         console.warn(`\x1b[33m[ATMOSX-PARSER]\x1b[0m [${new Date().toLocaleString()}] ${message}`);
     }
 
-    /**
-     * @function loadCollectionCache
-     * @description
-     *      Loads cached stanzas from the database, validates them, and processes them through the event parser. 
-     *      Only processes stanzas that are not marked to be ignored and match the CAP preferences.
-     *     
-     * @static
-     * @async
-     * @returns {Promise<void>}
-     */
-    public static async loadCollectionCache(): Promise<void> {
-        try {
-            const settings = loader.settings as types.ClientSettingsTypes;
-            if (settings.noaa_weather_wire_service_settings.cache.enabled) {
-                const maxRows = settings.noaa_weather_wire_service_settings.cache.max_db_cache_size ?? 5000;
-                const rows = await loader.cache.db.prepare(`SELECT * FROM stanzas ORDER BY rowid DESC LIMIT ?`)
-                    .all(maxRows) as { rowid: number; stanza: string }[];
-                this.warn(loader.definitions.messages.dump_cache.replace(`{count}`, rows.length.toString()), true);
-                const eventsToProcess = rows
-                    .map(row => {return JSON.parse(row.stanza)})
-                    .filter(validate => {
-                        if (!validate) return false;
-                        const skip = validate.ignore ||
-                            (validate.isCap && !settings.noaa_weather_wire_service_settings.preferences.cap_only) ||
-                            (!validate.isCap && settings.noaa_weather_wire_service_settings.preferences.cap_only) ||
-                            (validate.isCap && !validate.isCapDescription);
-                        return !skip;
-                    });
-                await Promise.all(eventsToProcess.map(validate => EventParser.eventHandler(validate)));
-                this.warn(loader.definitions.messages.dump_cache_complete, true);
-                return;
-            }
-        } catch (error: any) {
-            Utils.warn(`Failed to load cache: ${error.stack}`);
-        }
-    }
-
     /**
      * @function loadGeoJsonData
      * @description

package/src/index.ts

@@ -168,7 +168,7 @@ export class Manager {
             (async () => {
                 try {
                     await Xmpp.deploySession();
-                    await Utils.loadCollectionCache();
+                    await Database.loadCollectionCache();
                 } catch (err: unknown) {
                     const msg = err instanceof Error ? err.message : String(err);
                     Utils.warn(`Failed to initialize NWWS services: ${msg}`);

package/test.js

@@ -0,0 +1,62 @@
+const { AlertManager } = require(`@atmosx/event-product-parser`)
+
+
+const parser = new AlertManager({ 
+    database: `shapefile-manager.db`,
+    is_wire: true,
+    journal: true,
+    noaa_weather_wire_service_settings: {
+        reconnection_settings: {
+            enabled: true,
+            interval: 60,
+        },
+        credentials: {
+            username: `username123`,
+            password: `password123`,
+            nickname: "AtmosphericX Standalone Parser",
+        },   
+        cache: {
+            enabled: false,
+            max_db_history: 5000,
+            max_db_cache_size: 1000,
+        },
+        preferences: {
+            disable_ugc: false,
+            disable_vtec: false,
+            disable_text: false,
+            cap_only: false,
+        }
+    },
+    national_weather_service_settings: {
+        interval: 15,
+        endpoint: `https://api.weather.gov/alerts/active`,
+    },
+    global_settings: {
+        parent_events_only: true,
+        better_event_parsing: true,
+        ignore_geometry_parsing: false,
+        shapefile_coordinates: true,
+        filtering: {
+            events: [`Severe Thunderstorm Warning`],
+            filtered_icao: ["PAFC"],
+            ignored_icao: [],
+            ignored_events: [`Xx`, `Test Message`],
+            ugc_filter: [],
+            state_filter: [],
+            check_expired: true,
+            ignore_test_products: true,
+        },
+        eas_settings: {
+            directory: null,
+            intro_wav: null,
+        }
+    }
+})
+
+parser.on(`onEvents`, (alerts) => {
+   for (const alert of alerts) {
+        if (alert.geometry != null) {
+            console.log(`[${ new Date(alert.properties.issued).toLocaleString()}] ${alert.properties.event} for ${alert.properties.locations} (ID: ${alert.properties.details.tracking})`);
+        }
+    }
+});

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+	"compilerOptions": {
+		"target": "ES6",
+		"module": "ESNext",
+		"moduleResolution": "Node",
+		"outDir": "dist",
+		"declaration": true,
+		"declarationDir": "dist/types",
+		"esModuleInterop": true,
+		"allowSyntheticDefaultImports": true,
+		"skipLibCheck": true
+	},
+	"include": ["src"]
+}

package/tsup.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+	entry: ['src/index.ts'],
+	outDir: 'dist',
+	format: ['esm', 'cjs'],
+	noExternal: ["@xmpp/client", "@xmpp/sasl", "@xmpp/sasl-plain"],
+	clean: true,
+	outExtension({ format }) {
+		return { js: format === 'esm' ? '.mjs' : '.cjs' }
+	},
+	esbuildOptions(options, context) {
+		options.outdir = `dist/${context.format}`
+	},
+})