hampoelz / capacitor-nodejs Goto Github PK

Take advantage of new CapacitorJS enhancements such as gradle 8, Java 17, and the Android 13 target (which is required for new apps starting August 2023).

This also fixes the failing npm install with Capacitor v5 apps (#11).

Execution failed for task ':capacitor-nodejs:compileDebugJavaWithJavac'.

error: invalid source release: 17

As per https://github.com/nodejs-mobile/nodejs-mobile-cordova#nodejsstartscriptfilename-callback--options

It'd also be nice to have be able to pass environment variables as well.

I'm embedding a web service for an "offline only" version of my application, so I need to be able to configure it on boot based on settings provided by the android side of things. Environment varaibles are more convenient for me personally, but just being able to pass the args from the android side would be ok too.

I'm curently just using Os.setenv in a copy of the plugin since I haven't yet expanded my java skills.

Hi,

I created a simple capacitor android app and everything seems fine on the emulator , but when I tried it on a real device unfortunately it didn't . Strangely though when opening the android studio and instead of running it I pressed debug It worked.

Do you have any idea ??

Thanks

I've noticed that if I create the required files inside the dist folder of my vue app, the build will fail because it's unable to found the capacitor nodejs module and the dist folder is deleted. Maybe it's better to deploy them inside the public folder of vuejs project?

I have tried to run on android a node app that includes a dependency that includes the sodium-native package and it crushes.
Does android build, rebuild the npm modules ?

I will investigate further and provide more info.

Thank you. Fantastic job .

Looking at the readme I see that iOS support is "coming soon" ... is there progress being made on this item? Any sense of when it might be ready? Is there some obstacle that I or another contributor can help out with?

Great work , nice to see someone interested in embedding node.js .

I am trying to build an android app using capacitor and node.js. I wanted to include other packages inside node.js but it did not seem to work . Can you please help me.

Node.js without any modules is working fine, but when I install node modules that use native modules it doesn't

Thank you in advance.

Improve type safety and maintainability of the bridge package code. To keep backward compatibility, the module should be packaged as a hybrid package to support both ESM and CJS.

fixes #6 (and #12)
blocked by #15

I'm not getting your recently pushed updates.

I develop my node application separately from my capacitor project and it works completely standalone. I copied the bridge js into my program (with proper attribution and licensing) and then use it as an event listener (Since the channels extend event listener when binding isn't available). I can then test reaction to various events without involving capacitor at all.

I'm not quite sure how i can still do that with the new architecture.

Is there some way to still import the bridge for that usage and not load it twice or will the built bridge.js still work for that case?

Hey I love this project, but i have problems with getting nodejs to run on my phone. Even though I'm fairly certain that I followed the setup steps exactly, I could still be overlooking something.

Do you have an example project with the minimum required files to get a basic functionality going? That would be great!

Thanks for the great work!

Hey there,

When writing some nodejs code, how can I debug it as I go along? I need to sync/build/run every time?

If i change the configuration or arguments passed to nodejs then it'd be nice to be able to restart just nodejs instead of the whole app.

I tried to install capacitor-nodejs on a clean project and I got the bellow results

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: @capacitor/[email protected]
npm ERR! node_modules/@capacitor/core
npm ERR!   peer @capacitor/core@"^5.0.0" from @capacitor/[email protected]
npm ERR!   node_modules/@capacitor/android
npm ERR!     @capacitor/android@"^5.0.5" from the root project
npm ERR!   peer @capacitor/core@"^5.0.0" from @capacitor/[email protected]
npm ERR!   node_modules/@capacitor/camera
npm ERR!     @capacitor/camera@"latest" from the root project
npm ERR!   2 more (@capacitor/splash-screen, the root project)
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! capacitor-nodejs@"https://github.com/hampoelz/capacitor-nodejs/releases/download/v1.0.0-beta.2/capacitor-nodejs.tgz" from the root project
npm ERR! 
npm ERR! Conflicting peer dependency: @capacitor/[email protected]
npm ERR! node_modules/@capacitor/core
npm ERR!   peer @capacitor/core@"^3.0.0 || ^4.0.0" from [email protected]
npm ERR!   node_modules/capacitor-nodejs
npm ERR!     capacitor-nodejs@"https://github.com/hampoelz/capacitor-nodejs/releases/download/v1.0.0-beta.2/capacitor-nodejs.tgz" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /Users/sce9sc/.npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/sce9sc/.npm/_logs/2023-06-22T20_08_23_735Z-debug-0.log

my package json is

{
  "name": "capacitor-app",
  "version": "1.0.0",
  "description": "An Amazing Capacitor App",
  "main": "index.js",
  "keywords": [
    "capacitor",
    "mobile"
  ],
  "scripts": {
    "start": "vite",
    "build": "vite build",
    "preview": "vite preview"
  },
  "dependencies": {
    "@capacitor/android": "^5.0.5",
    "@capacitor/camera": "latest",
    "@capacitor/core": "latest",
    "@capacitor/splash-screen": "latest"
  },
  "devDependencies": {
    "@capacitor/cli": "latest",
    "vite": "^2.9.13"
  },
  "author": "",
  "license": "ISC"
}

Thank you.

Branches shouldn't be used the way they are being used for the example project.
It'd be best to just put the example projects in an examples directory in the main branch or alternatively as separate repositories.

I'd vote for separate repositories.

First of all . very nice work.

I was wondering if there is a way to upgrade the node.js version . I saw that the current version is v12.19.0.

I am not familiar with android but I was wondering if by upgrading the libnode will do . Please tell me if I can help .
Node.js v17 and v18 have many nice features

Currently, npm install inside the nodejs project directory creates a symlink to the bridge module included in the capacitor-nodejs package. When syncing the application with npx cap sync android, the symlink is copied unchanged to the native project, resulting in a symlink pointing to a non-existent path.

A possible solution would be to pack the bridge module and provide a tarball for installation, but this would impact the current implementation of the Electron platform.

As a workaround, install the bridge module with the --install-links option.

First of all, this is an extremely cool project! I was very happy to find that this exists, and I hope it gets the recognition it deserves.

I'm wondering if you would add a TypeScript declaration file to the bridge package? I cobbled together one of my own for the time being, but it would be good to have an official one included.

my project like this：

quasar hava a “\src-capacitor\capacitor.config.json“ and I configure it in this file

{
  "appId": "cn.test",
  "appName": "Quasar App",
  "webDir": "www",
  "server": {
    "androidScheme": "https",
    "url": "http://192.168.1.9:9500"
  },
  "plugins": {
    "CapacitorNodeJS": {
      "nodeDir": "nodejs"
    }
  }
}

I have created the nodejs folder in the ' src capacitor' and root directory，like：

Finally, I imported and used an example of the plugin in “indexPage. vue”

The results I obtained show that the plugin did not import properly

quasar docs：https://quasar.dev/docs

This is necessary to be able to implement the manual start of the node.js runtime / to pass environment variables (#8). In addition, the user node.js and the ElectronJS code would be separated, which is similar to the behavior on Android/iOS.

I set startMode: 'manual' in my capacitor.config.ts

I have my built application in public/nodejs so it gets copied into the build.

I call it like this: await NodeJS.start({ script: 'dist/index.js', env: { NODE_ENV: 'production' } });

The file s located at /data/data/com.example.myApp/files/nodejs/public/dist/index.js (via android device explorer)

I added Logger.info(CapacitorNodeJSPlugin.LOGGER_TAG, "NATIVE START" + Arrays.toString(arguments)); right before the call to nativeStart(arguments, environmentVariables, true); in NodeProcess.java and I see: NATIVE START[node, /data/user/0/com.example.myApp/files/nodejs/public/dist/index.js] so it does seem like it should use that file. However it doesnt seem to actually start my App. Before I go any farther in debugging, is this all I need to do?

EDIT: I should say that when i turn off manual mode and switch back to whenReady() the app boots as expected