@a11y-skills/audit 0.1.0 → 0.3.0

package/dist/schemas/index.js

@@ -6,7 +6,50 @@
  * (e.g. an issue creator that reads `*-result.json`). They are intentionally
  * permissive (no `additionalProperties: false`) so that additive changes to a
  * result shape do not break downstream validation.
+ *
+ * Every check shares the same envelope (`source` / `url` / `timestamp` / the
+ * four normalized buckets / `summary` / `details` / `disclaimer`); the common
+ * pieces live in `$defs` and each check schema defines its own `details`.
  */
+// =============================================================================
+// Shared $defs
+// =============================================================================
+const NORMALIZED_NODE_SCHEMA = {
+    type: 'object',
+    required: ['target', 'html', 'htmlTruncated', 'failureSummary'],
+    properties: {
+        target: { type: 'array', items: { type: 'string' } },
+        html: { type: 'string' },
+        htmlTruncated: { type: 'boolean' },
+        failureSummary: { type: 'string' },
+    },
+};
+const NORMALIZED_RULE_RESULT_SCHEMA = {
+    type: 'object',
+    required: ['id', 'impact', 'description', 'help', 'helpUrl', 'tags', 'nodes'],
+    properties: {
+        id: { type: 'string' },
+        impact: {
+            type: ['string', 'null'],
+            enum: ['critical', 'serious', 'moderate', 'minor', null],
+        },
+        description: { type: 'string' },
+        help: { type: 'string' },
+        helpUrl: { type: 'string' },
+        tags: { type: 'array', items: { type: 'string' } },
+        nodes: { type: 'array', items: { $ref: '#/$defs/normalizedNode' } },
+    },
+};
+const SUMMARY_SCHEMA = {
+    type: 'object',
+    required: ['violationCount', 'incompleteCount', 'passCount'],
+    properties: {
+        violationCount: { type: 'number' },
+        incompleteCount: { type: 'number' },
+        passCount: { type: 'number' },
+        checkedNodes: { type: 'number' },
+    },
+};
 const DISCLAIMER_SCHEMA = {
     type: 'object',
     properties: {
@@ -16,230 +59,405 @@ const DISCLAIMER_SCHEMA = {
         moreInfo: { type: 'string' },
     },
 };
-export const AXE_AUDIT_RESULT_SCHEMA = {
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://masup9.github.io/a11y-audit/schemas/axe-audit-result.json',
-    title: 'AxeAuditResult',
-    type: 'object',
-    required: [
-        'url',
-        'timestamp',
-        'violations',
-        'passes',
-        'incomplete',
-        'inapplicable',
-        'violationCount',
-    ],
-    properties: {
-        url: { type: 'string' },
-        timestamp: { type: 'string' },
-        violations: {
-            type: 'array',
-            items: {
-                type: 'object',
-                required: ['id', 'description', 'help', 'helpUrl', 'tags', 'nodes'],
-                properties: {
-                    id: { type: 'string' },
-                    impact: { type: ['string', 'null'] },
-                    description: { type: 'string' },
-                    help: { type: 'string' },
-                    helpUrl: { type: 'string' },
-                    tags: { type: 'array', items: { type: 'string' } },
-                    nodes: {
-                        type: 'array',
-                        items: {
-                            type: 'object',
-                            required: ['html', 'target'],
-                            properties: {
-                                html: { type: 'string' },
-                                target: { type: 'array', items: { type: 'string' } },
-                                failureSummary: { type: ['string', 'null'] },
-                            },
-                        },
-                    },
-                },
-            },
+const COMMON_DEFS = {
+    normalizedNode: NORMALIZED_NODE_SCHEMA,
+    normalizedRuleResult: NORMALIZED_RULE_RESULT_SCHEMA,
+    summary: SUMMARY_SCHEMA,
+    disclaimer: DISCLAIMER_SCHEMA,
+};
+const RULE_ARRAY = {
+    type: 'array',
+    items: { $ref: '#/$defs/normalizedRuleResult' },
+};
+/** Build the envelope schema for one check, plugging in its details schema. */
+function buildEnvelopeSchema(args) {
+    return {
+        $schema: 'https://json-schema.org/draft/2020-12/schema',
+        $id: `https://masup9.github.io/a11y-audit/schemas/${args.id}.json`,
+        title: args.title,
+        type: 'object',
+        required: [
+            'source',
+            'url',
+            'timestamp',
+            'violations',
+            'incomplete',
+            'passes',
+            'inapplicable',
+            'summary',
+            'details',
+            'disclaimer',
+        ],
+        properties: {
+            source: { const: args.source },
+            url: { type: 'string' },
+            timestamp: { type: 'string' },
+            violations: RULE_ARRAY,
+            incomplete: RULE_ARRAY,
+            passes: RULE_ARRAY,
+            inapplicable: RULE_ARRAY,
+            summary: { $ref: '#/$defs/summary' },
+            details: args.details,
+            disclaimer: { $ref: '#/$defs/disclaimer' },
         },
-        passes: { type: 'number' },
-        incomplete: { type: 'number' },
-        inapplicable: { type: 'number' },
-        violationCount: { type: 'number' },
-        disclaimer: DISCLAIMER_SCHEMA,
-    },
+        $defs: COMMON_DEFS,
+    };
+}
+// =============================================================================
+// Detail building blocks
+// =============================================================================
+const ELEMENT_EVIDENCE_PROPS = {
+    selector: { type: 'string' },
+    tagName: { type: 'string' },
+    html: { type: 'string' },
+    htmlTruncated: { type: 'boolean' },
 };
 const FOCUS_ELEMENT_REF_SCHEMA = {
     type: 'object',
-    required: ['tag', 'name', 'selector'],
+    required: ['tag', 'name', 'selector', 'html', 'htmlTruncated'],
     properties: {
         tag: { type: 'string' },
         role: { type: ['string', 'null'] },
         name: { type: 'string' },
         selector: { type: 'string' },
+        html: { type: 'string' },
+        htmlTruncated: { type: 'boolean' },
     },
 };
-export const FOCUS_CHECK_RESULT_SCHEMA = {
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://masup9.github.io/a11y-audit/schemas/focus-check-result.json',
+// =============================================================================
+// Check schemas
+// =============================================================================
+export const AXE_AUDIT_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'axe-audit-result',
+    title: 'AxeAuditResult',
+    source: 'axe-audit',
+    details: {
+        type: 'object',
+        required: [
+            'tagsRun',
+            'rulesOverride',
+            'violationRuleCount',
+            'passRuleCount',
+            'incompleteRuleCount',
+            'inapplicableRuleCount',
+        ],
+        properties: {
+            tagsRun: { type: 'array', items: { type: 'string' } },
+            rulesOverride: { type: ['object', 'null'] },
+            violationRuleCount: { type: 'number' },
+            passRuleCount: { type: 'number' },
+            incompleteRuleCount: { type: 'number' },
+            inapplicableRuleCount: { type: 'number' },
+        },
+    },
+});
+export const FOCUS_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'focus-check-result',
     title: 'FocusCheckResult',
-    type: 'object',
-    required: [
-        'url',
-        'totalFocusableElements',
-        'elementsWithFocusStyle',
-        'elementsWithoutFocusStyle',
-        'issues',
-        'onFocusViolations',
-        'focusObscuredIssues',
-        'elementsWithObscuredFocus',
-        'allElements',
-        'interrupted',
-        'screenshotPath',
-    ],
-    properties: {
-        url: { type: 'string' },
-        totalFocusableElements: { type: 'number' },
-        elementsWithFocusStyle: { type: 'number' },
-        elementsWithoutFocusStyle: { type: 'number' },
-        issues: {
-            type: 'array',
-            items: {
-                type: 'object',
-                required: ['tag', 'name'],
-                properties: {
-                    tag: { type: 'string' },
-                    role: { type: ['string', 'null'] },
-                    name: { type: 'string' },
+    source: 'focus-indicator-check',
+    details: {
+        type: 'object',
+        required: [
+            'totalFocusableElements',
+            'elementsWithFocusStyle',
+            'elementsWithoutFocusStyle',
+            'issues',
+            'onFocusViolations',
+            'focusObscuredIssues',
+            'elementsWithObscuredFocus',
+            'allElements',
+            'interrupted',
+            'screenshotPath',
+        ],
+        properties: {
+            totalFocusableElements: { type: 'number' },
+            elementsWithFocusStyle: { type: 'number' },
+            elementsWithoutFocusStyle: { type: 'number' },
+            issues: { type: 'array', items: FOCUS_ELEMENT_REF_SCHEMA },
+            onFocusViolations: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    required: ['element', 'fromUrl', 'toUrl', 'changeType'],
+                    properties: {
+                        element: FOCUS_ELEMENT_REF_SCHEMA,
+                        fromUrl: { type: 'string' },
+                        toUrl: { type: 'string' },
+                        changeType: {
+                            type: 'string',
+                            enum: ['navigation', 'new-window', 'dialog'],
+                        },
+                    },
                 },
             },
-        },
-        onFocusViolations: {
-            type: 'array',
-            items: {
-                type: 'object',
-                required: ['element', 'fromUrl', 'toUrl', 'changeType'],
-                properties: {
-                    element: FOCUS_ELEMENT_REF_SCHEMA,
-                    fromUrl: { type: 'string' },
-                    toUrl: { type: 'string' },
-                    changeType: {
-                        type: 'string',
-                        enum: ['navigation', 'new-window', 'dialog'],
+            focusObscuredIssues: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    required: ['element', 'elementRect', 'overlaps', 'obscuredRatio'],
+                    properties: {
+                        element: FOCUS_ELEMENT_REF_SCHEMA,
+                        elementRect: { type: 'object' },
+                        overlaps: { type: 'array', items: { type: 'object' } },
+                        obscuredRatio: { type: 'number' },
                     },
                 },
             },
+            elementsWithObscuredFocus: { type: 'number' },
+            allElements: { type: 'array', items: { type: 'object' } },
+            interrupted: { type: 'boolean' },
+            interruptedAt: { type: 'number' },
+            screenshotPath: { type: 'string' },
         },
-        focusObscuredIssues: {
-            type: 'array',
-            items: {
+    },
+});
+export const REFLOW_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'reflow-check-result',
+    title: 'ReflowCheckResult',
+    source: 'reflow-check',
+    details: {
+        type: 'object',
+        required: [
+            'viewport',
+            'hasHorizontalScroll',
+            'documentScrollWidth',
+            'documentClientWidth',
+            'overflowingElements',
+            'clippedTextElements',
+        ],
+        properties: {
+            viewport: {
                 type: 'object',
-                required: ['element', 'elementRect', 'overlaps', 'obscuredRatio'],
+                required: ['width', 'height'],
                 properties: {
-                    element: FOCUS_ELEMENT_REF_SCHEMA,
-                    elementRect: { type: 'object' },
-                    overlaps: { type: 'array', items: { type: 'object' } },
-                    obscuredRatio: { type: 'number' },
+                    width: { type: 'number' },
+                    height: { type: 'number' },
+                },
+            },
+            hasHorizontalScroll: { type: 'boolean' },
+            documentScrollWidth: { type: 'number' },
+            documentClientWidth: { type: 'number' },
+            overflowingElements: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    required: [
+                        'selector',
+                        'tagName',
+                        'html',
+                        'htmlTruncated',
+                        'rect',
+                        'viewportWidth',
+                        'reason',
+                    ],
+                    properties: {
+                        ...ELEMENT_EVIDENCE_PROPS,
+                        rect: { type: 'object' },
+                        viewportWidth: { type: 'number' },
+                        reason: {
+                            type: 'string',
+                            enum: ['overflow-right', 'overflow-left', 'clipped-text'],
+                        },
+                    },
                 },
             },
+            clippedTextElements: { type: 'array', items: { type: 'object' } },
         },
-        elementsWithObscuredFocus: { type: 'number' },
-        allElements: { type: 'array', items: { type: 'object' } },
-        interrupted: { type: 'boolean' },
-        interruptedAt: { type: 'number' },
-        screenshotPath: { type: 'string' },
-        disclaimer: DISCLAIMER_SCHEMA,
     },
-};
-export const REFLOW_CHECK_RESULT_SCHEMA = {
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://masup9.github.io/a11y-audit/schemas/reflow-check-result.json',
-    title: 'ReflowCheckResult',
-    type: 'object',
-    required: [
-        'url',
-        'viewport',
-        'hasHorizontalScroll',
-        'documentScrollWidth',
-        'documentClientWidth',
-        'overflowingElements',
-        'clippedTextElements',
-    ],
-    properties: {
-        url: { type: 'string' },
-        viewport: {
-            type: 'object',
-            required: ['width', 'height'],
-            properties: {
-                width: { type: 'number' },
-                height: { type: 'number' },
+});
+export const TARGET_SIZE_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'target-size-check-result',
+    title: 'TargetSizeCheckResult',
+    source: 'target-size-check',
+    details: {
+        type: 'object',
+        required: [
+            'totalTargetsChecked',
+            'failAA',
+            'failAAAOnly',
+            'passedTargets',
+            'exceptedTargets',
+            'summary',
+        ],
+        properties: {
+            totalTargetsChecked: { type: 'number' },
+            failAA: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    required: [
+                        'selector',
+                        'tagName',
+                        'html',
+                        'htmlTruncated',
+                        'width',
+                        'height',
+                        'minDimension',
+                        'level',
+                        'exceptionAssessment',
+                    ],
+                    properties: {
+                        ...ELEMENT_EVIDENCE_PROPS,
+                        role: { type: ['string', 'null'] },
+                        accessibleName: { type: ['string', 'null'] },
+                        width: { type: 'number' },
+                        height: { type: 'number' },
+                        minDimension: { type: 'number' },
+                        level: {
+                            type: 'string',
+                            enum: ['fail-aa', 'fail-aaa-only', 'pass'],
+                        },
+                        exception: { type: ['string', 'null'] },
+                        exceptionDetails: { type: ['string', 'null'] },
+                        exceptionAssessment: {
+                            type: 'string',
+                            enum: ['ruled-out', 'possible', 'not-assessed'],
+                        },
+                        href: { type: ['string', 'null'] },
+                    },
+                },
             },
-        },
-        hasHorizontalScroll: { type: 'boolean' },
-        documentScrollWidth: { type: 'number' },
-        documentClientWidth: { type: 'number' },
-        overflowingElements: {
-            type: 'array',
-            items: {
+            failAAAOnly: { type: 'array', items: { type: 'object' } },
+            passedTargets: { type: 'number' },
+            exceptedTargets: { type: 'array', items: { type: 'object' } },
+            summary: {
                 type: 'object',
-                required: ['selector', 'tagName', 'rect', 'viewportWidth', 'reason'],
+                required: [
+                    'failAACount',
+                    'failAAAOnlyCount',
+                    'passCount',
+                    'exceptedCount',
+                ],
                 properties: {
-                    selector: { type: 'string' },
-                    tagName: { type: 'string' },
-                    rect: { type: 'object' },
-                    viewportWidth: { type: 'number' },
-                    reason: {
-                        type: 'string',
-                        enum: ['overflow-right', 'overflow-left', 'clipped-text'],
-                    },
+                    failAACount: { type: 'number' },
+                    failAAAOnlyCount: { type: 'number' },
+                    passCount: { type: 'number' },
+                    exceptedCount: { type: 'number' },
                 },
             },
         },
-        clippedTextElements: { type: 'array', items: { type: 'object' } },
-        disclaimer: DISCLAIMER_SCHEMA,
     },
-};
-export const TARGET_SIZE_CHECK_RESULT_SCHEMA = {
-    $schema: 'https://json-schema.org/draft/2020-12/schema',
-    $id: 'https://masup9.github.io/a11y-audit/schemas/target-size-check-result.json',
-    title: 'TargetSizeCheckResult',
-    type: 'object',
-    required: [
-        'url',
-        'totalTargetsChecked',
-        'failAA',
-        'failAAAOnly',
-        'passedTargets',
-        'exceptedTargets',
-        'summary',
-    ],
-    properties: {
-        url: { type: 'string' },
-        totalTargetsChecked: { type: 'number' },
-        failAA: { type: 'array', items: { type: 'object' } },
-        failAAAOnly: { type: 'array', items: { type: 'object' } },
-        passedTargets: { type: 'number' },
-        exceptedTargets: { type: 'array', items: { type: 'object' } },
-        summary: {
-            type: 'object',
-            required: [
-                'failAACount',
-                'failAAAOnlyCount',
-                'passCount',
-                'exceptedCount',
-            ],
-            properties: {
-                failAACount: { type: 'number' },
-                failAAAOnlyCount: { type: 'number' },
-                passCount: { type: 'number' },
-                exceptedCount: { type: 'number' },
+});
+export const TEXT_SPACING_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'text-spacing-check-result',
+    title: 'TextSpacingCheckResult',
+    source: 'text-spacing-check',
+    details: {
+        type: 'object',
+        required: ['clippedElements', 'totalElementsChecked'],
+        properties: {
+            clippedElements: { type: 'array', items: { type: 'object' } },
+            totalElementsChecked: { type: 'number' },
+        },
+    },
+});
+export const ZOOM_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'zoom-check-result',
+    title: 'ZoomCheckResult',
+    source: 'zoom-200-check',
+    details: {
+        type: 'object',
+        required: [
+            'zoomFactor',
+            'viewport',
+            'hasHorizontalScroll',
+            'documentScrollWidth',
+            'documentClientWidth',
+            'clippedElements',
+        ],
+        properties: {
+            zoomFactor: { type: 'number' },
+            viewport: { type: 'object' },
+            hasHorizontalScroll: { type: 'boolean' },
+            documentScrollWidth: { type: 'number' },
+            documentClientWidth: { type: 'number' },
+            clippedElements: { type: 'array', items: { type: 'object' } },
+        },
+    },
+});
+export const ORIENTATION_CHECK_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'orientation-check-result',
+    title: 'OrientationCheckResult',
+    source: 'orientation-check',
+    details: {
+        type: 'object',
+        required: ['portrait', 'landscape', 'hasOrientationLock', 'lockDetectedIn'],
+        properties: {
+            portrait: { type: 'object' },
+            landscape: { type: 'object' },
+            hasOrientationLock: { type: 'boolean' },
+            lockDetectedIn: {
+                type: 'string',
+                enum: ['portrait', 'landscape', 'both', 'none'],
             },
         },
-        disclaimer: DISCLAIMER_SCHEMA,
     },
