@dallask/a11y-mcp-srv 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,792 @@
+/**
+ * TypeScript type definitions
+ * Shared types for the Accessibility MCP Server
+ */
+/**
+ * Accessibility rule data structure from the accessibility engine
+ */
+/**
+ * Impact/severity level for an issue. Uses each engine's native levels (no mapping).
+ *
+ * axe-core: critical | serious | moderate | minor
+ * ACE (IBM Equal Access): violation | potentialviolation | potentialrecommendation | recommendation | manual | pass
+ */
+export type ImpactLevel = string;
+export interface AccessibilityRuleData {
+    count: number;
+    xpaths: string[];
+    selectors?: (string | boolean)[];
+    text?: any[];
+    hidden?: boolean[];
+    description?: string;
+    domInfo?: DOMInfo[];
+    contrastdata?: any[];
+    tags?: string[];
+    /** Engine-reported impact (axe: critical/serious/moderate/minor; ACE: violation/potentialviolation/...) */
+    impact?: ImpactLevel;
+}
+/**
+ * Default impact order for sorting and scoring (higher = worse).
+ * axe: critical, serious, moderate, minor. ACE: violation, potentialviolation, potentialrecommendation, recommendation, manual, pass.
+ */
+export declare const IMPACT_ORDER: Record<string, number>;
+/**
+ * DOM information for an element
+ */
+export interface DOMInfo {
+    tagName?: string;
+    id?: string | null;
+    className?: string | null;
+    textContent?: string | null;
+    innerHTML?: string | null;
+    attributes?: Record<string, string>;
+    selector?: string;
+    error?: string;
+}
+/**
+ * Accessibility category structure (error, contrast, etc.)
+ */
+export interface AccessibilityCategory {
+    count: number;
+    items: Record<string, AccessibilityRuleData>;
+}
+/**
+ * Accessibility report structure containing categories
+ */
+export interface AccessibilityReport {
+    error?: AccessibilityCategory;
+    contrast?: AccessibilityCategory;
+    [key: string]: AccessibilityCategory | undefined;
+}
+/**
+ * Test engine metadata
+ */
+export interface TestEngine {
+    name: string;
+    version: string;
+}
+/**
+ * Test runner metadata
+ */
+export interface TestRunner {
+    name: string;
+}
+/**
+ * Test environment information
+ */
+export interface TestEnvironment {
+    userAgent: string;
+    windowWidth: number;
+    windowHeight: number;
+    orientationType?: string;
+    orientationAngle?: number;
+}
+/**
+ * Complete accessibility results structure
+ */
+export interface AccessibilityResults {
+    url: string;
+    timestamp: string;
+    testEngine: TestEngine;
+    testRunner: TestRunner;
+    testEnvironment: TestEnvironment;
+    violations: AccessibilityReport;
+}
+/**
+ * Test metadata structure
+ */
+export interface TestMetadata {
+    testEngine: TestEngine;
+    testRunner: TestRunner;
+    testEnvironment: TestEnvironment;
+    timestamp: string;
+    url: string;
+}
+/**
+ * WCAG compliance levels
+ */
+export type WCAGLevel = 'A' | 'AA' | 'AAA';
+/**
+ * WCAG compliance status
+ */
+export type ComplianceStatus = 'pass' | 'fail' | 'partial';
+/**
+ * Fix suggestion with code examples
+ */
+export interface FixSuggestion {
+    current: string;
+    suggested: string;
+    explanation: string;
+}
+/**
+ * Prioritized accessibility issue
+ */
+export interface PrioritizedIssue {
+    ruleId: string;
+    impact: ImpactLevel;
+    description: string;
+    wcagLevel: string;
+    tags: string[];
+    element: string;
+    xpath: string;
+    /** CSS class selector for the element (e.g. ".isi-btn.jsIsiMinimize") */
+    classSelector?: string;
+    fix: FixSuggestion;
+    userImpact: string;
+    priority: number;
+    category?: string;
+    helpUrl?: string;
+}
+/**
+ * Quick win - easy fix with high impact
+ */
+export interface QuickWin {
+    ruleId: string;
+    description: string;
+    impact: ImpactLevel;
+    fix: FixSuggestion;
+    estimatedTime: string;
+    affectedElements: number;
+}
+/**
+ * Critical blocker - must fix before launch
+ */
+export interface CriticalBlocker {
+    ruleId: string;
+    description: string;
+    impact: ImpactLevel;
+    userImpact: string;
+    affectedElements: number;
+    wcagLevel: string;
+}
+/**
+ * WCAG compliance breakdown
+ */
+export interface WCAGCompliance {
+    A: number;
+    AA: number;
+    AAA: number;
+}
+/**
+ * Summary statistics for audit results
+ */
+export interface AuditSummary {
+    totalIssues: number;
+    score: number;
+    wcagCompliance: WCAGCompliance;
+    byCategory: Record<string, number>;
+    byImpact: Record<string, number>;
+}
+/**
+ * Applied filters information
+ */
+export interface AppliedFilters {
+    tags?: string[];
+    originalIssueCount?: number;
+}
+/**
+ * Complete audit result structure
+ */
+export interface AuditResult {
+    summary: AuditSummary;
+    prioritizedIssues: PrioritizedIssue[];
+    appliedFilters?: AppliedFilters;
+    conversationalSummary: string;
+    issuesTable: string;
+    quickWins: QuickWin[];
+    criticalBlockers: CriticalBlocker[];
+    metadata?: TestMetadata;
+    rawResults?: AccessibilityResults;
+    /** HTTP status of the audited page (e.g. 200, 401). Set when Basic Auth or response is checked. */
+    responseStatus?: number;
+}
+/**
+ * Login selectors for custom login forms
+ */
+export interface LoginSelectors {
+    usernameSelector?: string;
+    passwordSelector?: string;
+    submitSelector?: string;
+    successIndicator?: string;
+}
+/**
+ * Session configuration
+ */
+export interface SessionConfig {
+    domain: string;
+    loginUrl?: string;
+    username: string;
+    password: string;
+    loginSelectors?: LoginSelectors;
+    sessionId?: string;
+}
+/**
+ * Active session information
+ */
+export interface Session {
+    sessionId: string;
+    domain: string;
+    createdAt: string;
+    expiresAt: string;
+    testUrl?: string;
+    isActive: boolean;
+}
+/**
+ * Session creation result
+ */
+export interface SessionResult {
+    sessionId: string;
+    expiresAt: string;
+    testUrl: string;
+}
+/**
+ * Wait strategy for page loading
+ */
+export type WaitStrategy = 'networkidle' | 'load' | 'domcontentloaded';
+/**
+ * Audit strategy for site-wide audits
+ */
+export type AuditStrategy = 'critical' | 'comprehensive' | 'custom';
+/**
+ * Accessibility engine: axe-core (Deque) or IBM Equal Access (ACE)
+ */
+export type AccessibilityEngine = 'axe' | 'ace';
+/**
+ * Single URL audit input
+ */
+export interface AuditUrlInput {
+    url: string;
+    domain?: string;
+    tags?: string[];
+    waitForLoad?: WaitStrategy;
+    timeout?: number;
+    engine?: AccessibilityEngine;
+    /** HTTP Basic Auth username. Use with basicAuthPassword for sites that require Basic Authentication. */
+    basicAuthUsername?: string;
+    /** HTTP Basic Auth password. Use with basicAuthUsername for sites that require Basic Authentication. */
+    basicAuthPassword?: string;
+}
+/**
+ * Multiple URLs audit input
+ */
+export interface AuditMultipleUrlsInput {
+    urls: string[] | string;
+    domain?: string;
+    parallel?: number;
+    continueOnError?: boolean;
+    tags?: string[];
+    engine?: AccessibilityEngine;
+    /** HTTP Basic Auth username for all URLs. Use with basicAuthPassword when sites require Basic Authentication. */
+    basicAuthUsername?: string;
+    /** HTTP Basic Auth password. Use with basicAuthUsername. */
+    basicAuthPassword?: string;
+}
+/**
+ * Site audit input
+ */
+export interface AuditSiteInput {
+    domain: string;
+    tags?: string[];
+    strategy?: AuditStrategy;
+    maxPages?: number;
+    priorityPaths?: string[];
+}
+/**
+ * Authenticated audit input
+ */
+export interface AuditWithSessionInput {
+    sessionId: string;
+    url: string;
+    domain?: string;
+    tags?: string[];
+}
+/**
+ * Score calculation input
+ */
+export interface ScoreInput {
+    results: AuditResult | string;
+    weights?: Record<string, number>;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Score result
+ */
+export interface ScoreResult {
+    overallScore: number;
+    breakdown: Record<string, number>;
+    wcagCompliance: WCAGCompliance;
+    trend?: TrendData;
+}
+/**
+ * Prioritization criteria
+ */
+export type PrioritizationCriteria = 'impact' | 'wcag' | 'fixability' | 'user-impact';
+/**
+ * Prioritize issues input
+ */
+export interface PrioritizeIssuesInput {
+    results: AuditResult;
+    criteria?: PrioritizationCriteria;
+    limit?: number;
+}
+/**
+ * Prioritize issues result
+ */
+export interface PrioritizeIssuesResult {
+    prioritized: PrioritizedIssue[];
+    quickWins: QuickWin[];
+    criticalBlockers: CriticalBlocker[];
+    reasoning: string;
+}
+/**
+ * Explain issue input
+ */
+export interface ExplainIssueInput {
+    ruleId: string;
+    context?: string;
+}
+/**
+ * Issue explanation result
+ */
+export interface IssueExplanation {
+    ruleId: string;
+    explanation: string;
+    userImpact: string;
+    howToFix: string;
+    wcagReference: string;
+    commonMistakes: string[];
+    codeExample?: {
+        before: string;
+        after: string;
+    };
+}
+/**
+ * Quick fixes input
+ */
+export interface QuickFixesInput {
+    results: AuditResult | string;
+    format?: 'markdown' | 'html' | 'json';
+    includeCode?: boolean;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Quick fix item
+ */
+export interface QuickFixItem {
+    ruleId: string;
+    description: string;
+    currentCode?: string;
+    fixedCode?: string;
+    explanation: string;
+    impactEstimate: string;
+    affectedElements: number;
+}
+/**
+ * Quick fixes result
+ */
+export interface QuickFixesResult {
+    fixes: QuickFixItem[];
+    format: 'markdown' | 'html' | 'json';
+    totalFixes: number;
+    formatted?: string;
+}
+/**
+ * Comparison input
+ */
+export interface CompareAccessibilityInput {
+    before: AuditResult | string;
+    after: AuditResult | string;
+    format?: 'summary' | 'detailed' | 'diff';
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Comparison result
+ */
+export interface ComparisonResult {
+    issuesFixed: PrioritizedIssue[];
+    issuesIntroduced: PrioritizedIssue[];
+    scoreImprovement: number;
+    remainingIssues: PrioritizedIssue[];
+    summary: string;
+    format: 'summary' | 'detailed' | 'diff';
+}
+/**
+ * Tracking timeframe
+ */
+export type TrackingTimeframe = '7d' | '30d' | '90d' | 'all';
+/**
+ * Tracking metric
+ */
+export type TrackingMetric = 'score' | 'issues' | 'wcag-compliance';
+/**
+ * Track accessibility input
+ */
+export interface TrackAccessibilityInput {
+    url: string;
+    timeframe?: TrackingTimeframe;
+    metric?: TrackingMetric;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Trend data point
+ */
+export interface TrendDataPoint {
+    timestamp: string;
+    value: number;
+    metadata?: Record<string, any>;
+}
+/**
+ * Trend data
+ */
+export interface TrendData {
+    dataPoints: TrendDataPoint[];
+    trend: 'improving' | 'declining' | 'stable';
+    prediction?: {
+        nextValue: number;
+        confidence: number;
+    };
+    recommendations: string[];
+    visualization?: string;
+}
+/**
+ * Track accessibility result
+ */
+export interface TrackAccessibilityResult {
+    url: string;
+    historicalData: TrendData;
+    currentValue: number;
+    trend: TrendData['trend'];
+    predictions?: TrendData['prediction'];
+    recommendations: string[];
+    visualization?: string;
+}
+/**
+ * Compliance report format
+ */
+export type ComplianceReportFormat = 'VPAT' | 'WCAG' | 'ADA' | 'Section508';
+/**
+ * Generate compliance report input
+ */
+export interface GenerateComplianceReportInput {
+    results: AuditResult;
+    format?: ComplianceReportFormat;
+    level?: WCAGLevel;
+    includeRemediation?: boolean;
+}
+/**
+ * Compliance report result
+ */
+export interface ComplianceReport {
+    format: ComplianceReportFormat;
+    level: WCAGLevel;
+    executiveSummary: string;
+    wcagMapping: Record<string, ComplianceStatus>;
+    remediationPlan?: QuickFixItem[];
+    compliancePercentage: number;
+    reportContent: string;
+}
+/**
+ * WCAG compliance input
+ */
+export interface WCAGComplianceInput {
+    results: AuditResult | string;
+    level?: WCAGLevel;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * WCAG criterion breakdown
+ */
+export interface WCAGCriterion {
+    criterion: string;
+    title: string;
+    level: WCAGLevel;
+    status: ComplianceStatus;
+    violations: PrioritizedIssue[];
+}
+/**
+ * WCAG compliance result
+ */
+export interface WCAGComplianceResult {
+    level: WCAGLevel;
+    status: ComplianceStatus;
+    compliancePercentage: number;
+    criteria: WCAGCriterion[];
+    missingRequirements: string[];
+    summary: string;
+}
+/**
+ * Progress update for long-running operations
+ */
+export interface ProgressUpdate {
+    current: number;
+    total: number;
+    percentage: number;
+    status: string;
+    estimatedTimeRemaining?: number;
+    currentItem?: string;
+}
+/**
+ * Batch audit progress
+ */
+export interface BatchAuditProgress extends ProgressUpdate {
+    completedUrls: string[];
+    failedUrls: string[];
+    currentUrl?: string;
+}
+/**
+ * Error result structure
+ */
+export interface AuditError {
+    url: string;
+    error: string;
+    timestamp: string;
+    stack?: string;
+}
+/**
+ * Supported accessibility tags
+ */
+export type AccessibilityTag = 'wcag2a' | 'wcag2aa' | 'wcag2aaa' | 'wcag21a' | 'wcag21aa' | 'wcag21aaa' | 'wcag22a' | 'wcag22aa' | 'wcag22aaa' | 'best-practice';
+/**
+ * Tag filter configuration
+ */
+export interface TagFilter {
+    tags: AccessibilityTag[];
+    mode?: 'include' | 'exclude';
+}
+/**
+ * Export to CSV input
+ */
+export interface ExportToCsvInput {
+    results: AuditResult | string;
+    includeMetadata?: boolean;
+    includeViolations?: boolean;
+    format?: 'standard' | 'detailed' | 'minimal';
+    /** HTTP Basic Auth username when results is a URL. Use with basicAuthPassword. Can be in URL as https://user:password@host/. */
+    basicAuthUsername?: string;
+    /** HTTP Basic Auth password when results is a URL. Use with basicAuthUsername. */
+    basicAuthPassword?: string;
+}
+/**
+ * Export to CSV result
+ */
+export interface ExportToCsvResult {
+    csv: string;
+    format: 'standard' | 'detailed' | 'minimal';
+    totalIssues: number;
+    includeMetadata: boolean;
+    includeViolations: boolean;
+}
+/**
+ * Export to Excel input
+ */
+export interface ExportToExcelInput {
+    results: AuditResult | string;
+    includeCharts?: boolean;
+    formatting?: boolean;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Export to Excel result
+ */
+export interface ExportToExcelResult {
+    excel: string;
+    format: 'xlsx';
+    totalIssues: number;
+    includeCharts: boolean;
+    formatting: boolean;
+}
+/**
+ * Export to JSON input
+ */
+export interface ExportToJsonInput {
+    results: AuditResult | string;
+    pretty?: boolean;
+    includeRaw?: boolean;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Export to JSON result
+ */
+export interface ExportToJsonResult {
+    json: string;
+    pretty: boolean;
+    includeRaw: boolean;
+    totalIssues: number;
+}
+/**
+ * Export to HTML input
+ */
+export interface ExportToHtmlInput {
+    results: AuditResult | string;
+    template?: 'default' | 'minimal' | 'detailed';
+    includeCharts?: boolean;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Export to HTML result
+ */
+export interface ExportToHtmlResult {
+    html: string;
+    template: 'default' | 'minimal' | 'detailed';
+    includeCharts: boolean;
+    totalIssues: number;
+}
+/**
+ * Filter criteria for filtering issues
+ */
+export interface FilterCriteria {
+    ruleIds?: string[];
+    categories?: string[];
+    impactLevels?: ImpactLevel[];
+    wcagLevels?: WCAGLevel[];
+    minCount?: number;
+    elementTypes?: string[];
+}
+/**
+ * Filter issues input
+ */
+export interface FilterIssuesInput {
+    results: AuditResult;
+    filters: FilterCriteria;
+    mode?: 'include' | 'exclude';
+}
+/**
+ * Filter issues result
+ */
+export interface FilterIssuesResult {
+    filtered: AuditResult;
+    originalCount: number;
+    filteredCount: number;
+    filtersApplied: FilterCriteria;
+    mode: 'include' | 'exclude';
+}
+/**
+ * Search issues input
+ */
+export interface SearchIssuesInput {
+    results: AuditResult;
+    query: string;
+    fields?: ('description' | 'element' | 'xpath' | 'selector' | 'ruleId' | 'userImpact' | 'fix' | 'all')[];
+    caseSensitive?: boolean;
+}
+/**
+ * Search issues result
+ */
+export interface SearchIssuesResult {
+    matches: PrioritizedIssue[];
+    query: string;
+    totalMatches: number;
+    fields: ('description' | 'element' | 'xpath' | 'selector' | 'ruleId' | 'userImpact' | 'fix' | 'all')[];
+}
+/**
+ * Aggregate audit results input
+ */
+export interface AggregateAuditResultsInput {
+    results: AuditResult[];
+    groupBy?: 'url' | 'category' | 'rule' | 'none';
+    includeSummary?: boolean;
+}
+/**
+ * Aggregated audit result with grouped issues
+ */
+export interface AggregateAuditResultsResult {
+    aggregated: AuditResult;
+    groupedBy: 'url' | 'category' | 'rule' | 'none';
+    totalResults: number;
+    groupedIssues?: Record<string, PrioritizedIssue[]>;
+    summary: AuditSummary;
+}
+/**
+ * Breakdown dimension for statistics
+ */
+export type BreakdownDimension = 'category' | 'impact' | 'wcag' | 'rule';
+/**
+ * Get statistics input
+ */
+export interface GetStatisticsInput {
+    results: AuditResult | AuditResult[];
+    breakdown?: BreakdownDimension[];
+}
+/**
+ * Statistics breakdown by dimension
+ */
+export interface StatisticsBreakdown {
+    counts: Record<string, number>;
+    percentages: Record<string, number>;
+    distribution: Record<string, number>;
+}
+/**
+ * Statistics result
+ */
+export interface GetStatisticsResult {
+    totalIssues: number;
+    averageScore: number;
+    totalResults: number;
+    byCategory?: StatisticsBreakdown;
+    byImpact?: StatisticsBreakdown;
+    byWCAG?: StatisticsBreakdown;
+    byRule?: StatisticsBreakdown;
+    wcagCompliance: WCAGCompliance;
+    breakdownDimensions: BreakdownDimension[];
+}
+/**
+ * Dashboard format
+ */
+export type DashboardFormat = 'text' | 'markdown' | 'html' | 'json';
+/**
+ * Generate dashboard input
+ */
+export interface GenerateDashboardInput {
+    results: AuditResult | AuditResult[] | string | string[];
+    format?: DashboardFormat;
+    includeCharts?: boolean;
+    /** HTTP Basic Auth username when results is a URL. Use with basicAuthPassword. Can also be embedded in URL as https://user:password@host/. */
+    basicAuthUsername?: string;
+    /** HTTP Basic Auth password when results is a URL. Use with basicAuthUsername. */
+    basicAuthPassword?: string;
+}
+/**
+ * Generate dashboard result
+ */
+export interface GenerateDashboardResult {
+    dashboard: string;
+    format: DashboardFormat;
+    includeCharts: boolean;
+    totalResults: number;
+}
+/**
+ * Summary report format
+ */
+export type SummaryReportFormat = 'text' | 'markdown' | 'html';
+/**
+ * Summary report level
+ */
+export type SummaryReportLevel = 'executive' | 'detailed' | 'technical';
+/**
+ * Generate summary report input
+ */
+export interface GenerateSummaryReportInput {
+    results: AuditResult | AuditResult[] | string | string[];
+    format?: SummaryReportFormat;
+    level?: SummaryReportLevel;
+    basicAuthUsername?: string;
+    basicAuthPassword?: string;
+}
+/**
+ * Generate summary report result
+ */
+export interface GenerateSummaryReportResult {
+    report: string;
+    format: SummaryReportFormat;
+    level: SummaryReportLevel;
+    totalResults: number;
+}
+//# sourceMappingURL=index.d.ts.map