@qualweb/cui-checks 0.2.2 → 0.3.1

package/dist/lib/readability.d.ts

@@ -0,0 +1,23 @@
+export declare function setBrowserFilePath(pathStr: string): void;
+export declare function getCommonWords(): Promise<string>;
+export declare function extractWords(textContent: string): string[];
+export declare function countComplexWordsPT(phrases: string[]): Promise<number>;
+export declare function countLetters(str: string): number;
+interface ITextCounters {
+    letters: number;
+    words: number;
+    syllables: number;
+    complexWords: number;
+    phrases: number;
+}
+type Grade = 'Alta legibilidade' | 'Média legibilidade' | 'Baixa legibilidade' | '';
+export interface IReadibiltyScores {
+    resultGrade: Grade;
+    result: number;
+}
+export declare function calculateReadabilityScores(counters: ITextCounters, language: string): IReadibiltyScores;
+export declare function getCounters(text: string, language: string): Promise<ITextCounters>;
+export declare function countPhrases(textContent: string): number;
+export declare function readability(text: string, language: string): Promise<IReadibiltyScores>;
+export {};
+//# sourceMappingURL=readability.d.ts.map

package/dist/lib/readability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"readability.d.ts","sourceRoot":"","sources":["../../src/lib/readability.ts"],"names":[],"mappings":"AAOA,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,QAEjD;AAQD,wBAAsB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAYtD;AAOD,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAG1D;AAmBD,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAwB5E;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,UAAU,aAAa;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,KAAK,KAAK,GAAG,mBAAmB,GAAG,oBAAoB,GAAG,oBAAoB,GAAG,EAAE,CAAC;AAEpF,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,KAAK,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAOD,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAiBvG;AAyCD,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAGxF;AAED,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAKxD;AAED,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAQ5F"}

package/dist/lib/readability.js

