@lengmoxxl/sdk 0.1.5 → 0.1.6

package/README.md

@@ -13,7 +13,7 @@
 | `ui.publish(topic, data)` | 后端向本插件 UI 发事件，对应前端 `ui.subscribe` |
 | `ui.subscribe<T>(topic, callback)` | 前端订阅本插件后端事件，返回取消订阅的函数 |
 | `ui.request<T>(method, params?)` | 前端调用本插件后端方法，返回 `Promise<T>` |
-| `connect(machine, signal?)` | 后端借用机器连接：`{ host?: string }`，可带 `AbortSignal` |
+| `connect(machine, signal?)` | 后端借用机器连接：`{ host?, env? }`，可带 `AbortSignal` |
 | `host.dataDirectory` / `host.config` | 插件私有数据目录 / 本插件设置 |
 | `host.tabs(options)` / `host.open(url)` | 前端开侧栏标签页 / 用系统浏览器打开 http、https |
 | `host.preview` | `{ url, message }`，HTML 预览 frame 的地址与握手消息 |
@@ -23,7 +23,7 @@
 `ui.handle` 注册的方法名不能含 `:`；`ui.publish` 与 `ui.subscribe` 的主题由宿主加插件 id 前缀，
 `global` 用原始主题，自定义主题要自己加命名空间（如 `directory-demo:opened`）。
 
-`connect({})` 连接本机，`connect({ host })` 连接 SSH。
+`connect({})` 连接本机，`connect({ host })` 连接 SSH；`env` 是那台机器上节点启动时的环境。
 
 宿主为相同机器复用连接并计数，每次取得连接对应一次 `disconnect()`。
 
@@ -65,6 +65,7 @@
 放入 init.ts `workspaces` 的插件用 `ui.handle` 提供：`workspaces()`（`WorkspaceRow[]`，
 按显示顺序）、`workspace-menu()`（`WorkspaceMenuItem[]`）、`workspace-create({ key })`
 （返回 `{ id }`）、`workspace-select({ id })`、`workspace-close({ id })`、
+`workspace-rename({ id, name })`（名字为空表示交回 provider 自己跟随的名字）、
 `workspace-move({ id, before? })`（`before` 是目标工作区 id，不是索引；省略为末尾，且只
 允许同一 provider 内拖动）。
 
@@ -146,7 +147,9 @@ connection.disconnect();
 
 `openMachine` 返回 `Promise<MachineConnection>`。`type` 为 `'local'` 或 `'ssh'`；local 可给
 `binary`，ssh 必须给 `host`（系统 ssh 目标或别名）与可选 `agent`（`InstallAgent`），两者
-都可给 `signal`。不传 `agent` 时 SDK 不下载二进制；连接用 BatchMode SSH。
+都可给 `env`（节点启动时带上的环境，值里的 `$NAME` 用运行节点那台机器的环境展开）与 `signal`。
+不传 `agent` 时 SDK 不下载二进制；连接用 BatchMode SSH。
 
-`agentCommand(command)` 返回拼接后的 shell 命令：在 PATH 前加入远端 `$HOME/.local/bin`，
-并携带当前进程的 WANGCAI_HOME（会转义；command 本身不转义，只传可信命令）。
+`agentCommand(command, env)` 返回拼接后的 shell 命令：在 PATH 前加入远端 `$HOME/.local/bin`，
+再带上当前进程的 WANGCAI_HOME 与配置要求的环境；值里的 `$NAME` 留给远端 shell 展开。命令本身
+不转义，只传可信内容。

package/dist/agent.d.ts

@@ -1 +1,2 @@
-export declare function agentCommand(command: string): string;
+export declare function exportableEnvironment(env?: Record<string, string>): Record<string, string>;
+export declare function agentCommand(command: string, env?: Record<string, string>): string;

package/dist/channel.d.ts

@@ -1,4 +1,5 @@
 import type { MachineConnection } from './connection';
