Merge pull request #342 from hoijnet/infra/fix-build-process-and-typescript

Infra/fix build process and typescript, to release 11.1.2

Author: hoijnet

.github/workflows/ci.yml

@@ -41,6 +41,7 @@ jobs:
       run: |
         npm ci
         npm run build
+        npm run validate-types:strict
         npm run test
         npm run test:integration
     - name: Lint

.husky/pre-commit

@@ -4,9 +4,12 @@
 # Lint
 npm run lint:check; 
 
-# Test
-npm test; 
+# Check typescript
+npm run validate-types:strict
 
 # Build
 npm run build
 
+# Test
+npm test; 
+

RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+# TerminusDB Client v11.1.2
+## Fixes
+* Adjust the release process to include version update task
+* Fix typescript generation and add ci tests to prevent similar errors in the future.
+
 # TerminusDB Client v11.1.1
 ## Fixes
 * Update dependencies follow-redirects, webpack-dev-middleware, axios, braces, semver, micromatch, cross-spawn, word-wrap, on-headers, compression, form-data

docs/release_process.md

@@ -1,10 +1,10 @@
 # Releasing a new version of the client
 
-1. Review the changelog between last tagged release v10.0.34..HEAD
-1. Create a branch and update RELEASE_NOTES.md based on changes
-1. Add target version number to release notes
-1. Check in and merge
-1. Pick the latest version from the RELEASE_NOTES.md file
-1. Update package.json version and run npm install
-1. Tag the repo locally and push the tag, align the release (git tag -s v11.x.x)
-1. The new release will be built and published 🎉
+1. Review the changelog between last tagged release v11.1.x..HEAD
+2. Pick the next version number, update package.json, and run `npm install`
+3. Create a branch and update RELEASE_NOTES.md based on changes
+4. Add target version number to release notes
+5. Check in and merge
+6. Pick the latest version from the RELEASE_NOTES.md file
+7. Copy the release notes in Markdown, create a tag on Github with the notes
+8. The new release will be built and published 🎉

lib/typedef.js

@@ -187,7 +187,27 @@ const { ACTIONS } = Utils.ACTIONS;
 /**
  * @typedef {Object} NamedResourceData - { filename: "data.csv", data: "col1;col2\nval1;val2" }
  * @property {string} filename - Filename referenced in the WOQL query
- * @property {string|Blob} data - Attached data, such as CSV contents
+ * @property {string|Blob|Buffer} data - Attached data, such as CSV contents
+ */
+
+/**
+ * @typedef {Object} Frame - Represents a document frame, object frame, or property frame
+ * in the viewer system. Frames are used to describe the structure and properties of data
+ * being displayed or validated.
+ * @property {string} [subject] - Subject identifier
+ * @property {string} [property] - Property name
+ * @property {string} [type] - Type information (e.g., xsd:string, schema:Person)
+ * @property {*} [value] - Frame value
+ * @property {number} [depth] - Depth in frame hierarchy
+ * @property {string} [range] - Property range/type
+ * @property {string} [label] - Display label
+ * @property {Object} [parent] - Parent frame reference
+ * @property {Array} [children] - Child frames
+ * @property {string} [status] - Frame status: 'updated' | 'error' | 'new' | 'ok'
+ * @property {boolean} [literal] - Whether this represents a literal value
+ * @property {number} [index] - Index in parent collection
+ * @property {Object} [frame] - Nested frame data
+ * @property {string} [subjectClass] - Class of the subject
  */
 
 module.exports = {};

lib/viewer/frameRule.js

@@ -8,6 +8,10 @@
 /* eslint-disable no-use-before-define */
 const TerminusRule = require('./terminusRule');
 
+/**
+ * @typedef {import('../typedef').Frame} Frame
+ */
+
 /**
  * @file Frame Rule
  * @license Apache Version 2
@@ -23,7 +27,7 @@ Object.setPrototypeOf(FrameRule.prototype, TerminusRule.TerminusRule.prototype);
 /**
  * Returns an array of rules that match the paased frame
  * @param {[FrameRule]} rules - array of rules to be tested
- * @param {Frame} frame - object frame, property frame or data from to be tested
+ * @param {Frame | object} frame - document frame, object frame, or property frame to be tested
  * @param {function} [onmatch] - optional function to be called with args (frame, rule)
  * on each match
  */

lib/viewer/tableConfig.js

@@ -124,8 +124,10 @@ WOQLTableConfig.prototype.prettyPrint = function () {
 };
 
 /**
- * @param {boolean} canfilter
- * @returns  WOQLTableConfig
+ * Gets or sets whether the table is filterable
+ * @param {boolean} [canfilter] - If provided, sets the filterable state
+ * @returns {boolean|WOQLTableConfig} - Returns the filterable state (boolean) when called
+ * without arguments, or returns this instance (WOQLTableConfig) for chaining when setting
  */
 
 WOQLTableConfig.prototype.filterable = function (canfilter) {

lib/viewer/terminusRule.js

@@ -20,7 +20,7 @@ TerminusRule.prototype.literal = function (tf) {
 };
 
 /**
- * @param {[TYPE_URLS]} list - parameters are types identified by prefixed URLS (xsd:string...)
+ * @param {...string} list - parameters are types identified by prefixed URLS (xsd:string...)
  */
 TerminusRule.prototype.type = function (...list) {
   if (typeof list === 'undefined' || list.length === 0) {

lib/viewer/woqlChooser.js

@@ -6,6 +6,10 @@ const WOQLChooserConfig = require('./chooserConfig');
 const UTILS = require('../utils');
 const { WOQLRule } = require('./woqlRule');
 
+/**
+ * @typedef {import('../woqlClient')} WOQLClient
+ */
+
 /**
  * Very simple implementation of a WOQL backed chooser
  * Makes a drop down from a WOQL query - configuration tells it which columns to use...

lib/viewer/woqlResult.js

@@ -8,6 +8,11 @@
 const UTILS = require('../utils');
 const WOQL = require('../woql');
 const WOQLQ = require('./woqlPaging');
+
+/**
+ * @typedef {import('../query/woqlCore')} WOQLQuery
+ */
+
 /**
  * @module WOQLResult
  * @license Apache Version 2