review docjs

Author: Francesca-Bit

.vscode/launch.json

@@ -0,0 +1,10 @@
+{
+    "configurations": [
+        {
+            "type": "pwa-chrome",
+            "name": "http://localhost:3005",
+            "request": "launch",
+            "url": "http://localhost:3005"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "compile-hero.disable-compile-files-on-did-save-code": false
+}

index.js

@@ -1,11 +1,34 @@
-
 module.exports = {
-    WOQLClient:require('./lib/woqlClient'),
-    UTILS:require('./lib/utils'),
-    View:require('./lib/viewer/woqlView'),
-    WOQL:require('./lib/woql'),
-    WOQLResult:require('./lib/viewer/woqlResult'),
-    WOQLTable:require('./lib/viewer/woqlTable'),
-    WOQLGraph:require('./lib/viewer/woqlGraph'),
-    axiosInstance:require('./lib/axiosInstance')
-};
+    /**
+     * @type {typeof import('./lib/woqlClient')}
+     */
+    WOQLClient: require('./lib/woqlClient'),
+    /**
+     * @type {typeof import('./lib/utils')}
+     */
+    UTILS: require('./lib/utils'),
+    /**
+     * @type {typeof import('./lib/woqlView')}
+     */
+    View: require('./lib/viewer/woqlView'),
+    /**
+     * @type {typeof import('./lib/woql')}
+     */
+    WOQL: require('./lib/woql'),
+    /**
+     * @type {typeof import('./lib/viewer/woqlResult')}
+     */
+    WOQLResult: require('./lib/viewer/woqlResult'),
+    /**
+     * @type {typeof import('./lib/viewer/woqlTable')}
+     */
+    WOQLTable: require('./lib/viewer/woqlTable'),
+    /**
+     * @type {typeof import('./lib/viewer/woqlGraph')}
+     */
+    WOQLGraph: require('./lib/viewer/woqlGraph'),
+    /**
+     * @type {typeof import('./lib/axiosInstance')}
+     */
+    axiosInstance: require('./lib/axiosInstance'),
+}

lib/connectionCapabilities.js

@@ -6,12 +6,12 @@ const UTILS = require("./utils")
 /**
  * @file Connection Capabilities
  * @license Apache Version 2
+ * @constructor
  * @description 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
- * @param {String} key API key
  */
 function ConnectionCapabilities() {
     this.clear()
@@ -30,39 +30,66 @@ ConnectionCapabilities.prototype.clear = function() {
 
 /**
  * @param {object} capabilities the JSON object returned by the connect API call
- * it is a system:User object with a system:role predicate which points at an array of roles
+ * @returns {object} it is a system:User object with a system:role predicate which points at an array of roles
  */
-ConnectionCapabilities.prototype.setCapabilities = function(connectjson) {
+ConnectionCapabilities.prototype.setCapabilities = function(capabilities) {
     this.clear()
     this.databases = false
-    if(connectjson['@context']) this._load_connection_context(connectjson['@context'])
-    this.user = this._extract_user_info(connectjson)
+    if(capabilities['@context']) this._load_connection_context(capabilities['@context'])
+    this.user = this._extract_user_info(capabilities)
     this._extract_database_organizations() //find the organization which owns the db
     return this.user
 }
 
-ConnectionCapabilities.prototype.get_user = function() {
+/*
+* @returns {object}
+*/
+//ConnectionCapabilities.prototype.get_user = function() {
+ConnectionCapabilities.prototype.getUserObj = function() {
+    //console.log("___USER___OBJ",this.user)
     return this.user
 }
-
+//getDatabases
+/*
+* @returns {string|boolean}
+*/
 ConnectionCapabilities.prototype.author = function() {
     if (this.user && this.user.author) return this.user.author
     return false
 }
 
-ConnectionCapabilities.prototype.get_databases = function() {
+
+/** 
+* @description get the database details list for the get capabilities call
+* @returns {array}
+*/
+//KEVIN
+//ConnectionCapabilities.prototype.get_databases = function() {
+ConnectionCapabilities.prototype.getDatabaseList = function() {
     if(!this.databases) this.databases = this._databases_from_dbdocs()
     return this.databases
 }
-
-ConnectionCapabilities.prototype.set_databases = function(newdbs) {
-    this.databases = newdbs
+/**
+ * @description set the newDBList form the get capabilities result
+ * @param {array} newDBList 
+ */
+//KEVIN
+ConnectionCapabilities.prototype.setDatabaseList = function(newDBList) {
+//ConnectionCapabilities.prototype.set_databases = function(newDBList) {
+    this.databases = newDBList
 }
 
-ConnectionCapabilities.prototype.get_database = function(dbid, orgid) {
+/**
+ * @description Gets the database's details
+ * @param {?string} dbId
+ * @param {?string} orgId
+ * @returns {object}
+ */
+//ConnectionCapabilities.prototype.get_database = function(dbId, orgId) {
+ConnectionCapabilities.prototype.getDatabaseObj = function(dbId, orgId) {
     if(!this.databases) this.databases = this._databases_from_dbdocs()
     for(var i = 0; i<this.databases.length; i++){
-        if(this.databases[i].id == dbid && this.databases[i].organization == orgid){
+        if(this.databases[i].id === dbId && this.databases[i].organization === orgId){
             return this.databases[i]
         }
     }
@@ -139,7 +166,7 @@ ConnectionCapabilities.prototype.actions_permitted = function(actions, resnames)
 }
 
 ConnectionCapabilities.prototype.buildContextsFromPrefixes = function(){
-    let dbs = this.get_databases()
+    let dbs = this.getDatabaseList()
     for(var i = 0; i<dbs.length; i++){
         dbs[i].jsonld_context = _jsonld_context_from_prefixes(dbs[i].prefix_pairs)
     }    
@@ -171,7 +198,7 @@ ConnectionCapabilities.prototype.getContextForOutboundQuery = function(woql, dbi
     else {
         if(this._is_system_db(dbid)) ob = this.getSystemContext()
         else {
-            let dbrec = this.get_database(dbid, orgid)
+            let dbrec = this.getDatabaseObj(dbid, orgid)
             let jcon = (dbrec && dbrec.jsonld_context ? dbrec.jsonld_context : this.jsonld_context)   
             for (var k in jcon) {
                 //if (k != 'doc') ob[k] = jcon[k]