Make it possible to run mkdocs on the prefixes too

hoijnet · hoijnet · commit 2461a43c3f97 · 2026-01-07T10:00:42.000+01:00
diff --git a/lib/query/woqlCore.js b/lib/query/woqlCore.js
@@ -20,7 +20,18 @@ const { Var, Vars, Doc } = require('./woqlDoc');
 const typedef = require('../typedef');
 
 /**
- * @typedef {import('../typedef').WOQLJson} WOQLJson
+ * @typedef {Object} WOQLJson - JSON-LD representation of a WOQL query
+ * @property {string} @type - The WOQL operation type
+ * @property {*} [subject] - Subject for triple patterns
+ * @property {*} [predicate] - Predicate for triple patterns
+ * @property {*} [object] - Object for triple patterns
+ * @property {WOQLJson[]} [and] - Array of queries for 'And' operations
+ * @property {WOQLJson[]} [or] - Array of queries for 'Or' operations
+ * @property {WOQLJson} [query] - Nested query
+ * @property {string[]} [variables] - Variable list for 'Select' operations
+ * @property {string} [graph] - Graph identifier
+ * @property {*} [consequent] - Consequent for path queries
+ * @property {string} [path_pattern] - Pattern for path queries
  */
 
 /**
@@ -414,12 +425,11 @@ WOQLQuery.prototype.cleanObject = function (o, t) {
     }
     obj.list = res;
   } else if (typeof o === 'object' && o) {
-    if (typeof o['@value'] !== 'undefined') obj.data = o;
-    else return o;
-  // eslint-disable-next-line no-dupe-else-if
-  } else if (typeof o === 'boolean') {
-    t = t || 'xsd:boolean';
-    obj['woql:datatype'] = this.jlt(o, t);
+    if (typeof o['@value'] !== 'undefined') {
+      obj.data = o;
+    } else {
+      return o;
+    }
   }
   return obj;
 };
@@ -428,9 +438,11 @@ WOQLQuery.prototype.cleanDataValue = function (o, t) {
   const obj = { '@type': 'DataValue' };
   if (o instanceof Var) {
     return this.expandDataVariable(o);
-  } if (o instanceof Doc) {
+  }
+  if (o instanceof Doc) {
     return o.encoded;
-  } if (typeof o === 'string') {
+  }
+  if (typeof o === 'string') {
     if (o.indexOf('v:') !== -1) {
       return this.expandDataVariable(o);
     }
diff --git a/lib/query/woqlLibrary.js b/lib/query/woqlLibrary.js
@@ -3,7 +3,80 @@
 const WOQLQuery = require('./woqlBuilder');
 
 /**
- * @typedef {import('./woqlBuilder')} WOQLQuery
+ * @typedef {Object} WOQLQuery - WOQL Query Builder class
+ * @property {function} triple - Add a triple pattern
+ * @property {function} and - Logical AND
+ * @property {function} or - Logical OR
+ * @property {function} select - Select variables
+ * @property {function} ask - Ask query
+ * @property {function} limit - Limit results
+ * @property {function} offset - Offset results
+ * @property {function} start - Start query
+ * @property {function} path - Path query
+ * @property {function} subquery - Subquery
+ * @property {function} from - Graph specifier
+ * @property {function} eq - Equality
+ * @property {function} not - Negation
+ * @property {function} greaterThan - Greater than
+ * @property {function} lessThan - Less than
+ * @property {function} greaterThanOrEqual - Greater than or equal
+ * @property {function} lessThanOrEqual - Less than or equal
+ * @property {function} like - String pattern matching
+ * @property {function} plus - Addition
+ * @property {function} minus - Subtraction
+ * @property {function} times - Multiplication
+ * @property {function} divide - Division
+ * @property {function} count - Count aggregation
+ * @property {function} sum - Sum aggregation
+ * @property {function} min - Minimum aggregation
+ * @property {function} max - Maximum aggregation
+ * @property {function} avg - Average aggregation
+ * @property {function} groupBy - Group by
+ * @property {function} orderBy - Order by
+ * @property {function} asc - Ascending order
+ * @property {function} desc - Descending order
+ * @property {function} json - JSON object
+ * @property {function} id - IRI
+ * @property {function} string - String literal
+ * @property {function} datetime - DateTime literal
+ * @property {function} date - Date literal
+ * @property {function} time - Time literal
+ * @property {function} boolean - Boolean literal
+ * @property {function} integer - Integer literal
+ * @property {function} decimal - Decimal literal
+ * @property {function} double - Double literal
+ * @property {function} value - Value literal
+ * @property {function} var - Variable
+ * @property {function} v - Variable shorthand
+ * @property {function} doc - Document
+ * @property {function} class - Class
+ * @property {function} property - Property
+ * @property {function} comment - Comment
+ * @property {function} label - Label
+ * @property {function} prefix - Prefix
+ * @property {function} using - Using
+ * @property {function} optional - Optional
+ * @property {function} union - Union
+ * @property {function} filter - Filter
+ * @property {function} bind - Bind
+ * @property {function} exists - Exists
+ * @property {function} notExists - Not exists
+ * @property {function} graph - Graph
+ * @property {function} named - Named graph
+ * @property {function} values - Values
+ * @property {function} minus - Minus
+ * @property {function} service - Service
+ * @property {function} load - Load
+ * @property {function} clear - Clear
+ * @property {function} drop - Drop
+ * @property {function} add - Add
+ * @property {function} move - Move
+ * @property {function} copy - Copy
+ * @property {function} insert - Insert
+ * @property {function} delete - Delete
+ * @property {function} modify - Modify
+ * @property {function} construct - Construct
+ * @property {function} describe - Describe
  */
 
 /**
diff --git a/lib/query/woqlQuery.js b/lib/query/woqlQuery.js
@@ -336,7 +336,7 @@ WOQLQuery.prototype.select = function (...varNames) {
  * Parameters with null values are local-only variables.
  *
  * @param {object} paramSpec - Object mapping parameter names to values (or null for local vars)
- * @returns {[function, object]} Tuple of [localized function, variables object]
+ * @returns {LocalizeResult} Tuple of [localized function, variables object]
  * @example
  * const [localized, v] = WOQL.localize({ consSubject, valueVar, last_cell: null });
  * return localized(
diff --git a/lib/typedef.js b/lib/typedef.js
@@ -226,4 +226,23 @@ const { ACTIONS } = Utils.ACTIONS;
  * Additional properties depend on the specific WOQL operation type
  */
 
