mirror of
https://github.com/chatmail/core.git
synced 2026-04-19 06:26:30 +03:00
c375c03d8e
- [x] figgure out how to build the packages (that it installs native optional package automatically) - [X] Make the gluecode - [x] expose both the lowerlevel api that desktop uses (~~send objects and receive objects~~, getting path of rpc-server is enough) - [X] and the higher level api needed for bots (jsonrpc client) - [X] typescript types - [x] automatically pick the right binary from npm or allow getting it from env var, or give out an error (throw error) - [x] find out how to dev locally (use local built core in dc desktop) - there is the question of how to link the typescript client and the task to add a search in the cargo target folder for a debug build or a different way, find out some good flow that we can use and document for dc desktop + locally built core development - [x] build the packages in ci - [x] fix that deltachat-rpc-server is not executable postponed: - [ ] publish from ci - [ ] add key/token to deploy to npm Closes #4694 ## Related prs - https://github.com/deltachat-bot/echo/pull/69 - https://github.com/deltachat/deltachat-desktop/pull/3567 --------- Co-authored-by: link2xt <link2xt@testrun.org>
78 lines
3.4 KiB
Markdown
78 lines
3.4 KiB
Markdown
## npm package for deltachat-rpc-server
|
|
|
|
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).
|
|
|
|
## Usage
|
|
|
|
> The **minimum** nodejs version for this package is `20.11`
|
|
|
|
```
|
|
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());
|
|
}
|
|
```
|
|
|
|
For a more complete example refer to https://github.com/deltachat-bot/echo/pull/69/files (TODO change link when pr is merged).
|
|
|
|
## How to use on an unsupported platform
|
|
|
|
<!-- todo instructions, will uses an env var for pointing to `deltachat-rpc-server` binary -->
|
|
|
|
<!-- todo copy parts from https://github.com/deltachat/deltachat-desktop/blob/7045c6f549e4b9d5caa0709d5bd314bbd9fd53db/docs/UPDATE_CORE.md -->
|
|
|
|
## How does it work when you install it
|
|
|
|
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://web.archive.org/web/20240309234250/https://napi.rs/docs/deep-dive/release#3-the-native-addon-for-different-platforms-is-distributed-through-different-npm-packages)
|
|
- 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
|
|
2. in PATH
|
|
- unless `DELTA_CHAT_SKIP_PATH=1` is specified
|
|
- searches in .cargo/bin directory first
|
|
- but there an additional version check is performed
|
|
3. prebuilds in npm packages
|
|
|
|
## How do you built this package in CI
|
|
|
|
- To build platform packages, run the `build_platform_package.py` script:
|
|
```
|
|
python3 build_platform_package.py <cargo-target>
|
|
# example
|
|
python3 build_platform_package.py x86_64-apple-darwin
|
|
```
|
|
- 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/platform_package`.
|
|
- then publish `deltachat-rpc-server/npm-package`,
|
|
- this will run `update_optional_dependencies_and_version.js` (in the `prepack` script),
|
|
which puts all platform packages into `optionalDependencies` and updates the `version` in `package.json`
|
|
|
|
## How to build a version you can use localy on your host machine for development
|
|
|
|
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 seperate scripts for making it work for local installation.
|
|
|
|
- If you just need your host platform run `python scripts/make_local_dev_version.py`
|
|
- note: this clears the `platform_package` folder
|
|
- (advanced) If you need more than one platform for local install you can just run `node scripts/update_optional_dependencies_and_version.js` after building multiple plaftorms with `build_platform_package.py`
|
|
|
|
## Thanks to nlnet
|
|
|
|
The initial work on this package was funded by nlnet as part of the [Delta Tauri](https://nlnet.nl/project/DeltaTauri/) Project.
|