Merge branch 'type_last' of https://github.com/terminusdb/terminusdb-client-js

Author: KittyJose

docs/api/woql.md

@@ -10,14 +10,14 @@ Every function matches one of the public api functions of the woql query object
 
 
 ## using
-##### WOQL.using(refPath, subquery) ⇒ <code>WOQLQuery</code>
+##### WOQL.using(refPath, [subquery]) ⇒ <code>WOQLQuery</code>
 Query running against any specific commit Id
 
 
 | Param | Type | Description |
 | --- | --- | --- |
 | refPath | <code>string</code> | path to specific reference Id or commit Id |
-| subquery | <code>WOQLQuery</code> | subquery for the specific commit point |
+| [subquery] | <code>WOQLQuery</code> | subquery for the specific commit point |
 
 **Example**  
 ```javascript
@@ -26,14 +26,14 @@ WOQL.using("userName/dbName/local/commit|branch/commitID").triple(a, b, c)
 ```
 
 ## comment
-##### WOQL.comment(comment, subquery) ⇒ <code>WOQLQuery</code>
+##### WOQL.comment(comment, [subquery]) ⇒ <code>WOQLQuery</code>
 Adds a text comment to a query - can also be used to wrap any part of a query to turn it off
 
 
 | Param | Type | Description |
 | --- | --- | --- |
 | comment | <code>string</code> | text comment |
-| subquery | <code>WOQLQuery</code> | query that is "commented out" |
+| [subquery] | <code>WOQLQuery</code> | query that is "commented out" |
 
 
 ## select
@@ -182,15 +182,15 @@ Specifies the database URL that will be the default database for the enclosed qu
 
 
 ## into
-##### WOQL.into(graphRef-, subquery) ⇒ <code>WOQLQuery</code>
+##### WOQL.into(graphRef-, [subquery]) ⇒ <code>WOQLQuery</code>
 Specifies the graph resource to write the contained query into
 
 **Returns**: <code>WOQLQuery</code> - A WOQLQuery which will be written into the graph in question  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | graphRef- | <code>typedef.GraphRef</code> | A valid graph resource identifier string |
