review getDatabases

Author: Francesca-Bit

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)
+    - [getDatabases](api/woqlClient.js?id=getDatabases)
     - [user](api/woqlClient.js?id=user)
     - [userOrganization](api/woqlClient.js?id=userOrganization)
     - [databases](api/woqlClient.js?id=databases)
@@ -58,6 +59,7 @@
     - [getEnums](api/woqlClient.js?id=getEnums)
     - [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
     - [getBranches](api/woqlClient.js?id=getBranches)
+    - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [getDiff](api/woqlClient.js?id=getDiff)
     - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)

docs/api/woqlClient.js.md

@@ -32,6 +32,11 @@ const client = new TerminusClient.WOQLClient('SERVER_CLOUD_URL/mycloudTeam',
                      {user:"[email protected]", organization:'mycloudTeam'})
 
 client.setApiKey(MY_ACCESS_TOKEN)
+//to get the list of all organization's databases
+client.getDatabases(result=>{
+     console.log(result)
+
+})
 async function getSchema() {
      client.db("test")
      client.checkout("dev")
@@ -303,7 +308,8 @@ let api_url = client.api()
 
 ### organization
 #### woqlClient.organization([orgId]) ⇒ <code>string</code> \| <code>boolean</code>
-Gets/Sets the client’s internal organization context value
+Gets/Sets the client’s internal organization context value, if you change the organization name the 
+databases list will be set to empty
 
 
 | Param | Type | Description |
@@ -315,6 +321,15 @@ Gets/Sets the client’s internal organization context value
 client.organization("admin")
 ```
 
+### getDatabases
+#### woqlClient.getDatabases() ⇒ <code>string</code> \| <code>boolean</code>
+Gets the organization's databases list
+
+**Example**  
+```js
+client.getDatabases()
+```
+
 ### user
 #### woqlClient.user() ⇒ <code>Object</code>
 Gets the current user object as returned by the connect capabilities response
@@ -851,6 +866,18 @@ get the database collections list
 client.getBranches()
 ```
 
+### getUserOrganizations
+#### woqlClient.getUserOrganizations() ⇒ <code>Promise</code>
+get the organizations and the database related
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+**Example**  
+```js
+client.getUserOrganizations().then(result=>{
+     console.log(result)
+})
+```
+
 ### getDiff
 #### woqlClient.getDiff(before, after) ⇒ <code>Promise</code>
 Get the patch of difference between two documents.

lib/woqlClient.js

@@ -34,7 +34,7 @@ const { default: axios } = require('axios')
  *                      {user:"myemail@something.com", organization:'mycloudTeam'})
  *                                           
  * client.setApiKey(MY_ACCESS_TOKEN)
- * //to get the list of all the team and databases
+ * //to get the list of all organization's databases
  * client.getDatabases(result=>{
  *      console.log(result)
  * 
@@ -145,8 +145,9 @@ WOQLClient.prototype.getDatabases = async function(){
     //we'll change this call
     await this.getUserOrganizations();
     const dbs =  this.userOrganizations().find(element => element['name'] === this.connectionConfig.organization()) 
-    this.databases(dbs)
-    return dbs
+    const dbList = dbs && dbs.databases ? dbs.databases : []
+    this.databases(dbList)
+    return dbList
 }
 
 /**
@@ -1078,12 +1079,9 @@ WOQLClient.prototype.getBranches = function(dbId){
         this.checkout(branch)
         return branchesObj
     })
-    //reset branch
-   
+    //reset branch   
 }
 
-
-
 /**
  * get the organizations and the database related
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected. 
@@ -1093,7 +1091,7 @@ WOQLClient.prototype.getBranches = function(dbId){
  * })
  */
  WOQLClient.prototype.getUserOrganizations = function(){
-    // return response
+    // this will be change to give back only the organizations list
     return this.dispatch(
         CONST.GET,
         this.connectionConfig.userOrganizationsURL(),