@nextclaw/service 0.1.1

package/dist/shared/types/cli.types.d.ts

@@ -0,0 +1,295 @@
+import { RestartStrategy } from "../services/restart/restart-coordinator.service.js";
+import { RemoteConnectCommandOptions, RemoteDoctorCommandOptions, RemoteEnableCommandOptions, RemoteRuntimeState, RemoteStatusCommandOptions } from "@nextclaw/remote";
+
+//#region src/shared/types/cli.types.d.ts
+type GatewayCommandOptions = {
+  ui?: boolean;
+  uiPort?: string | number;
+  uiOpen?: boolean;
+};
+type UiCommandOptions = {
+  port?: string | number;
+  open?: boolean;
+};
+type StartCommandOptions = {
+  uiPort?: string | number;
+  open?: boolean;
+  startTimeout?: string | number;
+};
+type CompanionStartCommandOptions = {
+  baseUrl?: string;
+};
+type CompanionEnableCommandOptions = {
+  baseUrl?: string;
+};
+type CompanionDisableCommandOptions = Record<string, never>;
+type CompanionStatusCommandOptions = {
+  json?: boolean;
+};
+type CompanionStopCommandOptions = {
+  force?: boolean;
+};
+type ServiceAutostartCommandOptions = {
+  user?: boolean;
+  system?: boolean;
+  dryRun?: boolean;
+  json?: boolean;
+};
+type AgentCommandOptions = {
+  message?: string;
+  session?: string;
+  markdown?: boolean;
+  model?: string;
+};
+type SkillsInstalledCommandOptions = {
+  workdir?: string;
+  scope?: string;
+  query?: string;
+  json?: boolean;
+};
+type SkillsInfoCommandOptions = {
+  workdir?: string;
+  json?: boolean;
+};
+type MarketplaceSkillsSearchCommandOptions = {
+  apiBase?: string;
+  query?: string;
+  tag?: string;
+  sort?: string;
+  page?: string | number;
+  pageSize?: string | number;
+  json?: boolean;
+};
+type MarketplaceSkillsRecommendCommandOptions = {
+  apiBase?: string;
+  scene?: string;
+  limit?: string | number;
+  json?: boolean;
+};
+type UpdateCommandOptions = {
+  check?: boolean;
+  download?: boolean;
+  apply?: boolean;
+  channel?: string;
+  manifestUrl?: string;
+  json?: boolean;
+};
+type LoginCommandOptions = {
+  apiBase?: string;
+  email?: string;
+  password?: string;
+  open?: boolean;
+};
+type AccountCommandOptions = {
+  apiBase?: string;
+  json?: boolean;
+};
+type AccountSetUsernameCommandOptions = {
+  apiBase?: string;
+  json?: boolean;
+};
+type PluginsListOptions = {
+  json?: boolean;
+  enabled?: boolean;
+  verbose?: boolean;
+};
+type AgentsListCommandOptions = {
+  json?: boolean;
+};
+type AgentsRuntimesCommandOptions = {
+  json?: boolean;
+  probe?: boolean;
+};
+type AgentsNewCommandOptions = {
+  name?: string;
+  description?: string;
+  avatar?: string;
+  home?: string;
+  runtime?: string;
+  json?: boolean;
+};
+type AgentsUpdateCommandOptions = {
+  name?: string;
+  description?: string;
+  avatar?: string;
+  runtime?: string;
+  json?: boolean;
+};
+type AgentsRemoveCommandOptions = {
+  json?: boolean;
+};
+type PluginsInfoOptions = {
+  json?: boolean;
+};
+type PluginsInstallOptions = {
+  link?: boolean;
+};
+type PluginsUninstallOptions = {
+  keepFiles?: boolean;
+  keepConfig?: boolean;
+  force?: boolean;
+  dryRun?: boolean;
+};
+type ChannelsAddOptions = {
+  channel: string;
+  code?: string;
+  token?: string;
+  name?: string;
+  url?: string;
+  httpUrl?: string;
+};
+type ChannelsLoginOptions = {
+  channel?: string;
+  account?: string;
+  url?: string;
+  httpUrl?: string;
+  verbose?: boolean;
+};
+type ConfigGetOptions = {
+  json?: boolean;
+};
+type ConfigSetOptions = {
+  json?: boolean;
+};
+type McpListOptions = {
+  json?: boolean;
+};
+type McpAddCommandOptions = {
+  transport?: string;
+  url?: string;
+  header?: string[];
+  env?: string[];
+  cwd?: string;
+  timeoutMs?: string | number;
+  disabled?: boolean;
+  allAgents?: boolean;
+  agent?: string[];
+  stderr?: string;
+  insecure?: boolean;
+};
+type McpDoctorOptions = {
+  json?: boolean;
+};
+type SecretsAuditOptions = {
+  json?: boolean;
+  strict?: boolean;
+};
+type SecretsConfigureOptions = {
+  provider?: string;
+  source?: string;
+  prefix?: string;
+  path?: string;
+  command?: string;
+  arg?: string[];
+  cwd?: string;
+  timeoutMs?: string | number;
+  setDefault?: boolean;
+  remove?: boolean;
+  json?: boolean;
+};
+type SecretsApplyOptions = {
+  path?: string;
+  source?: string;
+  id?: string;
+  provider?: string;
+  file?: string;
+  remove?: boolean;
+  enable?: boolean;
+  disable?: boolean;
+  json?: boolean;
+};
+type SecretsReloadOptions = {
+  json?: boolean;
+};
+type CronAddOptions = {
+  name: string;
+  message: string;
+  agent?: string;
+  session?: string;
+  every?: string;
+  cron?: string;
+  at?: string;
+  deliver?: boolean;
+  to?: string;
+  channel?: string;
+  account?: string;
+};
+type StatusCommandOptions = {
+  json?: boolean;
+  verbose?: boolean;
+  fix?: boolean;
+};
+type DoctorCommandOptions = {
+  json?: boolean;
+  verbose?: boolean;
+  fix?: boolean;
+};
+type LogsTailCommandOptions = {
+  crash?: boolean;
+  lines?: string | number;
+};
+type UsageCommandOptions = {
+  json?: boolean;
+  history?: boolean;
+  stats?: boolean;
+  limit?: string | number;
+};
+type HealthProbe = {
+  state: "ok" | "unreachable" | "invalid-response";
+  detail: string;
+  payload?: unknown;
+};
+type RuntimeStatusReport = {
+  generatedAt: string;
+  configPath: string;
+  configExists: boolean;
+  workspacePath: string;
+  workspaceExists: boolean;
+  model: string;
+  providers: Array<{
+    name: string;
+    configured: boolean;
+    detail: string;
+  }>;
+  serviceStatePath: string;
+  serviceStateExists: boolean;
+  fixActions: string[];
+  process: {
+    managedByState: boolean;
+    pid: number | null;
+    running: boolean;
+    staleState: boolean;
+    orphanSuspected: boolean;
+    startedAt: string | null;
+  };
+  endpoints: {
+    uiUrl: string | null;
+    apiUrl: string | null;
+    configuredUiUrl: string;
+    configuredApiUrl: string;
+  };
+  health: {
+    managed: HealthProbe;
+    configured: HealthProbe;
+  };
+  issues: string[];
+  recommendations: string[];
+  logTail: string[];
+  remote: {
+    configuredEnabled: boolean;
+    runtime: RemoteRuntimeState | null;
+  };
+  level: "healthy" | "degraded" | "stopped";
+  exitCode: 0 | 1 | 2;
+};
+type RequestRestartParams = {
+  reason: string;
+  manualMessage: string;
+  strategy?: RestartStrategy;
+  delayMs?: number;
+  silentOnServiceRestart?: boolean;
+  changedPaths?: string[];
+  mode?: "execute" | "notify";
+};
+//#endregion
+export { AccountCommandOptions, AccountSetUsernameCommandOptions, AgentCommandOptions, AgentsListCommandOptions, AgentsNewCommandOptions, AgentsRemoveCommandOptions, AgentsRuntimesCommandOptions, AgentsUpdateCommandOptions, ChannelsAddOptions, ChannelsLoginOptions, CompanionDisableCommandOptions, CompanionEnableCommandOptions, CompanionStartCommandOptions, CompanionStatusCommandOptions, CompanionStopCommandOptions, ConfigGetOptions, ConfigSetOptions, CronAddOptions, DoctorCommandOptions, GatewayCommandOptions, HealthProbe, LoginCommandOptions, LogsTailCommandOptions, MarketplaceSkillsRecommendCommandOptions, MarketplaceSkillsSearchCommandOptions, McpAddCommandOptions, McpDoctorOptions, McpListOptions, PluginsInfoOptions, PluginsInstallOptions, PluginsListOptions, PluginsUninstallOptions, type RemoteConnectCommandOptions, type RemoteDoctorCommandOptions, type RemoteEnableCommandOptions, type RemoteStatusCommandOptions, RequestRestartParams, RuntimeStatusReport, SecretsApplyOptions, SecretsAuditOptions, SecretsConfigureOptions, SecretsReloadOptions, ServiceAutostartCommandOptions, SkillsInfoCommandOptions, SkillsInstalledCommandOptions, StartCommandOptions, StatusCommandOptions, UiCommandOptions, UpdateCommandOptions, UsageCommandOptions };

