@deltachat/stdio-rpc-server 1.138.0 → 1.139.0

package/README.md

@@ -20,7 +20,9 @@ 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).

package/index.d.ts

@@ -20,17 +20,20 @@ export function getRPCServerPath(
 
 
 export type DeltaChatOverJsonRpcServer = StdioDeltaChat & {
-    shutdown: () => Promise<void>;
     readonly pathToServerBinary: string;
 };
 
+export interface StartOptions {
+  /** whether to disable outputting stderr to the parent process's stderr */
+  muteStdErr: boolean;
+}
 
 /**
  * 
  * @param directory directory for accounts folder
  * @param options 
  */
-export function startDeltaChat(directory: string, options?: Partial<SearchOptions> ): Promise<DeltaChatOverJsonRpcServer>
+export function startDeltaChat(directory: string, options?: Partial<SearchOptions & StartOptions> ): Promise<DeltaChatOverJsonRpcServer>
 
 
 export namespace FnTypes {

package/index.js

@@ -22,10 +22,6 @@ import {
 import package_json from "./package.json" with { type: "json" };
 import { createRequire } from "node:module";
 
-// exports
-// - [ ] a raw starter that has a stdin/out handle thingie like desktop uses
-// - [X] a function that already wraps the stdio handle from above into the deltachat jsonrpc bindings
-
 function findRPCServerInNodeModules() {
   const arch = os.arch();
   const operating_system = process.platform;
@@ -43,6 +39,32 @@ function findRPCServerInNodeModules() {
   }
 }
 
+/**
+ * @returns {Promise<string>}
+ */
+async function getLocationInPath() {
+  const exec = promisify(execFile);
+
+  if (os.platform() === "win32") {
+    const { stdout: executable } = await exec("where", [PATH_EXECUTABLE_NAME], {
+      shell: true,
+    });
+    return executable;
+  }
+
+  try {
+    const { stdout: executable } = await exec(
+      "command",
+      ["-v", PATH_EXECUTABLE_NAME],
+      { shell: true }
+    );
+    return executable;
+  } catch (error) {
+    if (error.code > 0) return "";
+    else throw error;
+  }
+}
+
 /** @type {import("./index").FnTypes.getRPCServerPath} */
 export async function getRPCServerPath(
   options = { skipSearchInPath: false, disableEnvPath: false }
@@ -65,19 +87,18 @@ export async function getRPCServerPath(
 
   // 2. check if it can be found in PATH
   if (!process.env[SKIP_SEARCH_IN_PATH] && !skipSearchInPath) {
-    const exec = promisify(execFile);
-
-    const { stdout: executable } =
-      os.platform() !== "win32"
-        ? await exec("command", ["-v", PATH_EXECUTABLE_NAME])
-        : await exec("where", [PATH_EXECUTABLE_NAME]);
+    const executable = await getLocationInPath();
 
     // by just trying to execute it and then use "command -v deltachat-rpc-server" (unix) or "where deltachat-rpc-server" (windows) to get the path to the executable
     if (executable.length > 1) {
       // test if it is the right version
       try {
         // for some unknown reason it is in stderr and not in stdout
-        const { stderr } = await promisify(execFile)(executable, ["--version"]);
+        const { stderr } = await promisify(execFile)(
+          executable,
+          ["--version"],
+          { shell: true }
+        );
         const version = stderr.slice(0, stderr.indexOf("\n"));
         if (package_json.version !== version) {
           throw new Error(
@@ -109,6 +130,7 @@ export async function startDeltaChat(directory, options) {
       RUST_LOG: process.env.RUST_LOG || "info",
       DC_ACCOUNTS_PATH: directory,
     },
+    stdio: ["pipe", "pipe", options.muteStdErr ? "ignore" : "inherit"],
   });
 
   server.on("error", (err) => {
@@ -123,13 +145,11 @@ export async function startDeltaChat(directory, options) {
     throw new Error("Server quit");
   });
 
-  server.stderr.pipe(process.stderr);
-
   /** @type {import('./index').DeltaChatOverJsonRpcServer} */
   //@ts-expect-error
   const dc = new StdioDeltaChat(server.stdin, server.stdout, true);
 
-  dc.shutdown = async () => {
+  dc.close = () => {
     shouldClose = true;
     if (!server.kill()) {
       console.log("server termination failed");

package/package.json

@@ -3,24 +3,28 @@
     "main": "index.js",
     "name": "@deltachat/stdio-rpc-server",
     "optionalDependencies": {
-        "@deltachat/stdio-rpc-server-darwin-arm64": "1.138.0",
-        "@deltachat/stdio-rpc-server-android-arm64": "1.138.0",
-        "@deltachat/stdio-rpc-server-linux-arm64": "1.138.0",
-        "@deltachat/stdio-rpc-server-linux-arm": "1.138.0",
-        "@deltachat/stdio-rpc-server-android-arm": "1.138.0",
-        "@deltachat/stdio-rpc-server-win32-i32": "1.138.0",
-        "@deltachat/stdio-rpc-server-linux-i32": "1.138.0",
-        "@deltachat/stdio-rpc-server-darwin-x64": "1.138.0",
-        "@deltachat/stdio-rpc-server-win32-x64": "1.138.0",
-        "@deltachat/stdio-rpc-server-linux-x64": "1.138.0"
+        "@deltachat/stdio-rpc-server-darwin-arm64": "1.139.0",
+        "@deltachat/stdio-rpc-server-android-arm64": "1.139.0",
+        "@deltachat/stdio-rpc-server-linux-arm64": "1.139.0",
+        "@deltachat/stdio-rpc-server-linux-arm": "1.139.0",
+        "@deltachat/stdio-rpc-server-android-arm": "1.139.0",
+        "@deltachat/stdio-rpc-server-win32-ia32": "1.139.0",
+        "@deltachat/stdio-rpc-server-linux-ia32": "1.139.0",
+        "@deltachat/stdio-rpc-server-darwin-x64": "1.139.0",
+        "@deltachat/stdio-rpc-server-win32-x64": "1.139.0",
+        "@deltachat/stdio-rpc-server-linux-x64": "1.139.0"
     },
     "peerDependencies": {
         "@deltachat/jsonrpc-client": "*"
     },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/deltachat/deltachat-core-rust.git"
+    },
     "scripts": {
         "prepack": "node scripts/update_optional_dependencies_and_version.js"
     },
     "type": "module",
     "types": "index.d.ts",
-    "version": "1.138.0"
+    "version": "1.139.0"
 }