@atmosx/event-product-parser 2.0.16 → 3.0.0

package/src/@submodules/xmpp.ts

@@ -1,142 +0,0 @@
-/*
-                                            _               _     __   __
-         /\  | |                           | |             (_)    \ \ / /
-        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
-       / /\ \| __| "_ ` _ \ / _ \/ __| "_ \| "_ \ / _ \ "__| |/ __| > <  
-      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
-     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
-                                     | |                                 
-                                     |_|                                                                                                                
-    
-    Written by: KiyoWx (k3yomi)                
-*/
-
-import * as loader from '../bootstrap';
-import * as types from '../types';
-import Utils from './utils';
-import StanzaParser from '../@parsers/stanza';
-import Database from '../@submodules/database';
-import EventParser from '../@parsers/events';
-
-export class Xmpp { 
-
-    /** 
-     * @function isSessionReconnectionEligible
-     * @description
-     *     Checks if the XMPP session has been inactive longer than the given interval
-     *     and, if so, attempts a controlled reconnection.
-     *
-     * @async
-     * @static
-     * @param {number} currentInterval
-     * @returns {Promise<void>}
-     */
-    public static async isSessionReconnectionEligible(currentInterval: number): Promise<void> {
-        const settings = loader.settings as types.ClientSettingsTypes;
-        const lastStanzaElapsed = Date.now() - loader.cache.lastStanza;
-        const threshold = currentInterval * 1000;
-        if ((!loader.cache.isConnected && !loader.cache.sigHalt) || !loader.cache.session) { return; }
-        if (lastStanzaElapsed < threshold) { return; }
-        if (loader.cache.attemptingReconnect) { return;  }
-        loader.cache.attemptingReconnect = true;
-        loader.cache.isConnected = false;
-        loader.cache.totalReconnects += 1;
-        try {
-            loader.cache.events.emit("onReconnection", {
-                reconnects: loader.cache.totalReconnects,
-                lastStanza: lastStanzaElapsed,
-                lastName: settings.noaa_weather_wire_service_settings.credentials.nickname,
-            });
-            await loader.cache.session.stop().catch(() => {});
-            await loader.cache.session.start().catch(() => {});
-        } catch (err) {
-            Utils.warn(`XMPP reconnection failed: ${(err as Error).message}`);
-        } finally {
-            loader.cache.attemptingReconnect = false;
-        }
-    } 
-
-    /**
-     * @function deploySession
-     * @description
-     *     Initializes the NOAA Weather Wire Service (NWWS-OI) XMPP client session and
-     *     manages its lifecycle events including connection, disconnection, errors,
-     *     and message handling.
-     *
-     * @async
-     * @static
-     * @returns {Promise<void>}
-     */
-    public static async deploySession(): Promise<void> {
-        const settings = loader.settings as types.ClientSettingsTypes;
-        settings.noaa_weather_wire_service_settings.credentials.nickname ??= settings.noaa_weather_wire_service_settings.credentials.username;
-        loader.cache.session = loader.packages.xmpp.client({
-            service: 'xmpp://nwws-oi.weather.gov',
-            domain: 'nwws-oi.weather.gov',
-            username: settings.noaa_weather_wire_service_settings.credentials.username,
-            password: settings.noaa_weather_wire_service_settings.credentials.password,
-        });
-        loader.cache.session.on('online', async (address: string) => {
-            const now = Date.now();
-            if (loader.cache.lastConnect && now - loader.cache.lastConnect < 10_000) {
-                loader.cache.sigHalt = true;
-                Utils.warn(loader.definitions.messages.reconnect_too_fast);
-                await Utils.sleep(2_000);
-                await loader.cache.session.stop().catch(() => {});
-                return;
-            }
-            loader.cache.isConnected = true;
-            loader.cache.sigHalt = false;
-            loader.cache.lastConnect = now;
-            loader.cache.session.send(loader.packages.xmpp.xml('presence', {
-                to: `nwws@conference.nwws-oi.weather.gov/${settings.noaa_weather_wire_service_settings.credentials.nickname}`,
-                xmlns: 'http://jabber.org/protocol/muc',
-            }));
-            loader.cache.events.emit('onConnection', settings.noaa_weather_wire_service_settings.credentials.nickname);
-            if (loader.cache.attemptingReconnect) return;
-            loader.cache.attemptingReconnect = true;
-            await Utils.sleep(15_000);
-            loader.cache.attemptingReconnect = false;
-        });
-        loader.cache.session.on('offline', () => {
-            loader.cache.isConnected = false;
-            loader.cache.sigHalt = true;
-            Utils.warn('XMPP connection went offline');
-        });
-        loader.cache.session.on('error', (error: Error) => {
-            loader.cache.isConnected = false;
-            loader.cache.sigHalt = true;
-            Utils.warn(`XMPP connection error: ${error.message}`);
-        });
-        loader.cache.session.on('stanza', async (stanza: any) => {
-            try {
-                loader.cache.lastStanza = Date.now();
-                if (stanza.is('message')) {
-                    const validate = StanzaParser.validate(stanza);
-                    const skipMessage = 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);
-                    if (skipMessage) return;
-                    await EventParser.eventHandler(validate);
-                    await Database.stanzaCacheImport(validate);
-                    loader.cache.events.emit('onMessage', validate);
-                }
-                if (stanza.is('presence') && stanza.attrs.from?.startsWith('nwws@conference.nwws-oi.weather.gov/')) {
-                    const occupant = stanza.attrs.from.split('/').slice(1).join('/');
-                    loader.cache.events.emit('onOccupant', {
-                        occupant,
-                        type: stanza.attrs.type === 'unavailable' ? 'unavailable' : 'available',
-                    });
-                }
-            } catch (err: unknown) {
-                Utils.warn(`Error processing stanza: ${(err as Error).message}`);
-            }
-        });
-        try { await loader.cache.session.start(); } catch (err: unknown) {
-            Utils.warn(`Failed to start XMPP session: ${(err as Error).message}`);
-        }
-    }
-}
-
-export default Xmpp;

