@newsails/veil-cli 1.0.1

package/utils/paths.js

@@ -0,0 +1,213 @@
+'use strict';
+
+const path = require('path');
+const os = require('os');
+
+const CONFIG_DIR_NAME = '.veil';
+
+/**
+ * Returns the .veil/ config directory for a project.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectConfigDir(cwd) {
+  return path.join(cwd, CONFIG_DIR_NAME);
+}
+
+/**
+ * Returns the agents directory for a project.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectAgentsDir(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'agents');
+}
+
+/**
+ * Returns the path to a specific agent's folder in a project.
+ * @param {string} cwd - Project root directory
+ * @param {string} agentName - Agent name
+ * @returns {string}
+ */
+function getAgentDir(cwd, agentName) {
+  return path.join(getProjectAgentsDir(cwd), agentName);
+}
+
+/**
+ * Returns the project-level settings.json path.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectSettingsPath(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'settings.json');
+}
+
+/**
+ * Returns the project-level settings.local.json path.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectSettingsLocalPath(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'settings.local.json');
+}
+
+/**
+ * Returns the project-level auth.json path.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectAuthPath(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'auth.json');
+}
+
+/**
+ * Returns the project-level AGENT.md path (global instructions for all agents).
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectAgentMdPath(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'AGENT.md');
+}
+
+/**
+ * Returns the project-level memory directory.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectMemoryDir(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'memory');
+}
+
+/**
+ * Returns the memory dir for a specific agent.
+ * @param {string} cwd - Project root directory
+ * @param {string} agentName - Agent name
+ * @returns {string}
+ */
+function getAgentMemoryDir(cwd, agentName) {
+  return path.join(getProjectMemoryDir(cwd), 'agents', agentName);
+}
+
+/**
+ * Returns the heartbeats directory.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getHeartbeatsDir(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'heartbeats');
+}
+
+/**
+ * Returns the project-level tools directory.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectToolsDir(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'tools');
+}
+
+/**
+ * Returns the project-level skills directory.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getProjectSkillsDir(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'skills');
+}
+
+/**
+ * Returns the PID file path.
+ * @param {string} cwd - Project root directory
+ * @returns {string}
+ */
+function getPidFilePath(cwd) {
+  return path.join(getProjectConfigDir(cwd), 'runtime.pid');
+}
+
+// ── Global paths (~/.veil/) ─────────────────────────────────────────────
+
+/**
+ * Returns the global ~/.veil/ directory.
+ * @returns {string}
+ */
+function getGlobalConfigDir() {
+  return path.join(os.homedir(), CONFIG_DIR_NAME);
+}
+
+/**
+ * Returns the global agents directory.
+ * @returns {string}
+ */
+function getGlobalAgentsDir() {
+  return path.join(getGlobalConfigDir(), 'agents');
+}
+
+/**
+ * Returns the global tools directory.
+ * @returns {string}
+ */
+function getGlobalToolsDir() {
+  return path.join(getGlobalConfigDir(), 'tools');
+}
+
+/**
+ * Returns the global skills directory.
+ * @returns {string}
+ */
+function getGlobalSkillsDir() {
+  return path.join(getGlobalConfigDir(), 'skills');
+}
+
+/**
+ * Returns the global settings.json path.
+ * @returns {string}
+ */
+function getGlobalSettingsPath() {
+  return path.join(getGlobalConfigDir(), 'settings.json');
+}
+
+/**
+ * Returns the global auth.json path.
+ * @returns {string}
+ */
+function getGlobalAuthPath() {
+  return path.join(getGlobalConfigDir(), 'auth.json');
+}
+
+/**
+ * Returns the global SQLite database path.
+ * @returns {string}
+ */
+function getDbPath() {
+  return path.join(getGlobalConfigDir(), 'data.db');
+}
+
+/**
+ * Returns the global backups directory.
+ * @returns {string}
+ */
+function getBackupsDir() {
+  return path.join(getGlobalConfigDir(), 'backups');
+}
+
+module.exports = {
+  getProjectConfigDir,
+  getProjectAgentsDir,
+  getAgentDir,
+  getProjectSettingsPath,
+  getProjectSettingsLocalPath,
+  getProjectAuthPath,
+  getProjectAgentMdPath,
+  getProjectMemoryDir,
+  getAgentMemoryDir,
+  getHeartbeatsDir,
+  getProjectToolsDir,
+  getProjectSkillsDir,
+  getPidFilePath,
+  getGlobalConfigDir,
+  getGlobalAgentsDir,
+  getGlobalToolsDir,
+  getGlobalSettingsPath,
+  getGlobalAuthPath,
+  getDbPath,
+};

package/utils/settings.js

