Merge branch 'dev' of https://github.com/terminusdb/terminus-client into dev

Author: kevinchekovfeeney

.travis.yml

@@ -1,6 +1,6 @@
 before_script:
   - |
-    if [[  $TRAVIS_BRANCH == 'clientBuild' && $TRAVIS_COMMIT_MESSAGE == *"[run deploy]"*  ]]; then
+    if [[  $TRAVIS_BRANCH == 'master' && $TRAVIS_COMMIT_MESSAGE == *"[run deploy]"*  ]]; then
       echo "__INCREMENT_VERSION_NUMBER__"
       export PACKAGE_VERSION=$(npm version patch)
       npm install -g documentation
@@ -20,7 +20,8 @@ after_script:
 
 branches:
   only:
-    - clientBuild
+    - master
+    - dev
 
 before_deploy:
   - |
@@ -41,7 +42,7 @@ deploy:
     keep_history: true
     script: bash public_pages.sh
     on:
-      branch: clientBuild 
+      branch: master 
       condition: $TRAVIS_COMMIT_MESSAGE == *"[run deploy]"*
   - provider: releases
     target_commitish : $LAST_HASH
@@ -50,7 +51,7 @@ deploy:
     skip_cleanup: true
     overwrite: true
     on:
-      branch: clientBuild 
+      branch: master 
       condition: $TRAVIS_COMMIT_MESSAGE == *"[run deploy]"*  
   - provider: npm
     registry: "https://registry.npmjs.org/"
@@ -61,5 +62,5 @@ deploy:
     keep_history: true
     auth_method: "authToken"
     on:
-      branch : clientBuild
+      branch : master
       condition: $TRAVIS_COMMIT_MESSAGE == *"[run deploy]"*

lib/connectionConfig.js

