buttplug 3.2.2 → 4.0.1

package/src/index.ts

@@ -1,19 +1,21 @@
-/*!
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
- * project root for full license information.
- *
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
- */
-
-export * from './client/Client';
-export * from './client/ButtplugClientDevice';
-export * from './client/ButtplugBrowserWebsocketClientConnector';
-export * from './client/ButtplugNodeWebsocketClientConnector';
-export * from './client/ButtplugClientConnectorException';
-export * from './utils/ButtplugMessageSorter';
-export * from './client/IButtplugClientConnector';
-export * from './core/Messages';
-export * from './core/MessageUtils';
-export * from './core/Logging';
-export * from './core/Exceptions';
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+
+export * from './client/ButtplugClient';
+export * from './client/ButtplugClientDevice';
+export * from './client/ButtplugBrowserWebsocketClientConnector';
+export * from './client/ButtplugNodeWebsocketClientConnector';
+export * from './client/ButtplugClientConnectorException';
+export * from './utils/ButtplugMessageSorter';
+export * from './client/ButtplugClientDeviceCommand';
+export * from './client/IButtplugClientConnector';
+//export * from './core/MessageClasses';
+export * from './core/Messages';
+//export * from './core/MessageUtils';
+export * from './core/Logging';
+export * from './core/Exceptions';

package/src/utils/ButtplugBrowserWebsocketConnector.ts

