java-bridge 2.1.7 → 2.1.8-beta.1

package/dist/ts-src/java.d.ts

@@ -16,6 +16,11 @@ export interface JVMOptions extends JavaOptions {
      * Additional arguments to pass to the JVM
      */
     opts?: Array<string> | null;
+    /**
+     * Additional items to add to the class path.
+     * This also allows wildcard imports, e.g. `/lib/*`
+     */
+    classpath?: string[];
 }
 /**
  * Ensure the java vm is created.
@@ -50,9 +55,30 @@ export interface JVMOptions extends JavaOptions {
  * ensureJvm();
  * ```
  *
+ * ## Notes on the `classpath` option
+ *
+ * If you need to set the class path *before* jvm startup, for example
+ * when using libraries with custom class loaders, you'd need to call
+ * `ensureJvm` *before* making any other call to `java-bridge` as those
+ * methods may themselves call `ensureJvm` with no arguments
+ * (see comment above). Altering the startup classpath after jvm boot is
+ * not possible, you can only alter the runtime classpath using
+ * `appendClasspath` or `appendClasspathAny` which may not reflect
+ * in an altered classpath in your java application/library if your
+ * application is using a custom classpath (e.g. Spring Boot).
+ *
+ * Also, it is not possible to restart the jvm after is has been started
+ * once, in order to alter the startup classpath. This is due to some
+ * limitations with the destructor feature of the node.js native api,
+ * which may not call the destructor in time and having two jvm instances
+ * in the same application is not allowed by java. Additionally, destroying
+ * the jvm instance may cause *undefined behaviour*, which may or may not
+ * cause the application to crash. Let's not do that.
+ *
  * @param options the options to use when creating the jvm
+ * @return true if the jvm was created and false if the jvm already existed and was not created
  */
-export declare function ensureJvm(options?: JVMOptions): void;
+export declare function ensureJvm(options?: JVMOptions): boolean;
 /**
  * Get the addon's internal class loader.
  * This may be used in combination with {@link setClassLoader}
@@ -160,6 +186,8 @@ export declare function importClassAsync<T extends JavaClassConstructorType = Un
  * This doesn't check if the jars are valid and/or even exist.
  * The new classpath will be available to all classes imported after this call.
  *
+ * **Note: This can only import single files, not directories.**
+ *
  * ## Example
  * ```ts
  * import { appendClasspath } from 'java-bridge';
@@ -181,6 +209,27 @@ export declare function importClassAsync<T extends JavaClassConstructorType = Un
  * @param path the path(s) to add
  */
 export declare function appendClasspath(path: string | string[]): void;
+/**
+ * Append either a single or multiple jars or directories to the class path.
+ * This will check if the path(s) passed are directories and will
+ * add a trailing slash to the path if it doesn't already have one
+ * so the class loader will treat it as a directory. This will
+ * check if the file or directory exists and throw an error if it doesn't exist.
+ *
+ * ## Example
+ * ```ts
+ * appendClasspathAny('/path/to/dir');
+ * ```
+ *
+ * Pass multiple paths:
+ * ```ts
+ * appendClasspathAny(['/path/to/dir1', '/path/to/my.jar']);
+ * ```
+ *
+ * @param path the file(s) or directory(s) to add
+ * @param recursive whether to recursively add all files in the directory
+ */
+export declare function appendClasspathAny(path: string | string[], recursive?: boolean): void;
 /**
  * Check if `this_obj` is instance of `other`.
  * This uses the native java `instanceof` operator.
@@ -215,7 +264,7 @@ export declare function appendClasspath(path: string | string[]): void;
  * @param other the class or class name to check against
  * @return true if `this_obj` is an instance of `other`
  */
-export declare function isInstanceOf<T extends JavaClassConstructorType>(this_obj: JavaClass, other: string | T): boolean;
+export declare function isInstanceOf<T extends object>(this_obj: JavaClass, other: string | T): boolean;
 /**
  * Methods for altering and querying the class path.
  * @example
@@ -233,9 +282,13 @@ export declare namespace classpath {
      */
     function append(path: string | string[]): void;
     /**
-     * Get the loaded jars in the class path
+     * @inheritDoc appendClasspathAny
+     */
+    function appendAny(path: string | string[], recursive?: boolean): void;
+    /**
+     * Get the loaded files or directories in the class path
      *
-     * @returns a list of the loaded jars
+     * @returns a list of the loaded files
      */
     function get(): string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "java-bridge",
