add getDatabases and review documentation

Author: Francesca-Bit

docs/_sidebar.md

@@ -19,10 +19,9 @@
     - [api](api/woqlClient.js?id=api)
     - [organization](api/woqlClient.js?id=organization)
     - [getDatabases](api/woqlClient.js?id=getDatabases)
+    - [databases](api/woqlClient.js?id=databases)
     - [user](api/woqlClient.js?id=user)
     - [userOrganization](api/woqlClient.js?id=userOrganization)
-    - [databases](api/woqlClient.js?id=databases)
-    - [userOrganizations](api/woqlClient.js?id=userOrganizations)
     - [databaseInfo](api/woqlClient.js?id=databaseInfo)
     - [db](api/woqlClient.js?id=db)
     - [setSystemDb](api/woqlClient.js?id=setSystemDb)
@@ -60,6 +59,7 @@
     - [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
     - [getBranches](api/woqlClient.js?id=getBranches)
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
+    - [userOrganizations](api/woqlClient.js?id=userOrganizations)
     - [getDiff](api/woqlClient.js?id=getDiff)
     - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)

docs/api/woqlClient.js.md

@@ -32,11 +32,13 @@ 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 callGetDatabases(){
+     const dbList = await client.getDatabases()
+     console.log(dbList)
+}
 
