Merge pull request #269 from terminusdb/fix_integration

fix issues #267 #260 #87 add patchResource and review typescript  types generation

Author: Francesca-Bit

docs/api/woql.md

@@ -351,12 +351,6 @@ Use the document inteface to import documents
 | query | <code>WOQLQuery</code> | The query which will be executed to produce the results |
 | fileResource | <code>string</code> | an file resource local to the server |
 
-**Example**  
-```javascript
-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"})
-```
 
 ## as
 ##### WOQL.as(source, target, [type]) ⇒ <code>WOQLQuery</code>

docs/api/woqlclient.md

@@ -744,8 +744,28 @@ const json = [{ "@type" : "Class",
              "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 entire 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:true"},
+      "mydb","update the all schema");
 
 // Here we will pass true to show how to get dataVersion
 
@@ -1184,6 +1204,81 @@ async funtion callGetUserOrganizations(){
 }
 ```
 
+## patch
+##### woqlClient.patch(before, patch) ⇒ <code>Promise</code>
+Apply a patch object to another object
+
+**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**  
+```javascript
+client.patch(
+     { "@id" : "Person/Jane", "@type" : "Person", "name" : "Jane"},
+     { "name" : { "@op" : "ValueSwap", "@before" : "Jane", "@after": "Janine" }}
+ ).then(patchResult=>{
+ console.log(patchResult)
+})
+//result example
+//{ "@id" : "Person/Jane", "@type" : "Person", "name" : "Jannet"}
+```
+
+## patchResource
+##### woqlClient.patchResource(patch, message) ⇒ <code>Promise</code>
+Apply a patch object to the current resource
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| patch | <code>array</code> | The patch object |
+| message | <code>string</code> | The commit message |
+
+**Example**  
+```javascript
+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"
+//  }
+//]
+//}
+```
+
 ## getJSONDiff
 ##### woqlClient.getJSONDiff(before, after, [options]) ⇒ <code>Promise</code>
 Get the patch of difference between two documents.
@@ -1293,28 +1388,6 @@ client.apply("main","mybranch","merge main").then(result=>{
 })
 ```
 
-## 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**  
-```javascript
-let diffPatch = await client.getJSONDiff(
-     { "@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);
-```
-
 ## sendCustomRequest
 ##### woqlClient.sendCustomRequest(requestType, customRequestURL, [payload]) ⇒ <code>Promise</code>
 Call a custom Api endpoit

lib/connectionConfig.js

@@ -513,6 +513,15 @@ ConnectionConfig.prototype.pullURL = function () {
   return purl;
 };
 
+/**
+ * Generate URL for pull endpoint
+ * @returns {string}
+ */
+ConnectionConfig.prototype.patchURL = function () {
+  const purl = this.branchBase('patch');
+  return purl;
+};
+
 /**
  * Generate URL for diff endpoint
  * @returns {string}

lib/dispatchRequest.js

@@ -172,7 +172,10 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
       }
       return axiosInstance
         .get(url, options)
-        .then((response) => (getDataVersion ? getResultWithDataVersion(response) : response.data))
+        .then((response) => {
+          const r = getDataVersion ? getResultWithDataVersion(response) : response.data;
+          return r;
+        })
         .catch((err) => {
           throw ErrorMessage.apiErrorFormatted(url, options, err);
         });
@@ -216,7 +219,10 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
       const compressedContentPost = checkPayload(payload, options, compress);
       return axiosInstance
         .post(url, compressedContentPost || payload || {}, options)
-        .then((response) => (getDataVersion ? getResultWithDataVersion(response) : response.data))
+        .then((response) => {
+          const r = getDataVersion ? getResultWithDataVersion(response) : response.data;
+          return r;
+        })
         .catch((err) => {
           throw ErrorMessage.apiErrorFormatted(url, options, err);
         });

lib/query/woqlQuery.js

@@ -786,16 +786,6 @@ WOQLQuery.prototype.as = function (...varList) {
   return this;
 };
 
-/* WOQLQuery.prototype.file = function (fpath, opts) {
-  // if (fpath && fpath == 'args') return ['file', 'format']
-  if (this.cursor['@type']) this.wrapCursorWithAnd();
-  this.cursor['@type'] = 'QueryResource';
-  this.cursor.source = { '@type': 'Source', file: fpath };
-  this.cursor.format = 'csv'; // hard coded for now
-  if (typeof opts !== 'undefined') this.cursor.options = opts;
-  return this;
-}; */
-
 /**
  * Identifies a remote resource by URL and specifies the format of the resource through the options
  * @param {object} remoteObj - The URL at which the remote resource can be accessed
@@ -1505,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]),
@@ -1548,9 +1538,9 @@ WOQLQuery.prototype.group_by = function (gvarlist, groupedvar, output, groupquer
   this.cursor['@type'] = 'GroupBy';
   this.cursor.group_by = [];
 
-  if (typeof gvarlist === 'string') gvarlist = [gvarlist];
+  if (typeof gvarlist === 'string' || gvarlist instanceof Var) gvarlist = [gvarlist];
   this.cursor.group_by = this.rawVarList(gvarlist);
-  if (typeof groupedvar === 'string') groupedvar = [groupedvar];
+  if (typeof groupedvar === 'string' || groupedvar instanceof Var) groupedvar = [groupedvar];
   this.cursor.template = this.rawVarList(groupedvar);
   this.cursor.grouped = this.varj(output);
   return this.addSubQuery(groupquery);

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);