buttplug 3.1.1 → 3.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "buttplug",
-  "version": "3.1.1",
+  "version": "3.2.1",
   "description": "Buttplug Client Implementation for Typescript/Javascript",
   "homepage": "https://github.com/buttplugio/buttplug-js/",
   "repository": {
@@ -20,15 +20,10 @@
   "types": "./dist/main/src/index.d.ts",
   "scripts": {
     "build": "trash dist dist-bundle && yarn build:all",
-    "build:all": "yarn build:main && yarn build:web && yarn build:web:release",
+    "build:all": "yarn build:main && yarn build:web",
     "build:main": "tsc -p tsconfig.json",
     "build:doc": "typedoc --options typedocconfig.js --out doc ./src/index.ts",
-    "build:rollup": "rollup -c",
-    "tslint": "tslint --project tsconfig.json --outputAbsolutePaths -c ../../tslint.json \"src/**/*.ts\" \"tests/**/*.ts\"",
-    "tslint:fix": "tslint --project tsconfig.json --outputAbsolutePaths -c ../../tslint.json --fix semicolon,comma,no-var-keyword,ordered-imports \"src/**/*.ts\" \"tests/**/*.ts\"",
-    "build:web": "webpack --config=build/webpack.base.js",
-    "build:web:release": "webpack --progress --hide-modules --config=build/webpack.production.js",
-    "build:analyze": "webpack --hide-modules --config=build/webpack.analyzer.js",
+    "build:web": "vite build",
     "pretest": "yarn build:main",
     "test": "jest tests/*",
     "web-test": "jest web-tests/test-web-library.ts",
@@ -36,63 +31,38 @@
   },
   "dependencies": {
     "class-transformer": "^0.5.1",
-    "eventemitter3": "^5.0.0",
+    "eventemitter3": "^5.0.1",
     "reflect-metadata": "^0.1.13",
-    "ws": "^8.12.0"
+    "ws": "^8.14.2"
   },
   "devDependencies": {
     "@types/commander": "^2.12.2",
-    "@types/expect-puppeteer": "^5.0.2",
-    "@types/jest": "^29.4.0",
-    "@types/jest-environment-puppeteer": "^5.0.3",
-    "@types/node": "^18.13.0",
+    "@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.4",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
+    "@types/ws": "^8.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.7.2",
+    "@typescript-eslint/parser": "^6.7.2",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "eslint": "^8.34.0",
+    "eslint": "^8.50.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "fork-ts-checker-webpack-plugin": "^7.3.0",
-    "gts": "^3.1.1",
-    "jest": "^29.4.2",
-    "jest-puppeteer": "^7.0.0",
-    "mock-socket": "^9.2.0",
-    "pkg": "^5.8.0",
-    "puppeteer": "^19.6.3",
-    "rollup": "^3.15.0",
-    "rollup-plugin-auto-external": "^2.0.0",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-html": "^0.2.1",
-    "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-node-builtins": "^2.1.2",
-    "rollup-plugin-node-globals": "^1.4.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-postcss": "^4.0.2",
-    "rollup-plugin-postcss-modules": "^2.1.1",
-    "rollup-plugin-terser": "^5.3.0",
-    "rollup-plugin-typescript2": "^0.34.1",
-    "selfsigned": "^2.1.1",
-    "style-loader": "^3.3.1",
-    "terser": "^4.x",
-    "terser-webpack-plugin": "^4.x",
+    "gts": "^5.0.1",
+    "jest": "^29.7.0",
+    "mock-socket": "^9.3.1",
+    "pkg": "^5.8.1",
     "tmp": "^0.2.1",
     "trash": "^8.1.1",
     "trash-cli": "^5.0.0",
-    "ts-jest": "^29.0.5",
-    "ts-loader": "^8.x",
+    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "tslib": "^2.5.0",
-    "tslint": "^6.1.0",
-    "typedoc": "^0.23.25",
-    "typescript": "^4.9.5",
-    "url-loader": "^4.1.1",
-    "webpack": "^4.42.1",
-    "webpack-bundle-analyzer": "^3.6.1",
-    "webpack-cli": "^3.3.11",
-    "webpack-merge": "^4.2.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"
   },
   "jest": {

package/src/client/ButtplugBrowserWebsocketClientConnector.ts

@@ -10,38 +10,16 @@
 
 import { IButtplugClientConnector } from './IButtplugClientConnector';
 import { ButtplugMessage } from '../core/Messages';
-import { FromJSON } from '../core/MessageUtils';
-import { ButtplugMessageSorter } from '../utils/ButtplugMessageSorter';
 import { ButtplugBrowserWebsocketConnector } from '../utils/ButtplugBrowserWebsocketConnector';
 
 export class ButtplugBrowserWebsocketClientConnector
   extends ButtplugBrowserWebsocketConnector
   implements IButtplugClientConnector
 {
-  private _sorter: ButtplugMessageSorter = new ButtplugMessageSorter(true);
-
-  public Send = async (msg: ButtplugMessage): Promise<ButtplugMessage> => {
+  public send = (msg: ButtplugMessage): void => {
     if (!this.Connected) {
       throw new Error('ButtplugClient not connected');
     }
-    const p = this._sorter.PrepareOutgoingMessage(msg);
-    this.SendMessage(msg);
-    return await p;
+    this.sendMessage(msg);
   };
-
-  protected ParseIncomingMessage = (event: MessageEvent) => {
-    if (typeof event.data === 'string') {
-      const msgs = FromJSON(event.data);
-      const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
-      this.emit('message', emitMsgs);
-    } else if (event.data instanceof Blob) {
-      // No-op, buttplug only uses text formatting.
-    }
-  };
-
-  protected OnReaderLoad(event: Event) {
-    const msgs = FromJSON((event.target as FileReader).result);
-    const emitMsgs = this._sorter.ParseIncomingMessages(msgs);
-    this.emit('message', emitMsgs);
-  }
 }

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:
@@ -209,7 +210,7 @@ export class ButtplugClientDevice extends EventEmitter {
   }
 
   public get linearAttributes(): Messages.GenericDeviceMessageAttributes[] {
-    return this.messageAttributes.RotateCmd ?? [];
+    return this.messageAttributes.LinearCmd ?? [];
   }
 
   public async linear(
@@ -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

@@ -12,6 +12,8 @@ import { ButtplugLogger } from '../core/Logging';
 import { EventEmitter } from 'eventemitter3';
 import { ButtplugClientDevice } from './ButtplugClientDevice';
 import { IButtplugClientConnector } from './IButtplugClientConnector';
+import { ButtplugMessageSorter } from '../utils/ButtplugMessageSorter';
+
 import * as Messages from '../core/Messages';
 import {
   ButtplugDeviceError,
@@ -20,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;
@@ -28,6 +31,7 @@ export class ButtplugClient extends EventEmitter {
   protected _clientName: string;
   protected _logger = ButtplugLogger.Logger;
   protected _isScanning = false;
+  private _sorter: ButtplugMessageSorter = new ButtplugMessageSorter(true);
 
   constructor(clientName = 'Generic Buttplug Client') {
     super();
@@ -58,7 +62,7 @@ export class ButtplugClient extends EventEmitter {
     this._logger.Info(
       `ButtplugClient: Connecting using ${connector.constructor.name}`
     );
-    await connector.Connect();
+    await connector.connect();
     this._connector = connector;
     this._connector.addListener('message', this.parseMessages);
     this._connector.addListener('disconnect', this.disconnectHandler);
@@ -69,7 +73,7 @@ export class ButtplugClient extends EventEmitter {
     this._logger.Debug('ButtplugClient: Disconnect called');
     this.checkConnector();
     await this.shutdownConnection();
-    await this._connector!.Disconnect();
+    await this._connector!.disconnect();
   };
 
   public startScanning = async () => {
@@ -112,8 +116,9 @@ export class ButtplugClient extends EventEmitter {
   };
 
   protected parseMessages = (msgs: Messages.ButtplugMessage[]) => {
-    for (const x of msgs) {
-      switch (x.constructor) {
+    const leftoverMsgs = this._sorter.ParseIncomingMessages(msgs);
+    for (const x of leftoverMsgs) {
+      switch (getMessageClassFromMessage(x)) {
         case Messages.DeviceAdded: {
           const addedMsg = x as Messages.DeviceAdded;
           const addedDevice = ButtplugClientDevice.fromMsg(
@@ -150,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(
@@ -160,7 +165,7 @@ export class ButtplugClient extends EventEmitter {
         const ping = serverinfo.MaxPingTime;
         if (serverinfo.MessageVersion < Messages.MESSAGE_SPEC_VERSION) {
           // Disconnect and throw an exception explaining the version mismatch problem.
-          await this._connector!.Disconnect();
+          await this._connector!.disconnect();
           throw ButtplugError.LogAndError(
             ButtplugInitError,
             this._logger,
@@ -186,7 +191,7 @@ export class ButtplugClient extends EventEmitter {
         // Disconnect and throw an exception with the error message we got back.
         // This will usually only error out if we have a version mismatch that the
         // server has detected.
-        await this._connector!.Disconnect();
+        await this._connector!.disconnect();
         const err = msg as Messages.Error;
         throw ButtplugError.LogAndError(
           ButtplugInitError,
@@ -231,7 +236,9 @@ export class ButtplugClient extends EventEmitter {
     msg: Messages.ButtplugMessage
   ): Promise<Messages.ButtplugMessage> {
     this.checkConnector();
-    return await this._connector!.Send(msg);
+    const p = this._sorter.PrepareOutgoingMessage(msg);
+    await this._connector!.send(msg);
+    return await p;
   }
 
   protected checkConnector() {
@@ -246,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:
@@ -255,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/client/IButtplugClientConnector.ts

@@ -10,9 +10,9 @@ import { ButtplugMessage } from '../core/Messages';
 import { EventEmitter } from 'eventemitter3';
 
 export interface IButtplugClientConnector extends EventEmitter {
-  Connect: () => Promise<void>;
-  Disconnect: () => Promise<void>;
-  Initialize: () => Promise<void>;
-  Send: (msg: ButtplugMessage) => Promise<ButtplugMessage>;
+  connect: () => Promise<void>;
+  disconnect: () => Promise<void>;
+  initialize: () => Promise<void>;
+  send: (msg: ButtplugMessage) => void;
   readonly Connected: boolean;
 }

package/src/core/MessageUtils.ts

@@ -21,7 +21,15 @@ function getMessageClass(
   return null;
 }
 
-export function FromJSON(str): Messages.ButtplugMessage[] {
+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[] = [];
   for (const x of Array.from(msgarray)) {

package/src/utils/ButtplugBrowserWebsocketConnector.ts

@@ -10,7 +10,7 @@
 
 import { EventEmitter } from 'eventemitter3';
 import { ButtplugMessage } from '../core/Messages';
-import { FromJSON } from '../core/MessageUtils';
+import { fromJSON } from '../core/MessageUtils';
 
 export class ButtplugBrowserWebsocketConnector extends EventEmitter {
   protected _ws: WebSocket | undefined;
@@ -24,7 +24,7 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
     return this._ws !== undefined;
   }
 
-  public Connect = async (): Promise<void> => {
+  public connect = async (): Promise<void> => {
     const ws = new (this._websocketConstructor ?? WebSocket)(this._url);
     let res;
     let rej;
@@ -39,12 +39,12 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
     ws.addEventListener('open', async () => {
       this._ws = ws;
       try {
-        await this.Initialize();
+        await this.initialize();
         this._ws.addEventListener('message', (msg) => {
-          this.ParseIncomingMessage(msg);
+          this.parseIncomingMessage(msg);
         });
         this._ws.removeEventListener('close', conErrorCallback);
-        this._ws.addEventListener('close', this.Disconnect);
+        this._ws.addEventListener('close', this.disconnect);
         // TODO This doesn't really communicate the chain why our initializer failed
         res();
       } catch (e) {
@@ -56,7 +56,7 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
     return p;
   };
 
-  public Disconnect = async (): Promise<void> => {
+  public disconnect = async (): Promise<void> => {
     if (!this.Connected) {
       return;
     }
@@ -65,28 +65,28 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
     this.emit('disconnect');
   };
 
-  public SendMessage(msg: ButtplugMessage) {
+  public sendMessage(msg: ButtplugMessage) {
     if (!this.Connected) {
       throw new Error('ButtplugBrowserWebsocketConnector not connected');
     }
     this._ws!.send('[' + msg.toJSON() + ']');
   }
 
-  public Initialize = async (): Promise<void> => {
+  public initialize = async (): Promise<void> => {
     return Promise.resolve();
   };
 
-  protected ParseIncomingMessage(event: MessageEvent) {
+  protected parseIncomingMessage(event: MessageEvent) {
     if (typeof event.data === 'string') {
-      const msgs = FromJSON(event.data);
+      const msgs = fromJSON(event.data);
       this.emit('message', msgs);
     } else if (event.data instanceof Blob) {
       // No-op, we only use text message types.
     }
   }
 
-  protected OnReaderLoad(event: Event) {
-    const msgs = FromJSON((event.target as FileReader).result);
+  protected onReaderLoad(event: Event) {
+    const msgs = fromJSON((event.target as FileReader).result);
     this.emit('message', msgs);
   }
 }

package/vite.config.ts

@@ -0,0 +1,26 @@
+import { resolve } from 'path';
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+
+export default defineConfig({
+  build: {
+    lib: {
+      // Could also be a dictionary or array of multiple entry points
+      entry: resolve(__dirname, 'src/index.ts'),
+      name: 'buttplug',
+      // the proper extensions will be added
+      fileName: (format): string => {
+        if (format === 'umd') {
+          return 'buttplug.js';
+        }
+        return 'buttplug.mjs';
+      },
+    },
+    outDir: 'dist/web',
+  },
+  plugins: [
+    dts({
+      exclude: ['tests'],
+    }),
+  ],
+});

package/.github/FUNDING.yml

@@ -1,5 +0,0 @@
-# These are supported funding model platforms
-
-github: qdot
-patreon: qdot
-ko_fi: qdot76367

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +0,0 @@
----
-name: Bug report
-about: Issues related to messages or system architecture
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is. Remember, this should only pertain to bugs at the protocol or general architecture level. Library or application specific bugs should be files in their respective repos.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Additional context**
-Add any other context about the problem here.

package/.github/workflows/docs.yaml

@@ -1,29 +0,0 @@
-name: Doc Build
-
-on: 
-  push:
-    branches:
-      - master
-
-jobs:
-  publish-docs:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set Node.js 18.x
-      uses: actions/setup-node@v3
-      with:
-        node-version: 18.x
-    - name: Run install
-      uses: borales/actions-yarn@v4
-      with:
-        cmd: install # will run `yarn install` command
-    - name: Build production bundle
-      uses: borales/actions-yarn@v4
-      with:
-        cmd: build:doc
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: doc/

package/azure-pipelines.yml

@@ -1,19 +0,0 @@
-trigger:
-- master
-- dev
-
-jobs:
-  # - job: "MacOS"
-  #   pool:
-  #     vmImage: 'macos-10.13'
-  #   steps:
-  #     - template: 'build/build-test-freeze.yml'
-  #       parameters:
-  #         platform: "macos-x64"
-  - job: "Linux"
-    pool:
-      vmImage: 'ubuntu-16.04'
-    steps:
-      - template: 'build/build-test-freeze.yml'
-        parameters:
-          platform: "linux-x64"