java-bridge 2.2.3-beta.3 → 2.2.3

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

@@ -2,6 +2,7 @@ export interface MethodDeclaration {
     returnType: string;
     parameters: string[];
     isStatic: boolean;
+    isDefault: boolean;
 }
 /**
  * A java class declaration converted to typescript
@@ -41,8 +42,11 @@ export default class TypescriptDefinitionGenerator {
     private readonly progressCallback;
     private readonly resolvedImports;
     private usesBasicOrJavaType;
+    private usesNewProxy;
+    private usesInterfaceProxy;
     private readonly additionalImports;
     private readonly importsToResolve;
+    private readonly interfaceImports;
     /**
      * Create a new `TypescriptDefinitionGenerator` instance
      *
@@ -64,6 +68,9 @@ export default class TypescriptDefinitionGenerator {
     private convertParameter;
     private convertParameters;
     private static createMethodComment;
+    private createMethodSignature;
+    private createInterfaceMethodSignatures;
+    private createNewProxyMethod;
     private createMethod;
     private convertMethod;
     private getAdditionalImports;

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

@@ -434,7 +434,12 @@ export declare namespace stdout {
  * ## See also
  * * {@link newProxy}
  */
-export interface JavaInterfaceProxy {
+export interface JavaInterfaceProxy<T extends ProxyRecord<T> = AnyProxyRecord> {
+    /**
+     * A dummy property to make sure the type is correct.
+     * This property will never be set.
+     */
+    _dummy?: T;
     /**
      * Destroy the proxy class.
      * After this call any call to any method defined by the
@@ -458,6 +463,8 @@ export interface JavaInterfaceProxy {
  * @return the value to pass back to the java process
  */
 export type ProxyMethod = (...args: any[]) => any;
+export type ProxyRecord<T> = Partial<Record<keyof T, ProxyMethod>>;
+export type AnyProxyRecord = Record<string, ProxyMethod>;
 /**
  * Create a new java interface proxy.
  * This allows you to implement java interfaces in javascript.
@@ -569,7 +576,27 @@ export type ProxyMethod = (...args: any[]) => any;
  * ### Keeping the proxy alive
  * If you want to keep the proxy alive, you must keep this instance in scope.
  * If that is not an option for you, you can manually keep the proxy alive
- * by setting the {@link InterfaceProxyOptions.keepAsDaemon} option to true.
+ * by setting the {@link InterfaceProxyOptions}.keepAsDaemon option to true.
+ *
+ * ```ts
+ * const proxy = newProxy('java.lang.Runnable', {
+ *    run: (): void => {
+ *      console.log('Hello World!');
+ *    }
+ * }, {
+ *    keepAsDaemon: true
+ * });
+ *
+ * const TimeUnit = java.importClass('java.util.concurrent.TimeUnit');
+ * const ScheduledThreadPoolExecutor = java.importClass(
+ *     'java.util.concurrent.ScheduledThreadPoolExecutor'
+ * );
+ * const executor = new ScheduledThreadPoolExecutor(1);
+ *
+ * // 'proxy' will eventually be garbage collected,
+ * // but it will be kept alive due to this option.
+ * executor.scheduleAtFixedRateSync(proxy, 0, 1, TimeUnit.SECONDS);
+ * ```
  *
  * This will keep the proxy alive internally, thus the instance can be moved
  * out of scope. However, this will also keep the JVM alive, so you should
@@ -589,7 +616,7 @@ export type ProxyMethod = (...args: any[]) => any;
  * @param opts the options to use
  * @returns a proxy class to pass back to the java process
  */
-export declare function newProxy(interfaceName: string, methods: Record<string, ProxyMethod>, opts?: InterfaceProxyOptions): JavaInterfaceProxy;
+export declare function newProxy<T extends ProxyRecord<T> = AnyProxyRecord>(interfaceName: string, methods: T, opts?: InterfaceProxyOptions): JavaInterfaceProxy<T>;
 /**
  * Get the static java instance.
  * This has no real use, all important methods are exported explicitly.
@@ -600,6 +627,8 @@ export declare function getJavaInstance(): Java | null;
  */
 export declare class config {
     /**
+     * **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
@@ -610,11 +639,15 @@ export declare class config {
      *
      * **Note:** Enabling this may cause the application to crash. Use with caution.
      *
+     * @experimental
      * @param value whether to run the event loop when an interface proxy is active
      */
     static set runEventLoopWhenInterfaceProxyIsActive(value: boolean);
     /**
+     * **Experimental Feature**
+     *
      * Get whether to run the event loop when an interface proxy is active.
+     * @experimental
      */
     static get runEventLoopWhenInterfaceProxyIsActive(): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "java-bridge",
-  "version": "2.2.3-beta.3",
+  "version": "2.2.3",
   "main": "dist/index.prod.min.js",
   "types": "dist/ts-src/index.d.ts",
   "description": "A bridge between Node.js and Java APIs",
@@ -56,8 +56,9 @@
     "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 --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
+    "testOnly": "npm run mocha",
     "pretestOnly": "npm run generateTestTypes",
+    "mocha": "mocha -r ts-node/register test/*.test.ts --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
     "pretest": "npm run build",
     "version": "napi version",
     "prettier": "prettier --write .",
@@ -78,6 +79,7 @@
   "devDependencies": {
     "@napi-rs/cli": "^2.14.8",
     "@types/chai": "^4.3.4",
+    "@types/folder-hash": "^4.0.2",
     "@types/glob": "^8.1.0",
     "@types/is-ci": "^3.0.0",
     "@types/mocha": "^10.0.1",
@@ -89,6 +91,7 @@
     "chai": "^4.3.7",
     "cpy-cli": "^4.2.0",
     "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",
@@ -110,11 +113,11 @@
     "which": "^3.0.0"
   },
   "optionalDependencies": {
-    "java-bridge-win32-x64-msvc": "2.2.3-beta.3",
-    "java-bridge-darwin-x64": "2.2.3-beta.3",
-    "java-bridge-linux-x64-gnu": "2.2.3-beta.3",
-    "java-bridge-darwin-arm64": "2.2.3-beta.3",
-    "java-bridge-win32-ia32-msvc": "2.2.3-beta.3",
-    "java-bridge-linux-arm64-gnu": "2.2.3-beta.3"
+    "java-bridge-win32-x64-msvc": "2.2.3",
+    "java-bridge-darwin-x64": "2.2.3",
+    "java-bridge-linux-x64-gnu": "2.2.3",
+    "java-bridge-darwin-arm64": "2.2.3",
+    "java-bridge-win32-ia32-msvc": "2.2.3",
+    "java-bridge-linux-arm64-gnu": "2.2.3"
   }
 }