@@ -84,7 +84,7 @@ ConnectionConfig.prototype.schemaURL = function () {
 
 /**
  * @param {String} inputStr - the URL of a Terminus DB base install or schema endpoint
- * @param {Object} [context] optional json-ld context 
+ * @param {Object} [context] optional json-ld context
  * sets the connection to point at the query api URL
  */
 ConnectionConfig.prototype.setQueryURL = function (inputStr, context) {
@@ -102,9 +102,11 @@ ConnectionConfig.prototype.queryURL = function () {
 	return `${this.dbURL()}/woql`;
 };
 
+
+
 /**
  * @param {String} inputStr - the URL of a Terminus DB base install or frame endpoint
- * @param {Object} [context] optional json-ld context 
+ * @param {Object} [context] optional json-ld context
  * sets the connection to point at the class frame api URL
  */
 ConnectionConfig.prototype.setClassFrameURL = function (inputStr, context) {
@@ -124,7 +126,7 @@ ConnectionConfig.prototype.frameURL = function () {
 
 /**
  * @param {String} inputStr - the URL of a Terminus DB base install or document endpoint
- * @param {Object} [context] optional json-ld context 
+ * @param {Object} [context] optional json-ld context
  * sets the connection to point at the document api URL
  */
 ConnectionConfig.prototype.setDocument = function (inputStr, context) {

lib/const.js

@@ -11,6 +11,7 @@ module.exports = Object.freeze({
 	UPDATE_DOCUMENT: 'update_document',
 	CLASS_FRAME: 'class_frame',
 	WOQL_SELECT: 'woql_select',
+    TERMINUS_MESSAGE: 'terminus_message',
 	GET_DOCUMENT: 'get_document',
 	DELETE_DATABASE: 'delete_database',
 	DELETE_DOCUMENT: 'delete_document',

lib/dispatchRequest.js

@@ -6,7 +6,7 @@ const ErrorMessage = require('./errorMessage');
 
 
 /**
- * base 64 encodes a string using either the btoa implementation if available or the Buffer object. 
+ * base 64 encodes a string using either the btoa implementation if available or the Buffer object.
  * @param {String} str string to be base 64 encoded
  */
 function btoaImplementation(str) {
@@ -21,7 +21,7 @@ function btoaImplementation(str) {
 /**
  * @file Dispatch Request
  * @license Apache Version 2
- * @description Functions for dispatching API requests via the axios library. 
+ * @description Functions for dispatching API requests via the axios library.
  * @param {String} url  API endpoint URL
  * @param {String} action API action
  * @param {Object} payload data to be transmitted to endpoint
@@ -59,6 +59,7 @@ function DispatchRequest(url, action, payload) {
 	case CONST.UPDATE_SCHEMA:
 	case CONST.CREATE_DOCUMENT:
 	case CONST.UPDATE_DOCUMENT:
+	case CONST.TERMINUS_MESSAGE:
 	case CONST.WOQL_UPDATE:
 		options.headers = options.headers ? options.headers : {};
 		options.headers['Content-Type'] = 'application/json';
@@ -86,7 +87,7 @@ function DispatchRequest(url, action, payload) {
 				if(err.response && err.response.data){
 					e.data = err.response.data;
 				}
-				throw e; 
+				throw e;
 			});
 	}
 }

lib/viewer/graphConfig.js

@@ -73,17 +73,29 @@ WOQLGraphConfig.prototype.selected_grows = function(v){
 	return this.bigsel;
 }
 
-WOQLGraphConfig.prototype.width = function(v){
-	if(typeof v != "undefined"){
-		this.gwidth = v;
+/**
+ * no parameter get the graph width or
+ * set the graph width and return the WOQLGraphConfig
+ * @param {size} Number
+ */
+
+WOQLGraphConfig.prototype.width = function(size){
+	if(typeof size != "undefined"){
+		this.gwidth = size;
 		return this;
 	}
 	return this.gwidth;
 }
 
-WOQLGraphConfig.prototype.height = function(v){
-	if(typeof v != "undefined"){
-		this.gheight = v;
+/**
+ * no parameter get the graph height or
+ * set the graph height and return the WOQLGraphConfig
+ * @param {size} Number
+ */
+
+WOQLGraphConfig.prototype.height = function(size){
+	if(typeof size != "undefined"){
+		this.gheight = size;
 		return this;
 	}
 	return this.gheight;

lib/woql.js

@@ -219,7 +219,7 @@ WOQL.with = function(graph, source, query){	return new WOQLQuery().with(graph, s
  * @param {string} vari - Target
  * @return {object} WOQLQuery
  */
-WOQL.as = function(map, vari){	return new WOQLQuery().as(map, vari); }
+WOQL.as = function(map, vari, ty){	return new WOQLQuery().as(map, vari, ty); }
 
 /**
  * Provides details of a remote data source in a JSON format that includes a URL property
@@ -1529,7 +1529,7 @@ WOQLQuery.prototype.boxDatatype = function(datatype, label, descr, graph, prefix
 }
 
 
-WOQLQuery.prototype.as = function(a, b){
+WOQLQuery.prototype.as = function(a, b, c){
 	if(!a) return;
 	if(!this.asArray){
 		this.asArray = true;
@@ -1538,7 +1538,12 @@ WOQLQuery.prototype.as = function(a, b){
 	if(b){
 		b = (b.indexOf(":") == -1 ? "v:" + b : b);
 		var val = (typeof a == "object" ? a : { "@value" : a});
-		this.query.push({as: [val, b]});
+
+        if(c){
+		    this.query.push({as: [val, b, c]});
+        }else{
+            this.query.push({as: [val, b]});
+        }
 	}
 	else {
 		a = (a.indexOf(":") == -1 ? "v:" + a : a);

lib/woqlClient.js

@@ -13,7 +13,7 @@ const UTILS = require('./utils.js');
  * Simple Javascript Client for accessing the Terminus DB API
  * Constructor - takes an option json list of connection parameters
  * @param {Object} params a json object containing connection parameters
- * which can be: 
+ * which can be:
  * params.server URL of server to connect to
  * params.dbid ID of database to connect to
  * params.docid = ID of document to load;
@@ -319,12 +319,31 @@ WOQLClient.prototype.update = function (qurl, woql, opts) {
 		);
 	}
 	const fileList = opts ? opts.fileList : {};
+
+	//var formData = new FormData();
+    //formData.set('file', file);
+	
 	let q = {'terminus:query' : JSON.stringify(woql), ...fileList};
 
 	q = this.addOptionsToWOQL(q, opts);
 	return this.dispatch(this.connectionConfig.queryURL(),  CONST.WOQL_UPDATE, q);
 };
 
+/**
+ * Executes a WOQL query on the server which keeps log of messages
+ *
+ * the first argument (payload) will include the message 
+ * the third argument (opts) is an options json - opts.key is an optional API key
+ */
+WOQLClient.prototype.serverLog = function (payload, opts) {
+	let endpoint = this.connectionConfig.server + "message";
+	let q = {'@type' : "terminus:APIUpdate", "terminus:message" : payload};
+
+	q = this.addOptionsToWOQL(q, opts);
+	return this.dispatch(endpoint,  CONST.TERMINUS_MESSAGE, q);
+};
+
+
 /**
  * Retrieves a WOQL query on the specified database which updates the state and returns the results
  *
@@ -351,7 +370,7 @@ WOQLClient.prototype.getClassFrame = function (cfurl, cls, opts) {
 
  /**
   * Adds a key to the passed woql query if it is present in the opts json
-  * 
+  *
   */
 WOQLClient.prototype.addOptionsToWOQL = function (woql, opts) {
 	if (opts && opts.key) {
@@ -368,7 +387,7 @@ WOQLClient.prototype.addOptionsToDocument = function (doc, opts) {
 	const pdoc = {};
 	pdoc['@context'] = doc['@context'];
 	// add blank node prefix as document base url
-	if (pdoc['@context'] && doc['@id']) { 
+	if (pdoc['@context'] && doc['@id']) {
 		pdoc['@context']._ = `${doc['@id']}/`;
 	}
 	if (opts && opts['terminus:encoding'] && opts['terminus:encoding'] === 'terminus:turtle') {
@@ -407,7 +426,7 @@ WOQLClient.prototype.addKeyToPayload = function (payload, url) {
 
 /**
  * Document updates include the URL in both the endpoint and the document itself
- * This ensures that they are the same by using the endpoint URL as the authoritative version 
+ * This ensures that they are the same by using the endpoint URL as the authoritative version
  * and copying it into the embedded document ID
  */
 WOQLClient.prototype.makeDocumentConsistentWithURL = function (doc, dburl) {
@@ -429,7 +448,7 @@ WOQLClient.prototype.dispatch = function (url, action, payload) {
 };
 
 /**
- * If the use_fetch switch is set, the browser's built in fetch will be used rather than the npm axios module 
+ * If the use_fetch switch is set, the browser's built in fetch will be used rather than the npm axios module
  */
 WOQLClient.prototype.dispatchFetch = function (url, action, payload) {
 	const api = {

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminus-client",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "TerminusDB client library",
   "main": "index.js",
   "directories": {

package.json

@@ -347,6 +347,21 @@ describe('woql queries', function () {
 
   })
 
+  it('check the join method',function(){
+
+    const woqlObject=WOQL.join(["v:A_obj", "v:B_obj"], ", ", "v:output");
+    const jsonObj={
+                    'join': [
+                      [ 'v:A_obj', 'v:B_obj' ],
+                      { '@value': ', ', '@type': 'xsd:string' },
+                      'v:output'
+                    ]
+                  };
+
+    expect(woqlObject.json()).to.eql(jsonObj);
+
+  })
+
   it('check the split method',function(){
 
     const woqlObject=WOQL.split("A, B, C", ", ", "v:list_obj");