Merge pull request #103 from terminusdb/addDP

adding diff and patch

Author: GavinMendelGleason

docs/_sidebar.md

@@ -59,6 +59,8 @@
     - [getEnums](api/woqlClient.js?id=getEnums)
     - [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
     - [getBranches](api/woqlClient.js?id=getBranches)
+    - [getDiff](api/woqlClient.js?id=getDiff)
+    - [patch](api/woqlClient.js?id=patch)
 - [WOQL](api/woql.js?id=WOQL)
   - [eval](api/woql.js?id=eval)
   - [using](api/woql.js?id=using)

docs/api/woqlClient.js.md

@@ -850,3 +850,43 @@ get the database collections list
 ```js
 client.getBranches()
 ```
+
+### getDiff
+#### woqlClient.getDiff(before, 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 |
+| --- | --- | --- |
+| before | <code>object</code> | The current state of JSON document |
+| after | <code>object</code> | The updated state of JSON document |
+
+**Example**  
+```js
+const diff = await client.getDiff(
+     { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
+     { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ );
+```
+
+### patch
+#### woqlClient.patch(before, patch) ⇒ <code>Promise</code>
+Patch the difference between two documents.
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| before | <code>object</code> | The current state of JSON document |
+| patch | <code>object</code> | The patch object |
+
+**Example**  
+```js
+let diffPatch = await client.getDiff(
+     { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
+     { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ );
+
+let patch = await client.patch( { "@id": "Person/Jane", "@type": "Person", name: "Jane" }, diffPatch);
+```

lib/const.js

@@ -48,4 +48,6 @@ module.exports = Object.freeze({
     ACTION: 'action',
     INFO: 'info',
     OPTIMIZE_SYSTEM: 'optimize_system',
+    GET_DIFF: 'getDiff',
+    PATCH: 'patch',
 })

lib/woqlClient.js

@@ -1106,4 +1106,71 @@ WOQLClient.prototype.getBranches = function(dbId){
     })
 }
 
+/**
+ * Get the patch of difference between two documents.
+ * @param {object} before - The current state of JSON document
+ * @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.getDiff(
+ *      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
+ *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ *  );
+ */
+WOQLClient.prototype.getDiff = function(before, after) {
+
+    if(typeof before !== "object" || typeof after !== "object") {
+
+        const errmsg = `"before" or "after" parameter error - you must specify a valid before or after json document`;
+
+        return Promise.reject(
+            new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
+        )
+    }
+
+    const payload = { before, after };
+    return this.dispatch(
+        CONST.POST,
+        this.connectionConfig.apiURL() + "diff",
+        payload
+    ).then(response => {
+        return response;
+    });
+};
+
+/**
+ * Patch the difference between two documents.
+ * @param {object} before - The current state of JSON document
+ * @param {object} patch - The patch object
+ * @returns {Promise}  A promise that returns the call response object, or an Error if rejected. 
+ * @example
+ *  let diffPatch = await client.getDiff(
+ *      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
+ *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
+ *  );
+ * 
+ * let patch = await client.patch( { "@id": "Person/Jane", "@type": "Person", name: "Jane" }, diffPatch);
+ */
+ WOQLClient.prototype.patch = function(before, patch){
+
+    if(typeof before !== "object" || typeof patch !== "object") {
+
+        const errmsg = `"before" or "patch" parameter error - you must specify a valid before or patch json document`;
+
+        return Promise.reject(
+            new Error(ErrorMessage.getInvalidParameterMessage(CONST.PATCH, errmsg)),
+        )
+    }
+    const payload = { before, patch };
+
+    return this.dispatch(
+        CONST.POST,
+        this.connectionConfig.apiURL() + 'patch',
+        payload
+    ).then(response => {   
+        return response
+    })
+   
+}
+
 module.exports = WOQLClient