openclaw-openviking-setup-helper 0.3.0-beta.25 → 0.3.0-beta.26

package/install.js

@@ -106,8 +106,10 @@ let langZh = false;
 let workdirExplicit = false;
 let upgradePluginOnly = false;
 let rollbackLastUpgrade = false;
-let showCurrentVersion = false;
-let uninstallPlugin = false;
+let showCurrentVersion = false;
+let uninstallPlugin = false;
+let forceSlotExplicit = false;
+let allowOfflineExplicit = false;
 
 const selectedMode = "remote";
 const baseUrlFromEnv = !!process.env.OPENVIKING_BASE_URL;
@@ -147,11 +149,19 @@ for (let i = 0; i < argv.length; i++) {
     rollbackLastUpgrade = true;
     continue;
   }
-  if (arg === "--uninstall" || arg === "--remove") {
-    uninstallPlugin = true;
-    continue;
-  }
-  if (arg === "--workdir") {
+  if (arg === "--uninstall" || arg === "--remove") {
+    uninstallPlugin = true;
+    continue;
+  }
+  if (arg === "--force-slot") {
+    forceSlotExplicit = true;
+    continue;
+  }
+  if (arg === "--allow-offline") {
+    allowOfflineExplicit = true;
+    continue;
+  }
+  if (arg === "--workdir") {
     const workdir = argv[i + 1]?.trim();
     if (!workdir) {
       console.error("--workdir requires a path");
@@ -282,9 +292,11 @@ function printHelp() {
   console.log("  --base-url=URL           OpenViking server URL (default: $OPENVIKING_BASE_URL or http://127.0.0.1:1933)");
   console.log("  --api-key=KEY            OpenViking API key (default: $OPENVIKING_API_KEY)");
   console.log("  --agent-prefix=PREFIX    Agent routing prefix (default: $OPENVIKING_AGENT_PREFIX)");
-  console.log("  --account-id=ID          Account ID for root API key (default: $OPENVIKING_ACCOUNT_ID)");
-  console.log("  --user-id=ID             User ID for root API key (default: $OPENVIKING_USER_ID)");
-  console.log("  --zh                     Chinese prompts");
+  console.log("  --account-id=ID          Account ID for root API key (default: $OPENVIKING_ACCOUNT_ID)");
+  console.log("  --user-id=ID             User ID for root API key (default: $OPENVIKING_USER_ID)");
+  console.log("  --force-slot             Explicitly replace an existing contextEngine slot owner");
+  console.log("  --allow-offline          Explicitly save config when the OpenViking server is unreachable");
+  console.log("  --zh                     Chinese prompts");
   console.log("  -h, --help               This help");
   console.log("");
   console.log("Examples:");
@@ -403,18 +415,23 @@ function runCapture(cmd, args, opts = {}) {
   });
 }
 
-function question(prompt, defaultValue = "") {
-  const rl = createInterface({ input: process.stdin, output: process.stdout });
-  const suffix = defaultValue ? ` [${defaultValue}]` : "";
-  return new Promise((resolve) => {
-    rl.question(`${prompt}${suffix}: `, (answer) => {
+function question(prompt, defaultValue = "") {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  const suffix = defaultValue ? ` [${defaultValue}]` : "";
+  return new Promise((resolve) => {
+    rl.question(`${prompt}${suffix}: `, (answer) => {
       rl.close();
       resolve((answer ?? defaultValue).trim() || defaultValue);
     });
-  });
-}
-
-function isValidAgentPrefixInput(value) {
+  });
+}
+
+function isYes(answer) {
+  const normalized = String(answer || "").trim().toLowerCase();
+  return normalized === "y" || normalized === "yes";
+}
+
+function isValidAgentPrefixInput(value) {
   const trimmed = String(value || "").trim();
   return !trimmed || /^[a-zA-Z0-9_-]+$/.test(trimmed);
 }
@@ -922,7 +939,7 @@ async function checkOpenClawCompatibility() {
   }
 
   // Check compatibility
-  if (!openClawPolicyVersionGte(ocVersion, resolvedMinOpenclawVersion)) {
+  if (!openClawPolicyVersionGte(ocVersion, resolvedMinOpenclawVersion)) {
     err(tr(
       `OpenClaw ${ocVersion} does not support this plugin (requires >= ${resolvedMinOpenclawVersion})`,
       `OpenClaw ${ocVersion} 不支持此插件（需要 >= ${resolvedMinOpenclawVersion}）`
@@ -1086,11 +1103,17 @@ function extractRuntimeConfigFromPluginEntry(entryConfig) {
     runtime.apiKey = entryConfig.apiKey;
   }
   const prefix = entryConfig.agent_prefix || entryConfig.agentId;
-  if (typeof prefix === "string" && prefix.trim()) {
-    runtime.agent_prefix = prefix.trim();
-  }
-  return runtime;
-}
+  if (typeof prefix === "string" && prefix.trim()) {
+    runtime.agent_prefix = prefix.trim();
+  }
+  if (typeof entryConfig.accountId === "string" && entryConfig.accountId.trim()) {
+    runtime.accountId = entryConfig.accountId.trim();
+  }
+  if (typeof entryConfig.userId === "string" && entryConfig.userId.trim()) {
+    runtime.userId = entryConfig.userId.trim();
+  }
+  return runtime;
+}
 
 async function backupOpenClawConfig(configPath) {
   await mkdir(getUpgradeAuditDir(), { recursive: true });
@@ -1380,10 +1403,12 @@ async function prepareStrongPluginUpgrade() {
       `检测到已安装 OpenViking 插件状态: ${installedState.generation}`,
     ),
   );
-  remoteBaseUrl = upgradeRuntimeConfig.baseUrl || remoteBaseUrl;
-  remoteApiKey = upgradeRuntimeConfig.apiKey || "";
-  remoteAgentPrefix = upgradeRuntimeConfig.agent_prefix || "";
-  info(tr(`Upgrade runtime mode: ${selectedMode} (remote OpenViking server)`, `升级运行模式: ${selectedMode}（远程 OpenViking 服务）`));
+  remoteBaseUrl = upgradeRuntimeConfig.baseUrl || remoteBaseUrl;
+  remoteApiKey = upgradeRuntimeConfig.apiKey || "";
+  remoteAgentPrefix = upgradeRuntimeConfig.agent_prefix || "";
+  remoteAccountId = upgradeRuntimeConfig.accountId || "";
+  remoteUserId = upgradeRuntimeConfig.userId || "";
+  info(tr(`Upgrade runtime mode: ${selectedMode} (remote OpenViking server)`, `升级运行模式: ${selectedMode}（远程 OpenViking 服务）`));
 
   info(tr(`Upgrade path: ${fromVersion} -> ${toVersion}`, `升级路径: ${fromVersion} -> ${toVersion}`));
 
@@ -1768,6 +1793,53 @@ async function cleanupConflictingPluginVariants() {
   info(tr("Conflicting plugin variants cleaned up", "冲突的插件变体已清理"));
 }
 
+function normalizeOpenClawLoadPath(filePath) {
+  return String(filePath || "")
+    .replace(/\\/g, "/")
+    .replace(/\/+$/g, "");
+}
+
+async function ensureOpenClawPluginLoadPath() {
+  const configPath = getOpenClawConfigPath();
+  let cfg = {};
+  if (existsSync(configPath)) {
+    try {
+      cfg = JSON.parse(await readFile(configPath, "utf8"));
+    } catch {
+      return;
+    }
+  }
+
+  const pluginPath = PLUGIN_DEST;
+  const normalizedPluginPath = normalizeOpenClawLoadPath(pluginPath);
+  const plugins = cfg.plugins && typeof cfg.plugins === "object" && !Array.isArray(cfg.plugins)
+    ? cfg.plugins
+    : {};
+  const load = plugins.load && typeof plugins.load === "object" && !Array.isArray(plugins.load)
+    ? plugins.load
+    : {};
+  const paths = Array.isArray(load.paths) ? load.paths : [];
+  if (paths.some((item) => normalizeOpenClawLoadPath(item) === normalizedPluginPath)) {
+    return;
+  }
+
+  const next = {
+    ...cfg,
+    plugins: {
+      ...plugins,
+      load: {
+        ...load,
+        paths: [...paths, pluginPath],
+      },
+    },
+  };
+  await mkdir(dirname(configPath), { recursive: true });
+  const tmp = `${configPath}.ov-install-tmp.${process.pid}`;
+  await writeFile(tmp, `${JSON.stringify(next, null, 2)}\n`, "utf8");
+  await rename(tmp, configPath);
+  info(tr(`Added OpenClaw plugin load path: ${pluginPath}`, `已添加 OpenClaw 插件加载路径: ${pluginPath}`));
+}
+
 async function configureOpenClawPlugin({
   preserveExistingConfig = false,
   runtimeConfig = null,
@@ -1821,6 +1893,8 @@ async function configureOpenClawPlugin({
     await scrubStaleOpenClawPluginRegistration();
   }
 
+  await ensureOpenClawPluginLoadPath();
+
   // Enable plugin: try CLI first (default path), fall back to direct file for --workdir
   if (!needWorkdirFlag) {
     try {
@@ -1931,13 +2005,14 @@ async function configureOpenClawPlugin({
     }
   } catch { /* ignore read errors */ }
 
-  let setupResult = null;
-  if (setupJsonSupported) {
-    const setupArgs = ["openviking", "setup"];
-    setupArgs.push("--base-url", effectiveRuntimeConfig.baseUrl || remoteBaseUrl);
-    setupArgs.push("--json");
-    if (effectiveRuntimeConfig.apiKey) {
-      setupArgs.push("--api-key", effectiveRuntimeConfig.apiKey);
+  let setupResult = null;
+  let parsed = null;
+  const runSetupJson = async (extraArgs = []) => {
+    const setupArgs = ["openviking", "setup"];
+    setupArgs.push("--base-url", effectiveRuntimeConfig.baseUrl || remoteBaseUrl);
+    setupArgs.push("--json");
+    if (effectiveRuntimeConfig.apiKey) {
+      setupArgs.push("--api-key", effectiveRuntimeConfig.apiKey);
     }
     if (effectiveRuntimeConfig.agent_prefix) {
       setupArgs.push("--agent-prefix", effectiveRuntimeConfig.agent_prefix);
@@ -1945,35 +2020,67 @@ async function configureOpenClawPlugin({
     if (effectiveRuntimeConfig.accountId) {
       setupArgs.push("--account-id", effectiveRuntimeConfig.accountId);
     }
-    if (effectiveRuntimeConfig.userId) {
-      setupArgs.push("--user-id", effectiveRuntimeConfig.userId);
-    }
-    if (claimSlot) {
-      setupArgs.push("--force-slot");
-    }
-    if (nonInteractive) {
-      setupArgs.push("--allow-offline");
-    }
-
-    info(tr(
-      "Delegating configuration to: openclaw openviking setup --json",
-      "委托配置给: openclaw openviking setup --json",
-    ));
-
-    setupResult = await runCapture("openclaw", setupArgs, { env: ocEnv, shell: IS_WIN });
-  } else {
-    info(tr(
-      "Installed plugin does not support setup --json, using direct config write",
-      "已安装的插件不支持 setup --json，使用直接配置写入",
-    ));
-  }
-
-  let parsed = null;
-  if (setupResult) {
-    parsed = parseJsonObjectFromOutput(`${setupResult.out || ""}\n${setupResult.err || ""}`);
-  }
-
-  if (parsed) {
+    if (effectiveRuntimeConfig.userId) {
+      setupArgs.push("--user-id", effectiveRuntimeConfig.userId);
+    }
+    if (forceSlotExplicit) {
+      setupArgs.push("--force-slot");
+    }
+    if (allowOfflineExplicit) {
+      setupArgs.push("--allow-offline");
+    }
+    setupArgs.push(...extraArgs);
+
+    const result = await runCapture("openclaw", setupArgs, { env: ocEnv, shell: IS_WIN });
+    return {
+      result,
+      parsed: parseJsonObjectFromOutput(`${result.out || ""}\n${result.err || ""}`),
+    };
+  };
+
+  if (setupJsonSupported) {
+    info(tr(
+      "Delegating configuration to: openclaw openviking setup --json",
+      "委托配置给: openclaw openviking setup --json",
+    ));
+
+    ({ result: setupResult, parsed } = await runSetupJson());
+  } else {
+    info(tr(
+      "Installed plugin does not support setup --json, using direct config write",
+      "已安装的插件不支持 setup --json，使用直接配置写入",
+    ));
+  }
+
+  if (parsed && !parsed.success && !nonInteractive) {
+    if (parsed.action === "slot_blocked" && !forceSlotExplicit) {
+      const answer = await question(
+        tr(
+          `contextEngine slot is owned by "${parsed.slot?.previousOwner}". Replace it with OpenViking? (y/N)`,
+          `contextEngine slot is owned by "${parsed.slot?.previousOwner}". Replace it with OpenViking? (y/N)`,
+        ),
+      );
+      if (isYes(answer)) {
+        ({ result: setupResult, parsed } = await runSetupJson(["--force-slot"]));
+      }
+    } else if (
+      typeof parsed.error === "string" &&
+      parsed.error.includes("Server unreachable") &&
+      !allowOfflineExplicit
+    ) {
+      const answer = await question(
+        tr(
+          "OpenViking server is unreachable. Save config offline anyway? (y/N)",
+          "OpenViking server is unreachable. Save config offline anyway? (y/N)",
+        ),
+      );
+      if (isYes(answer)) {
+        ({ result: setupResult, parsed } = await runSetupJson(["--allow-offline"]));
+      }
+    }
+  }
+
+  if (parsed) {
     if (parsed.success) {
       info(tr("OpenClaw plugin configured via setup", "OpenClaw 插件通过 setup 配置完成"));
       if (parsed.health?.ok) {
@@ -1991,32 +2098,37 @@ async function configureOpenClawPlugin({
       if (parsed.slot?.activated) {
         info(tr(`contextEngine slot activated`, `contextEngine slot 已激活`));
       }
-    } else {
-      // Setup returned success: false
-      if (parsed.action === "slot_blocked") {
-        warn(tr(
-          `Config saved but contextEngine slot is owned by "${parsed.slot?.previousOwner}". Use --force-slot to override.`,
-          `配置已保存，但 contextEngine slot 被 "${parsed.slot?.previousOwner}" 占用。使用 --force-slot 覆盖。`,
-        ));
-      } else {
-        err(tr(
-          `Setup failed: ${parsed.error || "unknown error"}`,
-          `配置失败: ${parsed.error || "未知错误"}`,
-        ));
-        return {
-          runtimeConfigOk: false,
-          error: parsed.error || parsed.action || "unknown error",
-        };
-      }
-    }
-  } else if (setupResult && setupResult.code !== 0) {
-    warn(tr(
-      `openclaw openviking setup exited with code ${setupResult.code}. Falling back to direct JSON config write.`,
-      `openclaw openviking setup 退出码 ${setupResult.code}，回退到直接写入 JSON 配置。`,
-    ));
-  }
-
-  if (!parsed) {
+    } else {
+      // Setup returned success: false
+      const setupError = parsed.error || parsed.action || "unknown error";
+      if (parsed.action === "slot_blocked") {
+        warn(tr(
+          `Config saved but contextEngine slot is owned by "${parsed.slot?.previousOwner}". Use --force-slot to override.`,
+          `配置已保存，但 contextEngine slot 被 "${parsed.slot?.previousOwner}" 占用。使用 --force-slot 覆盖。`,
+        ));
+      } else {
+        err(tr(
+          `Setup failed: ${setupError}`,
+          `配置失败: ${setupError}`,
+        ));
+      }
+      return {
+        runtimeConfigOk: false,
+        error: setupError,
+      };
+    }
+  } else if (setupJsonSupported) {
+    const setupError = setupResult
+      ? `openclaw openviking setup did not return JSON (exit code ${setupResult.code})`
+      : "openclaw openviking setup did not run";
+    err(tr(`Setup failed: ${setupError}`, `配置失败: ${setupError}`));
+    return {
+      runtimeConfigOk: false,
+      error: setupError,
+    };
+  }
+
+  if (!setupJsonSupported) {
     // Direct write: only used when the installed plugin doesn't support `setup --json` (old version).
     // Read the deployed configSchema to determine which fields are allowed, avoiding
     // "additionalProperties" validation failures when writing new fields to old schemas.
@@ -2153,7 +2265,7 @@ async function performUninstall() {
       tr("Confirm uninstall? (y/N)", "确认卸载？(y/N)"),
       "N",
     );
-    if (answer.toLowerCase() !== "y" && answer.toLowerCase() !== "yes") {
+    if (!isYes(answer)) {
       info(tr("Cancelled.", "已取消。"));
       return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openclaw-openviking-setup-helper",
-  "version": "0.3.0-beta.25",
+  "version": "0.3.0-beta.26",
   "description": "Setup helper for installing OpenViking memory plugin into OpenClaw",
   "type": "module",
   "bin": {