mind-client-js 0.20.0

package/js/uapi.js

@@ -0,0 +1,270 @@
+/*###############################################################
+#                                                               #
+# Copyright (c) 2026 DnaSoft BV and/or its subsidiaries.        #
+# All rights reserved.                                          #
+#                                                               #
+#   This source code contains the intellectual property         #
+#   of its copyright holder(s), and is made available           #
+#   under a license.  If you do not know the terms of           #
+#   the license, please stop and do not read further.           #
+#                                                               #
+###############################################################*/
+
+const utils = require("./utils");
+const uApi = require('./namespaces/uApi')
+
+const buildParametersText = fn => {
+    let text = ''
+
+    if (fn.returns && fn.returns !== '') {
+        text += fn.returns + ' = '
+    } else {
+        text += ''
+    }
+
+    text += fn.name + '('
+
+    if (fn.parameters && fn.parameters.length > 0) {
+        fn.parameters.forEach(param => {
+            text += param.name + ' as ' + param.datatype + ', '
+
+        })
+
+        text = text.slice(0, -2)
+    }
+
+    return text += ')'
+}
+
+module.exports = {
+    parse: function (that, writer, reader) {
+        const appendToObject = (namespace, that) => {
+            Object.defineProperties(namespace, {
+                objRoot: {
+                    value: that,
+                    enumerable: false,
+                    configurable: false,
+                    writable: false,
+                },
+                writer: {
+                    value: writer,
+                    enumerable: false,
+                    configurable: false,
+                    writable: false,
+                },
+                reader: {
+                    value: reader,
+                    enumerable: false,
+                    configurable: false,
+                    writable: false,
+                }
+            })
+        }
+
+        that.uApi.forEach(namespace => {
+            // create the namespace
+            that[namespace.name] = {}
+            appendToObject(that[namespace.name], that)
+
+            // create methods if needed
+            if (namespace.methods && namespace.methods.length > 0) {
+                namespace.methods.forEach(fn => {
+                    that[namespace.name][fn.name] = function (...args) {
+                        return uApi.method(that[namespace.name].objRoot, reader, writer, fn, namespace.name, args)
+                    }
+
+                    if (fn.showSignature && fn.showSignature === true) {
+                        Object.defineProperties(that[namespace.name], {
+                            [fn.name + '_signature']: {
+                                value: buildParametersText(fn),
+                                enumerable: true,
+                                configurable: false,
+                                writable: false,
+                            },
+                        })
+                    }
+
+                    if (fn.description && fn.description.length > 0 && fn.showDescription && fn.showDescription === true) {
+                        Object.defineProperties(that[namespace.name], {
+                            [fn.name + '_description']: {
+                                value: fn.description,
+                                enumerable: true,
+                                configurable: false,
+                                writable: false,
+                            },
+                        })
+                    }
+                })
+            }
+
+            // create properties if needed
+            if (namespace.properties && namespace.properties.length > 0) {
+                namespace.properties.forEach(fn => {
+                    Object.defineProperties(that[namespace.name], {
+                        [fn.name]: {
+                            value: fn.value,
+                            enumerable: true,
+                            writable: false
+                        },
+                    })
+                })
+            }
+
+            // create children
+            if (namespace.children && namespace.children.length > 0) {
+                namespace.children.forEach(child => {
+                    that[namespace.name][child.name] = {}
+                    appendToObject(that[namespace.name][child.name], that)
+
+                    // create methods if needed
+                    if (child.methods && child.methods.length > 0) {
+                        child.methods.forEach(fn => {
+                            that[namespace.name][child.name][fn.name] = function (...args) {
+                                return uApi.method(that[namespace.name][child.name].objRoot, reader, writer, fn, namespace.name + "." + child.name, args)
+                            }
+
+                            if (fn.showSignature && fn.showSignature === true) {
+                                Object.defineProperties(that[namespace.name][child.name], {
+                                    [fn.name + '_signature']: {
+                                        value: buildParametersText(fn),
+                                        enumerable: true,
+                                        configurable: false,
+                                        writable: false,
+                                    },
+                                })
+                            }
+
+                            if (fn.description && fn.description.length > 0 && fn.showDescription && fn.showDescription === true) {
+                                Object.defineProperties(that[namespace.name][child.name], {
+                                    [fn.name + '_description']: {
+                                        value: fn.description,
+                                        enumerable: true,
+                                        configurable: false,
+                                        writable: false,
+                                    },
+                                })
+                            }
+                        })
+                    }
+
+                    // create properties if needed
+                    if (child.properties && child.properties.length > 0) {
+                        child.properties.forEach(fn => {
+                            Object.defineProperties(that[namespace.name][child.name], {
+                                [fn.name]: {
+                                    value: fn.value,
+                                    enumerable: true,
+                                    writable: false
+                                },
+                            })
+                        })
+                    }
+
+                    // create children
+                    if (child.children && child.children.length > 0) {
+                        child.children.forEach(child2 => {
+                            that[namespace.name][child.name][child2.name] = {}
+                            appendToObject(that[namespace.name][child.name][child2.name], that)
+
+                            // create methods if needed
+                            if (child2.methods && child2.methods.length > 0) {
+                                child2.methods.forEach(fn => {
+                                    that[namespace.name][child.name][child2.name][fn.name] = function (...args) {
+                                        return uApi.method(that[namespace.name][child.name][child2.name].objRoot, reader, writer, fn, namespace.name + "." + child.name + '.' + child2.name, args)
+                                    }
+
+                                    if (fn.showSignature && fn.showSignature === true) {
+                                        Object.defineProperties(that[namespace.name][child.name][child2.name], {
+                                            [fn.name + '_signature']: {
+                                                value: buildParametersText(fn),
+                                                enumerable: true,
+                                                configurable: false,
+                                                writable: false,
+                                            },
+                                        })
+                                    }
+
+                                    if (fn.description && fn.description.length > 0 && fn.showDescription && fn.showDescription === true) {
+                                        Object.defineProperties(that[namespace.name][child.name][child2.name], {
+                                            [fn.name + '_description']: {
+                                                value: fn.description,
+                                                enumerable: true,
+                                                configurable: false,
+                                                writable: false,
+                                            },
+                                        })
+                                    }
+                                })
+                            }
+
+                            // create properties if needed
+                            if (child2.properties && child2.properties.length > 0) {
+                                child2.properties.forEach(fn => {
+                                    Object.defineProperties(that[namespace.name][child.name][child2.name], {
+                                        [fn.name]: {
+                                            value: fn.value,
+                                            enumerable: true,
+                                            writable: false
+                                        },
+                                    })
+                                })
+                            }
+
+                            // create children
+                            if (child2.children && child2.children.length > 0) {
+                                child2.children.forEach(child3 => {
+                                    that[namespace.name][child.name][child2.name][child3.name] = {}
+                                    appendToObject(that[namespace.name][child.name][child2.name][child3.name], that)
+
+                                    // create methods if needed
+                                    if (child3.methods && child3.methods.length > 0) {
+                                        child3.methods.forEach(fn => {
+                                            that[namespace.name][child.name][child2.name][child3.name][fn.name] = function (...args) {
+                                                return uApi.method(that[namespace.name][child.name][child2.name][child3.name].objRoot, reader, writer, fn, namespace.name + "." + child.name + '.' + child2.name + '.' + child3.name, args)
+                                            }
+
+                                            if (fn.showSignature && fn.showSignature === true) {
+                                                Object.defineProperties(that[namespace.name][child.name][child2.name][child3.name], {
+                                                    [fn.name + '_signature']: {
+                                                        value: buildParametersText(fn),
+                                                        enumerable: true,
+                                                        configurable: false,
+                                                        writable: false,
+                                                    },
+                                                })
+                                            }
+
+                                            if (fn.description && fn.description.length > 0 && fn.showDescription && fn.showDescription === true) {
+                                                Object.defineProperties(that[namespace.name][child.name][child2.name][child3.name], {
+                                                    [fn.name + '_description']: {
+                                                        value: fn.description,
+                                                        enumerable: true,
+                                                        configurable: false,
+                                                        writable: false,
+                                                    },
+                                                })
+                                            }
+                                        })
+                                    }
+
+                                    // create properties if needed
+                                    if (child3.properties && child3.properties.length > 0) {
+                                        child3.properties.forEach(fn => {
+                                            Object.defineProperties(that[namespace.name][child.name][child2.name][child3.name], {
+                                                [fn.name]: {
+                                                    value: fn.value,
+                                                    enumerable: true,
+                                                    writable: false
+                                                },
+                                            })
+                                        })
+                                    }
+                                })
+                            }
+                        })
+                    }
+                })
+            }
+        })
+    }
+}

