Merge pull request #124 from terminusdb/getDatabases

review the accessControl documentations add api token

Author: Francesca-Bit

docs/_sidebar.md

@@ -162,8 +162,8 @@
   - [first_commit](api/woqlLibrary.js?id=first_commit)
 - [AccessControl](api/accessControl.js?id=AccessControl)
   - [getDefaultOrganization](api/accessControl.js?id=getDefaultOrganization)
-  - [getJwtToken](api/accessControl.js?id=getJwtToken)
   - [setJwtToken](api/accessControl.js?id=setJwtToken)
+  - [setApiToken](api/accessControl.js?id=setApiToken)
   - [getAPIUrl](api/accessControl.js?id=getAPIUrl)
   - [getAccessRoles](api/accessControl.js?id=getAccessRoles)
   - [createOrganization](api/accessControl.js?id=createOrganization)

docs/api/accessControl.js.md

@@ -5,17 +5,30 @@
 
 #### new AccessControl()
 The AccessControl object has various methods to control the access for users.
+for the credential you can use the JWT token or the API token
 
 **Example**  
 ```js
+//connect with the API token 
+//(to request a token create an account in  https://terminusdb.com/)
+const accessContol = new AccessControl("https://servername.com",
+{organization:"my_team_name",
+token:"dGVybWludXNkYjovLy9kYXRhL2tleXNfYXB........"})
+accessControl.getOrgUsers().then(result=>{
+     console.log(result)
+})
+
+//connect with the jwt token this type of connection is only for the dashboard 
+//or for application integrate with our login workflow
 const accessContol = new AccessControl("https://servername.com",
 {organization:"my_team_name",
 jwt:"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd........"})
 accessControl.getOrgUsers().then(result=>{
      console.log(result)
 })
+
 //if the jwt is expired you can change it with
- accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
+accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
 ```
 
 ### getDefaultOrganization
@@ -29,25 +42,24 @@ Get a organization from parameters.
 | params | <code>object</code> | The parameters |
 
 
-### getJwtToken
-#### accessControl.getJwtToken(params) ⇒ <code>string</code>
-Get a API token from parameters.
+### setJwtToken
+#### accessControl.setJwtToken(jwt)
+Sets the Jwt token for the object
 
-**Returns**: <code>string</code> - jwt api token  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| params | <code>object</code> | The parameters |
+| jwt | <code>string</code> | The jwt api token to use |
 
 
-### setJwtToken
-#### accessControl.setJwtToken(jwt)
-Sets the API token for the object
+### setApiToken
+#### accessControl.setApiToken(atokenpi)
+Sets the API token for the object, to request a token create an account in  https://terminusdb.com/
 
 
 | Param | Type | Description |
 | --- | --- | --- |
-| jwt | <code>string</code> | The jwt api token to use |
+| atokenpi | <code>string</code> | The API token to use to connect with TerminusX |
 
 
 ### getAPIUrl

lib/accessControl.js

@@ -9,21 +9,43 @@ const UTILS = require('./utils')
  * @module AccessControl
  * @constructor AccessControl
  * @description The AccessControl object has various methods to control the access for users.
+ * for the credential you can use the JWT token or the API token
  * @example
+ * //connect with the API token 
+ * //(to request a token create an account in  https://terminusdb.com/)
+ * const accessContol = new AccessControl("https://servername.com",
+ * {organization:"my_team_name",
+ * token:"dGVybWludXNkYjovLy9kYXRhL2tleXNfYXB........"})
+ * accessControl.getOrgUsers().then(result=>{
+ *      console.log(result)
+ * })
+ * 
+ * //connect with the jwt token this type of connection is only for the dashboard 
+ * //or for application integrate with our login workflow
  * const accessContol = new AccessControl("https://servername.com",
  * {organization:"my_team_name",
  * jwt:"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd........"})
  * accessControl.getOrgUsers().then(result=>{
  *      console.log(result)
  * })
+ * 
  * //if the jwt is expired you can change it with