package/dist/shared/types/cli.types.js

@@ -0,0 +1 @@
+export {};

package/dist/shared/utils/cli.utils.d.ts

@@ -0,0 +1,34 @@
+import { getPackageVersion } from "./package/package-manifest.utils.js";
+import { Config } from "@nextclaw/core";
+import { Interface } from "node:readline";
+
+//#region src/shared/utils/cli.utils.d.ts
+declare function resolveUiConfig(config: Config, overrides?: Partial<Config["ui"]>): Config["ui"];
+declare function resolveUiApiBase(host: string, port: number): string;
+declare function isLoopbackHost(host: string): boolean;
+declare function resolvePublicIp(timeoutMs?: number): Promise<string | null>;
+declare function buildServeArgs(options: {
+  uiPort: number;
+}): string[];
+declare function resolveServiceLogPath(): string;
+declare function isProcessRunning(pid: number): boolean;
+declare function waitForExit(pid: number, timeoutMs: number): Promise<boolean>;
+type ListeningProcessInfo = {
+  pid: number;
+  command: string | null;
+};
+declare function findListeningProcessByPort(port: number): ListeningProcessInfo | null;
+declare function resolveUiStaticDir(importMetaUrl?: string): string | null;
+declare function openBrowser(url: string): boolean;
+type ExecutableLookupEnv = {
+  [key: string]: string | undefined;
+  PATH?: string;
+  Path?: string;
+  path?: string;
+  PATHEXT?: string;
+};
+declare function findExecutableOnPath(binary: string, env?: ExecutableLookupEnv, platform?: NodeJS.Platform): string | null;
+declare function printAgentResponse(response: string): void;
+declare function prompt(rl: Interface, question: string): Promise<string>;
+//#endregion
+export { ExecutableLookupEnv, ListeningProcessInfo, buildServeArgs, findExecutableOnPath, findListeningProcessByPort, getPackageVersion, isLoopbackHost, isProcessRunning, openBrowser, printAgentResponse, prompt, resolvePublicIp, resolveServiceLogPath, resolveUiApiBase, resolveUiConfig, resolveUiStaticDir, waitForExit };

