fix issues #267,#260,#86 and add patchResource method

Author: Francesca-Bit

lib/query/woqlQuery.js

@@ -1495,7 +1495,7 @@ WOQLQuery.prototype.order_by = function (...orderedVarlist) {
 
   for (let i = 0; i < orderedVarlist.length; i++) {
     let obj;
-    if (typeof orderedVarlist[i] === 'string' && orderedVarlist[i] !== '') {
+    if ((typeof orderedVarlist[i] === 'string' || orderedVarlist[i] instanceof Var) && orderedVarlist[i] !== '') {
       obj = {
         '@type': 'OrderTemplate',
         variable: this.rawVar(orderedVarlist[i]),

lib/woql.js

@@ -353,10 +353,6 @@ WOQL.get = function (asvars, queryResource) {
  * @param {WOQLQuery} query - The query which will be executed to produce the results
  * @param {string} fileResource - an file resource local to the server
  * @returns {WOQLQuery} A WOQLQuery which contains the put expression
- * @example
- * let [s, p, o] = vars("Subject", "Predicate", "Object")
- * WOQL.put(WOQL.as("s", s).as("p", p).as("o", o), WOQL.all())
- * .file({file:"/app/local_files/dump.csv"})
  */
 WOQL.put = function (varsToExp, query, fileResource) {
   return new WOQLQuery().put(varsToExp, query, fileResource);

lib/woqlClient.js

@@ -1007,8 +1007,28 @@ WOQLClient.prototype.prepareRevisionControlArgs = function (rc_args) {
  *              "name" : "xsd:string",
  *              "perimeter" : { "@type" : "List",
  *                              "@class" : "Coordinate" } }]
- * client.addDocument(json,{"graph_type":"schema"},"mydb","add new schema")
+ * client.addDocument(json,{"graph_type":"schema"},"mydb","add new schema documents")
  *
+ * //if we would like to override the intire schema
+ * const json = [
+ * {"@base": "terminusdb:///data/",
+ *       "@schema": "terminusdb:///schema#",
+ *       "@type": "@context"
+ *   },
+ *   {
+ *       "@id": "Person",
+ *        "@key": {
+ *           "@type": "Random"
+ *       },
+ *       "@type": "Class",
+ *       "name": {
+ *           "@class": "xsd:string",
+ *           "@type": "Optional"
+ *       }
+ *   }]
+ *
+ * // client.addDocument(json,{"graph_type":"schema","full_replace:tue"},
+      "mydb","update the all schema");
  *
  * // Here we will pass true to show how to get dataVersion
  *
@@ -1559,7 +1579,7 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
 /**
  * Apply a patch object to another object
  * @param {object} before - The current state of JSON document
- * @param {object} after - The patch object
+ * @param {object} patch - The patch object
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  * client.patch(
@@ -1571,15 +1591,76 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * //result example
  * //{ "@id" : "Person/Jane", "@type" : "Person", "name" : "Jannet"}
  */
-WOQLClient.prototype.patch = function (before, after) {
+WOQLClient.prototype.patch = function (before, patch) {
   if (typeof before !== 'object' || typeof after !== 'object') {
     const errmsg = '"before" or "after" parameter error - you must specify a valid before and after json document';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.PATCH, errmsg)),
     );
   }
-  const payload = { before, after };
+  const payload = { before, patch };
+
+  return this.dispatch(
+    CONST.POST,
+    `${this.connectionConfig.apiURL()}patch`,
+    payload,
+  ).then((response) => response);
+};
+
+/**
+ * Apply a patch object to the current resource
+ * @param {array} patch - The patch object
+ * @param {string} message - The commit message
+ * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
+ * @example
+ * const patch = [
+ *   {
+ *    "@id": "Obj/id1",
+ *     "name": {
+ *      "@op": "SwapValue",
+ *       "@before": "foo",
+ *       "@after": "bar"
+ *     }
+ *   },
+ *  {
+ *    "@id": "Obj/id2",
+ *     "name": {
+ *       "@op": "SwapValue",
+ *       "@before": "foo",
+ *      "@after": "bar"
+ *     }
+ *  }
+ * ]
+ * client.db("mydb")
+ * client.checkout("mybranch")
+ * client.patchResource(patch,"apply patch to mybranch").then(patchResult=>{
+ *  console.log(patchResult)
+ * })
+ * // result example
+ * // ["Obj/id1",
+ * // "Obj/id2"]
+ * // or conflict error 409
+ * // {
+ * // "@type": "api:PatchError",
+ * // "api:status": "api:conflict",
+ * // "api:witnesses": [
+ * //  {
+ * //   "@op": "InsertConflict",
+ * //    "@id_already_exists": "Person/Jane"
+ * //  }
+ * //]
+ * //}
+ */
+WOQLClient.prototype.patchResource = function (patch, message) {
+  if (!Array.isArray(patch)) {
+    const errmsg = '"patch" parameter error - you must specify a valid patch document';
+
+    return Promise.reject(
+      new Error(ErrorMessage.getInvalidParameterMessage(CONST.PATCH, errmsg)),
+    );
+  }
+  const payload = { patch, author: this.author(), message };
 
   return this.dispatch(
     CONST.POST,