@ircam/comote-helpers 0.0.0 → 0.2.0

package/package.json

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

package/qrcode.js

@@ -15,7 +15,7 @@ function formatConfigToLink(config) {
   let link = `comote://settings?`;
   const query = [];
 
-  if (Number.isFinite(config.id) && config.id >= 0) {
+  if ('id' in config) {
     query.push(`id=${config.id}`);
   }
 
@@ -25,15 +25,30 @@ function formatConfigToLink(config) {
 
   if (config.ws) {
     const {
+      protocol,
       hostname,
-      port
-    } = config.ws;
+      port,
+      pathname
+    } = config.ws; // build valid url
+    // only hostname is required
 
-    if (!hostname || !Number.isInteger(port)) {
+    if (!hostname) {
       throw new Error(`Invalid WebSocket config: ${config.ws}`);
     }
 
-    query.push(`ws-url=ws://${hostname}:${port}`);
+    let url = `ws-url=`;
+    url += protocol == 'ws' || protocol == 'wss' ? `${protocol}://` : `ws://`;
+    url += hostname;
+
+    if (port) {
+      url += `:${port}`;
+    }
+
+    if (pathname) {
+      url += pathname;
+    }
+
+    query.push(url); // autostart
 
     if (config.ws.autostart === true) {
       query.push(`ws-enable=1`);

package/server.js

@@ -4,9 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.Server = void 0;
-exports.getWifiInfos = getWifiInfos;
-
-var _systeminformation = _interopRequireDefault(require("systeminformation"));
 
 var _ws = _interopRequireDefault(require("ws"));
 
@@ -20,12 +17,6 @@ var _assignDeep = _interopRequireDefault(require("assign-deep"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- * @typedef {Object} WifiInfos
- * @property {number} ssid - SSID of the WiFi connection
- * @property {number} ip - Related IP (IPV4)
- */
-
 /**
  * @typedef {Object} CoMoteConfig
  * @property {String} id - id of the client CoMo.te
@@ -41,30 +32,6 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @property {Boolean} autostart - enable streaming on CoMo.te application
  */
 
-/**
- * Retrieve the SSID and related IP of the first WiFi connection found, return
- * `null` if no WiFi connection found.
- *
- * @async
- * @return {WiFiInfos|null}
- */
-async function getWifiInfos() {
-  // find first wifi connection
-  const wifiConnections = await _systeminformation.default.wifiConnections();
-  const conn = wifiConnections[0];
-
-  if (!conn) {
-    return null;
-  } // find related interface
-
-
-  const interfaces = await _systeminformation.default.networkInterfaces();
-  const int = interfaces.find(int => int.iface === conn.iface);
-  return {
-    ssid: conn.ssid,
-    ip: int.ip4
-  };
-}
 /**
  * Launch WebSocket and/or OSC server according to given `CoMoteConfig` object
  *
@@ -72,8 +39,6 @@ async function getWifiInfos() {
  * @param {Object} options - options
  * @param {Object} [options.verbose=false] - logs debug informations
  */
-
-
 class Server {
   constructor(config, options) {
     /**

package/wifi-infos.js

@@ -0,0 +1,41 @@
+"use strict";
+
+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
+ * @property {number} ip - Related IP (IPV4)
+ */
+
+/**
+ * Retrieve the SSID and related IP of the first WiFi connection found, return
+ * `null` if no WiFi connection found.
+ *
+ * @async
+ * @return {WiFiInfos|null}
+ */
+async function getWifiInfos() {
+  // find first wifi connection
+  const wifiConnections = await _systeminformation.default.wifiConnections();
+  const conn = wifiConnections[0];
+
+  if (!conn) {
+    return null;
+  } // find related interface
+
+
+  const interfaces = await _systeminformation.default.networkInterfaces();
+  const int = interfaces.find(int => int.iface === conn.iface);
+  return {
+    ssid: conn.ssid,
+    ip: int.ip4
+  };
+}