add pagination to getVersionDiff

Author: Francesca-Bit

RELEASE_NOTES.md

@@ -3,6 +3,7 @@
 * Fix getCommitsLog in WOQLClient
 
 ## New 🚀
+* add pagination to getVersionDiff
 * add getDocumentHistory in WOQLClient class
 * add baseServer property to ConnectionConfig class 
 

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

@@ -1750,7 +1750,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.
@@ -1774,7 +1775,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)
  * })