@capawesome/capacitor-nodejs 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/classes/events/MessageEvent.java

@@ -0,0 +1,27 @@
+package io.capawesome.capacitorjs.plugins.nodejs.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+
+public class MessageEvent {
+
+    @NonNull
+    private final JSArray args;
+
+    @NonNull
+    private final String eventName;
+
+    public MessageEvent(@NonNull String eventName, @NonNull JSArray args) {
+        this.args = args;
+        this.eventName = eventName;
+    }
+
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("args", args);
+        result.put("eventName", eventName);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/classes/options/SendOptions.java

@@ -0,0 +1,48 @@
+package io.capawesome.capacitorjs.plugins.nodejs.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.nodejs.classes.CustomExceptions;
+
+public class SendOptions {
+
+    @NonNull
+    private final JSArray args;
+
+    @NonNull
+    private final String eventName;
+
+    public SendOptions(@NonNull PluginCall call) throws Exception {
+        this.args = SendOptions.getArgsFromCall(call);
+        this.eventName = SendOptions.getEventNameFromCall(call);
+    }
+
+    @NonNull
+    public JSArray getArgs() {
+        return args;
+    }
+
+    @NonNull
+    public String getEventName() {
+        return eventName;
+    }
+
+    @NonNull
+    private static JSArray getArgsFromCall(@NonNull PluginCall call) {
+        JSArray args = call.getArray("args");
+        if (args == null) {
+            args = new JSArray();
+        }
+        return args;
+    }
+
+    @NonNull
+    private static String getEventNameFromCall(@NonNull PluginCall call) throws Exception {
+        String eventName = call.getString("eventName");
+        if (eventName == null) {
+            throw CustomExceptions.EVENT_NAME_MISSING;
+        }
+        return eventName;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/classes/options/StartOptions.java

@@ -0,0 +1,81 @@
+package io.capawesome.capacitorjs.plugins.nodejs.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+public class StartOptions {
+
+    @NonNull
+    private final List<String> args;
+
+    @NonNull
+    private final Map<String, String> env;
+
+    @Nullable
+    private final String script;
+
+    public StartOptions() {
+        this.args = new ArrayList<>();
+        this.env = new HashMap<>();
+        this.script = null;
+    }
+
+    public StartOptions(@NonNull PluginCall call) {
+        this.args = StartOptions.getArgsFromCall(call);
+        this.env = StartOptions.getEnvFromCall(call);
+        this.script = call.getString("script");
+    }
+
+    @NonNull
+    public List<String> getArgs() {
+        return args;
+    }
+
+    @NonNull
+    public Map<String, String> getEnv() {
+        return env;
+    }
+
+    @Nullable
+    public String getScript() {
+        return script;
+    }
+
+    @NonNull
+    private static List<String> getArgsFromCall(@NonNull PluginCall call) {
+        List<String> args = new ArrayList<>();
+        try {
+            List<Object> values = call.getArray("args", new com.getcapacitor.JSArray()).toList();
+            for (Object value : values) {
+                args.add(value.toString());
+            }
+        } catch (Exception exception) {
+            // No args provided.
+        }
+        return args;
+    }
+
+    @NonNull
+    private static Map<String, String> getEnvFromCall(@NonNull PluginCall call) {
+        Map<String, String> env = new HashMap<>();
+        JSObject envObject = call.getObject("env");
+        if (envObject != null) {
+            Iterator<String> keys = envObject.keys();
+            while (keys.hasNext()) {
+                String key = keys.next();
+                String value = envObject.getString(key);
+                if (value != null) {
+                    env.put(key, value);
+                }
+            }
+        }
+        return env;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/classes/results/IsReadyResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.nodejs.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.nodejs.interfaces.Result;
+
+public class IsReadyResult implements Result {
+
+    private final boolean ready;
+
+    public IsReadyResult(boolean ready) {
+        this.ready = ready;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("ready", ready);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.nodejs.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.nodejs.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.nodejs.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/nodejs/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.nodejs.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/dist/docs.json

@@ -0,0 +1,432 @@
+{
+  "api": {
+    "name": "NodejsPlugin",
+    "slug": "nodejsplugin",
+    "docs": "",
+    "tags": [
+      {
+        "text": "0.0.1",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "isReady",
+        "signature": "() => Promise<IsReadyResult>",
+        "parameters": [],
+        "returns": "Promise<IsReadyResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Check if the Node.js runtime is ready to receive messages.\n\nThe Node.js runtime is considered ready as soon as the Node.js project\nhas required the `bridge` module.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsReadyResult"
+        ],
+        "slug": "isready"
+      },
+      {
+        "name": "send",
+        "signature": "(options: SendOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SendOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Send a message to the Node.js runtime.\n\nThis method is only available when the Node.js runtime is ready.\nUse the `isReady()` method or the `ready` event to check if the\nNode.js runtime is ready.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "SendOptions"
+        ],
+        "slug": "send"
+      },
+      {
+        "name": "start",
+        "signature": "(options?: StartOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Start the Node.js runtime manually.\n\nThis method is only available if the `startMode` configuration option\nis set to `manual`.\n\n**Attention**: The Node.js runtime can only be started once per app\nlaunch. Stopping and restarting the Node.js runtime is not supported.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "StartOptions"
+        ],
+        "slug": "start"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'message', listenerFunc: (event: MessageEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'message'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: MessageEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Called when a message is received from the Node.js runtime.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "MessageEvent"
+        ],
+        "slug": "addlistenermessage-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'ready', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'ready'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Called when the Node.js runtime is ready to receive messages.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerready-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "IsReadyResult",
+      "slug": "isreadyresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "ready",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether or not the Node.js runtime is ready to receive messages.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SendOptions",
+      "slug": "sendoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "args",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "['Hello from Capacitor!']",
+              "name": "example"
+            }
+          ],
+          "docs": "The arguments to send to the Node.js runtime.",
+          "complexTypes": [
+            "MessageArg"
+          ],
+          "type": "MessageArg[] | undefined"
+        },
+        {
+          "name": "eventName",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'my-event'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the event to send to the Node.js runtime.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "StartOptions",
+      "slug": "startoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "args",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "['--option', 'value']",
+              "name": "example"
+            }
+          ],
+          "docs": "The arguments to pass to the Node.js process.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "env",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "{ MY_ENV_VAR: 'value' }",
+              "name": "example"
+            }
+          ],
+          "docs": "The environment variables to set for the Node.js process.",
+          "complexTypes": [],
+          "type": "{ [key: string]: string; } | undefined"
+        },
+        {
+          "name": "script",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "The `main` field of the `package.json` file of the Node.js project.",
+              "name": "default"
+            },
+            {
+              "text": "'custom-main.js'",
+              "name": "example"
+            }
+          ],
+          "docs": "The path of the script file to run, relative to the Node.js project directory.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "MessageEvent",
+      "slug": "messageevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.0.1",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "args",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "['Hello from Node.js!']",
+              "name": "example"
+            }
+          ],
+          "docs": "The arguments received from the Node.js runtime.",
+          "complexTypes": [
+            "MessageArg"
+          ],
+          "type": "MessageArg[]"
+        },
+        {
+          "name": "eventName",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'my-event'",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the event received from the Node.js runtime.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "MessageArg",
+      "slug": "messagearg",
+      "docs": "A single argument of a message that is exchanged with the Node.js runtime.",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        },
+        {
+          "text": "number",
+          "complexTypes": []
+        },
+        {
+          "text": "boolean",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": [
+    {
+      "name": "Nodejs",
+      "slug": "nodejs",
+      "properties": [
+        {
+          "name": "nodeDir",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'nodejs'",
+              "name": "default"
+            },
+            {
+              "text": "'custom-nodejs'",
+              "name": "example"
+            }
+          ],
+          "docs": "The directory of the Node.js project, relative to the Capacitor `webDir`.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "startMode",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            },
+            {
+              "text": "'auto'",
+              "name": "default"
+            },
+            {
+              "text": "'manual'",
+              "name": "example"
+            }
+          ],
+          "docs": "The start mode of the Node.js runtime.\n\nIf set to `auto`, the Node.js runtime starts automatically when the app is launched.\nIf set to `manual`, the Node.js runtime must be started manually using the `start(...)` method.\n\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "'manual' | 'auto' | undefined"
+        }
+      ],
+      "docs": ""
+    }
+  ]
+}