wcag-scanner 1.2.65 → 1.2.67

package/dist/rules/images.js

@@ -21,8 +21,6 @@ exports.default = {
         checkImageElements(document, results);
         // Check <svg> elements
         checkSvgElements(document, results);
-        // Check background images
-        checkBackgroundImages(document, window, results);
         // Check image maps
         checkImageMaps(document, results);
         return results;
@@ -187,54 +185,6 @@ function checkSvgElements(document, results) {
         }
     });
 }
-/**
- * Check background images for accessibility issues
- * @param document DOM document
- * @param window Window object
- * @param results Scan results
- */
-function checkBackgroundImages(document, window, results) {
-    // Find elements with background image
-    const allElements = document.querySelectorAll('*');
-    allElements.forEach(element => {
-        var _a, _b, _c;
-        const style = window.getComputedStyle(element);
-        const backgroundImage = style.backgroundImage;
-        // Skip if no background image or if it's "none"
-        if (!backgroundImage || backgroundImage === 'none') {
-            return;
-        }
-        // Skip if the element is hidden/decorative
-        if (isElementHidden(element) || element.getAttribute('aria-hidden') === 'true') {
-            return;
-        }
-        const info = {
-            tagName: element.tagName.toLowerCase(),
-            id: element.id || null,
-            className: ((_a = element.className) === null || _a === void 0 ? void 0 : _a.toString()) || null,
-            textContent: ((_b = element.textContent) === null || _b === void 0 ? void 0 : _b.substring(0, 50)) || null
-        };
-        // Check if meaningful background image has text alternative
-        const hasTextContent = ((_c = element.textContent) === null || _c === void 0 ? void 0 : _c.trim()) !== '';
-        const hasAriaLabel = element.hasAttribute('aria-label');
-        const hasAriaLabelledby = element.hasAttribute('aria-labelledby');
-        const hasTitle = element.hasAttribute('title');
-        if (!hasTextContent && !hasAriaLabel && !hasAriaLabelledby && !hasTitle) {
-            // Only warn if the background image looks like content (not decoration)
-            if (backgroundImage.includes('url(') && !isBackgroundLikelyDecorative(element)) {
-                results.warnings.push({
-                    rule: 'background-image',
-                    element: info,
-                    impact: 'moderate',
-                    description: 'Element with background image may need text alternative',
-                    snippet: element.outerHTML.slice(0, 150) + (element.outerHTML.length > 150 ? '...' : ''),
-                    wcag: ['1.1.1'],
-                    help: 'If the background image conveys meaning, add text alternative via aria-label or text content'
-                });
-            }
-        }
-    });
-}
 /**
  * Check image maps for accessibility
  * @param document DOM document
@@ -293,47 +243,6 @@ function checkImageMaps(document, results) {
         });
     });
 }
-/**
- * Check if an element is hidden
- * @param element Element to check
- */
-function isElementHidden(element) {
-    // This is a simplified check - a real implementation would be more comprehensive
-    if (element.hasAttribute('hidden') || element.getAttribute('aria-hidden') === 'true') {
-        return true;
-    }
-    // Check computed style if available
-    try {
-        const style = getComputedStyle(element);
-        return style.display === 'none' || style.visibility === 'hidden';
-    }
-    catch (e) {
-        return false;
-    }
-}
-/**
- * Check if a background image is likely decorative
- * @param element Element to check
- */
-function isBackgroundLikelyDecorative(element) {
-    var _a, _b;
-    // Common decorative pattern elements
-    const decorativeElements = ['header', 'footer', 'section', 'article', 'div'];
-    const tagName = ((_a = element.tagName) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || '';
-    if (decorativeElements.includes(tagName)) {
-        // Check for certain classes that might indicate decorative backgrounds
-        const className = ((_b = element.className) === null || _b === void 0 ? void 0 : _b.toString()) || '';
-        if (className.includes('background') ||
-            className.includes('banner') ||
-            className.includes('hero') ||
-            className.includes('container') ||
-            className.includes('wrapper') ||
-            className.includes('section')) {
-            return true;
-        }
-    }
-    return false;
-}
 /**
  * Determine if an image is likely decorative
  * @param img Image to check

package/dist/rules/presets.d.ts

@@ -0,0 +1,8 @@
+import { ScannerOptions } from '../types';
+export declare const FAST_RULES: readonly ["images", "contrast", "forms", "aria", "structure", "keyboard"];
+export declare const FULL_RULES: readonly ["images", "contrast", "forms", "aria", "structure", "keyboard", "backgroundImages"];
+export declare const RULE_PRESETS: {
+    readonly fast: readonly ["images", "contrast", "forms", "aria", "structure", "keyboard"];
+    readonly full: readonly ["images", "contrast", "forms", "aria", "structure", "keyboard", "backgroundImages"];
+};
+export declare function resolveRuleNames(options: ScannerOptions, fallback?: readonly string[]): string[];

package/dist/rules/presets.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RULE_PRESETS = exports.FULL_RULES = exports.FAST_RULES = void 0;
+exports.resolveRuleNames = resolveRuleNames;
+exports.FAST_RULES = ['images', 'contrast', 'forms', 'aria', 'structure', 'keyboard'];
+exports.FULL_RULES = [...exports.FAST_RULES, 'backgroundImages'];
+exports.RULE_PRESETS = {
+    fast: [...exports.FAST_RULES],
+    full: [...exports.FULL_RULES],
+};
+function resolveRuleNames(options, fallback = exports.FAST_RULES) {
+    if (options.rules && options.rules.length > 0) {
+        return options.rules;
+    }
+    if (options.preset === 'full') {
+        return [...exports.FULL_RULES];
+    }
+    return [...fallback];
+}

package/dist/scanner.js

@@ -7,6 +7,7 @@ exports.WCAGScanner = void 0;
 const jsdom_1 = require("jsdom");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const presets_1 = require("./rules/presets");
 /**
  * Main WCAG Scanner class
  */
@@ -18,7 +19,7 @@ class WCAGScanner {
     constructor(options = {}) {
         this.rules = new Map();
         this.options = {
-            rules: ['images', 'headings', 'contrast', 'forms', 'aria'],
+            preset: 'fast',
             level: 'AA',
             ai: true,
             ...options
@@ -36,18 +37,15 @@ class WCAGScanner {
      * @returns Promise<boolean> True if loaded successfully
      */
     async loadHTML(html, baseUrl = 'https://example.org') {
+        var _a;
         try {
+            (_a = this.dom) === null || _a === void 0 ? void 0 : _a.window.close();
             // Create virtual DOM with robust error handling
             this.dom = new jsdom_1.JSDOM(html, {
                 url: baseUrl,
-                resources: 'usable',
-                runScripts: 'dangerously',
+                runScripts: 'outside-only',
+                pretendToBeVisual: true,
                 beforeParse(window) {
-                    // Silence script errors
-                    window.addEventListener('error', (event) => {
-                        console.log(`Ignored script error: ${event.message}`);
-                        event.preventDefault();
-                    });
                     // Mock modern browser APIs that may be missing in JSDOM
                     if (!window.ReadableStream) {
                         window.ReadableStream = class MockReadableStream {
@@ -67,8 +65,6 @@ class WCAGScanner {
             });
             this.document = this.dom.window.document;
             this.window = this.dom.window;
-            // Wait for resources to load
-            await new Promise(resolve => setTimeout(resolve, 100));
             return true;
         }
         catch (error) {
@@ -103,6 +99,8 @@ class WCAGScanner {
                 .filter(file => {
                 if (file.endsWith('.d.ts') || file.endsWith('.d.js'))
                     return false;
+                if (path_1.default.basename(file, path_1.default.extname(file)) === 'presets')
+                    return false;
                 return file.endsWith('.js') || file.endsWith('.ts');
             });
             for (const file of ruleFiles) {
@@ -147,7 +145,7 @@ class WCAGScanner {
             await this.loadRules();
         }
         // Run each enabled rule
-        const enabledRules = this.options.rules || [];
+        const enabledRules = (0, presets_1.resolveRuleNames)(this.options, presets_1.FAST_RULES);
         for (const ruleName of enabledRules) {
             const rule = this.rules.get(ruleName);
             if (rule) {
@@ -170,7 +168,11 @@ class WCAGScanner {
      * @returns ScanResults Current scan results
      */
     getResults() {
-        return this.results;
+        return {
+            passes: [...this.results.passes],
+            violations: [...this.results.violations],
+            warnings: [...this.results.warnings]
+        };
     }
     /**
      * Update scanner options

package/dist/types/index.d.ts

@@ -1,9 +1,12 @@
+export type RulePreset = 'fast' | 'full';
 /**
  * Scanner configuration options
  */
 export interface ScannerOptions {
     /** WCAG level to check against (A, AA or AAA) */
     level?: 'A' | 'AA' | 'AAA';
+    /** Built-in rule preset */
+    preset?: RulePreset;
     /** Specific rules to check */
     rules?: string[];
     /** Enable AI-powered suggestions */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wcag-scanner",
-  "version": "1.2.65",
+  "version": "1.2.67",
   "description": "Scan HTML for WCAG accessibility violations with AI-powered fix suggestions",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,24 +10,22 @@
   },
   "files": [
     "dist",
-    "scrapper/pkg",
     "README.md",
     "LICENSE"
   ],
   "engines": {
     "node": ">=16.0.0"
   },
-  "bin": {
-    "wcag-scanner": "dist/cli/index.js"
-  },
   "scripts": {
     "test": "jest",
     "test:coverage": "jest --coverage",
-    "build:wasm": "wasm-pack build scrapper --target nodejs",
-    "build": "npm run build:wasm && rimraf dist && tsc",
+    "build": "rimraf dist && tsc",
+    "profile:aria": "npm run build && node scripts/profile-aria.js",
+    "profile:contrast": "npm run build && node scripts/profile-contrast.js",
+    "profile:forms": "npm run build && node scripts/profile-forms.js",
+    "profile:images": "npm run build && node scripts/profile-images.js",
     "prepublishOnly": "npm run build",
-    "lint": "eslint src/**/*.ts",
-    "codecov": "codecov"
+    "lint": "eslint src/**/*.ts"
   },
   "repository": {
     "type": "git",
@@ -51,10 +49,15 @@
     "react-dom": ">=17.0.0"
   },
   "peerDependenciesMeta": {
-    "react": { "optional": true },
-    "react-dom": { "optional": true }
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
   },
   "devDependencies": {
+    "@testing-library/react": "^16.3.2",
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.14",
     "@types/jsdom": "^21.1.7",
@@ -63,19 +66,17 @@
     "@types/react-dom": "^18.3.7",
     "@typescript-eslint/eslint-plugin": "^8.24.0",
     "@typescript-eslint/parser": "^8.24.0",
-    "codecov": "^3.6.2",
     "eslint": "^9.21.0",
     "jest": "^29.7.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
     "rimraf": "^6.0.1",
     "ts-jest": "^29.2.6",
     "typescript": "^5.7.2"
   },
   "dependencies": {
-    "@google/generative-ai": "^0.23.0",
     "color-diff": "^1.4.0",
-    "commander": "^13.1.0",
     "crypto": "^1.0.1",
-    "dotenv": "^16.4.7",
     "express": "^4.21.2",
     "jsdom": "^26.0.0"
   }

package/dist/ai/suggestions.d.ts

@@ -1,11 +0,0 @@
-import { Violation, FixSuggestion } from "../types";
-/**
- * Generate fix suggestions for accessibility violations
- * @param violation WCAG violation to fix
- * @returns Promise<FixSuggestion> Suggested fix
- */
-export declare function generateFixSuggestion(violation: Violation): Promise<FixSuggestion>;
-declare const _default: {
-    generateFixSuggestion: typeof generateFixSuggestion;
-};
-export default _default;

package/dist/ai/suggestions.js

@@ -1,103 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFixSuggestion = generateFixSuggestion;
-const generative_ai_1 = require("@google/generative-ai");
-const dotenv_1 = __importDefault(require("dotenv"));
-/**
- * @TODO working on AI-powered suggestions, it's still working in progress.
- */
-// Load environment variables from .env file
-dotenv_1.default.config();
-// Get API key from environment
-const apiKey = process.env.GEMINI_API_KEY;
-// Initialize Gemini if API key is available
-let genAI = null;
-let model = null;
-if (apiKey) {
-    try {
-        genAI = new generative_ai_1.GoogleGenerativeAI(apiKey);
-        model = genAI.getGenerativeModel({ model: 'gemini-1.0-pro' });
-        console.log('Gemini AI initialized');
-    }
-    catch (error) {
-        console.error('Error initializing Gemini AI:', error);
-    }
-}
-/**
- * Generate fix suggestions for accessibility violations
- * @param violation WCAG violation to fix
- * @returns Promise<FixSuggestion> Suggested fix
- */
-async function generateFixSuggestion(violation) {
-    // Ig Gemini is not available, use rule-based suggestion
-    if (!model) {
-        console.log('Gemini AI not available, using rule-based suggestion');
-        return generateRuleBasedSuggestion(violation);
-    }
-    try {
-        // Create prompt for Gemini
-        const prompt = `
-            As a web accessibility expert, I need a fix for this WCAG issue:
-            Rule: ${violation.rule || ''}
-            Description: ${violation.description || ''}
-
-            HTML code with issue:
-            ${violation.snippet || ''}
-
-            Please provide a corrected version of the code and a brief explanation.
-        `;
-        // Generate content with Gemini
-        const result = await model.generateContent(prompt);
-        const response = result.response.text();
-        // Extract code and explanation from response
-        const codeMatch = response.match(/```(?:html)?\s*([\s\S]*?)\s*```/);
-        const code = codeMatch ? codeMatch[1].trim() : '';
-        // Remove code block for clean explanation
-        const explanation = response
-            .replace(/```(?:html)?\s*[\s\S]*?\s*```/g, '')
-            .trim();
-        return {
-            code: code || 'Unable to generate specific code fix',
-            description: 'AI-suggested fix',
-            explanation: explanation || 'Fix the accessibility issue as suggested by the AI'
-        };
-    }
-    catch (error) {
-        console.error('Error generating fix suggestion with Gemini AI:', error);
-        return generateRuleBasedSuggestion(violation);
-    }
-}
-/**
- * Generate basic rule-based suggestion as fallback
- * @param violation WCAG violation
- * @returns FixSuggestion
- */
-function generateRuleBasedSuggestion(violation) {
-    var _a;
-    const rule = violation.rule || '';
-    if (rule.includes('img-alt')) {
-        return {
-            code: ((_a = violation.snippet) === null || _a === void 0 ? void 0 : _a.replace(/<img/i, '<img alt="Descriptive text"')) || '',
-            description: 'Add alt text to image',
-            explanation: 'Images need alternative text for screen readers'
-        };
-    }
-    if (rule.includes('contrast')) {
-        return {
-            code: '/* Increase color contrast to at least 4.5:1 ratio */',
-            description: 'Increase color contrast',
-            explanation: 'Text needs sufficient contrast with its background'
-        };
-    }
-    return {
-        code: '',
-        description: 'Fix needed',
-        explanation: violation.help || 'Fix this issue to improve accessibility'
-    };
-}
-exports.default = {
-    generateFixSuggestion
-};

package/dist/cli/index.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/cli/index.js

@@ -1,160 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const __1 = require("..");
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const __2 = require("..");
-// Try to load package.json for version information
-let version = '0.1.0';
-try {
-    const packagePath = path_1.default.join(__dirname, '../../package.json');
-    const packageJson = JSON.parse(fs_1.default.readFileSync(packagePath, 'utf8'));
-    version = packageJson.version;
-}
-catch (e) {
-    // Ignore package.json load error
-}
-commander_1.program
-    .name('wcag-scanner')
-    .description('Scan HTML files and websites for WCAG accessibility violations')
-    .version(version);
-// Command to scan HTML file
-commander_1.program
-    .command('scan <filePath>')
-    .description('Scan a local HTML file for accessibility violations')
-    .option('-l, --level <level>', 'WCAG level (A, AA, AAA)', 'AA')
-    .option('-f, --format <format>', 'Output format (json, console, html)', 'console')
-    .option('-o, --output <file>', 'Save results to file')
-    .option('-v, --verbose', 'Show verbose output')
-    .option('-r, --rules <rules>', 'Comma-separated list of rules to check')
-    .action(async (filePath, options) => {
-    try {
-        console.log(`Scanning file: ${filePath}`);
-        const scannerOptions = {
-            level: options.level,
-            verbose: options.verbose || false,
-            rules: options.rules ? options.rules.split(',') : undefined
-        };
-        const results = await (0, __1.scanFile)(filePath, scannerOptions);
-        // Generate report
-        const report = (0, __1.formatReport)(results, options.format, scannerOptions);
-        // Output to console if not html format
-        if (options.format !== 'html') {
-            console.log(report);
-        }
-        // Save to file if specified
-        if (options.output) {
-            console.log(`Saving report to: ${options.output}`);
-            (0, __1.saveReport)(report, options.output);
-        }
-        // Exit with appropriate code based on violations
-        process.exit(results.violations.length > 0 ? 1 : 0);
-    }
-    catch (error) {
-        console.error('Error scanning file:', error);
-        process.exit(1);
-    }
-});
-// Command to scan URL
-commander_1.program
-    .command('url <url>')
-    .description('Scan a website URL for accessibility issues')
-    .option('-l, --level <level>', 'WCAG level (A, AA, AAA)', 'AA')
-    .option('-f, --format <format>', 'Output format (json, console, html)', 'console')
-    .option('-o, --output <file>', 'Save results to file')
-    .option('-v, --verbose', 'Show verbose output')
-    .option('-r, --rules <rules>', 'Comma-separated list of rules to check')
-    .option('--ai', 'Enable AI-powered fix suggestions')
-    .action(async (urlString, options) => {
-    try {
-        // Add protocol if missing
-        if (!urlString.startsWith('http://') && !urlString.startsWith('https://')) {
-            urlString = 'https://' + urlString;
-            console.log(`Added protocol to URL: ${urlString}`);
-        }
-        console.log(`Scanning URL: ${urlString}`);
-        // Create scanner options
-        const scannerOptions = {
-            level: options.level,
-            verbose: options.verbose || false,
-            baseUrl: urlString,
-            rules: options.rules ? options.rules.split(',') : undefined,
-            ai: options.ai || false,
-            ignoreScriptErrors: true
-        };
-        // Use the scanUrl function that uses WASM internally
-        const results = await (0, __2.scanUrl)(urlString, scannerOptions);
-        // Generate report
-        const report = (0, __1.formatReport)(results, options.format, scannerOptions);
-        // Output to console if not html format
-        if (options.format !== 'html') {
-            console.log(report);
-        }
-        // Save to file if specified
-        if (options.output) {
-            console.log(`Saving report to: ${options.output}`);
-            (0, __1.saveReport)(report, options.output);
-        }
-        // Exit with appropriate code based on violations
-        process.exit(results.violations.length > 0 ? 1 : 0);
-    }
-    catch (error) {
-        console.error('Error scanning URL:', error);
-        process.exit(1);
-    }
-});
-// Command to scan HTML from stdin
-commander_1.program
-    .command('stdin')
-    .description('Scan HTML input from stdin')
-    .option('-l, --level <level>', 'WCAG level (A, AA, AAA)', 'AA')
-    .option('-f, --format <format>', 'Output format (json, console, html)', 'console')
-    .option('-o, --output <file>', 'Save results to file')
-    .option('-v, --verbose', 'Show verbose output')
-    .option('-r, --rules <rules>', 'Comma-separated list of rules to check')
-    .action(async (options) => {
-    try {
-        console.log('Reading HTML from stdin...');
-        let html = '';
-        process.stdin.on('data', (chunk) => {
-            html += chunk;
-        });
-        process.stdin.on('end', async () => {
-            console.log(`Received ${html.length} bytes of HTML`);
-            const scannerOptions = {
-                level: options.level,
-                verbose: options.verbose || false,
-                rules: options.rules ? options.rules.split(',') : undefined
-            };
-            const results = await (0, __1.scanHtml)(html, scannerOptions);
-            // Generate report
-            const report = (0, __1.formatReport)(results, options.format, scannerOptions);
-            // Output to console if not html format
-            if (options.format !== 'html') {
-                console.log(report);
-            }
-            // Save to file if specified
-            if (options.output) {
-                console.log(`Saving report to: ${options.output}`);
-                (0, __1.saveReport)(report, options.output);
-            }
-            // Exit with appropriate code based on violations
-            process.exit(results.violations.length > 0 ? 1 : 0);
-        });
-    }
-    catch (error) {
-        console.error('Error scanning HTML:', error);
-        process.exit(1);
-    }
-});
-// If no arguments provided, show help
-if (process.argv.length <= 2) {
-    commander_1.program.help();
-}
-// Parse command line arguments
-commander_1.program.parse(process.argv);

package/dist/wasm/index.d.ts

@@ -1,19 +0,0 @@
-/**
- * WASM based URL scraper using Rust
- */
-export declare class WsamScraper {
-    private wasmModule;
-    private initialized;
-    /**
-     * Initialize the WASM scraper
-     */
-    initialize(): Promise<void>;
-    /**
-     * Scrape a URL using Rust/WASM
-     * @param url URL to scrape
-     * @returns Promise<string> HTML content
-     */
-    scrapeUrl(url: string): Promise<string>;
-}
-declare const _default: WsamScraper;
-export default _default;

package/dist/wasm/index.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WsamScraper = void 0;
-/**
- * WASM based URL scraper using Rust
- */
-class WsamScraper {
-    constructor() {
-        this.initialized = false;
-    }
-    /**
-     * Initialize the WASM scraper
-     */
-    async initialize() {
-        if (this.initialized)
-            return;
-        try {
-            // scrapper/pkg is generated by `npm run build:wasm` (wasm-pack build)
-            this.wasmModule = require('../../scrapper/pkg/scrapper');
-            this.wasmModule.init_panic_hook();
-            this.initialized = true;
-            console.log("WASM scraper initialized successfully");
-        }
-        catch (error) {
-            console.error("Failed to initialize WASM scraper:", error);
-            throw error;
-        }
-    }
-    /**
-     * Scrape a URL using Rust/WASM
-     * @param url URL to scrape
-     * @returns Promise<string> HTML content
-     */
-    async scrapeUrl(url) {
-        if (!this.initialized) {
-            await this.initialize();
-        }
-        console.log(`Scraping URL using Rust/WASM: ${url}`);
-        try {
-            const uint8Array = await this.wasmModule.scrape_url(url);
-            const decoder = new TextDecoder('utf-8');
-            const html = decoder.decode(uint8Array);
-            console.log(`Successfully scraped ${html.length} bytes of HTML content`);
-            return html;
-        }
-        catch (error) {
-            console.error("Error in WASM scraper:", error);
-            throw error;
-        }
-    }
-}
-exports.WsamScraper = WsamScraper;
-exports.default = new WsamScraper;