@ircam/comote-helpers 1.0.1 → 1.0.4

package/max/CoMote/source/comote-connect/server.js

@@ -1,193 +0,0 @@
-import http from 'node:http';
-import fs from 'node:fs';
-import url from 'node:url';
-import path from 'node:path';
-
-import Max from 'max-api';
-import { WebSocketServer } from 'ws';
-import portfinder from 'portfinder';
-
-import { getWifiInfos } from '@ircam/comote-helpers/wifi-infos.js';
-import { getNetworkInterfacesInfos } from '@ircam/comote-helpers/network-infos.js';
-
-const comoteConfig = {
-  id: 0,
-  interval: 16, // period in ms
-  ws: null,
-  osc: {
-    port: 8001,
-    hostname: '',
-    autostart: true,
-  },
-  webview: '',
-};
-
-const server = http.createServer((req, res) => {
-  const parsedUrl = url.parse(req.url);
-  let pathname = `./comote-connect-public${parsedUrl.pathname}`;
-  const ext = path.parse(pathname).ext || '.html';
-  // maps file extension to MIME typere
-  const map = {
-    '.ico': 'image/x-icon',
-    '.html': 'text/html',
-    '.js': 'text/javascript',
-    '.json': 'application/json',
-    '.css': 'text/css',
-  };
-
-  if (fs.existsSync(pathname)) {
-    // if is a directory search for index file matching the extension
-    if (fs.statSync(pathname).isDirectory()) {
-      pathname += 'index.html';
-    }
-
-    // read file from file system
-    fs.readFile(pathname, (err, data) => {
-      if (err) {
-        res.statusCode = 500;
-        res.end(`Error getting the file: ${err}.`);
-      } else {
-        // if the file is found, set Content-type and send data
-        res.setHeader('Content-type', map[ext] || 'text/plain' );
-        res.end(data);
-      }
-    });
-  } else {
-    // file is not found, return 404
-    res.statusCode = 404;
-    res.end(`File ${pathname} not found!`);
-  }
-});;
-
-console.log('server started');
-
-const wss = new WebSocketServer({ server });
-const sockets = new Set();
-
-wss.on('connection', async function connection(ws) {
-  const wifiInfos = await getWifiInfos();
-  const networkInterfacesInfos = await getNetworkInterfacesInfos();
-
-  const networkInfos = networkInterfacesInfos
-        .sort( (a, b) => {
-          if (a.default) {
-            // default is before
-            return -1;
-          } else if (b.default) {
-            // other is before
-            return 1;
-          } else {
-            // finally, sort by interface name
-            return a.ifaceName < b.ifaceName;
-          }
-
-        });
-  ws.send(JSON.stringify({ type: 'networkInfos', payload: networkInfos }));
-
-  // use first network interface, it should be the default one
-  if (networkInfos && networkInfos[0]) {
-    comoteConfig.osc.hostname  = networkInfos[0].ip4;
-  }
-
-
-  ws.send(JSON.stringify({ type: 'wifiInfos', payload: wifiInfos }));
-  ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-
-  sockets.add(ws);
-
-  ws.on('message', async (data, isBinary) => {
-    // isBinary is not always set
-    const message = (isBinary || typeof data !== 'string')
-          ? data.toString()
-          : data;
-
-    const { type, payload } = JSON.parse(message);
-
-    switch (type) {
-      case 'comoteConfig':
-        Object.assign(comoteConfig, payload);
-        ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-
-        await Max.outlet('id', comoteConfig.id);
-        await Max.outlet('interval', comoteConfig.interval);
-        await Max.outlet('osc_hostname', comoteConfig.osc.hostname);
-        await Max.outlet('osc_port', comoteConfig.osc.port);
-        await Max.outlet('osc_autostart', comoteConfig.osc.autostart);
-        await Max.outlet('webview_url', comoteConfig.webview);
-        break;
-
-      default:
-        console.warn('received unknown message', {type, payload});
-      break;
-    }
-  });
-
-
-  ws.on('close', () => {
-    sockets.delete(ws);
-  });
-});
-
-const handlers = {
-  id: id => {
-    comoteConfig.id = id;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('id', id);
-  },
-  interval: interval => {
-    comoteConfig.interval = interval;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('interval', interval);
-  },
-  osc_hostname: hostname => {
-    comoteConfig.osc.hostname = hostname;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('osc_hostname', hostname);
-  },
-  osc_port: port => {
-    comoteConfig.osc.port = port;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('osc_port', port);
-  },
-  osc_autostart: autostart => {
-    comoteConfig.osc.autostart = !!autostart;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('osc_autostart', autostart);
-  },
-  webview_url: url => {
-    comoteConfig.webview = url;
-    sockets.forEach(ws => {
-      ws.send(JSON.stringify({ type: 'comoteConfig', payload: comoteConfig }));
-    });
-    Max.outlet('webview_url', url);
-  },
-  bang: async () => {
-    await Max.outlet('id', comoteConfig.id);
-    await Max.outlet('interval', comoteConfig.interval);
-    await Max.outlet('osc_hostname', comoteConfig.osc.hostname);
-    await Max.outlet('osc_port', comoteConfig.osc.port);
-    await Max.outlet('osc_autostart', comoteConfig.osc.autostart);
-    await Max.outlet('webview_url', comoteConfig.webview);
-  }
-};
-
-Max.addHandlers(handlers);
-
-portfinder.basePort = 8888;
-portfinder.getPort((err, port) => {
-  server.listen(port, () => {
-    const url = `http://127.0.0.1:${port}`;
-    console.log(`server listening on ${url}`);
-    Max.outlet('url', url);
-  });
-});

