dsh-office-kit 0.4.1 → 0.4.3

package/dist/index.js

@@ -1,6 +1,6 @@
 import { createRequire } from "node:module";
 import { execFile } from "node:child_process";
-import { existsSync, readFileSync, statSync } from "node:fs";
+import { existsSync, mkdirSync, readFileSync, renameSync, statSync, writeFileSync } from "node:fs";
 import { readFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import process from "node:process";
@@ -125,24 +125,31 @@ const POSTINSTALL_SCRIPT = join(PACKAGE_ROOT, "postinstall.mjs");
 const POSTINSTALL_TIMEOUT = 540 * 1e3;
 /** Failed probes are retried after this delay instead of re-running pip on every status call. */
 const FAILURE_RETRY_DELAY = 300 * 1e3;
-function configDir() {
-	const home = homedir();
-	return process.platform === "win32" ? join(process.env.APPDATA ?? join(home, "AppData", "Roaming"), "dsh-office-kit") : process.platform === "darwin" ? join(home, "Library", "Application Support", "dsh-office-kit") : join(process.env.XDG_CONFIG_HOME ?? join(home, ".config"), "dsh-office-kit");
+/** Where every version of this plugin keeps its runtime, next to DSH's own data. */
+function officeHome() {
+	return join(homedir(), ".dsh", "office");
 }
 function legacyDataDir() {
 	const home = homedir();
 	return process.platform === "win32" ? join(process.env.LOCALAPPDATA ?? join(home, "AppData", "Local"), "dsh-office-kit") : process.platform === "darwin" ? join(home, "Library", "Application Support", "dsh-office-kit") : join(process.env.XDG_DATA_HOME ?? join(home, ".local", "share"), "dsh-office-kit");
 }
-/** Config location written by versions that ignored the platform branch. */
-function legacyConfigFile() {
-	return process.platform === "win32" ? join(configDir(), "config.json") : join(process.env.APPDATA ?? join(homedir(), "AppData", "Roaming"), "dsh-office-kit", "config.json");
+/**
+* Config files older versions wrote, newest first.
+*
+* The pre-0.5 config stayed in the OS config directory (`%APPDATA%\dsh-office-kit`,
+* `$XDG_CONFIG_HOME/dsh-office-kit`, `~/Library/Application Support/dsh-office-kit`).
+* Reading them keeps an upgraded install from rebuilding or mis-reporting its venv.
+*/
+function legacyConfigFiles() {
+	const home = homedir();
+	return [.../* @__PURE__ */ new Set([process.platform === "win32" ? join(process.env.APPDATA ?? join(home, "AppData", "Roaming"), "dsh-office-kit", "config.json") : process.platform === "darwin" ? join(home, "Library", "Application Support", "dsh-office-kit", "config.json") : join(process.env.XDG_CONFIG_HOME ?? join(home, ".config"), "dsh-office-kit", "config.json"), join(process.env.APPDATA ?? join(home, "AppData", "Roaming"), "dsh-office-kit", "config.json")])];
 }
 /** Resolve per-OS config/data directories and bundled resources. */
 function officePaths() {
-	const runtimeDir = join(homedir(), ".dsh", "office", "runtime");
+	const runtimeDir = join(officeHome(), "runtime");
 	return {
-		configFile: join(configDir(), "config.json"),
-		legacyConfigFile: legacyConfigFile(),
+		configFile: join(officeHome(), "config.json"),
+		legacyConfigFiles: legacyConfigFiles(),
 		venv: join(runtimeDir, "venv"),
 		legacyVenv: join(legacyDataDir(), "venv"),
 		cli: join(PACKAGE_ROOT, "python", "office_cli.py"),
@@ -244,10 +251,11 @@ function failedInspection(path, error) {
 }
 /**
 * Read the interpreter path postinstall recorded; malformed files are ignored.
-* The legacy location is read second so an upgrade does not orphan a ready venv.
+* The legacy locations are read after the canonical one so an upgrade does not
+* orphan a ready venv.
 */
-function savedPython(configFile, legacyConfigFile) {
-	const files = legacyConfigFile == null ? [configFile] : [configFile, legacyConfigFile];
+function savedPython(configFile, legacyConfigFiles = []) {
+	const files = [configFile, ...legacyConfigFiles];
 	for (const file of files) {
 		if (!isFile(file)) continue;
 		try {
@@ -256,6 +264,61 @@ function savedPython(configFile, legacyConfigFile) {
 		} catch {}
 	}
 }
+/**
+* Read the plugin config, falling back to files older versions wrote.
+*
+* The canonical file wins key by key, so a legacy record contributes only what
+* the new file has not written yet (an upgrade usually still needs its venv).
+*/
+function loadConfig(configFile) {
+	const legacy = officePaths().legacyConfigFiles;
+	const merged = {};
+	for (const file of [...legacy].reverse()) try {
+		const parsed = JSON.parse(readFileSync(file, "utf8"));
+		if (parsed != null && typeof parsed === "object" && !Array.isArray(parsed)) Object.assign(merged, parsed);
+	} catch {}
+	try {
+		const parsed = JSON.parse(readFileSync(configFile, "utf8"));
+		if (parsed != null && typeof parsed === "object" && !Array.isArray(parsed)) Object.assign(merged, parsed);
+	} catch {}
+	return merged;
+}
+/**
+* Merge one key into the plugin's config without disturbing the rest.
+*
+* Versions that predate the current layout left stale absolute paths behind, so
+* the record is refreshed whenever the host resolves something different.
+*/
+function saveRecord(configFile, key, value) {
+	const config = loadConfig(configFile);
+	if (JSON.stringify(config[key]) === JSON.stringify(value) && isFile(configFile)) return;
+	const temporary = `${configFile}.${process.pid}.tmp`;
+	try {
+		mkdirSync(dirname(configFile), { recursive: true });
+		writeFileSync(temporary, `${JSON.stringify({
+			...config,
+			[key]: value
+		}, null, 2)}\n`, "utf8");
+		renameSync(temporary, configFile);
+	} catch {}
+}
+/**
+* Record the renderer the harness loaded so every later helper call finds it.
+*
+* A profile install keeps the plugin in `~/.dsh/profiles/<name>/node_modules`
+* and the kit in the harness tree, so no walk-up from the plugin can reach it.
+* The helper reads this record first; a read-only config must not stop loading.
+*/
+function saveKitPath(configFile, node, cli) {
+	saveRecord(configFile, "libreofficeKit", {
+		node,
+		cli
+	});
+}
+/** Record the interpreter this plugin settled on so the next probe can trust it. */
+function savePythonPath(configFile, python) {
+	saveRecord(configFile, "python", python);
+}
 /** The interpreter inside a virtual environment, which differs per platform. */
 function venvPython(venv) {
 	return join(venv, process.platform === "win32" ? "Scripts/python.exe" : "bin/python");
@@ -266,14 +329,10 @@ function candidates(configFile) {
 	const found = [];
 	const env = process.env.DSH_OFFICE_PYTHON;
 	if (env != null && env.length > 0) found.push(env);
-	const saved = savedPython(configFile, paths.legacyConfigFile);
+	found.push(venvPython(paths.venv));
+	const saved = savedPython(configFile, paths.legacyConfigFiles);
 	if (saved != null) found.push(saved);
-	found.push(venvPython(paths.venv), venvPython(paths.legacyVenv));
-	const marker = join(PACKAGE_ROOT, ".python-path");
-	if (isFile(marker)) {
-		const text = readFileSync(marker, "utf8").trim();
-		if (text.length > 0) found.push(text);
-	}
+	found.push(venvPython(paths.legacyVenv));
 	for (const name of ["python3", "python"]) found.push(name);
 	if (process.platform === "win32") {
 		for (const version of [
@@ -344,9 +403,20 @@ async function inspectRuntime(configFile = officePaths().configFile) {
 		if (expanded !== candidate && !isFile(expanded)) continue;
 		const inspection = await inspectPython(expanded);
 		seen.push(inspection);
-		if (inspection.compatible && inspection.missing.length === 0) return selectRuntime(seen);
+		if (inspection.compatible && inspection.missing.length === 0) return settledRuntime(seen, configFile);
 	}
-	return selectRuntime(seen);
+	return settledRuntime(seen, configFile);
+}
+/**
+* Freeze the probe result and keep config.json honest about which interpreter won.
+*
+* A venv migrated out of the legacy data directory leaves the old absolute path
+* recorded; rewriting it stops the next launch from probing a dead path first.
+*/
+function settledRuntime(seen, configFile) {
+	const status = selectRuntime(seen);
+	if (status.state === "ok" && status.python != null && status.python.path !== savedPython(configFile)) savePythonPath(configFile, status.python.path);
+	return status;
 }
 /** Run postinstall.mjs as a child process; resolve with an error summary or undefined. */
 function runPostinstall() {
@@ -433,7 +503,7 @@ function parseSkill(raw, path) {
 		content: raw.slice(match[0].length).trim()
 	};
 }
-const KIT_MISSING = "the DSH LibreOffice kit (@deepseek-ai/libreoffice-kit) was not found: DeepSeek Harness normally injects DSH_LIBREOFFICE_KIT_CLI, so point that variable at <kit>/lib/cli.js if this plugin runs outside the harness";
+const KIT_MISSING = "the DSH LibreOffice kit (@deepseek-ai/libreoffice-kit) was not found: the plugin records where the harness loaded it from in dsh-office-kit's config.json, and DSH_LIBREOFFICE_KIT_CLI overrides that for a plugin running outside the harness";
 const runKit = promisify(execFile);
 async function kitFacts() {
 	const cli = resolveKitCli();
@@ -495,10 +565,7 @@ function apply(ctx) {
 	const paths = officePaths();
 	const candidates = [];
 	const kitCli = resolveKitCli();
-	if (kitCli != null) {
-		process.env.DSH_LIBREOFFICE_KIT_CLI ??= kitCli;
-		process.env.DSH_NODE ??= process.execPath;
-	}
+	if (kitCli != null) saveKitPath(paths.configFile, process.execPath, kitCli);
 	for (const feature of OFFICE_FEATURES) {
 		const directory = join(paths.skillsDir, feature.skill);
 		const path = join(directory, "SKILL.md");
@@ -542,12 +609,17 @@ function apply(ctx) {
 			}
 			const parsed = parseSkill(raw, path);
 			const runtime = await ensureRuntime(paths.configFile);
-			const pythonLine = runtime.state === "ok" && runtime.python != null ? `\n\n## Office runtime\n\nUse these verified absolute paths for every helper command. Quote paths that contain spaces. \`skill\` is this skill's own directory: every script it names lives at \`<skill>/scripts/...\`; \`shared\` holds the cross-format workflow notes.\n\n\`\`\`json\n${JSON.stringify({
+			const kitCli = resolveKitCli();
+			const pythonLine = runtime.state === "ok" && runtime.python != null ? `\n\n## Office runtime\n\nVerified absolute paths. Use them for every helper command; quote paths that contain spaces.\n\n- \`python\` runs all helper scripts, \`cli\` is the Office helper CLI.\n- \`skill\` is this skill's directory: its scripts live under \`<skill>/scripts/\`.\n- \`shared\` holds the cross-format notes and shared scripts.\n- \`renderer\` is the DSH LibreOffice kit; the helper finds it itself, so never pass it.\n\n\`\`\`json\n${JSON.stringify({
 				python: runtime.python.path,
 				cli: paths.cli,
 				skill: dirname(path).split("\\").join("/"),
 				shared: join(paths.skillsDir, "shared").split("\\").join("/"),
-				version: runtime.python.version
+				version: runtime.python.version,
+				...kitCli == null ? {} : { renderer: {
+					kind: "libreoffice-kit",
+					cli: kitCli
+				} }
 			}, null, 2)}\n\`\`\`` : `\n\n## Office runtime\n\nNo working Python runtime is available: ${runtimeReason(runtime)}. Do not run helper commands or claim success. Tell the user to run \`${runtime.remedy}\`, then call \`office_status\` again.`;
 			const { rank: _rank, locator: _locator, ...summary } = candidate;
 			return {
@@ -598,6 +670,10 @@ function apply(ctx) {
 					path: paths.cli,
 					exists: cliExists()
 				},
+				config: {
+					path: paths.configFile,
+					exists: existsSync(paths.configFile)
+				},
 				packages: runtime.packages,
 				renderers: await kitFacts(),
 				skills: candidates.map((candidate) => candidate.name)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsh-office-kit",
   "type": "module",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Office documents, PDF, presentations, and spreadsheets for DeepSeek Harness",
   "author": "Hairy",
   "license": "MIT",

package/postinstall.mjs

@@ -16,7 +16,7 @@
  */
 
 import { spawnSync } from 'node:child_process'
-import { existsSync, mkdirSync, readFileSync, realpathSync, rmSync, writeFileSync } from 'node:fs'
+import { existsSync, mkdirSync, readFileSync, realpathSync, renameSync, rmSync, writeFileSync } from 'node:fs'
 import { homedir, tmpdir } from 'node:os'
 import { dirname, join } from 'node:path'
 import process from 'node:process'
@@ -35,21 +35,22 @@ const LEGACY_DATA_DIR = IS_WINDOWS
     : join(process.env.XDG_DATA_HOME || join(homedir(), '.local', 'share'), 'dsh-office-kit')
 export const LEGACY_VENV_DIR = join(LEGACY_DATA_DIR, 'venv')
 const LEGACY_VENV_PYTHON = join(LEGACY_VENV_DIR, IS_WINDOWS ? 'Scripts/python.exe' : 'bin/python')
-// Must mirror `configDir()` in src/python.ts: the host half reads this file on
-// every runtime probe, so a platform mismatch here makes a ready venv look missing.
-export const CONFIG_DIR = IS_WINDOWS
-  ? join(process.env.APPDATA || join(homedir(), 'AppData', 'Roaming'), 'dsh-office-kit')
-  : process.platform === 'darwin'
-    ? join(homedir(), 'Library', 'Application Support', 'dsh-office-kit')
-    : join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'dsh-office-kit')
+// Must mirror `officePaths()` in src/python.ts: the host half reads this file on
+// every runtime probe, so a mismatch here makes a ready venv look missing.
+export const CONFIG_DIR = join(homedir(), '.dsh', 'office')
 export const CONFIG_FILE = join(CONFIG_DIR, 'config.json')
 /**
- * Legacy config location written by versions without the platform branch.
- * Read as a fallback so an existing runtime is not rebuilt on upgrade.
+ * Config files older versions wrote in the OS config directory. Read as
+ * fallbacks so an upgraded install is not rebuilt or mis-reported.
  */
-const LEGACY_CONFIG_FILE = IS_WINDOWS
-  ? CONFIG_FILE
-  : join(process.env.APPDATA || join(homedir(), 'AppData', 'Roaming'), 'dsh-office-kit', 'config.json')
+const LEGACY_CONFIG_FILES = [...new Set([
+  IS_WINDOWS
+    ? join(process.env.APPDATA || join(homedir(), 'AppData', 'Roaming'), 'dsh-office-kit', 'config.json')
+    : process.platform === 'darwin'
+      ? join(homedir(), 'Library', 'Application Support', 'dsh-office-kit', 'config.json')
+      : join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'dsh-office-kit', 'config.json'),
+  join(process.env.APPDATA || join(homedir(), 'AppData', 'Roaming'), 'dsh-office-kit', 'config.json'),
+])]
 const REQUIREMENTS = join(PACKAGE_ROOT, 'python', 'requirements.txt')
 const LOG_PREFIX = '[dsh-office-kit]'
 
@@ -230,7 +231,37 @@ function installPython() {
   return true
 }
 
+/**
+ * Move an upgraded install's venv out of the pre-0.4 data directory.
+ *
+ * Reusing the legacy venv in place kept the old layout alive forever, so the
+ * canonical path was only ever reached by fresh installs. A rename is instant
+ * and offline; if it fails (another volume, a locked interpreter) the legacy
+ * venv stays usable and the next install retries.
+ */
+export function migrateLegacyVenv(legacy = LEGACY_VENV_DIR, target = VENV_DIR) {
+  const interpreter = venvPythonIn(legacy)
+  if (existsSync(target) || !existsSync(interpreter)) {
+    return false
+  }
+  try {
+    mkdirSync(dirname(target), { recursive: true })
+    renameSync(legacy, target)
+    log(`moved the virtual environment from ${legacy} to ${target}`)
+    return true
+  }
+  catch (error) {
+    warn(`could not move the legacy virtual environment: ${error instanceof Error ? error.message : String(error)}`)
+    return false
+  }
+}
+
+function venvPythonIn(directory) {
+  return join(directory, IS_WINDOWS ? 'Scripts/python.exe' : 'bin/python')
+}
+
 function ensureVenv(base) {
+  migrateLegacyVenv()
   const existing = workingVenv()
   if (existing) {
     if (existing.directory === LEGACY_VENV_DIR) {
@@ -284,18 +315,20 @@ function verifyImports(python) {
 }
 
 function readConfig() {
-  for (const file of [CONFIG_FILE, LEGACY_CONFIG_FILE]) {
+  // Oldest first so the canonical file and the newest legacy record win key by key.
+  const merged = {}
+  for (const file of [...LEGACY_CONFIG_FILES].reverse().concat(CONFIG_FILE)) {
     if (!existsSync(file)) {
       continue
     }
     try {
-      return JSON.parse(readFileSync(file, 'utf8'))
+      Object.assign(merged, JSON.parse(readFileSync(file, 'utf8')))
     }
     catch {
-      // A malformed file must not hide a usable legacy one.
+      // A malformed file must not hide a usable one.
     }
   }
-  return {}
+  return merged
 }
 
 function writeConfig(config) {
@@ -314,6 +347,14 @@ function writeReadyConfig(existingConfig, python, basePython, report) {
     updatedAt: new Date().toISOString(),
     imports: report,
   })
+  // The canonical file now holds everything the legacy files had; a pre-0.5 file
+  // that stays behind only makes "where is the config" ambiguous.
+  for (const file of LEGACY_CONFIG_FILES) {
+    try {
+      rmSync(file, { force: true })
+    }
+    catch {}
+  }
 }
 
 function main() {

package/python/office_cli.py

@@ -93,23 +93,86 @@ KIT_RELATIVE = Path("node_modules") / "@deepseek-ai" / "libreoffice-kit" / "lib"
 #: Actionable explanation used whenever the kit cannot be located.
 KIT_MISSING = (
     "the LibreOffice renderer is not available: the DSH LibreOffice kit was not found. "
-    "DeepSeek Harness normally injects DSH_LIBREOFFICE_KIT_CLI when it loads this plugin; "
-    "if you run the helper by hand, point that variable at <kit>/lib/cli.js of "
+    "The plugin records the path in dsh-office-kit's config.json when the harness loads it; "
+    "for a hand-run helper, set DSH_LIBREOFFICE_KIT_CLI to <kit>/lib/cli.js of "
     "@deepseek-ai/libreoffice-kit"
 )
 
 
+def office_home() -> Path:
+    """Everything this plugin owns lives under `~/.dsh/office` (mirrors src/python.ts)."""
+    return Path.home() / ".dsh" / "office"
+
+
+def config_file() -> Path:
+    """The config.json the host half and postinstall write."""
+    override = os.environ.get("DSH_OFFICE_CONFIG")
+    return Path(override).expanduser() if override else office_home() / "config.json"
+
+
+def legacy_config_files() -> list[Path]:
+    """Config files older versions wrote in the OS config directory, newest first."""
+    if sys.platform == "darwin":
+        primary = Path.home() / "Library" / "Application Support" / "dsh-office-kit" / "config.json"
+    elif sys.platform == "win32":
+        primary = Path(os.environ.get("APPDATA") or Path.home() / "AppData" / "Roaming") / "dsh-office-kit" / "config.json"
+    else:
+        primary = Path(os.environ.get("XDG_CONFIG_HOME") or Path.home() / ".config") / "dsh-office-kit" / "config.json"
+    roaming = Path(os.environ.get("APPDATA") or Path.home() / "AppData" / "Roaming") / "dsh-office-kit" / "config.json"
+    return list(dict.fromkeys([primary, roaming]))
+
+
+def read_config() -> dict[str, Any]:
+    """Merged config: the canonical file wins key by key over older locations."""
+    merged: dict[str, Any] = {}
+    for file in [*reversed(legacy_config_files()), config_file()]:
+        try:
+            parsed = json.loads(file.read_text("utf-8"))
+        except (OSError, ValueError):
+            continue
+        if isinstance(parsed, dict):
+            merged.update(parsed)
+    return merged
+
+
+def saved_kit() -> tuple[str, str] | None:
+    """Return (node, kit CLI) as recorded by the host half, or None.
+
+    This is how a profile install works: the kit lives in the harness tree, which
+    no walk-up from the plugin directory can reach, so the host half looks it up
+    while it loads and stores the result here for every later helper call.
+    """
+    kit = read_config().get("libreofficeKit")
+    if not isinstance(kit, dict):
+        return None
+    cli = kit.get("cli")
+    if not isinstance(cli, str) or not Path(cli).is_file():
+        return None
+    node = kit.get("node")
+    if not isinstance(node, str) or not node:
+        node = os.environ.get("DSH_NODE") or shutil.which("node")
+    if not node:
+        return None
+    return node, cli
+
+
 def find_kit() -> tuple[str, str] | None:
     """Return (node, kit CLI) for the bundled renderer, or None when it is absent.
 
-    DeepSeek Harness exports `DSH_LIBREOFFICE_KIT_CLI` (and `DSH_NODE`) before any
-    agent shell runs, which covers a profile install where the kit lives in the
-    harness tree. The walk-up covers a checkout or a plugin-local dependency.
+    Order: an explicit `DSH_LIBREOFFICE_KIT_CLI`, then the path the host half
+    recorded in config.json (the profile-install case), then a walk up from this
+    file, which covers a checkout or a plugin-local dependency.
     """
-    candidates: list[Path] = []
     override = os.environ.get("DSH_LIBREOFFICE_KIT_CLI")
     if override:
-        candidates.append(Path(override).expanduser())
+        cli = Path(override).expanduser()
+        if cli.is_file():
+            node = os.environ.get("DSH_NODE") or shutil.which("node")
+            return (node, str(cli)) if node else None
+    recorded = saved_kit()
+    if recorded is not None:
+        return recorded
+    candidates: list[Path] = []
     for root in (PACKAGE_ROOT, *PACKAGE_ROOT.parents):
         candidates.append(root / KIT_RELATIVE)
     cli = next((candidate for candidate in candidates if candidate.is_file()), None)