Merge pull request #185 from terminusdb/generate-types

Generate type definitions for typescript

Author: Francesca-Bit

.github/workflows/production.yml

@@ -18,6 +18,7 @@ jobs:
         registry-url: 'https://registry.npmjs.org'
     - run: npm install
     - run: npm run build
+    - run: npm run generate-types
     - run: npm publish
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

docs/api/typedef.md

@@ -113,6 +113,7 @@ the DELETE document interface query parameters
 | [branch] | <code>string</code> | set branch to this id |
 | [ref] | <code>string</code> | set commit ref |
 | [default_branch_id] | <code>string</code> | set the default branch id |
+| [token] | <code>string</code> | Api token to connect with TerminusX |
 
 
 ## RolesObj

docs/api/woql.md

@@ -9,18 +9,6 @@ Syntactic sugar to allow writing WOQL.triple()... instead of new WOQLQuery().tri
 Every function matches one of the public api functions of the woql query object
 
 
-## eval
-##### WOQL.eval ⇒ <code>WOQLQuery</code>
-Evaluates the passed arithmetic expression and generates or matches the result value
-
-**Returns**: <code>WOQLQuery</code> - WOQLQuery  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| arithExp | <code>object</code> \| <code>WOQLQuery</code> \| <code>string</code> | query or JSON-LD representing the query |
-| resultVarName | <code>string</code> | output variable |
-
-
 ## using
 ##### WOQL.using(refPath, subquery) ⇒ <code>WOQLQuery</code>
 Query running against any specific commit Id
@@ -531,6 +519,18 @@ let [result] = vars("result")
 evaluate(plus(2, minus(3, 1)), result)
 ```
 
+## eval
+##### WOQL.eval(arithExp, resultVarName) ⇒ <code>WOQLQuery</code>
+Evaluates the passed arithmetic expression and generates or matches the result value
+
+**Returns**: <code>WOQLQuery</code> - WOQLQuery  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| arithExp | <code>object</code> \| <code>WOQLQuery</code> \| <code>string</code> | query or JSON-LD representing the query |
+| resultVarName | <code>string</code> | output variable |
+
+
 ## plus
 ##### WOQL.plus(...args) ⇒ <code>WOQLQuery</code>
 Adds the numbers together

docs/api/woqlclient.md

@@ -339,7 +339,7 @@ client.organization("admin")
 ```
 
 ## getDatabases
-##### woqlClient.getDatabases() ⇒ <code>string</code> \| <code>boolean</code>
+##### woqlClient.getDatabases() ⇒ <code>Promise</code>
 Gets the organization's databases list.
 
 If no organization has been set up, the function throws an exception

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 || {};

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
  */
 
 /**

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) {

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) {

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') {

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 };