buttplug 3.0.0-alpha.4 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "buttplug",
-  "version": "3.0.0-alpha.4",
+  "version": "3.0.0",
   "description": "Buttplug Client Implementation for Typescript/Javascript",
   "homepage": "https://github.com/buttplugio/buttplug-js/",
   "repository": {

package/src/client/ButtplugClientConnectorException.ts

@@ -6,10 +6,10 @@
  * @copyright Copyright (c) Nonpolynomial Labs LLC. All rights reserved.
  */
 
-import { ButtplugException } from '../core/Exceptions';
+import { ButtplugError } from '../core/Exceptions';
 import * as Messages from '../core/Messages';
 
-export class ButtplugClientConnectorException extends ButtplugException {
+export class ButtplugClientConnectorException extends ButtplugError {
   public constructor(message: string) {
     super(message, Messages.ErrorClass.ERROR_UNKNOWN);
   }

package/src/client/ButtplugClientDevice.ts

@@ -9,9 +9,9 @@
 'use strict';
 import * as Messages from '../core/Messages';
 import {
-  ButtplugDeviceException,
-  ButtplugException,
-  ButtplugMessageException,
+  ButtplugDeviceError,
+  ButtplugError,
+  ButtplugMessageError,
 } from '../core/Exceptions';
 import { EventEmitter } from 'events';
 
@@ -102,9 +102,9 @@ export class ButtplugClientDevice extends EventEmitter {
       case Messages.Ok:
         return;
       case Messages.Error:
-        throw ButtplugException.FromError(response as Messages.Error);
+        throw ButtplugError.FromError(response as Messages.Error);
       default:
-        throw new ButtplugMessageException(
+        throw new ButtplugMessageError(
           `Message type ${response.constructor} not handled by SendMsgExpectOk`
         );
     }
@@ -128,7 +128,7 @@ export class ButtplugClientDevice extends EventEmitter {
       (x) => x.ActuatorType === actuator
     );
     if (!scalarAttrs || scalarAttrs.length === 0) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no ${actuator} capabilities`
       );
     }
@@ -139,7 +139,7 @@ export class ButtplugClientDevice extends EventEmitter {
       );
     } else if (Array.isArray(speed)) {
       if (speed.length > scalarAttrs.length) {
-        throw new ButtplugDeviceException(
+        throw new ButtplugDeviceError(
           `${speed.length} commands send to a device with ${scalarAttrs.length} vibrators`
         );
       }
@@ -147,7 +147,7 @@ export class ButtplugClientDevice extends EventEmitter {
         cmds.push(new Messages.ScalarSubcommand(x.Index, speed[i], actuator));
       });
     } else {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `${actuator} can only take numbers or arrays of numbers.`
       );
     }
@@ -188,7 +188,7 @@ export class ButtplugClientDevice extends EventEmitter {
   ): Promise<void> {
     const rotateAttrs = this.messageAttributes.RotateCmd;
     if (!rotateAttrs || rotateAttrs.length === 0) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no Rotate capabilities`
       );
     }
@@ -201,7 +201,7 @@ export class ButtplugClientDevice extends EventEmitter {
     } else if (Array.isArray(values)) {
       msg = Messages.RotateCmd.Create(this.index, values);
     } else {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         'SendRotateCmd can only take a number and boolean, or an array of number/boolean tuples'
       );
     }
@@ -218,7 +218,7 @@ export class ButtplugClientDevice extends EventEmitter {
   ): Promise<void> {
     const linearAttrs = this.messageAttributes.LinearCmd;
     if (!linearAttrs || linearAttrs.length === 0) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no Linear capabilities`
       );
     }
@@ -231,7 +231,7 @@ export class ButtplugClientDevice extends EventEmitter {
     } else if (Array.isArray(values)) {
       msg = Messages.LinearCmd.Create(this.index, values);
     } else {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         'SendLinearCmd can only take a number and number, or an array of number/number tuples'
       );
     }
@@ -249,9 +249,9 @@ export class ButtplugClientDevice extends EventEmitter {
       case Messages.SensorReading:
         return (response as Messages.SensorReading).Data;
       case Messages.Error:
-        throw ButtplugException.FromError(response as Messages.Error);
+        throw ButtplugError.FromError(response as Messages.Error);
       default:
-        throw new ButtplugMessageException(
+        throw new ButtplugMessageError(
           `Message type ${response.constructor} not handled by sensorRead`
         );
     }
@@ -266,7 +266,7 @@ export class ButtplugClientDevice extends EventEmitter {
 
   public async battery(): Promise<number> {
     if (!this.hasBattery) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no Battery capabilities`
       );
     }
