Type last (#241)

* review table

* review woql for typescript

* Apply docs changes

* review type declaration

* review types definition

* Apply docs changes

* review types definition

* review types definition

Co-authored-by: Francesca-Bit <francesca@terminusdb.com>
Co-authored-by: Francesca-Bit <Francesca-Bit@users.noreply.github.com>

Author: Francesca-Bit

docs/api/woql.md

@@ -1,5 +1,5 @@
 /* eslint-disable global-require */
-const Vars = require('./lib/query/woqlDoc');
+const { Var, Vars, Doc } = require('./lib/query/woqlDoc');
 const WOQLClient = require('./lib/woqlClient');
 const UTILS = require('./lib/utils');
 const View = require('./lib/viewer/woqlView');
@@ -9,8 +9,11 @@ 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 = {
+  Var,
+  Doc,
   Vars,
   WOQLClient,
   UTILS,
@@ -21,4 +24,5 @@ module.exports = {
   WOQLGraph,
   axiosInstance,
   AccessControl,
+  WOQLQuery,
 };

index.js

@@ -10,16 +10,33 @@
  *
  */
 
-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 {
+  // eslint-disable-next-line no-useless-constructor
+  constructor(query) {
+    super(query);
+  }
+}
 
+// WOQLQuery.prototype.counter = 1;
+/**
+ * @param {typedef.GraphRef} [Graph] - the resource identifier of a graph possible
+ * @param {string|Var} [Subj] - The IRI of a triple’s subject or a variable
+ * @param {string|Var} [Pred] - The IRI of a property or a variable
+ * @param {string|Var} [Obj] - The IRI of a node or a variable, or a literal
+ * @returns {WOQLQuery} - A WOQLQuery which contains the pattern matching expression
+ */
 /**
  * Simple composite functions which produce WOQL queries
  */
@@ -34,35 +51,77 @@ WOQLQuery.prototype.star = function (Graph, Subj, Pred, Obj) {
   return this.triple(Subj, Pred, Obj);
 };
 
+/**
+ * @param {string|Var} [Subj] - The IRI of a triple’s subject or a variable
+ * @param {string|Var} [Pred] - The IRI of a property or a variable
+ * @param {string|Var} [Obj] - The IRI of a node or a variable, or a literal
+ * @param {typedef.GraphRef} [Graph] - the resource identifier of a graph possible
+ * @returns {WOQLQuery} - A WOQLQuery which contains the pattern matching expression
+ */
+
 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();
-};
+}; */
+
+/**
+ * @param {string} s
+ * @returns {object}
+ * @example
+ */
 
 WOQLQuery.prototype.string = function (s) {
   return { '@type': 'xsd:string', '@value': String(s) };
 };
 
+/**
+ * @param {boolean} tf
+ * @returns {object}
+ * @example
+ */
+
 WOQLQuery.prototype.boolean = function (tf) {
   tf = tf || false;
   return this.literal(tf, 'boolean');
 };
 
+/**
+ * @param {any} s
+ * @param {string} t
+ * @returns {object}
+ * @example
+ */
 WOQLQuery.prototype.literal = function (s, t) {
   t = t.indexOf(':') === -1 ? `xsd:${t}` : t;
   return { '@type': t, '@value': s };
 };
 
+/**
+ * @param {string} s
+ * @returns {object}
+ * @example
+ */
+
 WOQLQuery.prototype.iri = function (s) {
   return {
     '@type': 'NodeValue',
     node: s,
   };
 };
 
+/**
+ * Update a pattern matching rule for the triple (Subject, Predicate, oldObjValue) with the
+ * new one (Subject, Predicate, newObjValue)
+ * @param {string|Var} subject - The IRI of a triple’s subject or a variable
+ * @param {string|Var} predicate - The IRI of a property or a variable
+ * @param {string|Var} newObjValue - The value to update or a literal
+ * @param {string|Var} oldObjValue - The old value of the object
+ * @returns {WOQLQuery} A WOQLQuery which contains the a Update Triple Statement
+ */
+
 WOQLQuery.prototype.update_triple = function (subject, predicate, new_object, old_object) {
   const tmp_name = old_object || `v:AnyObject__${this.counter += 1}`;
   return this.and(
@@ -104,7 +163,7 @@ WOQLQuery.prototype.update_quad = function (subject, predicate, new_object, grap
 
 /**
  * Removes all triples from a graph
- * @param {string} g - optional graph resource identifier
+ * @param {string} [g] - optional graph resource identifier
  */
 
 WOQLQuery.prototype.nuke = function (g) {
@@ -114,6 +173,16 @@ WOQLQuery.prototype.nuke = function (g) {
   return this.triple('v:A', 'v:B', 'v:C').delete_triple('v:A', 'v:B', 'v:C');
 };
 
+/**
+ *
+ * @param {string|Var} node -  The IRI of a node or a variable containing an IRI which will
+ * be the subject of the builder functions
+ * @param {typedef.FuntionType} [type] - Optional type of builder function to build
+ * (default is triple)
+ * @returns {WOQLQuery} - A WOQLQuery which contains the partial Node pattern matching expression
+ * @example
+ */
+
 WOQLQuery.prototype.node = function (node, type) {
   type = type || false;
   if (type === 'add_quad') type = 'AddTriple';
@@ -151,6 +220,13 @@ WOQLQuery.prototype._set_context = function (ctxt) {
   return this;
 };
 
+/**
+ * @param {string|Var} id - IRI string or variable containing
+ * @param {string|Var} type  -  IRI string or variable containing the IRI of the
+ * @param {typedef.GraphRef} [refGraph] - Optional Graph resource identifier
+ * @returns {WOQLQuery} A WOQLQuery which contains the insert expression
+ */
+
 WOQLQuery.prototype.insert = function (id, type, refGraph) {
   refGraph = refGraph || (this.triple_builder_context ? this.triple_builder_context.graph : false);
   if (refGraph) {

lib/query/woqlBuilder.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,57 @@ 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 {
+  triple_builder_context = {};
+
+  query = null;
+
+  counter = 1;
+
+  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/woqlCore.js

@@ -66,20 +66,37 @@ function convert(obj) {
   }
 }
 
+/**
+ * @param {string} name
+ * @returns
+ */
 function Var(name) {
   this.name = name;
 }
 
+/**
+ * @param {object} name
+ * @returns {object}
+ */
 function Doc(obj) {
   this.doc = obj;
   this.encoded = convert(obj);
+  return this.encoded;
 }
 
+/**
+* @param  {...string} varNames
+* @returns {object<Var>}
+*/
 function Vars(...args) {
+  const varObj = {};
   for (let i = 0, j = arguments.length; i < j; i += 1) {
     const argumentName = args[i];
-    this[argumentName] = new Var(argumentName);
+
+    // this[argumentName] = new Var(argumentName);
+    varObj[argumentName] = new Var(argumentName);
   }
+  return varObj;
 }
 
 module.exports = { Vars, Var, Doc };

lib/query/woqlDoc.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 = '';
 }
 
 /**