@d-zero/a11y-check-core 0.2.0 → 0.3.0

package/dist/clean-results.d.ts

@@ -1,2 +1,6 @@
 import type { Violation } from './types.js';
+/**
+ *
+ * @param results
+ */
 export declare function cleanResults(results: readonly Violation[]): Violation[];

package/dist/clean-results.js

@@ -1,6 +1,10 @@
 import { hash } from '@d-zero/shared/hash';
 import { pathComparator } from '@d-zero/shared/sort/path';
 import { scNumberComparator } from './sc-number-comparator.js';
+/**
+ *
+ * @param results
+ */
 export function cleanResults(results) {
     const hashMap = new Map();
     for (const result of results) {

package/dist/color-contrast.d.ts

@@ -5,4 +5,8 @@ export declare enum ColorContrastError {
     FOREGROUND_COLOR_HAS_ALPHA = 2,
     BACKGROUND_COLOR_HAS_ALPHA = 3
 }
+/**
+ *
+ * @param style
+ */
 export declare function colorContrastCheck(style: Style): ColorContrastError | ColorContrast;

package/dist/color-contrast.js

@@ -9,6 +9,10 @@ export var ColorContrastError;
     ColorContrastError[ColorContrastError["FOREGROUND_COLOR_HAS_ALPHA"] = 2] = "FOREGROUND_COLOR_HAS_ALPHA";
     ColorContrastError[ColorContrastError["BACKGROUND_COLOR_HAS_ALPHA"] = 3] = "BACKGROUND_COLOR_HAS_ALPHA";
 })(ColorContrastError || (ColorContrastError = {}));
+/**
+ *
+ * @param style
+ */
 export function colorContrastCheck(style) {
     const foreground = colorFnToHex(style.color);
     if (!foreground) {

package/dist/color.d.ts

@@ -1,2 +1,6 @@
 import type { Color } from './types.js';
+/**
+ *
+ * @param colorFn
+ */
 export declare function colorFnToHex(colorFn: string | null): Color | null;

package/dist/color.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param colorFn
+ */
 export function colorFnToHex(colorFn) {
     if (!colorFn) {
         return null;

package/dist/create-scenario.d.ts

@@ -1,2 +1,6 @@
 import type { ScenarioCreator } from './types.js';
+/**
+ *
+ * @param creator
+ */
 export declare function createScenario<O>(creator: ScenarioCreator<O>): ScenarioCreator<O>;

package/dist/create-scenario.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param creator
+ */
 export function createScenario(creator) {
     return creator;
 }

package/dist/sc-number-comparator.d.ts

@@ -1 +1,6 @@
+/**
+ *
+ * @param a
+ * @param b
+ */
 export declare function scNumberComparator(a: string | null, b: string | null): number;

package/dist/sc-number-comparator.js

@@ -1,3 +1,8 @@
+/**
+ *
+ * @param a
+ * @param b
+ */
 export function scNumberComparator(a, b) {
     if (a === b) {
         return 0;

package/dist/scenario-runner.d.ts

@@ -1,4 +1,10 @@
 import type { CoreOptions, Result, Scenario, ScenarioRunnerOptions } from './types.js';
+/**
+ *
+ * @param urlList
+ * @param scenarios
+ * @param options
+ */
 export declare function scenarioRunner<O>(urlList: readonly (string | {
     id: string | null;
     url: string;

package/dist/scenario-runner.js

@@ -4,6 +4,12 @@ import { Cache } from '@d-zero/shared/cache';
 import { delay } from '@d-zero/shared/delay';
 import c from 'ansi-colors';
 import { cleanResults } from './clean-results.js';
+/**
+ *
+ * @param urlList
+ * @param scenarios
+ * @param options
+ */
 export async function scenarioRunner(urlList, scenarios, options) {
     const cache = new Cache('a11y-check/run-puppeteer', options?.cacheDir);
     const hooks = options?.hooks;

package/dist/types.d.ts

@@ -13,7 +13,6 @@ export type ScenarioRunnerOptions = DealOptions & {
 export type ScenarioCreator<O> = (options?: O) => Scenario;
 export type Scenario = {
     id: string;
-    config?: {};
     exec: ScenarioExecutor;
     analyze?: ScenarioAnalyzer;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/a11y-check-core",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"description": "Accessibility Checker (Core Module)",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -24,15 +24,15 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/puppeteer-dealer": "0.2.0",
-		"@d-zero/shared": "0.6.0",
+		"@d-zero/puppeteer-dealer": "0.3.0",
+		"@d-zero/shared": "0.7.0",
 		"ansi-colors": "4.1.3",
 		"color-contrast-checker": "2.1.0"
 	},
 	"devDependencies": {
-		"@d-zero/dealer": "1.2.0",
-		"@d-zero/puppeteer-page": "0.2.0",
-		"@d-zero/puppeteer-page-scan": "2.0.0"
+		"@d-zero/dealer": "1.3.0",
+		"@d-zero/puppeteer-page": "0.3.0",
+		"@d-zero/puppeteer-page-scan": "3.0.0"
 	},
-	"gitHead": "1eb1c03400580040119121e11ffb33acd876fe1b"
+	"gitHead": "e4fd17857e31022d121527b00fd7f009dbdb2142"
 }

package/dist/color-contrast.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/color-contrast.spec.js

@@ -1,41 +0,0 @@
-import { test, expect } from 'vitest';
-import { colorContrastCheck, ColorContrastError } from './color-contrast.js';
-test('#000 vs #FFF', () => {
-    expect(colorContrastCheck({
-        color: 'rgb(0, 0, 0)',
-        backgroundColor: 'rgb(255, 255, 255)',
-        backgroundImage: '',
-        closestBackgroundColor: null,
-        closestBackgroundImage: null,
-    })).toStrictEqual({
-        foreground: {
-            a: 1,
-            b: 0,
-            g: 0,
-            hex: '#000000',
-            hexA: '#000000FF',
-            r: 0,
-        },
-        background: {
-            a: 1,
-            b: 255,
-            g: 255,
-            hex: '#FFFFFF',
-            hexA: '#FFFFFFFF',
-            r: 255,
-        },
-        ratio: 21,
-        ratioText: '21:1',
-        AA: true,
-        AAA: true,
-    });
-});
-test('has alpha channel', () => {
-    expect(colorContrastCheck({
-        color: 'rgba(0, 0, 0, 0.5)',
-        backgroundColor: 'rgb(255, 255, 255)',
-        backgroundImage: '',
-        closestBackgroundColor: null,
-        closestBackgroundImage: null,
-    })).toBe(ColorContrastError.FOREGROUND_COLOR_HAS_ALPHA);
-});

package/dist/sc-number-comparator.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/sc-number-comparator.spec.js

@@ -1,21 +0,0 @@
-import { test, expect } from 'vitest';
-import { scNumberComparator } from './sc-number-comparator.js';
-test('scNumberComparator', () => {
-    expect([
-        //
-        '1.2.3',
-        '1.1.1',
-        '1.2.1',
-        '1.1.2',
-        null,
-        '1.1.3',
-    ].toSorted(scNumberComparator)).toStrictEqual([
-        //
-        '1.1.1',
-        '1.1.2',
-        '1.1.3',
-        '1.2.1',
-        '1.2.3',
-        null,
-    ]);
-});