@@ -0,0 +1,161 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readability = exports.countPhrases = exports.getCounters = exports.calculateReadabilityScores = exports.countLetters = exports.countComplexWordsPT = exports.extractWords = exports.getCommonWords = exports.setBrowserFilePath = void 0;
+const syllable_pt_1 = __importDefault(require("syllable-pt"));
+const en_1 = require("hyphen/en");
+let browserFilePath = '';
+function setBrowserFilePath(pathStr) {
+    browserFilePath = pathStr;
+}
+exports.setBrowserFilePath = setBrowserFilePath;
+async function getCommonWords() {
+    try {
+        const response = await fetch(browserFilePath);
+        if (!response.ok) {
+            console.error('Error reading file:', response.statusText);
+            throw new Error(response.statusText);
+        }
+        return await response.text();
+    }
+    catch (error) {
+        console.error('Error fetching file:', error);
+        throw error;
+    }
+}
+exports.getCommonWords = getCommonWords;
+function extractWords(textContent) {
+    const pattern = /[a-zA-Zá-úÁ-ÚüÜçÇ]+(?:-[a-zA-Zá-úÁ-ÚüÜçÇ]+)*/gu;
+    return textContent.match(pattern) || [];
+}
+exports.extractWords = extractWords;
+function getPhrases(textContent) {
+    const regexPhrases = /[.!?]/g;
+    return textContent.split(regexPhrases);
+}
+function isNotComplexHeuristicPT(word) {
+    if (/\b[A-Z]{2,}(?:\d+)?(?:\.[A-Z]+)*\b/.test(word)) {
+        return true;
+    }
+    if (word[0].toUpperCase() === word[0]) {
+        return true;
+    }
+    return false;
+}
+let commonWordsSet = null;
+async function countComplexWordsPT(phrases) {
+    if (!commonWordsSet) {
+        const commonWordsText = await getCommonWords();
+        commonWordsSet = new Set(commonWordsText
+            .split(/\r?\n/)
+            .map(word => word.toLowerCase().trim()));
+    }
+    let complexWords = 0;
+    for (const phrase of phrases) {
+        const words = extractWords(phrase);
+        for (const word of words) {
+            if (isNotComplexHeuristicPT(word))
+                continue;
+            if (!commonWordsSet.has(word.toLowerCase())) {
+                complexWords++;
+            }
+        }
+    }
+    return complexWords;
+}
+exports.countComplexWordsPT = countComplexWordsPT;
+function countLetters(str) {
+    return [...str].filter((char) => /\p{L}/u.test(char)).length;
+}
+exports.countLetters = countLetters;
+function calculateReadabilityScores(counters, language) {
+    const metrics = {
+        resultGrade: '',
+        result: 0
+    };
+    metrics['result'] = readabilityFormulas[language](counters);
+    if (metrics['result'] < 13) {
+        metrics['resultGrade'] = 'Alta legibilidade';
+    }
+    else if (metrics['result'] >= 13 && metrics['result'] < 17) {
+        metrics['resultGrade'] = 'Média legibilidade';
+    }
+    else {
+        metrics['resultGrade'] = 'Baixa legibilidade';
+    }
+    return metrics;
+}
+exports.calculateReadabilityScores = calculateReadabilityScores;
+const getCountersMap = {
+    pt: async (text) => {
+        const counters = { letters: 0, words: 0, syllables: 0, complexWords: 0, phrases: 0 };
+        let words = extractWords(text);
+        let phrases = getPhrases(text);
+        counters['phrases'] = countPhrases(text);
+        counters['letters'] += countLetters(text);
+        counters['complexWords'] = await countComplexWordsPT(phrases);
+        for (let word of words) {
+            let countSyllable = await (0, syllable_pt_1.default)(word);
+            counters['words']++;
+            counters['syllables'] += countSyllable.split(' ').length;
+        }
+        return counters;
+    },
+    en: async (text) => {
+        const counters = { letters: 0, words: 0, syllables: 0, complexWords: 0, phrases: 0 };
+        let words = extractWords(text);
+        counters['phrases'] = countPhrases(text);
+        counters['letters'] += countLetters(text);
+        counters['complexWords'] = 0;
+        for (let word of words) {
+            counters['words']++;
+            const hyphenated = await (0, en_1.hyphenate)(word);
+            let syllableCount = hyphenated.split('\u00AD').length;
+            if (syllableCount >= 3) {
+                counters['complexWords']++;
+            }
+            counters['syllables'] += syllableCount;
+        }
+        return counters;
+    }
+};
+async function getCounters(text, language) {
+    const fn = getCountersMap[language];
+    return fn(text);
+}
+exports.getCounters = getCounters;
+function countPhrases(textContent) {
+    const regexPhrases = /[.!?]/g;
+    let phrases = textContent.match(regexPhrases);
+    return phrases != null ? phrases.length : 1;
+}
+exports.countPhrases = countPhrases;
+async function readability(text, language) {
+    if (!(language in readabilityFormulas) || !(language in getCountersMap)) {
+        throw new Error(`Unsupported language: ${language}`);
+    }
+    const counters = await getCounters(text, language);
+    let score = calculateReadabilityScores(counters, language);
+    return score;
+}
+exports.readability = readability;
+const readabilityFormulas = {
+    pt: (counters) => {
+        let fleschKincaidGradeLevel = Number.parseFloat((0.36 * (counters.words / counters.phrases) + 10.4 * (counters.syllables / counters.words) - 18).toFixed(1));
+        let gunningFogIndexScore = Number.parseFloat((0.49 * (counters.words / counters.phrases) + 19 * (counters.complexWords / counters.words)).toFixed(1));
+        let automatedReadabilityIndex = Number.parseFloat((4.6 * (counters.letters / counters.words) + 0.44 * (counters.words / counters.phrases) - 20).toFixed(1));
+        let colemanLiauIndexScore = Number.parseFloat((5.4 * (counters.letters / counters.words) - 21 * (counters.phrases / counters.words) - 14).toFixed(1));
+        return Math.round((fleschKincaidGradeLevel + gunningFogIndexScore + automatedReadabilityIndex + colemanLiauIndexScore) / 4);
+    },
+    en: (counters) => {
+        let fleschKincaidGradeLevel = Number.parseFloat((0.39 * (counters.words / counters.phrases) + 11.8 * (counters.syllables / counters.words) - 15.59).toFixed(1));
+        let gunningFogIndexScore = Number.parseFloat((0.4 * (counters.words / counters.phrases) + 100 * (counters.complexWords / counters.words)).toFixed(1));
+        let automatedReadabilityIndex = Number.parseFloat((4.71 * (counters.letters / counters.words) + 0.5 * (counters.words / counters.phrases) - 21.43).toFixed(1));
+        let colemanLiauIndexScore = Number.parseFloat((0.0588 * (counters.letters / counters.words) -
+            0.296 * ((counters.phrases * 100) / counters.words) -
+            15.8).toFixed(1));
+        return Math.round((fleschKincaidGradeLevel + gunningFogIndexScore + automatedReadabilityIndex + colemanLiauIndexScore) / 4);
+    }
+};

package/dist/lib/selectors.d.ts

@@ -0,0 +1,8 @@
+export interface QWCUI_Selectors {
+    QW_CC_WINDOW: string;
+    QW_CC_DIALOG: string;
+    QW_CC_MESSAGES: string;
+    QW_CC_MIC: string;
+    QW_CC_INPUT: string;
+}
+//# sourceMappingURL=selectors.d.ts.map

package/dist/lib/selectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../src/lib/selectors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/dist/lib/selectors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/types.d.ts

