fraim-framework 2.0.52 → 2.0.54

package/dist/registry/ai-manager-rules/spec.json

@@ -1,112 +0,0 @@
-{
-  "workflowType": "spec",
-  "description": "Specification phase validation ensures that feature specifications are complete, follow the correct template structure, and include all necessary components including high-fidelity mocks for UI changes.",
-  "validationRules": [
-    {
-      "step": 1,
-      "description": "Verify issue is labeled with phase:spec",
-      "passCriteria": "Issue has 'phase:spec' label applied in GitHub",
-      "weight": "blocking",
-      "category": "process"
-    },
-    {
-      "step": 2,
-      "description": "Verify spec document exists in correct location",
-      "command": "find \"docs/feature specs\" -name \"*{issue_number}*\" -type f",
-      "passCriteria": "Spec document exists at docs/feature specs/{issue_number}-{kebab-title}.md with substantial content (>1000 characters)",
-      "weight": "blocking",
-      "category": "completeness"
-    },
-    {
-      "step": 3,
-      "description": "Check spec follows FEATURESPEC template structure",
-      "passCriteria": "Spec includes all required sections: Customer, Customer's Desired Outcome, Customer Problem, User Experience, Validation Plan, Alternatives, Competitive Landscape",
-      "weight": "blocking",
-      "category": "structure"
-    },
-    {
-      "step": 4,
-      "description": "Validate Customer section is complete",
-      "passCriteria": "Customer section clearly identifies who will use this feature with specific details",
-      "weight": "blocking",
-      "category": "customer-focus"
-    },
-    {
-      "step": 5,
-      "description": "Validate Customer's Desired Outcome is specific",
-      "passCriteria": "Desired outcome is clear, measurable, and describes the end goal the customer wants to achieve",
-      "weight": "blocking",
-      "category": "customer-focus"
-    },
-    {
-      "step": 6,
-      "description": "Validate Customer Problem is well-defined",
-      "passCriteria": "Problem statement is specific and explains why current state is insufficient for the customer",
-      "weight": "blocking",
-      "category": "problem-definition"
-    },
-    {
-      "step": 7,
-      "description": "Check User Experience section has detailed workflow",
-      "passCriteria": "User Experience includes specific step-by-step workflow (start in X, click Y, see Z, etc.) that shows exactly how the user will interact with the feature",
-      "weight": "blocking",
-      "category": "user-experience"
-    },
-    {
-      "step": 8,
-      "description": "Verify high-fidelity mocks are created if issue requires mocks",
-      "command": "find \"docs/feature specs/mocks\" -name \"*{issue_number}*\" -type f",
-      "passCriteria": "If feature involves UI changes, high-fidelity mocks (HTML/CSS files) are included in docs/feature specs/mocks folder and linked in spec. Markdown code blocks are NOT sufficient.",
-      "weight": "blocking",
-      "category": "user-experience"
-    },
-    {
-      "step": 9,
-      "description": "Validate Validation Plan is actionable",
-      "passCriteria": "Validation Plan includes specific, executable steps to verify the feature works (browser tests, API calls, user scenarios, etc.)",
-      "weight": "blocking",
-      "category": "validation"
-    },
-    {
-      "step": 10,
-      "description": "Check Alternatives section is complete",
-      "passCriteria": "Alternatives section includes table with alternative solutions and clear reasons for not choosing them",
-      "weight": "warning",
-      "category": "thoroughness"
-    },
-    {
-      "step": 11,
-      "description": "Verify Competitive Landscape analysis",
-      "passCriteria": "Competitive Landscape section includes table with competitors, their solutions, and customer feedback or market research",
-      "weight": "warning",
-      "category": "market-awareness"
-    },
-    {
-      "step": 12,
-      "description": "Check all requirements from original issue are addressed",
-      "passCriteria": "All requirements and acceptance criteria from the original GitHub issue are covered in the spec document",
-      "weight": "blocking",
-      "category": "completeness"
-    }
-  ],
-  "gradingCriteria": {
-    "passRequirements": [
-      "ALL blocking validation steps must pass",
-      "At least 80% of warning validation steps should pass",
-      "Spec demonstrates clear understanding of customer needs",
-      "Quality standards are met consistently",
-      "No placeholder text or incomplete sections remain"
-    ],
-    "failRequirements": [
-      "ANY blocking validation step fails",
-      "Multiple warning validation steps fail indicating quality issues",
-      "Spec appears incomplete or rushed",
-      "Requirements not properly addressed",
-      "Template structure not followed"
-    ]
-  },
-  "reportingFormat": {
-    "requiredFields": ["pass", "reasons"],
-    "instructions": "Evaluate each validation step honestly. If ANY blocking step fails, you must report pass=false. Provide specific reasons for failure in the reasons array. Be thorough and honest in your self-assessment."
-  }
-}

