Merge remote-tracking branch 'origin/main' into doc_parsing

Author: rrooij

README.md

@@ -48,7 +48,7 @@ package, run:
 $ npm install --save @terminusdb/terminusdb-client
 ```
 
-This command update your `package.json`.
+This command updates your `package.json`.
 
 ### Script
 
@@ -69,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
+For the [full Documentation](https://terminusdb.com/docs/javascript)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -158,9 +158,9 @@ The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-doc
 
 ## Report Issues
 
-If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
+If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
 
-If you encounter other questions, you can ask in our [Discord Server](https://discord.gg/hTU3XWSzuZ).
+If you encounter other questions, you can ask them on our [Discord Server](https://discord.gg/hTU3XWSzuZ).
 
 ## Contribute
 

RELEASE_NOTES.md

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

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/typedef.js

@@ -177,4 +177,11 @@ const { ACTIONS } = Utils.ACTIONS;
  * @property {boolean} [created] - Created date of object (excludes history) false is the default
  */
 
+/**
+ * @typedef  {Object} DiffObject
+ * @property {keep} [Object] - Index to start from, 0 is the default
+ * @property {start} [number] - Amount of commits to show, 10 is the default
+ * @property {count} [number] - Last updated time (excludes history) false is the default
+ */
+
 module.exports = {};

lib/woqlClient.js

@@ -1320,7 +1320,7 @@ WOQLClient.prototype.updateDocument = function (json, params, dbId, message = 'u
   const docParams = params || {};
   docParams.author = this.author();
   docParams.message = message;
-  if (docParams.create) {
+  if (create) {
     docParams.create = create;
   }
   if (dbId) {
@@ -1585,7 +1585,7 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * //{ "@id" : "Person/Jane", "@type" : "Person", "name" : "Jannet"}
  */
 WOQLClient.prototype.patch = function (before, patch) {
-  if (typeof before !== 'object' || typeof after !== 'object') {
+  if (typeof before !== 'object' || typeof patch !== 'object') {
     const errmsg = '"before" or "after" parameter error - you must specify a valid before and after json document';
 
     return Promise.reject(
@@ -1743,7 +1743,8 @@ WOQLClient.prototype.getVersionObjectDiff = function (dataVersion, jsonObject, i
  * @param {string} afterVersion -  After branch/commit to compare
  * @param {string} [id] - The document id to be diffed,
  * if it is omitted all the documents will be compared
- * @param {object} [options] - {keep:{}} Options to send to the diff endpoint.
+ * @param {typedef.DiffObject} [options] - {keep:{},count:10,start:0}
+ * Options to send to the diff endpoint.
  * The diff api outputs the changes between the input (branches or commits),
  * in options you can list the properties that you would like to see in the diff result in any case.
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
@@ -1767,7 +1768,7 @@ WOQLClient.prototype.getVersionObjectDiff = function (dataVersion, jsonObject, i
  * })
  *
  * //This is to view the changes between two branches with the keep options
- * const options = {"keep":{"@id":true, "name": true}}
+ * const options = {"keep":{"@id":true, "name": true}, start:0, count:10}
  * client.getVersionDiff("main","mybranch",options).then(diffResult=>{
  *    console.log(diffResult)
  * })
@@ -1847,7 +1848,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",