-module.exports = {};
+/**
+ * @typedef {Object} WOQLQuery - WOQL Query Builder class
+ */
+
+/**
+ * Result from WOQL.localize() function - a two-element array [localizedFn, vars]
+ * @typedef {Object} LocalizeResult
+ * @property {function(WOQLQuery=): WOQLQuery} 0 - Localized function that wraps queries
+ * @property {Object.<string, Var>} 1 - Variables object with unique names
+ */
+
+// eslint-disable-next-line no-unused-vars
+const WOQLJson = {};
+// eslint-disable-next-line no-unused-vars
+const WOQLQuery = {};
+
+module.exports = {
+  WOQLJson,
+  WOQLQuery,
+};
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminusdb-client",
-  "version": "12.0.1",
+  "version": "12.0.3",
   "description": "TerminusDB client library",
   "main": "index.js",
   "types": "./dist/typescript/index.d.ts",
diff --git a/test/woql.spec.js b/test/woql.spec.js
@@ -48,30 +48,29 @@ describe('woql queries', () => {
   });
 
   it('check the start method', () => {
-    const woqlObject = WOQL.limit(10).start(0);
-
-    /* const jsonObj={"@type": "woql:Limit",
-                  "woql:limit": {
-                      "@type": "woql:DataValue",
-                      "woql:datatype": {
-                          "@type": "xsd:nonNegativeInteger",
-                          "@value": 10
-                      }
-                  },
-                  "woql:query": {
-                      "@type": "woql:Start",
-                      "woql:start": {
-                          "@type": "woql:DataValue",
-                          "woql:datatype": {
-                              "@type": "xsd:nonNegativeInteger",
-                              "@value": 0
-                          }
-                      },
-                      "woql:query": {}
-                  }
-              } */
-
-    // expect(woqlObject.json()).to.eql({});
+    const woqlObject = WOQL.start(10).limit(5).eq('v:X', 'v:Y');
+
+    const expectedJson = {
+      '@type': 'Start',
+      start: 10,
+      query: {
+        '@type': 'Limit',
+        limit: 5,
+        query: {
+          '@type': 'Equals',
+          left: {
+            '@type': 'Value',
+            variable: 'X',
+          },
+          right: {
+            '@type': 'Value',
+            variable: 'Y',
+          },
+        },
+      },
+    };
+
+    expect(woqlObject.json()).to.eql(expectedJson);
   });
 
   it('check the not method', () => {

Original file line number	Diff line number	Diff line change
`@@ -336,7 +336,7 @@ WOQLQuery.prototype.select = function (...varNames) {`
`336`	`336`	`* Parameters with null values are local-only variables.`
`337`	`337`	`*`
`338`	`338`	`* @param {object} paramSpec - Object mapping parameter names to values (or null for local vars)`
`339`		`- * @returns {[function, object]} Tuple of [localized function, variables object]`
	`339`	`+ * @returns {LocalizeResult} Tuple of [localized function, variables object]`
`340`	`340`	`* @example`
`341`	`341`	`* const [localized, v] = WOQL.localize({ consSubject, valueVar, last_cell: null });`
`342`	`342`	`* return localized(`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@terminusdb/terminusdb-client",`
`3`		`- "version": "12.0.1",`
	`3`	`+ "version": "12.0.3",`
`4`	`4`	`"description": "TerminusDB client library",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"types": "./dist/typescript/index.d.ts",`