javonet-nodejs-sdk 2.5.17 → 2.5.18

package/lib/types.d.ts

@@ -0,0 +1,57 @@
+export interface ConnectionData {
+    readonly connectionType: ConnectionType
+    readonly hostname: string
+    serializeConnectionData(): string
+}
+
+export enum RuntimeName {
+    Clr = 0,
+    Go = 1,
+    Jvm = 2,
+    Netcore = 3,
+    Perl = 4,
+    Python = 5,
+    Ruby = 6,
+    Nodejs = 7,
+    Cpp = 8,
+    Php = 9,
+    Python27 = 10,
+}
+
+export type RuntimeType =
+    | 'clr'
+    | 'go'
+    | 'jvm'
+    | 'netcore'
+    | 'perl'
+    | 'python'
+    | 'ruby'
+    | 'nodejs'
+    | 'cpp'
+    | 'php'
+    | 'python27'
+export type RuntimeChannelType = 'inMemory' | 'tcp' | 'webSocket'
+
+export interface RuntimeChannel {
+    type: RuntimeChannelType
+    host?: string
+    port?: number
+}
+
+export interface Runtime {
+    name: string
+    customOptions: string
+    modules: string
+    channel: RuntimeChannel
+    runtimeName: RuntimeName
+}
+
+export type Runtimes = {
+    [Key in keyof typeof RuntimeType]: Runtime[] | Runtime
+}
+
+export interface ConfigSource {
+    [key: string]: any
+    licenseKey: string
+    runtimes: Partial<Runtimes>
+}

package/lib/utils/Command.js

@@ -1,9 +1,14 @@
+// @ts-check
 import { CommandType } from './CommandType.js'
 
