clankie 0.1.0

package/src/config.ts

@@ -0,0 +1,380 @@
+/**
+ * clankie configuration management
+ *
+ * Reads an optional JSON5 config from ~/.clankie/clankie.json (comments + trailing commas allowed).
+ * Structure mirrors OpenClaw's ~/.openclaw/openclaw.json where applicable.
+ *
+ * Authentication credentials are managed by pi's AuthStorage
+ * at ~/.pi/agent/auth.json — shared between `pi` and `clankie`.
+ */
+
+import { chmodSync, existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import JSON5 from "json5";
+
+// ─── Config types ────────────────────────────────────────────────────────────
+
+export interface AppConfig {
+	/** Agent runtime settings */
+	agent?: {
+		/** Default persona name (default: "default") */
+		persona?: string;
+		/** Working directory for the agent (default: ~/.clankie/workspace) */
+		workspace?: string;
+		/** Override for pi's agent dir (default: ~/.clankie) */
+		agentDir?: string;
+		/** Model configuration */
+		model?: {
+			/** Primary model in provider/model format (e.g. "anthropic/claude-sonnet-4-5") */
+			primary?: string;
+			/** Fallback models tried in order if primary fails */
+			fallbacks?: string[];
+		};
+	};
+
+	/** Channel configuration — each channel starts when its section exists */
+	channels?: {
+		slack?: {
+			enabled?: boolean;
+			/** Persona name override for this channel */
+			persona?: string;
+			/** Per-channel persona mapping (Slack channel ID → persona name) */
+			channelPersonas?: Record<string, string>;
+			/** App token from Slack app settings (xapp-...) */
+			appToken?: string;
+			/** Bot token from Slack app settings (xoxb-...) */
+			botToken?: string;
+			/** Allowed Slack user IDs */
+			allowFrom?: string[];
+		};
+	};
+
+	/** Cron / scheduled jobs */
+	cron?: {
+		enabled?: boolean;
+	};
+
+	/** Heartbeat — periodic task execution */
+	heartbeat?: {
+		/** Enable heartbeat (default: true when daemon is running) */
+		enabled?: boolean;
+		/** Check interval in minutes (default: 30, min: 5) */
+		intervalMinutes?: number;
+	};
+}
+
+// ─── Paths ────────────────────────────────────────────────────────────────────
+
+const APP_DIR = join(homedir(), ".clankie");
+const CONFIG_PATH = join(APP_DIR, "clankie.json");
+/** Legacy path — migrated automatically */
+const LEGACY_CONFIG_PATH = join(APP_DIR, "config.json");
+
+/** Returns the path to the app's config directory, creating it if needed. */
+export function getAppDir(): string {
+	if (!existsSync(APP_DIR)) {
+		mkdirSync(APP_DIR, { recursive: true, mode: 0o700 });
+	}
+	return APP_DIR;
+}
+
+/** Resolves the workspace directory, creating it if needed. */
+export function getWorkspace(config?: AppConfig): string {
+	const workspace = config?.agent?.workspace ?? join(homedir(), ".clankie", "workspace");
+	const resolved = workspace.replace(/^~/, homedir());
+	if (!existsSync(resolved)) {
+		mkdirSync(resolved, { recursive: true, mode: 0o755 });
+	}
+	return resolved;
+}
+
+/** Resolves pi's agent directory (defaults to ~/.clankie to keep the app self-contained). */
+export function getAgentDir(config?: AppConfig): string {
+	return config?.agent?.agentDir ?? join(homedir(), ".clankie");
+}
+
+/** Returns the path to the app's auth file (~/.clankie/auth.json). */
+export function getAuthPath(): string {
+	return join(getAppDir(), "auth.json");
+}
+
+/** Path to the config file */
+export function getConfigPath(): string {
+	return CONFIG_PATH;
+}
+
+// ─── Loading & saving ─────────────────────────────────────────────────────────
+
+/** Load config from ~/.clankie/clankie.json (JSON5). Returns empty config if missing. */
+export function loadConfig(): AppConfig {
+	getAppDir();
+
+	// Auto-migrate legacy config.json → clankie.json
+	if (!existsSync(CONFIG_PATH) && existsSync(LEGACY_CONFIG_PATH)) {
+		migrateFromLegacy();
+	}
+
+	if (!existsSync(CONFIG_PATH)) {
+		return {};
+	}
+	try {
+		const raw = readFileSync(CONFIG_PATH, "utf-8");
+		return JSON5.parse(raw) as AppConfig;
+	} catch (err) {
+		console.error(`Warning: failed to parse ${CONFIG_PATH}: ${err instanceof Error ? err.message : String(err)}`);
+		return {};
+	}
+}
+
+/** Save config to ~/.clankie/clankie.json (JSON5-formatted with 2-space indent). */
+export function saveConfig(config: AppConfig): void {
+	getAppDir();
+	// JSON5.stringify produces valid JSON5 with trailing commas when possible
+	writeFileSync(CONFIG_PATH, `${JSON5.stringify(config, null, 2)}\n`, "utf-8");
+	try {
+		chmodSync(CONFIG_PATH, 0o600);
+	} catch {
+		// chmod may not be supported on all platforms; non-fatal
+	}
+}
+
+/** Deep-merge partial updates into the config. */
+export function updateConfig(partial: Partial<AppConfig>): AppConfig {
+	const current = loadConfig();
+	const updated = deepMerge(
+		current as unknown as Record<string, unknown>,
+		partial as unknown as Record<string, unknown>,
+	);
+	saveConfig(updated as unknown as AppConfig);
+	return updated as unknown as AppConfig;
+}
+
+// ─── Dot-path accessors (for `clankie config get/set`) ───────────────────────
+
+/** Get a value from the config by dot-separated path (e.g. "channels.telegram.botToken") */
+export function getByPath(config: AppConfig, path: string): unknown {
+	const parts = path.split(".");
+	let current: unknown = config;
+	for (const part of parts) {
+		if (current == null || typeof current !== "object") return undefined;
+		current = (current as Record<string, unknown>)[part];
+	}
+	return current;
+}
+
+/** Set a value in the config by dot-separated path. Returns the updated config. */
+export function setByPath(config: AppConfig, path: string, value: unknown): AppConfig {
+	const parts = path.split(".");
+	const clone = structuredClone(config) as Record<string, unknown>;
+
+	let current: Record<string, unknown> = clone;
+	for (let i = 0; i < parts.length - 1; i++) {
+		const part = parts[i];
+		if (current[part] == null || typeof current[part] !== "object") {
+			current[part] = {};
+		}
+		current = current[part] as Record<string, unknown>;
+	}
+
+	const lastKey = parts[parts.length - 1];
+	current[lastKey] = value;
+
+	return clone as unknown as AppConfig;
+}
+
+/** Unset (delete) a value from the config by dot-separated path. Returns the updated config. */
+export function unsetByPath(config: AppConfig, path: string): AppConfig {
+	const parts = path.split(".");
+	const clone = structuredClone(config) as Record<string, unknown>;
+
+	let current: Record<string, unknown> = clone;
+	for (let i = 0; i < parts.length - 1; i++) {
+		const part = parts[i];
+		if (current[part] == null || typeof current[part] !== "object") return clone as unknown as AppConfig;
+		current = current[part] as Record<string, unknown>;
+	}
+
+	delete current[parts[parts.length - 1]];
+	return clone as unknown as AppConfig;
+}
+
+// ─── Helpers ──────────────────────────────────────────────────────────────────
+
+function deepMerge(target: Record<string, unknown>, source: Record<string, unknown>): Record<string, unknown> {
+	const result = { ...target };
+	for (const key of Object.keys(source)) {
+		const sourceVal = source[key];
+		const targetVal = target[key];
+		if (
+			sourceVal != null &&
+			typeof sourceVal === "object" &&
+			!Array.isArray(sourceVal) &&
+			targetVal != null &&
+			typeof targetVal === "object" &&
+			!Array.isArray(targetVal)
+		) {
+			result[key] = deepMerge(targetVal as Record<string, unknown>, sourceVal as Record<string, unknown>);
+		} else {
+			result[key] = sourceVal;
+		}
+	}
+	return result;
+}
+
+/** Migrate legacy ~/.clankie/config.json (flat keys) to new ~/.clankie/clankie.json (nested). */
+function migrateFromLegacy(): void {
+	try {
+		const raw = readFileSync(LEGACY_CONFIG_PATH, "utf-8");
+		const legacy = JSON.parse(raw) as Record<string, unknown>;
+
+		const config: AppConfig = {};
+
+		// Map flat keys → nested structure
+		if (legacy.workspace || legacy.agentDir || legacy.provider || legacy.model) {
+			config.agent = {};
+			if (legacy.workspace) config.agent.workspace = legacy.workspace as string;
+			if (legacy.agentDir) config.agent.agentDir = legacy.agentDir as string;
+			if (legacy.model) {
+				config.agent.model = { primary: legacy.model as string };
+			}
+		}
+
+		saveConfig(config);
+		console.log(`Migrated config: ${LEGACY_CONFIG_PATH} → ${CONFIG_PATH}`);
+	} catch {
+		// Migration failed — non-fatal
+	}
+}
+
+// ─── Persona helpers ──────────────────────────────────────────────────────────
+
+/** Returns the path to the personas directory (~/.clankie/personas/), creating it if needed. */
+export function getPersonasDir(): string {
+	const dir = join(getAppDir(), "personas");
+	if (!existsSync(dir)) {
+		mkdirSync(dir, { recursive: true, mode: 0o700 });
+	}
+	return dir;
+}
+
+/**
+ * Validate and sanitize a persona name.
+ * Only allows alphanumeric, underscore, hyphen, and dot.
+ * Throws if invalid to prevent path traversal.
+ */
+function validatePersonaName(name: string): void {
+	if (!name || typeof name !== "string") {
+		throw new Error("Persona name must be a non-empty string");
+	}
+
+	const trimmed = name.trim();
+	if (!trimmed) {
+		throw new Error("Persona name cannot be empty or whitespace-only");
+	}
+
+	// Only allow safe characters: alphanumeric, underscore, hyphen, dot
+	if (!/^[a-zA-Z0-9._-]+$/.test(trimmed)) {
+		throw new Error(
+			`Invalid persona name "${name}". Only alphanumeric characters, dots, underscores, and hyphens are allowed.`,
+		);
+	}
+
+	// Prevent names that look like path traversal
+	if (trimmed.includes("..") || trimmed.startsWith(".") || trimmed.startsWith("-")) {
+		throw new Error(`Invalid persona name "${name}". Cannot start with dot or hyphen, or contain ".."`);
+	}
+}
+
+/**
+ * Returns the path to a specific persona directory.
+ * Validates the persona name and ensures the resolved path stays within the personas directory.
+ */
+export function getPersonaDir(personaName: string): string {
+	validatePersonaName(personaName);
+
+	const personasDir = getPersonasDir();
+	const personaDir = join(personasDir, personaName);
+
+	// Ensure the resolved path is actually under the personas directory (prevent traversal)
+	const { realpathSync } = require("node:fs");
+	try {
+		const canonicalPersonasDir = realpathSync(personasDir);
+		const canonicalPersonaDir = existsSync(personaDir)
+			? realpathSync(personaDir)
+			: join(canonicalPersonasDir, personaName); // Use join for non-existent paths
+
+		if (!canonicalPersonaDir.startsWith(canonicalPersonasDir + require("node:path").sep)) {
+			throw new Error(`Persona path "${personaDir}" escapes personas directory`);
+		}
+	} catch (_err) {
+		// If personas dir doesn't exist yet, just validate the constructed path
+		if (!personaDir.startsWith(personasDir + require("node:path").sep)) {
+			throw new Error(`Invalid persona path: would escape personas directory`);
+		}
+	}
+
+	return personaDir;
+}
+
+/**
+ * Load persona-specific model configuration from persona.json.
+ * Returns the model spec (provider/model) if set, otherwise undefined.
+ */
+export function resolvePersonaModel(personaName: string): string | undefined {
+	const configPath = join(getPersonaDir(personaName), "persona.json");
+	if (!existsSync(configPath)) return undefined;
+
+	try {
+		const raw = readFileSync(configPath, "utf-8");
+		const config = JSON5.parse(raw) as { model?: unknown };
+
+		// Validate that model is a non-empty string
+		if (typeof config.model !== "string") {
+			return undefined;
+		}
+
+		const trimmed = config.model.trim();
+		return trimmed || undefined;
+	} catch {
+		return undefined;
+	}
+}
+
+// ─── Channel persona override helpers ──────────────────────────────────────────
+
+const CHANNEL_PERSONA_OVERRIDES_PATH = join(APP_DIR, "channel-personas.json");
+
+/**
+ * Load channel-specific persona overrides from ~/.clankie/channel-personas.json.
+ * Returns a map of channel keys (e.g., "slack_C12345678") to persona names.
+ */
+export function loadChannelPersonaOverrides(): Record<string, string> {
+	if (!existsSync(CHANNEL_PERSONA_OVERRIDES_PATH)) {
+		return {};
+	}
+
+	try {
+		const raw = readFileSync(CHANNEL_PERSONA_OVERRIDES_PATH, "utf-8");
+		const parsed = JSON.parse(raw);
+		return typeof parsed === "object" && parsed !== null ? parsed : {};
+	} catch (err) {
+		console.error(
+			`Warning: failed to parse ${CHANNEL_PERSONA_OVERRIDES_PATH}: ${err instanceof Error ? err.message : String(err)}`,
+		);
+		return {};
+	}
+}
+
+/**
+ * Save channel-specific persona overrides to ~/.clankie/channel-personas.json.
+ */
+export function saveChannelPersonaOverrides(overrides: Record<string, string>): void {
+	getAppDir(); // Ensure directory exists
+	writeFileSync(CHANNEL_PERSONA_OVERRIDES_PATH, JSON.stringify(overrides, null, 2), "utf-8");
+	try {
+		chmodSync(CHANNEL_PERSONA_OVERRIDES_PATH, 0o600);
+	} catch {
+		// chmod may not be supported on all platforms; non-fatal
+	}
+}