package/src/types.ts

@@ -1,259 +0,0 @@
-/*
-                                            _               _     __   __
-         /\  | |                           | |             (_)    \ \ / /
-        /  \ | |_ _ __ ___   ___  ___ _ __ | |__   ___ _ __ _  ___ \ V / 
-       / /\ \| __| '_ ` _ \ / _ \/ __| '_ \| '_ \ / _ \ '__| |/ __| > <  
-      / ____ \ |_| | | | | | (_) \__ \ |_) | | | |  __/ |  | | (__ / . \ 
-     /_/    \_\__|_| |_| |_|\___/|___/ .__/|_| |_|\___|_|  |_|\___/_/ \_\
-                                     | |                                 
-                                     |_|                                                                                                                
-    
-    Written by: k3yomi@GitHub                        
-*/
-
-// ----------- Settings ----------- //
-interface LocalEasSettings {
-    directory?: string;
-    intro_wav?: string;
-}
-
-interface LocalAlertFilteringSettings { 
-    events?: string[]; 
-    filtered_icao?: string[]; 
-    ignored_icao?: string[]; 
-    ugc_filter?: string[]; 
-    state_filter?: string[]; 
-    ignored_events?: string[]; 
-    check_expired?: boolean;
-}
-
-interface LocalGlobalSettings {
-    parent_events_only?: boolean;
-    better_event_parsing?: boolean;
-    shapefile_coordinates?: boolean;
-    shapefile_skip?: number;
-    eas_settings?: LocalEasSettings;
-    filtering?: LocalAlertFilteringSettings;
-}
-
-interface LocalClientReconnectionSettings { 
-    enabled?: boolean;
-    interval?: number;
-}
-
-interface LocalClientCredentialSettings {
-    username?: string;
-    password?: string;
-    nickname?: string;
-}
-
-interface LocalCacheSettings { 
-    enabled?: boolean;
-    max_db_history?: number;
-    use_db_for_cache?: boolean;
-    max_db_cache_size?: number;
-}
-
-interface LocalAlertPreferenceSettings {
-    disable_ugc?: boolean;
-    disable_vtec?: boolean;
-    disable_text?: boolean;
-    cap_only?: boolean;
-}
-
-interface LocalNoaaWeatherWireServiceSettings {
-    reconnection_settings?: LocalClientReconnectionSettings;
-    credentials?: LocalClientCredentialSettings;
-    cache?: LocalCacheSettings;
-    preferences?: LocalAlertPreferenceSettings;
-}
-
-interface LocalNationalWeatherServiceSettings {
-    interval?: number;
-    endpoint?: string;
-}
-
-// --- Exports --- //
-export interface ClientSettingsTypes {
-    database?: string;
-    is_wire?: boolean;
-    journal?: boolean;
-    noaa_weather_wire_service_settings?: LocalNoaaWeatherWireServiceSettings;
-    national_weather_service_settings?: LocalNationalWeatherServiceSettings;
-    global_settings?: LocalGlobalSettings;
-}
-
-
-// ----------- Alert / Events ----------- //
-
-
-interface LocalEventHistory { 
-    description?: string;
-    issued?: string;
-    type?: string;
-}
-
-
-interface LocalEventParameters {
-    wmo?: string;
-    source?: string;
-    max_hail_size?: string;
-    max_wind_gust?: string;
-    damage_threat?: string;
-    tornado_detection?: string;
-    flood_detection?: string;
-    discussion_tornado_intensity?: string;
-    discussion_wind_intensity?: string;
-    discussion_hail_intensity?: string;
-    WMOidentifier?: string[];
-    VTEC?: string;
-    maxHailSize?: string;
-    maxWindGust?: string;
-    thunderstormDamageThreat?: string[];
-    tornadoDetection?: string[];
-    waterspoutDetection?: string[];
-    floodDetection?: string[];
-    AWIPSidentifier?: string[];
-    NWSheadline?: string[];
-}
-
-interface LocalEventProperties { 
-    parent?: string;
-    event?: string; 
-    locations?: string;
-    issued?: string;
-    expires?: string;
-    geocode?: { 
-        UGC: string[], 
-        generated?: string | null 
-    };
-    description?: string;
-    instruction?: string;
-    sender_name?: string;
-    sender_icao?: string;
-    raw?: DefaultAttributesType;
-    parameters?: LocalEventParameters;
-    messageType?: string;
-    sent?: string;
-    areaDesc?: string;
-    action_type?: string;
-    is_updated?: boolean;
-    is_cancelled?: boolean;
-    is_issued?: boolean;
-    is_test?: boolean;
-    hash?: string;
-    tags?: string[];
-    details?: Record<string, any>;
-}
-
-// --- Exports --- //
-
-export interface StanzaAttributesType {
-    xmlns?: string; 
-    id?: string; 
-    issue?: string; 
-    ttaaii?: string; 
-    cccc?: string; 
-    awipsid?: string; 
-}
-export interface DefaultAttributesType {
-    attributes?: {
-        xmlns?: string; 
-        id?: string; 
-        issue?: string; 
-        ttaaii?: string; 
-        cccc?: string; 
-        awipsid?: string; 
-    }
-    getAwip?: Record<string, string>;
-    awipsType?: Record<string, string>;
-    isCap?: boolean;
-    raw?: boolean;
-}
-
-export interface StanzaCompiled { 
-    message?: string;
-    attributes?: DefaultAttributesType;
-    isCap?: boolean;
-    isApi?: boolean;
-    isCapDescription?: boolean;
-    isPVtec?: boolean;
-    isUGC?: boolean;
-    getAwip?: Record<string, string>;
-    awipsType?: Record<string, string>;
-    awipsPrefix?: string;
-    ignore?: boolean;
-    awipsid?: string;
-}
-
-export interface PVtecEntry { 
-    raw?: string;
-    type?: string;
-    tracking?: string;
-    event?: string;
-    status?: string;
-    wmo?: string;
-    expires?: Date | string;
-    isKWNS?: boolean;
-}
-
-export interface UGCEntry { 
-    zones?: string[];
-    locations?: string[];
-    expiry?: Date | string;
-    polygon?: [number, number][];
-}
-
-export interface HVtecEntry { 
-    severity?: string,
-    cause?: string,
-    record?: string,
-    raw?: string,
-}
-
-export interface geometry { 
-    type?: string;
-    coordinates?: [number, number][];
-}
-
-
-export interface EventCompiled {
-    performance?: number;
-    id?: string;
-    tracking?: string;
-    header?: string;
-    pvtec?: string;
-    hvtec?: string;
-    history?: LocalEventHistory[];
-    properties?: LocalEventProperties
-    geometry?: { type?: string; coordinates?: [number, number][] } | null;
-}
-
-export type EventProperties = LocalEventProperties;
-export type StanzaAttributes = DefaultAttributesType;
-
-
-// ----------- Generic ----------- //
-
-// --- Exports --- //
-export type Coordinates = { 
-    lon: number; 
-    lat: number;
-}
-
-export type HTTPSettings = { 
-    timeout?: number;
-    headers?: Record<string, string>;
-    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    body?: string;
-}
-
-export interface EnhancedEventCondition {
-    description?: string; 
-    condition?: (value: string) => boolean; 
-}
-
-export interface GenericHTTPResponse { 
-    error?: boolean,
-    message?: { features: Record<string, any>[] } | string,
-}