@holmdigital/engine 1.4.3 → 1.4.5

package/README.md

@@ -1,16 +1,29 @@
 # @holmdigital/engine
 
-> Regulatory accessibility test engine with Virtual DOM and Shadow DOM support.
+[![npm version](https://img.shields.io/npm/v/@holmdigital/engine.svg)](https://www.npmjs.com/package/@holmdigital/engine)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)
+[![Downloads](https://img.shields.io/npm/dm/@holmdigital/engine.svg)](https://www.npmjs.com/package/@holmdigital/engine)
 
-This engine bridges the gap between technical accessibility scanning (using `axe-core`) and legal compliance reporting (EN 301 549). It provides prescriptive remediation advice and localized reporting.
+> Regulatory accessibility test engine with Virtual DOM, Shadow DOM support, and built-in legal compliance reporting.
+
+## Why this package?
+
+Most accessibility tools give you technical errors (e.g., "Color contrast must be 4.5:1"). This engine bridges the gap between **technical code validation** (using `axe-core`) and **legal compliance** (EN 301 549, Section 508, DOS-lagen).
+
+It handles the heavy lifting of:
+1.  **Mapping** technical failures to specific legal clauses.
+2.  **Validating** HTML structure to ensure test accuracy.
+3.  **Reporting** in multiple languages (EN, SV, NL, DE, FR, ES) for non-technical stakeholders.
 
 ## Features
 
-- **Regulatory Mapping**: Maps technical failures to EU laws.
-- **HTML Structure Validation**: built-in `html-validate` checks for semantic correctness.
-- **Internationalization (i18n)**: Supports English (`en`), Swedish (`sv`), German (`de`), French (`fr`), Spanish (`es`), and Dutch (`nl`). Supports region-specific rules (e.g. `en-us`, `en-gb`).
-- **Pseudo-Automation**: Generates Playwright test scripts for manual verification.
-- **PDF Reporting**: Generates beautiful, compliant PDF reports.
+- **Regulatory Mapping**: Maps technical failures to EU laws (EN 301 549, EAA).
+- **HTML Structure Validation**: Built-in `html-validate` checks to prevent false positives/negatives.
+- **Internationalization (i18n)**: Supports English (`en`), Swedish (`sv`), German (`de`), French (`fr`), Spanish (`es`), and Dutch (`nl`).
+- **Pseudo-Automation**: Automatically generates Playwright/Puppeteer test scripts for manual verification steps.
+- **PDF Reporting**: Generates beautiful, compliant PDF reports out of the box.
+- **TypeScript**: Written in TypeScript with full type definitions included.
 
 ## Installation
 

package/dist/cli/index.js

@@ -1005,7 +1005,7 @@ async function generatePDF(htmlContent, outputPath) {
 init_i18n();
 
 // src/cli/cloud-client.ts
-var ENGINE_VERSION = "1.1.0";
+var ENGINE_VERSION = "1.4.4";
 function transformToCloudPayload(result) {
   const violations = result.reports.map((report) => {
     const firstNode = report.failingNodes?.[0];
@@ -1094,7 +1094,7 @@ function isValidUrl(urlString) {
 }
 var program = new import_commander.Command();
 program.name("hd-a11y-scan").description("HolmDigital Regulatory Scanner").version("0.1.0");
-program.argument("<url>", "URL to scan").option("--lang <code", "Language code (en, sv)", "en").option("--ci", "Run in CI/CD mode (exit code 1 on critical failures)").option("--generate-tests", "Generate Pseudo-Automation tests").option("--json", "Output as JSON").option("--pdf <path>", "Generate PDF report to path").option("--viewport <size>", 'Set viewport (e.g. "mobile", "desktop", "1024x768")').option("--api-key <key>", "API key for HolmDigital Cloud authentication").option("--cloud-url <url>", "Cloud API URL", "https://cloud.holmdigital.se").action(async (url, options) => {
+program.argument("<url>", "URL to scan").option("--lang <code>", "Language code (en, sv)", "en").option("--ci", "Run in CI/CD mode (exit code 1 on critical failures)").option("--generate-tests", "Generate Pseudo-Automation tests").option("--json", "Output as JSON").option("--pdf <path>", "Generate PDF report to path").option("--viewport <size>", 'Set viewport (e.g. "mobile", "desktop", "1024x768")').option("--api-key <key>", "API key for HolmDigital Cloud authentication").option("--cloud-url <url>", "Cloud API URL", "https://cloud.holmdigital.se").action(async (url, options) => {
   setLanguage(options.lang);
   if (!isValidUrl(url)) {
     console.error(import_chalk.default.red(`Error: Invalid URL format '${url}'`));

package/dist/cli/index.mjs

@@ -262,7 +262,7 @@ async function generatePDF(htmlContent, outputPath) {
 }
 
 // src/cli/cloud-client.ts
-var ENGINE_VERSION = "1.1.0";
+var ENGINE_VERSION = "1.4.4";
 function transformToCloudPayload(result) {
   const violations = result.reports.map((report) => {
     const firstNode = report.failingNodes?.[0];
@@ -351,7 +351,7 @@ function isValidUrl(urlString) {
 }
 var program = new Command();
 program.name("hd-a11y-scan").description("HolmDigital Regulatory Scanner").version("0.1.0");
-program.argument("<url>", "URL to scan").option("--lang <code", "Language code (en, sv)", "en").option("--ci", "Run in CI/CD mode (exit code 1 on critical failures)").option("--generate-tests", "Generate Pseudo-Automation tests").option("--json", "Output as JSON").option("--pdf <path>", "Generate PDF report to path").option("--viewport <size>", 'Set viewport (e.g. "mobile", "desktop", "1024x768")').option("--api-key <key>", "API key for HolmDigital Cloud authentication").option("--cloud-url <url>", "Cloud API URL", "https://cloud.holmdigital.se").action(async (url, options) => {
+program.argument("<url>", "URL to scan").option("--lang <code>", "Language code (en, sv)", "en").option("--ci", "Run in CI/CD mode (exit code 1 on critical failures)").option("--generate-tests", "Generate Pseudo-Automation tests").option("--json", "Output as JSON").option("--pdf <path>", "Generate PDF report to path").option("--viewport <size>", 'Set viewport (e.g. "mobile", "desktop", "1024x768")').option("--api-key <key>", "API key for HolmDigital Cloud authentication").option("--cloud-url <url>", "Cloud API URL", "https://cloud.holmdigital.se").action(async (url, options) => {
   setLanguage(options.lang);
   if (!isValidUrl(url)) {
     console.error(chalk.red(`Error: Invalid URL format '${url}'`));

package/package.json

@@ -1,71 +1,79 @@
-{
-    "name": "@holmdigital/engine",
-    "version": "1.4.3",
-    "private": false,
-    "publishConfig": {
-        "access": "public",
-        "registry": "https://registry.npmjs.org/"
-    },
-    "description": "Regulatory accessibility test engine with Virtual DOM and Shadow DOM support",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/holmdigital/a11y-hd.git",
-        "directory": "packages/engine"
-    },
-    "main": "./dist/index.js",
-    "module": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
-    "bin": {
-        "hd-a11y-scan": "./dist/cli/index.js"
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.js"
-        },
-        "./cli": "./dist/cli/index.js"
-    },
-    "files": [
-        "dist",
-        "README.md"
-    ],
-    "scripts": {
-        "build": "tsup src/index.ts src/cli/index.ts --format cjs,esm --dts --clean",
-        "dev": "tsup src/index.ts src/cli/index.ts --format cjs,esm --dts --watch",
-        "test": "vitest",
-        "test:integration": "vitest run --config vitest.integration.config.ts",
-        "lint": "eslint src --ext .ts",
-        "prepublishOnly": "npm run build"
-    },
-    "keywords": [
-        "accessibility",
-        "a11y",
-        "scanner",
-        "regulatory",
-        "wcag",
-        "en301549",
-        "dos-lagen",
-        "testing",
-        "virtual-dom"
-    ],
-    "author": "Holm Digital AB",
-    "license": "MIT",
-    "dependencies": {
-        "@holmdigital/standards": "*",
-        "axe-core": "^4.10.2",
-        "chalk": "^5.3.0",
-        "commander": "^12.1.0",
-        "html-validate": "^10.4.0",
-        "ora": "^8.1.1",
-        "puppeteer": "^23.10.4",
-        "ws": "^8.18.0"
-    },
-    "devDependencies": {
-        "@types/node": "^22.10.2",
-        "@types/ws": "^8.5.13",
-        "tsup": "^8.3.5",
-        "typescript": "^5.7.2",
-        "vitest": "^2.1.8"
-    }
+{
+    "name": "@holmdigital/engine",
+    "version": "1.4.5",
+    "private": false,
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "description": "Regulatory accessibility test engine with Virtual DOM and Shadow DOM support",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/holmdigital/a11y-hd.git",
+        "directory": "packages/engine"
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "bin": {
+        "hd-a11y-scan": "./dist/cli/index.js"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js"
+        },
+        "./cli": "./dist/cli/index.js"
+    },
+    "files": [
+        "dist",
+        "README.md"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts src/cli/index.ts --format cjs,esm --dts --clean",
+        "dev": "tsup src/index.ts src/cli/index.ts --format cjs,esm --dts --watch",
+        "test": "vitest",
+        "test:integration": "vitest run --config vitest.integration.config.ts",
+        "lint": "eslint src --ext .ts",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": [
+        "accessibility",
+        "a11y",
+        "wcag",
+        "en301549",
+        "compliance",
+        "automation",
+        "testing",
+        "regulatory",
+        "html-validate",
+        "axe-core",
+        "ead",
+        "european-accessibility-act",
+        "holmdigital",
+        "section508",
+        "ada",
+        "dos-lagen",
+        "digitale-barrierefreiheit"
+    ],
+    "author": "Holm Digital AB",
+    "license": "MIT",
+    "dependencies": {
+        "@holmdigital/standards": "*",
+        "axe-core": "^4.10.2",
+        "chalk": "^5.3.0",
+        "commander": "^12.1.0",
+        "html-validate": "^10.4.0",
+        "ora": "^8.1.1",
+        "puppeteer": "^23.10.4",
+        "ws": "^8.18.0"
+    },
+    "devDependencies": {
+        "@types/node": "^22.10.2",
+        "@types/ws": "^8.5.13",
+        "tsup": "^8.3.5",
+        "typescript": "^5.7.2",
+        "vitest": "^4.0.16"
+    }
 }