+import type { Machine } from './types';
 export type Dispose = () => void | Promise<void>;
 /** A sidebar tab the window opens for a plugin: what it is called, and what it draws. */
 export interface TabOptions {
@@ -31,9 +32,7 @@ export interface MainContext {
         handle<T = unknown>(method: string, handler: (params: T) => unknown): Dispose;
         publish(topic: string, data: unknown): void;
     };
-    connect(machine: {
-        host?: string;
-    }, signal?: AbortSignal): Promise<MachineConnection>;
+    connect(machine: Pick<Machine, 'host' | 'env'>, signal?: AbortSignal): Promise<MachineConnection>;
     host: {
         dataDirectory: string;
         config: any;

package/dist/index.cjs

@@ -174,14 +174,25 @@ var Pty = class {
 };
 
 // agent.ts
-function agentCommand(command) {
+var quoted = (value) => value.replace(/[\\`"]/g, "\\$&");
+function exportableEnvironment(env = {}) {
+  return Object.fromEntries(Object.entries(env).filter(([name]) => /^[A-Za-z_][A-Za-z0-9_]*$/.test(name)));
+}
+function agentCommand(command, env = {}) {
   const home = process.env.WANGCAI_HOME;
   const exportHome = home ? `export WANGCAI_HOME='${home.replace(/'/g, String.raw`'\''`)}'; ` : "";
-  return `${exportHome}export PATH="$HOME/.local/bin:$PATH"; ${command}`;
+  const exports2 = Object.entries(exportableEnvironment(env)).map(([name, value]) => `export ${name}="${quoted(value)}"; `).join("");
+  return `${exportHome}export PATH="$HOME/.local/bin:$PATH"; ${exports2}${command}`;
 }
 
 // connection.ts
 var exec = (0, import_node_util.promisify)(import_node_child_process.execFile);
+function expandedEnvironment(env) {
+  return Object.fromEntries(Object.entries(env).map(([name, value]) => [
+    name,
+    value.replace(/\$\{?([A-Za-z_][A-Za-z0-9_]*)\}?/g, (_, variable) => process.env[variable] ?? "")
+  ]));
+}
 var MachineConnection = class {
   constructor(options) {
     this.options = options;
@@ -340,8 +351,12 @@ var MachineConnection = class {
     try {
       let info;
       let port;
+      const env = exportableEnvironment(this.options.env);
       if (this.options.type === "local") {
-        const { stdout } = await exec(this.options.binary ?? "wangcai", ["server", "start", "--json"], { timeout: 15e3 });
+        const { stdout } = await exec(this.options.binary ?? "wangcai", ["server", "start", "--json"], {
+          timeout: 15e3,
+          env: { ...process.env, ...expandedEnvironment(env) }
+        });
         info = JSON.parse(stdout);
         port = info.port;
       } else {
@@ -353,7 +368,7 @@ var MachineConnection = class {
           "-o",
           "ConnectTimeout=8",
           this.options.host,
-          agentCommand("wangcai server start --json")
+          agentCommand("wangcai server start --json", env)
         ], { timeout: 15e3, maxBuffer: 64 * 1024 });
         info = JSON.parse(stdout);
         if (!Number.isInteger(info.port) || info.port < 1 || info.port > 65535) throw new Error("Node returned an invalid port.");

package/dist/types.d.ts

@@ -10,6 +10,7 @@ export type InstallAgent = (host: string, signal?: AbortSignal) => Promise<void>
  *   workspace-create({ key }) -> { id: string }        the id of the workspace it made
  *   workspace-select({ id })
  *   workspace-close({ id })
+ *   workspace-rename({ id, name })                     an empty name gives the workspace back to the name it followed
  *   workspace-move({ id, before? })
  *
  * Every view that follows the workspace in front shares these channel topics, whatever the provider
@@ -35,6 +36,7 @@ export interface Machine {
     id: string;
     name: string;
     host?: string;
+    env?: Record<string, string>;
 }
 export interface WorkspaceActive {
     machine: Machine;
@@ -52,11 +54,13 @@ export interface FileClick {
 export type ConnectionOptions = {
     type: 'local';
     binary?: string;
+    env?: Record<string, string>;
     signal?: AbortSignal;
 } | {
     type: 'ssh';
     host: string;
     agent?: InstallAgent;
+    env?: Record<string, string>;
     signal?: AbortSignal;
 };
 export interface Size {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lengmoxxl/sdk",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Client SDK for WangCai: connect to a local or remote machine and drive its pty, files and git",
   "license": "MIT",
   "repository": {