refactored code for generating type definations

Neelterminusdb · Neelterminusdb · commit 9dcfc1c19151 · 2022-05-07T17:04:44.000+05:30
Signed-off-by: NeelParihar &lt;neel@terminusdb.com&gt;
diff --git a/lib/query/woqlCore.js b/lib/query/woqlCore.js
@@ -22,6 +22,7 @@ const { Var, Doc } = require('./woqlDoc');
  * @module WOQLQuery
  * @constructor
  * @param {object} [query] json-ld query for initialisation
+ * @returns {WOQLQuery}
  */
 function WOQLQuery(query) {
   this.query = query || {};
diff --git a/lib/typedef.js b/lib/typedef.js
@@ -93,6 +93,7 @@
  * @property {string} [branch] - set branch to this id
  * @property {string} [ref]    - set commit ref
  * @property {string} [default_branch_id] - set the default branch id
+ * @property {string} [token] - Api token to connect with TerminusX
  */
 
 /**
diff --git a/lib/viewer/chartConfig.js b/lib/viewer/chartConfig.js
@@ -10,8 +10,7 @@ function WOQLChartConfig() {
   this.type = 'chart';
 }
 
-WOQLChartConfig.prototype = Object.create(Config.ViewConfig.prototype);
-WOQLChartConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(WOQLChartConfig.prototype, Config.ViewConfig.prototype);
 
 WOQLChartConfig.prototype.prettyPrint = function () {
   let str = 'view = View.chart();\n';
@@ -214,8 +213,7 @@ function WOQLChartRule() {
   Config.WOQLViewRule.call(this);
 }
 
-WOQLChartRule.prototype = Object.create(Config.WOQLViewRule.prototype);
-WOQLChartRule.prototype.constructor = Config.WOQLViewRule;
+Object.setPrototypeOf(WOQLChartRule.prototype, Config.WOQLViewRule.prototype);
 
 WOQLChartRule.prototype.style = function (key, value) {
   if (value) {
diff --git a/lib/viewer/chooserConfig.js b/lib/viewer/chooserConfig.js
@@ -9,8 +9,7 @@ function WOQLChooserConfig() {
   this.type = 'chooser';
 }
 
-WOQLChooserConfig.prototype = Object.create(Config.ViewConfig.prototype);
-WOQLChooserConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(WOQLChooserConfig.prototype, Config.ViewConfig.prototype);
 
 WOQLChooserConfig.prototype.create = function (client) {
   const wqt = new WOQLChooser(client, this);
@@ -180,8 +179,7 @@ function WOQLChooserRule(scope) {
   Config.WOQLViewRule.call(this, scope);
 }
 
-WOQLChooserRule.prototype = Object.create(Config.WOQLViewRule.prototype);
-WOQLChooserRule.prototype.constructor = Config.WOQLViewRule;
+Object.setPrototypeOf(WOQLChooserRule.prototype, Config.WOQLViewRule.prototype);
 
 WOQLChooserRule.prototype.label = function (l) {
   if (l) {
diff --git a/lib/viewer/frameConfig.js b/lib/viewer/frameConfig.js
@@ -10,7 +10,7 @@
 /* eslint-disable no-plusplus */
 /* eslint-disable import/extensions */
 const Config = require('./viewConfig.js');
-const FrameRule = require('./frameRule.js');
+const { FrameRule } = require('./frameRule.js');
 const DocumentFrame = require('./documentFrame.js');
 
 /**
@@ -22,8 +22,7 @@ function FrameConfig() {
   this.type = 'document';
 }
 
-FrameConfig.prototype = Object.create(Config.ViewConfig.prototype);
-FrameConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(FrameConfig.prototype, Config.ViewConfig.prototype);
 
 FrameConfig.prototype.create = function (client) {
   const tf = new DocumentFrame(client, this);
@@ -192,8 +191,7 @@ function DocumentRule() {
   this.rule = {};
 }
 
-DocumentRule.prototype = Object.create(FrameRule.prototype);
-DocumentRule.prototype.constructor = FrameRule;
+Object.setPrototypeOf(DocumentRule.prototype, FrameRule.prototype);
 
 DocumentRule.prototype.renderer = function (rend) {
   if (typeof rend === 'undefined') {
diff --git a/lib/viewer/frameRule.js b/lib/viewer/frameRule.js
@@ -17,8 +17,8 @@ function FrameRule() {
   TerminusRule.TerminusRule.call(this);
   this.pattern = new FramePattern();
 }
-FrameRule.prototype = Object.create(TerminusRule.TerminusRule.prototype);
-FrameRule.prototype.constructor = TerminusRule.TerminusRule;
+
+Object.setPrototypeOf(FrameRule.prototype, TerminusRule.TerminusRule.prototype);
 
 /**
  * Returns an array of rules that match the paased frame
@@ -189,8 +189,7 @@ function FramePattern() {
   TerminusRule.TerminusPattern.call(this);
 }
 
-FramePattern.prototype = Object.create(TerminusRule.TerminusPattern.prototype);
-FramePattern.prototype.constructor = TerminusRule.TerminusPattern;
+Object.setPrototypeOf(FramePattern.prototype, TerminusRule.TerminusPattern.prototype);
 
 FramePattern.prototype.setPattern = function (pattern) {
   if (pattern.scope) this.scope = pattern.scope;
@@ -513,4 +512,4 @@ FramePattern.prototype.getRendererType = function (frame) {
   return false;
 };
 
-module.exports = FrameRule;
+module.exports = { FrameRule, FramePattern };
diff --git a/lib/viewer/graphConfig.js b/lib/viewer/graphConfig.js
@@ -13,8 +13,7 @@ function WOQLGraphConfig() {
   this.type = 'graph';
 }
 
-WOQLGraphConfig.prototype = Object.create(Config.ViewConfig.prototype);
-WOQLGraphConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(WOQLGraphConfig.prototype, Config.ViewConfig.prototype);
 
 WOQLGraphConfig.prototype.create = function (client) {
   const wqt = new WOQLGraph(client, this);
@@ -107,6 +106,11 @@ WOQLGraphConfig.prototype.height = function (size) {
   return this.gheight;
 };
 
+/**
+ *
+ * @param  {...any} edges
+ * @returns {any[][]}
+ */
 WOQLGraphConfig.prototype.edges = function (...edges) {
   if (edges && edges.length) {
     const nedges = [];
@@ -265,8 +269,7 @@ function WOQLGraphRule(scope) {
   Config.WOQLViewRule.call(this, scope);
 }
 
-WOQLGraphRule.prototype = Object.create(Config.WOQLViewRule.prototype);
-WOQLGraphRule.prototype.constructor = Config.WOQLViewRule;
+Object.setPrototypeOf(WOQLGraphRule.prototype, Config.WOQLViewRule.prototype);
 
 WOQLGraphRule.prototype.charge = function (v) {
   if (typeof v === 'undefined') {
diff --git a/lib/viewer/objectFrame.js b/lib/viewer/objectFrame.js
@@ -15,7 +15,7 @@
 /* eslint-disable no-restricted-syntax */
 /* eslint-disable no-use-before-define */
 const FrameHelper = require('../utils');
-const FrameRule = require('./frameRule');
+const { FrameRule } = require('./frameRule');
 const WOQL = require('../woql');
 
 /**
diff --git a/lib/viewer/streamConfig.js b/lib/viewer/streamConfig.js
@@ -6,8 +6,7 @@ function WOQLStreamConfig() {
   this.type = 'stream';
 }
 
-WOQLStreamConfig.prototype = Object.create(Config.ViewConfig.prototype);
-WOQLStreamConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(WOQLStreamConfig.prototype, Config.ViewConfig.prototype);
 
 WOQLStreamConfig.prototype.create = function (client) {
   const wqt = new WOQLStream(client, this);
@@ -72,8 +71,7 @@ function WOQLStreamRule() {
   Config.WOQLViewRule.call(this);
 }
 
-WOQLStreamRule.prototype = Object.create(Config.WOQLViewRule.prototype);
-WOQLStreamRule.prototype.constructor = Config.WOQLViewRule;
+Object.setPrototypeOf(WOQLStreamRule.prototype, Config.WOQLViewRule.prototype);
 
 WOQLStreamRule.prototype.template = function (template) {
   if (!template) return this.rule.template;
diff --git a/lib/viewer/tableConfig.js b/lib/viewer/tableConfig.js
@@ -9,8 +9,7 @@ function WOQLTableConfig() {
   this.type = 'table';
 }
 
-WOQLTableConfig.prototype = Object.create(Config.ViewConfig.prototype);
-WOQLTableConfig.prototype.constructor = Config.ViewConfig;
+Object.setPrototypeOf(WOQLTableConfig.prototype, Config.ViewConfig.prototype);
 
 WOQLTableConfig.prototype.create = function (client) {
   const wqt = new WOQLTable(client, this);
@@ -121,6 +120,10 @@ WOQLTableConfig.prototype.header = function (theader) {
   return this;
 };
 
+/**
+ * @param  {...any} val
+ * @returns {object}
+ */
 WOQLTableConfig.prototype.column_order = function (...val) {
   if (typeof val === 'undefined' || val.length === 0) {
     return this.order;
@@ -180,8 +183,7 @@ function WOQLTableRule() {
   Config.WOQLViewRule.call(this);
 }
 
-WOQLTableRule.prototype = Object.create(Config.WOQLViewRule.prototype);
-WOQLTableRule.prototype.constructor = Config.WOQLViewRule;
+Object.setPrototypeOf(WOQLTableRule.prototype, Config.WOQLViewRule.prototype);
 
 WOQLTableRule.prototype.header = function (hdr) {
   if (typeof hdr === 'undefined') {
diff --git a/lib/viewer/viewConfig.js b/lib/viewer/viewConfig.js
@@ -1,5 +1,5 @@
 /// /@ts-check
-const WOQLRule = require('./woqlRule');
+const { WOQLRule } = require('./woqlRule');
 
 /**
  * Generic functions / configs that are available to all config types
@@ -73,8 +73,7 @@ function WOQLViewRule() {
   this.rule = {};
 }
 
-WOQLViewRule.prototype = Object.create(WOQLRule.prototype);
-WOQLViewRule.prototype.constructor = WOQLRule;
+Object.setPrototypeOf(WOQLViewRule.prototype, WOQLRule.prototype);
 
 WOQLViewRule.prototype.prettyPrint = function (type) {
   let str = '';
diff --git a/lib/viewer/woqlChooser.js b/lib/viewer/woqlChooser.js
@@ -4,11 +4,14 @@
 /* eslint-disable no-undef */
 const WOQLChooserConfig = require('./chooserConfig');
 const UTILS = require('../utils');
-const WOQLRule = require('./woqlRule');
+const { WOQLRule } = require('./woqlRule');
 
-/*
+/**
  * Very simple implementation of a WOQL backed chooser
  * Makes a drop down from a WOQL query - configuration tells it which columns to use...
+ * @param {WOQLClient} client
+ * @param {WOQLChooserConfig} config
+ * @returns {WOQLChooser}
  */
 function WOQLChooser(client, config) {
   this.client = client;
diff --git a/lib/viewer/woqlGraph.js b/lib/viewer/woqlGraph.js
@@ -10,7 +10,7 @@
 /* eslint-disable no-plusplus */
 const WOQLGraphConfig = require('./graphConfig');
 const UTILS = require('../utils');
-const WOQLRule = require('./woqlRule');
+const { WOQLRule } = require('./woqlRule');
 
 function WOQLGraph(client, config) {
   this.client = client;
diff --git a/lib/viewer/woqlRule.js b/lib/viewer/woqlRule.js
@@ -17,8 +17,7 @@ function WOQLRule() {
   TerminusRule.TerminusRule.call(this);
   this.pattern = new WOQLPattern();
 }
-WOQLRule.prototype = Object.create(TerminusRule.TerminusRule.prototype);
-WOQLRule.prototype.constructor = TerminusRule.TerminusRule;
+Object.setPrototypeOf(WOQLRule.prototype, TerminusRule.TerminusRule.prototype);
 
 /**
  * Specifies that the rule only applies to specific variables returned by the WOQL query
@@ -190,8 +189,7 @@ WOQLRule.prototype.matchEdge = WOQLRule.prototype.matchPair;
 function WOQLPattern(pattern) {
   TerminusRule.TerminusPattern.call(this, pattern);
 }
-WOQLPattern.prototype = Object.create(TerminusRule.TerminusPattern.prototype);
-WOQLPattern.prototype.constructor = TerminusRule.TerminusPattern;
+Object.setPrototypeOf(WOQLPattern.prototype, TerminusRule.TerminusPattern.prototype);
 
 WOQLPattern.prototype.prettyPrint = function () {
   // starts with obj. ...
@@ -311,4 +309,4 @@ WOQLPattern.prototype.json = function () {
   return json;
 };
 
-module.exports = WOQLRule;
+module.exports = { WOQLRule, WOQLPattern };
diff --git a/lib/viewer/woqlStream.js b/lib/viewer/woqlStream.js
@@ -1,5 +1,10 @@
 const WOQLStreamConfig = require('./streamConfig');
 
+/**
+ * @param {WOQLClient} client
+ * @param {WOQLStreamConfig} config
+ * @returns {WOQLStream}
+ */
 function WOQLStream(client, config) {
   this.client = client;
   this.config = (config || new WOQLStreamConfig());
diff --git a/lib/viewer/woqlTable.js b/lib/viewer/woqlTable.js
@@ -9,7 +9,7 @@
 /* eslint-disable no-unused-vars */
 const WOQLTableConfig = require('./tableConfig');
 const UTILS = require('../utils');
-const WOQLRule = require('./woqlRule');
+const { WOQLRule } = require('./woqlRule');
 const WOQLResult = require('./woqlResult');
 const WOQLClient = require('../woqlClient');
 
diff --git a/lib/viewer/woqlView.js b/lib/viewer/woqlView.js
@@ -4,8 +4,8 @@ const WOQLGraphConfig = require('./graphConfig');
 const WOQLChartConfig = require('./chartConfig');
 const WOQLStreamConfig = require('./streamConfig');
 const FrameConfig = require('./frameConfig');
-const WOQLRule = require('./woqlRule');
-const FrameRule = require('./frameRule');
+const { WOQLRule } = require('./woqlRule');
+const { FrameRule } = require('./frameRule');
 
 /**
  * @constructor
diff --git a/lib/woql.js b/lib/woql.js
@@ -282,7 +282,9 @@ WOQL.sub = function (classA, classB) {
   return new WOQLQuery().sub(classA, classB);
 };
 
-WOQL.subsumption = WOQL.sub;
+WOQL.subsumption = function (classA, classB) {
+  return new WOQLQuery().sub(classA, classB);
+};
 
 /**
  * Matches if a is equal to b
@@ -295,7 +297,9 @@ WOQL.subsumption = WOQL.sub;
 WOQL.eq = function (varName, varValue) {
   return new WOQLQuery().eq(varName, varValue);
 };
-WOQL.equals = WOQL.eq;
+WOQL.equals = function (varName, varValue) {
+  return new WOQLQuery().eq(varName, varValue);
+};
 
 /**
  * Substring
@@ -310,7 +314,9 @@ WOQL.equals = WOQL.eq;
 WOQL.substr = function (string, before, length, after, substring) {
   return new WOQLQuery().substr(string, before, length, after, substring);
 };
-WOQL.substring = WOQL.substr;
+WOQL.substring = function (string, before, length, after, substring) {
+  return new WOQLQuery().substr(string, before, length, after, substring);
+};
 
 /**
  * Retrieves the exernal resource defined by QueryResource and copies values
@@ -503,7 +509,9 @@ WOQL.evaluate = function (arithExp, resultVarName) {
  * @returns {WOQLQuery} WOQLQuery
  */
 
-WOQL.eval = WOQL.evaluate;
+WOQL.eval = function (arithExp, resultVarName) {
+  return new WOQLQuery().eval(arithExp, resultVarName);
+};
 
 /**
  *
@@ -683,7 +691,9 @@ WOQL.opt = function (subquery) {
   return new WOQLQuery().opt(subquery);
 };
 
-WOQL.optional = WOQL.opt;
+WOQL.optional = function (subquery) {
+  return new WOQLQuery().opt(subquery);
+};
 
 /**
  *
@@ -719,7 +729,9 @@ WOQL.unique = function (prefix, inputVarList, resultVarName) {
 WOQL.idgen = function (prefix, inputVarList, resultVarName) {
   return new WOQLQuery().idgen(prefix, inputVarList, resultVarName);
 };
-WOQL.idgenerator = WOQL.idgen;
+WOQL.idgenerator = function (prefix, inputVarList, resultVarName) {
+  return new WOQLQuery().idgen(prefix, inputVarList, resultVarName);
+};
 
 /**
  *
@@ -904,7 +916,9 @@ WOQL.limit = function (limit, subquery) {
 WOQL.re = function (pattern, inputVarName, resultVarList) {
   return new WOQLQuery().re(pattern, inputVarName, resultVarList);
 };
-WOQL.regexp = WOQL.re;
+WOQL.regexp = function (pattern, inputVarName, resultVarList) {
+  return new WOQLQuery().re(pattern, inputVarName, resultVarList);
+};
 
 /**
  *
@@ -982,7 +996,9 @@ WOQL.count = function (countVarName, subquery) {
 WOQL.typecast = function (varName, varType, resultVarName) {
   return new WOQLQuery().typecast(varName, varType, resultVarName);
 };
-WOQL.cast = WOQL.typecast;
+WOQL.cast = function (varName, varType, resultVarName) {
+  return new WOQLQuery().typecast(varName, varType, resultVarName);
+};
 
 /**
  * Orders the results of the contained subquery by a precedence list of variables
diff --git a/lib/woqlClient.js b/lib/woqlClient.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/rules.spec.js b/test/rules.spec.js
