@diegovelasquezweb/a11y-engine 0.6.3 → 0.6.5

package/assets/knowledge/knowledge.mjs

@@ -107,7 +107,7 @@ export default {
         {
           id: "A",
           label: "Level A",
-          badge: "Minimum",
+          tag: "Minimum",
           description: "The baseline: essential requirements that remove the most severe barriers.",
           shortDescription: "Minimum baseline",
           hint: "Failing Level A means some users cannot access the content at all.",
@@ -116,7 +116,7 @@ export default {
         {
           id: "AA",
           label: "Level AA",
-          badge: "Standard",
+          tag: "Standard",
           description: "The recommended target for most websites — required by most accessibility laws.",
           shortDescription: "Recommended for most websites",
           hint: "Referenced by ADA, Section 508, EN 301 549, and EAA.",
@@ -125,7 +125,7 @@ export default {
         {
           id: "AAA",
           label: "Level AAA",
-          badge: "Enhanced",
+          tag: "Enhanced",
           description: "The highest conformance level — not required but beneficial for specialized audiences.",
           shortDescription: "Strictest — not required by most regulations",
           hint: "Full AAA conformance is not recommended as a general policy for entire sites.",
@@ -251,21 +251,21 @@ export default {
                   {
                     id: "wcag-2-0",
                     title: "WCAG 2.0",
-                    badge: "2008",
+                    tag: "2008",
                     summary: "The original W3C recommendation that established the foundation for web accessibility.",
                     body: "Introduced the four principles (Perceivable, Operable, Understandable, Robust) and three conformance levels (A, AA, AAA). Covers core requirements like text alternatives, keyboard access, color contrast, and form labels. Still widely referenced in legal frameworks worldwide.",
                   },
                   {
                     id: "wcag-2-1",
                     title: "WCAG 2.1",
-                    badge: "2018",
+                    tag: "2018",
                     summary: "Extended 2.0 with 17 new success criteria for mobile, low vision, and cognitive disabilities.",
                     body: "Added criteria for touch targets (2.5.5), text spacing (1.4.12), content reflow (1.4.10), orientation (1.3.4), and input purpose (1.3.5). Required by the European Accessibility Act (EAA) and referenced in updated ADA guidance. All 2.0 criteria remain \u2014 2.1 is a superset.",
                   },
                   {
                     id: "wcag-2-2",
                     title: "WCAG 2.2",
-                    badge: "2023",
+                    tag: "2023",
                     summary: "The latest version, adding 9 new criteria focused on cognitive accessibility and consistent help.",
                     body: "Key additions include consistent help (3.2.6), accessible authentication (3.3.8), dragging movements (2.5.7), and focus appearance (2.4.11/2.4.12). Removed criterion 4.1.1 (Parsing) as it\u2019s now handled by modern browsers. Supersedes both 2.0 and 2.1 \u2014 all prior criteria are included.",
                   },
@@ -278,21 +278,21 @@ export default {
                   {
                     id: "level-a",
                     title: "Level A",
-                    badge: "Minimum",
+                    tag: "Minimum",
                     summary: "The baseline: essential requirements that remove the most severe barriers.",
                     body: "Covers fundamentals like non-text content alternatives (1.1.1), keyboard operability (2.1.1), page titles (2.4.2), and language of the page (3.1.1). Failing Level A means some users cannot access the content at all. Every site should meet Level A at minimum.",
                   },
                   {
                     id: "level-aa",
                     title: "Level AA",
-                    badge: "Standard",
+                    tag: "Standard",
                     summary: "The recommended target for most websites \u2014 required by most accessibility laws.",
                     body: "Includes all Level A criteria plus requirements for color contrast (1.4.3 \u2014 4.5:1 ratio), resize text (1.4.4), focus visible (2.4.7), error suggestion (3.3.3), and consistent navigation (3.2.3). Referenced by ADA, Section 508, EN 301 549, and EAA. This is the standard the scanner defaults to.",
                   },
                   {
                     id: "level-aaa",
                     title: "Level AAA",
-                    badge: "Enhanced",
+                    tag: "Enhanced",
                     summary: "The highest conformance level \u2014 not required but beneficial for specialized audiences.",
                     body: "Adds stricter contrast (1.4.6 \u2014 7:1 ratio), sign language for audio (1.2.6), extended audio description (1.2.7), and reading level (3.1.5). Full AAA conformance is not recommended as a general policy because some criteria cannot be satisfied for all content types. Useful for targeted sections like education or government services.",
                   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@diegovelasquezweb/a11y-engine",
-  "version": "0.6.3",
+  "version": "0.6.5",
   "description": "WCAG 2.2 AA accessibility audit engine — scanner, analyzer, and report builders",
   "type": "module",
   "license": "MIT",

package/src/index.d.mts

@@ -1,6 +1,6 @@
-// ---------------------------------------------------------------------------
-// Core types
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface Finding {
   id: string;
@@ -135,9 +135,9 @@ export interface AuditSummary {
   totalFindings: number;
 }
 
-// ---------------------------------------------------------------------------
-// Report types
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface ScanPayload {
   findings: Finding[] | Record<string, unknown>[];
@@ -209,9 +209,9 @@ export interface SourcePatternOptions {
   onlyPattern?: string;
 }
 
-// ---------------------------------------------------------------------------
-// Knowledge APIs
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface ScannerEngineHelp {
   id: "axe" | "cdp" | "pa11y" | string;
@@ -222,25 +222,53 @@ export interface ScannerEngineHelp {
   defaultEnabled: boolean;
 }
 
-export interface EnumOptionValue {
-  value: string;
-  label: string;
-  description?: string;
-}
-
 export interface ScannerOptionHelp {
   id: string;
   label: string;
   description: string;
   defaultValue: unknown;
   type: string;
-  allowedValues?: unknown[] | EnumOptionValue[];
+  allowedValues?: unknown[];
+}
+
+export interface GlossaryEntry {
+  term: string;
+  definition: string;
+}
+
+export interface ConceptEntry {
+  title: string;
+  body: string;
+  context?: string;
+}
+
+export interface PersonaReferenceItem {
+  id: string;
+  icon: string;
+  label: string;
+  description: string;
+  keywords: string[];
+  mappedRules: string[];
+}
+
+export interface PersonaReference {
+  locale: string;
+  version: string;
+  personas: PersonaReferenceItem[];
+}
+
+export interface ScannerHelp {
+  locale: string;
+  version: string;
+  title: string;
+  engines: ScannerEngineHelp[];
+  options: ScannerOptionHelp[];
 }
 
 export interface ConformanceLevel {
   id: "A" | "AA" | "AAA";
   label: string;
-  badge: string;
+  tag: string;
   description: string;
   shortDescription: string;
   hint: string;
@@ -263,6 +291,32 @@ export interface SeverityLevel {
   order: number;
 }
 
+export interface DocArticle {
+  id: string;
+  title: string;
+  icon?: string;
+  tag?: string;
+  summary: string;
+  body: string;
+}
+
+export interface DocGroup {
+  id: string;
+  label: string;
+  articles: DocArticle[];
+}
+
+export interface DocSection {
+  id: string;
+  heading: string;
+  articles?: DocArticle[];
+  groups?: DocGroup[];
+}
+
+export interface KnowledgeDocs {
+  sections: DocSection[];
+}
+
 export interface ConformanceLevelsResult {
   locale: string;
   version: string;
@@ -309,9 +363,9 @@ export interface KnowledgeOptions {
   locale?: string;
 }
 
-// ---------------------------------------------------------------------------
-// Engine selection
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface EngineSelection {
   axe?: boolean;
@@ -319,9 +373,9 @@ export interface EngineSelection {
   pa11y?: boolean;
 }
 
-// ---------------------------------------------------------------------------
-// Audit options
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface RunAuditOptions {
   baseUrl: string;
@@ -346,17 +400,17 @@ export interface RunAuditOptions {
   onProgress?: (step: string, status: string, extra?: Record<string, unknown>) => void;
 }
 
-// ---------------------------------------------------------------------------
-// Enrichment options
-// ---------------------------------------------------------------------------
+
+
+
 
 export interface EnrichmentOptions {
   screenshotUrlBuilder?: (rawPath: string) => string;
 }
 
-// ---------------------------------------------------------------------------
-// Public API
-// ---------------------------------------------------------------------------
+
+
+
 
 export function runAudit(options: RunAuditOptions): Promise<ScanPayload>;