adding end oint for logging messages

Author: KittyJose

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/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;
@@ -326,6 +326,21 @@ WOQLClient.prototype.update = function (qurl, woql, opts) {
 	return this.dispatch(this.connectionConfig.queryURL(),  CONST.WOQL_SELECT, 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
  *
@@ -352,7 +367,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) {
@@ -369,7 +384,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') {
@@ -408,7 +423,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) {
@@ -430,7 +445,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 = {