@@ -290,7 +290,7 @@ export class ButtplugClientDevice extends EventEmitter {
 
   public async rssi(): Promise<number> {
     if (!this.hasRssi) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no RSSI capabilities`
       );
     }
@@ -311,12 +311,12 @@ export class ButtplugClientDevice extends EventEmitter {
     timeout: number
   ): Promise<Uint8Array> {
     if (!this.messageAttributes.RawReadCmd) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw read capabilities`
       );
     }
     if (this.messageAttributes.RawReadCmd.Endpoints.indexOf(endpoint) === -1) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw readable endpoint ${endpoint}`
       );
     }
@@ -327,9 +327,9 @@ export class ButtplugClientDevice extends EventEmitter {
       case Messages.RawReading:
         return new Uint8Array((response as Messages.RawReading).Data);
       case Messages.Error:
-        throw ButtplugException.FromError(response as Messages.Error);
+        throw ButtplugError.FromError(response as Messages.Error);
       default:
-        throw new ButtplugMessageException(
+        throw new ButtplugMessageError(
           `Message type ${response.constructor} not handled by rawRead`
         );
     }
@@ -341,12 +341,12 @@ export class ButtplugClientDevice extends EventEmitter {
     writeWithResponse: boolean
   ): Promise<void> {
     if (!this.messageAttributes.RawWriteCmd) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw write capabilities`
       );
     }
     if (this.messageAttributes.RawWriteCmd.Endpoints.indexOf(endpoint) === -1) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw writable endpoint ${endpoint}`
       );
     }
@@ -357,14 +357,14 @@ export class ButtplugClientDevice extends EventEmitter {
 
   public async rawSubscribe(endpoint: string): Promise<void> {
     if (!this.messageAttributes.RawSubscribeCmd) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw subscribe capabilities`
       );
     }
     if (
       this.messageAttributes.RawSubscribeCmd.Endpoints.indexOf(endpoint) === -1
     ) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw subscribable endpoint ${endpoint}`
       );
     }
@@ -374,14 +374,14 @@ export class ButtplugClientDevice extends EventEmitter {
   public async rawUnsubscribe(endpoint: string): Promise<void> {
     // This reuses raw subscribe's info.
     if (!this.messageAttributes.RawSubscribeCmd) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw unsubscribe capabilities`
       );
     }
     if (
       this.messageAttributes.RawSubscribeCmd.Endpoints.indexOf(endpoint) === -1
     ) {
-      throw new ButtplugDeviceException(
+      throw new ButtplugDeviceError(
         `Device ${this.name} has no raw unsubscribable endpoint ${endpoint}`
       );
     }

package/src/client/Client.ts

@@ -14,10 +14,10 @@ import { ButtplugClientDevice } from './ButtplugClientDevice';
 import { IButtplugClientConnector } from './IButtplugClientConnector';
 import * as Messages from '../core/Messages';
 import {
-  ButtplugDeviceException,
-  ButtplugException,
-  ButtplugInitException,
-  ButtplugMessageException,
+  ButtplugDeviceError,
+  ButtplugError,
+  ButtplugInitError,
+  ButtplugMessageError,
 } from '../core/Exceptions';
 import { ButtplugClientConnectorException } from './ButtplugClientConnectorException';
 
@@ -96,8 +96,8 @@ export class ButtplugClient extends EventEmitter {
     this.checkConnector();
     const dev = this._devices.get(device.index);
     if (dev === undefined) {
-      throw ButtplugException.LogAndError(
-        ButtplugDeviceException,
+      throw ButtplugError.LogAndError(
+        ButtplugDeviceError,
         this._logger,
         `Device ${device.index} not available.`
       );
@@ -161,8 +161,8 @@ export class ButtplugClient extends EventEmitter {
         if (serverinfo.MessageVersion < Messages.MESSAGE_SPEC_VERSION) {
           // Disconnect and throw an exception explaining the version mismatch problem.
           await this._connector!.Disconnect();
-          throw ButtplugException.LogAndError(
-            ButtplugInitException,
+          throw ButtplugError.LogAndError(
+            ButtplugInitError,
             this._logger,
             `Server protocol version ${serverinfo.MessageVersion} is older than client protocol version ${Messages.MESSAGE_SPEC_VERSION}. Please update server.`
           );
@@ -188,8 +188,8 @@ export class ButtplugClient extends EventEmitter {
         // server has detected.
         await this._connector!.Disconnect();
         const err = msg as Messages.Error;
-        throw ButtplugException.LogAndError(
-          ButtplugInitException,
+        throw ButtplugError.LogAndError(
+          ButtplugInitError,
           this._logger,
           `Cannot connect to server. ${err.ErrorMessage}`
         );
@@ -250,10 +250,10 @@ export class ButtplugClient extends EventEmitter {
       case Messages.Ok:
         return;
       case Messages.Error:
-        throw ButtplugException.FromError(response as Messages.Error);
+        throw ButtplugError.FromError(response as Messages.Error);
       default:
-        throw ButtplugException.LogAndError(
-          ButtplugMessageException,
+        throw ButtplugError.LogAndError(
+          ButtplugMessageError,
           this._logger,
           `Message type ${response.constructor} not handled by SendMsgExpectOk`
         );

package/src/core/Exceptions.ts

@@ -9,12 +9,12 @@
 import * as Messages from './Messages';
 import { ButtplugLogger } from './Logging';
 
-export class ButtplugException extends Error {
+export class ButtplugError extends Error {
   public get ErrorClass(): Messages.ErrorClass {
     return this.errorClass;
   }
 
-  public get InnerException(): Error | undefined {
+  public get InnerError(): Error | undefined {
     return this.innerError;
   }
 
@@ -26,7 +26,7 @@ export class ButtplugException extends Error {
     return new Messages.Error(this.message, this.ErrorClass, this.Id);
   }
 
-  public static LogAndError<T extends ButtplugException>(
+  public static LogAndError<T extends ButtplugError>(
     constructor: new (str: string, num: number) => T,
     logger: ButtplugLogger,
     message: string,
@@ -39,15 +39,15 @@ export class ButtplugException extends Error {
   public static FromError(error: Messages.Error) {
     switch (error.ErrorCode) {
       case Messages.ErrorClass.ERROR_DEVICE:
-        return new ButtplugDeviceException(error.ErrorMessage, error.Id);
+        return new ButtplugDeviceError(error.ErrorMessage, error.Id);
       case Messages.ErrorClass.ERROR_INIT:
-        return new ButtplugInitException(error.ErrorMessage, error.Id);
+        return new ButtplugInitError(error.ErrorMessage, error.Id);
       case Messages.ErrorClass.ERROR_UNKNOWN:
-        return new ButtplugUnknownException(error.ErrorMessage, error.Id);
+        return new ButtplugUnknownError(error.ErrorMessage, error.Id);
       case Messages.ErrorClass.ERROR_PING:
-        return new ButtplugPingException(error.ErrorMessage, error.Id);
+        return new ButtplugPingError(error.ErrorMessage, error.Id);
       case Messages.ErrorClass.ERROR_MSG:
-        return new ButtplugMessageException(error.ErrorMessage, error.Id);
+        return new ButtplugMessageError(error.ErrorMessage, error.Id);
       default:
         throw new Error(`Message type ${error.ErrorCode} not handled`);
     }
@@ -70,31 +70,31 @@ export class ButtplugException extends Error {
   }
 }
 
-export class ButtplugInitException extends ButtplugException {
+export class ButtplugInitError extends ButtplugError {
   public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
     super(message, Messages.ErrorClass.ERROR_INIT, id);
   }
 }
 
-export class ButtplugDeviceException extends ButtplugException {
+export class ButtplugDeviceError extends ButtplugError {
   public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
     super(message, Messages.ErrorClass.ERROR_DEVICE, id);
   }
 }
 
-export class ButtplugMessageException extends ButtplugException {
+export class ButtplugMessageError extends ButtplugError {
   public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
     super(message, Messages.ErrorClass.ERROR_MSG, id);
   }
 }
 
-export class ButtplugPingException extends ButtplugException {
+export class ButtplugPingError extends ButtplugError {
   public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
     super(message, Messages.ErrorClass.ERROR_PING, id);
   }
 }
 
-export class ButtplugUnknownException extends ButtplugException {
+export class ButtplugUnknownError extends ButtplugError {
   public constructor(message: string, id: number = Messages.SYSTEM_MESSAGE_ID) {
     super(message, Messages.ErrorClass.ERROR_UNKNOWN, id);
   }

package/src/utils/ButtplugMessageSorter.ts

@@ -7,7 +7,7 @@
  */
 
 import * as Messages from '../core/Messages';
-import { ButtplugException } from '../core/Exceptions';
+import { ButtplugError } from '../core/Exceptions';
 
 export class ButtplugMessageSorter {
   protected _counter = 1;
@@ -51,7 +51,7 @@ export class ButtplugMessageSorter {
         // If we've gotten back an error, reject the related promise using a
         // ButtplugException derived type.
         if (x.Type === Messages.Error) {
-          rej(ButtplugException.FromError(x as Messages.Error));
+          rej(ButtplugError.FromError(x as Messages.Error));
           continue;
         }
         res(x);