@ipation/specbridge 2.0.0 → 2.2.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import { SourceFile, Project } from 'ts-morph';
 import { Document } from 'yaml';
+import { Application } from 'express';
 export { minimatch } from 'minimatch';
 
 /**
@@ -179,7 +180,7 @@ interface LevelConfig {
  * Warning during verification (non-blocking)
  */
 interface VerificationWarning {
-    type: 'missing_verifier' | 'invalid_pattern' | 'other';
+    type: 'missing_verifier' | 'invalid_pattern' | 'invalid_params' | 'other';
     message: string;
     decisionId: string;
     constraintId: string;
@@ -1540,7 +1541,7 @@ declare class VerificationEngine {
     /**
      * Verify a single file
      */
-    verifyFile(filePath: string, decisions: Decision[], severityFilter?: Severity[], cwd?: string, reporter?: ExplainReporter): Promise<{
+    verifyFile(filePath: string, decisions: Decision[], severityFilter?: Severity[], cwd?: string, reporter?: ExplainReporter, signal?: AbortSignal): Promise<{
         violations: Violation[];
         warnings: VerificationWarning[];
         errors: VerificationIssue[];
@@ -1595,6 +1596,8 @@ interface VerificationContext {
     sourceFile: SourceFile;
     constraint: Constraint;
     decisionId: string;
+    /** Optional AbortSignal for cancellation support */
+    signal?: AbortSignal;
 }
 /**
  * Verifier interface - all verifiers must implement this
@@ -1883,6 +1886,23 @@ interface ReportOptions {
     /** Use v1.3 compliance formula instead of v2.0 severity-weighted formula */
     legacyCompliance?: boolean;
 }
+/**
+ * Generic verification result shape for Reporter class
+ * Supports various result formats from different verification engines
+ */
+interface ReporterResult {
+    violations?: Violation[];
+    summary?: {
+        totalViolations?: number;
+        decisionsChecked?: number;
+        filesChecked?: number;
+        critical?: number;
+        high?: number;
+        medium?: number;
+        low?: number;
+        duration?: number;
+    };
+}
 /**
  * Generate a compliance report
  */
@@ -1901,7 +1921,7 @@ declare class Reporter {
     /**
      * Generate formatted report from verification result
      */
-    generate(result: any, options?: {
+    generate(result: ReporterResult, options?: {
         format?: 'table' | 'json' | 'markdown';
         includePassedChecks?: boolean;
         groupBy?: 'severity' | 'file';
@@ -1910,7 +1930,7 @@ declare class Reporter {
     /**
      * Generate compliance overview from multiple results
      */
-    generateComplianceReport(results: any[]): string;
+    generateComplianceReport(results: ReporterResult[]): string;
     private formatAsTable;
     private formatAsTableGrouped;
     private formatAsMarkdown;
@@ -2083,7 +2103,7 @@ declare class AgentContextGenerator {
      * Generate context from decisions
      */
     generateContext(options: {
-        decisions: any[];
+        decisions: Decision[];
         filePattern?: string;
         format?: 'markdown' | 'plain' | 'json';
         concise?: boolean;
@@ -2094,15 +2114,15 @@ declare class AgentContextGenerator {
      * Generate prompt suffix for AI agents
      */
     generatePromptSuffix(options: {
-        decisions: any[];
+        decisions: Decision[];
     }): string;
     /**
      * Extract relevant decisions for a specific file
      */
     extractRelevantDecisions(options: {
-        decisions: any[];
+        decisions: Decision[];
         filePath: string;
-    }): any[];
+    }): Decision[];
 }
 
 /**
@@ -2233,4 +2253,160 @@ declare function matchesAnyPattern(filePath: string, patterns: string[], options
     cwd?: string;
 }): boolean;
 
-export { type AffectedFile, type AgentContext, AgentContextGenerator, AlreadyInitializedError, type Analyzer, AnalyzerNotFoundError, ApiVerifier, type ApplicableConstraint, type ApplicableDecision, AstCache, AutofixEngine, type AutofixPatch, type AutofixResult, CodeScanner, ComplexityVerifier, type ComplianceReport, ConfigError, type Constraint, type ConstraintCheck, ConstraintCheckSchema, type ConstraintCheckSchema_, type ConstraintException, ConstraintExceptionSchema, type ConstraintExceptionSchema_, ConstraintSchema, type ConstraintSchema_, type ConstraintType, ConstraintTypeSchema, type ConstraintTypeSchema_, type ContextOptions, type Decision, type DecisionCompliance, type DecisionContent, DecisionContentSchema, type DecisionContentSchema_, type DecisionFilter, type DecisionMetadata, DecisionMetadataSchema, type DecisionMetadataSchema_, DecisionNotFoundError, DecisionSchema, type DecisionStatus, DecisionStatusSchema, type DecisionStatusSchema_, type DecisionTypeSchema, DecisionValidationError, type DependencyGraph, DependencyVerifier, type DriftAnalysis, ErrorsAnalyzer, ErrorsVerifier, FileSystemError, type GlobOptions, type GraphNode, HookError, type ImpactAnalysis, ImportsAnalyzer, ImportsVerifier, InferenceEngine, InferenceError, type InferenceOptions, type InferenceResult, type LevelConfig, LinksSchema, type LoadError, type LoadResult, type LoadedDecision, type McpServerOptions, type MigrationStep, NamingAnalyzer, NamingVerifier, NotInitializedError, type OverallDrift, type Pattern, type PatternExample, type PromptTemplate, PropagationEngine, type PropagationOptions, RegexVerifier, Registry, type RegistryConstraintMatch, RegistryError, type RegistryOptions, type ReportOptions, ReportStorage, Reporter, type ScanOptions, type ScanResult, type ScannedFile, SecurityVerifier, type Severity, SeveritySchema, type SeveritySchema_, type SpecBridgeConfig, SpecBridgeConfigSchema, type SpecBridgeConfigType, SpecBridgeError, SpecBridgeMcpServer, type StoredReport, StructureAnalyzer, type TextEdit, type TrendAnalysis, type TrendData, type TrendDirection, type VerificationConfig, VerificationConfigSchema, type VerificationConfigSchema_, type VerificationContext, VerificationEngine, VerificationError, type VerificationFrequency, VerificationFrequencySchema, type VerificationFrequencySchema_, type VerificationIssue, type VerificationLevel, type VerificationOptions, type VerificationResult, type VerificationWarning, type Verifier, VerifierNotFoundError, type VerifierPlugin, type VerifierPluginMetadata, type Violation, type ViolationFix, analyzeTrend, buildDependencyGraph, builtinAnalyzers, builtinVerifiers, calculateConfidence, checkDegradation, clearVerifierPool, createInferenceEngine, createPattern, createPropagationEngine, createRegistry, createScannerFromConfig, createVerificationEngine, createViolation, defaultConfig, defineVerifierPlugin, detectDrift, ensureDir, extractSnippet, formatConsoleReport, formatContextAsJson, formatContextAsMarkdown, formatContextAsMcp, formatError, formatMarkdownReport, formatValidationErrors, generateContext, generateFormattedContext, generateReport, getAffectedFiles, getAffectingDecisions, getAnalyzer, getAnalyzerIds, getChangedFiles, getConfigPath, getDecisionsDir, getInferredDir, getReportsDir, getSpecBridgeDir, getTransitiveDependencies, getVerifier, getVerifierIds, getVerifiersDir, glob, isConstraintExcepted, isDirectory, loadConfig, loadDecisionFile, loadDecisionsFromDir, matchesAnyPattern, matchesPattern, mergeWithDefaults, normalizePath, parseYaml, parseYamlDocument, pathExists, readFilesInDir, readTextFile, runInference, selectVerifierForConstraint, shouldApplyConstraintToFile, stringifyYaml, templates, updateYamlDocument, validateConfig, validateDecision, validateDecisionFile, writeTextFile };
+/**
+ * Analytics engine - Provide insights into compliance trends and decision impact
+ */
+
+interface DecisionMetrics {
+    decisionId: string;
+    title: string;
+    totalViolations: number;
+    violationsByFile: Map<string, number>;
+    violationsBySeverity: Record<Severity, number>;
+    mostViolatedConstraint: {
+        id: string;
+        count: number;
+    } | null;
+    averageComplianceScore: number;
+    trendDirection: 'up' | 'down' | 'stable';
+    history: Array<{
+        date: string;
+        compliance: number;
+        violations: number;
+    }>;
+}
+interface Insight {
+    type: 'warning' | 'info' | 'success';
+    category: 'compliance' | 'trend' | 'hotspot' | 'suggestion';
+    message: string;
+    details?: string;
+    decisionId?: string;
+}
+interface AnalyticsSummary {
+    totalDecisions: number;
+    averageCompliance: number;
+    overallTrend: 'up' | 'down' | 'stable';
+    criticalIssues: number;
+    topDecisions: Array<{
+        decisionId: string;
+        title: string;
+        compliance: number;
+    }>;
+    bottomDecisions: Array<{
+        decisionId: string;
+        title: string;
+        compliance: number;
+    }>;
+    insights: Insight[];
+}
+/**
+ * Analytics engine for compliance data
+ */
+declare class AnalyticsEngine {
+    /**
+     * Analyze a specific decision across historical reports
+     */
+    analyzeDecision(decisionId: string, history: StoredReport[]): Promise<DecisionMetrics>;
+    /**
+     * Generate insights from historical data
+     */
+    generateInsights(history: StoredReport[]): Promise<Insight[]>;
+    /**
+     * Generate analytics summary
+     */
+    generateSummary(history: StoredReport[]): Promise<AnalyticsSummary>;
+}
+
+/**
+ * Dashboard server - Compliance dashboard backend with REST API
+ */
+
+interface DashboardOptions {
+    cwd: string;
+    config: SpecBridgeConfig;
+}
+/**
+ * Dashboard Server with caching
+ */
+declare class DashboardServer {
+    private app;
+    private cwd;
+    private config;
+    private registry;
+    private reportStorage;
+    private cachedReport;
+    private cacheTimestamp;
+    private readonly CACHE_TTL;
+    private refreshInterval;
+    constructor(options: DashboardOptions);
+    /**
+     * Start the server with background cache refresh
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the server and clear intervals
+     */
+    stop(): void;
+    /**
+     * Refresh the cached report
+     */
+    private refreshCache;
+    /**
+     * Get the Express app instance
+     */
+    getApp(): Application;
+    /**
+     * Setup middleware
+     */
+    private setupMiddleware;
+    /**
+     * Setup all routes
+     */
+    private setupRoutes;
+    /**
+     * Setup report-related routes
+     */
+    private setupReportRoutes;
+    /**
+     * Setup decision-related routes
+     */
+    private setupDecisionRoutes;
+    /**
+     * Setup analytics-related routes
+     */
+    private setupAnalyticsRoutes;
+    /**
+     * Setup health check route
+     */
+    private setupHealthRoute;
+    /**
+     * Setup static file serving
+     */
+    private setupStaticFiles;
+}
+/**
+ * Create and configure the dashboard server (factory function)
+ * @returns DashboardServer instance
+ */
+declare function createDashboardServer(options: DashboardOptions): DashboardServer;
+
+interface LspServerOptions {
+    cwd: string;
+    verbose?: boolean;
+}
+
+declare function startLspServer(options: LspServerOptions): Promise<void>;
+
+/**
+ * GitHub integration helpers (optional)
+ */
+
+interface GitHubPrCommentOptions {
+    repo: string;
+    pr: number;
+    token: string;
+}
+declare function formatViolationsForGitHub(violations: Violation[], limit?: number): string;
+declare function postPrComment(violations: Violation[], options: GitHubPrCommentOptions): Promise<void>;
+
+export { type AffectedFile, type AgentContext, AgentContextGenerator, AlreadyInitializedError, AnalyticsEngine, type AnalyticsSummary, type Analyzer, AnalyzerNotFoundError, ApiVerifier, type ApplicableConstraint, type ApplicableDecision, AstCache, AutofixEngine, type AutofixPatch, type AutofixResult, CodeScanner, ComplexityVerifier, type ComplianceReport, ConfigError, type Constraint, type ConstraintCheck, ConstraintCheckSchema, type ConstraintCheckSchema_, type ConstraintException, ConstraintExceptionSchema, type ConstraintExceptionSchema_, ConstraintSchema, type ConstraintSchema_, type ConstraintType, ConstraintTypeSchema, type ConstraintTypeSchema_, type ContextOptions, DashboardServer, type Decision, type DecisionCompliance, type DecisionContent, DecisionContentSchema, type DecisionContentSchema_, type DecisionFilter, type DecisionMetadata, DecisionMetadataSchema, type DecisionMetadataSchema_, type DecisionMetrics, DecisionNotFoundError, DecisionSchema, type DecisionStatus, DecisionStatusSchema, type DecisionStatusSchema_, type DecisionTypeSchema, DecisionValidationError, type DependencyGraph, DependencyVerifier, type DriftAnalysis, ErrorsAnalyzer, ErrorsVerifier, FileSystemError, type GitHubPrCommentOptions, type GlobOptions, type GraphNode, HookError, type ImpactAnalysis, ImportsAnalyzer, ImportsVerifier, InferenceEngine, InferenceError, type InferenceOptions, type InferenceResult, type Insight, type LevelConfig, LinksSchema, type LoadError, type LoadResult, type LoadedDecision, type McpServerOptions, type MigrationStep, NamingAnalyzer, NamingVerifier, NotInitializedError, type OverallDrift, type Pattern, type PatternExample, type PromptTemplate, PropagationEngine, type PropagationOptions, RegexVerifier, Registry, type RegistryConstraintMatch, RegistryError, type RegistryOptions, type ReportOptions, ReportStorage, Reporter, type ReporterResult, type ScanOptions, type ScanResult, type ScannedFile, SecurityVerifier, type Severity, SeveritySchema, type SeveritySchema_, type SpecBridgeConfig, SpecBridgeConfigSchema, type SpecBridgeConfigType, SpecBridgeError, SpecBridgeMcpServer, type StoredReport, StructureAnalyzer, type TextEdit, type TrendAnalysis, type TrendData, type TrendDirection, type VerificationConfig, VerificationConfigSchema, type VerificationConfigSchema_, type VerificationContext, VerificationEngine, VerificationError, type VerificationFrequency, VerificationFrequencySchema, type VerificationFrequencySchema_, type VerificationIssue, type VerificationLevel, type VerificationOptions, type VerificationResult, type VerificationWarning, type Verifier, VerifierNotFoundError, type VerifierPlugin, type VerifierPluginMetadata, type Violation, type ViolationFix, analyzeTrend, buildDependencyGraph, builtinAnalyzers, builtinVerifiers, calculateConfidence, checkDegradation, clearVerifierPool, createDashboardServer, createInferenceEngine, createPattern, createPropagationEngine, createRegistry, createScannerFromConfig, createVerificationEngine, createViolation, defaultConfig, defineVerifierPlugin, detectDrift, ensureDir, extractSnippet, formatConsoleReport, formatContextAsJson, formatContextAsMarkdown, formatContextAsMcp, formatError, formatMarkdownReport, formatValidationErrors, formatViolationsForGitHub, generateContext, generateFormattedContext, generateReport, getAffectedFiles, getAffectingDecisions, getAnalyzer, getAnalyzerIds, getChangedFiles, getConfigPath, getDecisionsDir, getInferredDir, getReportsDir, getSpecBridgeDir, getTransitiveDependencies, getVerifier, getVerifierIds, getVerifiersDir, glob, isConstraintExcepted, isDirectory, loadConfig, loadDecisionFile, loadDecisionsFromDir, matchesAnyPattern, matchesPattern, mergeWithDefaults, normalizePath, parseYaml, parseYamlDocument, pathExists, postPrComment, readFilesInDir, readTextFile, runInference, selectVerifierForConstraint, shouldApplyConstraintToFile, startLspServer, stringifyYaml, templates, updateYamlDocument, validateConfig, validateDecision, validateDecisionFile, writeTextFile };