testaro 78.0.8 → 78.4.0

package/testaro/dupAtt.ts

@@ -0,0 +1,144 @@
+/*
+  © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2026 Jeff Witt.
+  © 2026 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+// ########## IMPORTS
+
+import type {Page} from 'playwright';
+import {getSource} from '../procs/getSource';
+import {getXPathCatalogIndex} from '../procs/xPath';
+import type {Report, StandardInstance} from '../types';
+
+/*
+  dupAtt
+  This test reports duplicate attributes. The test is performed on the source of the document, because browsers delete additional same-name attributes in the DOM.
+  Compiled to dupAtt.js by tsc (issue #73); edit this file, not the emitted one.
+*/
+
+// ########## FUNCTIONS
+
+// Returns the catalog index of the element with an ID and tag name, or of the body if none does. Duplicate attributes are found in the source, not the DOM, so the ID is the only handle on the element.
+const getIDCatalogIndex = (report: Report, tagName: string, id: string): string => {
+  const {catalog} = report;
+  if (id && catalog) {
+    const index = Object.keys(catalog).find(
+      key => catalog[key].id === id && catalog[key].tagName === tagName
+    );
+    if (index !== undefined) {
+      return index;
+    }
+  }
+  return getXPathCatalogIndex(report, '/html/body');
+};
+// Runs the test and returns the result.
+export const reporter = async (page: Page, report: Report, _: unknown, withItems: boolean) => {
+  // Initialize the data and standard result.
+  const data: {
+    total: number;
+    items?: {tagName: string; id: string; duplicatedAttribute: string}[];
+    prevented?: boolean;
+    error?: string;
+  } = {total: 0};
+  if (withItems) {
+    data.items = [];
+  }
+  let totals: number[] = [];
+  const standardInstances: StandardInstance[] = [];
+  // Get the source.
+  const sourceData = await getSource(page);
+  // If it was not obtained:
+  if (sourceData.prevented) {
+    // Report this.
+    data.prevented = true;
+    data.error = sourceData.error;
+  }
+  // Otherwise, i.e. if it was obtained:
+  else {
+    let rawPage = sourceData.source;
+    // Change any spacing character sequences in it to single spaces.
+    rawPage = rawPage.replace(/\s+/g, ' ');
+    // Delete any spaces adjacent to equal symbols in it.
+    rawPage = rawPage.replace(/ = | =|= /g, '=');
+    // Remove any escaped quotation marks from it.
+    rawPage = rawPage.replace(/\\"|\\'/g, '');
+    // Remove any script code from it.
+    rawPage = rawPage.replace(/<script(?: [^<>]+)?>.*?<\/script>/g, '');
+    rawPage = rawPage.replace(/<script(?: [^<>]+)?>/g, '');
+    rawPage = rawPage.replace(/<\/script>/g, '');
+    // Remove any comments from it.
+    rawPage = rawPage.replace(/<!--.*?-->/g, '');
+    // Extract the syntactically valid opening tags of its elements.
+    // A pageless source would make the match null; the original dereferenced it unguarded.
+    let elements: string[] = rawPage.match(/<[a-zA-Z]+(?: [^<>]+)?>/g)!;
+    // Delete their enclosing angle brackets and any closing slashes.
+    elements = elements.map(element => element.replace(/< ?| ?\/?>/g, ''));
+    // Delete the values of any attributes in them.
+    const nvElements = elements.map(element => element.replace(/="[^"]*"/g, ''));
+    // For each element:
+    nvElements.forEach((element, index) => {
+      // Identify its tag name and attributes.
+      const terms = element.split(' ');
+      // If it has 2 or more attributes:
+      if (terms.length > 2) {
+        // If any is duplicated:
+        const tagName = terms[0].toUpperCase();
+        const attributes = terms.slice(1);
+        attributes.sort();
+        const duplicatedAttribute = attributes.find(
+          (current, attIndex) => attributes[attIndex + 1] === current
+        );
+        if (duplicatedAttribute) {
+          // Add data on the element to the data.
+          const id = terms.includes('id')
+            ? elements[index].replace(/^.+id="/, '').replace(/".+/, '')
+            : '';
+          data.total++;
+          if (withItems) {
+            data.items!.push({
+              tagName,
+              id,
+              duplicatedAttribute
+            });
+          }
+        }
+      }
+    });
+    // If itemization is required and there are any instances:
+    if (data.items) {
+      // For each violator:
+      data.items.forEach(item => {
+        // Add an instance to the standard instances.
+        standardInstances.push({
+          ruleID: 'dupAtt',
+          what: `${item.tagName} element has 2 attributes named ${item.duplicatedAttribute}`,
+          ordinalSeverity: 2,
+          count: 1,
+          catalogIndex: getIDCatalogIndex(report, item.tagName, item.id)
+        });
+      });
+    }
+    // Otherwise, if itemization is not required and there are any violations:
+    else if (data.total) {
+      // Add a summary instance to the standard instances.
+      standardInstances.push({
+        ruleID: 'dupAtt',
+        what: 'In some elements 2 attributes have the same name',
+        ordinalSeverity: 2,
+        count: data.total
+      });
+    }
+    totals = [0, 0, data.total, 0];
+  }
+  // Return the data.
+  return {
+    data,
+    totals,
+    standardInstances
+  };
+};

package/testaro/elements.d.ts

@@ -0,0 +1,6 @@
+import type { Page } from 'playwright';
+export declare const reporter: (page: Page, _0: unknown, _1: unknown, _2: unknown, detailLevel?: number, tagName?: string | null, onlyVisible?: boolean, attribute?: string) => Promise<{
+    data: Record<string, unknown>;
+    totals: never[];
+    standardInstances: never[];
+}>;

package/testaro/elements.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
   © 2023 CVS Health and/or one of its affiliates. All rights reserved.
   © 2026 Jonathan Robert Pool.
@@ -6,7 +7,8 @@
 
   SPDX-License-Identifier: MIT
 */
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reporter = void 0;
 /*
   elements
   This test reports data about specified elements within the document body. Meanings of detailLevel values:
@@ -14,163 +16,161 @@
   1. Also data on each specified element.
   2. Data on each specified element also include the text content of the parent element.
   3. Data on each specified element also include data on its sibling nodes.
+  Compiled to elements.js by tsc (issue #73); edit this file, not the emitted one.
 */
-
 // FUNCTIONS
-
-exports.reporter = async (
-  page, _, _, detailLevel = 0, tagName = null, onlyVisible = false, attribute
-) => {
-  // Determine a selector of the specified elements, including any descendants of open shadow roots.
-  let selector = `body ${tagName ? tagName.toLowerCase() : '*'}`;
-  if (attribute) {
-    selector += `[${attribute}]`;
-  }
-  if (onlyVisible) {
-    selector += ':visible';
-  }
-  let data = {};
-  // Get the data on the elements.
-  try {
-    const locator = page.locator(selector);
-    data = await locator.evaluateAll((elements, detailLevel) => {
-      // FUNCTION DEFINITIONS START
-      // Compacts a string.
-      const compact = string => string.replace(/\s+/g, ' ').trim();
-      // Gets data on a sibling node of an element.
-      const getSibInfo = (node, nodeType, text) => {
-        const sibInfo = {
-          type: nodeType
-        };
-        // If the sibling node is an element:
-        if (nodeType === 1) {
-          sibInfo.tagName = node.tagName;
-          sibInfo.attributes = [];
-          Array.from(node.attributes).forEach(attribute => {
-            sibInfo.attributes.push({
-              name: attribute.name,
-              value: attribute.value
-            });
-          });
-        }
-        else if (nodeType === 3) {
-          sibInfo.text = compact(text);
-        }
-        return sibInfo;
-      };
-      // FUNCTION DEFINITIONS END
-      // Initialize the data with the count of the specified elements.
-      const data = {
-        total: elements.length
-      };
-      // If no itemization is required:
-      if (detailLevel === 0) {
-        // Return the element count.
-        return data;
-      }
-      // Otherwise, i.e. if itemization is required:
-      else {
-        // Initialize the item data.
-        data.items = [];
-        // For each specified element:
-        elements.forEach(element => {
-          // Initialize data on it.
-          const parent = element.parentElement;
-          const datum = {
-            tagName: element.tagName,
-            parentTagName: parent ? parent.tagName : '',
-            code: compact(element.outerHTML),
-            attributes: [],
-            textContent: compact(element.textContent)
-          };
-          // For each of its attributes:
-          for (const attribute of element.attributes) {
-            // Add data on the attribute to the element data.
-            const {name, value} = attribute;
-            datum.attributes.push({
-              name,
-              value
-            });
-            // If the element has reference labels:
-            if (name === 'aria-labelledby') {
-              // Add their texts to the element data.
-              const labelerIDs = value.split(/\s+/);
-              const labelers = [];
-              labelerIDs.forEach(id => {
-                const labeler = document.getElementById(id);
-                if (labeler) {
-                  labelers.push(compact(labeler.textContent));
+const reporter = async (page, _0, _1, _2, detailLevel = 0, tagName = null, onlyVisible = false, attribute) => {
+    // Determine a selector of the specified elements, including any descendants of open shadow roots.
+    let selector = `body ${tagName ? tagName.toLowerCase() : '*'}`;
+    if (attribute) {
+        selector += `[${attribute}]`;
+    }
+    if (onlyVisible) {
+        selector += ':visible';
+    }
+    let data = {};
+    // Get the data on the elements.
+    try {
+        const locator = page.locator(selector);
+        data = await locator.evaluateAll((elements, detailLevel) => {
+            // FUNCTION DEFINITIONS START
+            // Compacts a string.
+            const compact = (string) => string.replace(/\s+/g, ' ').trim();
+            // Gets data on a sibling node of an element.
+            const getSibInfo = (node, nodeType, text) => {
+                const sibInfo = {
+                    type: nodeType
+                };
+                // If the sibling node is an element:
+                if (nodeType === 1) {
+                    sibInfo.tagName = node.tagName;
+                    sibInfo.attributes = [];
+                    Array.from(node.attributes).forEach(attribute => {
+                        sibInfo.attributes.push({
+                            name: attribute.name,
+                            value: attribute.value
+                        });
+                    });
                 }
-              });
-              if (labelers.length) {
-                datum.labelers = labelers;
-              }
-            }
-          }
-          // If the element has text content:
-          const {labels, textContent} = element;
-          const compactContent = compact(textContent);
-          if (compactContent) {
-            // Add it to the element data.
-            datum.textContent = compactContent;
-          }
-          // If the element has labels:
-          if (labels && labels.length) {
-            // Add their texts to the element data.
-            datum.labels = Array.from(labels).map(label => compact(label.textContent));
-          }
-          // If the parental text content is required:
-          if (detailLevel > 1) {
-            // Add it (excluding any shadow-root descendants) to the element data.
-            datum.parentTextContent = parent ? compact(parent.textContent) : '';
-          }
-          // If sibling itemization is required:
-          if (detailLevel === 3) {
-            // Add data on the siblings, excluding any descendants of shadow roots, to the data.
-            datum.siblings = {
-              before: [],
-              after: []
-            };
-            let more = element;
-            while (more) {
-              more = more.previousSibling;
-              if (more) {
-                const {nodeType, nodeValue} = more;
-                if (! (nodeType === 3 && nodeValue === '')) {
-                  const sibInfo = getSibInfo(more, nodeType, nodeValue);
-                  datum.siblings.before.unshift(sibInfo);
+                else if (nodeType === 3) {
+                    sibInfo.text = compact(text);
                 }
-              }
+                return sibInfo;
+            };
+            // FUNCTION DEFINITIONS END
+            // Initialize the data with the count of the specified elements.
+            const data = {
+                total: elements.length
+            };
+            // If no itemization is required:
+            if (detailLevel === 0) {
+                // Return the element count.
+                return data;
             }
-            more = element;
-            while (more) {
-              more = more.nextSibling;
-              if (more) {
-                const {nodeType, textContent} = more;
-                if (! (nodeType === 3 && textContent === '')) {
-                  const sibInfo = getSibInfo(more, nodeType, compact(textContent));
-                  datum.siblings.after.push(sibInfo);
-                }
-              }
+            // Otherwise, i.e. if itemization is required:
+            else {
+                // Initialize the item data.
+                data.items = [];
+                // For each specified element:
+                elements.forEach(element => {
+                    // Initialize data on it.
+                    const parent = element.parentElement;
+                    const datum = {
+                        tagName: element.tagName,
+                        parentTagName: parent ? parent.tagName : '',
+                        code: compact(element.outerHTML),
+                        attributes: [],
+                        textContent: compact(element.textContent)
+                    };
+                    // For each of its attributes:
+                    for (const attribute of element.attributes) {
+                        // Add data on the attribute to the element data.
+                        const { name, value } = attribute;
+                        datum.attributes.push({
+                            name,
+                            value
+                        });
+                        // If the element has reference labels:
+                        if (name === 'aria-labelledby') {
+                            // Add their texts to the element data.
+                            const labelerIDs = value.split(/\s+/);
+                            const labelers = [];
+                            labelerIDs.forEach(id => {
+                                const labeler = document.getElementById(id);
+                                if (labeler) {
+                                    labelers.push(compact(labeler.textContent));
+                                }
+                            });
+                            if (labelers.length) {
+                                datum.labelers = labelers;
+                            }
+                        }
+                    }
+                    // If the element has text content:
+                    const { labels, textContent } = element;
+                    const compactContent = compact(textContent);
+                    if (compactContent) {
+                        // Add it to the element data.
+                        datum.textContent = compactContent;
+                    }
+                    // If the element has labels:
+                    if (labels && labels.length) {
+                        // Add their texts to the element data.
+                        datum.labels = Array.from(labels).map(label => compact(label.textContent));
+                    }
+                    // If the parental text content is required:
+                    if (detailLevel > 1) {
+                        // Add it (excluding any shadow-root descendants) to the element data.
+                        datum.parentTextContent = parent ? compact(parent.textContent) : '';
+                    }
+                    // If sibling itemization is required:
+                    if (detailLevel === 3) {
+                        // Add data on the siblings, excluding any descendants of shadow roots, to the data.
+                        datum.siblings = {
+                            before: [],
+                            after: []
+                        };
+                        let more = element;
+                        while (more) {
+                            more = more.previousSibling;
+                            if (more) {
+                                const { nodeType, nodeValue } = more;
+                                if (!(nodeType === 3 && nodeValue === '')) {
+                                    const sibInfo = getSibInfo(more, nodeType, nodeValue);
+                                    datum.siblings.before.unshift(sibInfo);
+                                }
+                            }
+                        }
+                        more = element;
+                        while (more) {
+                            more = more.nextSibling;
+                            if (more) {
+                                const { nodeType, textContent } = more;
+                                if (!(nodeType === 3 && textContent === '')) {
+                                    const sibInfo = getSibInfo(more, nodeType, compact(textContent));
+                                    datum.siblings.after.push(sibInfo);
+                                }
+                            }
+                        }
+                    }
+                    data.items.push(datum);
+                });
+                return data;
             }
-          }
-          data.items.push(datum);
-        });
-        return data;
-      }
-    }, detailLevel);
-  }
-  catch(error) {
-    console.log(`ERROR performing test (${error.message})`);
-    data = {
-      prevented: true,
-      error: 'ERROR performing test'
+        }, detailLevel);
+    }
+    catch (error) {
+        console.log(`ERROR performing test (${error.message})`);
+        data = {
+            prevented: true,
+            error: 'ERROR performing test'
+        };
+    }
+    // Return the result.
+    return {
+        data,
+        totals: [],
+        standardInstances: []
     };
-  }
-  // Return the result.
-  return {
-    data,
-    totals: [],
-    standardInstances: []
-  };
 };
+exports.reporter = reporter;