package/dist/registry/ai-manager-rules/test.json

@@ -1,98 +0,0 @@
-{
-  "workflowType": "test",
-  "description": "Testing phase validation ensures comprehensive test coverage, proper test implementation, and validation of all functionality.",
-  "validationRules": [
-    {
-      "step": 1,
-      "description": "Verify issue is labeled with phase:test",
-      "passCriteria": "Issue has 'phase:test' label applied",
-      "weight": "blocking",
-      "category": "process"
-    },
-    {
-      "step": 2,
-      "description": "Check all tests pass",
-      "command": "npm test",
-      "passCriteria": "All tests pass without errors or failures",
-      "weight": "blocking",
-      "category": "test-execution"
-    },
-    {
-      "step": 3,
-      "description": "Verify test coverage is adequate",
-      "command": "npm run test:coverage",
-      "passCriteria": "Test coverage meets project standards (typically >80% for new code)",
-      "weight": "blocking",
-      "category": "test-coverage"
-    },
-    {
-      "step": 4,
-      "description": "Check unit tests for new functionality",
-      "passCriteria": "All new functions/methods have corresponding unit tests with edge cases",
-      "weight": "blocking",
-      "category": "unit-testing"
-    },
-    {
-      "step": 5,
-      "description": "Verify integration tests exist",
-      "passCriteria": "Integration tests cover API endpoints, database interactions, and component integration",
-      "weight": "blocking",
-      "category": "integration-testing"
-    },
-    {
-      "step": 6,
-      "description": "Check error scenario testing",
-      "passCriteria": "Tests cover error conditions, invalid inputs, and failure scenarios",
-      "weight": "blocking",
-      "category": "error-testing"
-    },
-    {
-      "step": 7,
-      "description": "Validate test data and mocking",
-      "passCriteria": "Proper test data setup, appropriate mocking of external dependencies",
-      "weight": "warning",
-      "category": "test-setup"
-    },
-    {
-      "step": 8,
-      "description": "Check test performance",
-      "passCriteria": "Tests run efficiently, no unnecessarily slow tests, proper test isolation",
-      "weight": "warning",
-      "category": "test-performance"
-    },
-    {
-      "step": 9,
-      "description": "Verify end-to-end tests (if applicable)",
-      "passCriteria": "E2E tests cover critical user workflows and system interactions",
-      "weight": "warning",
-      "category": "e2e-testing"
-    },
-    {
-      "step": 10,
-      "description": "Check test documentation",
-      "passCriteria": "Test cases are well-documented, test setup instructions are clear",
-      "weight": "warning",
-      "category": "test-documentation"
-    }
-  ],
-  "gradingCriteria": {
-    "passRequirements": [
-      "ALL blocking validation steps must pass",
-      "At least 80% of warning validation steps should pass",
-      "Comprehensive test coverage for all new functionality",
-      "Tests are reliable and maintainable",
-      "All edge cases and error scenarios covered"
-    ],
-    "failRequirements": [
-      "ANY blocking validation step fails",
-      "Tests are failing or missing",
-      "Inadequate test coverage",
-      "Poor test quality or reliability",
-      "Critical scenarios not tested"
-    ]
-  },
-  "reportingFormat": {
-    "requiredFields": ["pass", "reasons"],
-    "instructions": "Evaluate each validation step honestly. Run all test commands and verify coverage reports. If ANY blocking step fails, you must report pass=false. Focus on test quality, coverage, and reliability."
-  }
-}

