java-bridge 2.3.0 → 2.5.0

package/native.d.ts

@@ -3,6 +3,76 @@
 
 /* auto-generated by NAPI-RS */
 
+/**
+ * Configuration for the Java class proxy.
+ *
+ * @since 2.4.0
+ */
+export interface ClassConfiguration {
+  /**
+   * If true, the event loop will be run when an interface proxy is active.
+   * If not specified, the value from the global configuration will be used.
+   */
+  runEventLoopWhenInterfaceProxyIsActive?: boolean
+  /**
+   * If true, the custom inspect method will be used to display the object in the console.
+   * If not specified, the value from the global configuration will be used.
+   */
+  customInspect?: boolean
+  /**
+   * The suffix to use for synchronous methods.
+   * Set this value to an empty string to disable the suffix.
+   * The default value is "Sync".
+   * Setting this value to the same value as asyncSuffix will result in an error.
+   * If not specified, the value from the global configuration will be used.
+   */
+  syncSuffix?: string
+  /**
+   * The suffix to use for asynchronous methods.
+   * Set this value to an empty string to disable the suffix.
+   * The default value is an empty string.
+   * Setting this value to the same value as syncSuffix will result in an error.
+   * If not specified, the value from the global configuration will be used.
+   */
+  asyncSuffix?: string
+}
+/**
+ * Configuration for the Java class proxy.
+ *
+ * @since 2.4.0
+ */
+export interface Config {
+  /**
+   * If true, the event loop will be run when an interface proxy is active.
+   *
+   * @since 2.2.3
+   */
+  runEventLoopWhenInterfaceProxyIsActive: boolean
+  /**
+   * If true, the custom inspect method will be used to display the object in the console.
+   *
+   * @since 2.4.0
+   */
+  customInspect: boolean
+  /**
+   * The suffix to use for synchronous methods.
+   * Set this value to an empty string to disable the suffix.
+   * The default value is "Sync".
+   * Setting this value to the same value as asyncSuffix will result in an error.
+   *
+   * @since 2.4.0
+   */
+  syncSuffix?: string
+  /**
+   * The suffix to use for asynchronous methods.
+   * Set this value to an empty string to disable the suffix.
+   * The default value is an empty string.
+   * Setting this value to the same value as syncSuffix will result in an error.
+   *
+   * @since 2.4.0
+   */
+  asyncSuffix?: string
+}
 /** Options for the interface proxies */
 export interface InterfaceProxyOptions {
   /**
@@ -13,6 +83,14 @@ export interface InterfaceProxyOptions {
 }
 /** Clears the list of daemon proxies. */
 export function clearDaemonProxies(): void
+/**
+ * Clear the class proxy cache.
+ * Use this method in order to reset the config for all class proxies.
+ * The new config will be applied once the class is imported again.
+ *
+ * @since 2.4.0
+ */
+export function clearClassProxies(): void
 /**
  * Options for the Java VM.
  * Not the same as vm arguments.
@@ -54,13 +132,13 @@ export class Java {
    * Will import the class and parse all of its methods and fields.
    * The imported class will be cached for future use.
    */
-  importClass(className: string): object
+  importClass(className: string, config?: ClassConfiguration | undefined | null): object
   /**
    * Import a java class (async)
    * Will return a promise that resolves to the class instance.
    * @see importClass
    */
-  importClassAsync(className: string): Promise<object>
+  importClassAsync(className: string, config?: ClassConfiguration | undefined | null): Promise<object>
   /**
    * Get the wanted JVM version.
    * This may not match the actual JVM version.
@@ -83,11 +161,189 @@ export class Java {
   get classLoader(): object
   set classLoader(classLoader: object)
 }
+/**
+ * Configuration options for the java bridge.
+ *
+ * As of version 2.4.0, the options are cached inside the class proxy cache.
+ * This means that changing the options will not affect any class proxies
+ * that have already been created by importing a class using {@link importClass}
+ * or {@link importClassAsync}. You must clear the class proxy cache using the
+ * {@link clearClassProxies} method in order to apply the new options to all
+ * classes imported at a later date. This does not affect already instantiated
+ * or imported classes.
+ *
+ * Do not instantiate this class. Use the {@link default.config} instance instead.
+ *
+ * @since 2.2.3
+ */
 export class JavaConfig {
-  static setRunEventLoopWhenInterfaceProxyIsActive(value: boolean): void
-  static getRunEventLoopWhenInterfaceProxyIsActive(): boolean
+  /**
+   * Do not instantiate this class.
+   * Use the {@link default.config} instance instead.
+   */
+  constructor()
+  /**
+   * **Experimental Feature**
+   *
+   * Set whether to run the event loop when an interface proxy is active.
+   * This is disabled by default. Enabling this will cause the bridge
+   * to run the event loop when an interface proxy either as direct
+   * proxy or as daemon proxy is active. This is only required if the
+   * proxied method calls back into the javascript process in the same thread.
+   * If the proxy is used either in an async method or in a different thread,
+   * this is not required.
+   *
+   * **Note:** Enabling this may cause the application to crash. Use with caution.
+   *
+   * @since 2.2.3
+   * @experimental
+   * @param value whether to run the event loop when an interface proxy is active
+   */
+  set runEventLoopWhenInterfaceProxyIsActive(value: boolean)
+  /**
+   * **Experimental Feature**
+   *
+   * Get whether to run the event loop when an interface proxy is active.
+   * @since 2.2.3
+   * @experimental
+   */
+  get runEventLoopWhenInterfaceProxyIsActive(): boolean
+  /**
+   * Whether to add custom inspect methods to java objects.
+   * This is disabled by default.
+   * This allows console.log to print java objects in a more readable way
+   * using the `toString` method of the java object.
+   *
+   * @since 2.4.0
+   * @param value whether to add custom inspect methods to java objects
+   */
+  set customInspect(value: boolean)
+  /**
+   * Get whether to add custom inspect methods to java objects.
+   *
+   * @since 2.4.0
+   * @returns whether to add custom inspect methods to java objects
+   */
+  get customInspect(): boolean
+  /**
+   * Set the suffix for synchronous methods.
+   * This is `Sync` by default.
+   * Pass `null` or an empty string to disable the suffix.
+   * This must not be the same as the {@link asyncSuffix}.
+   *
+   * This option does not affect standard methods of java classes
+   * like `toString`, `toStringSync`, `toStringAsync` and `newInstanceAsync`.
+   *
+   * ## Example
+   * ```ts
+   * import { config, clearClassProxies } from 'java-bridge';
+   *
+   * // Set the async suffix in order to prevent errors
+   * config.asyncSuffix = 'Async';
+   * // Set the sync suffix to an empty string
+   * config.syncSuffix = '';
+   * // This would do the same
+   * config.syncSuffix = null;
+   *
+   * // Clear the class proxy cache
+   * clearClassProxies();
+   *
+   * // Import the class
+   * const ArrayList = importClass('java.util.ArrayList');
+   *
+   * // Create a new instance
+   * const list = new ArrayList();
+   *
+   * // Call the method
+   * list.add('Hello World!');
+   *
+   * // Async methods now have the 'Async' suffix
+   * await list.addAsync('Hello World!');
+   * ```
+   *
+   * @see asyncSuffix
+   * @since 2.4.0
+   * @param value the suffix to use for synchronous methods
+   */
+  set syncSuffix(value: string | undefined | null)
+  /**
+   * Get the suffix for synchronous methods.
+   *
+   * @since 2.4.0
+   */
+  get syncSuffix(): string | null
+  /**
+   * Set the suffix for asynchronous methods.
+   * This is `Async` by default.
+   * Pass `null` or an empty string to disable the suffix.
+   * This must not be the same as the {@link syncSuffix}.
+   *
+   * This option does not affect standard methods of java classes
+   * like `toString`, `toStringSync`, `toStringAsync` and `newInstanceAsync`.
+   *
+   * @see syncSuffix
+   * @since 2.4.0
+   * @param value the suffix to use for asynchronous methods
+   */
+  set asyncSuffix(value: string | undefined | null)
+  /**
+   * Get the suffix for asynchronous methods.
+   *
+   * @since 2.4.0
+   */
+  get asyncSuffix(): string | null
+  /**
+   * Override the whole config.
+   * If you want to change only a single field, use the static setters instead.
+   *
+   * @since 2.4.0
+   * @param value the config to use
+   */
+  set config(value: Config)
+  /**
+   * Get the current config.
+   *
+   * @since 2.4.0
+   */
+  get config(): Config
+  /**
+   * Reset the config to the default values.
+   *
+   * @since 2.4.0
+   */
+  reset(): void
 }
 export class StdoutRedirect {
   on(event: string, callback?: ((...args: any[]) => any) | null): void
   reset(): void
 }
+export namespace logging {
+  /**
+   * This method is not supported in this build.
+   * It will print a warning to stderr when called.
+   *
+   * Re-compile the native module with the `log` feature to enable logging.
+   */
+  export function setLogCallbacks(out: ((data: string | null) => void) | null | undefined, err: ((data: string | null) => void) | null | undefined): void
+  /**
+   * This method is not supported in this build.
+   * It will print a warning to stderr when called.
+   *
+   * Re-compile the native module with the `log` feature to enable logging.
+   */
+  export function initLogger(path: string): void
+  /**
+   * This method is not supported in this build.
+   * It will print a warning to stderr when called.
+   *
+   * Re-compile the native module with the `log` feature to enable logging.
+   */
+  export function resetLogCallbacks(): void
+  /**
+   * Whether logging is supported.
+   * Logging is disabled by default.
+   * This constant currently is set to `false`
+   * as logging is not supported in this build.
+   */
+  export const LOGGING_SUPPORTED: boolean
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "java-bridge",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "main": "dist/index.prod.min.js",
   "types": "dist/index.d.ts",
   "description": "A bridge between Node.js and Java APIs",
@@ -26,7 +26,8 @@
       "additional": [
         "aarch64-apple-darwin",
         "i686-pc-windows-msvc",
-        "aarch64-unknown-linux-gnu"
+        "aarch64-unknown-linux-gnu",
+        "x86_64-unknown-linux-musl"
       ]
     }
   },
