fraim-framework 2.0.56 → 2.0.58

package/dist/tests/test-workflow-discovery.js

@@ -1,242 +0,0 @@
-"use strict";
-/**
- * Tests for dynamic workflow discovery in MCP server
- * Ensures workflows from all categories can be found without hardcoded category lists
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_test_1 = require("node:test");
-const node_assert_1 = __importDefault(require("node:assert"));
-const shared_server_utils_js_1 = require("./shared-server-utils.js");
-(0, node_test_1.describe)('Workflow Discovery', () => {
-    (0, node_test_1.before)(async () => {
-        // Wait for the test server to be ready
-        await (0, shared_server_utils_js_1.waitForServer)();
-    });
-    (0, node_test_1.describe)('Dynamic Category Discovery', () => {
-        (0, node_test_1.it)('should find workflows from product-building category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 1,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'spec' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            node_assert_1.default.ok(Array.isArray(response.data.result.content));
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: spec'));
-            node_assert_1.default.ok(content.text.includes('workflows/product-building/spec.md'));
-        });
-        (0, node_test_1.it)('should find workflows from compliance category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 2,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'detect-compliance-requirements' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: detect-compliance-requirements'));
-            node_assert_1.default.ok(content.text.includes('workflows/compliance/detect-compliance-requirements.md'));
-            node_assert_1.default.ok(content.text.includes('Detect Compliance Requirements'));
-        });
-        (0, node_test_1.it)('should find workflows from brainstorming category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 3,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'blue-sky-brainstorming' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: blue-sky-brainstorming'));
-            node_assert_1.default.ok(content.text.includes('workflows/brainstorming/blue-sky-brainstorming.md'));
-        });
-        (0, node_test_1.it)('should find workflows from learning category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 4,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'synthesize-learnings' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: synthesize-learnings'));
-            node_assert_1.default.ok(content.text.includes('workflows/learning/synthesize-learnings.md'));
-        });
-        (0, node_test_1.it)('should find workflows from replicate category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 5,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'replicate-discovery' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: replicate-discovery'));
-            node_assert_1.default.ok(content.text.includes('workflows/replicate/replicate-discovery.md'));
-        });
-        (0, node_test_1.it)('should find workflows from marketing category', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 6,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'create-modern-website' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: create-modern-website'));
-            node_assert_1.default.ok(content.text.includes('workflows/marketing/create-modern-website.md'));
-        });
-    });
-    (0, node_test_1.describe)('Error Handling', () => {
-        (0, node_test_1.it)('should return helpful error for non-existent workflow', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 7,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'non-existent-workflow' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow "non-existent-workflow" not found'));
-            node_assert_1.default.ok(content.text.includes('Available workflows:'));
-        });
-        (0, node_test_1.it)('should handle workflow names with .md extension', async () => {
-            const axios = require('axios');
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 8,
-                method: 'tools/call',
-                params: {
-                    name: 'get_fraim_workflow',
-                    arguments: { workflow: 'spec.md' }
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            node_assert_1.default.ok(content.text.includes('Workflow: spec'));
-            node_assert_1.default.ok(content.text.includes('workflows/product-building/spec.md'));
-        });
-    });
-    (0, node_test_1.describe)('Regression Prevention', () => {
-        (0, node_test_1.it)('should discover all workflow categories dynamically', async () => {
-            const axios = require('axios');
-            // Test that we can find workflows from multiple categories without hardcoding
-            const testCases = [
-                { workflow: 'spec', expectedCategory: 'product-building' },
-                { workflow: 'detect-compliance-requirements', expectedCategory: 'compliance' },
-                { workflow: 'blue-sky-brainstorming', expectedCategory: 'brainstorming' },
-                { workflow: 'synthesize-learnings', expectedCategory: 'learning' },
-                { workflow: 'replicate-discovery', expectedCategory: 'replicate' },
-                { workflow: 'create-modern-website', expectedCategory: 'marketing' }
-            ];
-            for (const testCase of testCases) {
-                const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                    jsonrpc: '2.0',
-                    id: 100 + testCases.indexOf(testCase),
-                    method: 'tools/call',
-                    params: {
-                        name: 'get_fraim_workflow',
-                        arguments: { workflow: testCase.workflow }
-                    }
-                });
-                node_assert_1.default.strictEqual(response.status, 200, `Failed to find workflow: ${testCase.workflow}`);
-                node_assert_1.default.ok(response.data.result, `No result for workflow: ${testCase.workflow}`);
-                node_assert_1.default.ok(response.data.result.content, `No content for workflow: ${testCase.workflow}`);
-                const content = response.data.result.content[0];
-                node_assert_1.default.strictEqual(content.type, 'text');
-                node_assert_1.default.ok(content.text.includes(`workflows/${testCase.expectedCategory}/${testCase.workflow}.md`), `Expected workflow ${testCase.workflow} to be found in category ${testCase.expectedCategory}, but got: ${content.text.substring(0, 200)}`);
-            }
-        });
-        (0, node_test_1.it)('should not fail when new categories are added', async () => {
-            // This test documents the expected behavior:
-            // When new workflow categories are added to the registry,
-            // they should be automatically discoverable without code changes
-            const axios = require('axios');
-            // Get list of all workflows to verify dynamic discovery is working
-            const response = await axios.post((0, shared_server_utils_js_1.getMcpEndpoint)(), {
-                jsonrpc: '2.0',
-                id: 200,
-                method: 'tools/call',
-                params: {
-                    name: 'list_fraim_workflows'
-                }
-            });
-            node_assert_1.default.strictEqual(response.status, 200);
-            node_assert_1.default.ok(response.data.result);
-            node_assert_1.default.ok(response.data.result.content);
-            const content = response.data.result.content[0];
-            node_assert_1.default.strictEqual(content.type, 'text');
-            // Verify that multiple categories are listed
-            const expectedCategories = [
-                'bootstrap',
-                'brainstorming',
-                'business-development',
-                'compliance',
-                'customer-development',
-                'learning',
-                'marketing',
-                'product-building',
-                'replicate'
-            ];
-            for (const category of expectedCategories) {
-                node_assert_1.default.ok(content.text.includes(category), `Expected category "${category}" to be listed in workflows, but got: ${content.text.substring(0, 500)}`);
-            }
-        });
-    });
-});

package/labels.json

@@ -1,52 +0,0 @@
-[
-  {
-    "name": "phase:spec",
-    "color": "008672",
-    "description": "Specification creation phase"
-  },
-  {
-    "name": "phase:design",
-    "color": "0075ca",
-    "description": "Design and RFC creation phase"
-  },
-  {
-    "name": "phase:impl",
-    "color": "7057ff",
-    "description": "Implementation and development phase"
-  },
-  {
-    "name": "phase:tests",
-    "color": "008672",
-    "description": "Testing and validation phase"
-  },
-  {
-    "name": "status:wip",
-    "color": "fbca04",
-    "description": "Work in progress"
-  },
-  {
-    "name": "status:needs-review",
-    "color": "fbca04",
-    "description": "Ready for review"
-  },
-  {
-    "name": "status:complete",
-    "color": "0e8a16",
-    "description": "Work completed"
-  },
-  {
-    "name": "ai-agent:cursor",
-    "color": "c5def5",
-    "description": "Assigned to Cursor"
-  },
-  {
-    "name": "ai-agent:claude",
-    "color": "c5def5",
-    "description": "Assigned to Claude"
-  },
-  {
-    "name": "ai-agent:windsurf",
-    "color": "c5def5",
-    "description": "Assigned to Windsurf"
-  }
-]

package/registry/agent-guardrails.md

@@ -1,63 +0,0 @@
-# AI Agent Guardrails
-
-This file references the centralized rules located in `rules/` to ensure consistency across all AI platforms.
-
-## SUCCESS CRITERIA (THE "FRAIM 5")
-**Source**: Retrieve via `get_fraim_file({ path: "rules/agent-success-criteria.md" })`
-
-All agents are evaluated on:
-1. **Integrity (100 pts)**: Honesty above all.
-2. **Correctness (50 pts)**: Architecture & tests.
-3. **Completeness (30 pts)**: Thoroughness.
-4. **Independence (20 pts)**: Smart decisions.
-5. **Speed (10 pts)**: Velocity.
-
-## Referenced Rules
-
-### 0. Integrity
-**Source**: Retrieve via `get_fraim_file({ path: "rules/integrity-and-test-ethics.md" })`
-
-THIS IS THE MOST CRITICAL RULE. Be ethical, truthful, honest above all.
-
-### 1. Simplicity
-**Source**: Retrieve via `get_fraim_file({ path: "rules/simplicity.md" })`
-
-Keep solutions simple and focused, avoid over-engineering. Focus on the assigned issue only and don't make unrelated changes.
-
-### 2. Communication  
-**Source**: Retrieve via `get_fraim_file({ path: "rules/communication.md" })`
-
-Establish clear communication patterns and progress reporting standards for effective coordination between agents and stakeholders.
-
-### 3. Architecture
-**Source**: Read local architecture document (path from `.fraim/config.json` `customizations.architectureDoc`)
-
-Maintain clean architectural boundaries by using BAML (LLM) for natural-language understanding and TypeScript for deterministic work.
-
-### 4. Continuous Learning
-**Source**: Retrieve via `get_fraim_file({ path: "rules/continuous-learning.md" })`
-
-Prevent repeating past mistakes by systematically learning from retrospectives, RFCs, and historical issue patterns.
-
-### 5. Agent Testing Guidelines
-**Source**: Retrieve via `get_fraim_file({ path: "rules/agent-testing-guidelines.md" })`
-
-Comprehensive testing and validation requirements with concrete evidence. Ensures all work is thoroughly validated before completion.
-
-### 6. Local Development
-**Source**: Retrieve via `get_fraim_file({ path: "rules/local-development.md" })`
-
-Local development guidelines and workspace safety. Enables safe parallel development through strict workspace separation.
-
-### 7. Software Development Lifecycle
-**Source**: Retrieve via `get_fraim_file({ path: "rules/software-development-lifecycle.md" })`
-
-### 9. Merge Requirements
-**Source**: Retrieve via `get_fraim_file({ path: "rules/merge-requirements.md" })`
-
-Enforces a strict `git rebase` workflow to ensure feature branches are up-to-date with `master` before merging, maintaining a clean and stable history.
-
-### 10. Best practices while debuggin
-**Source**: Retrieve via `get_fraim_file({ path: "rules/successful-debugging-patterns.md" })`
-
-Patterns on debugging issues systematically and converting learnings into test cases

package/registry/fraim.md

@@ -1,48 +0,0 @@
-# FRAIM - Agent Instructions
-
-## What is FRAIM?
-
-FRAIM provides workflows, rules, templates, and scripts for AI agents. Use it to get structured guidance for development and customer development tasks.
-
-## How to Use FRAIM
-
-### 1. Initialize First
-**Always call `@fraim_mcp init` at the start of your session.** This loads all rules and available workflows.
-
-### 2. Get Workflows
-Use `@fraim_mcp` with a natural language description:
-- `@fraim_mcp write a spec for issue #631`
-- `@fraim_mcp design a new feature`
-- `@fraim_mcp implement a bug fix`
-- `@fraim_mcp write tests`
-
-FRAIM returns a complete package:
-- Workflow file with step-by-step instructions
-- Templates to fill out
-- Scripts to run
-- Rules you must follow
-
-### 3. Follow the Package
-1. Read the workflow file
-2. Use the provided templates (don't create from scratch)
-3. Run the provided scripts
-4. Follow all rules (they are mandatory)
-
-## Available Tools
-
-- `@fraim_mcp init` - Initialize and get all rules
-- `@fraim_mcp <workflow description>` - Get workflow package
-- `@fraim_mcp get <path>` - Get specific file (e.g., `workflows/spec.md`)
-- `@fraim_mcp list files` - Browse available files
-- `@fraim_mcp search <keyword>` - Find content by keyword
-
-## Key Rules (All Active)
-
-- **Integrity**: Be ethical, truthful, honest
-- **Simplicity**: Keep solutions simple, avoid over-engineering
-- **Communication**: Provide clear progress updates
-- **Testing**: Comprehensive testing requirements (see agent-testing-guidelines.md)
-- **Code Quality**: Never use `as any`, follow debugging patterns
-- **PR Workflow**: Complete PR lifecycle handling
-
-**All rules are mandatory. Read them carefully when provided in workflow packages.**

package/setup.js

@@ -1,171 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-// Colors for console output
-const colors = {
-    green: '\x1b[32m',
-    red: '\x1b[31m',
-    yellow: '\x1b[33m',
-    reset: '\x1b[0m'
-};
-
-// Utility functions
-function ensureDirectory(dirPath) {
-    if (!fs.existsSync(dirPath)) {
-        fs.mkdirSync(dirPath, { recursive: true });
-    }
-}
-
-function logSuccess(message) {
-    console.log(`${colors.green}✓ ${message}${colors.reset}`);
-}
-
-function logError(message) {
-    console.log(`${colors.red}✗ ${message}${colors.reset}`);
-}
-
-// Copy directory recursively
-function copyDirectory(src, dest) {
-    if (!fs.existsSync(src)) {
-        console.log(`⚠️  Warning: ${src} not found in package`);
-        return;
-    }
-    
-    ensureDirectory(dest);
-    const items = fs.readdirSync(src);
-    
-    for (const item of items) {
-        const srcPath = path.join(src, item);
-        const destPath = path.join(dest, item);
-        
-        if (fs.statSync(srcPath).isDirectory()) {
-            copyDirectory(srcPath, destPath);
-        } else {
-            fs.copyFileSync(srcPath, destPath);
-        }
-    }
-}
-
-// Copy single file
-function copyFile(src, dest) {
-    if (!fs.existsSync(src)) {
-        console.log(`⚠️  Warning: ${src} not found in package`);
-        return;
-    }
-    
-    // Ensure destination directory exists
-    const destDir = path.dirname(dest);
-    ensureDirectory(destDir);
-    
-    fs.copyFileSync(src, dest);
-}
-
-// Create GitHub labels from labels.json
-function createGitHubLabels() {
-    const labelsPath = path.join(__dirname, 'labels.json');
-    if (!fs.existsSync(labelsPath)) {
-        console.log('⚠️  Warning: labels.json not found in package');
-        return;
-    }
-    
-    const labelsContent = fs.readFileSync(labelsPath, 'utf8');
-    
-    // Always copy the labels.json file
-    fs.writeFileSync('labels.json', labelsContent);
-    logSuccess('Created labels.json');
-    
-    // Check if we're in a git repository
-    const isGitRepo = fs.existsSync('.git');
-    
-    if (isGitRepo) {
-        // We're in a git repo, run the script
-        try {
-            const { execSync } = require('child_process');
-            const os = require('os');
-            
-            if (os.platform() === 'win32') {
-                // Windows: use bash to run the script
-                execSync('bash .ai-agents/scripts/create-git-labels.sh labels.json', { stdio: 'inherit' });
-            } else {
-                // Unix-like: make executable and run
-                execSync('chmod +x .ai-agents/scripts/create-git-labels.sh');
-                execSync('.ai-agents/scripts/create-git-labels.sh labels.json', { stdio: 'inherit' });
-            }
-            logSuccess('Created GitHub labels');
-        } catch (error) {
-            console.log('⚠️  Could not create GitHub labels automatically. Run manually:');
-            if (require('os').platform() === 'win32') {
-                console.log('   bash .ai-agents/scripts/create-git-labels.sh labels.json');
-            } else {
-                console.log('   .ai-agents/scripts/create-git-labels.sh labels.json');
-            }
-        }
-    } else {
-        // Not in a git repo, give instructions
-        console.log('📝 Note: Not in a git repository. To create GitHub labels:');
-        console.log('   1. Initialize git repo: git init');
-        console.log('   2. Create GitHub repo and connect it');
-        if (require('os').platform() === 'win32') {
-            console.log('   3. Run: bash .ai-agents/scripts/create-git-labels.sh labels.json');
-        } else {
-            console.log('   3. Run: .ai-agents/scripts/create-git-labels.sh labels.json');
-        }
-    }
-}
-
-// Main setup function
-function runSetup() {
-    try {
-        // Copy full directories
-        const directoriesToCopy = [
-            '.ai-agents',
-            '.cursor',
-            '.windsurf',
-            '.github/workflows',
-            'examples'
-        ];
-        
-        directoriesToCopy.forEach(dir => {
-            const srcPath = path.join(__dirname, dir);
-            const destPath = dir;
-            copyDirectory(srcPath, destPath);
-            logSuccess(`Copied ${dir}/`);
-        });
-        
-        // Copy individual files
-        const filesToCopy = [
-            'Claude.md',
-            'sample_package.json',
-            'test-utils.ts',
-            'tsconfig.json'
-        ];
-        
-        filesToCopy.forEach(file => {
-            const srcPath = path.join(__dirname, file);
-            copyFile(srcPath, file);
-            logSuccess(`Copied ${file}`);
-        });
-        
-        // Create special files
-        createGitHubLabels();
-        
-        console.log('\n✅ FRAIM setup complete!');
-        console.log('🎯 Your repository is now ready for AI agent management.');
-        console.log('📚 Next steps:');
-        console.log('   1. Customize .ai-agents/rules/architecture.md for your project');
-        console.log('   2. Update .ai-agents/scripts/cleanup-branch.ts with your cleanup logic');
-        console.log('   3. Copy scripts from sample_package.json to your package.json');
-        console.log('   4. Start creating issues with ai-agent labels!');
-        
-    } catch (error) {
-        logError(`Setup failed: ${error.message}`);
-        throw error;
-    }
-}
-
-// If this file is run directly, execute setup
-if (require.main === module) {
-    runSetup();
-}
-
-module.exports = { runSetup };

package/tsconfig.json

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2021",
-    "module": "commonjs",
-    "lib": [
-      "es2021"
-    ],
-    "outDir": "./dist",
-    "rootDir": "./",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": [
-    "src/**/*.ts",
-    "tests/**/*.ts",
-    "registry/**/*.ts"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}