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

Author: Francesca-Bit

.github/workflows/docs.yml

@@ -21,9 +21,9 @@ jobs:
       with:
         source_folder: 'docs/api/.'
         destination_repo: 'terminusdb/terminusdb-docs'
-        destination_folder: 'index/terminusx-db/reference-guides/javascript-client-reference'
+        destination_folder: 'guides/reference-guides/javascript-client-reference'
         destination_base_branch: 'main'
         destination_head_branch: ${{ env.BRANCH_NAME }}
         user_email: '[email protected]'
         user_name: 'Neelterminusdb'
-        pull_request_reviewers: 'mark-terminusdb'
+        pull_request_reviewers: 'mark-terminusdb'

README.md

@@ -22,9 +22,7 @@ graph all through a simple document API.
 [terminusdb-docs]: https://terminusdb.com/docs/
 [terminusdb-repo]: https://github.com/terminusdb/terminusdb
 
-**TerminusX** is a self-service data platform that allows you to build, deploy,
-execute, monitor, and share versioned data products. It is built on TerminusDB.
-TerminusX is in public beta and you can [sign up now][dashboard].
+**TerminusX** TerminusX is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][dashboard].
 
 [dashboard]: https://dashboard.terminusdb.com/
 
@@ -71,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation][terminusdb-client-js-docs]
+For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");

lib/query/woqlCore.js

@@ -14,7 +14,7 @@
 /// /@ts-check
 const UTILS = require('../utils');
 const WOQLPrinter = require('./woqlPrinter');
-const { Var, Doc } = require('./woqlDoc');
+const { Var, Vars, Doc } = require('./woqlDoc');
 
 /**
  * defines the internal functions of the woql query object - the
@@ -709,9 +709,9 @@ function getClauseAndRemainder(pat) {
 
 function compilePredicate(pp, q) {
   if (pp.indexOf('<') !== -1 && pp.indexOf('>') !== -1) {
-    let pred = pp.slice(1, pp.length - 1);
+    const pred = pp.slice(1, pp.length - 1);
     // eslint-disable-next-line no-multi-assign,no-constant-condition
-    const cleaned = (pred = '*' ? 'owl:topObjectProperty' : q.cleanPathPredicate(pred));
+    const cleaned = pred === '.' ? null : q.cleanPathPredicate(pred);
     return {
       '@type': 'PathOr',
       or: [{
@@ -725,18 +725,15 @@ function compilePredicate(pp, q) {
     };
   } if (pp.indexOf('<') !== -1) {
     const pred = pp.slice(1, pp.length);
-    // let cleaned = pred === '*' ? 'owl:topObjectProperty' : q.cleanPathPredicate(pred)
-    const cleaned = q.cleanPathPredicate(pred);
+    const cleaned = pred === '.' ? null : q.cleanPathPredicate(pred);
     return { '@type': 'InversePathPredicate', predicate: cleaned };
   } if (pp.indexOf('>') !== -1) {
     const pred = pp.slice(0, pp.length - 1);
-    // let cleaned = pred === '*' ? 'owl:topObjectProperty' : q.cleanPathPredicate(pred)
-    const cleaned = q.cleanPathPredicate(pred);
+    const cleaned = pred === '.' ? null : q.cleanPathPredicate(pred);
     return { '@type': 'PathPredicate', predicate: cleaned };
   }
-  // let pred = pp === '*' ? 'owl:topObjectProperty' : q.cleanPathPredicate(pp)
-  const pred = q.cleanPathPredicate(pp);
-  return { '@type': 'PathPredicate', predicate: pred };
+  const cleaned = pp === '.' ? null : q.cleanPathPredicate(pp);
+  return { '@type': 'PathPredicate', predicate: cleaned };
 }
 
 /**
@@ -843,6 +840,8 @@ function copyJSON(orig, rollup) {
         }
       }
       nuj[k] = nupart;
+    } else if (part === null) {
+      // do nothing
     } else if (typeof part === 'object') {
       const q = copyJSON(part, rollup);
       if (!q || !UTILS.empty(q)) nuj[k] = q;

lib/query/woqlDoc.js

@@ -74,4 +74,11 @@ function Doc(obj) {
   this.doc = obj;
   this.encoded = convert(obj);
 }
-module.exports = { Var, Doc };
+
+function Vars() {
+  for(let k of arguments){
+    this[k] = new Var(k)
+  }
+}
+
+module.exports = { Vars, Var, Doc };

lib/query/woqlPrinter.js

@@ -389,9 +389,9 @@ WOQLPrinter.prototype.decompilePathPattern = function (pstruct) {
   // eslint-disable-next-line default-case
   switch (t) {
     case 'InversePathPredicate':
-      return `<${pstruct.predicate}`;
+      return pstruct.predicate ? `<${pstruct.predicate}` : '<.';
     case 'PathPredicate':
-      return pstruct.predicate;
+      return pstruct.predicate ? `${pstruct.predicate}` : '.';
     case 'PathPlus':
       var next = pstruct.plus;
       if (Array.isArray(next)) next = next[0];

lib/query/woqlQuery.js

@@ -12,7 +12,7 @@
 /// /@ts-check
 // WOQLQuery
 const WOQLQuery = require('./woqlCore');
-const { Var, Doc } = require('./woqlDoc');
+const { Var, Vars, Doc } = require('./woqlDoc');
 
 // I HAVE TO REVIEW THE Inheritance and the prototype chain
 /* class WOQLQuery extends WOQLCore {

lib/woql.js

@@ -3,7 +3,7 @@
 /// /@ts-check
 // I HAVE TO REVIEW THE Inheritance and the prototype chain
 const WOQLQuery = require('./query/woqlBuilder');
-const { Var, Doc } = require('./query/woqlDoc');
+const { Vars, Var, Doc } = require('./query/woqlDoc');
 /**
  * @license Apache Version 2
  * @module WOQL

test/woqlPathquery.js

@@ -27,6 +27,38 @@ describe('woql path query and path query prettyprint', () => {
     expect(query.prettyPrint()).to.eql('WOQL.path("v:X", "hop", "v:Y", "v:Path")');
   });
 
+  it('simple any path query', () => {
+    const query = WOQL.path('v:X', '.*,name', 'v:Y');
+    const json = {
+      '@type': 'Path',
+      subject: {
+        '@type': 'NodeValue',
+        variable: 'X',
+      },
+      pattern: {
+        '@type': "PathSequence",
+        'sequence': [
+          {
+            '@type': "PathStar",
+            'star': {
+              '@type': "PathPredicate"
+            }
+          },
+          {
+            '@type': "PathPredicate",
+            'predicate' : "name"
+          }
+        ]
+      },
+      object: {
+        '@type': 'Value',
+        variable: 'Y',
+      }
+    };
+    expect(query.json()).to.eql(json);
+    expect(query.prettyPrint()).to.eql('WOQL.path("v:X", "(.*),name", "v:Y")');
+  });
+
   it('test plus directed path query', () => {
     const query = WOQL.path('v:X', '<hop+', 'v:Y', 'v:Path');
     const json = {