@@ -1,89 +1,89 @@
-/*!
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
- * project root for full license information.
- *
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
- */
-
-'use strict';
-
-import { EventEmitter } from 'eventemitter3';
-import { ButtplugMessage } from '../core/Messages';
-import { fromJSON } from '../core/MessageUtils';
-
-export class ButtplugBrowserWebsocketConnector extends EventEmitter {
-  protected _ws: WebSocket | undefined;
-  protected _websocketConstructor: typeof WebSocket | null = null;
-
-  public constructor(private _url: string) {
-    super();
-  }
-
-  public get Connected(): boolean {
-    return this._ws !== undefined;
-  }
-
-  public connect = async (): Promise<void> => {
-    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);
-    });
-  };
-
-  public disconnect = async (): Promise<void> => {
-    if (!this.Connected) {
-      return;
-    }
-    this._ws!.close();
-    this._ws = undefined;
-    this.emit('disconnect');
-  };
-
-  public sendMessage(msg: ButtplugMessage) {
-    if (!this.Connected) {
-      throw new Error('ButtplugBrowserWebsocketConnector not connected');
-    }
-    this._ws!.send('[' + msg.toJSON() + ']');
-  }
-
-  public initialize = async (): Promise<void> => {
-    return Promise.resolve();
-  };
-
-  protected parseIncomingMessage(event: MessageEvent) {
-    if (typeof event.data === 'string') {
-      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);
-    this.emit('message', msgs);
-  }
-}
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+
+'use strict';
+
+import { EventEmitter } from 'eventemitter3';
+import { ButtplugMessage } from '../core/Messages';
+//import { fromJSON } from '../core/MessageUtils';
+
+export class ButtplugBrowserWebsocketConnector extends EventEmitter {
+  protected _ws: WebSocket | undefined;
+  protected _websocketConstructor: typeof WebSocket | null = null;
+
+  public constructor(private _url: string) {
+    super();
+  }
+
+  public get Connected(): boolean {
+    return this._ws !== undefined;
+  }
+
+  public connect = async (): Promise<void> => {
+    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);
+    });
+  };
+
+  public disconnect = async (): Promise<void> => {
+    if (!this.Connected) {
+      return;
+    }
+    this._ws!.close();
+    this._ws = undefined;
+    this.emit('disconnect');
+  };
+
+  public sendMessage(msg: ButtplugMessage) {
+    if (!this.Connected) {
+      throw new Error('ButtplugBrowserWebsocketConnector not connected');
+    }
+    this._ws!.send('[' + JSON.stringify(msg) + ']');
+  }
+
+  public initialize = async (): Promise<void> => {
+    return Promise.resolve();
+  };
+
+  protected parseIncomingMessage(event: MessageEvent) {
+    if (typeof event.data === 'string') {
+      const msgs: ButtplugMessage[] = JSON.parse(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: ButtplugMessage[] = JSON.parse((event.target as FileReader).result as string);
+    this.emit('message', msgs);
+  }
+}

package/src/utils/ButtplugMessageSorter.ts

@@ -1,65 +1,66 @@
-/*!
- * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
- * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
- * project root for full license information.
- *
- * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
- */
-
-import * as Messages from '../core/Messages';
-import { ButtplugError } from '../core/Exceptions';
-
-export class ButtplugMessageSorter {
-  protected _counter = 1;
-  protected _waitingMsgs: Map<
-    number,
-    [(val: Messages.ButtplugMessage) => void, (err: Error) => void]
-  > = new Map();
-
-  public constructor(private _useCounter: boolean) {}
-
-  // One of the places we should actually return a promise, as we need to store
-  // them while waiting for them to return across the line.
-  // tslint:disable:promise-function-async
-  public PrepareOutgoingMessage(
-    msg: Messages.ButtplugMessage
-  ): Promise<Messages.ButtplugMessage> {
-    if (this._useCounter) {
-      msg.Id = this._counter;
-      // Always increment last, otherwise we might lose sync
-      this._counter += 1;
-    }
-    let res;
-    let rej;
-    const msgPromise = new Promise<Messages.ButtplugMessage>(
-      (resolve, reject) => {
-        res = resolve;
-        rej = reject;
-      }
-    );
-    this._waitingMsgs.set(msg.Id, [res, rej]);
-    return msgPromise;
-  }
-
-  public ParseIncomingMessages(
-    msgs: Messages.ButtplugMessage[]
-  ): Messages.ButtplugMessage[] {
-    const noMatch: Messages.ButtplugMessage[] = [];
-    for (const x of msgs) {
-      if (x.Id !== Messages.SYSTEM_MESSAGE_ID && this._waitingMsgs.has(x.Id)) {
-        const [res, rej] = this._waitingMsgs.get(x.Id)!;
-        // If we've gotten back an error, reject the related promise using a
-        // ButtplugException derived type.
-        if (x.Type === Messages.Error) {
-          rej(ButtplugError.FromError(x as Messages.Error));
-          continue;
-        }
-        res(x);
-        continue;
-      } else {
-        noMatch.push(x);
-      }
-    }
-    return noMatch;
-  }
-}
+/*!
+ * Buttplug JS Source Code File - Visit https://buttplug.io for more info about
+ * the project. Licensed under the BSD 3-Clause license. See LICENSE file in the
+ * project root for full license information.
+ *
+ * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
+ */
+
+import * as Messages from '../core/Messages';
+import { ButtplugError } from '../core/Exceptions';
+
+export class ButtplugMessageSorter {
+  protected _counter = 1;
+  protected _waitingMsgs: Map<
+    number,
+    [(val: Messages.ButtplugMessage) => void, (err: Error) => void]
+  > = new Map();
+
+  public constructor(private _useCounter: boolean) {}
+
+  // One of the places we should actually return a promise, as we need to store
+  // them while waiting for them to return across the line.
+  // tslint:disable:promise-function-async
+  public PrepareOutgoingMessage(
+    msg: Messages.ButtplugMessage
+  ): Promise<Messages.ButtplugMessage> {
+    if (this._useCounter) {
+      Messages.setMsgId(msg, this._counter);
+      // Always increment last, otherwise we might lose sync
+      this._counter += 1;
+    }
+    let res;
+    let rej;
+    const msgPromise = new Promise<Messages.ButtplugMessage>(
+      (resolve, reject) => {
+        res = resolve;
+        rej = reject;
+      }
+    );
+    this._waitingMsgs.set(Messages.msgId(msg), [res, rej]);
+    return msgPromise;
+  }
+
+  public ParseIncomingMessages(
+    msgs: Messages.ButtplugMessage[]
+  ): Messages.ButtplugMessage[] {
+    const noMatch: Messages.ButtplugMessage[] = [];
+    for (const x of msgs) {
+      let id = Messages.msgId(x);
+      if (id !== Messages.SYSTEM_MESSAGE_ID && this._waitingMsgs.has(id)) {
+        const [res, rej] = this._waitingMsgs.get(id)!;
+        // If we've gotten back an error, reject the related promise using a
+        // ButtplugException derived type.
+        if (x.Error !== undefined) {
+          rej(ButtplugError.FromError(x.Error!));
+          continue;
+        }
+        res(x);
+        continue;
+      } else {
+        noMatch.push(x);
+      }
+    }
+    return noMatch;
+  }
+}

package/src/utils/Utils.ts

@@ -1,3 +1,3 @@
-export function getRandomInt(max: number) {
-  return Math.floor(Math.random() * Math.floor(max));
-}
+export function getRandomInt(max: number) {
+  return Math.floor(Math.random() * Math.floor(max));
+}

package/tsconfig.json

@@ -1,22 +1,22 @@
-{
-  "compilerOptions" : {
-    "baseUrl": "./src",
-    "lib": ["es2015", "dom", "es6"],
-    "target": "es6",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "sourceMap": true,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "strictNullChecks": true,
-    "noImplicitThis": true,
-    "declaration": true,
-    "outDir": "./dist/main",
-    "esModuleInterop": true
-  },
-  "include": [
-    "./src/*.ts",
-    "./src/**/*.ts",
-    "./tests/**/*.ts"
-  ]
-}
+{
+  "compilerOptions" : {
+    "baseUrl": "./src",
+    "lib": ["esnext", "dom"],
+    "target": "esnext",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "strictNullChecks": true,
+    "noImplicitThis": true,
+    "declaration": true,
+    "outDir": "./dist/main",
+    "esModuleInterop": true
+  },
+  "include": [
+    "./src/*.ts",
+    "./src/**/*.ts",
+    "./tests/**/*.ts"
+  ]
+}

package/tsfmt.json

@@ -1,14 +1,14 @@
-{
-  "indentSize": 2,
-  "tabSize": 2,
-  "convertTabsToSpaces": true,
-  "insertSpaceAfterCommaDelimiter": true,
-  "insertSpaceAfterSemicolonInForStatements": true,
-  "insertSpaceBeforeAndAfterBinaryOperators": true,
-  "insertSpaceAfterKeywordsInControlFlowStatements": true,
-  "insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
-  "insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
-  "insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
-  "placeOpenBraceOnNewLineForFunctions": false,
-  "placeOpenBraceOnNewLineForControlBlocks": false
-}
+{
+  "indentSize": 2,
+  "tabSize": 2,
+  "convertTabsToSpaces": true,
+  "insertSpaceAfterCommaDelimiter": true,
+  "insertSpaceAfterSemicolonInForStatements": true,
+  "insertSpaceBeforeAndAfterBinaryOperators": true,
+  "insertSpaceAfterKeywordsInControlFlowStatements": true,
+  "insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+  "placeOpenBraceOnNewLineForFunctions": false,
+  "placeOpenBraceOnNewLineForControlBlocks": false
+}

package/tslint.json

@@ -1,27 +1,27 @@
-{
-  "extends": [
-    "tslint:recommended"
-  ],
-  "linterOptions": {
-      "exclude": [
-          "**/buttplug-gui-proto.d.ts"
-      ]
-  },
-  "jsRules": {},
-  "rules": {
-    "variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore", "allow-pascal-case"],
-    "only-arrow-functions": [false],
-    "indent": [true, "spaces", 2],
-    "no-var-requires": [false],
-    "ordered-imports": [false],
-    "no-console": [false],
-    "object-literal-sort-keys": [false],
-    "max-classes-per-file": [false],
-    "no-bitwise": [false],
-    "semicolon": [true, "always"],
-    "promise-function-async": true,
-    "no-invalid-template-strings": true,
-    "no-floating-promises": true
-  },
-  "rulesDirectory": []
-}
+{
+  "extends": [
+    "tslint:recommended"
+  ],
+  "linterOptions": {
+      "exclude": [
+          "**/buttplug-gui-proto.d.ts"
+      ]
+  },
+  "jsRules": {},
+  "rules": {
+    "variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore", "allow-pascal-case"],
+    "only-arrow-functions": [false],
+    "indent": [true, "spaces", 2],
+    "no-var-requires": [false],
+    "ordered-imports": [false],
+    "no-console": [false],
+    "object-literal-sort-keys": [false],
+    "max-classes-per-file": [false],
+    "no-bitwise": [false],
+    "semicolon": [true, "always"],
+    "promise-function-async": true,
+    "no-invalid-template-strings": true,
+    "no-floating-promises": true
+  },
+  "rulesDirectory": []
+}

package/typedocconfig.js

@@ -1,6 +1,6 @@
-/** @type {import('typedoc').TypeDocOptions} */
-module.exports = {
-  exclude: '**/+(test|example|node_modules)/**/*.ts',
-  excludeExternals: true,
-  excludePrivate: true,
-};
+/** @type {import('typedoc').TypeDocOptions} */
+module.exports = {
+  exclude: '**/+(test|example|node_modules)/**/*.ts',
+  excludeExternals: true,
+  excludePrivate: true,
+};

package/vite.config.ts

@@ -1,26 +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'],
-    }),
-  ],
-});
+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'],
+    }),
+  ],
+});