java-bridge 2.1.3 → 2.1.5-beta.1

package/{ts-src/java.ts → dist/ts-src/java.d.ts}

@@ -1,30 +1,5 @@
-import {
-    getClassFields,
-    getField,
-    getStaticField,
-    Java,
-    JavaOptions,
-    setField,
-    setStaticField,
-} from '../native';
-import {
-    JavaClassInstance,
-    JavaClassType,
-    JavaConstructor,
-    JavaVersion,
-} from './definitions';
-import { getJavaLibPath, getNativeLibPath } from './nativeLib';
-
-/**
- * The static java instance
- */
-let javaInstance: Java | null = null;
-
-interface ImportedJavaClass {
-    'class.proxy': object;
-    new (...args: any[]): any;
-}
-
+import { Java, JavaOptions } from '../native';
+import { JavaClass, JavaClassConstructorType, JavaVersion, UnknownJavaClassType } from './definitions';
 /**
  * Options for creating the Java VM.
  */
@@ -42,7 +17,6 @@ export interface JVMOptions extends JavaOptions {
      */
     opts?: Array<string> | null;
 }
-
 /**
  * Ensure the java vm is created.
  * If the jvm is already created, this does nothing.
@@ -78,43 +52,7 @@ export interface JVMOptions extends JavaOptions {
  *
  * @param options the options to use when creating the jvm
  */
-export function ensureJvm(options?: JVMOptions): void {
-    if (!javaInstance) {
-        javaInstance = new Java(
-            options?.libPath,
-            options?.version,
-            options?.opts,
-            options,
-            getJavaLibPath(),
-            getNativeLibPath()
-        );
-    }
-}
-
-function defineFields(object: Record<string, any>, getStatic: boolean): void {
-    for (const field of getClassFields(object['class.proxy'], getStatic)) {
-        const getter = (): any =>
-            getStatic
-                ? getStaticField(object, field.name)
-                : getField(object, field.name);
-        if (field.isFinal) {
-            Object.defineProperty(object, field.name, {
-                get: getter,
-                enumerable: true,
-            });
-        } else {
-            Object.defineProperty(object, field.name, {
-                get: getter,
-                set: (value: any) =>
-                    getStatic
-                        ? setStaticField(object, field.name, value)
-                        : setField(object, field.name, value),
-                enumerable: true,
-            });
-        }
-    }
-}
-
+export declare function ensureJvm(options?: JVMOptions): void;
 /**
  * Import a class.
  * Returns the constructor of the class to be created.
@@ -180,47 +118,11 @@ function defineFields(object: Record<string, any>, getStatic: boolean): void {
  * @param classname the name of the class to resolve
  * @return the java class constructor
  */
-export function importClass<T extends JavaClassType = JavaClassType>(
-    classname: string
-): JavaConstructor<T> {
-    ensureJvm();
-    const constructor = javaInstance!.importClass(
-        classname
-    ) as ImportedJavaClass;
-    defineFields(constructor, true);
-
-    constructor.constructor = function (...args: any[]) {
-        const object = new constructor.prototype.constructor(...args);
-        defineFields(object, false);
-
-        return object;
-    };
-
-    return constructor as unknown as JavaConstructor<T>;
-}
-
+export declare function importClass<T extends JavaClassConstructorType = UnknownJavaClassType>(classname: string): T;
 /**
  * @inheritDoc importClass
  */
-export async function importClassAsync<T extends JavaClassType = JavaClassType>(
-    classname: string
-): Promise<JavaConstructor<T>> {
-    ensureJvm();
-    const constructor = (await javaInstance!.importClassAsync(
-        classname
-    )) as ImportedJavaClass;
-    defineFields(constructor, true);
-
-    constructor.constructor = function (...args: any[]) {
-        const object = new constructor.prototype.constructor(...args);
-        defineFields(object, false);
-
-        return object;
-    };
-
-    return constructor as unknown as JavaConstructor<T>;
-}
-
+export declare function importClassAsync<T extends JavaClassConstructorType = UnknownJavaClassType>(classname: string): Promise<T>;
 /**
  * Append a single or multiple jars to the class path.
  *
@@ -248,15 +150,11 @@ export async function importClassAsync<T extends JavaClassType = JavaClassType>(
  *
  * @param path the path(s) to add
  */
