@ircam/comote-helpers 0.3.1 → 0.3.3

package/network-infos.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getNetworkInterfacesInfos = getNetworkInterfacesInfos;
+var _systeminformation = _interopRequireDefault(require("systeminformation"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * @typedef {Object} NetworkInterfaces
+ * @property {Array.<NetworkInterface>} Interfaces
+ */
+
+/**
+ * @typedef {Object} NetworkInterface
+ *
+ * @property {string} iface: - identifier eg. 'en0'
+ * @property {string} ifaceName - name eg. 'en0'
+ * @property {boolean} default - true if default interface (for sending data)
+ * @property {string} ip4 - address eg. '192.168.0.1'
+ * @property {string} ip4subnet - eg. '255.255.252.0'
+ * @property {string} ip6 eg. 'fe80::456:7890:abcd:ef01'
+ * @property {string} ip6subnet eg. 'ffff:ffff:ffff:ffff::'
+ * @property {string} type eg. 'wireless' or 'wired'
+ *
+ * @see https://www.npmjs.com/package/systeminformation
+ */
+
+/**
+ * @callback interfacaFilterCallback
+ * @param {Object} interface network interface to test
+ * @return {boolean} true to keep this interface
+ */
+
+/**
+ * Retrieve information of network interfaces
+ *
+ * @async
+ * @param {Object} options
+ * @param {interfacaFilterCallback} options.interfaceFilter callback for filter to test interface
+ * @return {NetworkInterfaces|null} null if no interface found
+ */
+async function getNetworkInterfacesInfos({
+  interfaceFilter = i => {
+    // only IPv4
+    // avoid localhost
+    return i.ip4 && i.ip4 !== '127.0.0.1' && i.ip4 !== 'localhost';
+  }
+} = {}) {
+  const interfaces = await _systeminformation.default.networkInterfaces();
+  if (!interfaces) {
+    return null;
+  }
+  if (typeof interfaceFilter !== 'function') {
+    return interfaces;
+  }
+  return interfaces.filter(interfaceFilter);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ircam/comote-helpers",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Server component & utilities for the CoMo.te application",
   "authors": [
     "Benjamin.Matuszewski@ircam.fr",

package/qrcode.js

@@ -6,83 +6,70 @@ Object.defineProperty(exports, "__esModule", {
 exports.dataURL = dataURL;
 exports.rawLink = rawLink;
 exports.terminal = terminal;
-
 var _qrcode = _interopRequireDefault(require("qrcode"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function formatConfigToLink(config) {
   let link = `comote://settings?`;
   const query = [];
-
   if ('id' in config) {
     query.push(`id=${config.id}`);
   }
-
   if (Number.isFinite(config.interval) && config.interval > 0) {
     query.push(`interval=${config.interval}`);
   }
-
   if (config.ws) {
     const {
       protocol,
       hostname,
       port,
       pathname
-    } = config.ws; // build valid url
-    // only hostname is required
+    } = config.ws;
 
+    // build valid url
+    // only hostname is required
     if (!hostname) {
       throw new Error(`Invalid WebSocket config: ${config.ws}`);
     }
-
     let url = `ws-url=`;
     url += protocol == 'ws' || protocol == 'wss' ? `${protocol}://` : `ws://`;
     url += hostname;
-
     if (port) {
       url += `:${port}`;
     }
-
     if (pathname) {
       url += pathname;
     }
+    query.push(url);
 
-    query.push(url); // autostart
-
+    // autostart
     if (config.ws.autostart === true) {
       query.push(`ws-enable=1`);
     }
   }
-
   if (config.osc) {
     const {
       hostname,
       port
     } = config.osc;
-
     if (!hostname || !Number.isInteger(port)) {
       throw new Error(`Invalid WebSocket config: ${config.osc}`);
     }
-
     query.push(`osc-url=udp://${hostname}:${port}`);
-
     if (config.osc.autostart === true) {
       query.push(`osc-enable=1`);
     }
   }
-
   link += query.join('&');
   return link;
 }
+
 /**
  * Return the link to be encoded in the QRCode accroding to given `CoMoteConfig`
  */
-
-
 function rawLink(config) {
   return formatConfigToLink(config);
 }
+
 /**
  * Create a qrcode to be logged in terminal according to given `CoMoteConfig``
  *
@@ -90,14 +77,13 @@ function rawLink(config) {
  * @example
  * console(await CoMoteQRCode.terminal(config));
  */
-
-
 async function terminal(config) {
   const link = formatConfigToLink(config);
   return await _qrcode.default.toString(link, {
     type: 'terminal'
   });
 }
+
 /**
  * Create a qrcode to be used as in Image source according to given `CoMoteConfig``
  *
@@ -107,8 +93,6 @@ async function terminal(config) {
  *
  * <img src="${qrCode}" />
  */
-
-
 async function dataURL(config) {
   const link = formatConfigToLink(config);
   return await await _qrcode.default.toDataURL(link);

package/server.js

@@ -4,19 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Server = void 0;
-
 var _ws = _interopRequireDefault(require("ws"));
-
 var _utf8Validate = _interopRequireDefault(require("utf-8-validate"));
-
 var _nodeOsc = require("node-osc");
-
 var _cloneDeep = _interopRequireDefault(require("clone-deep"));
-
 var _assignDeep = _interopRequireDefault(require("assign-deep"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {Object} CoMoteConfig
  * @property {String} id - id of the client CoMo.te
@@ -52,103 +45,89 @@ class Server {
       verbose: false
     }, config));
     this._verbose = !!options.verbose;
-
     if (this._verbose) {
       console.log('+ CoMo.te config:');
       console.log(this.config, '\n');
     }
-
     this._websocketServer = null;
     this._oscServer = null;
     this._wsListeners = new Set();
     this._oscListeners = new Set();
   }
-
   async start() {
     let wsPromise = true;
     let oscPromise = true;
-
     if (this.config.ws !== null) {
       const {
         hostname,
         port
       } = this.config.ws;
-
       if (!Number.isInteger(port)) {
         throw new Error(`Invalid port "${port}" for WebSocket server`);
       }
-
       if (this._verbose) {
         console.log(`> CoMo.te: Launching WebSocket server on port: ${port}`);
       }
-
       this._websocketServer = new _ws.default.Server({
         port
       });
       const sockets = new Map();
-
       this._websocketServer.on('connection', (socket, request) => {
         // const ip = request.socket.remoteAddress;
         socket.on('message', (data, isBinary) => {
-          if (isBinary) {// @todo
+          if (isBinary) {
+            // @todo
           } else {
             if ((0, _utf8Validate.default)(data)) {
               // do we really need this check?
               data = JSON.parse(data);
-
               if (this._verbose) {
                 console.log(`> CoMo.te: new WebSocket message`, data);
-              } // console.log(data);
-              // console.log(this._wsListeners.size);
-
+              }
 
+              // console.log(data);
+              // console.log(this._wsListeners.size);
               this._wsListeners.forEach(listener => listener(data));
             }
           }
-        }); // When a socket closes, or disconnects, remove it from the array.
+        });
 
+        // When a socket closes, or disconnects, remove it from the array.
         socket.on('close', (code, data) => {
           if (this._verbose) {
             console.log('> CoMo.te: closed socket connection');
           }
         });
       });
-
       wsPromise = new Promise((resolve, reject) => {
         this._websocketServer.on('listening', () => {
           if (this._verbose) {
             console.log(`> CoMo.te: WebSocket server listening`);
           }
-
           resolve();
         });
-
         this._websocketServer.on('error', err => {
           console.log(`> CoMo.te: WebSocket server error`, err);
           reject(err);
         });
       });
     }
-
     if (this.config.osc !== null) {
       const {
         hostname,
         port
       } = this.config.osc;
-
       if (!Number.isInteger(port)) {
         throw new Error(`Invalid port "${port}" for OSC server`);
-      } // fallback to broadcast
-
+      }
 
+      // fallback to broadcast
       if (!hostname) {
         hostname = '0.0.0.0';
       }
-
       if (this._verbose) {
         console.log(`> CoMo.te: Launching OSC server udp://${hostname}:${port}`);
       }
-
       oscPromise = new Promise((resolve, reject) => {
         this._oscServer = new _nodeOsc.Server(this.config.osc.port, hostname, err => {
           if (err) {
@@ -156,75 +135,59 @@ class Server {
             reject();
             return;
           }
-
           if (this._verbose) {
             console.log(`> CoMo.te: OSC server listening`);
           }
-
           resolve();
         });
-
         this._oscServer.on('message', data => {
           let address = data.shift();
-
           if (this._verbose) {
             console.log(`> CoMo.te: new OSC message "${address}":`, data);
           }
-
           this._oscListeners.forEach(callback => callback(address, data));
         });
       });
     }
-
     return Promise.all([wsPromise, oscPromise]);
   }
-
   async stop() {
     if (this._websocketServer) {
       this._websocketServer.close();
     }
-
     if (this._oscServer) {
       this._oscServer.close();
     }
   }
+
   /**
   * Add a listener for incomming WebSocket message
   */
-
-
   addWsListener(callback) {
     this._wsListeners.add(callback);
-
     return () => this._wsListeners.delete(callback);
   }
+
   /**
    * Remove WebSocket listener
    */
-
-
   removeWsListener(callback) {
     this._wsListeners.delete(callback);
   }
+
   /**
    * Add a listener for incomming OSC message
    */
-
-
   addOscListener(callback) {
     this._oscListeners.add(callback);
-
     return () => this._oscListeners.delete(callback);
   }
+
   /**
    * Remove OSC listener
    */
-
-
   removeOscListener(callback) {
     this._oscListeners.delete(callback);
   }
-
 }
-
 exports.Server = Server;

package/wifi-infos.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getWifiInfos = getWifiInfos;
-
 var _systeminformation = _interopRequireDefault(require("systeminformation"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @typedef {Object} WifiInfos
  * @property {number} ssid - SSID of the WiFi connection
@@ -26,12 +23,11 @@ async function getWifiInfos() {
   // find first wifi connection
   const wifiConnections = await _systeminformation.default.wifiConnections();
   const conn = wifiConnections[0];
-
   if (!conn) {
     return null;
-  } // find related interface
-
+  }
 
+  // find related interface
   const interfaces = await _systeminformation.default.networkInterfaces();
   const int = interfaces.find(int => int.iface === conn.iface);
   return {