package/dist/registry/scripts/build-scripts-generator.js

@@ -1,205 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-/**
- * FRAIM Build Scripts Generator
- *
- * Generates generic build scripts and validation patterns.
- * These are generic enough to apply to any project.
- *
- * Usage:
- *   npx tsx scripts/build-scripts-generator.ts
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatePackageScripts = generatePackageScripts;
-exports.generateCodeQualityScript = generateCodeQualityScript;
-exports.generateCopyScripts = generateCopyScripts;
-exports.generateBuildScripts = generateBuildScripts;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const config_loader_js_1 = require("../../src/fraim/config-loader.js");
-/**
- * Generate package.json scripts section
- */
-function generatePackageScripts(config) {
-    return {
-        "build": "tsc && npm run validate:openapi",
-        "validate:openapi": "npx tsx " + "reg" + "istry/scripts/validate-openapi-limits.ts",
-        "start": "node dist/src/server.js",
-        "start:mcp": "node dist/src/mcp-server.js",
-        "dev": "npx tsx --watch src/server.ts",
-        "dev:mcp": "tsx src/mcp-server.ts",
-        "generate:openapi": "npx tsx " + "reg" + "istry/scripts/openapi-generator.ts",
-        "test": "npx tsx --test test*.ts",
-        "lint": "eslint *.ts",
-        "lint:fix": "eslint *.ts --fix"
-    };
-}
-/**
- * Generate code quality check script (generic version)
- */
-function generateCodeQualityScript(outputDir) {
-    if (!(0, fs_1.existsSync)(outputDir)) {
-        (0, fs_1.mkdirSync)(outputDir, { recursive: true });
-    }
-    const scriptContent = `#!/bin/bash
-
-# FRAIM Generic Code Quality Check
-# Validates code quality, build, and ChatGPT limits
-
-set -e
-
-MODE=\${1:-full}
-FAILED=0
-WARNINGS=0
-
-echo "================================================"
-echo "🔍 CODE QUALITY CHECK ($MODE mode)"
-echo "================================================"
-echo ""
-
-# Build check
-if [ "$MODE" = "full" ] || [ "$MODE" = "build" ]; then
-  echo "📦 Building project..."
-  if npm run build; then
-    echo "✅ Build passed"
-  else
-    echo "❌ Build failed"
-    FAILED=1
-  fi
-  echo ""
-fi
-
-# Lint check
-if [ "$MODE" = "full" ] || [ "$MODE" = "lint" ]; then
-  echo "🔍 Linting code..."
-  if npm run lint; then
-    echo "✅ Lint passed"
-  else
-    echo "⚠️  Lint warnings (non-blocking)"
-    WARNINGS=1
-  fi
-  echo ""
-fi
-
-# OpenAPI validation (ChatGPT limits)
-if [ "$MODE" = "full" ] || [ "$MODE" = "openapi" ]; then
-  echo "📋 Validating OpenAPI and ChatGPT limits..."
-  if npm run validate:openapi; then
-    echo "✅ OpenAPI validation passed"
-  else
-    echo "❌ OpenAPI validation failed"
-    FAILED=1
-  fi
-  echo ""
-fi
-
-# Summary
-echo "================================================"
-echo "📊 QUALITY CHECK SUMMARY ($MODE mode)"
-echo "================================================"
-echo ""
-
-if [ $FAILED -eq 1 ]; then
-  echo "❌ CHECKS FAILED"
-  echo ""
-  echo "Fix the errors above before proceeding."
-  exit 1
-elif [ $WARNINGS -eq 1 ]; then
-  echo "⚠️  CHECKS PASSED WITH WARNINGS"
-  echo ""
-  echo "Review warnings above."
-  exit 0
-else
-  echo "✅ ALL CHECKS PASSED"
-  echo ""
-  exit 0
-fi
-`;
-    const scriptPath = (0, path_1.join)(outputDir, 'code-quality-check.sh');
-    (0, fs_1.writeFileSync)(scriptPath, scriptContent);
-    // Make executable (Unix)
-    if (process.platform !== 'win32') {
-        const { execSync } = require('child_process');
-        execSync(`chmod +x ${scriptPath}`);
-    }
-    console.log(`✅ Generated code quality check script at ${scriptPath}`);
-}
-/**
- * Generate build copy scripts (generic)
- */
-function generateCopyScripts(outputDir) {
-    if (!(0, fs_1.existsSync)(outputDir)) {
-        (0, fs_1.mkdirSync)(outputDir, { recursive: true });
-    }
-    // Copy AI agents script (if .fraim exists)
-    const copyAiAgents = `#!/usr/bin/env node
-
-/**
- * Copy registry directory to dist
- * Generic build script for FRAIM projects
- */
-
-const fs = require('fs');
-const path = require('path');
-
-const sourceDir = path.join(__dirname, '..', '..', 'registry');
-const destDir = path.join(__dirname, '..', '..', 'dist', 'registry');
-
-if (fs.existsSync(sourceDir)) {
-  // Recursive copy
-  function copyRecursive(src, dest) {
-    if (!fs.existsSync(dest)) {
-      fs.mkdirSync(dest, { recursive: true });
-    }
-    
-    const entries = fs.readdirSync(src, { withFileTypes: true });
-    
-    for (const entry of entries) {
-      const srcPath = path.join(src, entry.name);
-      const destPath = path.join(dest, entry.name);
-      
-      if (entry.isDirectory()) {
-        copyRecursive(srcPath, destPath);
-      } else {
-        fs.copyFileSync(srcPath, destPath);
-      }
-    }
-  }
-  
-  copyRecursive(sourceDir, destDir);
-  console.log('✅ Copied registry to dist/registry');
-} else {
-  console.log('ℹ️  registry directory not found, skipping');
-}
-`;
-    (0, fs_1.writeFileSync)((0, path_1.join)(outputDir, 'copy-ai-agents.js'), copyAiAgents);
-    console.log(`✅ Generated copy-ai-agents.js`);
-}
-/**
- * Main generator function
- */
-function generateBuildScripts(config, outputDir = "scr" + "ipts/build") {
-    console.log('🚀 FRAIM Build Scripts Generator\n');
-    console.log(`📁 Output directory: ${outputDir}\n`);
-    // Ensure output directory exists
-    if (!(0, fs_1.existsSync)(outputDir)) {
-        (0, fs_1.mkdirSync)(outputDir, { recursive: true });
-    }
-    // Generate code quality check
-    console.log('📝 Generating code quality check script...');
-    generateCodeQualityScript(outputDir);
-    // Generate build scripts
-    console.log('\n📝 Generating build scripts...');
-    generateCopyScripts(outputDir);
-    console.log('\n✅ Build scripts generation complete!');
-    console.log('\n📋 Next steps:');
-    console.log('1. Add scripts to package.json');
-    console.log('2. Run: npm run validate:openapi');
-    console.log('3. Run: ./scripts/build/code-quality-check.sh');
-}
-// Run if executed directly
-// @ts-ignore
-if (import.meta.url === `file://${process.argv[1]}`) {
-    const config = (0, config_loader_js_1.loadFraimConfig)();
-    generateBuildScripts(config);
-}