- *  accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
+ * accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
+ * 
+ *
+ * 
  */
 
 function AccessControl(cloudAPIUrl, params) {
 
     this.baseURL = this.getAPIUrl(cloudAPIUrl);
-    this.apiJwtToken = this.getJwtToken(params);
+    if(params.jwt){
+        this.setJwtToken(params.jwt)
+       
+    }else if (params.token){
+        this.setApiToken(params.token)
+    }
+    
     this.defaultOrganization = this.getDefaultOrganization(params);
 
 }
@@ -35,40 +57,37 @@ function AccessControl(cloudAPIUrl, params) {
  */
  AccessControl.prototype.getDefaultOrganization = function(params) {
     if(params && params.organization && typeof params.organization === 'string') {
-        return params.organization;
+        return params.organization
     }
     return undefined;
 }
-
 /**
- * Get a API token from parameters.
- * @param {object} params -  The parameters
- * @return {string} jwt api token
+ * Sets the Jwt token for the object
+ * @param {string} jwt -  The jwt api token to use
  */
-AccessControl.prototype.getJwtToken = function(params) {
-    if(params) {
-        if(!params.jwt) throw new Error('TerminusX Access token required');
-
-        return params.jwt;
-    } else {
-        if(!process.env.TERMINUSDB_ACCESS_TOKEN) throw new Error('TerminusX Access token required');
-
-        return process.env.TERMINUSDB_ACCESS_TOKEN;
+AccessControl.prototype.setJwtToken = function(jwt) {
+    if(!jwt) {
+     throw new Error('TerminusX Access token required');
     }
+
+    this.apiJwtToken = jwt;
+    this.apiType = 'jwt'
 }
 
 /**
- * Sets the API token for the object
- * @param {string} jwt -  The jwt api token to use
+ * Sets the API token for the object, to request a token create an account in  https://terminusdb.com/
+ * @param {string} atokenpi  -  The API token to use to connect with TerminusX
  */
-AccessControl.prototype.setJwtToken = function(jwt) {
-    if(!jwt) {
+ AccessControl.prototype.setApiToken = function(token) {
+    if(!token) {
      throw new Error('TerminusX Access token required');
     }
 
-    this.apiJwtToken = jwt;
+    this.apiToken = token;
+    this.apiType = "apikey"
 }
 
+
 /**
  * Get a API url from cloudAPIUrl
  * @param {string} cloudAPIUrl -  The base url for cloud
@@ -97,11 +116,13 @@ AccessControl.prototype.dispatch = function(requestUrl, action, payload) {
         );
     }
 
+    const apiToken = this.apiJwtToken || this.apiToken
+
     return DispatchRequest(
         requestUrl,
         action,
         payload,
-        { type: 'jwt', key: this.apiJwtToken }
+        { type:this.apiType, key:apiToken }
     );
 }
 
@@ -555,4 +576,4 @@ AccessControl.prototype.updateUserRole = function (userId, capabilityId, scope,
     });
 };
 
-module.exports = AccessControl;
+module.exports = AccessControl

test/connectionConfing.spec.js

@@ -274,9 +274,9 @@ describe('connectionConfig tests', function() {
     it('check baseUrlEncode', function() {
         const db = "%6277&ˆˆˆ@ˆˆWˆTWTET#Y@&&GHHSHHS"
         connectionConfig.setDB(db)
-        const dbBase = 'http://localhost:6363/api/woql/123/%256277%26%CB%86%CB%86%CB%86%40%CB%86%CB%86W%CB%86TWTET%23Y%40%26%26GHHSHHS'
-        //expect(connectionConfig.dbBase('woql')).to.equal(dbBase)
-        //expect(connectionConfig.db()).to.equal(db)
+        const dbBase = 'http://localhost:6363/api/woql/123/%256277%26%CB%86%CB%86%CB%86@%CB%86%CB%86W%CB%86TWTET%23Y@%26%26GHHSHHS'
+        expect(connectionConfig.dbBase('woql')).to.equal(dbBase)
+        expect(connectionConfig.db()).to.equal(db)
 
     })