@qualweb/earl-reporter 0.4.3 → 0.4.6

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="@qualweb/types" />
-import { Evaluations } from '@qualweb/core';
-import { EarlEvaluations, Assertion, EarlOptions, Report } from '@qualweb/earl-reporter';
-declare function generateEARLAssertions(report: Report, date?: string): Array<Assertion>;
-declare function generateEARLReport(reports: Evaluations, options?: EarlOptions): EarlEvaluations;
-export { generateEARLAssertions, generateEARLReport };
+/// <reference types="@qualweb/types" />
+import { Evaluations } from '@qualweb/core';
+import { EarlEvaluations, Assertion, EarlOptions, Report } from '@qualweb/earl-reporter';
+declare function generateEARLAssertions(report: Report, date?: string): Array<Assertion>;
+declare function generateEARLReport(reports: Evaluations, options?: EarlOptions): EarlEvaluations;
+export { generateEARLAssertions, generateEARLReport };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,156 +1,156 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateEARLReport = exports.generateEARLAssertions = void 0;
-const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
-const constants_1 = require("./constants");
-function generateEARLAssertions(report, date) {
-    var _a;
-    const assertions = new Array();
-    for (const name in report.assertions || {}) {
-        if (report.assertions[name]) {
-            const test = report.assertions[name];
-            if (test) {
-                const sources = generateSources(test);
-                const sCriterias = test.metadata['success-criteria'];
-                const isPartOf = convertSC(sCriterias);
-                const result = {
-                    '@type': 'TestResult',
-                    outcome: 'earl:' + (test.metadata.outcome !== 'warning' ? test.metadata.outcome : 'cantTell'),
-                    source: sources,
-                    description: test.metadata.description,
-                    date: date !== null && date !== void 0 ? date : new Date().toISOString().replace(/T/, ' ').replace(/\..+/, '')
-                };
-                const assertion = {
-                    '@type': 'Assertion',
-                    test: {
-                        '@id': (_a = test.metadata.url) !== null && _a !== void 0 ? _a : test.name,
-                        '@type': 'TestCase',
-                        title: test.name,
-                        description: test.description,
-                        isPartOf
-                    },
-                    mode: 'earl:automatic',
-                    result
-                };
-                assertions.push(assertion);
-            }
-        }
-    }
-    return assertions;
-}
-exports.generateEARLAssertions = generateEARLAssertions;
-function convertSC(scList) {
-    if (scList)
-        return scList.map((sc) => {
-            var _a;
-            const name = sc.name;
-            return (_a = constants_1.SC[name]) === null || _a === void 0 ? void 0 : _a.scId;
-        });
-    else
-        return [];
-}
-function generateSources(test) {
-    var _a;
-    const sources = new Array();
-    for (const result of test.results || []) {
-        const source = {
-            result: {
-                pointer: (_a = result.elements) === null || _a === void 0 ? void 0 : _a.filter((e) => e.pointer !== undefined).map((e) => e.pointer).join(', '),
-                outcome: 'earl:' + (result.verdict !== 'warning' ? result.verdict : 'cantTell')
-            }
-        };
-        sources.push(source);
-    }
-    return sources;
-}
-function reportModule(module, options) {
-    if (!options || !options.modules) {
-        return true;
-    }
-    else {
-        switch (module) {
-            case 'act':
-                return !!options.modules.act;
-            case 'wcag':
-                return !!options.modules.wcag;
-            case 'best-practices':
-                return !!options.modules['best-practices'];
-            default:
-                return false;
-        }
-    }
-}
-function generateSingleEarlReport(report, options) {
-    var _a, _b;
-    const earlReport = {
-        '@context': 'https://act-rules.github.io/earl-context.json',
-        '@graph': new Array()
-    };
-    const assertor = {
-        '@id': report.system.name,
-        '@type': 'Software',
-        title: report.system.name,
-        description: report.system.description,
-        hasVersion: report.system.version,
-        homepage: report.system.homepage
-    };
-    const testSubject = {
-        '@type': 'TestSubject',
-        source: (_b = (_a = report.system.url) === null || _a === void 0 ? void 0 : _a.inputUrl) !== null && _b !== void 0 ? _b : '',
-        assertor,
-        assertions: new Array()
-    };
-    if (report.system.url && report.system.url.inputUrl !== report.system.url.completeUrl) {
-        testSubject.redirectedTo = report.system.url.completeUrl;
-    }
-    if (report.modules['act-rules'] && reportModule('act', options)) {
-        testSubject.assertions = [
-            ...testSubject.assertions,
-            ...generateEARLAssertions(report.modules['act-rules'], report.system.date)
-        ];
-    }
-    if (report.modules['wcag-techniques'] && reportModule('wcag', options)) {
-        testSubject.assertions = [
-            ...testSubject.assertions,
-            ...generateEARLAssertions(report.modules['wcag-techniques'], report.system.date)
-        ];
-    }
-    if (report.modules['best-practices'] && reportModule('best-practices', options)) {
-        testSubject.assertions = [
-            ...testSubject.assertions,
-            ...generateEARLAssertions(report.modules['best-practices'], report.system.date)
-        ];
-    }
-    earlReport['@graph'].push(lodash_clonedeep_1.default(testSubject));
-    return earlReport;
-}
-function generateAggregatedEarlReport(reports, options) {
-    const aggregatedReport = {
-        '@context': 'https://act-rules.github.io/earl-context.json',
-        '@graph': new Array()
-    };
-    for (const report of reports || []) {
-        const earlReport = generateSingleEarlReport(report, options);
-        aggregatedReport['@graph'].push(lodash_clonedeep_1.default(earlReport['@graph'][0]));
-    }
-    return aggregatedReport;
-}
-function generateEARLReport(reports, options) {
-    const earlReports = {};
-    if (options && options.aggregated) {
-        const firstUrl = Object.keys(reports)[0];
-        earlReports[options.aggregatedName || firstUrl] = generateAggregatedEarlReport(Object.values(reports), options);
-    }
-    else {
-        for (const url in reports || {}) {
-            const earlReport = generateSingleEarlReport(reports[url], options);
-            earlReports[url] = lodash_clonedeep_1.default(earlReport);
-        }
-    }
-    return lodash_clonedeep_1.default(earlReports);
-}
-exports.generateEARLReport = generateEARLReport;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateEARLReport = exports.generateEARLAssertions = void 0;
+const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
+const constants_1 = require("./constants");
+function generateEARLAssertions(report, date) {
+    var _a;
+    const assertions = new Array();
+    for (const name in report.assertions || {}) {
+        if (report.assertions[name]) {
+            const test = report.assertions[name];
+            if (test) {
+                const sources = generateSources(test);
+                const sCriterias = test.metadata['success-criteria'];
+                const isPartOf = convertSC(sCriterias);
+                const result = {
+                    '@type': 'TestResult',
+                    outcome: 'earl:' + (test.metadata.outcome !== 'warning' ? test.metadata.outcome : 'cantTell'),
+                    source: sources,
+                    description: test.metadata.description,
+                    date: date !== null && date !== void 0 ? date : new Date().toISOString().replace(/T/, ' ').replace(/\..+/, '')
+                };
+                const assertion = {
+                    '@type': 'Assertion',
+                    test: {
+                        '@id': (_a = test.metadata.url) !== null && _a !== void 0 ? _a : test.name,
+                        '@type': 'TestCase',
+                        title: test.name,
+                        description: test.description,
+                        isPartOf
+                    },
+                    mode: 'earl:automatic',
+                    result
+                };
+                assertions.push(assertion);
+            }
+        }
+    }
+    return assertions;
+}
+exports.generateEARLAssertions = generateEARLAssertions;
+function convertSC(scList) {
+    if (scList)
+        return scList.map((sc) => {
+            var _a;
+            const name = sc.name;
+            return (_a = constants_1.SC[name]) === null || _a === void 0 ? void 0 : _a.scId;
+        });
+    else
+        return [];
+}
+function generateSources(test) {
+    var _a;
+    const sources = new Array();
+    for (const result of test.results || []) {
+        const source = {
+            result: {
+                pointer: (_a = result.elements) === null || _a === void 0 ? void 0 : _a.filter((e) => e.pointer !== undefined).map((e) => e.pointer).join(', '),
+                outcome: 'earl:' + (result.verdict !== 'warning' ? result.verdict : 'cantTell')
+            }
+        };
+        sources.push(source);
+    }
+    return sources;
+}
+function reportModule(module, options) {
+    if (!options || !options.modules) {
+        return true;
+    }
+    else {
+        switch (module) {
+            case 'act':
+                return !!options.modules.act;
+            case 'wcag':
+                return !!options.modules.wcag;
+            case 'best-practices':
+                return !!options.modules['best-practices'];
+            default:
+                return false;
+        }
+    }
+}
+function generateSingleEarlReport(report, options) {
+    var _a, _b;
+    const earlReport = {
+        '@context': 'https://act-rules.github.io/earl-context.json',
+        '@graph': new Array()
+    };
+    const assertor = {
+        '@id': report.system.name,
+        '@type': 'Software',
+        title: report.system.name,
+        description: report.system.description,
+        hasVersion: report.system.version,
+        homepage: report.system.homepage
+    };
+    const testSubject = {
+        '@type': 'TestSubject',
+        source: (_b = (_a = report.system.url) === null || _a === void 0 ? void 0 : _a.inputUrl) !== null && _b !== void 0 ? _b : '',
+        assertor,
+        assertions: new Array()
+    };
+    if (report.system.url && report.system.url.inputUrl !== report.system.url.completeUrl) {
+        testSubject.redirectedTo = report.system.url.completeUrl;
+    }
+    if (report.modules['act-rules'] && reportModule('act', options)) {
+        testSubject.assertions = [
+            ...testSubject.assertions,
+            ...generateEARLAssertions(report.modules['act-rules'], report.system.date)
+        ];
+    }
+    if (report.modules['wcag-techniques'] && reportModule('wcag', options)) {
+        testSubject.assertions = [
+            ...testSubject.assertions,
+            ...generateEARLAssertions(report.modules['wcag-techniques'], report.system.date)
+        ];
+    }
+    if (report.modules['best-practices'] && reportModule('best-practices', options)) {
+        testSubject.assertions = [
+            ...testSubject.assertions,
+            ...generateEARLAssertions(report.modules['best-practices'], report.system.date)
+        ];
+    }
+    earlReport['@graph'].push(lodash_clonedeep_1.default(testSubject));
+    return earlReport;
+}
+function generateAggregatedEarlReport(reports, options) {
+    const aggregatedReport = {
+        '@context': 'https://act-rules.github.io/earl-context.json',
+        '@graph': new Array()
+    };
+    for (const report of reports || []) {
+        const earlReport = generateSingleEarlReport(report, options);
+        aggregatedReport['@graph'].push(lodash_clonedeep_1.default(earlReport['@graph'][0]));
+    }
+    return aggregatedReport;
+}
+function generateEARLReport(reports, options) {
+    const earlReports = {};
+    if (options && options.aggregated) {
+        const firstUrl = Object.keys(reports)[0];
+        earlReports[options.aggregatedName || firstUrl] = generateAggregatedEarlReport(Object.values(reports), options);
+    }
+    else {
+        for (const url in reports || {}) {
+            const earlReport = generateSingleEarlReport(reports[url], options);
+            earlReports[url] = lodash_clonedeep_1.default(earlReport);
+        }
+    }
+    return lodash_clonedeep_1.default(earlReports);
+}
+exports.generateEARLReport = generateEARLReport;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,63 +1,58 @@
-{
-  "name": "@qualweb/earl-reporter",
-  "version": "0.4.3",
-  "description": "Qualweb earl reporter",
-  "main": "dist/index.js",
-  "files": [
-    "dist/*"
-  ],
-  "scripts": {
-    "tsc": "tsc",
-    "test": "mocha --require esm",
-    "prebuild": "rimraf dist",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "format": "prettier --config .prettierrc 'src/**/*.ts' --write",
-    "build": "npm run prebuild && tsc --build",
-    "prepare": "npm run build"
-  },
-  "keywords": [
-    "earl",
-    "json-ld",
-    "a11y",
-    "normalized",
-    "report",
-    "accessibility"
-  ],
-  "homepage": "https://github.com/qualweb/earl-reporter#readme",
-  "bugs": {
-    "url": "https://github.com/qualweb/earl-reporter/issues",
-    "email": "qualweb@fc.ul.pt"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/qualweb/earl-reporter.git"
-  },
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "author": "João Vicente",
-  "license": "ISC",
-  "devDependencies": {
-    "@qualweb/types": "^0.7.18",
-    "@tsconfig/recommended": "^1.0.1",
-    "@types/lodash.clonedeep": "^4.5.6",
-    "@types/node": "^14.14.35",
-    "@typescript-eslint/eslint-plugin": "^4.19.0",
-    "@typescript-eslint/parser": "^4.19.0",
-    "chai": "^4.3.4",
-    "eslint": "^7.22.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "eslint-plugin-sonarjs": "^0.6.0",
-    "esm": "^3.2.25",
-    "mocha": "^8.3.2",
-    "prettier": "^2.2.1",
-    "rimraf": "^3.0.2",
-    "typedoc": "^0.20.33",
-    "typescript": "^4.2.3"
-  },
-  "dependencies": {
-    "lodash.clonedeep": "^4.5.0"
-  }
-}
+{
+  "name": "@qualweb/earl-reporter",
+  "version": "0.4.6",
+  "description": "Qualweb earl reporter",
+  "main": "dist/index.js",
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+    "tsc": "tsc",
+    "test": "mocha --require esm",
+    "prebuild": "rimraf dist",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier src/**/*.ts --write",
+    "build": "npm run prebuild && tsc --build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "earl",
+    "json-ld",
+    "a11y",
+    "normalized",
+    "report",
+    "accessibility"
+  ],
+  "homepage": "https://github.com/qualweb/earl-reporter#readme",
+  "bugs": {
+    "url": "https://github.com/qualweb/earl-reporter/issues",
+    "email": "qualweb@fc.ul.pt"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/qualweb/earl-reporter.git"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "author": "João Vicente",
+  "license": "ISC",
+  "devDependencies": {
+    "@qualweb/types": "0.7.25",
+    "@tsconfig/recommended": "^1.0.3",
+    "@types/lodash.clonedeep": "^4.5.9",
+    "@types/node": "^14.14.35",
+    "chai": "^5.0.0",
+    "eslint": "^8.56.0",
+    "esm": "^3.2.25",
+    "mocha": "^10.2.0",
+    "prettier": "^3.1.1",
+    "rimraf": "^5.0.5",
+    "typedoc": "^0.25.6",
+    "typescript": "^4.2.3"
+  },
+  "dependencies": {
+    "lodash.clonedeep": "^4.5.0"
+  }
+}

package/LICENSE

@@ -1,15 +0,0 @@
-ISC License
-
-Copyright (c) 2021, FCUL
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.