@d-zero/a11y-check-axe-scenario 0.2.0 → 0.3.1

package/dist/axe.js

@@ -1,3 +1,4 @@
+import AxePuppeteer from '@axe-core/puppeteer';
 import { createScenario } from '@d-zero/a11y-check-core';
 import { Cache } from '@d-zero/shared/cache';
 import { convertResultsFromViolations } from './convert-results-from-violations.js';
@@ -5,13 +6,14 @@ const scenarioId = 'a11y-check/axe';
 export default createScenario((options) => {
     const cache = new Cache(scenarioId, options?.cacheDir);
     return {
+        modulePath: import.meta.url,
         id: scenarioId,
         async exec(page, sizeName, log) {
             if (options?.cache === false) {
                 await cache.clear();
             }
             const axeLog = (message) => log(`🪓 ${message}`);
-            const key = (await page.url()) + '#' + sizeName;
+            const key = page.url() + '#' + sizeName;
             const cached = await cache.load(key, (key, value) => {
                 if (key === 'timestamp') {
                     return new Date(Date.parse(value));
@@ -23,10 +25,13 @@ export default createScenario((options) => {
                     violations: await convertResultsFromViolations(page, cached, sizeName, options?.screenshot ?? false, axeLog),
                 };
             }
-            const axeResults = await page.axe({
-                lang: options?.lang ?? 'ja',
-                log: axeLog,
-            });
+            const axeResults = await new AxePuppeteer(page)
+                .configure({
+                locale: {
+                    lang: options?.lang ?? 'ja',
+                },
+            })
+                .analyze();
             await cache.store(key, axeResults);
             return {
                 violations: await convertResultsFromViolations(page, axeResults, sizeName, options?.screenshot ?? false, axeLog),

package/dist/convert-results-from-node.d.ts

@@ -1,6 +1,13 @@
 import type { Style } from '@d-zero/a11y-check-core';
-import type { Page } from '@d-zero/puppeteer-page';
 import type { NodeResult } from 'axe-core';
+import type { Page } from 'puppeteer';
+/**
+ *
+ * @param page
+ * @param node
+ * @param screenshot
+ * @param log
+ */
 export declare function convertResultsFromNode(page: Page, node: NodeResult, screenshot: boolean, log: (log: string) => void): Promise<{
     screenshot: string | null;
     style: Style | null;

package/dist/convert-results-from-node.js

@@ -1,5 +1,12 @@
 import path from 'node:path';
 import { hash } from '@d-zero/shared/hash';
+/**
+ *
+ * @param page
+ * @param node
+ * @param screenshot
+ * @param log
+ */
 export async function convertResultsFromNode(page, node, screenshot, log) {
     const target = node.target[0] && typeof node.target[0] === 'string' ? node.target[0] : null;
     if (!target) {
@@ -9,9 +16,10 @@ export async function convertResultsFromNode(page, node, screenshot, log) {
     let screenshotName = null;
     if (screenshot && target) {
         log(`Screenshot: ${target}`);
-        const url = await page.url();
+        const url = page.url();
         const ssName = hash(url + target) + '.png';
-        const elementScreenshot = await page.elementScreenshot(target, {
+        const el = await page.waitForSelector(target);
+        const elementScreenshot = await el?.screenshot({
             path: path.resolve(process.cwd(), '.cache', ssName),
         });
         if (elementScreenshot) {

package/dist/convert-results-from-violations.d.ts

@@ -1,4 +1,12 @@
 import type { Violation } from '@d-zero/a11y-check-core';
-import type { Page } from '@d-zero/puppeteer-page';
 import type { AxeResults } from 'axe-core';
+import type { Page } from 'puppeteer';
+/**
+ *
+ * @param page
+ * @param axeResults
+ * @param sizeName
+ * @param screenshot
+ * @param log
+ */
 export declare function convertResultsFromViolations(page: Page, axeResults: AxeResults, sizeName: string, screenshot: boolean, log: (log: string) => void): Promise<Violation[]>;

package/dist/convert-results-from-violations.js

@@ -3,6 +3,14 @@ import { detectLevel } from './detect-level.js';
 import { inferExplanation } from './infer-explanation.js';
 import { p } from './pargraph.js';
 import { tagsToSCs } from './tags-to-scs.js';
+/**
+ *
+ * @param page
+ * @param axeResults
+ * @param sizeName
+ * @param screenshot
+ * @param log
+ */
 export async function convertResultsFromViolations(page, axeResults, sizeName, screenshot, log) {
     const results = [];
     const violations = [...axeResults.incomplete, ...axeResults.violations];
@@ -13,7 +21,7 @@ export async function convertResultsFromViolations(page, axeResults, sizeName, s
             const explanation = inferExplanation(violation.id, node, nodeResult?.style ?? null);
             results.push({
                 id: '',
-                url: await page.url(),
+                url: page.url(),
                 tool: `${axeResults.testEngine.name} (v${axeResults.testEngine.version})`,
                 timestamp: new Date(axeResults.timestamp),
                 component: nodeResult?.landmark ?? null,

package/dist/detect-level.d.ts

@@ -1 +1,5 @@
+/**
+ *
+ * @param tags
+ */
 export declare function detectLevel(tags: readonly string[]): "A" | "AA" | "AAA" | null;

package/dist/detect-level.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param tags
+ */
 export function detectLevel(tags) {
     return tags.includes('wcag2a')
         ? 'A'

package/dist/detect-version.d.ts

@@ -1 +1,5 @@
+/**
+ *
+ * @param tags
+ */
 export declare function detectLevel(tags: readonly string[]): "A" | "AA" | "AAA" | null;

package/dist/detect-version.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param tags
+ */
 export function detectLevel(tags) {
     return tags.includes('wcag2')
         ? 'A'

package/dist/infer-explanation.d.ts

@@ -1,4 +1,10 @@
 import type { AxeRuleId, Explanation } from './types.js';
 import type { Style } from '@d-zero/a11y-check-core';
 import type { NodeResult } from 'axe-core';
+/**
+ *
+ * @param id
+ * @param node
+ * @param style
+ */
 export declare function inferExplanation(id: AxeRuleId, node: NodeResult, style: Style | null): Explanation | null;

package/dist/infer-explanation.js

@@ -1,5 +1,11 @@
 import { colorContrastCheck, ColorContrastError } from '@d-zero/a11y-check-core';
 import { br, p } from './pargraph.js';
+/**
+ *
+ * @param id
+ * @param node
+ * @param style
+ */
 export function inferExplanation(id, node, style) {
     switch (id) {
         case 'accesskeys': {

package/dist/pargraph.d.ts

@@ -1,2 +1,10 @@
+/**
+ *
+ * @param {...any} texts
+ */
 export declare function p(...texts: (string | null | undefined)[]): string;
+/**
+ *
+ * @param {...any} texts
+ */
 export declare function br(...texts: (string | null | undefined)[]): string;

package/dist/pargraph.js

@@ -1,6 +1,14 @@
+/**
+ *
+ * @param {...any} texts
+ */
 export function p(...texts) {
     return texts.filter(Boolean).join('\n\n');
 }
+/**
+ *
+ * @param {...any} texts
+ */
 export function br(...texts) {
     return texts.filter(Boolean).join('\n');
 }

package/dist/tags-to-scs.d.ts

@@ -1,2 +1,10 @@
+/**
+ *
+ * @param tags
+ */
 export declare function tagsToSCs(tags: string[]): string;
+/**
+ *
+ * @param tag
+ */
 export declare function tagToSC(tag: string): "1.1.1" | "1.2.1" | "1.2.2" | "1.2.3" | "1.2.4" | "1.2.5" | "1.2.6" | "1.2.7" | "1.2.8" | "1.2.9" | "1.3.1" | "1.3.2" | "1.3.3" | "1.3.4" | "1.3.5" | "1.3.6" | "1.4.1" | "1.4.2" | "1.4.3" | "1.4.4" | "1.4.5" | "1.4.6" | "1.4.7" | "1.4.8" | "1.4.9" | "1.4.10" | "1.4.11" | "1.4.12" | "1.4.13" | "2.1.1" | "2.1.2" | "2.1.3" | "2.1.4" | "2.2.1" | "2.2.2" | "2.2.3" | "2.2.4" | "2.2.5" | "2.2.6" | "2.3.1" | "2.3.2" | "2.3.3" | "2.4.1" | "2.4.2" | "2.4.3" | "2.4.4" | "2.4.5" | "2.4.6" | "2.4.7" | "2.4.8" | "2.4.9" | "2.4.10" | "2.4.11" | "2.4.12" | "2.4.13" | "2.5.1" | "2.5.2" | "2.5.3" | "2.5.4" | "2.5.5" | "2.5.6" | "2.5.7" | "2.5.8" | "3.1.1" | "3.1.2" | "3.1.3" | "3.1.4" | "3.1.5" | "3.1.6" | "3.2.1" | "3.2.2" | "3.2.3" | "3.2.4" | "3.2.5" | "3.2.6" | "3.3.1" | "3.3.2" | "3.3.3" | "3.3.4" | "3.3.5" | "3.3.6" | "3.3.7" | "3.3.8" | "3.3.9" | "4.1.2" | "4.1.3" | null;

package/dist/tags-to-scs.js

@@ -2,9 +2,17 @@ import { wcag } from '@d-zero/db-wcag';
 const scVersions = new Set(
 // @ts-ignore
 Object.keys(wcag.successCriterions['wcag_2.2'].en));
+/**
+ *
+ * @param tags
+ */
 export function tagsToSCs(tags) {
     return tags.map(tagToSC).filter(Boolean).join('\n');
 }
+/**
+ *
+ * @param tag
+ */
 export function tagToSC(tag) {
     if (!tag.startsWith('wcag') || tag.endsWith('a')) {
         return null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/a11y-check-axe-scenario",
-	"version": "0.2.0",
+	"version": "0.3.1",
 	"description": "Accessibility Checker Axe Scenario",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,13 +24,18 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/a11y-check-core": "0.2.0",
+		"@axe-core/puppeteer": "4.10.1",
+		"@d-zero/a11y-check-core": "0.4.0",
 		"@d-zero/db-wcag": "1.0.0-alpha.1",
-		"@d-zero/shared": "0.6.0"
+		"@d-zero/shared": "0.8.0"
 	},
 	"devDependencies": {
-		"@d-zero/puppeteer-page": "0.2.0",
-		"axe-core": "4.10.2"
+		"axe-core": "4.10.3",
+		"puppeteer": "24.9.0"
 	},
-	"gitHead": "1eb1c03400580040119121e11ffb33acd876fe1b"
+	"peerDependencies": {
+		"axe-core": "4.10.3",
+		"puppeteer": "24.8.2"
+	},
+	"gitHead": "4e9cc7b87e0fef91b6f2d4edfb66ca9134b2491b"
 }

package/dist/axe-puppeteer.d.ts

@@ -1,3 +0,0 @@
-import type { AxeResults } from 'axe-core';
-import type { Page } from 'puppeteer';
-export declare function runAxePuppeteer(page: Page, lang: string, log: (log: string) => void): Promise<AxeResults>;

package/dist/axe-puppeteer.js

@@ -1,17 +0,0 @@
-import { AxePuppeteer } from '@axe-core/puppeteer';
-import { delay } from '@d-zero/shared/delay';
-export async function runAxePuppeteer(page, lang, log) {
-    const mod = await import(`axe-core/locales/${lang}.json`, {
-        with: { type: 'json' },
-    });
-    const locale = mod.default;
-    log(`Analyze%dots%`);
-    const axeResults = await new AxePuppeteer(page)
-        .configure({
-        locale,
-    })
-        .analyze();
-    log(`Found ${axeResults.violations.length} violations, ${axeResults.incomplete.length} incomplete issues`);
-    await delay(600);
-    return axeResults;
-}

package/dist/sc.d.ts

@@ -1 +0,0 @@
-export declare function sc(tags: string[]): string;

package/dist/sc.js

@@ -1,23 +0,0 @@
-import { wcag } from '@d-zero/db-wcag';
-const scVersions = new Set(
-// @ts-ignore
-Object.keys(wcag.successCriterions['wcag_2.2'].en));
-export function sc(tags) {
-    return tags.map(_sc).filter(Boolean).join('\n');
-}
-function _sc(tag) {
-    if (!tag.startsWith('wcag') || tag.endsWith('a')) {
-        return null;
-    }
-    const num = /\d+/.exec(tag)?.[0];
-    if (!num) {
-        return null;
-    }
-    for (const version of scVersions) {
-        const crushedNum = version.replaceAll('.', '');
-        if (tag === crushedNum) {
-            return version;
-        }
-    }
-    return null;
-}