dsh-workbuddy-connect 0.2.1 → 0.2.3

package/README.en.md

@@ -22,23 +22,41 @@ Expand the card to see the account, token validity, and remaining credit.
 
 Prerequisite: the WorkBuddy desktop app is installed and signed in (the plugin reuses the app's sign-in state and follows account switches automatically).
 
+The plugin runs under all three DSH interfaces: **Web**, **Desktop**, and **TUI**. Pick the install command that matches the profile you use.
+
 ```sh
-# npm (recommended; ships prebuilt artifacts)
+# Web (recommended; ships prebuilt artifacts)
 dsh plugin --profile web add dsh-workbuddy-connect
+dsh web
 
-# or install from the GitHub source
+# or install the Web version from the GitHub source
 dsh plugin --profile web add github:corrinehu/dsh-workbuddy-connect
-
 dsh web
 ```
 
+```sh
+# Desktop (the DSH Desktop app)
+dsh plugin --profile desktop add dsh-workbuddy-connect
+dsh --profile desktop
+```
+
+```sh
+# TUI (terminal UI)
+dsh plugin --profile dsh-tui add dsh-workbuddy-connect
+dsh --profile dsh-tui
+```
+
+> Note: the `dsh-tui` profile requires pnpm 11 to install packages (a different pnpm on PATH fails with `ERR_PNPM_UNEXPECTED_STORE` — use `npx pnpm@11`); verified on dsh `0.1.1-rc.2`.
+
+After installing, switch to a WorkBuddy model in the model picker of the interface you chose. On Web, the settings card (Settings → Plugins → DSH WorkBuddy Connect) shows the account, token validity, and remaining credit; on TUI, configure `authFile` in `/settings`.
+
 ## CLI
 
-`dsh plugin --profile web exec dsh-workbuddy-connect status`: sign-in state and remaining credit (`--json` for machine-readable output; `doctor` for diagnostics and `logout` for credential cleanup are also available).
+`dsh plugin --profile <web|desktop|dsh-tui> exec dsh-workbuddy-connect status`: sign-in state and remaining credit (`--json` for machine-readable output; `doctor` for diagnostics and `logout` for credential cleanup are also available).
 
 ## Known limitations
 
-- Verified on macOS with the DSH Web profile (`0.1.1-rc.2`+, Node 22+). The default credential paths on Windows / Linux are unverified — point the `WORKBUDDY_AUTH_FILE` environment variable at the actual location if needed.
+- Verified on macOS with the DSH Web / Desktop / TUI profile (`0.1.1-rc.2`+, Node 22+). The default credential paths on Windows / Linux are unverified — point the `WORKBUDDY_AUTH_FILE` environment variable at the actual location if needed.
 - Relies on WorkBuddy client interfaces (not a public API); the plugin may need updates as WorkBuddy changes.
 
 ## Disclaimer

package/README.md

@@ -28,23 +28,41 @@
 
 前置：已安装并登录 WorkBuddy 桌面 App（插件复用 App 的登录状态，账号切换自动跟随）。
 
+插件在三种 DSH 界面下均可运行：**Web**、**Desktop**、**TUI**。根据你使用的 profile 选对应命令安装。
+
 ```sh
-# npm（推荐，自带预构建产物）
+# Web（推荐，自带预构建产物）
 dsh plugin --profile web add dsh-workbuddy-connect
+dsh web
 
-# 或从 GitHub 源码安装
+# 或从 GitHub 源码安装 Web 版
 dsh plugin --profile web add github:corrinehu/dsh-workbuddy-connect
-
 dsh web
 ```
 
+```sh
+# Desktop（DSH Desktop 桌面版）
+dsh plugin --profile desktop add dsh-workbuddy-connect
+dsh --profile desktop
+```
+
+```sh
+# TUI（终端界面）
+dsh plugin --profile dsh-tui add dsh-workbuddy-connect
+dsh --profile dsh-tui
+```
+
+> 提示：`dsh-tui` profile 需用 pnpm 11 安装（PATH 里是其他版本会报 `ERR_PNPM_UNEXPECTED_STORE`，用 `npx pnpm@11` 即可）；已验证 dsh `0.1.1-rc.2`。
+
+安装后，在对应界面的模型选择器里切换到 WorkBuddy 模型即可使用；Web 下设置卡片（设置 → 插件 → DSH WorkBuddy Connect）可查看账号信息、令牌有效期与剩余积分，TUI 下可在 `/settings` 里配置 `authFile`。
+
 ## 命令行
 
-`dsh plugin --profile web exec dsh-workbuddy-connect status`：登录状态与剩余积分（`--json` 输出机器可读格式；另有 `doctor` 诊断、`logout` 清理凭据）。
+`dsh plugin --profile <web|desktop|dsh-tui> exec dsh-workbuddy-connect status`：登录状态与剩余积分（`--json` 输出机器可读格式；另有 `doctor` 诊断、`logout` 清理凭据）。
 
 ## 已知限制
 
-- 在 macOS 与 DSH Web profile（`0.1.1-rc.2`+、Node 22+）下验证通过；Windows / Linux 的凭据默认路径未经验证，必要时可通过环境变量 `WORKBUDDY_AUTH_FILE` 指定实际位置。
+- 在 macOS 的 DSH Web / Desktop / TUI profile（`0.1.1-rc.2`+、Node 22+）下验证通过；Windows / Linux 的凭据默认路径未经验证，必要时可通过环境变量 `WORKBUDDY_AUTH_FILE` 指定实际位置。
 - 依赖 WorkBuddy 客户端接口（非官方开放 API），WorkBuddy 更新后插件可能需要随之调整。
 
 ## 免责声明

package/lib/bin.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { _ as WorkBuddyCredentialStore, a as readHostHeartbeat, b as workbuddyOwnAuthPath, c as WORKBUDDY_CONNECT_VERSION, l as WorkBuddyUpstreamClient, o as workbuddyHostHeartbeatPath, p as FALLBACK_WORKBUDDY_MODELS, r as isHeartbeatProcessAlive } from "./host-heartbeat-DehQgrb9.js";
+import { _ as WorkBuddyCredentialStore, a as readHostHeartbeat, c as WORKBUDDY_CONNECT_VERSION, l as WorkBuddyUpstreamClient, o as workbuddyHostHeartbeatPath, p as FALLBACK_WORKBUDDY_MODELS, r as isHeartbeatProcessAlive, x as workbuddyOwnAuthPath } from "./host-heartbeat-C80jXKyk.js";
 import { realpathSync } from "node:fs";
 import { fileURLToPath } from "node:url";
 //#region src/bin.ts

package/lib/{host-heartbeat-DehQgrb9.js → host-heartbeat-C80jXKyk.js}

@@ -24,12 +24,22 @@ const OWN_FORMAT_VERSION = 1;
 function workbuddyOwnAuthPath() {
 	return join(resolveDshHome(), WORKBUDDY_AUTH_FILENAME);
 }
-/** Platform default for the WorkBuddy desktop app's auth file. */
-function defaultDesktopAuthPath() {
+/**
+* Platform-default candidates for the WorkBuddy desktop app's auth file, in
+* probe order. Windows probes both AppData roots: current builds write under
+* `%LOCALAPPDATA%` (Local), older ones under `%APPDATA%` (Roaming). macOS and
+* Linux have a single well-known location.
+*/
+function defaultDesktopAuthCandidates() {
 	const home = homedir();
-	if (process.platform === "darwin") return join(home, "Library", "Application Support", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info");
-	if (process.platform === "win32") return join(home, "AppData", "Roaming", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info");
-	if (process.platform === "linux") return join(home, ".config", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info");
+	if (process.platform === "darwin") return [join(home, "Library", "Application Support", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info")];
+	if (process.platform === "win32") return [join(home, "AppData", "Local", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info"), join(home, "AppData", "Roaming", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info")];
+	if (process.platform === "linux") return [join(home, ".config", "CodeBuddyExtension", "Data", "Public", "auth", "workbuddy-desktop.info")];
+	return [];
+}
+/** First platform-default candidate; see {@link defaultDesktopAuthCandidates}. */
+function defaultDesktopAuthPath() {
+	return defaultDesktopAuthCandidates()[0];
 }
 /** Normalize an expiry that may arrive in seconds or milliseconds. */
 function expiryToMs(value) {
@@ -133,11 +143,17 @@ var WorkBuddyCredentialStore = class {
 	}
 	/**
 	* Configuration precedence for the desktop file: the plugin's configured
-	* path, then the environment variable, then the platform default.
+	* path, then the environment variable, then the platform defaults. An
+	* explicit path is used verbatim; the defaults are a probe order.
 	*/
-	resolveDesktopPath() {
+	resolveDesktopCandidates() {
 		const fromEnv = process.env[WORKBUDDY_AUTH_FILE_ENV];
-		return this.desktopPathOverride ?? (fromEnv !== void 0 && fromEnv.trim() !== "" ? fromEnv : void 0) ?? defaultDesktopAuthPath();
+		const explicit = this.desktopPathOverride ?? (fromEnv !== void 0 && fromEnv.trim() !== "" ? fromEnv : void 0);
+		if (explicit !== void 0) return [explicit];
+		return defaultDesktopAuthCandidates();
+	}
+	resolveDesktopPath() {
+		return this.resolveDesktopCandidates()[0];
 	}
 	/**
 	* Repoint the desktop file; a settings change applies on the next read.
@@ -167,7 +183,8 @@ var WorkBuddyCredentialStore = class {
 	async resolve() {
 		const credential = await this.current();
 		if (credential === void 0) {
-			const desktop = this.resolveDesktopPath() ?? "(no desktop path on this platform)";
+			const candidates = this.resolveDesktopCandidates();
+			const desktop = candidates.length > 0 ? candidates.join(" or ") : "(no desktop path on this platform)";
 			throw new Error(`workbuddy: no signed-in WorkBuddy account found; sign in once in the WorkBuddy desktop app (expected ${desktop} or WORKBUDDY_AUTH_FILE), or refresh an existing session`);
 		}
 		if (!this.needsRefresh(credential)) return credential;
@@ -232,14 +249,17 @@ var WorkBuddyCredentialStore = class {
 			});
 		});
 	}
+	/**
+	* Read the first desktop candidate that exists. Only an absent file
+	* (ENOENT) falls through to the next candidate; a file that is present
+	* but unparsable is authoritative for its slot, so a stale older-version
+	* file never silently wins over a broken newer one.
+	*/
 	async readDesktop() {
-		const desktopPath = this.resolveDesktopPath();
-		if (desktopPath === void 0) return void 0;
-		try {
+		for (const desktopPath of this.resolveDesktopCandidates()) try {
 			return parseWorkBuddyAuth(await readFile(desktopPath, "utf8"));
 		} catch (error) {
-			if (isENOENT(error)) return void 0;
-			throw error;
+			if (!isENOENT(error)) throw error;
 		}
 	}
 	async readOwn() {
@@ -250,15 +270,12 @@ var WorkBuddyCredentialStore = class {
 			return;
 		}
 	}
-	/** Whether the desktop file exists and is a regular file; diagnostics only. */
+	/** Whether any desktop-file candidate exists as a regular file; diagnostics only. */
 	async desktopFilePresent() {
-		const desktopPath = this.resolveDesktopPath();
-		if (desktopPath === void 0) return false;
-		try {
-			return (await stat(desktopPath)).isFile();
-		} catch {
-			return false;
-		}
+		for (const desktopPath of this.resolveDesktopCandidates()) try {
+			if ((await stat(desktopPath)).isFile()) return true;
+		} catch {}
+		return false;
 	}
 };
 //#endregion
@@ -684,7 +701,7 @@ var WorkBuddyUpstreamClient = class {
 };
 //#endregion
 //#region src/version.ts
-const WORKBUDDY_CONNECT_VERSION = "0.2.1";
+const WORKBUDDY_CONNECT_VERSION = "0.2.3";
 //#endregion
 //#region src/host-heartbeat.ts
 /**
@@ -827,4 +844,4 @@ function isHeartbeatProcessAlive(heartbeat) {
 	return startAtMs <= heartbeat.registeredAt;
 }
 //#endregion
-export { WorkBuddyCredentialStore as _, readHostHeartbeat as a, workbuddyOwnAuthPath as b, WORKBUDDY_CONNECT_VERSION as c, prepareChatBody as d, regionOf as f, WORKBUDDY_AUTH_FILE_ENV as g, WORKBUDDY_AUTH_FILENAME as h, processStartTimeMs as i, WorkBuddyUpstreamClient as l, WorkBuddyCatalog as m, clearHostHeartbeat as n, workbuddyHostHeartbeatPath as o, FALLBACK_WORKBUDDY_MODELS as p, isHeartbeatProcessAlive as r, writeHostHeartbeat as s, WORKBUDDY_HOST_HEARTBEAT_FILENAME as t, classifyUpstreamError as u, defaultDesktopAuthPath as v, parseWorkBuddyAuth as y };
+export { WorkBuddyCredentialStore as _, readHostHeartbeat as a, parseWorkBuddyAuth as b, WORKBUDDY_CONNECT_VERSION as c, prepareChatBody as d, regionOf as f, WORKBUDDY_AUTH_FILE_ENV as g, WORKBUDDY_AUTH_FILENAME as h, processStartTimeMs as i, WorkBuddyUpstreamClient as l, WorkBuddyCatalog as m, clearHostHeartbeat as n, workbuddyHostHeartbeatPath as o, FALLBACK_WORKBUDDY_MODELS as p, isHeartbeatProcessAlive as r, writeHostHeartbeat as s, WORKBUDDY_HOST_HEARTBEAT_FILENAME as t, classifyUpstreamError as u, defaultDesktopAuthCandidates as v, workbuddyOwnAuthPath as x, defaultDesktopAuthPath as y };

package/lib/index.d.ts

@@ -107,7 +107,14 @@ declare const WORKBUDDY_AUTH_FILENAME = ".workbuddy-auth.json";
 declare const WORKBUDDY_AUTH_FILE_ENV = "WORKBUDDY_AUTH_FILE";
 /** Plugin-owned copy path inside the Harness home. */
 declare function workbuddyOwnAuthPath(): string;
-/** Platform default for the WorkBuddy desktop app's auth file. */
+/**
+ * Platform-default candidates for the WorkBuddy desktop app's auth file, in
+ * probe order. Windows probes both AppData roots: current builds write under
+ * `%LOCALAPPDATA%` (Local), older ones under `%APPDATA%` (Roaming). macOS and
+ * Linux have a single well-known location.
+ */
+declare function defaultDesktopAuthCandidates(): string[];
+/** First platform-default candidate; see {@link defaultDesktopAuthCandidates}. */
 declare function defaultDesktopAuthPath(): string | undefined;
 /**
  * Parse a WorkBuddy auth document in either on-disk shape: the plugin OAuth
@@ -133,8 +140,10 @@ declare class WorkBuddyCredentialStore {
   constructor(options: WorkBuddyStoreOptions);
   /**
    * Configuration precedence for the desktop file: the plugin's configured
-   * path, then the environment variable, then the platform default.
+   * path, then the environment variable, then the platform defaults. An
+   * explicit path is used verbatim; the defaults are a probe order.
    */
+  private resolveDesktopCandidates;
   private resolveDesktopPath;
   /**
    * Repoint the desktop file; a settings change applies on the next read.
@@ -158,9 +167,15 @@ declare class WorkBuddyCredentialStore {
   private needsRefresh;
   private refreshNow;
   private saveOwn;
+  /**
+   * Read the first desktop candidate that exists. Only an absent file
+   * (ENOENT) falls through to the next candidate; a file that is present
+   * but unparsable is authoritative for its slot, so a stale older-version
+   * file never silently wins over a broken newer one.
+   */
   private readDesktop;
   private readOwn;
-  /** Whether the desktop file exists and is a regular file; diagnostics only. */
+  /** Whether any desktop-file candidate exists as a regular file; diagnostics only. */
   desktopFilePresent(): Promise<boolean>;
 }
 //#endregion
@@ -329,4 +344,4 @@ declare const Config: z<Config>;
  */
 declare function apply(ctx: Context, config: Config): void;
 //#endregion
-export { Config, FALLBACK_WORKBUDDY_MODELS, type UpstreamErrorKind, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_PROVIDER, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, type WorkBuddyAdapter, type WorkBuddyAuthStatus, WorkBuddyCatalog, type WorkBuddyChatResult, type WorkBuddyCredential, WorkBuddyCredentialStore, type WorkBuddyCredits, type WorkBuddyHostHeartbeat, type WorkBuddyModelInfo, type WorkBuddyRefreshOutcome, type WorkBuddyShim, WorkBuddyUpstreamClient, type WorkBuddyUpstreamModel, apply, classifyUpstreamError, clearHostHeartbeat, createWorkBuddyAdapter, createWorkBuddyShim, defaultDesktopAuthPath, inject, isHeartbeatProcessAlive, name, parseWorkBuddyAuth, prepareChatBody, processStartTimeMs, readHostHeartbeat, regionOf, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath };
+export { Config, FALLBACK_WORKBUDDY_MODELS, type UpstreamErrorKind, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_PROVIDER, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, type WorkBuddyAdapter, type WorkBuddyAuthStatus, WorkBuddyCatalog, type WorkBuddyChatResult, type WorkBuddyCredential, WorkBuddyCredentialStore, type WorkBuddyCredits, type WorkBuddyHostHeartbeat, type WorkBuddyModelInfo, type WorkBuddyRefreshOutcome, type WorkBuddyShim, WorkBuddyUpstreamClient, type WorkBuddyUpstreamModel, apply, classifyUpstreamError, clearHostHeartbeat, createWorkBuddyAdapter, createWorkBuddyShim, defaultDesktopAuthCandidates, defaultDesktopAuthPath, inject, isHeartbeatProcessAlive, name, parseWorkBuddyAuth, prepareChatBody, processStartTimeMs, readHostHeartbeat, regionOf, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath };

package/lib/index.js

@@ -1,4 +1,4 @@
-import { _ as WorkBuddyCredentialStore, a as readHostHeartbeat, b as workbuddyOwnAuthPath, d as prepareChatBody, f as regionOf, g as WORKBUDDY_AUTH_FILE_ENV, h as WORKBUDDY_AUTH_FILENAME, i as processStartTimeMs, l as WorkBuddyUpstreamClient, m as WorkBuddyCatalog, n as clearHostHeartbeat, o as workbuddyHostHeartbeatPath, p as FALLBACK_WORKBUDDY_MODELS, r as isHeartbeatProcessAlive, s as writeHostHeartbeat, t as WORKBUDDY_HOST_HEARTBEAT_FILENAME, u as classifyUpstreamError, v as defaultDesktopAuthPath, y as parseWorkBuddyAuth } from "./host-heartbeat-DehQgrb9.js";
+import { _ as WorkBuddyCredentialStore, a as readHostHeartbeat, b as parseWorkBuddyAuth, d as prepareChatBody, f as regionOf, g as WORKBUDDY_AUTH_FILE_ENV, h as WORKBUDDY_AUTH_FILENAME, i as processStartTimeMs, l as WorkBuddyUpstreamClient, m as WorkBuddyCatalog, n as clearHostHeartbeat, o as workbuddyHostHeartbeatPath, p as FALLBACK_WORKBUDDY_MODELS, r as isHeartbeatProcessAlive, s as writeHostHeartbeat, t as WORKBUDDY_HOST_HEARTBEAT_FILENAME, u as classifyUpstreamError, v as defaultDesktopAuthCandidates, x as workbuddyOwnAuthPath, y as defaultDesktopAuthPath } from "./host-heartbeat-C80jXKyk.js";
 import z from "@deepseek-ai/schemastery";
 import { installSettingsSection, settingsNamespace } from "@deepseek-ai/dsh-settings";
 import { createProvider } from "@earendil-works/pi-ai";
@@ -553,4 +553,4 @@ function apply(ctx, config) {
 	});
 }
 //#endregion
-export { Config, FALLBACK_WORKBUDDY_MODELS, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_PROVIDER, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, WorkBuddyCatalog, WorkBuddyCredentialStore, WorkBuddyUpstreamClient, apply, classifyUpstreamError, clearHostHeartbeat, createWorkBuddyAdapter, createWorkBuddyShim, defaultDesktopAuthPath, inject, isHeartbeatProcessAlive, name, parseWorkBuddyAuth, prepareChatBody, processStartTimeMs, readHostHeartbeat, regionOf, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath };
+export { Config, FALLBACK_WORKBUDDY_MODELS, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_PROVIDER, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, WorkBuddyCatalog, WorkBuddyCredentialStore, WorkBuddyUpstreamClient, apply, classifyUpstreamError, clearHostHeartbeat, createWorkBuddyAdapter, createWorkBuddyShim, defaultDesktopAuthCandidates, defaultDesktopAuthPath, inject, isHeartbeatProcessAlive, name, parseWorkBuddyAuth, prepareChatBody, processStartTimeMs, readHostHeartbeat, regionOf, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath };

package/package.json

@@ -2,7 +2,7 @@
   "name": "dsh-workbuddy-connect",
   "displayName": "DSH WorkBuddy Connect",
   "description": "将 WorkBuddy 桌面 App 包含的模型自动接入 DeepSeek Harness — bring WorkBuddy desktop app models into DeepSeek Harness with zero configuration.",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "author": "corrinehu",
   "keywords": [
     "dsh-plugin",
@@ -21,6 +21,7 @@
     "dsh-workbuddy-connect": "lib/bin.js"
   },
   "scripts": {
+    "prepack": "npm run build",
     "build": "tsdown",
     "test": "vitest run",
     "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.client.json",
@@ -99,4 +100,4 @@
     "typescript": "^5.9.3",
     "vitest": "^4.1.8"
   }
-}
+}