to be fix test

Author: Francesca-Bit

dist/terminus-client.min.js

@@ -1,11 +1,18 @@
-'use strict';
 module.exports = {
 				 WOQLClient:require('./lib/woqlClient'),
-                  ConnectionCapabilities:require('./lib/connectionCapabilities'),
-                  ConnectionConfig:require('./lib/connectionConfig'),
-                  IDParser:require('./lib/terminusIDParser'),
-                  ErrorMessage:require('./lib/errorMessage'),
-                  FrameHelper:require('./lib/frameHelper'),
-                  ObjectFrame:require('./lib/objectFrame'),
-                  WOQLResult:require('./lib/woqlResult'),
-                  WOQL:require('./lib/woql')};
+                 ConnectionCapabilities:require('./lib/connectionCapabilities'),
+                 ConnectionConfig:require('./lib/connectionConfig'),
+                 IDParser:require('./lib/terminusIDParser'),
+                 ErrorMessage:require('./lib/errorMessage'),
+                 UTILS:require('./lib/utils'),
+                 WOQLResult:require('./lib/woqlResult'),
+                 WOQLRule:require('./lib/woqlRule'),
+                 FrameRule:require('./lib/frameRule'),
+                 View:require('./lib/woqlView'),
+                 DocumentFrame:require('./lib/viewer/documentFrame'),
+                 WOQLGraph:require('./lib/viewer/woqlGraph'),
+                 WOQLTable:require('./lib/viewer/woqlTable'),
+                 WOQLChooser:require('./lib/viewer/woqlChooser'),
+                 WOQLChart:require('./lib/viewer/woqlChart'),
+                 WOQLStream:require('./lib/viewer/woqlStream'),
+                 WOQL:require('./lib/woql')};

dist/terminus-client.min.js.map

@@ -0,0 +1 @@
+{}

index.js

@@ -1,16 +1,20 @@
-const UTILS = require('./utils.js');
-const CONST = require('./const.js');
-const ErrorMessage = require('./errorMessage');
-/*
+/**
+ * @file Connection Capabilities
+ * @license Apache Version 2
+ * @summary Object which helps manage the capabilities available for a given TerminusDB connection
  * Creates an entry in the connection registry for the server
  * and all the databases that the client has access to
  * maps the input authorties to a per-db array for internal storage and easy
  * access control checks
- * {doc:dbid => {terminus:authority =>
- * [terminus:woql_select, terminus:create_document, auth3, ...]}}
- *
  */
+const CONST = require('./const.js');
+const ErrorMessage = require('./errorMessage');
 
+/**
+ * @constructor 
+ * @param {connectionConfig} connectionConfig connectionConfig object containing the connection parameters 
+ * @param {String} key API key
+ */
 function ConnectionCapabilities(connectionConfig, key) {
 	this.connection = {};
 	this.connectionConfig = connectionConfig;
@@ -19,6 +23,10 @@ function ConnectionCapabilities(connectionConfig, key) {
 	}
 }
 
