@ipsme/msgenv-mqtt 0.0.21

package/README.md

@@ -0,0 +1 @@
+

package/dist/ipsme_msgenv.cjs.js

@@ -0,0 +1,125 @@
+'use strict';
+
+const mqtt = require('mqtt');
+const { BitLogr } = require ('@knev/bitlogr');
+
+// https://www.tutorialsteacher.com/nodejs/nodejs-module-exports
+
+//-------------------------------------------------------------------------------------------------
+
+let LOGR_= new BitLogr();
+
+const l_ = {
+	MsgEnv : 0b1 << 0,	// MsgEnv
+	CXNS : 0b1 << 1,	// connections
+	REFL : 0b1 << 2,	// reflection
+};
+LOGR_.labels= l_;
+
+// https://stackoverflow.com/questions/4602141/variable-name-as-a-string-in-javascript
+const __name = obj => Object.keys(obj)[0];
+// console.log('OUT', __name({variableName}) );
+
+//-------------------------------------------------------------------------------------------------
+
+var cfg_= (function() {
+    let _options= {};
+
+    // options= {
+    // channel : 'IPSME',
+    //     prefix : '',
+    //     logr : ...
+    // }
+
+    return {
+        get channel() {
+			return (_options.channel === undefined) ? 'IPSME' : _options.channel;
+        },
+        get prefix() { 
+			return (_options.prefix === undefined) ? '' : _options.prefix;
+        },
+		get options() { return _options; },
+		set options(obj) {
+			_options= obj;
+            if (_options.logr && _options.logr[ __name(l_) ] )
+			    LOGR_.toggled= _options.logr;
+		}
+    }
+})();
+
+//-------------------------------------------------------------------------------------------------
+// MsgEnv:
+
+let singleton;
+
+const kstr_TOPIC = 'IPSME';
+
+class Singleton {
+    constructor() {
+        this.client = mqtt.connect('mqtt://localhost:1883');
+
+        this.client.on('error', function (err) {
+            console.error('MQTT Connection Error:', err);
+        });
+
+        this.client.on('connect', function () {
+            // console.log('MQTT Connected');
+        });
+    }
+
+    static getInstance() {
+        if (!singleton) {
+            singleton = new Singleton();
+        }
+        return singleton;
+    }
+}
+
+// Normally you can specify an object to filter on when subscribing, but in electron that is missing
+// 
+function subscribe_(handler) {
+	if (handler.subscription_ID !== undefined)
+		return;
+    LOGR_.log(l_.CXNS, cfg_.prefix +'MsgEnv: subscribe');
+    // handler.subscription_ID= systemPreferences.subscribeNotification(cfg_.channel, function(event, userInfo, object) {
+    //     LOGR_.log(l_.REFL, cfg_.prefix +'MsgEnv: onNotification: ', userInfo.msg);
+    //     this(userInfo.msg);
+    // }.bind(handler));    
+
+    let instance = Singleton.getInstance();
+    handler.subscription_ID = function (topic, message) {
+        handler(message.toString());
+    };
+  
+    instance.client.on('message', handler.subscription_ID);
+    instance.client.subscribe(kstr_TOPIC);
+}
+
+// we have to use the ID, rather than the handler itself to unsubsribe
+function unsubscribe_(handler) {
+    LOGR_.log(l_.CXNS, cfg_.prefix +'MsgEnv: unsubscribe');
+    // systemPreferences.unsubscribeNotification(handler.subscription_ID);
+    let instance = Singleton.getInstance();
+    instance.client.removeListener('message', handler.subscription_ID);
+    instance.client.unsubscribe(kstr_TOPIC);
+    delete handler.subscription_ID;
+}
+
+// Normally a {name, object, userInfo} tuple, but in electron it is apparently not possible
+// to specify the (sender) object explicitly; gets set automagically?!
+function publish_(msg) {
+    LOGR_.log(l_.REFL, cfg_.prefix +'MsgEnv: postNotification: ', msg);
+    // systemPreferences.postNotification(cfg_.channel, { "msg" : msg }, true);
+    let instance = Singleton.getInstance();
+    instance.client.publish(kstr_TOPIC, msg);
+}
+
+//-------------------------------------------------------------------------------------------------
+
+module.exports= {
+    config : cfg_,
+    subscribe : subscribe_,
+    unsubscribe : unsubscribe_,
+    publish : publish_,
+    l : l_,
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ipsme/msgenv-mqtt",
+  "version": "0.0.21",
+  "description": "",
+  "exports": {
+    "node": {
+      "require": "./dist/ipsme_msgenv.cjs.js"
+    },
+    "default": "./dist/ipsme_msgenv.cjs.js"
+  },
+  "type": "commonjs",
+  "scripts": {
+    "build": "rollup --config",
+    "test": "node tests/test_ipsme_msgenv.cjs",
+    "clean": "del dist && echo OK"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/IPSME/npm-msgenv-MQTT.git"
+  },
+  "keywords": [
+    "ipsme"
+  ],
+  "author": "K.Nevelsteen, PhD",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/IPSME/npm-msgenv-MQTT/issues"
+  },
+  "homepage": "https://github.com/IPSME/npm-msgenv-MQTT#readme",
+  "dependencies": {
+    "@knev/bitlogr": "^0.2.1",
+    "mqtt": "^5.1.4"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "del-cli": "^5.0.0",
+    "rollup": "^3.2.3"
+  }
+}

package/rollup.config.mjs

