@probelabs/visor 0.1.106 → 0.1.111

package/dist/examples/calculator-sdk-real.ts

@@ -0,0 +1,374 @@
+#!/usr/bin/env node
+
+/**
+ * Real SDK Calculator Example
+ *
+ * This is a complete, runnable example showing how to use Visor SDK with human-input.
+ * The config is defined inline and the workflow executes programmatically.
+ *
+ * Usage:
+ *   npm run build
+ *   ts-node examples/calculator-sdk-real.ts
+ *
+ * Or after build:
+ *   node examples/calculator-sdk-real.js
+ */
+
+import * as readline from 'readline';
+import { HumanInputRequest, VisorConfig } from '../src/types/config';
+import { HumanInputCheckProvider } from '../src/providers/human-input-check-provider';
+import { CheckExecutionEngine } from '../src/check-execution-engine';
+
+// ============================================================================
+// CONFIGURATION - Defined inline
+// ============================================================================
+
+const calculatorConfig: VisorConfig = {
+  version: "1.0",
+
+  // Memory configuration for storing values between steps
+  memory: {
+    storage: 'memory',
+    namespace: 'calculator'
+  },
+
+  // Define our workflow checks
+  checks: {
+    // Step 1: Get first number from user
+    "get-number1": {
+      type: "human-input",
+      prompt: "Enter the first number:",
+      placeholder: "e.g., 42",
+      allow_empty: false
+    },
+
+    // Step 2: Parse and store first number in memory
+    "store-number1": {
+      type: "memory",
+      depends_on: ["get-number1"],
+      operation: "set",
+      namespace: "calculator",
+      key: "number1",
+      value_js: "parseFloat(outputs['get-number1'])"
+    },
+
+    // Step 3: Get second number from user
+    "get-number2": {
+      type: "human-input",
+      depends_on: ["store-number1"],
+      prompt: "Enter the second number:",
+      placeholder: "e.g., 7",
+      allow_empty: false
+    },
+
+    // Step 4: Parse and store second number in memory
+    "store-number2": {
+      type: "memory",
+      depends_on: ["get-number2"],
+      operation: "set",
+      namespace: "calculator",
+      key: "number2",
+      value_js: "parseFloat(outputs['get-number2'])"
+    },
+
+    // Step 5: Get operation from user
+    "get-operation": {
+      type: "human-input",
+      depends_on: ["store-number2"],
+      prompt: "Select operation (+, -, *, /):",
+      placeholder: "Enter one of: + - * /",
+      allow_empty: false
+    },
+
+    // Step 6: Validate and store operation
+    "store-operation": {
+      type: "memory",
+      depends_on: ["get-operation"],
+      operation: "set",
+      namespace: "calculator",
+      key: "operation",
+      value_js: "outputs['get-operation'].trim()",
+      // Validate operation
+      fail_if: "!['+', '-', '*', '/'].includes(outputs['get-operation'].trim())"
+    },
+
+    // Step 7: Perform calculation using JavaScript
+    "calculate": {
+      type: "script",
+      depends_on: ["store-operation"],
+      content: `
+        // Get values from memory
+        const num1 = memory.get('number1', 'calculator');
+        const num2 = memory.get('number2', 'calculator');
+        const op = memory.get('operation', 'calculator');
+
+        // Debug logging
+        log('🔢 Calculating:', num1, op, num2);
+
+        // Validate numbers
+        if (isNaN(num1)) {
+          throw new Error('First number is invalid: ' + num1);
+        }
+        if (isNaN(num2)) {
+          throw new Error('Second number is invalid: ' + num2);
+        }
+
+        // Perform calculation
+        let result;
+        switch(op) {
+          case '+':
+            result = num1 + num2;
+            break;
+          case '-':
+            result = num1 - num2;
+            break;
+          case '*':
+            result = num1 * num2;
+            break;
+          case '/':
+            if (num2 === 0) {
+              throw new Error('❌ Division by zero!');
+            }
+            result = num1 / num2;
+            break;
+          default:
+            throw new Error('Invalid operation: ' + op + ' (must be +, -, *, or /)');
+        }
+
+        log('✅ Result:', result);
+
+        // Return result for dependent checks
+        return result;
+      `
+    },
+
+    // Step 8: Display the final result
+    "show-result": {
+      type: "log",
+      depends_on: ["calculate"],
+      level: "info",
+      message: `
+╔════════════════════════════════════════╗
+║        CALCULATION RESULT              ║
+╠════════════════════════════════════════╣
+║                                        ║
+║  {{ outputs['get-number1'] }} {{ outputs['get-operation'] }} {{ outputs['get-number2'] }} = {{ outputs['calculate'] }}
+║                                        ║
+╚════════════════════════════════════════╝
+      `
+    }
+  },
+
+  // Output configuration
+  output: {
+    pr_comment: {
+      format: "markdown",
+      group_by: "check",
+      collapse: false
+    }
+  }
+};
+
+// ============================================================================
+// CUSTOM HOOK IMPLEMENTATION
+// ============================================================================
+
+/**
+ * Custom readline-based input handler for SDK mode
+ * This shows how to implement your own input mechanism
+ */
+async function customHumanInputHandler(request: HumanInputRequest): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout
+    });
+
+    // Display a nice prompt
+    console.log('\n┌─────────────────────────────────────────────────────────┐');
+    const padding = 57 - request.prompt.length;
+    console.log(`│ 💬 ${request.prompt}${' '.repeat(Math.max(0, padding))}│`);
+    console.log('└─────────────────────────────────────────────────────────┘');
+
+    if (request.placeholder) {
+      console.log(`   ${request.placeholder}`);
+    }
+
+    rl.question('\n> ', (answer) => {
+      rl.close();
+
+      const trimmed = answer.trim();
+
+      // Handle empty input
+      if (!trimmed) {
+        if (request.allowEmpty) {
+          resolve(request.default || '');
+        } else if (request.default) {
+          console.log(`   (using default: ${request.default})`);
+          resolve(request.default);
+        } else {
+          console.log('   ❌ Empty input not allowed\n');
+          reject(new Error('Empty input not allowed'));
+        }
+      } else {
+        resolve(trimmed);
+      }
+    });
+
+    // Handle timeout if specified
+    if (request.timeout) {
+      setTimeout(() => {
+        rl.close();
+        if (request.default) {
+          console.log(`\n   ⏱️  Timeout - using default: ${request.default}`);
+          resolve(request.default);
+        } else {
+          reject(new Error('Input timeout'));
+        }
+      }, request.timeout);
+    }
+  });
+}
+
+// ============================================================================
+// MAIN EXECUTION
+// ============================================================================
+
+async function main() {
+  console.log('\n╔═══════════════════════════════════════════════════════════╗');
+  console.log('║      Visor SDK Calculator - Real Implementation          ║');
+  console.log('║      Human Input + Memory + JavaScript                   ║');
+  console.log('╚═══════════════════════════════════════════════════════════╝\n');
+
+  console.log('This is a real SDK example with:');
+  console.log('  ✓ Inline configuration (no YAML files needed)');
+  console.log('  ✓ Custom human-input hook using readline');
+  console.log('  ✓ Memory provider for state management');
+  console.log('  ✓ JavaScript execution for calculations');
+  console.log('  ✓ Full dependency chain with error handling\n');
+
+  console.log('═'.repeat(59));
+  console.log('Starting calculator workflow...');
+  console.log('═'.repeat(59));
+
+  try {
+    // Set up the human input hook
+    HumanInputCheckProvider.setHooks({
+      onHumanInput: customHumanInputHandler
+    });
+
+    // Create execution engine
+    const engine = new CheckExecutionEngine();
+
+    // Execute all checks in the workflow
+    const checksToRun = Object.keys(calculatorConfig.checks || {});
+
+    console.log(`\n📋 Running ${checksToRun.length} checks...\n`);
+
+    const result = await engine.executeChecks({
+      checks: checksToRun,
+      config: calculatorConfig,
+      outputFormat: 'json',
+      maxParallelism: 1, // Run sequentially for human input
+      debug: false
+    });
+
+    // Display results summary
+    console.log('\n═'.repeat(59));
+    console.log('✅ Calculator workflow completed successfully!');
+    console.log('═'.repeat(59));
+
+    console.log(`\n📊 Summary:`);
+    console.log(`   - Total checks: ${checksToRun.length}`);
+    console.log(`   - Execution time: ${result.executionTime}ms`);
+    console.log(`   - Timestamp: ${result.timestamp}`);
+    console.log(`   - Memory namespace: ${calculatorConfig.memory?.namespace}`);
+
+    // Access memory store to show final values
+    if (calculatorConfig.memory) {
+      const { MemoryStore } = await import('../src/memory-store');
+      const memoryStore = MemoryStore.getInstance(calculatorConfig.memory);
+
+      console.log('\n💾 Final memory state:');
+      const keys = memoryStore.list('calculator');
+      for (const key of keys) {
+        const value = memoryStore.get(key, 'calculator');
+        console.log(`   ${key}: ${value}`);
+      }
+    }
+
+  } catch (error) {
+    console.error('\n❌ Error running calculator:');
+    if (error instanceof Error) {
+      console.error(`   ${error.message}`);
+      if (error.stack) {
+        console.error(`\n${error.stack}`);
+      }
+    } else {
+      console.error(`   ${error}`);
+    }
+    process.exit(1);
+  }
+
+  console.log('\n✨ Done!\n');
+}
+
+// ============================================================================
+// ALTERNATIVE: Non-interactive mode for testing
+// ============================================================================
+
+/**
+ * Run calculator with predefined inputs (for testing/automation)
+ */
+async function runWithPredefinedInputs(num1: number, num2: number, op: string) {
+  console.log('\n🤖 Running in automated mode with predefined inputs...\n');
+
+  const inputs = [num1.toString(), num2.toString(), op];
+  let inputIndex = 0;
+
+  // Set up hook that uses predefined inputs
+  HumanInputCheckProvider.setHooks({
+    onHumanInput: async (request: HumanInputRequest) => {
+      const value = inputs[inputIndex++];
+      console.log(`${request.prompt} ${value}`);
+      return value;
+    }
+  });
+
+  // Run main workflow
+  await main();
+}
+
+// ============================================================================
+// ENTRY POINT
+// ============================================================================
+
+if (require.main === module) {
+  // Check for command line arguments for automated mode
+  const args = process.argv.slice(2);
+
+  if (args.length === 3) {
+    // Automated mode: node calculator-sdk-real.js 42 7 +
+    const [num1, num2, op] = args;
+    runWithPredefinedInputs(parseFloat(num1), parseFloat(num2), op)
+      .catch(err => {
+        console.error('Error:', err);
+        process.exit(1);
+      });
+  } else if (args.length > 0) {
+    console.error('Usage:');
+    console.error('  Interactive mode: ts-node calculator-sdk-real.ts');
+    console.error('  Automated mode:   ts-node calculator-sdk-real.ts <num1> <num2> <op>');
+    console.error('  Example:          ts-node calculator-sdk-real.ts 42 7 +');
+    process.exit(1);
+  } else {
+    // Interactive mode
+    main().catch(err => {
+      console.error('Error:', err);
+      process.exit(1);
+    });
+  }
+}
+
+// Export for use as a module
+export { calculatorConfig, customHumanInputHandler, main };

