@nommos/core 0.0.3

package/src/lib/utils.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Gets all the query parameters found on a given url
+ *
+ * @param url - the url from which we want to get the query parameters from
+ * @returns A record of query parameters' name and value
+ */
+export declare function getQueryParams(url: string): Record<string, string>;
+/**
+ * Removes trailing spaces in a string and convert to lowerCase.
+ *
+ * @param s - string to convert
+ * @returns normalized string in lowerCase and no trailing space.
+ */
+export declare const normString: (s: string) => string;
+/**
+ * Extract the browser, the operating system and the channel (3 or 7) from the user agent of a device
+ * @param ua - User Agent of the device
+ * @returns An Object with the browser, operating system and the channel used by the user agent.
+ */
+export declare const userAgentInfo: (ua: string) => {
+    browser: string;
+    os: string;
+    channel: 3 | 7;
+};

package/src/lib/utils.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userAgentInfo = exports.normString = void 0;
+exports.getQueryParams = getQueryParams;
+const constants_1 = require("./constants");
+/**
+ * Gets all the query parameters found on a given url
+ *
+ * @param url - the url from which we want to get the query parameters from
+ * @returns A record of query parameters' name and value
+ */
+function getQueryParams(url) {
+    const params = {};
+    const urlObj = new URL(url);
+    urlObj.searchParams.forEach((value, key) => {
+        // Handle repeated keys as arrays
+        if (params[key] === undefined && value.length > 0) {
+            params[key] = value;
+        }
+    });
+    return params;
+}
+/**
+ * Removes trailing spaces in a string and convert to lowerCase.
+ *
+ * @param s - string to convert
+ * @returns normalized string in lowerCase and no trailing space.
+ */
+const normString = (s) => s.trim().toLowerCase();
+exports.normString = normString;
+/**
+ * Extract the browser, the operating system and the channel (3 or 7) from the user agent of a device
+ * @param ua - User Agent of the device
+ * @returns An Object with the browser, operating system and the channel used by the user agent.
+ */
+const userAgentInfo = (ua) => ({
+    browser: detect(ua, constants_1.BROWSER_DEFS),
+    os: detect(ua, constants_1.OS_DEFS),
+    channel: /Mobi|Android|iPhone|iPad|iPod|Windows Phone/i.test(ua) ? 3 : 7,
+});
+exports.userAgentInfo = userAgentInfo;
+const detect = (ua, defs, fallback = 'Unknown') => {
+    for (const [re, name, map] of defs) {
+        const m = new RegExp(re).exec(ua);
+        if (m) {
+            const v = map ? map(m) : m[1];
+            return v ? `${name} ${v}` : name;
+        }
+    }
+    return fallback;
+};
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../nommos/core/src/lib/utils.ts"],"names":[],"mappings":";;;AAUA,wCAYC;AAtBD,2CAAoD;AAIpD;;;;;GAKG;AACH,SAAgB,cAAc,CAAC,GAAW;IACxC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAE5B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACzC,iCAAiC;QACjC,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACI,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAAnD,QAAA,UAAU,cAAyC;AAEhE;;;;GAIG;AACI,MAAM,aAAa,GAAG,CAC3B,EAAU,EACuC,EAAE,CAAC,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,wBAAY,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,mBAAO,CAAC;IACvB,OAAO,EAAE,8CAA8C,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACzE,CAAC,CAAC;AANU,QAAA,aAAa,iBAMvB;AACH,MAAM,MAAM,GAAG,CAAC,EAAU,EAAE,IAAa,EAAE,QAAQ,GAAG,SAAS,EAAU,EAAE;IACzE,KAAK,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,EAAE,CAAC;YACN,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACnC,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/src/lib/webSocket-client.d.ts

