@axe-core/reporter-earl 4.8.2-9a65b64.0 → 4.8.2-aab6d3c.0

package/dist/axeReporterEarl.d.mts

@@ -0,0 +1,49 @@
+declare enum EarlType {
+    WebPage = "WebPage",
+    Assertion = "Assertion",
+    TestCase = "TestCase",
+    TestResult = "TestResult"
+}
+interface EarlResult {
+    '@context': object;
+    '@type': EarlType.WebPage;
+    url: string;
+    assertions: Assertion[];
+}
+interface Assertion {
+    '@type': EarlType.Assertion;
+    mode: 'earl:automatic';
+    assertedBy: {};
+    test: {
+        '@type': EarlType.TestCase;
+        '@id': string;
+    };
+    result: TestResult;
+}
+interface TestResult {
+    '@type': EarlType.TestResult;
+    outcome: string;
+    pointer?: string;
+    info?: string;
+}
+interface RawResult {
+    id: string;
+    helpUrl: string;
+    description: string;
+    violations?: RawNodeResult[];
+    passes?: RawNodeResult[];
+    incomplete?: RawNodeResult[];
+}
+interface RawNodeResult {
+    node: {
+        selector: Selector;
+    };
+    result?: 'passed' | 'failed' | 'inapplicable' | 'incomplete';
+}
+type SelectorItem = string[] | string;
+type Selector = SelectorItem[];
+
+declare function createEarlReport(rawResults: RawResult[], url?: string): EarlResult;
+declare function axeReporterEarl(rawResults: RawResult[], {}: {}, callback: Function): void;
+
+export { createEarlReport, axeReporterEarl as default };

package/jest.config.js

@@ -4,7 +4,7 @@ module.exports = {
   transform: {
     '\\.(ts|tsx)$': 'ts-jest'
   },
-  testRegex: '/tests/.*\\.(ts|tsx|js)$',
+  testPathDirs: 'tests',
   testPathIgnorePatterns: ['/node_modules/', '/dist/', '/tests/utils.ts'],
   silent: false,
   coverageThreshold: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/reporter-earl",
-  "version": "4.8.2-9a65b64.0+9a65b64",
+  "version": "4.8.2-aab6d3c.0+aab6d3c",
   "description": "A EARL+JSON-LD reporter for axe-core",
   "main": "dist/axeReporterEarl.js",
   "module": "./dist/axeReporterEarl.mjs",
@@ -15,7 +15,10 @@
   "scripts": {
     "start": "NODE_OPTIONS=--experimental-vm-modules jest --watch --env=jsdom",
     "test": "npm run build && npm run test:unit",
-    "test:esm": "node esmTest.mjs",
+    "test:export": "npm run test:esm && npm run test:commonjs && npm run test:ts",
+    "test:esm": "node tests/esmTest.mjs",
+    "test:commonjs": "node tests/commonjsTest.js",
+    "test:ts": "tsc tests/tsTest.ts --noEmit --skipLibCheck --esModuleInterop",
     "test:unit": "NODE_OPTIONS=--experimental-vm-modules jest --collectCoverage",
     "build": "tsup src/axeReporterEarl.ts --dts --format esm,cjs",
     "prepublishOnly": "npm run build"
@@ -42,7 +45,7 @@
   "devDependencies": {
     "@types/clone": "^2.1.1",
     "@types/jsonld": "github:types/jsonld",
-    "@types/node": "^18.8.3",
+    "@types/node": "^20.8.10",
     "axe-core": "~4.8.2",
     "clone": "^2.1.2",
     "cross-env": "^7.0.3",
@@ -51,8 +54,8 @@
     "jsonld": "^8.2.1",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "tsup": "^6.7.0",
+    "tsup": "^7.2.0",
     "typescript": "^4.8.4"
   },
-  "gitHead": "9a65b64304f7b4c375892eeb2d2fa6fb6c71ac87"
+  "gitHead": "aab6d3cbbb6b69623b58fd8f4be1126a13740fab"
 }

package/tests/commonjsTest.js

@@ -0,0 +1,6 @@
+// ensure backwards compatibility of commonJs format
+const defaultExport = require('../dist/axeReporterEarl.js').default;
+const assert = require('assert');
+
+const exportIsFunction = typeof defaultExport === 'function';
+assert(exportIsFunction, 'export is not a function');

package/{esmTest.mjs → tests/esmTest.mjs}

@@ -1,4 +1,5 @@
-import defaultExport from './dist/axeReporterEarl.mjs';
+// ensure compatibility of ESM format
+import defaultExport from '../dist/axeReporterEarl.mjs';
 import assert from 'assert';
 
 const exportIsFunction = typeof defaultExport === 'function';

package/tests/tsTest.ts

@@ -0,0 +1,18 @@
+// This file isn't executed; we only care that typescript can successfully
+// build/typecheck. It is a smoke test that our build process is producing a
+// basically-reasonable index.d.ts.
+
+// Detailed tests of individual types should instead be covered by unit tests.
+
+import DefaultImportReporter from '../dist/axeReporterEarl.js';
+// import axe from 'axe-core';
+
+// See https://stackoverflow.com/a/55541672
+type IsAny<T> = 0 extends 1 & T ? true : false;
+
+// If the imports don't have typings assigned, these will fail
+// with "ts(2322): Type 'false' is not assignable to type 'true'."
+(x: IsAny<typeof DefaultImportReporter>): false => x;
+
+// TODO: this doesn't work as our types are broken
+// axe.configure({ reporter: DefaultImportReporter });