package/dist/shared/utils/cli.utils.js

@@ -0,0 +1,262 @@
+import { findNearestPackageManifest, getPackageVersion } from "./package/package-manifest.utils.js";
+import { spawn, spawnSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+import { join, resolve } from "node:path";
+import { createExternalCommandEnv, getLogsPath, resolveLocalUiBaseUrl } from "@nextclaw/core";
+import { existsSync } from "node:fs";
+import { isIP } from "node:net";
+//#region src/shared/utils/cli.utils.ts
+function resolveUiConfig(config, overrides) {
+	return {
+		...config.ui ?? {
+			enabled: false,
+			host: "127.0.0.1",
+			port: 55667,
+			open: false
+		},
+		...overrides ?? {}
+	};
+}
+function resolveUiApiBase(host, port) {
+	return resolveLocalUiBaseUrl({
+		host,
+		port
+	});
+}
+function isLoopbackHost(host) {
+	const normalized = host.trim().toLowerCase();
+	return normalized === "127.0.0.1" || normalized === "localhost" || normalized === "::1";
+}
+const PUBLIC_IP_CHECK_URLS = ["https://api.ipify.org", "https://ifconfig.me/ip"];
+async function fetchPublicIpFrom(url, timeoutMs) {
+	const controller = new AbortController();
+	const timer = setTimeout(() => controller.abort(), timeoutMs);
+	try {
+		const response = await fetch(url, {
+			signal: controller.signal,
+			headers: { Accept: "text/plain" }
+		});
+		if (!response.ok) return null;
+		const text = (await response.text()).trim();
+		return isIP(text) ? text : null;
+	} catch {
+		return null;
+	} finally {
+		clearTimeout(timer);
+	}
+}
+async function resolvePublicIp(timeoutMs = 1500) {
+	for (const endpoint of PUBLIC_IP_CHECK_URLS) {
+		const candidate = await fetchPublicIpFrom(endpoint, timeoutMs);
+		if (candidate) return candidate;
+	}
+	return null;
+}
+function buildServeArgs(options) {
+	return [
+		fileURLToPath(new URL("../../app/index.js", import.meta.url)),
+		"serve",
+		"--ui-port",
+		String(options.uiPort)
+	];
+}
+function resolveServiceLogPath() {
+	return resolve(getLogsPath(), "service.log");
+}
+function isProcessRunning(pid) {
+	try {
+		process.kill(pid, 0);
+		return true;
+	} catch {
+		return false;
+	}
+}
+async function waitForExit(pid, timeoutMs) {
+	const start = Date.now();
+	while (Date.now() - start < timeoutMs) {
+		if (!isProcessRunning(pid)) return true;
+		await new Promise((resolve) => setTimeout(resolve, 200));
+	}
+	return !isProcessRunning(pid);
+}
+function runLookupCommand(command, args) {
+	try {
+		const result = spawnSync(command, args, {
+			encoding: "utf8",
+			env: createExternalCommandEnv(process.env)
+		});
+		if (result.error || result.status !== 0) return {
+			ok: false,
+			stdout: ""
+		};
+		return {
+			ok: true,
+			stdout: result.stdout ?? ""
+		};
+	} catch {
+		return {
+			ok: false,
+			stdout: ""
+		};
+	}
+}
+function parseListeningPidFromLsof(raw) {
+	for (const line of raw.split("\n")) {
+		if (!line.startsWith("p")) continue;
+		const pid = Number(line.slice(1));
+		if (Number.isFinite(pid) && pid > 0) return pid;
+	}
+	return null;
+}
+function parseListeningPidFromNetstat(raw, port) {
+	const portSuffix = `:${port}`;
+	for (const line of raw.split("\n")) {
+		const trimmed = line.trim();
+		if (!trimmed || !trimmed.includes("LISTEN")) continue;
+		const columns = trimmed.split(/\s+/);
+		if (columns.length < 5) continue;
+		if (!(columns[1] ?? "").endsWith(portSuffix)) continue;
+		const pid = Number(columns[4]);
+		if (Number.isFinite(pid) && pid > 0) return pid;
+	}
+	return null;
+}
+function lookupProcessCommandByPid(pid) {
+	if (!Number.isFinite(pid) || pid <= 0) return null;
+	if (process.platform === "win32") {
+		const result = runLookupCommand("powershell", [
+			"-NoProfile",
+			"-Command",
+			`(Get-CimInstance Win32_Process -Filter "ProcessId = ${pid}").CommandLine`
+		]);
+		if (!result.ok) return null;
+		const command = result.stdout.trim();
+		return command.length > 0 ? command : null;
+	}
+	const result = runLookupCommand("ps", [
+		"-p",
+		String(pid),
+		"-o",
+		"command="
+	]);
+	if (!result.ok) return null;
+	const command = result.stdout.trim();
+	return command.length > 0 ? command : null;
+}
+function findListeningProcessByPort(port) {
+	if (!Number.isFinite(port) || port <= 0) return null;
+	let pid = null;
+	if (process.platform === "win32") {
+		const result = runLookupCommand("netstat", [
+			"-ano",
+			"-p",
+			"tcp"
+		]);
+		if (!result.ok) return null;
+		pid = parseListeningPidFromNetstat(result.stdout, port);
+	} else {
+		const result = runLookupCommand("lsof", [
+			"-nP",
+			`-iTCP:${port}`,
+			"-sTCP:LISTEN",
+			"-F",
+			"p"
+		]);
+		if (!result.ok) return null;
+		pid = parseListeningPidFromLsof(result.stdout);
+	}
+	if (!pid) return null;
+	return {
+		pid,
+		command: lookupProcessCommandByPid(pid)
+	};
+}
+function resolveUiStaticDir(importMetaUrl = import.meta.url) {
+	if (process.env.NEXTCLAW_DISABLE_STATIC_UI === "1") return null;
+	const envDir = process.env.NEXTCLAW_UI_STATIC_DIR;
+	if (envDir) return existsSync(join(envDir, "index.html")) ? envDir : null;
+	const pkgRoot = findNearestPackageManifest(resolve(fileURLToPath(new URL(".", importMetaUrl))), "nextclaw")?.rootDir;
+	if (!pkgRoot) return null;
+	const bundledDir = join(pkgRoot, "ui-dist");
+	return existsSync(join(bundledDir, "index.html")) ? bundledDir : null;
+}
+function openBrowser(url) {
+	const platform = process.platform;
+	let command;
+	let args;
+	if (platform === "darwin") {
+		command = "open";
+		args = [url];
+	} else if (platform === "win32") {
+		command = "cmd";
+		args = [
+			"/c",
+			"start",
+			"",
+			url
+		];
+	} else {
+		command = "xdg-open";
+		args = [url];
+	}
+	if (!findExecutableOnPath(command)) return false;
+	try {
+		spawn(command, args, {
+			stdio: "ignore",
+			detached: true,
+			env: createExternalCommandEnv(process.env)
+		}).unref();
+		return true;
+	} catch {
+		return false;
+	}
+}
+function normalizePathEntries(rawPath, platform) {
+	const delimiter = platform === "win32" ? ";" : ":";
+	return rawPath.split(delimiter).map((entry) => entry.trim().replace(/^"+|"+$/g, "")).filter(Boolean);
+}
+function normalizeWindowsPathExt(rawPathExt) {
+	const source = rawPathExt && rawPathExt.trim().length > 0 ? rawPathExt : ".COM;.EXE;.BAT;.CMD";
+	const unique = /* @__PURE__ */ new Set();
+	for (const ext of source.split(";")) {
+		const trimmed = ext.trim();
+		if (!trimmed) continue;
+		const normalized = trimmed.startsWith(".") ? trimmed : `.${trimmed}`;
+		unique.add(normalized.toUpperCase());
+	}
+	return [...unique];
+}
+function hasFileExtension(binary) {
+	return binary.lastIndexOf(".") > Math.max(binary.lastIndexOf("/"), binary.lastIndexOf("\\"));
+}
+function findExecutableOnPath(binary, env = process.env, platform = process.platform) {
+	const target = binary.trim();
+	if (!target) return null;
+	if (target.includes("/") || target.includes("\\")) return existsSync(target) ? target : null;
+	const rawPath = env.PATH ?? env.Path ?? env.path ?? "";
+	if (!rawPath.trim()) return null;
+	const entries = normalizePathEntries(rawPath, platform);
+	if (entries.length === 0) return null;
+	for (const dir of entries) {
+		const direct = join(dir, target);
+		if (existsSync(direct)) return direct;
+		if (platform !== "win32" || hasFileExtension(target)) continue;
+		for (const ext of normalizeWindowsPathExt(env.PATHEXT)) {
+			const withExt = join(dir, `${target}${ext}`);
+			if (existsSync(withExt)) return withExt;
+		}
+	}
+	return null;
+}
+function printAgentResponse(response) {
+	console.log("\n" + response + "\n");
+}
+async function prompt(rl, question) {
+	rl.setPrompt(question);
+	rl.prompt();
+	return new Promise((resolve) => {
+		rl.once("line", (line) => resolve(line));
+	});
+}
+//#endregion
+export { buildServeArgs, findExecutableOnPath, findListeningProcessByPort, getPackageVersion, isLoopbackHost, isProcessRunning, openBrowser, printAgentResponse, prompt, resolvePublicIp, resolveServiceLogPath, resolveUiApiBase, resolveUiConfig, resolveUiStaticDir, waitForExit };

package/dist/shared/utils/config-path.d.ts

@@ -0,0 +1,15 @@
+import { ConfigSetOptions } from "../types/cli.types.js";
+
+//#region src/shared/utils/config-path.d.ts
+declare function isIndexSegment(raw: string): boolean;
+declare function parseConfigPath(raw: string): string[];
+declare function parseRequiredConfigPath(raw: string): string[];
+declare function parseConfigSetValue(raw: string, opts: ConfigSetOptions): unknown;
+declare function getAtConfigPath(root: unknown, pathSegments: string[]): {
+  found: boolean;
+  value?: unknown;
+};
+declare function setAtConfigPath(root: Record<string, unknown>, pathSegments: string[], value: unknown): void;
+declare function unsetAtConfigPath(root: Record<string, unknown>, pathSegments: string[]): boolean;
+//#endregion
+export { getAtConfigPath, isIndexSegment, parseConfigPath, parseConfigSetValue, parseRequiredConfigPath, setAtConfigPath, unsetAtConfigPath };