review woql for typescript

Author: Francesca-Bit

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/woql.js

@@ -3,6 +3,7 @@
 /// /@ts-check
 // I HAVE TO REVIEW THE Inheritance and the prototype chain
 const WOQLQuery = require('./query/woqlBuilder');
+const WOQLLibrary = require('./query/woqlLibrary');
 const { Vars, Var, Doc } = require('./query/woqlDoc');
 /**
  * @license Apache Version 2
@@ -46,7 +47,7 @@ WOQL.using = function (refPath, subquery) {
 /**
  * Adds a text comment to a query - can also be used to wrap any part of a query to turn it off
  * @param {string} comment - text comment
- * @param {WOQLQuery} subquery  - query that is "commented out"
+ * @param {WOQLQuery} [subquery]  - query that is "commented out"
  * @returns {WOQLQuery}
  */
 WOQL.comment = function (comment, subquery) {
@@ -187,7 +188,7 @@ WOQL.from = function (graphRef, query) {
 /**
  * Specifies the graph resource to write the contained query into
  * @param {typedef.GraphRef} graphRef- A valid graph resource identifier string
- * @param {WOQLQuery} subquery - The query which will be written into the graph
+ * @param {WOQLQuery} [subquery] - The query which will be written into the graph
  * @returns {WOQLQuery} A WOQLQuery which will be written into the graph in question
  * @example
  * //Subq is an argument or a chained query
@@ -1241,7 +1242,7 @@ WOQL.json = function (JSON_LD) {
  * const query = WOQL.lib().branches()
  */
 WOQL.lib = function () {
-  return new WOQLQuery().lib();
+  return new WOQLLibrary();
 };
 
 /**

lib/woqlClient.js

@@ -11,7 +11,7 @@ const DispatchRequest = require('./dispatchRequest');
 const ErrorMessage = require('./errorMessage');
 const ConnectionConfig = require('./connectionConfig');
 const WOQL = require('./woql');
-const WOQLQuery = require('./query/woqlBuilder');
+const WOQLQuery = require('./query/woqlCore');
 
 /**
  * @license Apache Version 2
@@ -1199,6 +1199,8 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
     delete params.query;
   }
   // if query we are send a get with a payload
+  console.log(this.connectionConfig.documentURL(params));
+
   if (queryDoc) {
     return this.dispatch(
       CONST.QUERY_DOCUMENT,