-export function appendClasspath(path: string | string[]): void {
-    ensureJvm();
-    javaInstance!.appendClasspath(path);
-}
-
+export declare function appendClasspath(path: string | string[]): void;
 /**
  * Check if `this_obj` is instance of `other`.
  * This uses the native java `instanceof` operator.
- * You may want to use this if {@link JavaClassInstance.instanceOf}
+ * You may want to use this if {@link JavaClass.instanceOf}
  * is overridden, as that method itself does not override
  * any method defined in the specific java class named 'instanceOf'.
  *
@@ -287,14 +185,7 @@ export 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 function isInstanceOf<T extends typeof JavaClassInstance>(
-    this_obj: JavaClassInstance,
-    other: string | T
-): boolean {
-    ensureJvm();
-    return javaInstance!.isInstanceOf(this_obj, other);
-}
-
+export declare function isInstanceOf<T extends JavaClassConstructorType>(this_obj: JavaClass, other: string | T): boolean;
 /**
  * Methods for altering and querying the class path.
  * @example
@@ -306,25 +197,18 @@ export function isInstanceOf<T extends typeof JavaClassInstance>(
  * assert.equal(classpath.get().length, 1);
  * assert.equal(classpath.get()[0], '/path/to/jar.jar');
  */
-export namespace classpath {
+export declare namespace classpath {
     /**
      * @inheritDoc appendClasspath
      */
-    export function append(path: string | string[]): void {
-        appendClasspath(path);
-    }
-
+    function append(path: string | string[]): void;
     /**
      * Get the loaded jars in the class path
      *
      * @returns a list of the loaded jars
      */
-    export function get(): string[] {
-        ensureJvm();
-        return javaInstance!.loadedJars;
-    }
+    function get(): string[];
 }
-
 /**
  * A callback for any output redirected from stdout/stderr from the java process.
  *
@@ -332,8 +216,7 @@ export namespace classpath {
  *            This is null if the output was valid. This will probably never be set.
  * @param data the data that was converted. This is unset if <code>err</code> is set.
  */
-export type StdoutCallback = (err: Error | null, data?: string) => void;
-
+export declare type StdoutCallback = (err: Error | null, data?: string) => void;
 /**
  * The class guarding the stdout redirect.
  * Keep this instance in scope to not lose the redirect.
@@ -381,7 +264,6 @@ export interface StdoutRedirectGuard {
      * @param callback the callback
      */
     on(event: 'stdout' | 'stderr', callback: StdoutCallback | null): void;
-
     /**
      * Reset this <code>StdoutRedirectGuard</code> instance.
      * After this call, the stdout/stderr will no longer
@@ -390,7 +272,6 @@ export interface StdoutRedirectGuard {
      */
     reset(): void;
 }
-
 /**
  * A namespace containing methods for redirecting the stdout/stderr of the java process.
  *
@@ -398,7 +279,7 @@ export interface StdoutRedirectGuard {
  * * {@link StdoutRedirectGuard}
  * * {@link stdout.enableRedirect}
  */
-export namespace stdout {
+export declare namespace stdout {
     /**
      * Enable stdout/stderr redirection.
      *
@@ -452,15 +333,8 @@ export namespace stdout {
      * @param stderr the callback to be called when stderr is received
      * @returns a <code>StdoutRedirectGuard</code> instance. Keep this instance in scope to not lose the redirect.
      */
-    export function enableRedirect(
-        stdout?: StdoutCallback | null,
-        stderr?: StdoutCallback | null
-    ): StdoutRedirectGuard {
-        ensureJvm();
-        return javaInstance!.setStdoutCallbacks(stdout, stderr);
-    }
+    function enableRedirect(stdout?: StdoutCallback | null, stderr?: StdoutCallback | null): StdoutRedirectGuard;
 }
-
 /**
  * The class for implementing java interfaces.
  * Keep this instance in scope to not destroy the java object.
@@ -505,7 +379,6 @@ export interface JavaInterfaceProxy {
      */
     reset(): void;
 }