package/max-update.bash

@@ -1,44 +0,0 @@
-#!/bin/bash
-
-cd "$(dirname "$0")" || exit 0
-
-local_path="$(pwd)"
-
-max_examples=(
-  "simple-webview"
-  "soundworks"
-)
-
-exclude_files=(
-  "node_modules"
-  ".build"
-  ".git"
-  ".data"
-  ".vendors"
-)
-
-exclude_options=()
-for x in "${exclude_files[@]}"; do
-  exclude_options+=("--exclude=${x}")
-done
-
-examples_root_path="${local_path}/examples"
-examples_max_path="${local_path}/max/CoMote/examples"
-
-for example in "${max_examples[@]}"; do
-  example_source="${examples_root_path}/${example}"
-  echo "Updating ${example_source}"
-  (
-    cd -- "${example_source}" || {
-      echo "Failed to change directory to ${example_source}"
-      exit 1
-    }
-    npm install
-    npm run build
-    example_destination="${examples_max_path}/${example}"
-    echo "Copying to ${example_destination}"
-    mkdir -p -- "${example_destination}"
-    tar c . | tar xv "${exclude_options[@]}" -C "${example_destination}"
-
-  )
-done

package/src/.editorbackup/network-infos.js~

@@ -1,60 +0,0 @@
-import si from 'systeminformation';
-
-/**
- * @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
- */
-
-/**
- * Retrieve information of network interfaces
- *  Return `null` if no WiFi connection found.
- *
- * @async
- * @return {NetworkInterfaces|null}
- */
-export async function getNetworkInterfacesInfos({
-  interfaceFilter = (i) => {
-    // only IPv4
-    // avoid localhost
-    return i.ip4
-      && i.ip4 !== '127.0.0.1'
-      && i.ip4 !== 'localhost';
-  }
-}= {}) {
-  const interfaces = await si.networkInterfaces();
-
-  if(!interfaces) {
-    return null;
-  }
-
-  if(typeof interfaceFilter !== 'function') {
-    return interfaces;
-  }
-
-  return interfaces.filter(interfaceFilter);
-}
-
-
-
-
-
-
-
-
-
-

package/src/.editorbackup/wifi-infos.js~

@@ -1,33 +0,0 @@
-import si from 'systeminformation';
-
-/**
- * @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}
- */
-export async function getWifiInfos() {
-  // find first wifi connection
-  const wifiConnections = await si.wifiConnections();
-  const conn = wifiConnections[0];
-
-  if (!conn) {
-    return null;
-  }
-
-  // find related interface
-  const interfaces = await si.networkInterfaces();
-  const int = interfaces.find(int => int.iface === conn.iface);
-
-  return {
-    ssid: conn.ssid,
-    ip: int.ip4,
-  };
-}