Merge pull request #278 from terminusdb/history

fix WOQLClient.getCommitsLog with selected branch

Author: GavinMendelGleason

docs/api/woqlclient.md

@@ -1383,7 +1383,30 @@ If you would like to change branch or commit before apply use client.checkout("b
 **Example**  
 ```javascript
 client.checkout("mybranch")
-client.apply("main","mybranch","merge main").then(result=>{
+client.apply("mybranch","mybranch_new","merge main").then(result=>{
+   console.log(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)
 })
 ```

lib/connectionConfig.js

@@ -473,7 +473,7 @@ ConnectionConfig.prototype.queryURL = function () {
  * @returns {string}
  */
 ConnectionConfig.prototype.log = function () {
-  return this.dbBase('log');
+  return this.branchBase('log');
 };
 
 /**

lib/woqlClient.js

@@ -1815,7 +1815,7 @@ WOQLClient.prototype.getVersionDiff = function (beforeVersion, afterVersion, id,
  * @param {object} [options] - {keep:{}} Options to send to the apply endpoint
  * @example
  * client.checkout("mybranch")
- * client.apply("main","mybranch","merge main").then(result=>{
+ * client.apply("mybranch","mybranch_new","merge main").then(result=>{
  *    console.log(result)
  * })
  */

test/connectionConfing.spec.js

@@ -290,7 +290,7 @@ describe('connectionConfig tests', () => {
 
     it('check cloud commits log url', function() {
         const tmpClient = new ConnectionConfig("http://127.0.0.1:6363/myteam/",{organization:'myteam',db:'mydb'})
-        expect(tmpClient.log()).to.equal('http://127.0.0.1:6363/myteam/api/log/myteam/mydb')
+        expect(tmpClient.log()).to.equal('http://127.0.0.1:6363/myteam/api/log/myteam/mydb/local/branch/main')
 
     })