Merge branch 'dev' into canary

Author: rrooij

docs/api/woql.js.md

@@ -1075,7 +1075,7 @@ Performs a path regular expression match on the graph
 | Param | Type | Description |
 | --- | --- | --- |
 | subject | <code>string</code> | An IRI or variable that refers to an IRI representing the subject, i.e. the starting point of the path |
-| pattern | <code>string</code> | (string) - A path regular expression describing a pattern through multiple edges of the graph Path regular expressions consist of a sequence of predicates and / or a set of alternatives, with quantification operators The characters that are interpreted specially are the following: | representing alternative choices , - representing a sequence of predcitates + - Representing a quantification of 1 or more of the preceding pattern in a sequence {min, max} - Representing at least min examples and at most max examples of the preceding pattern - Representing any predicate () - Parentheses, interpreted in the normal way to group clauses |
+| pattern | <code>string</code> | A regular expression describing a path through multiple edges of the graph. Path regular expressions consist of predicates and special characters including `\|` for alternatives, `,` for sequences, `+` for 1 or more predicates, `{min, max}` for matching a minimum and maximum number of times, `*` for matching anything, and `()` for grouping. |
 | object | <code>string</code> | An IRI or variable that refers to an IRI representing the object, i.e. ending point of the path |
 | resultVarName | <code>string</code> | A variable in which the actual paths traversed will be stored |
 

docs/api/woqlClient.js.md

@@ -17,7 +17,7 @@ For situations where you want to communicate with a TerminusDB server API, the W
 
 **Example**  
 ```js
-const client = new TerminusClient.Client(SERVER_URL)
+const client = new TerminusClient.WOQLClient(SERVER_URL)
 await client.connect(params)
 client.db("test")
 client.checkout("dev")
@@ -45,7 +45,7 @@ or the promise will be rejected.
 
 **Example**  
 ```js
