@qualweb/cui-checks 0.1.1 → 0.2.0

package/src/lib/decorator.ts

@@ -1,463 +0,0 @@
-import { CUICheck, CUICheckResult } from '@qualweb/cui-checks';
-import { Translate } from '@qualweb/locale';
-import rules from './rules.json';
-
-function CUICheckDecorator<T extends { new (...args: any[]): {} }>(constructor: T) {
-  const newConstructor: any = function () {
-    const locales = <Translate>arguments[0];
-
-    //@ts-ignore
-    const rule = <CUICheck>rules[constructor.name];
-
-    rule.metadata.passed = 0;
-    rule.metadata.warning = 0;
-    rule.metadata.failed = 0;
-    rule.metadata.inapplicable = 0;
-    rule.metadata.outcome = 'inapplicable';
-    try {
-      rule.name = <string>(
-        (locales.translate['act-rules']?.[rule.code]?.name ?? locales.fallback['act-rules']?.[rule.code]?.name)
-      );
-      rule.description = <string>(
-        (locales.translate['act-rules']?.[rule.code]?.description ??
-          locales.fallback['act-rules']?.[rule.code]?.description)
-      );
-      rule.metadata.description = <string>(
-        (locales.translate['act-rules']?.[rule.code]?.results?.I1 ??
-          locales.fallback['act-rules']?.[rule.code].results?.I1)
-      );
-    } catch (err) {
-      console.error(err);
-    }
-    rule.results = new Array<CUICheckResult>();
-
-    const func: any = function () {
-      return new constructor(rule, locales);
-    };
-    func.prototype = constructor.prototype;
-    return new func();
-  };
-  newConstructor.prototype = constructor.prototype;
-  return newConstructor;
-}
-
-function ElementExists(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    if (<typeof window.qwElement>arguments[0]) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsHTMLElement(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    if (element.isElementHTMLElement()) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementHasAttributes(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const hasAttributes = (<typeof window.qwElement>arguments[0]).elementHasAttributes();
-    if (hasAttributes) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementHasAttribute(attribute: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const attr = (<typeof window.qwElement>arguments[0]).elementHasAttribute(attribute);
-      if (attr) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementHasNonEmptyAttribute(attribute: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const attr = (<typeof window.qwElement>arguments[0]).getElementAttribute(attribute);
-      if (attr && attr.trim()) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementHasAttributeRole(role: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const _role = window.AccessibilityUtils.getElementRole(<typeof window.qwElement>arguments[0]);
-      if (!_role || _role === role) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementHasAttributeValue(attribute: string, value: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const attr = (<typeof window.qwElement>arguments[0]).getElementAttribute(attribute);
-      if (attr && attr === value) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function IfElementHasTagNameMustHaveAttributeRole(tagName: string, role: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const _tagName = (<typeof window.qwElement>arguments[0]).getElementTagName();
-      if (_tagName === tagName) {
-        const _role = (<typeof window.qwElement>arguments[0]).getElementAttribute('role'); // window.AccessibilityUtils.getElementRole(arguments[0], arguments[1]);
-        if (!_role || _role === role) {
-          return method.apply(this, arguments);
-        }
-      } else {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementHasText(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    if (window.DomUtils.getTrimmedText(element) !== '') {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementHasTextNode(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    if (element.elementHasTextNode()) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsInAccessibilityTree(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const isInAT = window.AccessibilityUtils.isElementInAT(<typeof window.qwElement>arguments[0]);
-    if (isInAT) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementHasNegativeTabIndex(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const tabindex = (<typeof window.qwElement>arguments[0]).getElementAttribute('tabindex');
-    if (tabindex && parseInt(tabindex) <= -1) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsNotInert(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    let notInert: boolean = true;
-    const hasInert = (<typeof window.qwElement>arguments[0]).elementHasAttribute('inert');
-    if (hasInert) {
-      const inert = (<typeof window.qwElement>arguments[0]).getElementAttribute('inert');
-      if (inert !== 'false') {
-        notInert = false;
-      }
-      if (!notInert) {
-        return;
-      }
-    }
-    let noParentInert: boolean = true;
-    let parent = (<typeof window.qwElement>arguments[0]).getElementParent();
-    while (parent) {
-      const inert = parent.getElementAttribute('inert');
-      if (inert && inert === 'true') {
-        noParentInert = false;
-      }
-      parent = parent.getElementParent();
-    }
-    if (!noParentInert) {
-      return;
-    }
-    if (window.qwPage.pageHasOpenDialog()) {
-      return;
-    }
-    return method.apply(this, arguments);
-  };
-}
-
-function ElementIsVisibleOrInAccessibilityTree(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const page = <typeof window.qwPage>window.qwPage;
-    const elements = page.getElements('*').filter((element: typeof window.qwElement) => {
-      return (
-        element.hasTextNode() &&
-        (window.DomUtils.isElementVisible(element) || window.AccessibilityUtils.isElementInAT(element))
-      );
-    });
-    if (elements.length > 0) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsNotHidden(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const notHidden = !window.DomUtils.isElementHidden(<typeof window.qwElement>arguments[0]);
-    if (notHidden) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementSrcAttributeFilenameEqualsAccessibleName(
-  _target: any,
-  _propertyKey: string,
-  descriptor: PropertyDescriptor
-) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const src = (<typeof window.qwElement>arguments[0]).getElementAttribute('src');
-    const srcSet = (<typeof window.qwElement>arguments[0]).getElementAttribute('srcset');
-    const parent = (<typeof window.qwElement>arguments[0]).getElementParent();
-    let filenameWithExtension = new Array<string>();
-    if (src) {
-      const filePath = src.split('/');
-      filenameWithExtension = [filePath[filePath.length - 1].trim().toLowerCase()];
-    }
-    if (srcSet) {
-      const srcSetElements = srcSet.split(',');
-      for (const srcsetElement of srcSetElements || []) {
-        const srcValue = srcsetElement.split(' ')[0];
-        const fileSrc = srcValue.split('/');
-        filenameWithExtension.push(fileSrc[fileSrc.length - 1].trim().toLowerCase());
-      }
-    }
-    if (parent) {
-      const parentTag = parent.getElementTagName();
-      if (parentTag === 'picture') {
-        const sourceElements = parent.getElements('source');
-        for (const sourceElement of sourceElements) {
-          const src = sourceElement.getElementAttribute('srcset');
-          if (src) {
-            const filePath = src.split('/');
-            filenameWithExtension.push(filePath[filePath.length - 1].trim().toLowerCase());
-          }
-        }
-      }
-    }
-
-    const accessibleName = window.AccessibilityUtils.getAccessibleName(<typeof window.qwElement>arguments[0]);
-
-    if (accessibleName && filenameWithExtension && filenameWithExtension.includes(accessibleName.toLowerCase())) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function isInMainContext(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const differentContext = (<typeof window.qwElement>arguments[0]).getElementAttribute('_documentSelector');
-    if (!differentContext || !differentContext.includes('>')) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsVisible(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const isVisible = window.DomUtils.isElementVisible(<typeof window.qwElement>arguments[0]);
-    if (isVisible) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsNot(names: string[]) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const name = (<typeof window.qwElement>arguments[0]).getElementTagName();
-      if (name && !names.includes(name)) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementHasOneOfTheFollowingRoles(roles: string[]) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const role = window.AccessibilityUtils.getElementRole(<typeof window.qwElement>arguments[0]);
-      if (!!role && roles.includes(role)) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function ElementIsWidget(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const isWidget = window.AccessibilityUtils.isElementWidget(<typeof window.qwElement>arguments[0]);
-    if (isWidget) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsNotWidget(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const isWidget = window.AccessibilityUtils.isElementWidget(<typeof window.qwElement>arguments[0]);
-    if (!isWidget) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementAllowsNameFromContent(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const supportsNameFromContent = window.AccessibilityUtils.allowsNameFromContent(
-      <typeof window.qwElement>arguments[0]
-    );
-    if (supportsNameFromContent) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function IsHTMLDocument(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    let IsNonHTMLDocument = false;
-    const htmlElement = window.qwPage.getElement('html');
-    if (htmlElement) IsNonHTMLDocument = htmlElement.getElementAttribute('nonHTMLPage') === 'true';
-    if (!IsNonHTMLDocument) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementHasCSSRules(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    if (element.getCSSRules()) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function IsLangSubTagValid(attribute: string) {
-  return function (_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-    const method = descriptor.value;
-    descriptor.value = function () {
-      const attr = (<typeof window.qwElement>arguments[0]).getElementAttribute(attribute);
-      if (attr && isSubTagValid(attr.split('-')[0])) {
-        return method.apply(this, arguments);
-      }
-    };
-  };
-}
-
-function isSubTagValid(subTag: string): boolean {
-  const languages = window.AccessibilityUtils.languages;
-  return languages.hasOwnProperty(subTag.toLowerCase());
-}
-
-function ElementIsImage(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    const role = window.AccessibilityUtils.getElementRole(element);
-    if (element.getElementTagName() === 'img' || role === 'img') {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-function ElementIsNonText(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    const isNonText = window.DomUtils.objectElementIsNonText(element);
-    if (isNonText) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-const semanticLinkRoles = ['link', 'doc-backlink', 'doc-biblioref', 'doc-glossref', 'doc-noteref'];
-
-function ElementIsSemanticLink(_target: any, _propertyKey: string, descriptor: PropertyDescriptor) {
-  const method = descriptor.value;
-  descriptor.value = function () {
-    const element = <typeof window.qwElement>arguments[0];
-    const role = window.AccessibilityUtils.getElementRole(element);
-    if (!!role && semanticLinkRoles.includes(role)) {
-      return method.apply(this, arguments);
-    }
-  };
-}
-
-export {
-  CUICheckDecorator,
-  ElementExists,
-  ElementIsHTMLElement,
-  ElementHasAttributes,
-  ElementHasAttribute,
-  ElementHasAttributeRole,
-  ElementHasAttributeValue,
-  IfElementHasTagNameMustHaveAttributeRole,
-  ElementHasNonEmptyAttribute,
-  ElementHasText,
-  ElementHasTextNode,
-  ElementIsInAccessibilityTree,
-  ElementSrcAttributeFilenameEqualsAccessibleName,
-  ElementIsVisible,
-  ElementIsNot,
-  ElementHasOneOfTheFollowingRoles,
-  ElementIsWidget,
-  ElementIsNotWidget,
-  ElementAllowsNameFromContent,
-  IsHTMLDocument,
-  IsLangSubTagValid,
-  isInMainContext,
-  ElementIsNotHidden,
-  ElementIsVisibleOrInAccessibilityTree,
-  ElementHasNegativeTabIndex,
-  ElementHasCSSRules,
-  ElementIsImage,
-  ElementIsNonText,
-  ElementIsSemanticLink,
-  ElementIsNotInert
-};

package/src/lib/rules.json

@@ -1,25 +0,0 @@
-{
-  "QW_CUI_C1": {
-    "name": "Testing check",
-    "code": "QW-CUI-C1",
-    "description": "This is a test.",
-    "metadata": {
-      "target": {
-        "element": "title"
-      },
-      "success-criteria": [
-        {
-          "name": "2.4.2",
-          "level": "A",
-          "principle": "Operable",
-          "url": "https://www.w3.org/WAI/WCAG21/Understanding/page-titled",
-		      "url_tr": "https://www.w3.org/TR/WCAG21/#page-titled"
-        }
-      ],
-      "related": ["G88", "H25"],
-      "url": "https://www.w3.org/WAI/standards-guidelines/act/rules/2779a5/",
-      "type": ["ACTRule", "TestCase"],
-      "a11yReq": ["WCAG21:title"]
-    }
-  }
-}

package/src/lib/rules.ts

@@ -1,5 +0,0 @@
-import QW_CUI_C1 from '../rules/QW-CUI-C1';
-
-export {
-  QW_CUI_C1,
-};

package/src/rules/QW-CUI-C1.ts

@@ -1,46 +0,0 @@
-import { CUICheck } from '@qualweb/cui-checks';
-import { Translate } from '@qualweb/locale';
-import { CUICheckDecorator, IsHTMLDocument } from '../lib/decorator';
-import Test from '../lib/Test.object';
-import Check from '../lib/Check.object';
-
-@CUICheckDecorator
-class QW_CUI_C1 extends Check {
-  constructor(rule: CUICheck, locale: Translate) {
-    super(rule, locale);
-  }
-
-  @IsHTMLDocument
-  execute(element: typeof window.qwElement | undefined): void {
-    //the first title element was already tested
-    if (super.getNumberOfPassedResults() + super.getNumberOfFailedResults() === 0) {
-      const test = new Test();
-      // the first title element was not tested yet
-      if (!element) {
-        //the title element does not exit
-        test.verdict = 'failed';
-        test.resultCode = 'F1';
-      }
-      //the title element is empty
-      else if (!element.getElementText() || element.getElementText().trim() === '') {
-        test.verdict = 'failed';
-        test.resultCode = 'F2';
-      } else if (element.getElementAttribute('_documentSelector')) {
-        test.verdict = 'failed';
-        test.resultCode = 'F3';
-      } else {
-        //the title element exists and it's not empty
-        test.verdict = 'passed';
-        test.resultCode = 'P1';
-      }
-
-      if (element) {
-        test.addElement(element);
-      }
-
-      super.addTestResult(test);
-    }
-  }
-}
-
-export = QW_CUI_C1;

package/tsconfig.json

@@ -1,43 +0,0 @@
-{
-  "extends": "@tsconfig/recommended/tsconfig.json",
-  "compilerOptions": {
-    /* Basic Options */
-    "resolveJsonModule": true,
-    "outDir": "./prebuild" /* Redirect output structure to the directory. */,
-    "rootDir": "." /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
-    "removeComments": true /* Do not emit comments to output. */,
-
-    /* Strict Type-Checking Options */
-    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
-    "strictNullChecks": true /* Enable strict null checks. */,
-    "strictFunctionTypes": true /* Enable strict checking of function types. */,
-    "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */,
-    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
-    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
-    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
-
-    /* Additional Checks */
-    "noUnusedLocals": true /* Report errors on unused locals. */,
-    "noUnusedParameters": true /* Report errors on unused parameters. */,
-    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
-    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
-
-    /* Module Resolution Options */
-    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
-
-    "types": [
-      "@qualweb/types",
-      "node",
-      "mocha",
-    ] /* Type declaration files to be included in compilation. */,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
-
-    /* Experimental Options */
-    "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
-    "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */
-  },
-  "include": [
-    "src/**/*.ts",
-    "test/**/*.ts",
-  ],
-}

package/tsconfig.prod.json

@@ -1,20 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
-
-    /* Additional Checks */
-    "noUnusedLocals": true /* Report errors on unused locals. */,
-    "noUnusedParameters": true /* Report errors on unused parameters. */,
-    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
-    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
-
-    "types": [
-      "@qualweb/types",
-      "node",
-    ] /* Type declaration files to be included in compilation. */,
-  },
-  "include": [
-    "src",
-  ],
-}

package/validate-rules.js

@@ -1,42 +0,0 @@
-/**
- * Validation script.
- * Uses the schema defined in: cui-checks.schema.json
- * For the cui checks in: src/lib/rules.json
- */
-
-const Ajv = require('ajv');
-const fsSync = require('fs');
-const path = require('path');
-
-const schemaPath = path.join(__dirname, 'cui-checks.schema.json');
-const cuichecksPath = path.join(__dirname, 'src', 'lib', 'rules.json');
-
-const ajv = new Ajv({
-  allErrors: true
-});
-
-console.info(`Using schema at ${schemaPath}`);
-console.info(`Using ACT rules defined in ${cuichecksPath}`);
-
-const schemaString = fsSync.readFileSync(schemaPath, 'utf-8');
-// const schemaString = await fs.readFile(schemaPath, 'utf-8');
-
-const schemaObject = JSON.parse(schemaString);
-
-const cuichecks = JSON.parse(fsSync.readFileSync(cuichecksPath, 'utf-8'));
-// const actrules = JSON.parse(await fs.readFile(actrulesPath, 'utf-8'));
-
-const validateFunction = ajv.compile(schemaObject);
-// const validateFunction = await ajv.compileAsync(schemaObject);
-
-console.info('Starting validation');
-
-const isValid = validateFunction(cuichecks);
-
-if (isValid === false && validateFunction.errors) {
-  for (const error of validateFunction.errors) {
-    console.error(error);
-  }
-} else {
-  console.info('Validation found no errors.');
-}

package/webpack.config.js

@@ -1,30 +0,0 @@
-const path = require('path');
-const TerserPlugin = require('terser-webpack-plugin');
-
-module.exports = {
-  mode: 'production',
-  entry: './prebuild/index.js',
-  output: {
-    filename: 'cui.bundle.js',
-    path: path.resolve(__dirname, 'dist'),
-    library: {
-      type: 'this'
-    }
-  },
-  optimization: {
-    minimize: true,
-    minimizer: [
-      new TerserPlugin({
-        terserOptions: {
-          compress: {
-            keep_classnames: true
-          },
-          mangle: {
-            keep_classnames: true
-          }
-        }
-      })
-    ]
-  },
-  target: 'web'
-}