Merge pull request #178 from terminusdb/getVersionDiff

Get version diff

Author: rrooij

docs/_sidebar.md

@@ -62,6 +62,8 @@
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [userOrganizations](api/woqlClient.js?id=userOrganizations)
     - [getDiff](api/woqlClient.js?id=getDiff)
+    - [getVersionObjectDiff](api/woqlClient.js?id=getVersionObjectDiff)
+    - [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
     - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)
   - [eval](api/woql.js?id=eval)

docs/api/woqlclient.md

@@ -1137,6 +1137,48 @@ const diff = await client.getDiff(
  );
 ```
 
+## getVersionObjectDiff
+##### woqlClient.getVersionObjectDiff(id, beforeVersion, after) ⇒ <code>Promise</code>
+Get the patch of difference between two documents.
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | The object id to be diffed |
+| beforeVersion | <code>string</code> | The version from which to compare the object |
+| after | <code>object</code> | The updated state of JSON document |
+
+**Example**  
+```javascript
+const diff = await client.getVersionObjectDiff(
+     "Person/Jane",
+     "branch:a73ssscfx0kke7z76083cgswszdxy6l",
+     { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ );
+```
+
+## getVersionDiff
+##### woqlClient.getVersionDiff(id, beforeVersion, afterVersion) ⇒ <code>Promise</code>
+Get the patch of difference between two documents.
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | The object id to be diffed |
+| beforeVersion | <code>string</code> | The version from which to compare the object |
+| afterVersion | <code>object</code> | The version to which to compare the object |
+
+**Example**  
+```javascript
+const diff = await client.getVersionDiff(
+     "Person/Jane",
+     "branch:a73ssscfx0kke7z76083cgswszdxy6l",
+     "branch:73rqpooz65kbsheuno5dsayh71x7wf4"
+ );
+```
+
 ## patch
 ##### woqlClient.patch(before, patch) ⇒ <code>Promise</code>
 Patch the difference between two documents.

lib/connectionConfig.js

@@ -503,6 +503,15 @@ ConnectionConfig.prototype.pullURL = function () {
   return purl;
 };
 
+/**
+ * Generate URL for diff endpoint
+ * @returns {string}
+ */
+ConnectionConfig.prototype.diffURL = function () {
+  const purl = this.branchBase('diff');
+  return purl;
+};
+
 /**
  * Generate URL for fetch endpoint
  * @param {string} remoteName

lib/woqlClient.js

@@ -1475,6 +1475,70 @@ WOQLClient.prototype.getDiff = function (before, after) {
   ).then((response) => response);
 };
 
+/**
+ * Get the patch of difference between two documents.
+ * @param {string} id - The object id to be diffed
+ * @param {string} beforeVersion - The version from which to compare the object
+ * @param {object} after - The updated state of JSON document
+ * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
+ * @example
+ *  const diff = await client.getVersionObjectDiff(
+ *      "Person/Jane",
+ *      "branch:a73ssscfx0kke7z76083cgswszdxy6l",
+ *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ *  );
+ */
+WOQLClient.prototype.getVersionObjectDiff = function (id, beforeVersion, after) {
+  if (typeof id !== 'string' || typeof beforeVersion !== 'string' || typeof after !== 'object') {
+    const errmsg = '"id", "beforeVersion" or "after" parameter error - you must specify a valid after json document and valid id and version';
+
+    return Promise.reject(
+      new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
+    );
+  }
+
+  const payload = { document_id: id, before_data_version: beforeVersion, after };
+  return this.dispatch(
+    CONST.POST,
+    this.connectionConfig.diffURL(),
+    payload,
+  ).then((response) => response);
+};
+
+/**
+ * Get the patch of difference between two documents.
+ * @param {string} id - The object id to be diffed
+ * @param {string} beforeVersion - The version from which to compare the object
+ * @param {object} afterVersion - The version to which to compare the object
+ * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
+ * @example
+ *  const diff = await client.getVersionDiff(
+ *      "Person/Jane",
+ *      "branch:a73ssscfx0kke7z76083cgswszdxy6l",
+ *      "branch:73rqpooz65kbsheuno5dsayh71x7wf4"
+ *  );
+ */
+WOQLClient.prototype.getVersionDiff = function (id, beforeVersion, afterVersion) {
+  if (typeof id !== 'string' || typeof beforeVersion !== 'string' || typeof afterVersion !== 'string') {
+    const errmsg = '"id", "beforeVersion" or "after" parameter error - you must specify a valid after json document and valid id and version';
+
+    return Promise.reject(
+      new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
+    );
+  }
+
+  const payload = {
+    document_id: id,
+    before_data_version: beforeVersion,
+    after_data_version: afterVersion,
+  };
+  return this.dispatch(
+    CONST.POST,
+    this.connectionConfig.diffURL(),
+    payload,
+  ).then((response) => response);
+};
+
 /**
  * Patch the difference between two documents.
  * @param {object} before - The current state of JSON document