@substrio/cli 0.0.0-stage → 0.1.1

package/src/config.mjs

@@ -0,0 +1,569 @@
+/**
+ * Substrio CLI: Configuration loader with multi-profile support
+ * 
+ * Resolution order:
+ *   1. Environment variables (SUBSTRIO_URL, SUBSTRIO_TENANT, SUBSTRIO_MASTER_KEY)
+ *   2. substrio.toml in current directory (project config)
+ *   3. SUBSTRIO_PROFILE, else substrio.toml profile → [profiles.<name>]
+ *   4. the profiles file's default_profile → [profiles.<default>]
+ *   5. the profiles file's flat keys
+ *
+ * The profiles file is ~/.substrio/config.toml (SUBSTRIO_CONFIG_DIR moves the
+ * directory): the directory is 0700 and the file 0600, whatever the umask,
+ * and it is replaced atomically. A ~/.substriorc of an older CLI is moved there
+ * on first use.
+ */
+
+import {
+    chmodSync, closeSync, existsSync, fchmodSync, fsyncSync, mkdirSync, openSync, readFileSync, renameSync, rmSync,
+    writeFileSync,
+} from 'node:fs';
+import { randomBytes } from 'node:crypto';
+import { dirname, join } from 'node:path';
+import { homedir } from 'node:os';
+
+import { SETTINGS_TABLES } from './settings.mjs';
+
+// =============================================================================
+// Minimal TOML Parser (handles key=value, [sections], [a.b] dotted, [[arrays
+// of tables]], strings, bools, numbers, and arrays and inline tables of those,
+// which may span lines)
+// =============================================================================
+
+// One scalar: a quoted string (basic strings keep \" \\ \n \t escapes), a
+// bool or an integer; anything else is kept as its text.
+function parseScalar(text) {
+    const value = text.trim();
+    if (value.length >= 2 && value.startsWith('"') && value.endsWith('"')) {
+        return value.slice(1, -1).replace(/\\(["\\nt])/g, (_, c) =>
+            c === 'n' ? '\n' : c === 't' ? '\t' : c);
+    }
+    if (value.length >= 2 && value.startsWith("'") && value.endsWith("'")) {
+        return value.slice(1, -1);
+    }
+    if (value === 'true') return true;
+    if (value === 'false') return false;
+    if (/^-?\d+$/.test(value)) return parseInt(value, 10);
+    return value;
+}
+
+// Skips whitespace, line breaks and # comments from text[i].
+function skipBlank(text, i) {
+    while (i < text.length) {
+        const ch = text[i];
+        if (ch === '#') { while (i < text.length && text[i] !== '\n') i++; }
+        else if (ch === ' ' || ch === '\t' || ch === '\r' || ch === '\n') i++;
+        else break;
+    }
+    return i;
+}
+
+// The index just past the string that opens at text[i].
+function stringEnd(text, i) {
+    const quote = text[i];
+    for (let j = i + 1; j < text.length; j++) {
+        if (text[j] === '\\' && quote === '"') j++;
+        else if (text[j] === quote) return j + 1;
+    }
+    throw new Error(`unclosed string: ${text.slice(i, i + 40)}`);
+}
+
+// One value at text[i]: a string, an array, an inline table or a bare scalar
+// (which ends at a comma, a closing bracket or brace, a comment or a line
+// break). Returns [value, the index after it].
+function parseValue(text, i) {
+    i = skipBlank(text, i);
+    const ch = text[i];
+    if (ch === '"' || ch === "'") {
+        const end = stringEnd(text, i);
+        return [parseScalar(text.slice(i, end)), end];
+    }
+    if (ch === '[' || ch === '{') {
+        const close = ch === '[' ? ']' : '}';
+        const out = ch === '[' ? [] : {};
+        i = skipBlank(text, i + 1);
+        while (text[i] !== close) {
+            if (i >= text.length) throw new Error(`unclosed ${ch === '[' ? 'array' : 'inline table'}`);
+            if (ch === '[') {
+                const [value, next] = parseValue(text, i);
+                out.push(value);
+                i = next;
+            } else {
+                const eq = text.indexOf('=', i);
+                if (eq < 0) throw new Error(`inline table entry without "=": ${text.slice(i, i + 40)}`);
+                const key = parseScalar(text.slice(i, eq));
+                const [value, next] = parseValue(text, eq + 1);
+                out[key] = value;
+                i = next;
+            }
+            i = skipBlank(text, i);
+            if (text[i] === ',') i = skipBlank(text, i + 1);
+            else if (text[i] !== close) throw new Error(`expected "," or "${close}" at: ${text.slice(i, i + 40)}`);
+        }
+        return [out, i + 1];
+    }
+    let end = i;
+    while (end < text.length && !',]}#\n'.includes(text[end])) end++;
+    return [parseScalar(text.slice(i, end)), end];
+}
+
+// Whether an array or inline table value is still open at the end of text:
+// brackets and braces outside strings and comments are counted.
+function valueOpen(text) {
+    let depth = 0;
+    let quote = null;
+    for (let i = 0; i < text.length; i++) {
+        const ch = text[i];
+        if (quote) {
+            if (ch === '\\' && quote === '"') i++;
+            else if (ch === quote) quote = null;
+        } else if (ch === '"' || ch === "'") quote = ch;
+        else if (ch === '#') { while (i < text.length && text[i] !== '\n') i++; }
+        else if (ch === '[' || ch === '{') depth++;
+        else if ((ch === ']' || ch === '}') && --depth === 0) return false;
+    }
+    return depth > 0;
+}
+
+// The table a dotted header names, made as needed. A name that holds an array
+// of tables stands for its last table, as in TOML.
+function tableAt(root, parts) {
+    let obj = root;
+    for (const part of parts) {
+        if (Array.isArray(obj[part])) obj = obj[part][obj[part].length - 1];
+        else obj = obj[part] = obj[part] || {};
+    }
+    return obj;
+}
+
+export function parseTOML(content) {
+    const result = {};
+    let current = result;
+    const lines = content.split('\n');
+
+    for (let n = 0; n < lines.length; n++) {
+        const line = lines[n].trim();
+        if (!line || line.startsWith('#')) continue;
+
+        // Array of tables: [[cron]] or [[build.steps]] appends a new table.
+        const arrayMatch = line.match(/^\[\[([^\]]+)\]\]$/);
+        if (arrayMatch) {
+            const parts = arrayMatch[1].trim().split('.').map((p) => p.trim());
+            const parent = tableAt(result, parts.slice(0, -1));
+            const last = parts[parts.length - 1];
+            if (parent[last] === undefined) parent[last] = [];
+            if (!Array.isArray(parent[last])) throw new Error(`[[${arrayMatch[1]}]] names a table that is not an array`);
+            current = {};
+            parent[last].push(current);
+            continue;
+        }
+
+        // Section header: [section] or [section.subsection]
+        const sectionMatch = line.match(/^\[([^\]]+)\]$/);
+        if (sectionMatch) {
+            current = tableAt(result, sectionMatch[1].trim().split('.').map((p) => p.trim()));
+            continue;
+        }
+
+        // Key = value
+        const kvMatch = line.match(/^([^=]+?)\s*=\s*(.+)$/);
+        if (kvMatch) {
+            const key = kvMatch[1].trim();
+            let value = kvMatch[2].trim();
+
+            if (value.startsWith('[') || value.startsWith('{')) {
+                let text = value;
+                while (valueOpen(text) && n + 1 < lines.length) text += '\n' + lines[++n];
+                if (valueOpen(text)) {
+                    throw new Error(`unclosed ${value.startsWith('[') ? 'array' : 'inline table'} for "${key}"`);
+                }
+                value = parseValue(text, 0)[0];
+            } else if (value.startsWith('"') || value.startsWith("'")) {
+                // A quoted string; a comment after it is dropped.
+                value = parseValue(value, 0)[0];
+            } else {
+                value = parseScalar(value);
+            }
+
+            current[key] = value;
+        }
+    }
+
+    return result;
+}
+
+// =============================================================================
+// TOML Writer (simple key=value with sections)
+// =============================================================================
+
+function toTOML(obj, prefix = '') {
+    const lines = [];
+    const sections = [];
+
+    for (const [key, val] of Object.entries(obj)) {
+        if (val && typeof val === 'object' && !Array.isArray(val)) {
+            sections.push([key, val]);
+        } else {
+            const quoted = typeof val === 'string' ? `"${val}"` : String(val);
+            lines.push(`${key} = ${quoted}`);
+        }
+    }
+
+    for (const [key, val] of sections) {
+        const sectionKey = prefix ? `${prefix}.${key}` : key;
+        lines.push('');
+        lines.push(`[${sectionKey}]`);
+        for (const [k, v] of Object.entries(val)) {
+            if (v && typeof v === 'object' && !Array.isArray(v)) {
+                // Nested section (e.g., profiles.local)
+                const nestedKey = `${sectionKey}.${k}`;
+                lines.push('');
+                lines.push(`[${nestedKey}]`);
+                for (const [nk, nv] of Object.entries(v)) {
+                    const q = typeof nv === 'string' ? `"${nv}"` : String(nv);
+                    lines.push(`${nk} = ${q}`);
+                }
+            } else {
+                const q = typeof v === 'string' ? `"${v}"` : String(v);
+                lines.push(`${k} = ${q}`);
+            }
+        }
+    }
+
+    return lines.join('\n') + '\n';
+}
+
+// =============================================================================
+// RC File Helpers
+// =============================================================================
+
+/** The directory that holds the profiles file (SUBSTRIO_CONFIG_DIR, else ~/.substrio). */
+export function configDir() {
+    return process.env.SUBSTRIO_CONFIG_DIR || join(homedir(), '.substrio');
+}
+
+/** The profiles file: saved URLs, keys and tenants. */
+export function rcPath() {
+    return join(configDir(), 'config.toml');
+}
+
+/** The directory in a project root where substrio keeps what is local to this checkout (never committed). */
+export const PROJECT_STATE_DIR = '.substrio';
+
+/** Where the loader looks for a project's functions and static files when substrio.toml names none. */
+export const DEFAULT_FUNCTIONS_DIR = 'functions';
+export const DEFAULT_PUBLIC_DIR = 'public';
+
+/** The data directory of `substrio dev` in the project at `root`: its database, its keys, its log. */
+export function devDataDir(root) {
+    return join(root, PROJECT_STATE_DIR, 'dev');
+}
+
+const LEGACY_RC = () => join(homedir(), '.substriorc');
+
+/**
+ * Writes `text` to `path` readable by its owner only (0600 whatever the
+ * umask). Replaces the file atomically (a temporary file renamed over it), or
+ * with `exclusive` creates it and refuses an existing one.
+ */
+export function writePrivateFile(path, text, { exclusive = false } = {}) {
+    const target = exclusive ? path : `${path}.${randomBytes(6).toString('hex')}.tmp`;
+    const fd = openSync(target, 'wx', 0o600);
+    try {
+        fchmodSync(fd, 0o600);
+        writeFileSync(fd, text);
+        fsyncSync(fd);
+    } catch (err) {
+        closeSync(fd);
+        rmSync(target, { force: true });
+        throw err;
+    }
+    closeSync(fd);
+    if (!exclusive) renameSync(target, path);
+}
+
+// The config directory, owner-only (0700); created when missing.
+function privateDir() {
+    const dir = configDir();
+    mkdirSync(dir, { recursive: true, mode: 0o700 });
+    chmodSync(dir, 0o700);
+    return dir;
+}
+
+export function loadRC() {
+    const path = rcPath();
+    if (!existsSync(path) && existsSync(LEGACY_RC())) {
+        privateDir();
+        renameSync(LEGACY_RC(), path);
+        chmodSync(path, 0o600);
+    }
+    if (!existsSync(path)) return {};
+    try {
+        return parseTOML(readFileSync(path, 'utf-8'));
+    } catch { return {}; }
+}
+
+// The file holds keys: readable by its owner only, in an owner-only directory.
+export function saveRC(rc) {
+    privateDir();
+    writePrivateFile(rcPath(), toTOML(rc));
+}
+
+// Saves profile `name`; it becomes the default when there is none, or with
+// `makeDefault` (substrio login).
+// `defaultIfNone` false leaves the default as it is even when there is none (the dev profile of `substrio dev`).
+export function writeProfile(name, url, masterKey, tenant = null, { makeDefault = false, defaultIfNone = true, checked = true } = {}) {
+    const rc = loadRC();
+    if (!rc.profiles) rc.profiles = {};
+    rc.profiles[name] = tenant ? { url, master_key: masterKey, tenant } : { url, master_key: masterKey };
+    // A profile saved with no round trip (login --offline) says so; any later
+    // save that did reach the server writes it without the mark.
+    if (!checked) rc.profiles[name].checked = false;
+    if (makeDefault || (defaultIfNone && !rc.default_profile)) rc.default_profile = name;
+    saveRC(rc);
+}
+
+// Replaces the key of a saved profile (after `substrio key rotate`), keeping its
+// URL. Returns false when there is no such profile.
+/** The tenant a `substrio dev` without a tenant in substrio.toml uses. */
+export const DEFAULT_DEV_TENANT = 'dev';
+/** The end of the name of the profile `substrio dev` saves for its project's tenant. */
+export const DEV_PROFILE_SUFFIX = '-dev';
+
+/** The app's tenant under `substrio dev` (pure): the config's own tenant, else DEFAULT_DEV_TENANT. */
+export const devTenantSlug = (config) => (config.tenant && config.tenant !== 'default' ? config.tenant : DEFAULT_DEV_TENANT);
+
+/** The name of the dev profile of tenant `slug` (pure). */
+export const devProfileName = (slug) => `${slug}${DEV_PROFILE_SUFFIX}`;
+
+/**
+ * Saves (or updates, at each start: the port is new) the profile of the dev server of tenant `slug`: its
+ * URL and the tenant's dev key. It is never made the default. Returns the profile's name.
+ */
+export function saveDevProfile(slug, url, key) {
+    const name = devProfileName(slug);
+    writeProfile(name, url, key, slug, { defaultIfNone: false });
+    return name;
+}
+
+/**
+ * What `substrio --dev` selects (the connection variables, as loadConfig reads them) for the project at `cwd`:
+ * the saved dev profile of its tenant, {SUBSTRIO_PROFILE, SUBSTRIO_URL, SUBSTRIO_TENANT, SUBSTRIO_MASTER_KEY}. Throws an Error
+ * naming the profile when `substrio dev` has not saved it yet.
+ */
+export function devConnection(cwd) {
+    const slug = devTenantSlug(loadConfig(cwd));
+    const name = devProfileName(slug);
+    const profile = readProfile(name);
+    if (profile === null || !profile.url || !profile.master_key) {
+        throw new Error(`there is no dev profile "${name}": run "substrio dev" in this project first (it saves one)`);
+    }
+    return { SUBSTRIO_PROFILE: name, SUBSTRIO_URL: profile.url, SUBSTRIO_TENANT: slug, SUBSTRIO_MASTER_KEY: profile.master_key };
+}
+
+export function setProfileKey(name, masterKey) {
+    const rc = loadRC();
+    if (!rc.profiles?.[name]) return false;
+    rc.profiles[name].master_key = masterKey;
+    saveRC(rc);
+    return true;
+}
+
+// One saved profile, {url, master_key} with the URL's trailing slash dropped,
+// or null when there is no such profile.
+export function readProfile(name) {
+    const profile = loadRC().profiles?.[name];
+    if (!profile) return null;
+    return { url: (profile.url || '').replace(/\/+$/, ''), master_key: profile.master_key || '' };
+}
+
+export function removeProfile(name) {
+    const rc = loadRC();
+    if (rc.profiles && rc.profiles[name]) {
+        delete rc.profiles[name];
+        if (rc.default_profile === name) {
+            const remaining = Object.keys(rc.profiles || {});
+            rc.default_profile = remaining[0] || '';
+        }
+        saveRC(rc);
+        return true;
+    }
+    return false;
+}
+
+export function listProfiles() {
+    const rc = loadRC();
+    const profiles = rc.profiles || {};
+    const defaultName = rc.default_profile || '';
+    return Object.entries(profiles).map(([name, cfg]) => ({
+        name,
+        url: cfg.url || '',
+        isDefault: name === defaultName,
+    }));
+}
+
+// =============================================================================
+// Config Loader
+// =============================================================================
+
+export function loadConfig(cwd = process.cwd()) {
+    const config = {
+        url: null,
+        tenant: 'default',
+        // true when a profile, substrio.toml, SUBSTRIO_TENANT or --tenant named
+        // the tenant; false for the 'default' fallback, which a command over
+        // the account's apps (substrio tenants) leaves off the wire.
+        tenant_named: false,
+        master_key: null,
+        functions_dir: DEFAULT_FUNCTIONS_DIR,
+        public_dir: DEFAULT_PUBLIC_DIR,
+        profile: null,
+        // [functions.<name>] tables: routes, main, [functions.<name>.vars]
+        functions: {},
+        // JSON file of the tenant's security rules, applied by `substrio deploy`
+        rules_file: null,
+        // Directory of the collections the app declares, one JSON file each (src/collections.mjs)
+        collections_dir: null,
+        // JSON file of the tenant's MCP tools (docs/mcp.md), set by `substrio deploy`
+        mcp_file: null,
+        // JSON file of the tenant's plans, counters and feature flags, set by `substrio deploy`
+        plans_file: null,
+        // [apps.offer] and [apps.use]: the functions the app offers other apps and the ones it calls, set by
+        // `substrio deploy` (apps.calls.set; substrio.apps.<app>.<entry>(...) in a function); [apps.query.<name>]
+        // and [apps.use_query]: the reads it offers and the ones it makes (substrio.apps.<app>.query.<name>(...))
+        apps: null,
+        // What `substrio push` builds and ships (src/manifest.mjs reads these):
+        // [build] steps, [site] parts and ignore, [[cron]], [[triggers]] and [queues.<name>].
+        build: null,
+        site: null,
+        cron: [],
+        triggers: [],
+        // [queues.<name>] tables: the durable queues the version declares (src/manifest.mjs)
+        queues: null,
+        // [roles.NAME] tables: the roles `substrio deploy` and `substrio dev` apply (src/identity.mjs)
+        roles: null,
+        // [permissions] table: the tenant's permission catalog `substrio deploy` sets (src/manifest.mjs's declaredPermissions)
+        permissions: null,
+        // [ledger] table: the tenant's ledger catalog `substrio deploy` declares (src/manifest.mjs's declaredLedger)
+        ledger: null,
+        // Settings tables a pushed version carries, such as [auth] (src/settings.mjs)
+        ...Object.fromEntries(SETTINGS_TABLES.map(({ table }) => [table, null])),
+    };
+
+    const rc = loadRC();
+
+    // 1. Load substrio.toml (project config)
+    let toml = {};
+    const tomlPath = join(cwd, 'substrio.toml');
+    if (existsSync(tomlPath)) {
+        try {
+            toml = parseTOML(readFileSync(tomlPath, 'utf-8'));
+        } catch (err) {
+            console.error(`⚠ Error reading substrio.toml: ${err.message}`);
+        }
+    }
+    const flat = toml.project ? { ...toml, ...toml.project } : toml;
+
+    // 2. Resolve profile: SUBSTRIO_PROFILE, then substrio.toml, then the profiles file's default
+    const profileName = process.env.SUBSTRIO_PROFILE || flat.profile || rc.default_profile || null;
+    let profileCfg = null;
+    if (profileName && rc.profiles && rc.profiles[profileName]) {
+        profileCfg = rc.profiles[profileName];
+        config.profile = profileName;
+    }
+
+    // 3. Apply layers: profile < substrio.toml < env vars (backward compat: flat rc)
+    // Layer 0: the profiles file's flat keys
+    if (rc.url) config.url = rc.url;
+    if (rc.master_key) config.master_key = rc.master_key;
+
+    // Layer 1: profile values
+    if (profileCfg) {
+        if (profileCfg.url) config.url = profileCfg.url;
+        if (profileCfg.master_key) config.master_key = profileCfg.master_key;
+        if (profileCfg.tenant) config.tenant = profileCfg.tenant;
+    }
+
+    // Layer 2: substrio.toml direct values
+    if (flat.url) config.url = flat.url;
+    if (flat.tenant) config.tenant = flat.tenant;
+    if (flat.master_key) config.master_key = flat.master_key;
+    if (flat.functions_dir) config.functions_dir = flat.functions_dir;
+    if (flat.public_dir) config.public_dir = flat.public_dir;
+    if (flat.functions && typeof flat.functions === 'object') config.functions = flat.functions;
+    if (flat.rules_file) config.rules_file = flat.rules_file;
+    if (flat.collections_dir) config.collections_dir = flat.collections_dir;
+    if (flat.mcp_file) config.mcp_file = flat.mcp_file;
+    if (flat.plans_file) config.plans_file = flat.plans_file;
+    if (flat.apps !== undefined) config.apps = flat.apps;
+    if (flat.site_ignore !== undefined) config.site_ignore = flat.site_ignore;
+    if (flat.build !== undefined) config.build = flat.build;
+    if (flat.site !== undefined) config.site = flat.site;
+    if (flat.cron !== undefined) config.cron = flat.cron;
+    if (flat.triggers !== undefined) config.triggers = flat.triggers;
+    if (flat.queues !== undefined) config.queues = flat.queues;
+    if (flat.roles !== undefined) config.roles = flat.roles;
+    if (flat.permissions !== undefined) config.permissions = flat.permissions;
+    if (flat.ledger !== undefined) config.ledger = flat.ledger;
+    for (const { table } of SETTINGS_TABLES) if (flat[table] !== undefined) config[table] = flat[table];
+
+    // Layer 3: environment variables override everything
+    if (process.env.SUBSTRIO_URL) config.url = process.env.SUBSTRIO_URL;
+    if (process.env.SUBSTRIO_TENANT) config.tenant = process.env.SUBSTRIO_TENANT;
+    config.tenant_named = Boolean(profileCfg?.tenant || flat.tenant || process.env.SUBSTRIO_TENANT);
+    if (process.env.SUBSTRIO_MASTER_KEY) config.master_key = process.env.SUBSTRIO_MASTER_KEY;
+    if (process.env.SUBSTRIO_FUNCTIONS_DIR) config.functions_dir = process.env.SUBSTRIO_FUNCTIONS_DIR;
+    if (process.env.SUBSTRIO_PUBLIC_DIR) config.public_dir = process.env.SUBSTRIO_PUBLIC_DIR;
+
+    // Normalize URL (strip trailing slash)
+    if (config.url) config.url = config.url.replace(/\/+$/, '');
+
+    return config;
+}
+
+/**
+ * Validate that required config fields are present.
+ * Returns null if valid, or an error message string.
+ */
+export function validateConfig(config, requireAuth = true) {
+    if (!config.url) {
+        return 'Server URL not configured. Run "substrio login" or set url in substrio.toml / SUBSTRIO_URL env var.';
+    }
+    if (requireAuth && !config.master_key) {
+        return 'Master key not configured. Run "substrio login" or set master_key in substrio.toml / SUBSTRIO_MASTER_KEY env var.';
+    }
+    return null;
+}
+
+/**
+ * Returns a human-readable summary of resolved config sources.
+ */
+export function getConfigSources(cwd = process.cwd()) {
+    const sources = {};
+    const rc = loadRC();
+    const tomlPath = join(cwd, 'substrio.toml');
+    const hasToml = existsSync(tomlPath);
+    let toml = {};
+    if (hasToml) {
+        try { toml = parseTOML(readFileSync(tomlPath, 'utf-8')); } catch { /* an unreadable substrio.toml adds nothing to the summary */ }
+    }
+    const flat = toml.project ? { ...toml, ...toml.project } : toml;
+    const profileName = process.env.SUBSTRIO_PROFILE || flat.profile || rc.default_profile || null;
+
+    // Determine source for each key
+    for (const key of ['url', 'tenant', 'master_key']) {
+        const envKey = `SUBSTRIO_${key.toUpperCase()}`;
+        if (process.env[envKey]) {
+            sources[key] = `env ${envKey}`;
+        } else if (flat[key]) {
+            sources[key] = 'substrio.toml';
+        } else if (profileName && rc.profiles?.[profileName]?.[key]) {
+            sources[key] = `profile "${profileName}"`;
+        } else if (rc[key]) {
+            sources[key] = rcPath();
+        } else {
+            sources[key] = 'default';
+        }
+    }
+    return sources;
+}