@@ -0,0 +1,69 @@
+import { AnalyticsEvent, FullConfig } from './types';
+/**
+ * WebSocketClient
+ * ----------------
+ * A lightweight STOMP-over-WebSocket wrapper designed for publishing
+ * analytics events to a RabbitMQ broker. Includes:
+ *  - connection lifecycle management
+ *  - auto-reconnect support
+ *  - offline event buffering
+ *  - reactive connection status via RxJS
+ *
+ * Intended to be used inside applications where analytics events must
+ * never be lost due to temporary connection issues.
+ */
+export declare class WebSocketClient {
+    /**
+     * The underlying STOMP client instance.
+     * Initialized in `connectAnalyticsStomp()`.
+     */
+    private analyticsClient;
+    /**
+     * Buffer containing analytics events produced before the socket
+     * becomes connected. They are automatically flushed on connection.
+     */
+    pendingEvents: AnalyticsEvent[];
+    private readonly stompAnalyticsConnected;
+    /**
+     * Reactive connection state for consumers who want to listen for
+     * connection availability changes.
+     *
+     * `true`  -> connected
+     * `false` -> disconnected
+     */
+    stompAnalyticsConnected$: import("rxjs").Observable<boolean>;
+    /**
+     * Creates and configures a STOMP client instance.
+     *
+     * @param cfg Connection configuration (broker URL, credentials, reconnect delay, mode).
+     * @returns A configured but not yet activated STOMP `Client` instance.
+     */
+    private createStompClient;
+    /**
+     * Establishes a STOMP WebSocket connection and wires lifecycle handlers.
+     *
+     * - On successful connection:
+     *    • Emits `true` for reactive subscribers
+     *    • Flushes all queued analytics events
+     * - On broker error:
+     *    • Logs structured error output
+     *
+     * @param cfg Configuration including URL, credentials, mode etc.
+     */
+    connectAnalyticsStomp(cfg: FullConfig): void;
+    /**
+     * Publishes an analytics event to a RabbitMQ queue.
+     *
+     * If the connection is not ready, the event is automatically queued
+     * and delivered once the socket reconnects.
+     *
+     * @param payload The analytics event to send.
+     */
+    publishAnalyticsMessage(payload: AnalyticsEvent): void;
+    /**
+     * Gracefully shuts down the STOMP client and updates connection status.
+     *
+     * Safe to call even if the client was never created or already disconnected.
+     */
+    disconnect(): void;
+}

package/src/lib/webSocket-client.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketClient = void 0;
+const stompjs_1 = require("@stomp/stompjs");
+const rxjs_1 = require("rxjs");
+const constants_1 = require("./constants");
+/**
+ * WebSocketClient
+ * ----------------
+ * A lightweight STOMP-over-WebSocket wrapper designed for publishing
+ * analytics events to a RabbitMQ broker. Includes:
+ *  - connection lifecycle management
+ *  - auto-reconnect support
+ *  - offline event buffering
+ *  - reactive connection status via RxJS
+ *
+ * Intended to be used inside applications where analytics events must
+ * never be lost due to temporary connection issues.
+ */
+class WebSocketClient {
+    constructor() {
+        /**
+         * The underlying STOMP client instance.
+         * Initialized in `connectAnalyticsStomp()`.
+         */
+        this.analyticsClient = null;
+        /**
+         * Buffer containing analytics events produced before the socket
+         * becomes connected. They are automatically flushed on connection.
+         */
+        this.pendingEvents = [];
+        this.stompAnalyticsConnected = new rxjs_1.BehaviorSubject(false);
+        /**
+         * Reactive connection state for consumers who want to listen for
+         * connection availability changes.
+         *
+         * `true`  -> connected
+         * `false` -> disconnected
+         */
+        this.stompAnalyticsConnected$ = this.stompAnalyticsConnected.asObservable();
+    }
+    /**
+     * Creates and configures a STOMP client instance.
+     *
+     * @param cfg Connection configuration (broker URL, credentials, reconnect delay, mode).
+     * @returns A configured but not yet activated STOMP `Client` instance.
+     */
+    createStompClient(cfg) {
+        var _a, _b, _c, _d;
+        console.log('[Nommos Tracker] Rabbit Configs... ', cfg);
+        const client = new stompjs_1.Client({
+            brokerURL: (_a = cfg.rabbitUrl) !== null && _a !== void 0 ? _a : '',
+            connectHeaders: {
+                login: (_b = cfg.username) !== null && _b !== void 0 ? _b : '',
+                passcode: (_c = cfg.password) !== null && _c !== void 0 ? _c : '',
+            },
+            reconnectDelay: (_d = cfg.reconnectDelay) !== null && _d !== void 0 ? _d : 5000,
+        });
+        if (cfg.mode === 'dev') {
+            client.debug = (msg) => console.log('[Nommos Tracker]', msg);
+        }
+        else {
+            client.debug = () => {
+                /* empty */
+            }; // silence logs in non-dev mode
+        }
+        return client;
+    }
+    /**
+     * Establishes a STOMP WebSocket connection and wires lifecycle handlers.
+     *
+     * - On successful connection:
+     *    • Emits `true` for reactive subscribers
+     *    • Flushes all queued analytics events
+     * - On broker error:
+     *    • Logs structured error output
+     *
+     * @param cfg Configuration including URL, credentials, mode etc.
+     */
+    connectAnalyticsStomp(cfg) {
+        this.analyticsClient = this.createStompClient(cfg);
+        this.analyticsClient.onConnect = () => {
+            console.log('[Nommos Tracker] Connected');
+            this.stompAnalyticsConnected.next(true);
+            // flush pending events
+            for (const m of this.pendingEvents) {
+                this.publishAnalyticsMessage(m);
+            }
+            this.pendingEvents = [];
+        };
+        this.analyticsClient.onStompError = (frame) => {
+            console.error('[Nommos Tracker] Broker error:', frame.headers['message']);
+        };
+        console.log('[Nommos Tracker] Activating STOMP client...');
+        this.analyticsClient.activate();
+    }
+    /**
+     * Publishes an analytics event to a RabbitMQ queue.
+     *
+     * If the connection is not ready, the event is automatically queued
+     * and delivered once the socket reconnects.
+     *
+     * @param payload The analytics event to send.
+     */
+    publishAnalyticsMessage(payload) {
+        var _a;
+        if (!((_a = this.analyticsClient) === null || _a === void 0 ? void 0 : _a.connected) || this.analyticsClient == null) {
+            this.pendingEvents.push(payload);
+            return;
+        }
+        this.analyticsClient.publish({
+            destination: constants_1.ANALYTICS_QUEUE,
+            headers: { 'content-type': 'application/json' },
+            body: JSON.stringify(payload),
+        });
+    }
+    /**
+     * Gracefully shuts down the STOMP client and updates connection status.
+     *
+     * Safe to call even if the client was never created or already disconnected.
+     */
+    disconnect() {
+        if (this.analyticsClient) {
+            this.analyticsClient.deactivate().then(() => {
+                this.stompAnalyticsConnected.next(false);
+                console.log('[Nommos Tracker] Disconnected');
+            });
+        }
+    }
+}
+exports.WebSocketClient = WebSocketClient;
+//# sourceMappingURL=webSocket-client.js.map