-})
 async function getSchema() {
      client.db("test")
      client.checkout("dev")
@@ -323,53 +325,47 @@ client.organization("admin")
 
 ### getDatabases
 #### woqlClient.getDatabases() ⇒ <code>string</code> \| <code>boolean</code>
-Gets the organization's databases list
+Gets the organization's databases list.
+
+If no organization has been set up, the function throws an exception
 
 **Example**  
 ```js
-client.getDatabases()
+async function callGetDatabases(){
+     const dbList = await client.getDatabases()
+     console.log(dbList)
+}
 ```
 
-### user
-#### woqlClient.user() ⇒ <code>Object</code>
-Gets the current user object as returned by the connect capabilities response
-user has fields: [id, name, notes, author]
-
-
-### userOrganization
-#### woqlClient.userOrganization() ⇒ <code>string</code>
-**Returns**: <code>string</code> - the user organization name  
-**Desription**: Gets the user's organization id  
-
 ### databases
 #### woqlClient.databases([dbList]) ⇒ <code>array</code>
-Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
+Set/Get the organization's databases list (id, label, comment) that the current user has access to on the server.
 
-**Returns**: <code>array</code> - the user databases list  
+**Returns**: <code>array</code> - the organization's databases list  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | [dbList] | <code>array</code> | a list of databases the user has access to on the server, each having: |
 
 **Example**  
 ```js
-const my_dbs = client.databases()
+//to get the list of all organization's databases
+async function callGetDatabases(){
+     await client.getDatabases()
+     console.log(client.databases())
+}
 ```
 
-### userOrganizations
-#### woqlClient.userOrganizations([orgList]) ⇒ <code>array</code>
-Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
-
-**Returns**: <code>array</code> - the user databases list  
+### user
+#### woqlClient.user() ⇒ <code>Object</code>
+Gets the current user object as returned by the connect capabilities response
+user has fields: [id, name, notes, author]
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [orgList] | <code>array</code> | a list of databases the user has access to on the server, each having: |
 
-**Example**  
-```js
-const my_dbs = client.databases()
-```
+### userOrganization
+#### woqlClient.userOrganization() ⇒ <code>string</code>
+**Returns**: <code>string</code> - the user organization name  
+**Desription**: Gets the user's organization id  
 
 ### databaseInfo
 #### woqlClient.databaseInfo([dbId]) ⇒ <code>object</code>
@@ -868,14 +864,33 @@ client.getBranches()
 
 ### getUserOrganizations
 #### woqlClient.getUserOrganizations() ⇒ <code>Promise</code>
-get the organizations and the database related
+Get the list of the user's 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)
-})
+async funtion callGetUserOrganizations(){
+     await getUserOrganizations()
+     console.log(client.userOrganizations())
+}
+```
+
+### userOrganizations
+#### woqlClient.userOrganizations([orgList]) ⇒ <code>array</code>
+Get/Set the list of the user's organizations (id, organization, label, comment).
+
+**Returns**: <code>array</code> - the user Organizations list  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [orgList] | <code>array</code> | a list of user's Organization |
+
+**Example**  
+```js
+async funtion callGetUserOrganizations(){
+     await client.getUserOrganizations()
+     console.log(client.userOrganizations())
+}
 ```
 
 ### getDiff

lib/woqlClient.js

@@ -34,11 +34,13 @@ const { default: axios } = require('axios')
  *                      {user:"myemail@something.com", organization:'mycloudTeam'})
  *                                           
  * client.setApiKey(MY_ACCESS_TOKEN)
+ * 
  * //to get the list of all organization's databases
- * client.getDatabases(result=>{
- *      console.log(result)
+ * async function callGetDatabases(){
+ *      const dbList = await client.getDatabases()
+ *      console.log(dbList)
+ * }
  * 
- * })
  * async function getSchema() {
  *      client.db("test")
  *      client.checkout("dev")
@@ -131,10 +133,15 @@ WOQLClient.prototype.organization = function(orgId) {
 }
 
 /**
- * Gets the organization's databases list
+ * Gets the organization's databases list.
+ * 
+ * If no organization has been set up, the function throws an exception
  * @returns {string | boolean}
  * @example
- * client.getDatabases()
+ * async function callGetDatabases(){
+ *      const dbList = await client.getDatabases()
+ *      console.log(dbList)
+ * }
  */
 WOQLClient.prototype.getDatabases = async function(){
     // return response
@@ -150,6 +157,23 @@ WOQLClient.prototype.getDatabases = async function(){
     return dbList
 }
 
+/**
+ * Set/Get the organization's databases list (id, label, comment) that the current user has access to on the server.
+ * @param {array} [dbList] a list of databases the user has access to on the server, each having:
+ * @returns {array} the organization's databases list
+ * @example
+ * //to get the list of all organization's databases
+ * async function callGetDatabases(){
+ *      await client.getDatabases()
+ *      console.log(client.databases())
+ * }
+ * 
+ */
+ WOQLClient.prototype.databases = function(dbList) {
+    if (dbList) this.databaseList = dbList
+    return this.databaseList || []
+}
+
 /**
  * Gets the current user object as returned by the connect capabilities response
  * user has fields: [id, name, notes, author]
@@ -170,32 +194,6 @@ WOQLClient.prototype.userOrganization = function() {
 }
 
 
-/**
- * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
- * @param {array} [dbList] a list of databases the user has access to on the server, each having:
- * @returns {array} the user databases list
- * @example
- * const my_dbs = client.databases()
- */
-WOQLClient.prototype.databases = function(dbList) {
-    if (dbList) this.databaseList = dbList
-    return this.databaseList || []
-}
-
-/**
- * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
- * @param {array} [orgList] a list of databases the user has access to on the server, each having:
- * @returns {array} the user databases list
- * @example
- * const my_dbs = client.databases()
- */
- WOQLClient.prototype.userOrganizations = function(orgList) {
-    if (orgList) this.organizationList = orgList
-    return this.organizationList || []
-}
-
-
-
 /**
  * Gets the database's details
  * @param {string} [dbId] - the datbase id
@@ -220,8 +218,6 @@ WOQLClient.prototype.db = function(dbId) {
         this.connectionConfig.setDB(dbId)
     }
     return this.connectionConfig.dbid
-    
-    //this.connectionConfig.db()
 }
 
 /**
@@ -1083,12 +1079,13 @@ WOQLClient.prototype.getBranches = function(dbId){
 }
 
 /**
- * get the organizations and the database related
+ * Get the list of the user's organizations and the database related
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected. 
  * @example
- * client.getUserOrganizations().then(result=>{
- *      console.log(result)
- * })
+ * async funtion callGetUserOrganizations(){
+ *      await getUserOrganizations()
+ *      console.log(client.userOrganizations())
+ * }
  */
  WOQLClient.prototype.getUserOrganizations = function(){
     // this will be change to give back only the organizations list
@@ -1102,6 +1099,21 @@ WOQLClient.prototype.getBranches = function(dbId){
     })
 }
 
+/**
+ * Get/Set the list of the user's organizations (id, organization, label, comment).
+ * @param {array} [orgList] a list of user's Organization
+ * @returns {array} the user Organizations list
+ * @example
+ * async funtion callGetUserOrganizations(){
+ *      await client.getUserOrganizations()
+ *      console.log(client.userOrganizations())
+ * }
+ */
+ WOQLClient.prototype.userOrganizations = function(orgList) {
+    if (orgList) this.organizationList = orgList
+    return this.organizationList || []
+}
+
 /**
  * Get the patch of difference between two documents.
  * @param {object} before - The current state of JSON document