@@ -0,0 +1,24 @@
+// import resolve from '@rollup/plugin-node-resolve';
+// import commonjs from '@rollup/plugin-commonjs';
+// import json from '@rollup/plugin-json';
+
+export default [
+	{
+		input: 'src/ipsme_msgenv.cjs',
+		output: {
+			name: "ipsme_msgenv",
+			file: 'dist/ipsme_msgenv.cjs.js',
+			format: 'cjs'
+		},
+		// plugins: [resolve()]
+	},
+	// {
+	// 	input: 'src/ipsme_msgenv.cjs',
+	// 	output: {
+	// 		name: "ipsme_msgenv",
+	// 		file: 'dist/ipsme_msgenv.es.mjs',
+	// 		format: 'es'
+	// 	},
+	// 	plugins: [resolve(), commonjs()]
+	// }
+];

package/src/ipsme_msgenv.cjs

@@ -0,0 +1,124 @@
+
+const mqtt = require('mqtt');
+const { BitLogr } = require ('@knev/bitlogr');
+
+// https://www.tutorialsteacher.com/nodejs/nodejs-module-exports
+
+//-------------------------------------------------------------------------------------------------
+
+let LOGR_= new BitLogr();
+
+const l_ = {
+	MsgEnv : 0b1 << 0,	// MsgEnv
+	CXNS : 0b1 << 1,	// connections
+	REFL : 0b1 << 2,	// reflection
+}
+LOGR_.labels= l_;
+
+// https://stackoverflow.com/questions/4602141/variable-name-as-a-string-in-javascript
+const __name = obj => Object.keys(obj)[0];
+// console.log('OUT', __name({variableName}) );
+
+//-------------------------------------------------------------------------------------------------
+
+var cfg_= (function() {
+    let _options= {};
+
+    // options= {
+    // channel : 'IPSME',
+    //     prefix : '',
+    //     logr : ...
+    // }
+
+    return {
+        get channel() {
+			return (_options.channel === undefined) ? 'IPSME' : _options.channel;
+        },
+        get prefix() { 
+			return (_options.prefix === undefined) ? '' : _options.prefix;
+        },
+		get options() { return _options; },
+		set options(obj) {
+			_options= obj;
+            if (_options.logr && _options.logr[ __name(l_) ] )
+			    LOGR_.toggled= _options.logr
+		}
+    }
+})();
+
+//-------------------------------------------------------------------------------------------------
+// MsgEnv:
+
+let singleton;
+
+const kstr_TOPIC = 'IPSME';
+
+class Singleton {
+    constructor() {
+        this.client = mqtt.connect('mqtt://localhost:1883');
+
+        this.client.on('error', function (err) {
+            console.error('MQTT Connection Error:', err);
+        });
+
+        this.client.on('connect', function () {
+            // console.log('MQTT Connected');
+        });
+    }
+
+    static getInstance() {
+        if (!singleton) {
+            singleton = new Singleton();
+        }
+        return singleton;
+    }
+}
+
+// Normally you can specify an object to filter on when subscribing, but in electron that is missing
+// 
+function subscribe_(handler) {
+	if (handler.subscription_ID !== undefined)
+		return;
+    LOGR_.log(l_.CXNS, cfg_.prefix +'MsgEnv: subscribe');
+    // handler.subscription_ID= systemPreferences.subscribeNotification(cfg_.channel, function(event, userInfo, object) {
+    //     LOGR_.log(l_.REFL, cfg_.prefix +'MsgEnv: onNotification: ', userInfo.msg);
+    //     this(userInfo.msg);
+    // }.bind(handler));    
+
+    let instance = Singleton.getInstance();
+    handler.subscription_ID = function (topic, message) {
+        handler(message.toString());
+    };
+  
+    instance.client.on('message', handler.subscription_ID);
+    instance.client.subscribe(kstr_TOPIC);
+}
+
+// we have to use the ID, rather than the handler itself to unsubsribe
+function unsubscribe_(handler) {
+    LOGR_.log(l_.CXNS, cfg_.prefix +'MsgEnv: unsubscribe');
+    // systemPreferences.unsubscribeNotification(handler.subscription_ID);
+    let instance = Singleton.getInstance();
+    instance.client.removeListener('message', handler.subscription_ID);
+    instance.client.unsubscribe(kstr_TOPIC);
+    delete handler.subscription_ID;
+}
+
+// Normally a {name, object, userInfo} tuple, but in electron it is apparently not possible
+// to specify the (sender) object explicitly; gets set automagically?!
+function publish_(msg) {
+    LOGR_.log(l_.REFL, cfg_.prefix +'MsgEnv: postNotification: ', msg);
+    // systemPreferences.postNotification(cfg_.channel, { "msg" : msg }, true);
+    let instance = Singleton.getInstance();
+    instance.client.publish(kstr_TOPIC, msg);
+}
+
+//-------------------------------------------------------------------------------------------------
+
+module.exports= {
+    config : cfg_,
+    subscribe : subscribe_,
+    unsubscribe : unsubscribe_,
+    publish : publish_,
+    l : l_,
+}

package/tests/test_ipsme_msgenv.cjs

@@ -0,0 +1,30 @@
+
+IPSME_MsgEnv_OS = require('../dist/ipsme_msgenv.cjs');
+
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+function handler_(msg)
+{
+    console.log(msg);
+
+}
+
+
+async function demo() {
+    IPSME_MsgEnv_OS.subscribe( handler_ );
+    IPSME_MsgEnv_OS.publish('BOOYAH 1');
+
+    await sleep(2000);
+
+    IPSME_MsgEnv_OS.unsubscribe( handler_ );
+    IPSME_MsgEnv_OS.publish('BOOYAH 2.o');
+
+    await sleep(2000);
+
+    IPSME_MsgEnv_OS.subscribe( handler_ );
+    IPSME_MsgEnv_OS.publish('BOOYAH 3.o');
+}
+
+demo();