+/**
+ * @summary Retrieves the API key for the given TerminusDB Server
+ * @param {String} serverURL optional - URL of TerminusDB - if ommited the current server URL is used
+ */
 ConnectionCapabilities.prototype.getClientKey = function (serverURL) {
 	if (!serverURL) serverURL = this.connectionConfig.serverURL();
 	if (serverURL && this.connection[serverURL]) return this.connection[serverURL].key;
@@ -29,6 +37,12 @@ ConnectionCapabilities.prototype.getClientKey = function (serverURL) {
 /*
  * Utility functions for changing the state of connections with Terminus servers
  */
+
+/**
+ * @summary sets the api key for the given url
+ * @param {String} curl a valid terminusDB server URL
+ * @param {String} key an optional API key
+ */
 ConnectionCapabilities.prototype.setClientKey = function (curl, key) {
 	if (typeof key === 'string' && key.trim()) {
 		if (typeof this.connection[curl] === 'undefined') {
@@ -40,8 +54,8 @@ ConnectionCapabilities.prototype.setClientKey = function (curl, key) {
 
 
 /**
- * @params {string} curl a valid terminusDB server URL
- * @params {object} capabilities it is the connect call response
+ * @param {string} curl a valid terminusDB server URL
+ * @param {object} capabilities the JSON object returned by the connect API call 
  */
 ConnectionCapabilities.prototype.addConnection = function (curl, capabilities) {
 	if (typeof this.connection[curl] === 'undefined') {
@@ -59,9 +73,8 @@ ConnectionCapabilities.prototype.addConnection = function (curl, capabilities) {
 	        let scope = auths[i]['terminus:authority_scope'];
 	        const actions = auths[i]['terminus:action'];
 
-	        if (Array.isArray(scope) === false) scope = [scope];
-	        const actionsArr = UTILS.authorityActionsToArr(actions);
-
+			if (Array.isArray(scope) === false) scope = [scope];
+			const actionsArr = ((Array.isArray(actions)) ? actions.map(item => item['@id']) : [] );
 	        for (let j = 0; j < scope.length; j += 1) {
 	          const nrec = scope[j];
 	          if (typeof this.connection[curl][nrec['@id']] === 'undefined') {
@@ -76,34 +89,20 @@ ConnectionCapabilities.prototype.addConnection = function (curl, capabilities) {
 	}
 };
 
+/**
+ * @summary returns true if the client is currently connected to a server
+ * @returns {Boolean}
+ */
 ConnectionCapabilities.prototype.serverConnected = function () {
 	return typeof this.connection[this.connectionConfig.server] !== 'undefined';
 };
 
-ConnectionCapabilities.prototype.capabilitiesPermit = function (action, dbid, server) {
-	if (!this.connectionConfig.connectionMode()
-         || this.connectionConfig.client_checks_capabilities !== true
-         || action === CONST.CONNECT) { return true; }
-
-	server = server || this.connectionConfig.server;
-	dbid = dbid || this.connectionConfig.dbid;
-
-	let rec;
-
-	if (action === CONST.CREATE_DATABASE) {
-		rec = this.getServerRecord(server);
-	} else if (dbid) rec = this.getDBRecord(dbid);
-	else console.log('no dbid', server, dbid);
-	if (rec) {
-		const auths = rec['terminus:authority'];
-		if (auths && auths.indexOf(`terminus:${action}`) !== -1) return true;
-	} else {
-		console.log('problem with ', this.connection, action, server, dbid);
-	}
-	this.error = ErrorMessage.accessDenied(action, dbid, server);
-	return false;
-};
 
+/**
+ * @summary retrieves the meta-data record returned by connect for a particular server
+ * @param {String} [srvr] optional server URL - if omitted current connection config will be used
+ * @returns {terminus:Server} JSON server record as returned by WOQLClient.connect
+ */
 ConnectionCapabilities.prototype.getServerRecord = function (srvr) {
 	const url = (srvr || this.connectionConfig.server);
 	const connectionObj = this.connection[url] || {};
@@ -117,6 +116,12 @@ ConnectionCapabilities.prototype.getServerRecord = function (srvr) {
 	return false;
 };
 
+/**
+ * @summary retrieves the meta-data record returned by connect for a particular database
+ * @param {String} [dbid] optional database id - if omitted current connection config db will be used
+ * @param {String} [srvr] optional server URL - if omitted current connection config server will be used
+ * @returns {terminus:Database} terminus:Database JSON document as returned by WOQLClient.connect
+ */
 ConnectionCapabilities.prototype.getDBRecord = function (dbid, srvr) {
 	const url = (srvr || this.connectionConfig.server);
 	dbid = (dbid || this.connectionConfig.dbid);
@@ -132,6 +137,11 @@ ConnectionCapabilities.prototype.getDBRecord = function (dbid, srvr) {
 	return undefined;
 };
 
+/**
+ * @summary retrieves all the db meta-data records returned by connect for a particular server
+ * @param {String} [srvr] optional server URL - if omitted current connection config server will be used
+ * @returns {[terminus:Database]} array of terminus:Database JSON documents as returned by WOQLClient.connect
+ */
 ConnectionCapabilities.prototype.getServerDBRecords = function (srvr) {
 	const url = (srvr || this.connectionConfig.server);
 	const dbrecs = {};
@@ -145,8 +155,11 @@ ConnectionCapabilities.prototype.getServerDBRecords = function (srvr) {
 	return dbrecs;
 };
 
-/*
- * removes a database record from the connection registry (after deletion, for example)
+/**
+ * @summary removes a database record from the connection registry (after deletion, for example)
+ * @param {String} [dbid] optional DB ID - if omitted current connection config db will be used
+ * @param {String} [srvr] optional server URL - if omitted current connection config server will be used
+ * @returns {[terminus:Database]} array of terminus:Database JSON documents as returned by WOQLClient.connect
  */
 ConnectionCapabilities.prototype.removeDB = function (dbid, srvr) {
 	dbid = dbid || this.connectionConfig.dbid;
@@ -162,24 +175,41 @@ ConnectionCapabilities.prototype.removeDB = function (dbid, srvr) {
 	}
 };
 
-
+/**
+ * @param {String} dbid local id of database
+ * @returns {String} the id of the terminus:Document describing the DB
+ * @summary Generates the ID of the terminus:Database document from the database ID
+ */
 ConnectionCapabilities.prototype.dbCapabilityID = function (dbid) {
 	return `doc:${dbid}`;
 };
 
-ConnectionCapabilities.prototype.getDBRecord = function (dbid, srvr) {
-	const url = srvr || this.connectionConfig.server;
+/**
+ * @param {String} action - the action that will be carried out
+ * @param {String} [dbid] optional DB ID - if omitted current connection config db will be used
+ * @param {String} [srvr] optional server URL - if omitted current connection config server will be used
+ * @returns {Boolean} true if the client's capabilities allow the action on the given server / db
+ * @summary supports client side access control checks (in addition to server side)
+ */
+ConnectionCapabilities.prototype.capabilitiesPermit = function (action, dbid, server) {
+	server = server || this.connectionConfig.server;
 	dbid = dbid || this.connectionConfig.dbid;
-	if (typeof this.connection[url] !== 'object') {
-		return false;
-	}
-	if (typeof this.connection[url][dbid] !== 'undefined') { return this.connection[url][dbid]; }
-
-	dbid = this.dbCapabilityID(dbid);
 
-	if (typeof this.connection[url][dbid] !== 'undefined') { return this.connection[url][dbid]; }
+	let rec;
 
-	return undefined;
+	if (action === CONST.CREATE_DATABASE) {
+		rec = this.getServerRecord(server);
+	} else if (dbid) rec = this.getDBRecord(dbid);
+	else console.log('no dbid provided in capabilities check ', server, dbid);
+	if (rec) {
+		const auths = rec['terminus:authority'];
+		if (auths && auths.indexOf(`terminus:${action}`) !== -1) return true;
+	} else {
+		console.log('No record found for connection: ', this.connection, action, server, dbid);
+	}
+	this.error = ErrorMessage.accessDenied(action, dbid, server);
+	return false;
 };
 
+
 module.exports = ConnectionCapabilities;