-| subquery | <code>WOQLQuery</code> | The query which will be written into the graph |
+| [subquery] | <code>WOQLQuery</code> | The query which will be written into the graph |
 
 **Example**  
 ```javascript

index.js

@@ -9,6 +9,7 @@ const WOQLTable = require('./lib/viewer/woqlTable');
 const WOQLGraph = require('./lib/viewer/woqlGraph');
 const axiosInstance = require('./lib/axiosInstance');
 const AccessControl = require('./lib/accessControl');
+const WOQLQuery = require('./lib/query/woqlBuilder');
 
 module.exports = {
   Vars,
@@ -21,4 +22,5 @@ module.exports = {
   WOQLGraph,
   axiosInstance,
   AccessControl,
+  WOQLQuery,
 };

lib/query/woqlBuilder.js

@@ -10,15 +10,28 @@
  *
  */
 
-const WOQLQuery = require('./woqlQuery');
-const WOQLLibrary = require('./woqlLibrary');
+/**
+ * defines the internal functions of the woql query object - the
+ * language API is defined in WOQLQuery
+ * @module WOQLQuery
+ * @constructor
+ * @param {object} [query] json-ld query for initialisation
+ * @returns {WOQLQuery}
+ */
 
-WOQLQuery.prototype.counter = 1;
-/* class WOQLQuery extends WOQLQueryImp {
-    constructor(query) {
-        super(query)
-    }
-} */
+const WOQLQueryExt = require('./woqlQuery');
+// const WOQLLibrary = require('./woqlLibrary');
+
+class WOQLQuery extends WOQLQueryExt {
+  counter = 1;
+
+  // eslint-disable-next-line no-useless-constructor
+  constructor(query) {
+    super(query);
+  }
+}
+
+// WOQLQuery.prototype.counter = 1;
 
 /**
  * Simple composite functions which produce WOQL queries
@@ -38,9 +51,9 @@ WOQLQuery.prototype.all = function (Subj, Pred, Obj, Graph) {
   return this.star(Graph, Subj, Pred, Obj);
 };
 
-WOQLQuery.prototype.lib = function () {
+/* WOQLQuery.prototype.lib = function () {
   return new WOQLLibrary();
-};
+}; */
 
 WOQLQuery.prototype.string = function (s) {
   return { '@type': 'xsd:string', '@value': String(s) };

lib/query/woqlCore.js

@@ -24,7 +24,7 @@ const { Var, Vars, Doc } = require('./woqlDoc');
  * @param {object} [query] json-ld query for initialisation
  * @returns {WOQLQuery}
  */
-function WOQLQuery(query) {
+/* function WOQLQuery(query) {
   this.query = query || {};
   this.errors = [];
   this.cursor = this.query;
@@ -47,6 +47,53 @@ function WOQLQuery(query) {
   // object used to accumulate triples from fragments to support usage like node("x").label("y");
   this.tripleBuilder = false;
   return this;
+} */
+
+class WOQLQuery {
+  query = null;
+
+  errors = [];
+
+  cursor = {};
+
+  chain_ended = false;
+
+  contains_update = false;
+
+  // operators which preserve global paging
+  paging_transitive_properties = ['select', 'from', 'start', 'when', 'opt', 'limit'];
+
+  update_operators = [
+    'AddTriple',
+    'DeleteTriple',
+    'AddQuad',
+    'DeleteQuad',
+    'InsertDocument',
+    'DeleteDocument',
+    'UpdateDocument',
+  ];
+
+  vocab = this.loadDefaultVocabulary();
+
+  // object used to accumulate triples from fragments to support usage like node("x").label("y");
+  tripleBuilder = false;
+  /**
+   * defines the internal functions of the woql query object - the
+   * language API is defined in WOQLQuery
+   * @module WOQLQuery
+   * @constructor
+   * @param {object} [query] json-ld query for initialisation
+   * @returns {WOQLQuery}
+   */
+
+  constructor(query) {
+    this.query = query || {};
+    // this.errors = [];
+    this.cursor = this.query;
+
+    // eslint-disable-next-line no-constructor-return
+    return this;
+  }
 }
 
 /**

lib/query/woqlLibrary.js

@@ -1,5 +1,6 @@
 /// /@ts-check
-const WOQLQuery = require('./woqlCore');
+// we can not import woqlBuilder because woqlBuilder import WOQLLibrary
+const WOQLQuery = require('./woqlBuilder');
 
 /**
  * @license Apache Version 2
@@ -13,12 +14,16 @@ const WOQLQuery = require('./woqlCore');
  *  //or you can call this functions using WOQL Class
  *  WOQL.lib().branches()
  * */
-function WOQLLibrary() {
-  this.default_schema_resource = 'schema/main';
-  this.default_commit_resource = '_commits';
-  this.default_meta_resource = '_meta';
-  this.masterdb_resource = '_system';
-  this.empty = '';
+class WOQLLibrary {
+  default_schema_resource = 'schema/main';
+
+  default_commit_resource = '_commits';
+
+  default_meta_resource = '_meta';
+
+  masterdb_resource = '_system';
+
+  empty = '';
 }
 
 /**

lib/query/woqlQuery.js

@@ -1,3 +1,4 @@
+/* eslint-disable class-methods-use-this */
 /* eslint-disable no-redeclare */
 /* eslint-disable block-scoped-var */
 /* eslint-disable no-var */
@@ -11,15 +12,48 @@
 /* eslint-disable no-restricted-syntax */
 /// /@ts-check
 // WOQLQuery
-const WOQLQuery = require('./woqlCore');
+/**
+ * defines the internal functions of the woql query object - the
+ * language API is defined in WOQLQuery
+ * @module WOQLQuery
+ * @constructor
+ * @param {object} [query] json-ld query for initialisation
+ * @returns {WOQLQuery}
+ */
+
+const WOQLCore = require('./woqlCore');
 const { Var, Vars, Doc } = require('./woqlDoc');
 
 // I HAVE TO REVIEW THE Inheritance and the prototype chain
-/* class WOQLQuery extends WOQLCore {
-    constructor(query) {
-        super(query)
-    }
-} */
+class WOQLQuery extends WOQLCore {
+  /**
+ * defines the internal functions of the woql query object - the
+ * language API is defined in WOQLQuery
+ * @module WOQLQuery
+ * @constructor
+ * @param {object} [query] json-ld query for initialisation
+ * @returns {WOQLQuery}
+ */
+
+  update_triple(subject, predicate, new_object, old_object) {}
+
+  star(Graph, Subj, Pred, Obj) {}
+
+  update_quad(subject, predicate, new_object, graph) {}
+
+  insert(id, type, refGraph) {}
+
+  graph(g) {}
+
+  node(node, type) {}
+
+  nuke(g) {}
+
+  // eslint-disable-next-line no-useless-constructor
+  constructor(query) {
+    super(query);
+  }
+}
 
 WOQLQuery.prototype.read_document = function (IRI, OutputVar) {
   if (this.cursor['@type']) this.wrapCursorWithAnd();

lib/viewer/tableConfig.js

@@ -31,6 +31,12 @@ WOQLTableConfig.prototype.json = function () {
   if (typeof this.renderer() !== 'undefined') {
     conf.renderer = this.renderer();
   }
+  if (typeof this.filter() !== 'undefined') {
+    conf.filter = this.filter();
+  }
+  if (typeof this.filterable() !== 'undefined') {
+    conf.filterable = this.filterable();
+  }
   if (typeof this.pager() !== 'undefined') {
     conf.pager = this.pager();
   }
@@ -68,6 +74,12 @@ WOQLTableConfig.prototype.loadJSON = function (config, rules) {
   if (typeof config.renderer !== 'undefined') {
     this.renderer(config.renderer);
   }
+  if (typeof config.filter !== 'undefined') {
+    this.filter(config.filter);
+  }
+  if (typeof config.filterable !== 'undefined') {
+    this.filterable(config.filterable);
+  }
   if (typeof config.bindings !== 'undefined') {
     this.bindings(config.bindings);
   }
@@ -111,6 +123,27 @@ WOQLTableConfig.prototype.prettyPrint = function () {
   return str;
 };
 
+/**
+ * @param {boolean} canfilter
+ * @returns  WOQLTableConfig
+ */
+
+WOQLTableConfig.prototype.filterable = function (canfilter) {
+  if (!canfilter && canfilter !== false) return this.tfilterable;
+  this.tfilterable = canfilter;
+  return this;
+};
+
+/*
+* default is string
+* filter type number | list | date
+*/
+WOQLTableConfig.prototype.filter = function (filter) {
+  if (!filter) return this.tfilter;
+  this.tfilter = filter;
+  return this;
+};
+
 WOQLTableConfig.prototype.renderer = function (rend) {
   if (!rend) return this.trenderer;
   this.trenderer = rend;
@@ -196,6 +229,22 @@ WOQLTableRule.prototype.header = function (hdr) {
   return this;
 };
 
+WOQLTableRule.prototype.filter = function (hdr) {
+  if (typeof hdr === 'undefined') {
+    return this.rule.filter;
+  }
+  this.rule.filter = hdr;
+  return this;
+};
+
+WOQLTableRule.prototype.filterable = function (hdr) {
+  if (typeof hdr === 'undefined') {
+    return this.rule.filterable;
+  }
+  this.rule.filterable = hdr;
+  return this;
+};
+
 WOQLTableRule.prototype.width = function (wid) {
   if (typeof wid === 'undefined') {
     return this.rule.width;

lib/viewer/terminusRule.js

@@ -112,6 +112,7 @@ TerminusPattern.prototype.testBasics = function (scope, value) {
 };
 
 TerminusPattern.prototype.testValue = function (value, constraint) {
+  if (!value) return null;
   const vundertest = (value['@value'] ? value['@value'] : value);
   if (typeof constraint === 'function') return constraint(vundertest);
   // eslint-disable-next-line no-param-reassign