-};
+});
+export const AUTOCOMPLETE_AUDIT_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'autocomplete-audit-result',
+    title: 'AutocompleteAuditResult',
+    source: 'autocomplete-audit',
+    details: {
+        type: 'object',
+        required: ['totalFieldsChecked', 'missingAutocomplete', 'invalidAutocomplete'],
+        properties: {
+            totalFieldsChecked: { type: 'number' },
+            missingAutocomplete: { type: 'array', items: { type: 'object' } },
+            invalidAutocomplete: { type: 'array', items: { type: 'object' } },
+        },
+    },
+});
+export const TIME_LIMIT_DETECTOR_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'time-limit-detector-result',
+    title: 'TimeLimitDetectorResult',
+    source: 'time-limit-detector',
+    details: {
+        type: 'object',
+        required: ['metaRefresh', 'timers', 'countdownIndicators', 'hasTimeLimits'],
+        properties: {
+            metaRefresh: { type: 'array', items: { type: 'object' } },
+            timers: { type: 'array', items: { type: 'object' } },
+            countdownIndicators: { type: 'array', items: { type: 'object' } },
+            hasTimeLimits: { type: 'boolean' },
+        },
+    },
+});
+export const AUTO_PLAY_DETECTION_RESULT_SCHEMA = buildEnvelopeSchema({
+    id: 'auto-play-detection-result',
+    title: 'AutoPlayDetectionResult',
+    source: 'auto-play-detection',
+    details: {
+        type: 'object',
+        required: [
+            'screenshotRecords',
+            'comparisons',
+            'hasAutoPlayContent',
+            'stopsWithin5Seconds',
+            'pauseControls',
+            'pauseVerification',
+            'recommendation',
+        ],
+        properties: {
+            screenshotRecords: { type: 'array', items: { type: 'object' } },
+            comparisons: { type: 'array', items: { type: 'object' } },
+            hasAutoPlayContent: { type: 'boolean' },
+            stopsWithin5Seconds: { type: 'boolean' },
+            pauseControls: { type: 'object' },
+            pauseVerification: { type: 'object' },
+            recommendation: { type: 'string' },
+        },
+    },
+});
 /** All result schemas keyed by check id. */
 export const RESULT_SCHEMAS = {
     'axe-audit': AXE_AUDIT_RESULT_SCHEMA,
     'focus-indicator-check': FOCUS_CHECK_RESULT_SCHEMA,
     'reflow-check': REFLOW_CHECK_RESULT_SCHEMA,
     'target-size-check': TARGET_SIZE_CHECK_RESULT_SCHEMA,
+    'text-spacing-check': TEXT_SPACING_CHECK_RESULT_SCHEMA,
+    'zoom-200-check': ZOOM_CHECK_RESULT_SCHEMA,
+    'orientation-check': ORIENTATION_CHECK_RESULT_SCHEMA,
+    'autocomplete-audit': AUTOCOMPLETE_AUDIT_RESULT_SCHEMA,
+    'time-limit-detector': TIME_LIMIT_DETECTOR_RESULT_SCHEMA,
+    'auto-play-detection': AUTO_PLAY_DETECTION_RESULT_SCHEMA,
 };

package/dist/test-entries/auto-play-detection.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Compatibility test entry for auto-play detection (WCAG 1.4.2 / 2.2.2).
+ * Run from a one-line local spec: `import "@a11y-skills/audit/test-entries/auto-play-detection";`
+ *
+ * Requires the optional `pixelmatch` + `pngjs` deps.
+ */
+export {};