@arcadialdev/arcality 2.4.23 → 2.4.25

package/src/configManager.mjs

@@ -1,172 +1,172 @@
-// src/configManager.mjs
-// Manages the local arcality.config file — single configuration per project.
-// Replaces multi-config .env approach.
-
-import fs from 'node:fs';
-import path from 'node:path';
-
-const CONFIG_FILENAME = 'arcality.config';
-
-/**
- * Resolves the path to arcality.config in the project root.
- * @param {string} [projectRoot] - Override project root. Defaults to cwd.
- * @returns {string}
- */
-export function getConfigPath(projectRoot) {
-    return path.join(projectRoot || process.cwd(), CONFIG_FILENAME);
-}
-
-/**
- * Checks if arcality.config exists in the project.
- * @param {string} [projectRoot]
- * @returns {boolean}
- */
-export function configExists(projectRoot) {
-    return fs.existsSync(getConfigPath(projectRoot));
-}
-
-/**
- * Reads and parses the arcality.config file.
- * @param {string} [projectRoot]
- * @returns {ArcalityConfig | null}
- */
-export function loadProjectConfig(projectRoot) {
-    const configPath = getConfigPath(projectRoot);
-    try {
-        if (!fs.existsSync(configPath)) return null;
-        let raw = fs.readFileSync(configPath, 'utf8');
-        // Strip BOM if present
-        if (raw.charCodeAt(0) === 0xFEFF) raw = raw.slice(1);
-        return JSON.parse(raw);
-    } catch (err) {
-        console.error(`⚠️  Error reading ${CONFIG_FILENAME}: ${err.message}`);
-        return null;
-    }
-}
-
-/**
- * Writes the arcality.config file.
- * @param {ArcalityConfig} config
- * @param {string} [projectRoot]
- */
-export function saveProjectConfig(config, projectRoot) {
-    const configPath = getConfigPath(projectRoot);
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf8');
-}
-
-/**
- * Validates that the config has all required fields for running.
- * @param {ArcalityConfig} config
- * @returns {{ valid: boolean, missing: string[] }}
- */
-export function validateConfig(config) {
-    const missing = [];
-
-    if (!config) {
-        return { valid: false, missing: ['arcality.config file'] };
-    }
-
-    if (!config.apiKey) missing.push('apiKey');
-    if (!config.projectId) missing.push('projectId');
-    if (!config.project?.baseUrl) missing.push('project.baseUrl');
-    if (!config.auth?.username) missing.push('auth.username');
-    if (!config.auth?.password) missing.push('auth.password');
-
-    return { valid: missing.length === 0, missing };
-}
-
-/**
- * Creates a fresh arcality.config structure.
- * @param {object} params
- * @returns {ArcalityConfig}
- */
-export function createConfig({
-    apiKey,
-    organizationId,
-    projectId,
-    projectName,
-    baseUrl,
-    frameworkDetected,
-    username,
-    password,
-    arcalityVersion,
-    yamlOutputDir = './arcality',
-}) {
-    return {
-        version: '1',
-        apiKey,
-        organizationId: organizationId || null,
-        projectId,
-        project: {
-            name: projectName,
-            baseUrl,
-            frameworkDetected: frameworkDetected || null,
-        },
-        auth: {
-            username,
-            password,
-        },
-        runtime: {
-            yamlOutputDir,
-            reuseSuccessfulYamls: true,
-            singleConfigurationMode: true,
-        },
-        meta: {
-            arcalityVersion: arcalityVersion || 'unknown',
-        },
-    };
-}
-
-/**
- * Injects arcality.config values into process.env for backward compat
- * with existing modules that read from process.env.
- * @param {ArcalityConfig} config
- */
-export function injectConfigToEnv(config) {
-    if (!config) return;
-
-    if (config.apiKey) process.env.ARCALITY_API_KEY = config.apiKey;
-    if (config.projectId) process.env.ARCALITY_PROJECT_ID = config.projectId;
-    if (config.project?.baseUrl) {
-        process.env.BASE_URL = config.project.baseUrl;
-    }
-    if (config.auth?.username) process.env.LOGIN_USER = config.auth.username;
-    if (config.auth?.password) process.env.LOGIN_PASSWORD = config.auth.password;
-}
-
-/**
- * Gets the YAML output directory from config, falling back to default.
- * @param {ArcalityConfig} config
- * @param {string} [projectRoot]
- * @returns {string} absolute path
- */
-export function getYamlOutputDir(config, projectRoot) {
-    const dir = config?.runtime?.yamlOutputDir || './arcality';
-    return path.resolve(projectRoot || process.cwd(), dir);
-}
-
-/**
- * Ensures the YAML output directory exists.
- * @param {ArcalityConfig} config
- * @param {string} [projectRoot]
- * @returns {string} absolute path to the directory
- */
-export function ensureYamlOutputDir(config, projectRoot) {
-    const dir = getYamlOutputDir(config, projectRoot);
-    if (!fs.existsSync(dir)) {
-        fs.mkdirSync(dir, { recursive: true });
-    }
-    return dir;
-}
-
-/**
- * @typedef {object} ArcalityConfig
- * @property {string} version
- * @property {string} apiKey
- * @property {string|null} organizationId
- * @property {string} projectId
- * @property {{ name: string, baseUrl: string, frameworkDetected: string|null }} project
- * @property {{ username: string, password: string }} auth
- * @property {{ yamlOutputDir: string, reuseSuccessfulYamls: boolean, singleConfigurationMode: boolean }} runtime
- * @property {{ arcalityVersion: string }} meta
- */
+// src/configManager.mjs
+// Manages the local arcality.config file — single configuration per project.
+// Replaces multi-config .env approach.
+
+import fs from 'node:fs';
+import path from 'node:path';
+
+const CONFIG_FILENAME = 'arcality.config';
+
+/**
+ * Resolves the path to arcality.config in the project root.
+ * @param {string} [projectRoot] - Override project root. Defaults to cwd.
+ * @returns {string}
+ */
+export function getConfigPath(projectRoot) {
+    return path.join(projectRoot || process.cwd(), CONFIG_FILENAME);
+}
+
+/**
+ * Checks if arcality.config exists in the project.
+ * @param {string} [projectRoot]
+ * @returns {boolean}
+ */
+export function configExists(projectRoot) {
+    return fs.existsSync(getConfigPath(projectRoot));
+}
+
+/**
+ * Reads and parses the arcality.config file.
+ * @param {string} [projectRoot]
+ * @returns {ArcalityConfig | null}
+ */
+export function loadProjectConfig(projectRoot) {
+    const configPath = getConfigPath(projectRoot);
+    try {
+        if (!fs.existsSync(configPath)) return null;
+        let raw = fs.readFileSync(configPath, 'utf8');
+        // Strip BOM if present
+        if (raw.charCodeAt(0) === 0xFEFF) raw = raw.slice(1);
+        return JSON.parse(raw);
+    } catch (err) {
+        console.error(`⚠️  Error reading ${CONFIG_FILENAME}: ${err.message}`);
+        return null;
+    }
+}
+
+/**
+ * Writes the arcality.config file.
+ * @param {ArcalityConfig} config
+ * @param {string} [projectRoot]
+ */
+export function saveProjectConfig(config, projectRoot) {
+    const configPath = getConfigPath(projectRoot);
+    fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf8');
+}
+
+/**
+ * Validates that the config has all required fields for running.
+ * @param {ArcalityConfig} config
+ * @returns {{ valid: boolean, missing: string[] }}
+ */
+export function validateConfig(config) {
+    const missing = [];
+
+    if (!config) {
+        return { valid: false, missing: ['arcality.config file'] };
+    }
+
+    if (!config.apiKey) missing.push('apiKey');
+    if (!config.projectId) missing.push('projectId');
+    if (!config.project?.baseUrl) missing.push('project.baseUrl');
+    if (!config.auth?.username) missing.push('auth.username');
+    if (!config.auth?.password) missing.push('auth.password');
+
+    return { valid: missing.length === 0, missing };
+}
+
+/**
+ * Creates a fresh arcality.config structure.
+ * @param {object} params
+ * @returns {ArcalityConfig}
+ */
+export function createConfig({
+    apiKey,
+    organizationId,
+    projectId,
+    projectName,
+    baseUrl,
+    frameworkDetected,
+    username,
+    password,
+    arcalityVersion,
+    yamlOutputDir = './arcality',
+}) {
+    return {
+        version: '1',
+        apiKey,
+        organizationId: organizationId || null,
+        projectId,
+        project: {
+            name: projectName,
+            baseUrl,
+            frameworkDetected: frameworkDetected || null,
+        },
+        auth: {
+            username,
+            password,
+        },
+        runtime: {
+            yamlOutputDir,
+            reuseSuccessfulYamls: true,
+            singleConfigurationMode: true,
+        },
+        meta: {
+            arcalityVersion: arcalityVersion || 'unknown',
+        },
+    };
+}
+
+/**
+ * Injects arcality.config values into process.env for backward compat
+ * with existing modules that read from process.env.
+ * @param {ArcalityConfig} config
+ */
+export function injectConfigToEnv(config) {
+    if (!config) return;
+
+    if (config.apiKey) process.env.ARCALITY_API_KEY = config.apiKey;
+    if (config.projectId) process.env.ARCALITY_PROJECT_ID = config.projectId;
+    if (config.project?.baseUrl) {
+        process.env.BASE_URL = config.project.baseUrl;
+    }
+    if (config.auth?.username) process.env.LOGIN_USER = config.auth.username;
+    if (config.auth?.password) process.env.LOGIN_PASSWORD = config.auth.password;
+}
+
+/**
+ * Gets the YAML output directory from config, falling back to default.
+ * @param {ArcalityConfig} config
+ * @param {string} [projectRoot]
+ * @returns {string} absolute path
+ */
+export function getYamlOutputDir(config, projectRoot) {
+    const dir = config?.runtime?.yamlOutputDir || './arcality';
+    return path.resolve(projectRoot || process.cwd(), dir);
+}
+
+/**
+ * Ensures the YAML output directory exists.
+ * @param {ArcalityConfig} config
+ * @param {string} [projectRoot]
+ * @returns {string} absolute path to the directory
+ */
+export function ensureYamlOutputDir(config, projectRoot) {
+    const dir = getYamlOutputDir(config, projectRoot);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    return dir;
+}
+
+/**
+ * @typedef {object} ArcalityConfig
+ * @property {string} version
+ * @property {string} apiKey
+ * @property {string|null} organizationId
+ * @property {string} projectId
+ * @property {{ name: string, baseUrl: string, frameworkDetected: string|null }} project
+ * @property {{ username: string, password: string }} auth
+ * @property {{ yamlOutputDir: string, reuseSuccessfulYamls: boolean, singleConfigurationMode: boolean }} runtime
+ * @property {{ arcalityVersion: string }} meta
+ */