fraim-framework 2.0.36 → 2.0.38

package/dist/src/cli/commands/setup.js

@@ -0,0 +1,176 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupCommand = exports.runSetup = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const prompts_1 = __importDefault(require("prompts"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const token_validator_1 = require("../setup/token-validator");
+const auto_mcp_setup_1 = require("../setup/auto-mcp-setup");
+const script_sync_utils_1 = require("../../utils/script-sync-utils");
+const version_utils_1 = require("../../utils/version-utils");
+const promptForFraimKey = async () => {
+    console.log(chalk_1.default.blue('🔑 FRAIM Key Setup'));
+    console.log('FRAIM requires a valid API key to access workflows and features.\n');
+    let key = null;
+    let attempts = 0;
+    const maxAttempts = 3;
+    while (!key && attempts < maxAttempts) {
+        const keyResponse = await (0, prompts_1.default)({
+            type: 'password',
+            name: 'key',
+            message: attempts === 0
+                ? 'Enter your FRAIM key (required)'
+                : `Enter your FRAIM key (attempt ${attempts + 1}/${maxAttempts})`,
+            validate: (value) => {
+                if (!value)
+                    return 'FRAIM key is required';
+                if ((0, token_validator_1.isValidTokenFormat)(value, 'fraim'))
+                    return true;
+                return 'Please enter a valid FRAIM key (starts with fraim_)';
+            }
+        });
+        if (!keyResponse.key) {
+            console.log(chalk_1.default.red('\n❌ FRAIM key is required to proceed.'));
+            console.log(chalk_1.default.gray('If you need a key, please email sid.mathur@gmail.com to request one.\n'));
+            const retry = await (0, prompts_1.default)({
+                type: 'confirm',
+                name: 'retry',
+                message: 'Would you like to try entering the FRAIM key again?',
+                initial: true
+            });
+            if (!retry.retry) {
+                console.log(chalk_1.default.red('Setup cancelled. Please obtain a FRAIM key and try again.'));
+                process.exit(1);
+            }
+            attempts++;
+            continue;
+        }
+        // Validate key
+        const isValid = await (0, token_validator_1.validateFraimKey)(keyResponse.key);
+        if (isValid) {
+            console.log(chalk_1.default.green('✅ FRAIM key validated\n'));
+            return keyResponse.key;
+        }
+        else {
+            console.log(chalk_1.default.red('❌ Invalid FRAIM key\n'));
+            attempts++;
+        }
+    }
+    console.log(chalk_1.default.red('\n❌ Maximum attempts reached. Setup cancelled.'));
+    console.log(chalk_1.default.gray('Please ensure you have a valid FRAIM key and try again.'));
+    process.exit(1);
+};
+const saveGlobalConfig = (fraimKey) => {
+    const globalConfigDir = path_1.default.join(os_1.default.homedir(), '.fraim');
+    const globalConfigPath = path_1.default.join(globalConfigDir, 'config.json');
+    if (!fs_1.default.existsSync(globalConfigDir)) {
+        fs_1.default.mkdirSync(globalConfigDir, { recursive: true });
+    }
+    const config = {
+        version: (0, version_utils_1.getFraimVersion)(),
+        apiKey: fraimKey,
+        configuredAt: new Date().toISOString(),
+        userPreferences: {
+            autoSync: true,
+            backupConfigs: true
+        }
+    };
+    fs_1.default.writeFileSync(globalConfigPath, JSON.stringify(config, null, 2));
+    console.log(chalk_1.default.green('✅ Global FRAIM configuration saved'));
+};
+const syncGlobalScripts = () => {
+    console.log(chalk_1.default.blue('🔄 Syncing FRAIM scripts to user directory...'));
+    // Find registry path
+    let registryPath = path_1.default.join(__dirname, '../../../../registry');
+    if (!fs_1.default.existsSync(registryPath)) {
+        registryPath = path_1.default.join(__dirname, '../../../registry');
+    }
+    if (fs_1.default.existsSync(registryPath)) {
+        const syncResult = (0, script_sync_utils_1.syncScriptsToUserDirectory)(registryPath);
+        console.log(chalk_1.default.green(`✅ Synced ${syncResult.synced} scripts to user directory.`));
+        if (syncResult.ephemeral > 0) {
+            console.log(chalk_1.default.gray(`   ${syncResult.ephemeral} dependent scripts will use ephemeral execution.`));
+        }
+    }
+    else {
+        console.log(chalk_1.default.yellow('⚠️ Registry not found, skipping script sync.'));
+    }
+};
+const runSetup = async (options) => {
+    console.log(chalk_1.default.blue('🚀 Welcome to FRAIM! Let\'s get you set up.\n'));
+    // Show what we're about to do
+    console.log(chalk_1.default.yellow('📋 This setup will:'));
+    console.log(chalk_1.default.gray('   • Validate your FRAIM and GitHub tokens'));
+    console.log(chalk_1.default.gray('   • Create global FRAIM configuration'));
+    console.log(chalk_1.default.gray('   • Detect and configure supported IDEs'));
+    console.log(chalk_1.default.gray('   • Sync FRAIM scripts to your system'));
+    console.log(chalk_1.default.gray('   • Set up MCP servers for AI integration\n'));
+    // Get FRAIM key
+    let fraimKey = options.key;
+    if (!fraimKey) {
+        fraimKey = await promptForFraimKey();
+    }
+    else {
+        if (!(0, token_validator_1.isValidTokenFormat)(fraimKey, 'fraim')) {
+            console.log(chalk_1.default.red('❌ Invalid FRAIM key format. Key must start with fraim_'));
+            process.exit(1);
+        }
+        console.log(chalk_1.default.blue('🔑 Validating FRAIM key...'));
+        const isValid = await (0, token_validator_1.validateFraimKey)(fraimKey);
+        if (!isValid) {
+            console.log(chalk_1.default.red('❌ Invalid FRAIM key'));
+            process.exit(1);
+        }
+        console.log(chalk_1.default.green('✅ FRAIM key validated\n'));
+    }
+    // Get GitHub token
+    let githubToken = options.githubToken;
+    if (!githubToken) {
+        githubToken = await (0, auto_mcp_setup_1.promptForGitHubToken)();
+    }
+    else {
+        if (!(0, token_validator_1.isValidTokenFormat)(githubToken, 'github')) {
+            console.log(chalk_1.default.red('❌ Invalid GitHub token format. Token must start with ghp_ or github_pat_'));
+            process.exit(1);
+        }
+        console.log(chalk_1.default.blue('🔍 Validating GitHub token...'));
+        const isValid = await (0, token_validator_1.validateGitHubToken)(githubToken);
+        if (!isValid) {
+            console.log(chalk_1.default.red('❌ Invalid GitHub token'));
+            process.exit(1);
+        }
+        console.log(chalk_1.default.green('✅ GitHub token validated\n'));
+    }
+    // Save global configuration
+    console.log(chalk_1.default.blue('💾 Saving global configuration...'));
+    saveGlobalConfig(fraimKey);
+    // Sync global scripts
+    syncGlobalScripts();
+    // Configure IDEs
+    const selectedIDEs = options.ide ? options.ide.split(',') : undefined;
+    const autoAll = options.all;
+    if (autoAll && selectedIDEs) {
+        console.log(chalk_1.default.yellow('⚠️ Both --all and --ide specified. Using --ide selection.'));
+    }
+    await (0, auto_mcp_setup_1.autoConfigureMCP)(fraimKey, githubToken, selectedIDEs);
+    console.log(chalk_1.default.green('\n🎯 Setup complete! Next steps:'));
+    console.log(chalk_1.default.cyan('   1. Restart your configured IDEs'));
+    console.log(chalk_1.default.cyan('   2. Go to any project directory'));
+    console.log(chalk_1.default.cyan('   3. Run: fraim init-project'));
+    console.log(chalk_1.default.cyan('   4. Ask your AI agent: "list fraim workflows"'));
+    console.log(chalk_1.default.blue('\n💡 Use "fraim test-mcp" to verify your setup anytime.'));
+};
+exports.runSetup = runSetup;
+exports.setupCommand = new commander_1.Command('setup')
+    .description('Complete global FRAIM setup with IDE configuration')
+    .option('--key <key>', 'FRAIM API key')
+    .option('--github-token <token>', 'GitHub Personal Access Token')
+    .option('--all', 'Auto-configure all detected IDEs')
+    .option('--ide <ides>', 'Configure specific IDEs (comma-separated: claude,cursor,kiro)')
+    .action(exports.runSetup);

package/dist/src/cli/commands/sync.js

@@ -9,7 +9,6 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const digest_utils_1 = require("../../utils/digest-utils");
-const stub_generator_1 = require("../../utils/stub-generator");
 const config_loader_1 = require("../../fraim/config-loader");
 const version_utils_1 = require("../../utils/version-utils");
 const script_sync_utils_1 = require("../../utils/script-sync-utils");
@@ -20,20 +19,20 @@ const runSync = async (options) => {
     const workflowsRelativePath = config.customizations?.workflowsPath || '.fraim/workflows';
     const workflowsDir = path_1.default.resolve(projectRoot, workflowsRelativePath);
     const digestPath = path_1.default.join(fraimDir, '.digest');
-    // In a real npm package, registry would be in node_modules/@fraim/framework/registry
+    // In npm package, stubs are in node_modules/@fraim/framework/registry/stubs/workflows
     // We need to handle both "running from source" (src/cli/commands) and "running from dist" (dist/src/cli/commands)
     // Try 4 levels up (dist/src/cli/commands -> root)
-    let registryPath = path_1.default.join(__dirname, '../../../../registry');
+    let registryPath = path_1.default.join(__dirname, '../../../../registry/stubs');
     if (!fs_1.default.existsSync(registryPath)) {
         // Try 3 levels up (src/cli/commands -> root)
-        registryPath = path_1.default.join(__dirname, '../../../registry');
+        registryPath = path_1.default.join(__dirname, '../../../registry/stubs');
     }
     // Fallback for local development if running from within the framework repo itself
     if (!fs_1.default.existsSync(registryPath)) {
-        registryPath = path_1.default.join(projectRoot, 'registry');
+        registryPath = path_1.default.join(projectRoot, 'registry/stubs');
     }
     if (!fs_1.default.existsSync(registryPath)) {
-        console.error(chalk_1.default.red('❌ Registry not found. Ensure @fraim/framework is installed.'));
+        console.error(chalk_1.default.red('❌ Stub registry not found. Ensure @fraim/framework is installed and built.'));
         process.exit(1);
     }
     if (!fs_1.default.existsSync(workflowsDir)) {
@@ -64,10 +63,10 @@ const runSync = async (options) => {
     else {
         const registryWorkflowsPath = path_1.default.join(registryPath, 'workflows');
         if (!fs_1.default.existsSync(registryWorkflowsPath)) {
-            console.log(chalk_1.default.yellow('⚠️ No workflows found in registry.'));
+            console.log(chalk_1.default.yellow('⚠️ No workflow stubs found in registry.'));
         }
         else {
-            // Get all workflows from registry (recursive)
+            // Get all workflow stubs from registry (recursive)
             const getFiles = (dir) => {
                 const entries = fs_1.default.readdirSync(dir, { withFileTypes: true });
                 const files = entries
@@ -80,13 +79,12 @@ const runSync = async (options) => {
                 return files;
             };
             const registryFiles = getFiles(registryWorkflowsPath);
-            const generatedStubs = [];
+            const copiedStubs = [];
             for (const file of registryFiles) {
-                const content = fs_1.default.readFileSync(file, 'utf8');
-                const { intent, principles } = (0, stub_generator_1.parseRegistryWorkflow)(content);
+                // These are already stubs, just copy them directly
                 const fileName = path_1.default.basename(file);
                 const workflowName = fileName.replace('.md', '');
-                // Calculate relative path from registry/workflows to preserve structure
+                // Calculate relative path from registry/stubs/workflows to preserve structure
                 const relativePath = path_1.default.relative(registryWorkflowsPath, file);
                 const relativeDir = path_1.default.dirname(relativePath);
                 // Ensure target directory exists
@@ -94,10 +92,11 @@ const runSync = async (options) => {
                 if (!fs_1.default.existsSync(targetDir)) {
                     fs_1.default.mkdirSync(targetDir, { recursive: true });
                 }
-                const stubContent = (0, stub_generator_1.generateWorkflowStub)(workflowName, file, intent, principles);
+                // Copy stub file directly
+                const stubContent = fs_1.default.readFileSync(file, 'utf8');
                 const stubPath = path_1.default.join(targetDir, fileName);
                 fs_1.default.writeFileSync(stubPath, stubContent);
-                generatedStubs.push(relativePath); // Store relative path for cleanup tracking
+                copiedStubs.push(relativePath); // Store relative path for cleanup tracking
                 console.log(chalk_1.default.gray(`  + ${workflowName} (${relativeDir === '.' ? 'root' : relativeDir})`));
             }
             // Cleanup stubs that no longer exist in registry
@@ -119,8 +118,8 @@ const runSync = async (options) => {
             for (const stub of localStubs) {
                 // standardise path separators for comparison
                 const normalizedStub = stub.replace(/\\/g, '/');
-                const normalizedGenerated = generatedStubs.map(s => s.replace(/\\/g, '/'));
-                if (!normalizedGenerated.includes(normalizedStub)) {
+                const normalizedCopied = copiedStubs.map(s => s.replace(/\\/g, '/'));
+                if (!normalizedCopied.includes(normalizedStub)) {
                     fs_1.default.unlinkSync(path_1.default.join(workflowsDir, stub));
                     console.log(chalk_1.default.yellow(`  - ${stub} (removed from registry)`));
                     // Cleanup empty directories
@@ -134,13 +133,28 @@ const runSync = async (options) => {
                 }
             }
             fs_1.default.writeFileSync(digestPath, currentDigest);
-            console.log(chalk_1.default.green(`\n✅ Workflow sync complete. Generated ${generatedStubs.length} stubs.`));
+            console.log(chalk_1.default.green(`\n✅ Workflow sync complete. Copied ${copiedStubs.length} stubs.`));
         }
     }
     // Always sync scripts, regardless of workflow sync status
     console.log(chalk_1.default.blue('\n🔄 Syncing FRAIM scripts to user directory...'));
-    const syncResult = (0, script_sync_utils_1.syncScriptsToUserDirectory)(registryPath);
-    const cleanedScriptCount = (0, script_sync_utils_1.cleanupObsoleteUserScripts)(registryPath);
+    // Scripts are packaged separately from stubs, find the correct registry path
+    // Try 4 levels up (dist/src/cli/commands -> root)
+    let scriptsRegistryPath = path_1.default.join(__dirname, '../../../../registry');
+    if (!fs_1.default.existsSync(path_1.default.join(scriptsRegistryPath, 'scripts'))) {
+        // Try 3 levels up (src/cli/commands -> root)
+        scriptsRegistryPath = path_1.default.join(__dirname, '../../../registry');
+    }
+    // Fallback for local development if running from within the framework repo itself
+    if (!fs_1.default.existsSync(path_1.default.join(scriptsRegistryPath, 'scripts'))) {
+        scriptsRegistryPath = path_1.default.join(projectRoot, 'registry');
+    }
+    if (!fs_1.default.existsSync(path_1.default.join(scriptsRegistryPath, 'scripts'))) {
+        console.error(chalk_1.default.red('❌ Scripts registry not found. Ensure @fraim/framework is installed and built.'));
+        process.exit(1);
+    }
+    const syncResult = (0, script_sync_utils_1.syncScriptsToUserDirectory)(scriptsRegistryPath);
+    const cleanedScriptCount = (0, script_sync_utils_1.cleanupObsoleteUserScripts)(scriptsRegistryPath);
     if (syncResult.synced > 0 || cleanedScriptCount > 0) {
         console.log(chalk_1.default.green(`✅ Script sync complete. Updated ${syncResult.synced} scripts, removed ${cleanedScriptCount} obsolete scripts.`));
     }

package/dist/src/cli/commands/test-mcp.js

@@ -0,0 +1,135 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testMCPCommand = exports.runTestMCP = void 0;
+const commander_1 = require("commander");
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const ide_detector_1 = require("../setup/ide-detector");
+const testIDEConfig = async (ide) => {
+    const result = {
+        ide: ide.name,
+        configExists: false,
+        configValid: false,
+        mcpServers: [],
+        errors: []
+    };
+    const configPath = (0, ide_detector_1.expandPath)(ide.configPath);
+    if (!fs_1.default.existsSync(configPath)) {
+        result.errors.push('Config file does not exist');
+        return result;
+    }
+    result.configExists = true;
+    try {
+        if (ide.configFormat === 'json') {
+            const configContent = fs_1.default.readFileSync(configPath, 'utf8');
+            const config = JSON.parse(configContent);
+            if (config.mcpServers) {
+                result.configValid = true;
+                result.mcpServers = Object.keys(config.mcpServers);
+            }
+            else {
+                result.errors.push('No mcpServers section found');
+            }
+        }
+        else if (ide.configFormat === 'toml') {
+            const configContent = fs_1.default.readFileSync(configPath, 'utf8');
+            // Simple TOML parsing for MCP servers
+            const serverMatches = configContent.match(/\[mcp_servers\.(\w+)\]/g);
+            if (serverMatches) {
+                result.configValid = true;
+                result.mcpServers = serverMatches.map(match => match.replace(/\[mcp_servers\.(\w+)\]/, '$1'));
+            }
+            else {
+                result.errors.push('No mcp_servers sections found');
+            }
+        }
+    }
+    catch (error) {
+        result.errors.push(`Failed to parse config: ${error instanceof Error ? error.message : 'Unknown error'}`);
+    }
+    return result;
+};
+const checkGlobalSetup = () => {
+    const globalConfigPath = path_1.default.join(os_1.default.homedir(), '.fraim', 'config.json');
+    return fs_1.default.existsSync(globalConfigPath);
+};
+const runTestMCP = async () => {
+    console.log(chalk_1.default.blue('🔍 Testing MCP configuration...\n'));
+    // Check global setup
+    if (!checkGlobalSetup()) {
+        console.log(chalk_1.default.red('❌ Global FRAIM setup not found.'));
+        console.log(chalk_1.default.yellow('Please run: fraim setup --key=<your-fraim-key>'));
+        return;
+    }
+    console.log(chalk_1.default.green('✅ Global FRAIM setup found'));
+    // Detect IDEs
+    const detectedIDEs = (0, ide_detector_1.detectInstalledIDEs)();
+    if (detectedIDEs.length === 0) {
+        console.log(chalk_1.default.yellow('⚠️ No supported IDEs detected.'));
+        return;
+    }
+    console.log(chalk_1.default.blue(`\n🔍 Testing ${detectedIDEs.length} detected IDEs...\n`));
+    const results = await Promise.all(detectedIDEs.map(ide => testIDEConfig(ide)));
+    let totalConfigured = 0;
+    let totalWithFRAIM = 0;
+    for (const result of results) {
+        console.log(chalk_1.default.white(`📱 ${result.ide}`));
+        if (!result.configExists) {
+            console.log(chalk_1.default.red('   ❌ No MCP config found'));
+            console.log(chalk_1.default.gray(`   💡 Run: fraim setup --ide=${result.ide.toLowerCase()}`));
+        }
+        else if (!result.configValid) {
+            console.log(chalk_1.default.yellow('   ⚠️ Config exists but invalid'));
+            result.errors.forEach(error => {
+                console.log(chalk_1.default.red(`   ❌ ${error}`));
+            });
+        }
+        else {
+            totalConfigured++;
+            console.log(chalk_1.default.green(`   ✅ MCP config valid (${result.mcpServers.length} servers)`));
+            // Check for essential servers
+            const essentialServers = ['fraim', 'git', 'github', 'playwright'];
+            const hasEssential = essentialServers.filter(server => result.mcpServers.includes(server));
+            if (hasEssential.includes('fraim')) {
+                totalWithFRAIM++;
+                console.log(chalk_1.default.green('   ✅ FRAIM server configured'));
+            }
+            else {
+                console.log(chalk_1.default.yellow('   ⚠️ FRAIM server missing'));
+            }
+            if (hasEssential.length > 1) {
+                console.log(chalk_1.default.green(`   ✅ ${hasEssential.length - 1} additional servers: ${hasEssential.filter(s => s !== 'fraim').join(', ')}`));
+            }
+            const missingEssential = essentialServers.filter(server => !result.mcpServers.includes(server));
+            if (missingEssential.length > 0) {
+                console.log(chalk_1.default.yellow(`   ⚠️ Missing servers: ${missingEssential.join(', ')}`));
+            }
+        }
+        console.log(); // Empty line
+    }
+    // Summary
+    console.log(chalk_1.default.blue('📊 Summary:'));
+    console.log(chalk_1.default.green(`   ✅ ${totalConfigured}/${detectedIDEs.length} IDEs have valid MCP configs`));
+    console.log(chalk_1.default.green(`   ✅ ${totalWithFRAIM}/${detectedIDEs.length} IDEs have FRAIM configured`));
+    if (totalWithFRAIM === 0) {
+        console.log(chalk_1.default.red('\n❌ No IDEs have FRAIM configured!'));
+        console.log(chalk_1.default.yellow('💡 Run: fraim setup --key=<your-fraim-key>'));
+    }
+    else if (totalWithFRAIM < detectedIDEs.length) {
+        console.log(chalk_1.default.yellow(`\n⚠️ ${detectedIDEs.length - totalWithFRAIM} IDEs missing FRAIM configuration`));
+        console.log(chalk_1.default.yellow('💡 Run: fraim setup to configure remaining IDEs'));
+    }
+    else {
+        console.log(chalk_1.default.green('\n🎉 All detected IDEs have FRAIM configured!'));
+        console.log(chalk_1.default.blue('💡 Try running: fraim init-project in any project'));
+    }
+};
+exports.runTestMCP = runTestMCP;
+exports.testMCPCommand = new commander_1.Command('test-mcp')
+    .description('Test MCP server configurations for all detected IDEs')
+    .action(exports.runTestMCP);

package/dist/src/cli/fraim.js

@@ -10,6 +10,9 @@ const sync_1 = require("./commands/sync");
 const doctor_1 = require("./commands/doctor");
 const list_1 = require("./commands/list");
 const wizard_1 = require("./commands/wizard");
+const setup_1 = require("./commands/setup");
+const init_project_1 = require("./commands/init-project");
+const test_mcp_1 = require("./commands/test-mcp");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const program = new commander_1.Command();
@@ -42,4 +45,7 @@ program.addCommand(sync_1.syncCommand);
 program.addCommand(doctor_1.doctorCommand);
 program.addCommand(list_1.listCommand);
 program.addCommand(wizard_1.wizardCommand);
+program.addCommand(setup_1.setupCommand);
+program.addCommand(init_project_1.initProjectCommand);
+program.addCommand(test_mcp_1.testMCPCommand);
 program.parse(process.argv);