@@ -0,0 +1,6 @@
+export interface RuleTest {
+    code: string;
+    selector: string;
+    result: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACrB,IAAI,EAAC,MAAM,CAAC;IACZ,QAAQ,EAAC,MAAM,CAAC;IAChB,MAAM,EAAC,MAAM,CAAC;CACf"}

package/dist/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/units.d.ts

@@ -0,0 +1,2 @@
+export declare function recognizeUnitByLocale(locale: string, text: string): boolean | null;
+//# sourceMappingURL=units.d.ts.map

package/dist/lib/units.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"units.d.ts","sourceRoot":"","sources":["../../src/lib/units.ts"],"names":[],"mappings":"AA2BA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAC,IAAI,EAAC,MAAM,GAAG,OAAO,GAAG,IAAI,CAyBhF"}

package/dist/lib/units.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recognizeUnitByLocale = void 0;
+const recognizers_text_number_with_unit_1 = require("@microsoft/recognizers-text-number-with-unit");
+const cultureMapping = {
+    'en': recognizers_text_number_with_unit_1.Culture.English,
+    'fr': recognizers_text_number_with_unit_1.Culture.French,
+    'de': recognizers_text_number_with_unit_1.Culture.German,
+    'it': recognizers_text_number_with_unit_1.Culture.Italian,
+    'es': recognizers_text_number_with_unit_1.Culture.Spanish,
+    'pt': recognizers_text_number_with_unit_1.Culture.Portuguese,
+    'nl': recognizers_text_number_with_unit_1.Culture.Dutch,
+};
+function recognizeUnitByLocale(locale, text) {
+    const language = locale.split('-')[0];
+    if (!(language in cultureMapping)) {
+        return null;
+    }
+    let results = (0, recognizers_text_number_with_unit_1.recognizeDimension)(text, cultureMapping[language]);
+    console.log('Recognized dimensions:', JSON.stringify(results));
+    if (results.length > 0) {
+        return true;
+    }
+    for (const lang in cultureMapping) {
+        if (lang !== language) {
+            results = (0, recognizers_text_number_with_unit_1.recognizeDimension)(text, cultureMapping[lang]);
+            if (results.length > 0) {
+                return false;
+            }
+        }
+    }
+    return null;
+}
+exports.recognizeUnitByLocale = recognizeUnitByLocale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualweb/cui-checks",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "Accessibility tests for conversational user interfaces",
   "files": [
     "dist/*"
@@ -20,12 +20,13 @@
   },
   "scripts": {
     "tsc": "tsc",
-    "test": "mocha",
+    "test": "mocha --require ts-node/register  --tsconfig ./tsconfig.test.json",
     "lint": "eslint",
     "format": "prettier src/**/*.ts --write",
     "clean": "rimraf dist",
     "build": "tsc --build tsconfig.prod.json && webpack",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "postinstall": "node -e \"const fs=require('fs'); if(fs.existsSync('./fix-syllable-pt.js')) require('./fix-syllable-pt.js')\""
   },
   "homepage": "https://github.com/qualweb/qualweb/blob/main/packages/cui-checks",
   "repository": {
@@ -39,22 +40,42 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@qualweb/core": "^0.8.2",
+    "@qualweb/core": "^0.8.5",
     "@qualweb/locale": "0.2.2",
     "@qualweb/qw-page": "0.3.2",
-    "@qualweb/util": "0.6.2",
+    "@qualweb/util": "0.6.4",
     "@tsconfig/recommended": "^1.0.3",
+    "@types/hyphen": "^1.6.7",
+    "@types/intl": "^1.2.2",
+    "@types/langdetect": "^0.2.2",
+    "@types/luxon": "^3.6.2",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^16.11.11",
+    "@types/node": "^16.18.126",
     "@types/node-fetch": "^2.6.11",
+    "@types/sinon": "^17.0.3",
+    "@types/utf8": "^3.0.3",
     "chai": "^4.4.1",
     "mocha": "^10.2.0",
+    "npm": "^11.1.0",
+    "nyc": "^17.1.0",
     "prettier": "^3.1.1",
     "puppeteer": "^22.12.1",
     "rimraf": "^5.0.5",
+    "sinon": "^19.0.2",
+    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
     "typescript": "^4.7.4",
     "webpack": "^5.89.0",
     "webpack-cli": "^4.9.1"
+  },
+  "dependencies": {
+    "@microsoft/recognizers-text-number-with-unit": "^1.3.0",
+    "hyphen": "^1.10.6",
+    "locale-currency": "^0.0.4",
+    "luxon": "^3.6.1",
+    "syllable": "^5.0.1",
+    "syllable-pt": "^1.0.4",
+    "tinyld": "^1.3.4",
+    "utf8": "^3.0.0"
   }
 }