-client.connect({key="mykey",user="admin"})
+client.connect({key:"mykey",user:"admin"})
 ```
 
 ### Create Database

docsify

@@ -42,17 +42,12 @@ function ConnectionConfig(serverUrl, params) {
     this.refid = false
     /** @type {string | boolean} */
     this.connection_error = false
-
+    //I can set serverURL only in constructor
     let surl = this.parseServerURL(serverUrl)
-    if (surl) {
-        //I can set serverURL only in constructor
-        this.server = surl
-        if (params) this.update(params)
-    } else {
-        //better throw an error
-        //fail fast designer
-        this.setError(`Invalid Server URL: ${serverUrl}`)
-    }
+   
+    this.server = surl
+    if (params) this.update(params)
+   
 }
 
 /**
@@ -77,8 +72,10 @@ ConnectionConfig.prototype.copy = function() {
  */
 ConnectionConfig.prototype.update = function(params) {
     if (!params) return
-    const orgID = params.organization || params.user
+    const orgID = params.organization || params.user 
+    //console.log("orgID",orgID,params)
     this.setOrganization(orgID)
+    if (typeof params.credential !== 'undefined')this.setTokenParameter(params.credential)
     if (typeof params.db !== 'undefined') this.setDB(params.db)
     if (typeof params.jwt !== 'undefined') this.setRemoteBasicAuth(params.jwt, params.jwt_user)
     if (typeof params.key !== 'undefined') this.setLocalBasicAuth(params.key, params.user)
@@ -87,6 +84,10 @@ ConnectionConfig.prototype.update = function(params) {
     if (typeof params.repo !== 'undefined') this.setRepo(params.repo)
 }
 
+ConnectionConfig.prototype.setTokenParameter = function(param){
+    this.tokenParameter = param
+}
+
 /**
  * Simple gets to retrieve current connection status
  * Gets the current server url
@@ -96,6 +97,15 @@ ConnectionConfig.prototype.serverURL = function() {
     return this.server
 }
 
+/**
+ * Simple gets to retrieve current connection status
+ * Gets the current server url
+ * @returns {string}
+ */
+ ConnectionConfig.prototype.author = function() {
+    return this.author
+}
+
 /**
  * Gets the server connection url
  * @returns {string}
@@ -109,6 +119,7 @@ ConnectionConfig.prototype.apiURL = function() {
  * @returns {string | boolean}
  */
 ConnectionConfig.prototype.db = function() {
+    if(!this.dbid) throw new Error('Invalid database name'); 
     return this.dbid
 }
 
@@ -191,7 +202,7 @@ ConnectionConfig.prototype.parseServerURL = function(str) {
     }
     //throw an error this is the
     //return false
-    return ''
+    throw new Error(`Invalid Server URL: ${str}`);
 }
 
 /**
@@ -272,13 +283,14 @@ ConnectionConfig.prototype.setRemoteBasicAuth = function(remoteKey, remoteUserID
  * set the local database connection credential
  * @param {string} [userKey] - basic auth api key
  * @param {string} [userId] -  user id
+ * @param {string} [type] - basic - jwt - token
  */
-ConnectionConfig.prototype.setLocalBasicAuth = function(userKey, userId = 'admin') {
+ConnectionConfig.prototype.setLocalBasicAuth = function(userKey, userId = 'admin', type= 'basic') {
     if (!userKey) {
         this.local_auth = undefined
     } else {
         const uid = userId
-        this.local_auth = {type: 'basic', user: uid, key: userKey}
+        this.local_auth = {type:type, user: uid, key: userKey}
     }
 }
 
@@ -347,7 +359,7 @@ ConnectionConfig.prototype.organizationURL = function(orgId, action) {
  * @returns {string}
  */
 ConnectionConfig.prototype.rolesURL = function() {
-    return `${this.apiURL()}roles`
+    return `${this.apiURL()}role`
 }
 
 /**
@@ -404,13 +416,14 @@ ConnectionConfig.prototype.queryURL = function() {
     return this.branchBase('woql')
 }
 
+
 /**
- * Generate URL for class frame api endpoint
+ * get the url to update the organization role in the system database
+ * don't change the end point (this is a terminus db server end point)
  * @returns {string}
  */
-ConnectionConfig.prototype.classFrameURL = function() {
-    if (this.db() == this.system_db) return this.dbBase('frame')
-    return this.branchBase('frame')
+ ConnectionConfig.prototype.updateOrganizationRoleURL = function() {
+    return `${this.apiURL()}update_role`
 }
 
 /**
@@ -531,6 +544,10 @@ ConnectionConfig.prototype.dbBase = function(action) {
     return `${this.apiURL()}${action}/${this.dbURLFragment()}`
 }
 
+//https://127.0.0.1:6363/api/document/admin/cloud-profiles/local/branch/main?graph_type=instance
+//instance
+
+
 /**
  * Generate base branch url consisting of server/action/organization/dbid/branchid
  * @param {typedef.ActionType} action
@@ -563,7 +580,11 @@ ConnectionConfig.prototype.branchBase = function(action) {
         return b
     }
     //_commits branch is magic - stores all commits for repo
-    if (this.branch() == '_commits') {
+
+    /*
+    *https://127.0.0.1:6363/api/db/admin/profiles01/local/_commits
+    */
+    if (this.branch() === '_commits') {
         return b + `/${this.branch()}`
     } else if (this.ref()) {
         return b + `/commit/${this.ref()}`
@@ -583,4 +604,32 @@ ConnectionConfig.prototype.dbURLFragment = function() {
     return this.organization() + '/' + this.db()
 }
 
+/**
+ * Generate url portion consisting of organization/dbid
+ * (unless dbid = system dbname in which case there is no organization)
+ * @property {typedef.DocParamsPost|Object} params
+ */
+
+ConnectionConfig.prototype.documentURL = function(params){
+    const paramsStr=this.queryParameter(params)
+    if (this.db() === this.system_db){
+       return this.dbBase('document')+paramsStr
+    }
+    return this.branchBase('document')+paramsStr
+}
+
+ConnectionConfig.prototype.queryParameter = function(params){
+    if(params && typeof params!=='object')return ''
+    let queryString = Object.keys(params).map((key) => {
+        return key + '=' + encodeURIComponent(params[key])
+    }).join('&');
+
+    return `?${queryString}`;
+}
+
+ConnectionConfig.prototype.jsonSchemaURL = function(params){
+    const paramsStr=this.queryParameter(params)
+    return this.branchBase('schema')+paramsStr
+}
+
 module.exports = ConnectionConfig

lib/connectionConfig.js

@@ -5,25 +5,25 @@
  */
 
 module.exports = Object.freeze({
+    POST:'POST',
+    GET:'GET',
+    DELETE:'DELETE',
+    PUT:'PUT',
     SQUASH_BRANCH: 'SQUASH_BRANCH',
     UPDATE_SCHEMA: 'UPDATE_SCHEMA',
     CONNECT: 'connect',
     CREATE_DATABASE: 'create_database',
     READ_DATABASE: 'read_database',
     UPDATE_DATABASE: 'update_database',
-    DELETE_DATABASE: 'delete_database',
     CREATE_USER: 'create_user',
     READ_USER: 'read_user',
     UPDATE_USER: 'update_user',
-    DELETE_USER: 'delete_user',
     CREATE_ORGANIZATION: 'create_organization',
     READ_ORGANIZATION: 'read_organization',
     UPDATE_ORGANIZATION: 'update_organization',
-    DELETE_ORGANIZATION: 'delete_organization',
     GET_ROLES: 'get_roles',
     UPDATE_ROLES: 'update_roles',
     CREATE_GRAPH: 'create_graph',
-    DELETE_GRAPH: 'delete_graph',
     GET_TRIPLES: 'get_triples',
     INSERT_TRIPLES: 'insert_triples',
     UPDATE_TRIPLES: 'update_triples',
@@ -39,12 +39,10 @@ module.exports = Object.freeze({
     REBASE: 'rebase',
     RESET: 'reset',
     BRANCH: 'branch',
-    DELETE_BRANCH: 'delete_branch',
     RESET_BRANCH: 'reset_branch',
     ADD_CSV: 'add_csv',
     GET_CSV: 'get_csv',
     UPDATE_CSV: 'update_csv',
-    DELETE_CSV: 'delete_csv',
     MESSAGE: 'message',
     ACTION: 'action',
     INFO: 'info',

lib/const.js

@@ -23,9 +23,9 @@ function btoaImplementation(str) {
  * @param {string} action API action
  * @param {object} payload data to be transmitted to endpoint
  * @param {string} key optional basic auth string to be passed
- * @param {string} reqUID the unique reqID
+ * @param {object} customHeaders the unique reqID
  */
-function DispatchRequest(url, action, payload, local_auth, remote_auth = null, reqUID = null) {
+function DispatchRequest(url, action, payload, local_auth, remote_auth = null, customHeaders = null) {
     /*
      *CORS is only required when trying to fetch data from a browser,
      *as browsers by default will block requests to different origins
@@ -34,6 +34,7 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, r
         mode: 'cors', // no-cors, cors, *same-origin
         redirect: 'follow', // manual, *follow, error
         referrer: 'client',
+        headers:{}
         // url:url,
         // no-referrer, *client
     }
@@ -51,35 +52,32 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, r
      * I can call the local database using the local authorization key or
      * a jwt token
      */
-    if (local_auth && local_auth.type == 'basic') {
+    if (local_auth && local_auth.type === 'basic') {
         let encoded = btoaImplementation(local_auth.user + ':' + local_auth.key)
         options.headers = {Authorization: `Basic ${encoded}`}
-    } else if (local_auth && local_auth.type == 'jwt') {
+    } else if (local_auth && local_auth.type === 'jwt') {
         options.headers = {Authorization: `Bearer ${local_auth.key}`}
+    } else if (local_auth && local_auth.type === 'cloud') {
+        
     }
     /*
      * pass the Authorization information of another
      * terminusdb server to the local terminusdb
      */
-    if (remote_auth && remote_auth.type == 'jwt') {
-        if (!options.headers) options.headers = {}
+    if (remote_auth && remote_auth.type == 'jwt') {        
         options.headers['Authorization-Remote'] = `Bearer ${remote_auth.key}`
     } else if (remote_auth && remote_auth.type == 'basic') {
         let rencoded = btoaImplementation(remote_auth.user + ':' + remote_auth.key)
-        if (!options.headers) options.headers = {}
         options.headers['Authorization-Remote'] = `Basic ${rencoded}`
     }
 
-    if (reqUID) {
-        options.headers['ReqUID'] = reqUID
+    if (customHeaders && typeof customHeaders === "object" ) {
+        Object.keys(customHeaders).map((key) => {
+            options.headers[key] = customHeaders[key]
+        })
     }
     switch (action) {
-        case CONST.DELETE_DATABASE:
-        case CONST.DELETE_CSV:
-        case CONST.DELETE_GRAPH:
-        case CONST.DELETE_USER:
-        case CONST.DELETE_BRANCH:
-        case CONST.DELETE_ORGANIZATION:
+        case CONST.DELETE:
             if (payload) {
                 options.headers = options.headers ? options.headers : {}
                 options.headers['Content-Type'] = 'application/json'
@@ -93,15 +91,7 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, r
                     if (err.response && err.response.data) e.data = err.response.data
                     throw e
                 })
-        case CONST.GET_TRIPLES:
-        case CONST.READ_USER:
-        case CONST.READ_DATABASE:
-        case CONST.READ_ORGANIZATION:
-        case CONST.CONNECT:
-        case CONST.GET_CSV:
-        case CONST.MESSAGE:
-        case CONST.INFO:
-        case CONST.GET_ROLES:
+        case CONST.GET:
             if (payload) {
                 const ext = UTILS.URIEncodePayload(payload)
                 if (ext) url += `?${ext}`
@@ -128,6 +118,17 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, r
                     if (err.response && err.response.data) e.data = err.response.data
                     throw e
                 })
+        case CONST.PUT:
+            options.headers = options.headers ? options.headers : {}
+            options.headers['Content-Type'] = 'application/json'
+            return axiosInstance
+                .put(url, payload, options)
+                .then(response => response.data)
+                .catch(err => {
+                    const e = new Error(ErrorMessage.getAPIErrorMessage(url, options, err))
+                    if (err.response && err.response.data) e.data = err.response.data
+                    throw e
+                })
         default:
             options.headers = options.headers ? options.headers : {}
             options.headers['Content-Type'] = 'application/json'