Merge pull request #234 from terminusdb/integration_tests

review typedef

Author: Francesca-Bit

docs/README.md

@@ -22,9 +22,7 @@ graph all through a simple document API.
 [terminusdb-docs]: https://terminusdb.com/docs/
 [terminusdb-repo]: https://github.com/terminusdb/terminusdb
 
-**TerminusX** is a self-service data platform that allows you to build, deploy,
-execute, monitor, and share versioned data products. It is built on TerminusDB.
-TerminusX is in public beta and you can [sign up now][dashboard].
+**TerminusX** TerminusX is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][dashboard].
 
 [dashboard]: https://dashboard.terminusdb.com/
 
@@ -71,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation][terminusdb-client-js-docs]
+For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");

docs/_sidebar.md

@@ -18,6 +18,7 @@
     - [server](api/woqlClient.js?id=server)
     - [api](api/woqlClient.js?id=api)
     - [organization](api/woqlClient.js?id=organization)
+    - [hasDatabase](api/woqlClient.js?id=hasDatabase)
     - [getDatabases](api/woqlClient.js?id=getDatabases)
     - [databases](api/woqlClient.js?id=databases)
     - [user](api/woqlClient.js?id=user)
@@ -57,6 +58,7 @@
     - [getEnums](api/woqlClient.js?id=getEnums)
     - [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
     - [getBranches](api/woqlClient.js?id=getBranches)
+    - [getCommitsLog](api/woqlClient.js?id=getCommitsLog)
     - [getPrefixes](api/woqlClient.js?id=getPrefixes)
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [userOrganizations](api/woqlClient.js?id=userOrganizations)
@@ -65,6 +67,8 @@
     - [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
     - [apply](api/woqlClient.js?id=apply)
     - [patch](api/woqlClient.js?id=patch)
+    - [sendCustomRequest](api/woqlClient.js?id=sendCustomRequest)
+- [WOQLClient](api/woqlClient.js?id=WOQLClient)
 - [WOQL](api/woql.js?id=WOQL)
   - [using](api/woql.js?id=using)
   - [comment](api/woql.js?id=comment)
@@ -91,7 +95,6 @@
   - [put](api/woql.js?id=put)
   - [as](api/woql.js?id=as)
   - [remote](api/woql.js?id=remote)
-  - [file](api/woql.js?id=file)
   - [post](api/woql.js?id=post)
   - [delete_triple](api/woql.js?id=delete_triple)
   - [delete_quad](api/woql.js?id=delete_quad)
@@ -153,6 +156,7 @@
   - [vars](api/woql.js?id=vars)
   - [doc](api/woql.js?id=doc)
   - [client](api/woql.js?id=client)
+  - [Vars](api/woql.js?id=Vars)
   - [emerge](api/woql.js?id=emerge)
   - [update_triple](api/woql.js?id=update_triple)
   - [update_quad](api/woql.js?id=update_quad)
@@ -211,6 +215,7 @@
   - [ActionType](api/typedef.js?id=ActionType)
   - [ParamsObj](api/typedef.js?id=ParamsObj)
   - [RolesObj](api/typedef.js?id=RolesObj)
+  - [ResourceType](api/typedef.js?id=ResourceType)
   - [RepoType](api/typedef.js?id=RepoType)
   - [DbDetails](api/typedef.js?id=DbDetails)
   - [RemoteRepoDetails](api/typedef.js?id=RemoteRepoDetails)

docs/api/accesscontrol.md

@@ -254,7 +254,7 @@ accessControl.deleteUser(userId).then(result=>{
 ```
 
 ## manageCapability
-##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, resourceType) ⇒ <code>Promise</code>
+##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, scopeType) ⇒ <code>Promise</code>
 -- TerminusdDB API ---
 Grant/Revoke Capability
 
@@ -266,7 +266,7 @@ Grant/Revoke Capability
 | 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) |
+| scopeType | <code>typedef.ScopeType</code> | the resource type (database or organization) |
 
 **Example**  
 ```javascript

docs/api/typedef.md

@@ -132,8 +132,8 @@ the DELETE document interface query parameters
 | [invitation] | <code>string</code> | - |
 
 
-## ResourceType
-##### ResourceType:  `  "database"` |  `  "organization" ` 
+## ScopeType
+##### ScopeType:  `  "database"` |  `  "organization" ` 
 
 ## RepoType
 ##### RepoType:  `  "local"` |  `  "remote" ` 

lib/accessControl.js

@@ -304,7 +304,7 @@ AccessControl.prototype.deleteUser = function (userId) {
  * @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)
+ * @param  {typedef.ScopeType}  scopeType - the resource type (database or organization)
  * @return {Promise} A promise that returns the call response object, or an Error if rejected.
  * @example
  * //we add an user to an organization and manage users' access
@@ -320,13 +320,13 @@ AccessControl.prototype.deleteUser = function (userId) {
  * })
  */
 
-AccessControl.prototype.manageCapability = function (userName, resourceName, rolesArr, operation, resourceType) {
+AccessControl.prototype.manageCapability = function (userName, resourceName, rolesArr, operation, scopeType) {
   const payload = {
     operation,
     user: userName,
     roles: rolesArr,
     scope: resourceName,
-    scope_type: resourceType,
+    scope_type: scopeType,
   };
   return this.dispatch(`${this.baseURL}/capabilities`, CONST.POST, payload);
 };

lib/typedef.js

@@ -117,7 +117,7 @@ const { ACTIONS } = Utils.ACTIONS;
  */
 
 /**
- * @typedef {"database"|"organization"} ResourceType
+ * @typedef {"database"|"organization"} ScopeType
  */
 
 /**