add typescript dependency, check jsdoc types (#38)

* add typescript dependency, check jsdoc types

- Add typescript dependency
- Add test-types npm script
- Call npm test-types in npm test script
- Add CommandServer class extends WebSocketServer
- Add @types for dependencies that need them

* fixup! add typescript dependency, check jsdoc types

Author: mzgoddard

lib/cli.js

@@ -19,7 +19,7 @@ const DEFAULT_PORT = 4382;
 const log = (...args) => console.error(new Date().toISOString(), ...args);
 
 module.exports = async process => {
-  const argv = yargs(hideBin(process.argv))
+  const argv = await yargs(hideBin(process.argv))
     .option('port', {
       coerce(string) {
         if (!/^(0|[1-9][0-9]*)$/.test(string)) {

lib/create-command-server.js

@@ -1,20 +1,19 @@
 'use strict';
+
 const { WebSocketServer } = require('ws');
 const interactionModule = require('./modules/interaction');
 const sessionModule = require('./modules/session');
 
-const broadcast = (server, message) => {
-  const packedMessage = JSON.stringify(message);
-  server.clients.forEach(websocket => {
-    if (websocket.sessionId) {
-      websocket.send(packedMessage, error => {
-        if (error) {
-          server.emit('error', `error sending message: ${error}`);
-        }
-      });
-    }
-  });
-};
+/** @typedef {import("ws").WebSocket} WebSocket */
+
+/**
+ * @typedef WebSocketData
+ * @property {string} [sessionId]
+ */
+
+/**
+ * @typedef {WebSocket & WebSocketData} WebSocketWithData
+ */
 
 const methodHandlers = {
   ...interactionModule,
@@ -70,26 +69,44 @@ const onConnection = websocket => {
   });
 };
 
+class CommandServer extends WebSocketServer {
+  /**
+   * Broadcast message to all clients.
+   * @param message
+   */
+  broadcast(message) {
+    const packedMessage = JSON.stringify(message);
+    /** @type {Set<WebSocketWithData>} */ (this.clients).forEach(websocket => {
+      if (websocket.sessionId) {
+        websocket.send(packedMessage, error => {
+          if (error) {
+            this.emit('error', `error sending message: ${error}`);
+          }
+        });
+      }
+    });
+  }
+}
+
 /**
  * Create a server which communicates with external clients using the WebSocket
  * protocol described in the project README.md file.
  *
  * @param {number} port - the port on which the server should listen for new
  *                        connections
  *
- * @returns {Promise<EventEmitter>} an eventual value which is fulfilled when
- *                                  the server has successfully bound to the
- *                                  requested port
+ * @returns {Promise<CommandServer>} an eventual value which is fulfilled when
+ *                                   the server has successfully bound to the
+ *                                   requested port
  */
 module.exports = async function createWebSocketServer(port) {
-  const server = new WebSocketServer({
+  const server = new CommandServer({
     clientTracking: true,
     path: '/session',
     port,
   });
   await new Promise(resolve => server.once('listening', resolve));
 
-  server.broadcast = broadcast.bind(null, server);
   server.on('connection', onConnection);
 
   return server;

lib/create-voice-server.js

@@ -2,6 +2,8 @@
 
 const net = require('net');
 
+/** @typedef {import("events").EventEmitter} EventEmitter */
+
 const onConnection = (server, socket) => {
   let emitted = '';
   socket.on('data', buffer => (emitted += buffer.toString()));

package-lock.json

@@ -10,8 +10,9 @@
     "postinstall": "Release\\MakeVoice.exe",
     "postuninstall": "Release\\MakeVoice.exe /u",
     "prettier": "prettier --write lib test",
-    "test": "prettier --check lib test && npm run test-unit",
-    "test-unit": "mocha --ui tdd test"
+    "test": "prettier --check lib test && npm run test-types && npm run test-unit",
+    "test-unit": "mocha --ui tdd test",
+    "test-types": "tsc -p tsconfig.json"
   },
   "files": [
     "lib",
@@ -22,8 +23,13 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.17",
+    "@types/ws": "^8.5.10",
+    "@types/yargs": "^17.0.32",
     "mocha": "^9.1.2",
-    "prettier": "^3.2.4"
+    "prettier": "^3.2.4",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
     "robotjs": "^0.6.0",

package.json

@@ -0,0 +1,7 @@
+{
+    "compilerOptions": {
+        "checkJs": true,
+        "noEmit": true
+    },
+    "include": ["lib", "test"]
+}