-  "version": "2.1.7",
+  "version": "2.1.8-beta.1",
   "main": "dist/index.prod.min.js",
   "types": "dist/ts-src/index.d.ts",
   "description": "A bridge between Node.js and Java APIs",
@@ -56,7 +56,8 @@
     "build:java:win32": "cd java-src && .\\gradlew.bat shadowJar",
     "prepublishOnly": "napi prepublish -t npm",
     "test": "npm run testOnly",
-    "testOnly": "mocha -r ts-node/register test/**/*.test.ts",
+    "testOnly": "mocha -r ts-node/register test/*.test.ts --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
+    "pretestOnly": "npm run generateTestTypes",
     "pretest": "npm run build",
     "version": "napi version",
     "prettier": "prettier --write .",
@@ -64,7 +65,8 @@
     "prebuild:debug": "rimraf dist",
     "benchmark": "ts-node -P test/tsconfig.json test/benchmark/benchmark.ts && ts-node -P test/tsconfig.json test/benchmark/benchmarkDaemonThreads.ts",
     "prebenchmark": "npm run build",
-    "docs": "typedoc --out docs ts-src/index.ts"
+    "docs": "typedoc --out docs ts-src/index.ts",
+    "generateTestTypes": "ts-node -P test/tsconfig.json test/generateTestTypes.ts"
   },
   "dependencies": {
     "chalk": "^5.1.2",
@@ -74,28 +76,30 @@
     "yargs": "^17.6.2"
   },
   "devDependencies": {
-    "@napi-rs/cli": "^2.12.1",
+    "@napi-rs/cli": "^2.13.0",
     "@types/chai": "^4.3.4",
     "@types/glob": "^8.0.0",
     "@types/is-ci": "^3.0.0",
-    "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.9",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.10",
     "@types/semver": "^7.3.13",
     "@types/webpack-node-externals": "^2.5.3",
-    "@types/yargs": "^17.0.13",
+    "@types/yargs": "^17.0.15",
     "chai": "^4.3.7",
     "cpy-cli": "^4.2.0",
     "expose-gc": "^1.0.0",
     "is-ci": "^3.0.1",
     "mocha": "^10.1.0",
+    "mocha-junit-reporter": "^2.2.0",
+    "mocha-multi-reporters": "^1.5.1",
     "nanobench": "^3.0.0",
     "node-loader": "^2.0.0",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.0",
     "rimraf": "^3.0.2",
     "run-script-os": "^1.1.6",
     "semver": "^7.3.8",
     "string-replace-loader": "^3.1.0",
-    "ts-loader": "^9.4.1",
+    "ts-loader": "^9.4.2",
     "ts-node": "^10.9.1",
     "tslib": "^2.4.1",
     "typedoc": "^0.23.21",
@@ -104,11 +108,11 @@
     "webpack-node-externals": "^3.0.0"
   },
   "optionalDependencies": {
-    "java-bridge-win32-x64-msvc": "2.1.7",
-    "java-bridge-darwin-x64": "2.1.7",
-    "java-bridge-linux-x64-gnu": "2.1.7",
-    "java-bridge-darwin-arm64": "2.1.7",
-    "java-bridge-win32-ia32-msvc": "2.1.7",
-    "java-bridge-linux-arm64-gnu": "2.1.7"
+    "java-bridge-win32-x64-msvc": "2.1.8-beta.1",
+    "java-bridge-darwin-x64": "2.1.8-beta.1",
+    "java-bridge-linux-x64-gnu": "2.1.8-beta.1",
+    "java-bridge-darwin-arm64": "2.1.8-beta.1",
+    "java-bridge-win32-ia32-msvc": "2.1.8-beta.1",
+    "java-bridge-linux-arm64-gnu": "2.1.8-beta.1"
   }
 }