@@ -43,73 +44,75 @@
   },
   "scripts": {
     "artifacts": "napi artifacts",
+    "build:all": "npm run build:napi -- --features all && npm run postbuild",
     "build": "npm run build:napi",
-    "build:debug": "npm run build:napi:debug && npm run build:ts && npm run build:java",
-    "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 && cpy native.d.ts dist",
+    "build:debug": "npm run build:napi:debug && npm run build:java && npm run build:ts",
+    "postbuild": "npm run build:java && npm run build:ts",
+    "build:napi": "napi build --cargo-name java --platform --release --js native.js --dts native.d.ts",
+    "build:napi:debug": "napi build --cargo-name java --platform --js native.js --dts native.d.ts",
+    "build:ts": "webpack build",
     "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": "npm run testOnly",
     "testOnly": "npm run mocha",
-    "mocha": "mocha -r ts-node/register test/*.test.ts --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
+    "mocha": "cross-env NODE_OPTIONS=\"--import tsx\" mocha test/*.test.ts --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
     "pretest": "npm run build",
     "version": "napi version",
     "prettier": "prettier --write .",
+    "prettier:check": "prettier --check .",
     "prebuild": "rimraf dist",
     "prebuild:debug": "rimraf dist",
-    "benchmark": "ts-node -P test/tsconfig.json test/benchmark/benchmark.ts",
+    "benchmark": "tsx --tsconfig test/tsconfig.json test/benchmark/benchmark.ts",
     "prebenchmark": "npm run build",
     "docs": "typedoc --out docs ts-src/index.ts"
   },