package/dist/examples/calculator-sdk-test.ts

@@ -0,0 +1,148 @@
+#!/usr/bin/env ts-node
+/**
+ * Automated test for calculator SDK example
+ * Tests fail_if validation with outputs from previous checks
+ */
+
+import { runChecks } from '../src/sdk';
+import { HumanInputCheckProvider } from '../src/providers/human-input-check-provider';
+import type { VisorConfig, HumanInputRequest } from '../src/types/config';
+
+// Calculator configuration
+const calculatorConfig: VisorConfig = {
+  version: '1.0',
+  checks: {
+    'get-number1': {
+      type: 'human-input',
+      prompt: 'Enter the first number:',
+      placeholder: 'e.g., 42',
+      allow_empty: false,
+    },
+
+    'store-number1': {
+      type: 'memory',
+      depends_on: ['get-number1'],
+      operation: 'set',
+      namespace: 'calculator',
+      key: 'number1',
+      value_js: "parseFloat(outputs['get-number1'])",
+    },
+
+    'get-number2': {
+      type: 'human-input',
+      depends_on: ['store-number1'],
+      prompt: 'Enter the second number:',
+      placeholder: 'e.g., 7',
+      allow_empty: false,
+    },
+
+    'store-number2': {
+      type: 'memory',
+      depends_on: ['get-number2'],
+      operation: 'set',
+      namespace: 'calculator',
+      key: 'number2',
+      value_js: "parseFloat(outputs['get-number2'])",
+    },
+
+    'get-operation': {
+      type: 'human-input',
+      depends_on: ['store-number2'],
+      prompt: 'Select operation (+, -, *, /):',
+      placeholder: 'Enter one of: + - * /',
+      allow_empty: false,
+    },
+
+    'store-operation': {
+      type: 'memory',
+      depends_on: ['get-operation'],
+      operation: 'set',
+      namespace: 'calculator',
+      key: 'operation',
+      value_js: "outputs['get-operation'].trim()",
+      // THIS IS THE KEY TEST: fail_if should have access to outputs['get-operation']
+      fail_if: "!['+', '-', '*', '/'].includes(outputs['get-operation'].trim())",
+    },
+
+    'calculate': {
+      type: 'script',
+      depends_on: ['store-operation'],
+      content: `
+        const num1 = memory.get('number1', 'calculator');
+        const num2 = memory.get('number2', 'calculator');
+        const op = memory.get('operation', 'calculator');
+
+        log('🔢 Calculating:', num1, op, num2);
+
+        let result;
+        switch(op) {
+          case '+': result = num1 + num2; break;
+          case '-': result = num1 - num2; break;
+          case '*': result = num1 * num2; break;
+          case '/': result = num1 / num2; break;
+          default: throw new Error('Invalid operation');
+        }
+
+        log('✅ Result:', result);
+        return result;
+      `,
+    },
+
+    'show-result': {
+      type: 'log',
+      depends_on: ['calculate'],
+      message: `Result: {{ outputs['get-number1'] }} {{ outputs['get-operation'] }} {{ outputs['get-number2'] }} = {{ outputs['calculate'] }}`,
+    },
+  },
+};
+
+async function runCalculatorTest() {
+  console.log('Testing calculator with fail_if validation...\n');
+
+  // Simulated user inputs
+  const inputs = {
+    'get-number1': '10',
+    'get-number2': '5',
+    'get-operation': '+',
+  };
+
+  let currentCheckId = '';
+
+  // Set up human-input hook
+  HumanInputCheckProvider.setHooks({
+    onHumanInput: async (request: HumanInputRequest) => {
+      currentCheckId = request.checkId;
+      const input = inputs[request.checkId as keyof typeof inputs];
+      console.log(`📝 ${request.prompt}`);
+      console.log(`   → ${input}\n`);
+      return input;
+    },
+  });
+
+  try {
+    // Execute checks using SDK
+    const result = await runChecks({
+      config: calculatorConfig,
+      checks: Object.keys(calculatorConfig.checks!),
+      outputFormat: 'table',
+      maxParallelism: 1,
+    });
+
+    console.log('\n✅ Test PASSED: All checks completed successfully!');
+    console.log(`   No fail_if errors detected`);
+    console.log(`   Result: 10 + 5 = 15\n`);
+
+    return 0;
+  } catch (error) {
+    console.error('\n❌ Test FAILED:', error);
+    return 1;
+  }
+}
+
+// Run test
+runCalculatorTest()
+  .then((code) => process.exit(code))
+  .catch((error) => {
+    console.error('Unexpected error:', error);
+    process.exit(1);
+  });

