Merge pull request #225 from terminusdb/vars_like_python

Make vars act exactly like python client

Author: Francesca-Bit

.babelrc

@@ -1,4 +1,6 @@
 {
+  
+  "sourceType": "unambiguous",
   "presets": ["@babel/preset-env"],
   "plugins": ["@babel/plugin-transform-regenerator",
     "@babel/plugin-transform-runtime"]

docs/api/accesscontrol.md

@@ -242,25 +242,33 @@ accessControl.deleteUser(userId).then(result=>{
 ```
 
 ## manageCapability
-##### accessControl.manageCapability(userId, resourceId, rolesArr, operation) ⇒ <code>Promise</code>
+##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, resourceType) ⇒ <code>Promise</code>
 -- TerminusdDB API ---
 Grant/Revoke Capability
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| userId | <code>string</code> | the document user id |
-| resourceId | <code>string</code> | the resource id (database or team) |
-| rolesArr | <code>array</code> | the roles list |
+| userName | <code>string</code> | the document user id |
+| resourceName | <code>string</code> | the name of a (database or team) |
+| rolesArr | <code>array</code> | the roles name list |
 | operation | <code>typedef.CapabilityCommand</code> | grant/revoke operation |
+| resourceType | <code>typedef.ResourceType</code> | the resource type (database or organization) |
 
 **Example**  
 ```javascript
-{ "operation" : "grant",
-  "scope" : "Organization/myteam",
-  "user" : "User/myUser",
-  "roles" : ["Role/reader"] }
+//we add an user to an organization and manage users' access
+//the user myUser can  access the Organization and all the database under the organization with "reader" Role
+client.manageCapability(myUser,myteam,[reader],"grant","organization").then(result=>{
+ consol.log(result)
+})
+
+//the user myUser can  access the database db__001 under the organization myteam
+//with "writer" Role
+client.manageCapability(myUser,myteam/db__001,[writer],"grant","database").then(result=>{
+ consol.log(result)
+})
 ```
 
 ## getAccessRoles

docs/api/typedef.md

@@ -92,7 +92,7 @@ the DELETE document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
-| type | <code>&#x27;basic&#x27;</code> \| <code>&#x27;jwt&#x27;</code> | the authorization type of an TerminusDB connection |
+| type | <code>&#x27;basic&#x27;</code> \| <code>&#x27;jwt&#x27;</code> \| <code>&#x27;apikey&#x27;</code> | the authorization type of an TerminusDB connection |
 | [user] | <code>string</code> \| <code>boolean</code> | the user id | I don't need the user with the jwt token |
 | key | <code>string</code> | the connection key |
 
@@ -131,6 +131,9 @@ the DELETE document interface query parameters
 | [invitation] | <code>string</code> | - |
 
 
+## ResourceType
+##### ResourceType:  `  "database"` |  `  "organization" ` 
+
 ## RepoType
 ##### RepoType:  `  "local"` |  `  "remote" ` 
 
@@ -140,13 +143,9 @@ the DELETE document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
-| [organization] | <code>string</code> | the db organization id |
-| id | <code>string</code> | The database identification name |
 | label | <code>string</code> | "Textual DB Name" |
 | [comment] | <code>string</code> | "Text description of DB" |
 | [public] | <code>boolean</code> |  |
-| [icon] | <code>string</code> | The database's icon |
-| [prefixes] | <code>object</code> | {scm: "http://url.to.use/for/scm", doc: "http://url.to.use/for/doc"} |
 | [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
 
 

docs/api/woql.md

@@ -387,22 +387,6 @@ Identifies a remote resource by URL and specifies the format of the resource thr
 remote({url:"http://url.of.resource"}, {type: "csv"})
 ```
 
-## file
-##### WOQL.file(url, [formatObj]) ⇒ <code>WOQLQuery</code>
-Identifies a file resource as a path on the server and specifies the format through the options
-
-**Returns**: <code>WOQLQuery</code> - A WOQLQuery which contains the file resource identifier  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| url | <code>object</code> | The Path on the server at which the file resource can be accessed |
-| [formatObj] | <code>typedef.DataFormatObj</code> | imput options |
-
-**Example**  
-```javascript
-file("/path/to/file", {type: 'turtle'} )
-```
-
 ## post
 ##### WOQL.post(url, [formatObj], [source]) ⇒ <code>WOQLQuery</code>
 Identifies a resource as a local path on the client, to be sent to the server through a
@@ -1429,6 +1413,20 @@ Gets/Sets woqlClient
 | client | <code>WOQLClient</code> | 
 
 
+## Vars
+##### WOQL.Vars(...varNames) ⇒
+**Returns**: object  
+
+| Param | Type |
+| --- | --- |
+| ...varNames | <code>string</code> | 
+
+**Example**  
+```javascript
+const v = WOQL.Vars('var01', 'var02', 'var03');
+triple(v.var01, v.var02, v.var03)
+```
+
 ## emerge
 ##### WOQL.emerge(auto_eval)
 query module

docs/api/woqlclient.md

@@ -1094,6 +1094,21 @@ get the database collections list
 client.getBranches()
 ```
 
+## getCommitsLog
+##### woqlClient.getCommitsLog([dbId]) ⇒ <code>Promise</code>
+get the database collections list
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [dbId] | <code>string</code> | the database id |
+
+**Example**  
+```javascript
+client.getCommitsLog()
+```
+
 ## getPrefixes
 ##### woqlClient.getPrefixes([dbId]) ⇒ <code>Promise</code>
 get the database prefixes object

index.html

@@ -1,29 +1,41 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>Woql Client</title>
-</head>
-<body>
-<script type="text/javascript">
-	var dbClient= new TerminusClient.WOQLClient();
+   <head>
+      <meta charset="utf-8">
+      <title>Woql Client</title>
+      <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+      </head>
+   <body onload="startTerminusdb();">
+      <div id="root" class="container">
+         <div class="alert alert-primary" role="alert">WE ARE TESTING TerminusDB Client ......</div>
+         <div class="alert alert-warning" role="alert" id="success-alert"></div>
+         <div class="alert alert-warning" role="alert" id="success-alert01"></div>
+         <div class="alert alert-success" role="alert" id="success-alert02"></div>
+      </div>
+      <script>
+         async function startTerminusdb(){
+			var dbClient= new TerminusDBClient.WOQLClient("http://127.0.0.1:6363",{user:"admin","key":"root",organization:"admin"});
+         	const db__01 = `myDB___${Date.now()}`
+         	try{
+         		await dbClient.createDatabase(db__01, {label: db__01 , comment: "add db", schema: true}) 
+         		const h5 = document.getElementById("success-alert");
+         		const newContent = document.createTextNode(`THE DATABASE ${db__01} HAS BEEN CREATED `);
+         		h5.appendChild(newContent)
+         
+         		await dbClient.deleteDatabase(db__01) 
+         
+         		const h6 = document.getElementById("success-alert01");
+         		const newContent01 = document.createTextNode(`THE DATABASE ${db__01} HAS BEEN DELETED`);
+         		h6.appendChild(newContent01)        
 
-var connection=dbClient.connect("http://localhost");
-
-connection.then((response)=>{
-	console.log("I'm connect")
-	dbClient.getSchema(getSchema,{"terminus:encoding":"terminus:turtle"}).then((response)=>
-	console.log("getSchema RESPONSE OK")).catch((err)=>{
-	console.log("PROMISE reject", 'GETSCHEMA');
-});
-
-}).catch((err)=>{
-	console.log("PROMISE reject", 'CONNECTION');
-});
-
-var getSchema='terminus';
-	
-</script>
-  
-</body>
+				const h7 = document.getElementById("success-alert02");
+         		const newContent02 = document.createTextNode(`CREATE/DELETE TerminusDB DATABASE TEST PASSED......`);
+         		h7.appendChild(newContent02)
+         	}catch(err){
+         		console.log(err)
+         	}
+         }
+         
+      </script>
+   </body>
 </html>

index.js

@@ -1,8 +1,14 @@
 /* eslint-disable global-require */
+// const { Vars } = require('./lib/query/woqlDoc');
+
 module.exports = {
   /**
-     * @type {typeof import('./lib/woqlClient')}
-     */
+   * @type {typeof import('./lib/query/woqlDoc')}
+   */
+  Vars: require('./lib/query/woqlDoc'),
+  /**
+   * @type {typeof import('./lib/woqlClient')}
+   */
   WOQLClient: require('./lib/woqlClient'),
   /**
      * @type {typeof import('./lib/utils')}

lib/accessControl.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable no-underscore-dangle */
 const DispatchRequest = require('./dispatchRequest');
 const ErrorMessage = require('./errorMessage');
@@ -289,20 +290,33 @@ AccessControl.prototype.deleteUser = function (userId) {
 /**
  * -- TerminusdDB API ---
  * Grant/Revoke Capability
- * @param  {string}  userId - the document user id
- * @param  {string}  resourceId - the resource id (database or team)
- * @param  {array}   rolesArr - the roles list
+ * @param  {string}  userName - the document user id
+ * @param  {string}  resourceName - the name of a (database or team)
+ * @param  {array}   rolesArr - the roles name list
  * @param  {typedef.CapabilityCommand}  operation - grant/revoke operation
+ * @param  {typedef.ResourceType}  resourceType - the resource type (database or organization)
  * @return {Promise} A promise that returns the call response object, or an Error if rejected.
  * @example
- { "operation" : "grant",
-  "scope" : "Organization/myteam",
-  "user" : "User/myUser",
-  "roles" : ["Role/reader"] }
+ * //we add an user to an organization and manage users' access
+ * //the user myUser can  access the Organization and all the database under the organization with "reader" Role
+ * client.manageCapability(myUser,myteam,[reader],"grant","organization").then(result=>{
+ *  consol.log(result)
+ * })
+ *
+ * //the user myUser can  access the database db__001 under the organization myteam
+ * //with "writer" Role
+ * client.manageCapability(myUser,myteam/db__001,[writer],"grant","database").then(result=>{
+ *  consol.log(result)
+ * })
  */
-AccessControl.prototype.manageCapability = function (userId, resourceId, rolesArr, operation) {
+
+AccessControl.prototype.manageCapability = function (userName, resourceName, rolesArr, operation, resourceType) {
   const payload = {
-    operation, user: userId, roles: rolesArr, scope: resourceId,
+    operation,
+    user: userName,
+    roles: rolesArr,
+    scope: resourceName,
+    scope_type: resourceType,
   };
   return this.dispatch(`${this.baseURL}/capabilities`, CONST.POST, payload);
 };

lib/connectionConfig.js

@@ -466,6 +466,14 @@ ConnectionConfig.prototype.queryURL = function () {
   return this.branchBase('woql');
 };
 
+/**
+ * Generate URL for get back the commits logs
+ * @returns {string}
+ */
+ConnectionConfig.prototype.log = function () {
+  return this.dbBase('log');
+};
+
 /**
  * get the url to update the organization role in the system database
  * don't change the end point (this is a terminus db server end point)

lib/dispatchRequest.js

@@ -29,6 +29,22 @@ function getResultWithDataVersion(response) {
       : '',
   };
 }
+/**
+ * Create the authorization header string
+ * @param {object} auth_obj
+ * @returns {object} Object with the Authorization header
+ */
+
+function formatAuthHeader(auth_obj) {
+  if (!auth_obj) return '';
+  const authType = { jwt: 'Bearer', basic: 'Basic', apikey: 'Token' };
+  let auth_key = auth_obj.key;
+
+  if (auth_obj.type === 'basic') {
+    auth_key = btoaImplementation(`${auth_obj.user}:${auth_obj.key}`);
+  }
+  return `${authType[auth_obj.type]} ${auth_key}`;
+}
 
 /**
  * @file Dispatch Request
@@ -41,6 +57,7 @@ function getResultWithDataVersion(response) {
  * @param {object} customHeaders the unique reqID
  * @param {boolean} compress If true, compress the data with gzip if its size is bigger than 1024
  */
+
 // eslint-disable-next-line max-len
 function DispatchRequest(url, action, payload, local_auth, remote_auth = null, customHeaders = null, getDataVersion = false, compress = false) {
   /*
@@ -72,24 +89,30 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
      * I can call the local database using the local authorization key or
      * a jwt token
      */
-  if (local_auth && local_auth.type === 'basic') {
+  /* if (local_auth && local_auth.type === 'basic') {
     const encoded = btoaImplementation(`${local_auth.user}:${local_auth.key}`);
     options.headers = { Authorization: `Basic ${encoded}` };
   } else if (local_auth && local_auth.type === 'jwt') {
     options.headers = { Authorization: `Bearer ${local_auth.key}` };
   } else if (local_auth && local_auth.type === 'apikey') {
     options.headers = { Authorization: `Token ${local_auth.key}` };
+  } */
+  /*
+     * I can call the local database or a custom installation using the local authorization key or
+     * I Can call TerminusX using the jwt token or an apiToken
+     */
+  if (local_auth && typeof local_auth === 'object') {
+    options.headers.Authorization = formatAuthHeader(local_auth);
   }
 
   /*
-     * pass the Authorization information of another
-     * terminusdb server to the local terminusdb
-     */
-  if (remote_auth && remote_auth.type === 'jwt') {
-    options.headers['Authorization-Remote'] = `Bearer ${remote_auth.key}`;
-  } else if (remote_auth && remote_auth.type === 'basic') {
-    const rencoded = btoaImplementation(`${remote_auth.user}:${remote_auth.key}`);
-    options.headers['Authorization-Remote'] = `Basic ${rencoded}`;
+   * pass the Authorization information of another
+   * terminusdb server to the local terminusdb
+   * for authentication you can use jwt or the apiKey token in TerminusX or
+   * the Basic autentication if is allowed in the custom server
+   */
+  if (remote_auth && typeof remote_auth === 'object') {
+    options.headers['Authorization-Remote'] = formatAuthHeader(remote_auth);
   }
 
   if (customHeaders && typeof customHeaders === 'object') {