-  "dependencies": {
-    "glob": "^10.0.0"
-  },
   "devDependencies": {
-    "@napi-rs/cli": "^2.15.2",
-    "@types/chai": "^4.3.4",
-    "@types/folder-hash": "^4.0.2",
+    "@napi-rs/cli": "^2.16.2",
+    "@types/chai": "^4.3.5",
+    "@types/chai-as-promised": "^7.1.5",
     "@types/is-ci": "^3.0.0",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.15.11",
-    "@types/semver": "^7.3.13",
+    "@types/node": "^20.4.10",
+    "@types/semver": "^7.5.0",
+    "@types/webpack-env": "^1.18.1",
     "@types/webpack-node-externals": "^3.0.0",
-    "@types/which": "^3.0.0",
     "@types/yargs": "^17.0.24",
-    "chai": "^4.3.7",
-    "cpy-cli": "^4.2.0",
+    "chai": "^4.4.1",
+    "chai-as-promised": "^7.1.1",
+    "copy-webpack-plugin": "^12.0.2",
+    "cpy-cli": "^5.0.0",
+    "cross-env": "^7.0.3",
     "expose-gc": "^1.0.0",
-    "folder-hash": "^4.0.4",
     "is-ci": "^3.0.1",
     "mocha": "^10.2.0",
-    "mocha-junit-reporter": "^2.2.0",
+    "mocha-junit-reporter": "^2.2.1",
     "mocha-multi-reporters": "^1.5.1",
     "nanobench": "^3.0.0",
     "node-loader": "^2.0.0",
-    "prettier": "^2.8.7",
-    "rimraf": "^5.0.0",
+    "prettier": "^3.0.1",
+    "rimraf": "^5.0.1",
     "run-script-os": "^1.1.6",
-    "semver": "^7.4.0",
+    "semver": "^7.5.4",
     "string-replace-loader": "^3.1.0",
-    "ts-loader": "^9.4.2",
+    "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
-    "tslib": "^2.5.0",
-    "typedoc": "^0.24.1",
-    "typescript": "^5.0.4",
-    "webpack": "^5.79.0",
-    "webpack-cli": "^5.0.1",
-    "webpack-node-externals": "^3.0.0",
-    "which": "^3.0.0"
+    "tslib": "^2.6.1",
+    "tsx": "^4.7.1",
+    "typedoc": "^0.25.8",
+    "typescript": "^5.3.3",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4",
+    "webpack-node-externals": "^3.0.0"
   },
   "optionalDependencies": {
-    "java-bridge-win32-x64-msvc": "2.3.0",
-    "java-bridge-darwin-x64": "2.3.0",
-    "java-bridge-linux-x64-gnu": "2.3.0",
-    "java-bridge-darwin-arm64": "2.3.0",
-    "java-bridge-win32-ia32-msvc": "2.3.0",
-    "java-bridge-linux-arm64-gnu": "2.3.0"
+    "java-bridge-win32-x64-msvc": "2.5.0",
+    "java-bridge-darwin-x64": "2.5.0",
+    "java-bridge-linux-x64-gnu": "2.5.0",
+    "java-bridge-darwin-arm64": "2.5.0",
+    "java-bridge-win32-ia32-msvc": "2.5.0",
+    "java-bridge-linux-arm64-gnu": "2.5.0",
+    "java-bridge-linux-x64-musl": "2.5.0"
   }
 }