@@ -0,0 +1,172 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const paths = require('./paths');
+const F = require('../settings/fields');
+
+/**
+ * Deep merge: target is mutated with source values (source wins).
+ * @param {Object} target
+ * @param {Object} source
+ * @returns {Object}
+ */
+function deepMerge(target, source) {
+  for (const key of Object.keys(source)) {
+    if (source[key] !== null && typeof source[key] === 'object' && !Array.isArray(source[key])) {
+      if (!target[key] || typeof target[key] !== 'object') target[key] = {};
+      deepMerge(target[key], source[key]);
+    } else {
+      target[key] = source[key];
+    }
+  }
+  return target;
+}
+
+/**
+ * Safely read + parse a JSON file. Returns null if file doesn't exist.
+ * @param {string} filePath
+ * @returns {Object|null}
+ */
+function readJsonFile(filePath) {
+  try {
+    const raw = fs.readFileSync(filePath, 'utf8');
+    return JSON.parse(raw);
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Build default settings object.
+ * @returns {Object}
+ */
+function getDefaults() {
+  return {
+    port: F.DEFAULT_PORT,
+    secret: null,
+    models: {
+      main: { [F.MODEL_BASE_URL]: 'https://openrouter.ai/api/v1', [F.MODEL_API_KEY]: '', [F.MODEL_NAME]: '' },
+      compact: null,
+      title: null,
+    },
+    permissions: {
+      [F.PERMISSIONS_ALLOW]: [],
+      [F.PERMISSIONS_DENY]: [],
+      [F.PERMISSIONS_ASK]: [],
+    },
+    hooks: {
+      [F.HOOKS_PRE_TOOL_USE]: null,
+      [F.HOOKS_POST_TOOL_USE]: null,
+    },
+    compaction: {
+      [F.COMPACTION_THRESHOLD]: F.DEFAULT_COMPACTION_THRESHOLD,
+      [F.COMPACTION_OBSERVATION_MASKING_TURNS]: F.DEFAULT_OBSERVATION_MASKING_TURNS,
+    },
+    memory: {
+      enabled: true,
+      maxLines: F.DEFAULT_MEMORY_MAX_LINES,
+    },
+    storage: {
+      retention: {
+        sessions: { maxAgeDays: 90, maxCount: 10000 },
+        tasks: { maxAgeDays: 30, maxCount: 5000 },
+      },
+    },
+    maxIterations: F.DEFAULT_MAX_ITERATIONS,
+    maxDurationSeconds: F.DEFAULT_MAX_DURATION_SECONDS,
+    maxConcurrentTasks: F.DEFAULT_MAX_CONCURRENT_TASKS,
+    maxSubAgentDepth: F.DEFAULT_MAX_SUBAGENT_DEPTH,
+    mcpServers: {},
+    ably: { enabled: false, key: null },
+  };
+}
+
+/**
+ * Load and merge settings from all layers:
+ * defaults → ~/.veil/settings.json → .veil/settings.json → .veil/settings.local.json → cliOverrides
+ *
+ * @param {string} cwd - Project root directory
+ * @param {Object} [cliOverrides={}] - CLI flag overrides
+ * @returns {Object} Merged settings
+ */
+function loadSettings({ cwd, cliOverrides = {} }) {
+  const result = getDefaults();
+
+  const globalSettings = readJsonFile(paths.getGlobalSettingsPath());
+  if (globalSettings) deepMerge(result, globalSettings);
+
+  const globalAuth = readJsonFile(paths.getGlobalAuthPath());
+  if (globalAuth) {
+    if (globalAuth.models) deepMerge(result.models, globalAuth.models);
+  }
+
+  const projectSettings = readJsonFile(paths.getProjectSettingsPath(cwd));
+  if (projectSettings) deepMerge(result, projectSettings);
+
+  const projectAuth = readJsonFile(paths.getProjectAuthPath(cwd));
+  if (projectAuth) {
+    if (projectAuth.models) deepMerge(result.models, projectAuth.models);
+  }
+
+  const localSettings = readJsonFile(paths.getProjectSettingsLocalPath(cwd));
+  if (localSettings) deepMerge(result, localSettings);
+
+  if (cliOverrides && Object.keys(cliOverrides).length > 0) {
+    deepMerge(result, cliOverrides);
+  }
+
+  return result;
+}
+
+/**
+ * Get the model config for a given role. Falls back to 'main' if role not configured.
+ * @param {Object} settings
+ * @param {'main'|'compact'|'title'} role
+ * @returns {{ base_url: string, api_key: string, model: string }}
+ */
+function getModelConfig(settings, role = F.MODEL_MAIN) {
+  const roleConfig = settings.models && settings.models[role];
+  if (roleConfig && roleConfig[F.MODEL_NAME]) return roleConfig;
+  return settings.models[F.MODEL_MAIN];
+}
+
+const VALID_LEVELS = ['merged', 'project', 'global', 'local'];
+
+/**
+ * Resolve the settings file path for a given level.
+ * @param {'project'|'global'|'local'} level
+ * @param {string} cwd
+ * @returns {string}
+ */
+function settingsPathForLevel(level, cwd) {
+  if (level === 'global') return paths.getGlobalSettingsPath();
+  if (level === 'local') return paths.getProjectSettingsLocalPath(cwd);
+  return paths.getProjectSettingsPath(cwd);
+}
+
+/**
+ * Read raw settings for a single level without merging.
+ * - 'merged'  → full merged loadSettings result
+ * - 'project' → .veil/settings.json (raw, or {} if absent)
+ * - 'global'  → ~/.veil/settings.json (raw, or {} if absent)
+ * - 'local'   → .veil/settings.local.json (raw, or {} if absent)
+ *
+ * @param {{ cwd: string, level?: string }} opts
+ * @returns {{ settings: Object, exists: boolean, path: string|null }}
+ */
+function readSettingsForLevel({ cwd, level = 'merged' }) {
+  if (!VALID_LEVELS.includes(level)) {
+    throw Object.assign(new Error(`Invalid level "${level}". Must be one of: ${VALID_LEVELS.join(', ')}`), { code: 'INVALID_LEVEL' });
+  }
+
+  if (level === 'merged') {
+    return { settings: loadSettings({ cwd }), exists: true, path: null };
+  }
+
+  const filePath = settingsPathForLevel(level, cwd);
+  const raw = readJsonFile(filePath);
+  return { settings: raw || {}, exists: raw !== null, path: filePath };
+}
+
+module.exports = { loadSettings, getModelConfig, readSettingsForLevel, settingsPathForLevel, VALID_LEVELS };