package/dist/examples/claude-code-config.yaml

@@ -0,0 +1,191 @@
+# Claude Code Provider Configuration Example
+# This example demonstrates how to use the Claude Code provider
+# for advanced AI-powered code reviews with MCP tools
+
+version: "1.0"
+project: claude-code-example
+language: typescript
+
+# Claude Code checks with various configurations
+steps:
+  # Basic Claude Code analysis
+  claude_security_review:
+    type: claude-code
+    group: security
+    prompt: |
+      Analyze this code for security vulnerabilities including:
+      - SQL injection risks
+      - XSS vulnerabilities
+      - Authentication/authorization issues
+      - Sensitive data exposure
+      - Input validation problems
+    claude_code:
+      allowedTools: ['Grep', 'Read']
+      maxTurns: 3
+      systemPrompt: "You are a senior security engineer conducting a thorough security audit."
+    on: [pr_opened, pr_updated]
+
+  # Architecture analysis with MCP tools
+  claude_architecture:
+    type: claude-code
+    group: architecture
+    prompt: |
+      Analyze the code architecture and provide insights on:
+      - Code organization and structure
+      - Design patterns usage
+      - Coupling and cohesion
+      - Modularity and maintainability
+    claude_code:
+      allowedTools:
+        - Read
+        - Grep
+        - analyze_file_structure
+        - detect_patterns
+        - calculate_complexity
+      maxTurns: 5
+      systemPrompt: "You are a software architect reviewing code for best practices."
+    on: [pr_opened, pr_updated]
+
+  # Performance analysis with custom MCP server
+  claude_performance:
+    type: claude-code
+    group: performance
+    prompt: |
+      Review the code for performance issues:
+      - Algorithm efficiency
+      - Database query optimization
+      - Memory leaks and management
+      - Caching opportunities
+      - Async/await patterns
+    claude_code:
+      allowedTools:
+        - Read
+        - Grep
+        - calculate_complexity
+        - suggest_improvements
+      maxTurns: 4
+      systemPrompt: "Focus on performance bottlenecks and optimization opportunities."
+      # Custom MCP server for performance profiling
+      mcpServers:
+        perf_analyzer:
+          command: "node"
+          args: ["./tools/performance-analyzer.js"]
+          env:
+            PROFILE_MODE: "detailed"
+    on: [pr_opened, pr_updated]
+
+  # Code quality with web search
+  claude_quality:
+    type: claude-code
+    group: quality
+    prompt: |
+      Assess overall code quality:
+      - Naming conventions and readability
+      - Documentation completeness
+      - Test coverage assessment
+      - Error handling
+      - Code duplication
+      Search for best practices if needed.
+    claude_code:
+      allowedTools:
+        - Read
+        - Grep
+        - WebSearch
+        - detect_patterns
+        - suggest_improvements
+      maxTurns: 6
+      systemPrompt: "You are a code quality expert. Use web search to find current best practices when needed."
+    on: [pr_opened, pr_updated]
+
+  # Dependency analysis with session reuse
+  claude_dependencies:
+    type: claude-code
+    group: dependencies
+    prompt: |
+      Analyze the project dependencies:
+      - Outdated packages
+      - Security vulnerabilities in dependencies
+      - Unused dependencies
+      - Missing peer dependencies
+    claude_code:
+      allowedTools:
+        - Read
+        - Grep
+        - WebSearch
+      maxTurns: 3
+    depends_on: [claude_quality]
+    reuse_ai_session: true  # Reuse session from quality check
+    on: [pr_opened, pr_updated]
+
+  # Advanced review with subagent
+  claude_comprehensive:
+    type: claude-code
+    group: comprehensive
+    prompt: |
+      Perform a comprehensive code review covering all aspects.
+      Delegate specific tasks to specialized subagents as needed.
+    claude_code:
+      allowedTools:
+        - Read
+        - Grep
+        - WebSearch
+        - analyze_file_structure
+        - detect_patterns
+        - calculate_complexity
+        - suggest_improvements
+      maxTurns: 10
+      systemPrompt: "You are the lead code reviewer. Use all available tools and delegate to subagents."
+      # Subagent for specialized tasks
+      subagent: "./.claude/agents/code-reviewer.md"
+      # Hooks for custom processing
+      hooks:
+        onStart: "echo 'Starting comprehensive Claude Code review'"
+        onToolUse: "./hooks/log-tool-usage.sh"
+        onEnd: "echo 'Comprehensive review complete'"
+    on: [manual]  # Run manually due to high resource usage
+
+# Output configuration
+output:
+  # PR comment format
+  pr_comment:
+    enabled: true
+    update_existing: true
+    group_by: group
+
+  # Multiple output formats
+  format: table
+
+  # Save detailed reports
+  file:
+    enabled: true
+    path: "./reports/claude-review-{{date}}.md"
+    format: markdown
+
+# Global AI settings (fallback for non-Claude checks)
+ai_provider: google
+ai_model: gemini-pro
+
+# Failure conditions
+fail_if: "criticalIssues > 0 || securityIssues > 5"
+
+# Custom MCP server configuration
+# This can be extended in .mcp.json for more servers
+mcp_config:
+  servers:
+    code_analyzer:
+      command: "python"
+      args: ["./mcp/analyzer.py"]
+      env:
+        ANALYSIS_LEVEL: "deep"
+
+    security_scanner:
+      command: "node"
+      args: ["./mcp/security.js"]
+      env:
+        SCAN_MODE: "full"
+
+# Environment variables for checks
+env:
+  ANALYSIS_DEPTH: "comprehensive"
+  INCLUDE_SUGGESTIONS: "true"
+  MAX_FILE_SIZE: "1000000"