Merge pull request #53 from terminusdb/dev

add multi organization

Author: KittyJose

lib/connectionConfig.js

@@ -56,6 +56,7 @@ function ConnectionConfig(serverUrl, params) {
  */
 ConnectionConfig.prototype.copy = function() {
     let other = new ConnectionConfig(this.server)
+    other.api_extension = this.api_extension
     other.remote_auth = this.remote_auth
     other.local_auth = this.local_auth
     other.organizationid = this.organizationid
@@ -362,6 +363,18 @@ ConnectionConfig.prototype.organizationURL = function(orgId, action) {
     return url
 }
 
+/**
+ * Generate URL for the user's organization api endpoint
+ * @param {string} orgId - the organization id
+ * @param {string} [action] - the organization id
+ * @returns {string}
+ */
+
+ ConnectionConfig.prototype.userOrganizationsURL = function() {
+    let url = `${this.apiURL()}user_organizations`
+    return url
+}
+
 /**
  * Generate URL for the user's roles api endpoint
  * @returns {string}

lib/query/woqlQuery.js

@@ -9,6 +9,15 @@ let WOQLQuery = require('./woqlCore')
     }
 }*/
 
+WOQLQuery.prototype.read_object = function(IRI, OutputVar, Format) {
+    //if (IRI && IRI == 'args') return ['document_uri', 'document']
+    if (this.cursor['@type']) this.wrapCursorWithAnd()
+    this.cursor['@type'] = 'ReadObject'
+    this.cursor['document_uri'] = this.expandValueVariable(IRI)
+    this.cursor['document'] = this.expandValueVariable(OutputVar)
+    return this.wform(Format)
+}
+
 /**
  * Contains definitions of the WOQL functions which map directly to JSON-LD types
  * All other calls and queries can be composed from these
@@ -799,7 +808,6 @@ WOQLQuery.prototype.length = function(va, vb) {
  * Negation of passed or chained query
  */
 WOQLQuery.prototype.not = function(query) {
-    //if (query && query == 'args') return ['query']
     if (this.cursor['@type']) this.wrapCursorWithAnd()
     this.cursor['@type'] = 'Not'
     return this.addSubQuery(query)

lib/typedef.js

@@ -1,34 +1,34 @@
 //typedef
 /**
  *@typedef {Object} DocParamsGet - the GET document interface query parameters 
- *@property {string} [graph_type=instance] - instance|schema default value is instance. Used to switch between getting documents from the instance or the schema graph.
+ *@property {GraphType} [graph_type] - instance|schema, default value is instance. Used to switch between getting documents from the instance or the schema graph.
  *@property {string} [type]	- only documents of the given type are returned.
  *@property {string} [id] -	only the document with the given ID is returned.
- *@property {boolean} [prefixed=true] - return IRIs using a prefixed notation wherever possible. If false, full IRIs are used.
- *@property {boolean} [minimized=false] - return the documents with very little whitespace. Each json document will be on its own line.
- *@property {boolean} [unfold=true] - any subdocuments contained in the returned document are returned too. If false, these are referred to by their ID instead.
- *@property {number} [skip=0] - How many results to skip
+ *@property {boolean} [prefixed] - default is true, return IRIs using a prefixed notation wherever possible. If false, full IRIs are used.
+ *@property {boolean} [minimized] -  default is false, return the documents with very little whitespace. Each json document will be on its own line.
+ *@property {boolean} [unfold] -  default is false, any subdocuments contained in the returned document are returned too. If false, these are referred to by their ID instead.
+ *@property {number} [skip] -  default is 0, How many results to skip
  *@property {number} [count] count	 - How many results to return. If this option is absent, all results are returned.
- *@property {boolean} [as_list=false] If true, don't return a stream of json objects, but a json list.
+ *@property {boolean} [as_list]  default is false, If true, don't return a stream of json objects, but a json list.
  *@property {string} [graph_type] - instance|schema default value is instance
  */
 
  /**
  *@typedef {Object} DocParamsPost - the POST document interface query parameters
- *@property {string} [graph_type=instance] - instance|schema Used to switch between getting documents from the instance or the schema graph.
- *@property {boolean} [full_replace=false] - If true, all existing documents are deleted before inserting the posted documents. This allows the full replacement of the contents of a database. This is especially useful for replacing the schema.
+ *@property {GraphType} [graph_type] - default is instance  instance|schema Used to switch between getting documents from the instance or the schema graph.
+ *@property {boolean} [full_replace] - default is false, If true, all existing documents are deleted before inserting the posted documents. This allows the full replacement of the contents of a database. This is especially useful for replacing the schema.
  */
 
  /**
  *@typedef {Object} DocParamsPut - the PUT document interface query parameters
- *@property {string} [graph_type=instance] - instance|schema Used to switch between getting documents from the instance or the schema graph.
+ *@property {GraphType} [graph_type] - default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph.
  */
 
  /**
  *@typedef {Object} DocParamsDelete - the DELETE document interface query parameters
- *@property {string} [graph_type=instance] - instance|schema Used to switch between getting documents from the instance or the schema graph.
+ *@property {GraphType} [graph_type] - default is instance, instance|schema Used to switch between getting documents from the instance or the schema graph.
  *@property {string|array} id	- a single id or a list of ids to delete.
- *@property {booleam} [nuke=false]	- If true, delete everything at this resource location (dangerous!).
+ *@property {booleam} [nuke]	- default is false, If true, delete everything at this resource location (dangerous!).
  */
 
 

lib/woql.js

@@ -1115,6 +1115,10 @@ WOQL.string = function(val) {
     return new WOQLQuery().string(val)
 }
 
+WOQL.read_object = function(IRI, output, formatObj) {
+    return new WOQLQuery().read_object(IRI, output, formatObj)
+}
+
 /**
  * Generates explicitly a JSON-LD string literal from the input
  * @param {string} val - any literal type

lib/woqlClient.js

@@ -47,6 +47,7 @@ function WOQLClient(serverUrl, params) {
     // current connection context variables
     this.connectionConfig = new ConnectionConfig(serverUrl, params)
     this.databaseList = []
+    this.organizationList =[]
 }
 
 
@@ -115,7 +116,11 @@ WOQLClient.prototype.api = function() {
  */
 WOQLClient.prototype.organization = function(orgId) {
     if (typeof orgId !== 'undefined') {
-        this.connectionConfig.setOrganization(orgId)
+        this.connectionConfig.setOrganization(orgId)  
+        const orgObj =  this.userOrganizations().find(element => element['name'] === orgId)  
+        const dbs = orgObj ? orgObj.databases : []
+        //change the database list
+        this.databases(dbs)
     }
     return this.connectionConfig.organization()
 }
@@ -152,6 +157,20 @@ WOQLClient.prototype.databases = function(dbList) {
     return this.databaseList || []
 }
 
+/**
+ * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
+ * @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
@@ -332,9 +351,8 @@ WOQLClient.prototype.resource = function(resourceType, resourceId) {
 WOQLClient.prototype.connect = function(params) {
     if (params) this.connectionConfig.update(params)
     // unset the current server setting until successful connect
-    return this.dispatch(CONST.GET, this.api()).then(response => {
+    return this.dispatch(CONST.GET, this.api()).then(response => { 
         this.databases(response)
-        return response
     })
 }
 
@@ -1048,4 +1066,36 @@ WOQLClient.prototype.getBranches = function(dbId){
 
 }
 
+//this method is not documented
+/*
+ * get the organizations and the database related
+ * @param {string} [defaultOrg] - the organizatation to set 
+ * @returns {Promise}  A promise that returns the call response object, or an Error if rejected. 
+ * @example
+ * client.getUserOrganizations()
+ */
+ WOQLClient.prototype.getUserOrganizations = function(defaultOrg){
+     //this.databases(response)
+     // return response
+    return this.dispatch(
+        CONST.GET,
+        this.connectionConfig.userOrganizationsURL(),
+    ).then(response => {   
+        const orgList = Array.isArray(response) ? response : []
+        this.userOrganizations(orgList)
+        if (orgList.length>0){          
+            //let orgObj = {}
+            if(defaultOrg){
+                orgObj = response.find(element => element['name'] === defaultOrg)
+                            
+            }else{
+                orgObj = response[0]
+            }
+            this.organization(orgObj['name'])  
+        } 
+        return response
+    })
+   
+}
+
 module.exports = WOQLClient