package/dist/registry/scripts/fraim-config.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fraimConfig = void 0;
-exports.formatExecutiveDisplayName = formatExecutiveDisplayName;
-exports.formatPersonaSignature = formatPersonaSignature;
-const config_loader_1 = require("../../src/fraim/config-loader");
-const config = (0, config_loader_1.loadFraimConfig)();
-const envOr = (keys, fallback) => {
-    for (const key of keys) {
-        const value = process.env[key];
-        if (value && value.length) {
-            return value;
-        }
-    }
-    return fallback;
-};
-const personaName = config.persona.name;
-const personaDisplayNameDefault = config.persona.displayNamePattern.replace('{executiveName}', 'Your');
-exports.fraimConfig = {
-    repoOwner: config.git.repoOwner || 'mathursrus',
-    repoName: config.git.repoName || 'fraim-repo',
-    projectName: config.project.name,
-    personaName,
-    personaPronouns: envOr(['FRAIM_PERSONA_PRONOUNS'], 'they/them'), // Could add to config if needed
-    personaDisplayName: envOr(['FRAIM_PERSONA_DISPLAY_NAME'], personaDisplayNameDefault),
-    personaDisplayNamePattern: config.persona.displayNamePattern,
-    personaThankYouSignature: config.persona.emailSignature,
-    defaultEmail: envOr(['FRAIM_DEFAULT_EMAIL'], 'agent@example.com'),
-    prodDefaultEmail: envOr(['PROD_FRAIM_DEFAULT_EMAIL'], 'agent@example.com'),
-    defaultAccessToken: envOr(['FRAIM_DEFAULT_ACCESS_TOKEN'], ''),
-    defaultRefreshToken: envOr(['FRAIM_DEFAULT_REFRESH_TOKEN'], ''),
-    prodAccessToken: envOr(['PROD_FRAIM_DEFAULT_ACCESS_TOKEN'], ''),
-    prodRefreshToken: envOr(['PROD_FRAIM_DEFAULT_REFRESH_TOKEN'], ''),
-    defaultOAuthClientId: envOr(['FRAIM_DEFAULT_OAUTH_CLIENT_ID'], ''),
-    defaultOAuthClientSecret: envOr(['FRAIM_DEFAULT_OAUTH_CLIENT_SECRET'], ''),
-    prodOAuthClientId: envOr(['PROD_FRAIM_DEFAULT_OAUTH_CLIENT_ID'], ''),
-    prodOAuthClientSecret: envOr(['PROD_FRAIM_DEFAULT_OAUTH_CLIENT_SECRET'], ''),
-    identityCollection: config.database?.identityCollection || 'Identity',
-    executiveCollection: config.database?.executiveCollection || 'Executive',
-    newsletterTitle: config.marketing?.newsletterTitle || 'Weekly Update',
-    newsletterCtaText: config.marketing?.newsletterCtaText || 'Learn More',
-    newsletterUrl: config.marketing?.newsletterUrl || envOr(['FRAIM_NEWSLETTER_URL'], ''),
-    issueRepoUrl: config.git.url || `https://github.com/${config.git.repoOwner}/${config.git.repoName}.git`,
-    identityTokensCollection: config.database?.tokensCollection || 'Tokens',
-    webAppUrl: config.marketing?.websiteUrl || envOr(['FRAIM_WEB_APP_URL'], 'http://localhost:3000'),
-    chatUrl: config.marketing?.chatUrl || envOr(['FRAIM_CHAT_URL'], ''),
-    azure: {
-        prodAppName: envOr(['FRAIM_AZURE_PROD_APP_NAME'], 'fraim-app-prod'),
-        prodResourceGroup: envOr(['FRAIM_AZURE_PROD_RESOURCE_GROUP'], 'fraim-prod-rg'),
-        preprodAppName: envOr(['FRAIM_AZURE_PREPROD_APP_NAME'], 'fraim-app-pre-prod'),
-        preprodResourceGroup: envOr(['FRAIM_AZURE_PREPROD_RESOURCE_GROUP'], 'fraim-pre-prod-rg'),
-        localAppName: envOr(['FRAIM_AZURE_LOCAL_APP_NAME'], 'local'),
-        localResourceGroup: envOr(['FRAIM_AZURE_LOCAL_RESOURCE_GROUP'], 'local')
-    }
-};
-function formatExecutiveDisplayName(executiveName) {
-    return config.persona.displayNamePattern.replace('{executiveName}', executiveName);
-}
-function formatPersonaSignature() {
-    return `With gratitude,\n${exports.fraimConfig.personaThankYouSignature}\n${personaName} - Your AI Executive Assistant\n\n`;
-}

