Merge pull request #279 from terminusdb/add_baseServer

update config, add baseServer property

Author: Francesca-Bit

RELEASE_NOTES.md

@@ -1,3 +1,11 @@
+# TerminusDB Client v10.0.29
+## Fixes 🛠
+* Fix getCommitsLog in WOQLClient
+
+## New 🚀
+* add getDocumentHistory in WOQLClient class
+* add baseServer property to ConnectionConfig class 
+
 # TerminusDB Client v10.0.28
 
 ## Fixes 🛠

docs/api/woqlclient.md

@@ -1388,31 +1388,8 @@ client.apply("mybranch","mybranch_new","merge main").then(result=>{
 })
 ```
 
-## docHistory
-##### woqlClient.docHistory(id, [historyParams])
-Get the document's history for a specific database or branch
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | id of document to report history of |
-| [historyParams] | <code>typedef.DocHistoryParams</code> |  |
-
-**Example**  
-```javascript
-//this will return the last 5 commits for the Person/Anna document
-client.checkout("mybranch")
-client.docHistory("Person/Anna",{start:0,count:5}).then(result=>{
-   console.log(result)
-})
-//this will return the last and the first commit for the Person/Anna document
-client.docHistory("Person/Anna",{updated:true,created:true}).then(result=>{
-   console.log(result)
-})
-```
-
-## docHistory
-##### woqlClient.docHistory(id, [historyParams])
+## getDocumentHistory
+##### woqlClient.getDocumentHistory(id, [historyParams])
 Get the document's history for a specific database or branch
 
 

lib/connectionConfig.js

@@ -20,6 +20,9 @@ function ConnectionConfig(serverUrl, params) {
      */
   this.server = undefined;
 
+  // the base server url without the team name
+  this.baseServer = undefined;
+
   // remote auth for authenticating to remote servers for push / fetch / clone
   /** @type {typedef.CredentialObj} */
   this.remote_auth = undefined;
@@ -229,7 +232,9 @@ ConnectionConfig.prototype.parseServerURL = function (str) {
 
 ConnectionConfig.prototype.serverUrlEncoding = function (str) {
   const orgArr = str.split('/');
-  if (orgArr.length > 3) {
+  if (orgArr.length > 4) {
+    // we can need only the server baseurl
+    this.baseServer = str.replace(`${orgArr[3]}/`, '');
     // const org = encodeURI(orgArr[3])
     /*
       * if we pass the organization name like Francesca-Bit-9e73
@@ -239,6 +244,7 @@ ConnectionConfig.prototype.serverUrlEncoding = function (str) {
     const org = encodeURISegment(orgArr[3]);
     return str.replace(orgArr[3], org);
   }
+  this.baseServer = str;
   return str;
 };
 

lib/woqlClient.js

@@ -1857,7 +1857,7 @@ WOQLClient.prototype.apply = function (beforeVersion, afterVersion, message, mat
  */
 
 // eslint-disable-next-line max-len
-WOQLClient.prototype.docHistory = function (id, historyParams) {
+WOQLClient.prototype.getDocumentHistory = function (id, historyParams) {
   const params = historyParams || {};
   params.id = id;
   return this.dispatch(

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminusdb-client",
-  "version": "10.0.28",
+  "version": "10.0.29",
   "description": "TerminusDB client library",
   "main": "index.js",
   "types": "./dist/typescript/index.d.ts",