Merge branch 'canary' into rc

Author: rrooij

lib/const.js

@@ -38,5 +38,6 @@ module.exports = Object.freeze({
     GET_CSV: 'get_csv',
     UPDATE_CSV: 'update_csv',
     DELETE_CSV: 'delete_csv',
-    MESSAGE: 'message'
+    MESSAGE: 'message',
+    INFO: 'info'
 })

lib/dispatchRequest.js

@@ -86,6 +86,7 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null) {
         case CONST.READ_ORGANIZATION:
         case CONST.CONNECT:
         case CONST.GET_CSV:
+        case CONST.INFO:
             if (payload) {
                 const ext = UTILS.URIEncodePayload(payload)
                 if (ext) url += `?${ext}`

lib/woqlClient.js

@@ -394,17 +394,17 @@ WOQLClient.prototype.insertTriples = function(gtype, gid, turtle, commit_msg) {
 }
 
 /**
- * Inserts a csv into the specified path
+ * Inserts a csv from a specified path
  *
- * @param {array} csv_path is an array of csv file names
- * @param {string} commitMsg Textual message describing the reason for the update
+ * @param {array} csv_path is an array of csv file names with file path
+ * @param {string} commit_msg Textual message describing the reason for the update
  * @param {string} gtype type of graph  |instance|schema|inference|
  * @param {string} gid TerminusDB Graph ID to update, main is the default value
  * @return {Promise} An API success message
  */
-WOQLClient.prototype.insertCSV = function(csv_path, commitMsg, gtype, gid) {
-    if (commitMsg && csv_path) {
-        let commit = this.generateCommitInfo(commitMsg)
+WOQLClient.prototype.insertCSV = function(csv_path, commit_msg, gtype, gid) {
+    if (commit_msg && csv_path) {
+        let commit = this.generateCommitInfo(commit_msg)
         const formData = new FormData();
         csv_path.map((item)=>{
             if(typeof(item.name)=="string"){
@@ -429,17 +429,17 @@ WOQLClient.prototype.insertCSV = function(csv_path, commitMsg, gtype, gid) {
  * Updates the contents of the specified path with a csv, creating the appropriate
  * diff object as the commit.
  *
- * @param {array} csvPaths Array csvs to upload
- * @param {string} commitMsg Textual message describing the reason for the update
+ * @param {array} csv_path Array csvs to upload
+ * @param {string} commit_msg Textual message describing the reason for the update
  * @param {string} gtype type of graph  |instance|schema|inference|
  * @param {string} gid TerminusDB Graph ID to update, main is the default value
  * @return {Promise} An API success message
  */
-WOQLClient.prototype.updateCSV = function(csv, commitMsg, gtype, gid) {
-    if (commitMsg && csv) {
-        let commit = this.generateCommitInfo(commitMsg)
+WOQLClient.prototype.updateCSV = function(csv_path, commit_msg, gtype, gid) {
+    if (commit_msg && csv_path) {
+        let commit = this.generateCommitInfo(commit_msg)
         const formData = new FormData();
-        csv.map((item)=>{
+        csv_path.map((item)=>{
             formData.append(item.fileToBeUpdated, item.updateWith)
         })
         formData.append('payload', JSON.stringify(commit))
@@ -454,23 +454,22 @@ WOQLClient.prototype.updateCSV = function(csv, commitMsg, gtype, gid) {
 /**
  * Retrieves the contents of the specified graph as a CSV
  *
- * @param {string} csvName Name of csv to dump from the specified database to extract
- * @param {string} csvDirectory CSV output directory path. (defaults to current directory).
+ * @param {string} csv_name Name of csv to dump from the specified database to extract
  * @param {string} download flag to download csv file
  * @param {string} gtype Type of graph (instance|schema|inference)
  * @param {string} gid identifier.
  * @return {Promise} An API success message
  *
  */
-WOQLClient.prototype.getCSV = function(csvName, download, gtype, gid) {
+WOQLClient.prototype.getCSV = function(csv_name, download, gtype, gid) {
     let options = {}, filePath
-    options.name=csvName;
+    options.name=csv_name;
     return this.dispatch(CONST.GET_CSV, this.connectionConfig.csvURL(gtype, gid), options).then(results => {
             if (download) {
                 const url=window.URL.createObjectURL(new Blob([results]));
                 const link=document.createElement('a');
                 link.href = url;
-                link.setAttribute('download', csvName);
+                link.setAttribute('download', csv_name);
                 document.body.appendChild(link);
                 link.click();
             }
@@ -481,17 +480,15 @@ WOQLClient.prototype.getCSV = function(csvName, download, gtype, gid) {
 /**
  * Deletes a csv into the specified path
  *
- * @param {array} csvName is an array of csv file names
- * @param {string} commitMsg Textual message describing the reason for the delete
- * @param {string} gtype type of graph  |instance|schema|inference|
- * @param {string} gid TerminusDB Graph ID to update, main is the default value
+ * @param {array} csv_name is an array of csv file names
+ * @param {string} commit_msg Textual message describing the reason for the delete
  * @return {Promise} An API success message
  */
- WOQLClient.prototype.deleteCSV = function(csvName, commitMsg, gtype, gid) {
-    if (commitMsg && csvName) {
-        let commit = this.generateCommitInfo(commitMsg)
+ WOQLClient.prototype.deleteCSV = function(csv_name, commit_msg) {
+    if (commit_msg && csv_name) {
+        let commit = this.generateCommitInfo(commit_msg)
         let options = {}, filePath
-        options.name=csvName;
+        options.name=csv_name;
         options.commit_info=commit.commit_info
         return this.dispatch(CONST.DELETE_CSV, this.connectionConfig.csvURL(), options).then(results => {
             return results;
@@ -510,6 +507,17 @@ WOQLClient.prototype.message = function(message) {
     })
 }
 
+/**
+ * gets terminusdb server info
+ * @param {string} msg - textual string
+ */
+WOQLClient.prototype.info = function() {
+    const url = this.api() + 'info'
+    return this.dispatch(CONST.INFO, url).then(response => {
+        return response
+    })
+}
+
 
 /**
  * Executes a WOQL query on the specified database and returns the results

package.json

@@ -19,10 +19,10 @@
   "author": "kevin@terminusdb.com",
   "license": "Apache-2.0",
   "dependencies": {
-    "axios": "^0.19.2",
-    "documentation": "^13.0.2"
+    "axios": "^0.19.2"
   },
   "devDependencies": {
+    "documentation": "^13.0.2",
     "@babel/core": "^7.8.4",
     "@babel/preset-env": "^7.8.4",
     "@babel/register": "^7.8.3",