chore: rename FromJSON to fromJSON

Author: qdot

js/src/core/MessageUtils.ts

@@ -21,7 +21,7 @@ function getMessageClass(
   return null;
 }
 
-export function FromJSON(str): Messages.ButtplugMessage[] {
+export function fromJSON(str): Messages.ButtplugMessage[] {
   const msgarray: object[] = JSON.parse(str);
   const msgs: Messages.ButtplugMessage[] = [];
   for (const x of Array.from(msgarray)) {

js/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;
@@ -78,15 +78,15 @@ export class ButtplugBrowserWebsocketConnector extends EventEmitter {
 
   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);
+    const msgs = fromJSON((event.target as FileReader).result);
     this.emit('message', msgs);
   }
 }

js/tests/test-messages.ts

@@ -1,6 +1,6 @@
 import * as Messages from "../src/core/Messages";
 import { ButtplugClient } from "../src/client/Client";
-import { FromJSON } from "../src/core/MessageUtils";
+import { fromJSON } from "../src/core/MessageUtils";
 import { SetupTestSuite } from "./utils";
 import { ScalarSubcommand, VectorSubcommand, RotateSubcommand } from "../src/core/Messages";
 
@@ -15,7 +15,7 @@ describe("Message", () => {
   it("Converts ok message from json correctly",
      () => {
        const jsonStr = '[{"Ok":{"Id":2}}]';
-       expect(FromJSON(jsonStr)).toEqual([new Messages.Ok(2)]);
+       expect(fromJSON(jsonStr)).toEqual([new Messages.Ok(2)]);
      });
   it("Converts DeviceList message from json correctly",
      () => {
@@ -64,7 +64,7 @@ describe("Message", () => {
         }
       ]       
        `;
-       expect(FromJSON(jsonStr))
+       expect(fromJSON(jsonStr))
         .toEqual(
             [
               new Messages.DeviceList(
@@ -121,7 +121,7 @@ describe("Message", () => {
           }
         }
       ]`;
-      expect(FromJSON(jsonStr)[0] as Messages.DeviceAdded)
+      expect(fromJSON(jsonStr)[0] as Messages.DeviceAdded)
       .toEqual(
             new Messages.DeviceAdded({
               DeviceIndex: 0, 
@@ -139,15 +139,15 @@ describe("Message", () => {
   it("Converts Error message from json correctly",
      () => {
        const jsonStr = '[{"Error":{"Id":2,"ErrorCode":3,"ErrorMessage":"TestError"}}]';
-       expect(FromJSON(jsonStr)).toEqual([new Messages.Error("TestError",
+       expect(fromJSON(jsonStr)).toEqual([new Messages.Error("TestError",
                                                              Messages.ErrorClass.ERROR_MSG,
                                                              2)]);
      });
      /*
   it("Handles Device Commands with Subcommand arrays correctly",
      () => {
        const jsonStr = '[{"VibrateCmd":{"Id":2, "DeviceIndex": 3, "Speeds": [{ "Index": 0, "Speed": 1.0}, {"Index": 1, "Speed": 0.5}]}}]';
-       expect(FromJSON(jsonStr)).toEqual([new Messages.VibrateCmd([{Index: 0, Speed: 1.0}, {Index: 1, Speed: 0.5}], 3, 2)]);
+       expect(fromJSON(jsonStr)).toEqual([new Messages.VibrateCmd([{Index: 0, Speed: 1.0}, {Index: 1, Speed: 0.5}], 3, 2)]);
      });
      */
 });

js/tests/test-websocketclient.ts

@@ -2,7 +2,7 @@ import { Server, WebSocket, Client } from "mock-socket";
 import { ButtplugClient } from "../src/client/Client";
 import * as Messages from "../src/core/Messages";
 import { ButtplugLogLevel } from "../src/core/Logging";
-import { FromJSON } from "../src/core/MessageUtils";
+import { fromJSON } from "../src/core/MessageUtils";
 import { SetupTestSuite } from "./utils";
 import { ButtplugMessageError, ButtplugBrowserWebsocketClientConnector } from "../src";
 
@@ -27,7 +27,7 @@ describe("Websocket Client Tests", () => {
     mockServer = new Server("ws://localhost:6868");
     p = new Promise((resolve, reject) => { res = resolve; rej = reject; });
     const serverInfo = (jsonmsg: string) => {
-      const msg: Messages.ButtplugMessage = FromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
+      const msg: Messages.ButtplugMessage = fromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
       if (msg.Type === Messages.RequestServerInfo) {
         delaySend(new Messages.ServerInfo(3, 0, "Test Server", msg.Id));
       }
@@ -57,7 +57,7 @@ describe("Websocket Client Tests", () => {
 
   it("Should deal with request/reply correctly", async () => {
     (socket as any).on("message", (jsonmsg: string) => {
-      const msg: Messages.ButtplugMessage = FromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
+      const msg: Messages.ButtplugMessage = fromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
       delaySend(new Messages.Ok(msg.Id));
     });
     await bp.startScanning();
@@ -72,7 +72,7 @@ describe("Websocket Client Tests", () => {
 
   it("Should throw Error on return of error message", async () => {
     (socket as any).on("message", (jsonmsg: string) => {
-      const msg: Messages.ButtplugMessage = FromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
+      const msg: Messages.ButtplugMessage = fromJSON(jsonmsg)[0] as Messages.ButtplugMessage;
       if (msg.Type === Messages.StopAllDevices) {
         delaySend(new Messages.Error("Error", Messages.ErrorClass.ERROR_MSG, msg.Id));
       }

wasm/src/index.ts

@@ -1,4 +1,4 @@
-import { ButtplugMessage, IButtplugClientConnector, FromJSON } from 'buttplug';
+import { ButtplugMessage, IButtplugClientConnector, fromJSON } from 'buttplug';
 import { EventEmitter } from 'eventemitter3';
 
 export class ButtplugWasmClientConnector extends EventEmitter implements IButtplugClientConnector {
@@ -37,8 +37,7 @@ export class ButtplugWasmClientConnector extends EventEmitter implements IButtpl
     //ButtplugWasmClientConnector.wasmInstance.buttplug_activate_env_logger('debug');
     console.log(ButtplugWasmClientConnector.wasmInstance.buttplug_create_embedded_wasm_server);    
     this.client = ButtplugWasmClientConnector.wasmInstance.buttplug_create_embedded_wasm_server((msgs) => {
-      let str = new TextDecoder().decode(msgs);
-      this.emit('message', FromJSON(str));
+      this.emitMessage(msgs);
     }, this.serverPtr);
     this._connected = true;
   };
@@ -48,8 +47,13 @@ export class ButtplugWasmClientConnector extends EventEmitter implements IButtpl
   public send = (msg: ButtplugMessage): void => {
     console.log(msg);
     ButtplugWasmClientConnector.wasmInstance.buttplug_client_send_json_message(this.client, new TextEncoder().encode('[' + msg.toJSON() + ']'), (output) => {
-      let str = new TextDecoder().decode(output);
-      this.emit('message', FromJSON(str));
+      this.emitMessage(output);
     });
   };
+
+  private emitMessage = (msg: Uint8Array) => {
+    let str = new TextDecoder().decode(output);
+    // This needs to use buttplug-js's fromJSON, otherwise we won't resolve the message name correctly.
+    this.emit('message', fromJSON(str));
+  }
 }