Type last (#250)

* fix fetch in javascript client#249

* Apply docs changes

* review type

Co-authored-by: Francesca-Bit <[email protected]>
Co-authored-by: Francesca-Bit <[email protected]>

Author: Francesca-Bit

docs/api/typedef.md

@@ -146,7 +146,7 @@ the DELETE document interface query parameters
 | --- | --- | --- |
 | label | <code>string</code> | "Textual DB Name" |
 | [comment] | <code>string</code> | "Text description of DB" |
-| [public] | <code>boolean</code> |  |
+| [public] | <code>boolean</code> | - |
 | [schema] | <code>boolean</code> | if set to true, a schema graph will be created |
 
 

docs/api/woql.md

@@ -447,10 +447,9 @@ WOQL.delete_quad("Person", "rdf:type", "sys:Class", "schema")
 ```
 
 ## add_triple
-##### WOQL.add\_triple(subject, predicate, object) ⇒ <code>object</code>
+##### WOQL.add\_triple(subject, predicate, object) ⇒ <code>WOQLQuery</code>
 Adds triples according to the the pattern [subject,predicate,object]
 
-**Returns**: <code>object</code> - WOQLQuery  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -460,10 +459,9 @@ Adds triples according to the the pattern [subject,predicate,object]
 
 
 ## add_quad
-##### WOQL.add\_quad(subject, predicate, object, graphRef-) ⇒ <code>object</code>
+##### WOQL.add\_quad(subject, predicate, object, graphRef-) ⇒ <code>WOQLQuery</code>
 Adds quads according to the pattern [S,P,O,G]
 
-**Returns**: <code>object</code> - WOQLQuery  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -1521,8 +1519,7 @@ Update a pattern matching rule for the quad [S, P, O, G] (Subject, Predicate, Ob
 
 ## value
 ##### WOQL.value(subject, predicate, objValue) ⇒ <code>WOQLQuery</code>
-Creates a pattern matching rule for a quad [Subject, Predicate, Object, Graph] or for a
-triple [Subject, Predicate, Object]
+Creates a pattern matching rule for a triple [Subject, Predicate, Object]
 add extra information about the type of the value object
 
 **Returns**: <code>WOQLQuery</code> - A WOQLQuery which contains the a quad or a triple Statement  
@@ -1536,8 +1533,7 @@ add extra information about the type of the value object
 
 ## link
 ##### WOQL.link(subject, predicate, object) ⇒ <code>WOQLQuery</code>
-Creates a pattern matching rule for a quad [Subject, Predicate, Object, Graph] or for a
-triple [Subject, Predicate, Object]
+Creates a pattern matching rule for a triple [Subject, Predicate, Object]
 
 **Returns**: <code>WOQLQuery</code> - A WOQLQuery which contains the a quad or a triple Statement  
 

lib/dispatchRequest.js

@@ -46,6 +46,17 @@ function formatAuthHeader(auth_obj) {
   return `${authType[auth_obj.type]} ${auth_key}`;
 }
 
+function checkPayload(payload, options, compress) {
+  if (!payload || typeof payload !== 'object') return false;
+  const jsonStringPost = JSON.stringify(payload);
+  if (jsonStringPost && jsonStringPost.length > 1024 && compress) {
+    // eslint-disable-next-line no-param-reassign
+    options.headers['Content-Encoding'] = 'gzip';
+    return pako.gzip(jsonStringPost);
+  }
+  return false;
+}
+
 /**
  * @file Dispatch Request
  * @license Apache Version 2
@@ -195,16 +206,11 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
       // eslint-disable-next-line no-fallthrough
     }
     default: {
-      let compressedContentPost = null;
       options.headers = options.headers ? options.headers : {};
       options.headers['Content-Type'] = 'application/json; charset=utf-8';
-      const jsonStringPost = JSON.stringify(payload);
-      if (jsonStringPost.length > 1024 && compress) {
-        options.headers['Content-Encoding'] = 'gzip';
-        compressedContentPost = pako.gzip(jsonStringPost);
-      }
+      const compressedContentPost = checkPayload(payload, options, compress);
       return axiosInstance
-        .post(url, compressedContentPost || payload, options)
+        .post(url, compressedContentPost || payload || {}, options)
         .then((response) => (getDataVersion ? getResultWithDataVersion(response) : response.data))
         .catch((err) => {
           throw ErrorMessage.apiErrorFormatted(url, options, err);

lib/query/woqlBuilder.js

@@ -63,14 +63,9 @@ WOQLQuery.prototype.all = function (Subj, Pred, Obj, Graph) {
   return this.star(Graph, Subj, Pred, Obj);
 };
 
-/* WOQLQuery.prototype.lib = function () {
-  return new WOQLLibrary();
-}; */
-
 /**
  * @param {string} s
  * @returns {object}
- * @example
  */
 
 WOQLQuery.prototype.string = function (s) {
@@ -80,7 +75,6 @@ WOQLQuery.prototype.string = function (s) {
 /**
  * @param {boolean} tf
  * @returns {object}
- * @example
  */
 
 WOQLQuery.prototype.boolean = function (tf) {
@@ -92,7 +86,6 @@ WOQLQuery.prototype.boolean = function (tf) {
  * @param {any} s
  * @param {string} t
  * @returns {object}
- * @example
  */
 WOQLQuery.prototype.literal = function (s, t) {
   t = t.indexOf(':') === -1 ? `xsd:${t}` : t;
@@ -102,7 +95,6 @@ WOQLQuery.prototype.literal = function (s, t) {
 /**
  * @param {string} s
  * @returns {object}
- * @example
  */
 
 WOQLQuery.prototype.iri = function (s) {
@@ -162,13 +154,15 @@ WOQLQuery.prototype.update_quad = function (subject, predicate, new_object, grap
 };
 
 /**
- * Removes all triples from a graph
- * @param {string} [g] - optional graph resource identifier
+ * Deletes all triples in the passed graph (defaults to instance/main)
+ * @param {typedef.GraphRef} [graphRef] - Resource String identifying the graph from
+ * which all triples will be removed
+ * @returns {WOQLQuery} - A WOQLQuery which contains the deletion expression
  */
 
-WOQLQuery.prototype.nuke = function (g) {
-  if (g) {
-    return this.quad('v:A', 'v:B', 'v:C', g).delete_quad('v:A', 'v:B', 'v:C', g);
+WOQLQuery.prototype.nuke = function (graphRef) {
+  if (graphRef) {
+    return this.quad('v:A', 'v:B', 'v:C', graphRef).delete_quad('v:A', 'v:B', 'v:C', graphRef);
   }
   return this.triple('v:A', 'v:B', 'v:C').delete_triple('v:A', 'v:B', 'v:C');
 };
@@ -198,12 +192,13 @@ WOQLQuery.prototype.node = function (node, type) {
   return this;
 };
 
+// do not remove
 /**
- * set the graph type schema or instance
- * for the query we point at the instance graph so you use this only
- * if you would like to query the schema graph
+ * Sets the graph resource ID that will be used for subsequent chained function calls
+ * @param {typedef.GraphRef} [graphRef] Resource String identifying the graph which will
+ * be used for subsequent chained schema calls
+ * @returns {WOQLQuery} A WOQLQuery which contains the partial Graph pattern matching expression
  */
-// do not remove
 WOQLQuery.prototype.graph = function (g) {
   return this._set_context({
     graph: g,