Single return + publish dist folder on npm

Author: emiax

.gitignore

@@ -1 +1 @@
-node_modules/
+node_modules/

.npmignore

@@ -1,3 +1,2 @@
-dist
 docs
 examples

dist/openspace-api.js

@@ -22,7 +22,7 @@ api.onConnect(async () => {
 
   let openspace = {};
   try {
-    openspace = await api.library();
+    openspace = await api.singleReturnLibrary();
   } catch (e) {
     console.log('OpenSpace library could not be loaded: Error: \n', e)
     return;
@@ -61,7 +61,7 @@ async function getScaleUpdates() {
 async function getTime(openspace) {
   try {
     const t = await openspace.time.UTC();
-    console.log("Current simulation time: " + t[1]);
+    console.log("Current simulation time: " + t);
   } catch (e) {
     console.log('failed to get time. Error: \n', e);
   }

examples/example.js

@@ -1,6 +1,6 @@
 {
   "name": "openspace-api-js",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "OpenSpace Socket/Websocket API bindings for JavaScript",
   "main": "src/node.js",
   "browser": {

package-lock.json

@@ -64,6 +64,10 @@ class OpenSpaceApi {
    * @return {Topic} - An object representing the topic.
    */
   startTopic(type, payload) {
+    if (typeof type !== 'string') {
+      throw("Topic type must be a string")
+    }
+
     const topic = this._nextTopicId++;
     const messageObject = {
         topic,
@@ -129,7 +133,10 @@ class OpenSpaceApi {
    * @param {*} value - The value to set the property to.
    */
   setProperty(property, value) {
-     const topic = this.startTopic('set', {
+    if (typeof property !== 'string') {
+      throw("Property must be a valid uri string")
+    }
+    const topic = this.startTopic('set', {
        property,
        value
      });
@@ -142,6 +149,9 @@ class OpenSpaceApi {
    * @return {*} The value of the property.
    */
   async getProperty(property) {
+    if (typeof property !== 'string') {
+      throw("Property must be a valid uri string")
+    }
     const topic = this.startTopic('get', {
       property,
     });
@@ -182,6 +192,9 @@ class OpenSpaceApi {
    *         When cancelled, this object will unsubscribe to the property.
    */
   subscribeToProperty(property) {
+    if (typeof property !== 'string') {
+      throw("Property must be a valid uri string")
+    }
     const topic = this.startTopic('subscribe', {
       event: 'start_subscription',
       property
@@ -202,10 +215,13 @@ class OpenSpaceApi {
   /**
    * Execute a lua script
    * @param {string} script - The lua script to execute.
-   * @param {string} getReturnValue - Specified whether the return value should be collected.
+   * @param {bool} getReturnValue - Specified whether the return value should be collected.
    * @return {*} The return value of the script, if `getReturnValue` is true, otherwise undefined.
    */
   async executeLuaScript(script, getReturnValue = true) {
+    if (typeof script !== 'string') {
+      throw("Script must be a string")
+    }
     const topic = this.startTopic('luascript', {
       script,
       return: getReturnValue
@@ -231,6 +247,9 @@ class OpenSpaceApi {
    * @return {*} The return value of the script, if `getReturnValue` is true, otherwise undefined.
    */
   async executeLuaFunction(fun, args, getReturnValue = true) {
+    if (typeof fun !== 'string') {
+      throw("Function must be a string")
+    }
     const topic = this.startTopic('luascript', {
       function: fun,
       arguments: args,
@@ -252,10 +271,16 @@ class OpenSpaceApi {
 
   /**
    * Get an object representing the OpenSpace lua library.
+   * @param {bool} multiReturn - whether the library should return the raw lua tables.
+   *   If this value is true, the 1-indexed lua table will be returned as a JavaScript object.
+   *   if the value is false, the only the first return value will be returned
    * @return {Object} The lua library, mapped to async JavaScript functions.
    */
-  async library() {
-    const generateAsyncFunction = (functionName) => {
+  async library(multiReturn) {
+    if (multiReturn === undefined) {
+      multiReturn = true;
+    }
+    const generateAsyncMultiRetFunction = functionName => {
       return async (...args) => {
         try {
           return await this.executeLuaFunction(functionName, args);
@@ -265,6 +290,17 @@ class OpenSpaceApi {
       }
     };
 
+    const generateAsyncSingleRetFunction = functionName => {
+      return async (...args) => {
+        try {
+          const luaTable = await this.executeLuaFunction(functionName, args);
+          return luaTable[1];
+        } catch (e) {
+          throw "Lua execution error: \n" + e
+        }
+      }
+    };
+
     let documentation;
     try {
       documentation = await this.getDocumentation('lua');
@@ -273,26 +309,47 @@ class OpenSpaceApi {
     }
     const jsLibrary = {};
 
-    documentation.forEach((lib) => {
+    documentation.forEach(lib => {
       let subJsLibrary = undefined;
       if (lib.library === '') {
         subJsLibrary = jsLibrary;
       } else {
         subJsLibrary = jsLibrary[lib.library] = {};
       }
 
-      lib.functions.forEach((f) => {
+      lib.functions.forEach(f => {
         const fullFunctionName =
           'openspace.' +
           (subJsLibrary === jsLibrary ? '' : (lib.library + '.')) +
           f.name;
 
-        subJsLibrary[f.name] = generateAsyncFunction(fullFunctionName);
+        subJsLibrary[f.name] = multiReturn ?
+          generateAsyncMultiRetFunction(fullFunctionName) :
+          generateAsyncSingleRetFunction(fullFunctionName);
       });
     });
 
     return jsLibrary;
   }
+
+  /**
+   * Get an object representing the OpenSpace lua library.
+   * @return {Object} The lua library, mapped to async JavaScript functions.
+   * This method only returns the first return value.
+   */
+  async singleReturnLibrary() {
+    return await this.library(true);
+  }
+
+  /**
+   * Get an object representing the OpenSpace lua library.
+   * @return {Object} The lua library, mapped to async JavaScript functions.
+   * The values returned by the async functions will be the entire lua tables,
+   * with 1-indexed values.
+   */
+  async multiReturnLibrary() {
+    return await this.library(false);
+  }
 }
 
 module.exports = OpenSpaceApi;