This is the successor of `deltachat-node`, it does not use NAPI bindings but instead uses stdio executables to let you talk to core over jsonrpc over stdio. This simplifies cross-compilation and even reduces binary size (no CFFI layer and no NAPI layer).
npm install @deltachat/stdio-rpc-serverThis is the successor of deltachat-node,
it does not use NAPI bindings but instead uses stdio executables
to let you talk to core over jsonrpc over stdio.
This simplifies cross-compilation and even reduces binary size (no CFFI layer and no NAPI layer).
> The minimum nodejs version for this package is 16
```
npm i @deltachat/stdio-rpc-server @deltachat/jsonrpc-client
`js
import { startDeltaChat } from "@deltachat/stdio-rpc-server";
import { C } from "@deltachat/jsonrpc-client";
async function main() {
const dc = await startDeltaChat("deltachat-data");
console.log(await dc.rpc.getSystemInfo());
dc.close()
}
main()
`
For a more complete example refer to https://github.com/deltachat-bot/echo/pull/69/files (TODO change link when pr is merged).
NPM automatically installs platform dependent optional dependencies when os and cpu fields are set correctly.
references:
- https://napi.rs/docs/deep-dive/release#3-the-native-addon-for-different-platforms-is-distributed-through-different-npm-packages, webarchive version
- https://docs.npmjs.com/cli/v6/configuring-npm/package-json#cpu
- https://docs.npmjs.com/cli/v6/configuring-npm/package-json#os
When you import this package it searches for the rpc server in the following locations and order:
1. DELTA_CHAT_RPC_SERVER environment variable{takeVersionFromPATH: true}
2. use the PATH when is supplied in the options.
3. prebuilds in npm packages
so by default it uses the prebuilds.
- To build platform packages, run the build_platform_package.py script:`
`
python3 build_platform_package.py
# example
python3 build_platform_package.py x86_64-apple-darwin
deltachat-rpc-server/npm-package/platform_package
- Then pass it as an artifact to the last CI action that publishes the main package.
- upload all packages from .deltachat-rpc-server/npm-package
- then publish ,update_optional_dependencies_and_version.js
- this will run (in the prepack script),optionalDependencies
which puts all platform packages into and updates the version in package.json
You can not install the npm packet from the previous section locally, unless you have a local npm registry set up where you upload it too. This is why we have separate scripts for making it work for local installation.
- If you just need your host platform run python scripts/make_local_dev_version.pyplatform_package
- note: this clears the foldernode scripts/update_optional_dependencies_and_version.js
- (advanced) If you need more than one platform for local install you can just run after building multiple platforms with build_platform_package.py`
The initial work on this package was funded by nlnet as part of the Delta Tauri Project.