buttplug 3.2.0 → 3.2.2

package/dist/web/core/MessageUtils.d.ts

@@ -6,4 +6,5 @@
  * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
  */
 import * as Messages from './Messages';
+export declare function getMessageClassFromMessage(msg: Messages.ButtplugMessage): (new (...args: unknown[]) => Messages.ButtplugMessage) | null;
 export declare function fromJSON(str: any): Messages.ButtplugMessage[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "buttplug",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "Buttplug Client Implementation for Typescript/Javascript",
   "homepage": "https://github.com/buttplugio/buttplug-js/",
   "repository": {
@@ -32,38 +32,38 @@
   "dependencies": {
     "class-transformer": "^0.5.1",
     "eventemitter3": "^5.0.1",
-    "reflect-metadata": "^0.1.13",
-    "ws": "^8.14.2"
+    "reflect-metadata": "^0.2.1",
+    "ws": "^8.16.0"
   },
   "devDependencies": {
     "@types/commander": "^2.12.2",
-    "@types/expect-puppeteer": "^5.0.4",
-    "@types/jest": "^29.5.5",
-    "@types/jest-environment-puppeteer": "^5.0.4",
-    "@types/node": "^20.6.3",
-    "@types/uuid-parse": "^1.0.0",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.7.2",
-    "@typescript-eslint/parser": "^6.7.2",
+    "@types/expect-puppeteer": "^5.0.6",
+    "@types/jest": "^29.5.12",
+    "@types/jest-environment-puppeteer": "^5.0.6",
+    "@types/node": "^20.11.24",
+    "@types/uuid-parse": "^1.0.2",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.50.0",
+    "eslint": "^8.57.0",
     "eslint-plugin-node": "^11.1.0",
-    "gts": "^5.0.1",
+    "gts": "^5.2.0",
     "jest": "^29.7.0",
     "mock-socket": "^9.3.1",
     "pkg": "^5.8.1",
-    "tmp": "^0.2.1",
+    "tmp": "^0.2.3",
     "trash": "^8.1.1",
     "trash-cli": "^5.0.0",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
     "tslib": "^2.6.2",
-    "typedoc": "^0.25.1",
-    "typescript": "^5.2.2",
-    "vite": "^4.4.9",
-    "vite-plugin-dts": "^3.5.4",
-    "yarn": "^1.22.19"
+    "typedoc": "^0.25.9",
+    "typescript": "^5.3.3",
+    "vite": "^5.1.4",
+    "vite-plugin-dts": "^3.7.3",
+    "yarn": "^1.22.21"
   },
   "jest": {
     "moduleFileExtensions": [

package/src/client/ButtplugClientDevice.ts

@@ -14,6 +14,7 @@ import {
   ButtplugMessageError,
 } from '../core/Exceptions';
 import { EventEmitter } from 'eventemitter3';
+import { getMessageClassFromMessage } from '../core/MessageUtils';
 
 /**
  * Represents an abstract device, capable of taking certain kinds of messages.
@@ -98,7 +99,7 @@ export class ButtplugClientDevice extends EventEmitter {
     msg: Messages.ButtplugDeviceMessage
   ): Promise<void> {
     const response = await this.send(msg);
-    switch (response.constructor) {
+    switch (getMessageClassFromMessage(response)) {
       case Messages.Ok:
         return;
       case Messages.Error:
@@ -245,7 +246,7 @@ export class ButtplugClientDevice extends EventEmitter {
     const response = await this.send(
       new Messages.SensorReadCmd(this.index, sensorIndex, sensorType)
     );
-    switch (response.constructor) {
+    switch (getMessageClassFromMessage(response)) {
       case Messages.SensorReading:
         return (response as Messages.SensorReading).Data;
       case Messages.Error:
@@ -323,7 +324,7 @@ export class ButtplugClientDevice extends EventEmitter {
     const response = await this.send(
       new Messages.RawReadCmd(this.index, endpoint, expectedLength, timeout)
     );
-    switch (response.constructor) {
+    switch (getMessageClassFromMessage(response)) {
       case Messages.RawReading:
         return new Uint8Array((response as Messages.RawReading).Data);
       case Messages.Error:

package/src/client/Client.ts

@@ -22,6 +22,7 @@ import {
   ButtplugMessageError,
 } from '../core/Exceptions';
 import { ButtplugClientConnectorException } from './ButtplugClientConnectorException';
+import { getMessageClassFromMessage } from '../core/MessageUtils';
 
 export class ButtplugClient extends EventEmitter {
   protected _pingTimer: NodeJS.Timeout | null = null;
@@ -117,7 +118,7 @@ export class ButtplugClient extends EventEmitter {
   protected parseMessages = (msgs: Messages.ButtplugMessage[]) => {
     const leftoverMsgs = this._sorter.ParseIncomingMessages(msgs);
     for (const x of leftoverMsgs) {
-      switch (x.constructor) {
+      switch (getMessageClassFromMessage(x)) {
         case Messages.DeviceAdded: {
           const addedMsg = x as Messages.DeviceAdded;
           const addedDevice = ButtplugClientDevice.fromMsg(
@@ -154,7 +155,7 @@ export class ButtplugClient extends EventEmitter {
         Messages.MESSAGE_SPEC_VERSION
       )
     );
-    switch (msg.constructor) {
+    switch (getMessageClassFromMessage(msg)) {
       case Messages.ServerInfo: {
         const serverinfo = msg as Messages.ServerInfo;
         this._logger.Info(
@@ -252,7 +253,7 @@ export class ButtplugClient extends EventEmitter {
     msg: Messages.ButtplugMessage
   ): Promise<void> => {
     const response = await this.sendMessage(msg);
-    switch (response.constructor) {
+    switch (getMessageClassFromMessage(response)) {
       case Messages.Ok:
         return;
       case Messages.Error:
@@ -261,7 +262,7 @@ export class ButtplugClient extends EventEmitter {
         throw ButtplugError.LogAndError(
           ButtplugMessageError,
           this._logger,
-          `Message type ${response.constructor} not handled by SendMsgExpectOk`
+          `Message type ${getMessageClassFromMessage(response)!.constructor} not handled by SendMsgExpectOk`
         );
     }
   };

package/src/core/MessageUtils.ts

@@ -21,6 +21,14 @@ function getMessageClass(
   return null;
 }
 
+export function getMessageClassFromMessage(
+  msg: Messages.ButtplugMessage
+): (new (...args: unknown[]) => Messages.ButtplugMessage) | null {
+  // Making the bold assumption all message classes have the Name static. Should define a
+  // requirement for this in the abstract class.
+  return getMessageClass(Object.getPrototypeOf(msg).constructor.Name);
+}
+
 export function fromJSON(str): Messages.ButtplugMessage[] {
   const msgarray: object[] = JSON.parse(str);
   const msgs: Messages.ButtplugMessage[] = [];

package/src/utils/ButtplugBrowserWebsocketConnector.ts

@@ -25,35 +25,32 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
   }
 
   public connect = async (): Promise<void> => {
-    const ws = new (this._websocketConstructor ?? WebSocket)(this._url);
-    let res;
-    let rej;
-    const p = new Promise<void>((resolve, reject) => {
-      res = resolve;
-      rej = reject;
-    });
-    // In websockets, our error rarely tells us much, as for security reasons
-    // browsers usually only throw Error Code 1006. It's up to those using this
-    // library to state what the problem might be.
-    const conErrorCallback = () => rej();
-    ws.addEventListener('open', async () => {
-      this._ws = ws;
-      try {
-        await this.initialize();
-        this._ws.addEventListener('message', (msg) => {
-          this.parseIncomingMessage(msg);
-        });
-        this._ws.removeEventListener('close', conErrorCallback);
-        this._ws.addEventListener('close', this.disconnect);
-        // TODO This doesn't really communicate the chain why our initializer failed
-        res();
-      } catch (e) {
-        console.log(e);
-        rej();
-      }
+    return new Promise<void>((resolve, reject) => {
+      const ws = new (this._websocketConstructor ?? WebSocket)(this._url);
+      const onErrorCallback = (event: Event) => {reject(event)}
+      const onCloseCallback = (event: CloseEvent) => reject(event.reason)
+      ws.addEventListener('open', async () => {
+        this._ws = ws;
+        try {
+          await this.initialize();
+          this._ws.addEventListener('message', (msg) => {
+            this.parseIncomingMessage(msg);
+          });
+          this._ws.removeEventListener('close', onCloseCallback);
+          this._ws.removeEventListener('error', onErrorCallback);
+          this._ws.addEventListener('close', this.disconnect);
+          resolve();
+        } catch (e) {
+          reject(e);
+        }
+      });
+      // In websockets, our error rarely tells us much, as for security reasons
+      // browsers usually only throw Error Code 1006. It's up to those using this
+      // library to state what the problem might be.
+
+      ws.addEventListener('error', onErrorCallback)
+      ws.addEventListener('close', onCloseCallback);
     });
-    ws.addEventListener('close', conErrorCallback);
-    return p;
   };
 
   public disconnect = async (): Promise<void> => {

package/util/convert_device_config.js

@@ -1,6 +0,0 @@
-var inputfile = './dependencies/buttplug-device-config/buttplug-device-config.yml',
-    outputfile = './dependencies/buttplug-device-config/buttplug-device-config.json',
-    yaml = require('js-yaml'),
-    fs = require('fs'),
-    obj = yaml.load(fs.readFileSync(inputfile, {encoding: 'utf-8'}));
-fs.writeFileSync(outputfile, JSON.stringify(obj, null, 2));