-
 /**
  * An interface proxy method.
  * Any arguments passed to this method are values converted from java values.
@@ -514,11 +387,7 @@ export interface JavaInterfaceProxy {
  * @param args the arguments passed from the java process
  * @return the value to pass back to the java process
  */
-export type ProxyMethod = (...args: any[]) => any;
-type InternalProxyRecord = Parameters<
-    typeof Java.prototype.createInterfaceProxy
->[1];
-
+export declare type ProxyMethod = (...args: any[]) => any;
 /**
  * Create a new java interface proxy.
  * This allows you to implement java interfaces in javascript.
@@ -626,46 +495,9 @@ type InternalProxyRecord = Parameters<
  * @param methods the methods to implement.
  * @returns a proxy class to pass back to the java process
  */
-export function newProxy(
-    interfaceName: string,
-    methods: Record<string, ProxyMethod>
-): JavaInterfaceProxy {
-    ensureJvm();
-    const proxyMethods: InternalProxyRecord = Object.create(null);
-
-    for (const [name, method] of Object.entries(methods)) {
-        proxyMethods[name] = (
-            err: null | Error,
-            callback: (err: Error | null, data?: any | null) => void,
-            ...args: any[]
-        ): void => {
-            if (err) {
-                throw err;
-            }
-
-            try {
-                const res = method(...args);
-                callback(null, res);
-            } catch (e: any) {
-                if (e instanceof Error) {
-                    callback(e);
-                } else {
-                    callback(new Error(e.toString()));
-                }
-            }
-        };
-    }
-
-    return javaInstance!.createInterfaceProxy(
-        interfaceName,
-        proxyMethods
-    ) as JavaInterfaceProxy;
-}
-
+export declare function newProxy(interfaceName: string, methods: Record<string, ProxyMethod>): JavaInterfaceProxy;
 /**
  * Get the static java instance.
  * This has no real use, all important methods are exported explicitly.
  */
-export function getJavaInstance(): Java | null {
-    return javaInstance;
-}
+export declare function getJavaInstance(): Java | null;

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

@@ -0,0 +1,2 @@
+export declare function getNativeLibPath(): string;
+export declare function getJavaLibPath(): string;

package/dist/ts-src/scripts/cli.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,23 @@
+/**
+ * Get the version of the Java VM in use.
+ * Async version.
+ *
+ * @see getJavaVersionSync
+ * @returns the java version string
+ */
+export declare function getJavaVersion(): Promise<string>;
+/**
+ * Get the version of the Java VM in use.
+ * Sync version.
+ *
+ * This is equal to the following java implementation:
+ * ```java
+ * public static String getJavaVersion() {
+ *     return System.getProperty("java.version");
+ * }
+ * ```
+ *
+ * @see getJavaVersion
+ * @returns the java version string
+ */
+export declare function getJavaVersionSync(): string;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "java-bridge",
-  "version": "2.1.3",
+  "version": "2.1.5-beta.1",
   "main": "dist/index.prod.min.js",
-  "typings": "ts-src/index.ts",
+  "types": "dist/ts-src/index.d.ts",
   "description": "A bridge between Node.js and Java APIs",
   "repository": {
     "type": "git",
@@ -14,17 +14,18 @@
   },
   "homepage": "https://github.com/MarkusJx/node-java-bridge#readme",
   "files": [
-    "ts-src",
     "dist/*.js",
-    "java-src/build/libs/*.jar",
-    "native.d.ts"
+    "dist/*.map",
+    "dist/**/*.d.ts",
+    "java-src/build/libs/*.jar"
   ],
   "napi": {
     "name": "java",
     "triples": {
       "additional": [
         "aarch64-apple-darwin",
-        "i686-pc-windows-msvc"
+        "i686-pc-windows-msvc",
+        "aarch64-unknown-linux-gnu"
       ]
     }
   },