package/js/utils.js

@@ -0,0 +1,174 @@
+/*###############################################################
+#                                                               #
+# Copyright (c) 2025-2026 DnaSoft BV and/or its subsidiaries.   #
+# All rights reserved.                                          #
+#                                                               #
+#   This source code contains the intellectual property         #
+#   of its copyright holder(s), and is made available           #
+#   under a license.  If you do not know the terms of           #
+#   the license, please stop and do not read further.           #
+#                                                               #
+###############################################################*/
+const errors = require("./errors");
+
+module.exports = {
+    validateTypeOfField: (param, type) => {
+        return (typeof param === type)
+    },
+
+    validateConnectOptions: options => {
+
+        if (typeof options !== 'object') {
+            return errors.PARAM_NOT_OBJECT + 'options must be an object'
+        }
+
+        if (Array.isArray(options)) {
+            return errors.PARAM_IS_ARRAY + 'options cannot be an array'
+        }
+
+        if (Object.keys(options).length === 0) {
+            return ''
+        }
+
+        // *****************************************
+        // Socket information
+        // *****************************************
+        if (options.connectTimeout && typeof options.connectTimeout !== 'number') {
+            return errors.PARAM_NOT_NUMBER + 'options.connectTimeout must be a number'
+        }
+
+        if (options.protocol && typeof options.protocol !== 'string') {
+            return errors.PARAM_NOT_STRING + 'options.protocol must be a string'
+        }
+
+        if (options.protocol && (options.protocol !== 'tcp' && options.protocol !== 'uds')) {
+            return errors.PARAM_BAD_VALUE + 'options.protocol must be either tcp or uds.'
+        }
+
+        if (options.useTls && typeof options.useTls !== 'boolean') {
+            return errors.PARAM_NOT_BOOLEAN + 'options.useTls must be a boolean'
+        }
+
+        if (options.tlsRejectSelfSigned && typeof options.tlsRejectSelfSigned !== 'boolean') {
+            return errors.PARAM_NOT_BOOLEAN + 'options.tlsRejectSelfSigned must be a boolean'
+        }
+
+        if (options.protocol === undefined) options.protocol = 'tcp'
+
+        // *****************************************
+        // DB
+        // *****************************************
+        if (options.db && typeof options.db !== 'object') {
+            return errors.PARAM_NOT_OBJECT + 'options.db must be an object'
+        }
+
+        if (options.db && options.db.globals && !Array.isArray(options.db.globals)) {
+            return errors.PARAM_NOT_ARRAY + 'options.db.globals must be an array'
+        }
+
+        if (options.db && options.db.globals) {
+            let err = ''
+
+            options.db.globals.forEach(entry => {
+                if (typeof entry !== 'string') {
+                    err = errors.PARAM_NOT_STRING + 'Entries in options.app.globals must be a string'
+                }
+            })
+
+            if (err !== '') return err
+        }
+
+        // *****************************************
+        // uApi
+        // *****************************************
+        if (options.uApi && typeof options.uApi !== 'object') {
+            return errors.PARAM_NOT_OBJECT + 'options.uApi must be an object'
+        }
+
+        if (options.uApi && options.uApi.appName) {
+            if (typeof options.uApi.appName !== 'string') {
+                return errors.PARAM_NOT_STRING + 'options.uApi.appName must be a string'
+            }
+        }
+
+        return ''
+    },
+
+    validateGlvnName: name => {
+        if (name === undefined || typeof name !== 'string') {
+            throw new Error(errors.PARAM_NOT_STRING_OR_EMPTY + 'Name empty or not string type')
+        }
+
+        const baseIndex = name.charAt(0) === '_' ? 1 : 0
+        let strRegex = new RegExp(/^[a-z0-9]+$/i)
+        let result = strRegex.test(name.slice(baseIndex))
+        let result2 = false
+
+        strRegex = new RegExp(/^[a-z]+$/i)
+        result2 = (name.charAt(0) === '_' || strRegex.test(name.charAt(0)))
+
+        if (!result || !result2) {
+            throw new Error(errors.BAD_SYNTAX + 'Invalid name, must be alphanumeric with first char alphabetic or underscore')
+        }
+    },
+
+    validateGlvnPath: path => {
+        let cnt = -1
+
+        for (const sub of path) {
+            cnt++
+            if (typeof sub !== 'string' && typeof sub !== 'number') {
+                throw new Error(errors.PARAM_NOT_STRING_OR_NUMBER + 'Subpath: ' + cnt + ' must be a string or number')
+            }
+
+            if (typeof sub === 'string' && sub === '') {
+                throw new Error(errors.STRING_IS_EMPTY + 'String in path position: ' + cnt + ' is empty')
+            }
+        }
+    },
+
+    convertPathTo$Name: path => {
+        let ret = ''
+
+        for (const sub of path) {
+            if (typeof sub === 'string') {
+                ret += '"' + sub + '"'
+            } else {
+                ret += sub.toString()
+            }
+            ret += ','
+        }
+
+        return ret.slice(0, -1)
+    },
+
+    generateGlvn: that => (that._type === 'globals' ? '^' : '') + that._glvnName.replace('_', '%') + (that._path !== '' ? '(' + that._path + ')' : ''),
+
+    appendToObject: (namespace, that) => {
+        Object.defineProperties(namespace, {
+            objRoot: {
+                value: that.objRoot,
+                enumerable: false,
+                configurable: false
+            },
+            writer: {
+                value: that.writer,
+                enumerable: false,
+                configurable: false
+            },
+            reader: {
+                value: that.reader,
+                enumerable: false,
+                configurable: false
+            }
+        })
+    },
+
+    formatNumber: num => {
+        return num.toLocaleString().replaceAll('.', ',')
+    },
+
+    formatDecimals: (num, decimals = 2) => {
+        return num.toFixed(decimals)
+    }
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+    "name": "mind-client-js",
+    "version": "0.20.0",
+    "description": "node.js driver for MINDM",
+    "main": "js/index.js",
+    "type": "commonjs",
+    "scripts": {
+        "test": "mocha ./test/bootstrap.js --exit --recursive --timeout=300000 test/test_files",
+        "test-uds": "mocha ./test/bootstrap.js --exit --recursive --timeout=300000 test/test-files-uds"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/mind4yottadb/mind-nodejs.git"
+    },
+    "devDependencies": {
+        "chai": "^4.3.4",
+        "lodash": "^4.17.21",
+        "mocha": "^11.7.2"
+    },
+    "engines": {
+        "node": ">= 10.18.1",
+        "npm": ">= 6.13.4"
+    },
+    "author": {
+        "name": "Stefano Lalli",
+        "email": "stefano@dnasoft.nl",
+        "url": "www.dnasoft.nl"
+    },
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/mind4yottadb/mind-nodejs/issues"
+    },
+    "homepage": "https://github.com/mind4yottadb/mind-nodejs#readme"
+}

package/sketch.txt

@@ -0,0 +1,22 @@
+          cd mind-demo-server
+          docker image build --build-arg SERVERMODE=client-test --build-arg BRANCH=main --progress=plain -t mind-server .
+          docker run -d --init --tty -p 10000:10000 --name=mind-server mind-server
+          cd ..
+
+
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+
+
+
+      - name: pull
+        uses: actions/checkout@v2
+        with:
+          repository: mind4yottadb/mind-demo-server
+          ref: main
+          path: mind-demo-server
+          clean: false
+