package/src/lib/webSocket-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webSocket-client.js","sourceRoot":"","sources":["../../../../../nommos/core/src/lib/webSocket-client.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AAExC,+BAAuC;AACvC,2CAA8C;AAE9C;;;;;;;;;;;;GAYG;AACH,MAAa,eAAe;IAA5B;QACE;;;WAGG;QACK,oBAAe,GAAkB,IAAI,CAAC;QAE9C;;;WAGG;QACH,kBAAa,GAAqB,EAAE,CAAC;QAGpB,4BAAuB,GAAG,IAAI,sBAAe,CAAC,KAAK,CAAC,CAAC;QAEtE;;;;;;WAMG;QACH,6BAAwB,GAAG,IAAI,CAAC,uBAAuB,CAAC,YAAY,EAAE,CAAC;IAqGzE,CAAC;IAnGC;;;;;OAKG;IACK,iBAAiB,CAAC,GAAe;;QACvC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,gBAAM,CAAC;YACxB,SAAS,EAAE,MAAA,GAAG,CAAC,SAAS,mCAAI,EAAE;YAC9B,cAAc,EAAE;gBACd,KAAK,EAAE,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE;gBACzB,QAAQ,EAAE,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE;aAC7B;YACD,cAAc,EAAE,MAAA,GAAG,CAAC,cAAc,mCAAI,IAAI;SAC3C,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACvB,MAAM,CAAC,KAAK,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAC/D,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE;gBAClB,WAAW;YACb,CAAC,CAAC,CAAC,+BAA+B;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAGD;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,GAAe;QACnC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAEnD,IAAI,CAAC,eAAe,CAAC,SAAS,GAAG,GAAG,EAAE;YACpC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC1C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAExC,uBAAuB;YACvB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;YAClC,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,IAAI,CAAC,eAAe,CAAC,YAAY,GAAG,CAAC,KAAK,EAAE,EAAE;YAC5C,OAAO,CAAC,KAAK,CACX,gCAAgC,EAChC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CACzB,CAAC;QACJ,CAAC,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;QAC3D,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACH,uBAAuB,CAAC,OAAuB;;QAC7C,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,SAAS,CAAA,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE,CAAC;YACrE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACjC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC;YAC3B,WAAW,EAAE,2BAAe;YAC5B,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC1C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACzC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AA5HD,0CA4HC"}