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

Author: KittyJose

RELEASE_NOTES.md

@@ -1,3 +1,10 @@
+ 
+# TerminusDB Client v10.0.24
+
+## Fixes 🛠
+
+* Review WOQL typescript definitions
+
 # TerminusDB Client v10.0.22
 
 ## New 🚀

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');
@@ -12,6 +12,8 @@ const AccessControl = require('./lib/accessControl');
 const WOQLQuery = require('./lib/query/woqlBuilder');
 
 module.exports = {
+  Var,
+  Doc,
   Vars,
   WOQLClient,
   UTILS,

index.js

@@ -23,16 +23,20 @@ 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;
-
+/**
+ * @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
  */
@@ -47,6 +51,14 @@ 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);
 };
@@ -55,27 +67,61 @@ WOQLQuery.prototype.all = function (Subj, Pred, Obj, Graph) {
   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(
@@ -117,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) {
@@ -127,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';
@@ -164,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

@@ -50,8 +50,12 @@ const { Var, Vars, Doc } = require('./woqlDoc');
 } */
 
 class WOQLQuery {
+  triple_builder_context = {};
+
   query = null;
 
+  counter = 1;
+
   errors = [];
 
   cursor = {};

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