+/**
+ * @typedef {import('../types.d.ts').RuntimeName} RuntimeName
+ */
+
 export class Command {
     /**
      * Constructs a new Command instance.
-     * @param {number} runtimeName - The runtime name associated with the command.
+     * @param {RuntimeName} runtimeName - The runtime name associated with the command.
      * @param {number} commandType - The type of the command.
      * @param {any} [payload] - The optional payload of the command.
      * @method
@@ -15,27 +20,27 @@ export class Command {
     }
 
     /**
-     * @param {any} [response]
-     * @param {number} runtimeName
+     * @param {unknown} response
+     * @param {RuntimeName} runtimeName
+     * @returns {Command}
      */
     static createResponse(response, runtimeName) {
         return new Command(runtimeName, CommandType.Value, [response])
     }
 
     /**
-     * @param {any} [response]
-     * @param {number} runtimeName
-     * @method
+     * @param {unknown} response
+     * @param {RuntimeName} runtimeName
+     * @returns {Command}
      */
     static createReference(response, runtimeName) {
         return new Command(runtimeName, CommandType.Reference, [response])
     }
 
     /**
-     * @param {any} [response]
-     * @param {number} runtimeName
+     * @param {unknown} response
+     * @param {RuntimeName} runtimeName
      * @returns {Command}
-     * @method
      */
     static createArrayResponse(response, runtimeName) {
         return new Command(runtimeName, CommandType.Array, response)

package/lib/utils/CustomError.js

@@ -1,4 +1,9 @@
+// @ts-check
 export class CustomError extends Error {
+    /**
+     * @param {string} message
+     * @param {string} cause
+     */
     constructor(message, cause) {
         super(`${message}: ${cause}`)
         this.name = 'CustomError'

package/lib/utils/Runtime.js

@@ -42,7 +42,7 @@ export function getRuntimeExtension() {
 /**
  * Get the require function
  * @param {string} callerPath - The path to the caller
- * @returns {import('module').createRequire}
+ * @returns {any}
  */
 export const getRequire = (callerPath) => {
     try {

package/lib/utils/RuntimeLogger.js

@@ -1,6 +1,9 @@
+// @ts-check
 import { getRequire, isNodejsRuntime } from './Runtime.js'
 
+/** @type {any | null} */
 let os = null
+/** @type {any | null} */
 let process = null
 
 const requireDynamic = getRequire(import.meta.url)

package/lib/utils/RuntimeNameHandler.js

@@ -1,9 +1,14 @@
+// @ts-check
 import { RuntimeName } from './RuntimeName.js'
 
+/**
+ * @typedef {import('../types.d.ts').RuntimeType} RuntimeType
+ */
+
 class RuntimeNameHandler {
     /**
      * @param {number} runtimeName
-     * @returns {string}
+     * @returns {RuntimeType}
      */
     static getName(runtimeName) {
         switch (runtimeName) {

package/lib/utils/Type.js

@@ -12,4 +12,5 @@ export const Type = /** @type {const} */ ({
     JAVONET_UNSIGNED_LONG_LONG: 9,
     JAVONET_UNSIGNED_INTEGER: 10,
     JAVONET_NULL: 11,
-})
+    JAVONET_VOID: 12,
+})

package/lib/utils/TypesHandler.js

@@ -0,0 +1,35 @@
+// @ts-check
+/**
+ * TypesHandler class provides utilities for converting between types.
+ */
+class TypesHandler {
+    /**
+     * Converts a JavaScript type to a JType equivalent.
+     * @param {Function} type - The JavaScript type.
+     * @returns {string} The corresponding type name
+     */
+    static convertTypeToJType(type) {
+        switch (type) {
+            case Boolean:
+                return "JType.Boolean"
+            case Number:
+                return "JType.Float"
+            case String:
+                return "JType.String"
+            case Object:
+                return typeof type
+            default:
+                return typeof type
+        }
+    }
+
+    /**
+     * @param {unknown} value
+     * @returns {boolean}
+     */
+    static isPrimitiveOrNullOrUndefined(value) {
+        return value === null || value === undefined || typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean'
+    }
+}
+
+export {TypesHandler}

package/lib/utils/UtilsConst.js

@@ -0,0 +1,88 @@
+// @ts-check
+import { getRequire, isNodejsRuntime } from './Runtime.js'
+
+/** @type {any | null} */
+let fs = null
+/** @type {any | null} */
+let path = null
+
+const requireDynamic = getRequire(import.meta.url)
+
+class UtilsConst {
+    /** @type {string} */
+    static _javonetWorkingDirectory = '.'
+    /** @type {string} */
+    static _configSource = ''
+    /** @type {string} */
+    static _licenseKey = ''
+
+    /**
+     * @param {string} inputPath
+     */
+    static setJavonetWorkingDirectory(inputPath) {
+        if (!inputPath) {
+            return
+        }
+        let normalizedPath = inputPath.replace(/\\/g, '/')
+
+        if (!normalizedPath.endsWith('/')) {
+            normalizedPath += '/'
+        }
+        if (isNodejsRuntime()) {
+            if (!fs) {
+                fs = requireDynamic('fs')
+            }
+            if (!fs.existsSync(normalizedPath)) {
+                fs.mkdirSync(normalizedPath, { recursive: true })
+                fs.chmodSync(normalizedPath, 0o700)
+            }
+        }
+        UtilsConst._javonetWorkingDirectory = normalizedPath
+    }
+
+    /**
+     * @returns {string}
+     */
+    static getJavonetWorkingDirectory() {
+        if (isNodejsRuntime() && !UtilsConst._javonetWorkingDirectory) {
+            if (!path) {
+                path = requireDynamic('path')
+            }
+            UtilsConst._javonetWorkingDirectory = path.resolve() + '/'
+        }
+        return UtilsConst._javonetWorkingDirectory
+    }
+
+    /**
+     * @param {string} value
+     */
+    static setConfigSource(value) {
+        UtilsConst._configSource = value
+    }
+
+    /**
+     * @returns {string}
+     */
+    static getConfigSource() {
+        return UtilsConst._configSource
+    }
+
+    /**
+     * @param {string} value
+     */
+    static setLicenseKey(value) {
+        if (!value || value === 'your-license-key') {
+            return
+        }
+        UtilsConst._licenseKey = value
+    }
+
+    /**
+     * @returns {string}
+     */
+    static getLicenseKey() {
+        return UtilsConst._licenseKey
+    }
+}
+
+export { UtilsConst }

package/lib/utils/connectionData/IConnectionData.js

@@ -1,12 +1,26 @@
+// @ts-check
+
+/**
+ * @typedef {import('../ConnectionType.js').ConnectionType} ConnectionType
+ */
 export class IConnectionData {
+    /**
+     * @returns {ConnectionType}
+     */
     get connectionType() {
         throw new Error('You have to implement the method connectionType!')
     }
 
+    /**
+     * @returns {string}
+     */
     get hostname() {
         throw new Error('You have to implement the method hostname!')
     }
 
+    /**
+     * @returns {number[]}
+     */
     serializeConnectionData() {
         throw new Error('You have to implement the method serializeConnectionData!')
     }

package/lib/utils/connectionData/InMemoryConnectionData.js

@@ -1,6 +1,11 @@
+// @ts-check
 import { ConnectionType } from '../ConnectionType.js'
 import { IConnectionData } from './IConnectionData.js'
 
+/**
+ * @typedef {import('../ConnectionType.js').ConnectionType} ConnectionType
+ */
+
 /**
  * @extends IConnectionData
  */
@@ -11,14 +16,24 @@ class InMemoryConnectionData extends IConnectionData {
         this._hostname = ''
     }
 
+    /**
+     * @returns {ConnectionType}
+     */
     get connectionType() {
         return this._connectionType
     }
 
+    /**
+     * @returns {string}
+     */
     get hostname() {
         return this._hostname
     }
 
+    /**
+     * Serializes the connection data.
+     * @returns {number[]} An array of connection data values.
+     */
     serializeConnectionData() {
         return [this.connectionType, 0, 0, 0, 0, 0, 0]
     }

package/lib/utils/connectionData/WsConnectionData.js

@@ -1,6 +1,11 @@
+// @ts-check
 import { ConnectionType } from '../ConnectionType.js'
 import { IConnectionData } from './IConnectionData.js'
 
+/**
+ * @typedef {import('../ConnectionType.js').ConnectionType} ConnectionType
+ */
+
 /**
  * Represents WebSocket connection data.
  * @extends IConnectionData
@@ -40,6 +45,10 @@ class WsConnectionData extends IConnectionData {
         return [this.connectionType, 0, 0, 0, 0, 0, 0]
     }
 
+    /**
+     * @param {WsConnectionData} other
+     * @returns {boolean}
+     */
     equals(other) {
         return other instanceof WsConnectionData && this._hostname === other.hostname
     }

package/lib/utils/nodejs/connectionData/TcpConnectionData.js

@@ -1,12 +1,28 @@
+// @ts-check
 import { IConnectionData } from '../../connectionData/IConnectionData.js'
 import { ConnectionType } from '../../ConnectionType.js'
 import { getRequire, isNodejsRuntime } from '../../Runtime.js'
 
 const requireDynamic = getRequire(import.meta.url)
+
 /**
+ * @typedef {import('../../ConnectionType.js').ConnectionType} ConnectionType
  * @extends IConnectionData
  */
 export class TcpConnectionData extends IConnectionData {
+    /** @type {string} */
+    ipAddress = ''
+    /** @type {number} */
+    _port = 0
+    /** @type {string} */
+    _hostname = ''
+    /** @type {ConnectionType} */
+    _connectionType = ConnectionType.TCP
+
+    /**
+     * @param {string} hostname
+     * @param {number} port
+     */
     constructor(hostname, port) {
         super()
         this._port = port
@@ -19,6 +35,9 @@ export class TcpConnectionData extends IConnectionData {
         }
     }
 
+    /**
+     * @returns {ConnectionType}
+     */
     get connectionType() {
         return this._connectionType
     }
@@ -40,7 +59,7 @@ export class TcpConnectionData extends IConnectionData {
 
     /**
      * @param {string} hostname
-     * @returns {string|null}
+     * @returns {string}
      */
     resolveIpAddress(hostname) {
         try {
@@ -54,24 +73,29 @@ export class TcpConnectionData extends IConnectionData {
                     const dns = requireDynamic('dns')
 
                     // If it's not an IP address, try to resolve it as a hostname
-                    return dns.resolve4(hostname, (err, addresses) => {
+                    return dns.resolve4(hostname, (/** @type {Error | null} */ err, /** @type {string[]} */ addresses) => {
                         if (err) {
                             console.error(err)
-                            return null
+                            return ''
                         }
                         return addresses[0]
                     })
-                    // eslint-disable-next-line no-unused-vars
                 }
             }
+            return ''
         } catch (error) {
-            if (error.code === 'MODULE_NOT_FOUND') {
+            const err = /** @type {{code?: string}} */ (error)
+            if (err.code === 'MODULE_NOT_FOUND') {
                 throw new Error('dns module not found. Please install it using npm install dns')
             }
             throw error
         }
     }
 
+    /**
+     * Serializes the connection data.
+     * @returns {number[]} An array of connection data values.
+     */
     serializeConnectionData() {
         let result = [this.connectionType]
         result = result.concat(this.#getAddressBytes())
@@ -79,10 +103,16 @@ export class TcpConnectionData extends IConnectionData {
         return result
     }
 
+    /**
+     * @returns {number[]} An array of address bytes.
+     */
     #getAddressBytes() {
         return this.ipAddress.split('.').map(Number)
     }
 
+    /**
+     * @returns {number[]} An array of port bytes.
+     */
     #getPortBytes() {
         return [this._port & 0xff, this._port >> 8]
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "javonet-nodejs-sdk",
-    "version": "2.5.17",
+    "version": "2.5.18",
     "description": "Javonet allows you to reference and use modules or packages written in (Java/Kotlin/Groovy/Clojure, C#/VB.NET, Ruby, Perl, Python, JavaScript/TypeScript) like they were created in your technology. It works on Linux/Windows and MacOS for applications created in JVM, CLR/Netcore, Perl, Python, Ruby, NodeJS, C++ or GoLang and gives you unparalleled freedom and flexibility with native performance in building your mixed-technologies products. Let it be accessing best AI or cryptography libraries, devices SDKs, legacy client modules, internal custom packages or anything from public repositories available on NPM, Nuget, PyPI, Maven/Gradle, RubyGems or GitHub. Get free from programming languages barriers today! For more information check out our guides at https://www.javonet.com/guides/v2/",
     "keywords": [],
     "author": "SdNCenter Sp. z o. o.",
@@ -42,6 +42,7 @@
         "format": "prettier --write ."
     },
     "dependencies": {
+        "@types/ws": "^8.18.1",
         "buffer": "^6.0.3",
         "glob": "^10.4.5",
         "uuid": "^10.0.0"
@@ -78,8 +79,8 @@
     "peerDependencies": {
         "crypto": "^1.0.1",
         "dns": "^0.2.2",
-        "ws": "^8.0.0",
-        "fs-extra": "^11.2.0"
+        "fs-extra": "^11.2.0",
+        "ws": "^8.0.0"
     },
     "peerDependenciesMeta": {
         "ws": {

package/dist/sdk/tools/browser/ConfigSourceResolver.cjs

@@ -1,153 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var ConfigSourceResolver_exports = {};
-__export(ConfigSourceResolver_exports, {
-  ConfigSourceResolver: () => ConfigSourceResolver
-});
-module.exports = __toCommonJS(ConfigSourceResolver_exports);
-function hasOwnProperty(obj, key) {
-  return Object.prototype.hasOwnProperty.call(obj, key);
-}
-class ConfigSourceResolver {
-  /**
-   *
-   * @param {object | string} configSource
-   */
-  constructor(configSource) {
-    if (typeof configSource === "string") {
-      try {
-        this.jsonObject = JSON.parse(configSource);
-      } catch (err) {
-        throw new Error(
-          `Failed to parse configSource as JSON: ${err instanceof Error ? err.message : "Unknown error"}`
-        );
-      }
-    } else if (configSource && typeof configSource === "object") {
-      this.jsonObject = configSource;
-    } else {
-      throw new Error("configSource must be a JSON object or JSON string");
-    }
-  }
-  getLicenseKey() {
-    if (!hasOwnProperty(this.jsonObject, "licenseKey")) {
-      throw new Error(
-        "License key not found in configuration file. Please check your configuration file."
-      );
-    }
-    return this.jsonObject.licenseKey;
-  }
-  getRuntimes() {
-    return this.jsonObject.runtimes;
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getRuntime(runtimeName, configName) {
-    const runtimes = this.getRuntimes();
-    if (hasOwnProperty(runtimes, runtimeName)) {
-      const runtime = runtimes[runtimeName];
-      if (Array.isArray(runtime)) {
-        for (let item of runtime) {
-          if (item.name === configName) {
-            return item;
-          }
-        }
-      } else if (runtime?.name === configName) {
-        return runtime;
-      }
-    }
-    throw new Error(
-      `Runtime config ${configName} not found in configuration file for runtime ${runtimeName}. Please check your configuration file.`
-    );
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getChannel(runtimeName, configName) {
-    const runtime = this.getRuntime(runtimeName, configName);
-    if (!hasOwnProperty(runtime, "channel")) {
-      throw new Error(
-        `Channel key not found in configuration file for config ${configName}. Please check your configuration file.`
-      );
-    }
-    return runtime.channel;
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getChannelType(runtimeName, configName) {
-    const channel = this.getChannel(runtimeName, configName);
-    if (!hasOwnProperty(channel, "type")) {
-      throw new Error(
-        `Channel type not found in configuration file for config ${configName}. Please check your configuration file.`
-      );
-    }
-    return channel.type;
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getChannelHost(runtimeName, configName) {
-    const channel = this.getChannel(runtimeName, configName);
-    if (!hasOwnProperty(channel, "host")) {
-      throw new Error(
-        `Channel host not found in configuration file for config ${configName}. Please check your configuration file.`
-      );
-    }
-    return channel.host;
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getChannelPort(runtimeName, configName) {
-    const channel = this.getChannel(runtimeName, configName);
-    if (!hasOwnProperty(channel, "port")) {
-      throw new Error(
-        `Channel port not found in configuration file for config ${configName}. Please check your configuration file.`
-      );
-    }
-    return channel.port;
-  }
-  /**
-   * @param {string} runtimeName
-   * @param {string} configName
-   * @returns {any}
-   */
-  getModules(runtimeName, configName) {
-    const runtime = this.getRuntime(runtimeName, configName);
-    if (hasOwnProperty(runtime, "modules")) {
-      return runtime.modules;
-    }
-    return "";
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  ConfigSourceResolver
-});