@@ -49,12 +50,12 @@
     "postbuild": "npm run build:ts && npm run build:java",
     "build:napi": "napi build --platform --release --js native.js --dts native.d.ts",
     "build:napi:debug": "napi build --platform --js native.js --dts native.d.ts",
-    "build:ts": "webpack build",
+    "build:ts": "webpack build && cpy native.d.ts dist",
     "build:java": "run-script-os",
     "build:java:darwin:linux": "cd java-src && chmod +x gradlew && ./gradlew shadowJar",
     "build:java:win32": "cd java-src && .\\gradlew.bat shadowJar",
     "prepublishOnly": "napi prepublish -t npm",
-    "test": "mocha -r ts-node/register test/**/*.test.ts",
+    "test": "npm run testOnly",
     "testOnly": "mocha -r ts-node/register test/**/*.test.ts",
     "pretest": "npm run build",
     "version": "napi version",
@@ -66,44 +67,48 @@
     "docs": "typedoc --out docs ts-src/index.ts"
   },
   "dependencies": {
-    "@types/glob": "^8.0.0",
-    "chalk": "^5.0.1",
+    "chalk": "^5.1.2",
     "glob": "^8.0.3",
     "ora": "^6.1.2",
-    "typescript": "^4.8.2",
-    "yargs": "^17.5.1"
+    "typescript": "^4.8.4",
+    "yargs": "^17.6.1"
   },
   "devDependencies": {
-    "@napi-rs/cli": "^2.11.4",
+    "@napi-rs/cli": "^2.12.0",
     "@types/chai": "^4.3.3",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.7.15",
-    "@types/semver": "^7.3.12",
+    "@types/glob": "^8.0.0",
+    "@types/is-ci": "^3.0.0",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.9",
+    "@types/semver": "^7.3.13",
     "@types/webpack-node-externals": "^2.5.3",
-    "@types/yargs": "^17.0.12",
+    "@types/yargs": "^17.0.13",
     "chai": "^4.3.6",
+    "cpy-cli": "^4.2.0",
     "expose-gc": "^1.0.0",
-    "mocha": "^10.0.0",
+    "is-ci": "^3.0.1",
+    "mocha": "^10.1.0",
     "nanobench": "^3.0.0",
     "node-loader": "^2.0.0",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
     "run-script-os": "^1.1.6",
-    "semver": "^7.3.7",
+    "semver": "^7.3.8",
     "string-replace-loader": "^3.1.0",
-    "ts-loader": "^9.3.1",
+    "ts-loader": "^9.4.1",
     "ts-node": "^10.9.1",
-    "tslib": "^2.4.0",
-    "typedoc": "^0.23.13",
+    "tslib": "^2.4.1",
+    "typedoc": "^0.23.20",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0",
     "webpack-node-externals": "^3.0.0"
   },
   "optionalDependencies": {
-    "java-bridge-win32-x64-msvc": "2.1.3",
-    "java-bridge-darwin-x64": "2.1.3",
-    "java-bridge-linux-x64-gnu": "2.1.3",
-    "java-bridge-darwin-arm64": "2.1.3",
-    "java-bridge-win32-ia32-msvc": "2.1.3"
+    "java-bridge-win32-x64-msvc": "2.1.5-beta.1",
+    "java-bridge-darwin-x64": "2.1.5-beta.1",
+    "java-bridge-linux-x64-gnu": "2.1.5-beta.1",
+    "java-bridge-darwin-arm64": "2.1.5-beta.1",
+    "java-bridge-win32-ia32-msvc": "2.1.5-beta.1",
+    "java-bridge-linux-arm64-gnu": "2.1.5-beta.1"
   }
 }