package/dist/registry/scripts/generic-issues-api.js

@@ -1,100 +0,0 @@
-"use strict";
-/**
- * FRAIM Generic Issues API
- *
- * Generic issue filing endpoint that works for any project.
- * Can be invoked through ChatGPT OpenAPI or MCP.
- *
- * Usage:
- * 1. Import this file
- * 2. Mount the router in your Express app
- * 3. Configure GitHub repository in .fraim/config.json
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.issuesRouter = void 0;
-const express_1 = require("express");
-const issues_js_1 = require("../../src/fraim/issues.js");
-const config_loader_js_1 = require("../../src/fraim/config-loader.js");
-const issuesRouter = (0, express_1.Router)();
-exports.issuesRouter = issuesRouter;
-/**
- * POST /issues/create - Create a GitHub issue
- *
- * Generic endpoint that works for any FRAIM project.
- * Repository owner and name are read from .fraim/config.json
- */
-issuesRouter.post('/create', async (req, res) => {
-    try {
-        // Load project configuration
-        const config = (0, config_loader_js_1.loadFraimConfig)();
-        const repoOwner = config.git?.repoOwner || process.env.GITHUB_OWNER || 'your-org';
-        const repoName = config.git?.repoName || process.env.GITHUB_REPO || 'your-repo';
-        // Get user context (if available - project-specific)
-        // Projects can customize this based on their auth system
-        const userId = req.userContext?.userId ||
-            req.executiveContext?.executiveId ||
-            req.headers['x-user-id'];
-        const userEmail = req.userContext?.email ||
-            req.executiveContext?.executiveEmail ||
-            req.headers['x-user-email'];
-        const userName = req.userContext?.name ||
-            req.executiveContext?.executiveName ||
-            req.headers['x-user-name'];
-        const { title, body, labels } = req.body;
-        if (!title || !body) {
-            return res.status(400).json({
-                success: false,
-                error: 'Missing required fields: title, body'
-            });
-        }
-        // Check if GitHub token is configured
-        if (!process.env.GITHUB_TOKEN && !process.env.GIT_TOKEN && !process.env.GITHUB_PAT) {
-            return res.status(500).json({
-                success: false,
-                error: 'GitHub integration not configured. Please set GITHUB_TOKEN environment variable.'
-            });
-        }
-        // Build issue body with user context (if available)
-        let issueBody = body;
-        if (userName || userEmail || userId) {
-            issueBody = `**Reported by:** ${userName || 'Unknown'}${userEmail ? ` (${userEmail})` : ''}${userId ? `\n**User ID:** ${userId}` : ''}\n\n**Issue Details:**\n${body}\n\n---\n*This issue was automatically created through the API.*`;
-        }
-        // Create the issue using shared function
-        const result = await (0, issues_js_1.fileFraimIssue)({
-            title: title,
-            body: issueBody,
-            labels: labels || ['user-reported']
-        });
-        if (!result.success) {
-            return res.status(500).json({
-                success: false,
-                error: result.message
-            });
-        }
-        return res.json({
-            success: true,
-            message: 'Issue created successfully',
-            issueNumber: result.issueNumber,
-            issueUrl: result.htmlUrl,
-            title: title
-        });
-    }
-    catch (error) {
-        console.error('❌ Unexpected error creating Git issue:', error);
-        return res.status(500).json({
-            success: false,
-            error: error.message || 'Failed to create Git issue'
-        });
-    }
-});
-/**
- * GET /issues/list - List issues
- *
- * Not implemented in this generic version.
- */
-issuesRouter.get('/list', async (req, res) => {
-    return res.status(501).json({
-        success: false,
-        error: 'Listing issues is not supported in this generic API version yet.'
-    });
-});