@govtechsg/oobee 0.10.76 → 0.10.78-alpha1

package/dist/crawlers/custom/framesCheck.js

@@ -0,0 +1,37 @@
+export function framesCheck(cssSelector) {
+    let doc = document; // Start with the main document
+    let remainingSelector = ''; // To store the last part of the selector
+    let targetIframe = null;
+    // Split the selector into parts at "> html"
+    const diffParts = cssSelector.split(/\s*>\s*html\s*/);
+    for (let i = 0; i < diffParts.length - 1; i++) {
+        let iframeSelector = `${diffParts[i].trim()}`;
+        // Add back '> html' to the current part
+        if (i > 0) {
+            iframeSelector = `html > ${iframeSelector}`;
+        }
+        let frameset = null;
+        // Find the iframe using the current document context
+        if (doc.querySelector('frameset')) {
+            frameset = doc.querySelector('frameset');
+        }
+        if (frameset) {
+            doc = frameset;
+            iframeSelector = iframeSelector.split('body >')[1].trim();
+        }
+        targetIframe = doc.querySelector(iframeSelector);
+        if (targetIframe && targetIframe.contentDocument) {
+            // Update the document to the iframe's contentDocument
+            doc = targetIframe.contentDocument;
+        }
+        else {
+            console.warn(`Iframe not found or contentDocument inaccessible for selector: ${iframeSelector}`);
+            return { doc, remainingSelector: cssSelector }; // Return original selector if iframe not found
+        }
+    }
+    // The last part is the remaining CSS selector
+    remainingSelector = diffParts[diffParts.length - 1].trim();
+    // Remove any leading '>' combinators from remainingSelector
+    remainingSelector = `html${remainingSelector}`;
+    return { doc, remainingSelector };
+}

package/dist/crawlers/custom/getAxeConfiguration.js

@@ -0,0 +1,111 @@
+import { evaluateAltText } from "./evaluateAltText.js";
+export function getAxeConfiguration({ enableWcagAaa = false, gradingReadabilityFlag = '', disableOobee = false, }) {
+    return {
+        branding: {
+            application: 'oobee',
+        },
+        checks: [
+            {
+                id: 'oobee-confusing-alt-text',
+                metadata: {
+                    impact: 'serious',
+                    messages: {
+                        pass: 'The image alt text is probably useful.',
+                        fail: "The image alt text set as 'img', 'image', 'picture', 'photo', or 'graphic' is confusing or not useful.",
+                    },
+                },
+                evaluate: evaluateAltText,
+            },
+            {
+                id: 'oobee-accessible-label',
+                metadata: {
+                    impact: 'serious',
+                    messages: {
+                        pass: 'The clickable element has an accessible label.',
+                        fail: 'The clickable element does not have an accessible label.',
+                    },
+                },
+                evaluate: (node) => {
+                    return !node.dataset.flagged; // fail any element with a data-flagged attribute set to true
+                },
+            },
+            ...(enableWcagAaa
+                ? [
+                    {
+                        id: 'oobee-grading-text-contents',
+                        metadata: {
+                            impact: 'moderate',
+                            messages: {
+                                pass: 'The text content is easy to understand.',
+                                fail: 'The text content is potentially difficult to understand.',
+                                incomplete: `The text content is potentially difficult to read, with a Flesch-Kincaid Reading Ease score of ${gradingReadabilityFlag}.\nThe target passing score is above 50, indicating content readable by university students and lower grade levels.\nA higher score reflects better readability.`,
+                            },
+                        },
+                        evaluate: (_node) => {
+                            if (gradingReadabilityFlag === '') {
+                                return true; // Pass if no readability issues
+                            }
+                            // Fail if readability issues are detected
+                        },
+                    },
+                ]
+                : []),
+        ],
+        rules: [
+            { id: 'target-size', enabled: true },
+            {
+                id: 'oobee-confusing-alt-text',
+                selector: 'img[alt]',
+                enabled: true,
+                any: ['oobee-confusing-alt-text'],
+                tags: ['wcag2a', 'wcag111'],
+                metadata: {
+                    description: 'Ensures image alt text is clear and useful.',
+                    help: 'Image alt text must not be vague or unhelpful.',
+                    helpUrl: 'https://www.deque.com/blog/great-alt-text-introduction/',
+                },
+            },
+            {
+                id: 'oobee-accessible-label',
+                // selector: '*', // to be set with the checker function output xpaths converted to css selectors
+                enabled: true,
+                any: ['oobee-accessible-label'],
+                tags: ['wcag2a', 'wcag211', 'wcag412'],
+                metadata: {
+                    description: 'Ensures clickable elements have an accessible label.',
+                    help: 'Clickable elements must have accessible labels.',
+                    helpUrl: 'https://www.deque.com/blog/accessible-aria-buttons',
+                },
+            },
+            {
+                id: 'oobee-grading-text-contents',
+                selector: 'html',
+                enabled: true,
+                any: ['oobee-grading-text-contents'],
+                tags: ['wcag2aaa', 'wcag315'],
+                metadata: {
+                    description: 'Text content should be easy to understand for individuals with education levels up to university graduates. If the text content is difficult to understand, provide supplemental content or a version that is easy to understand.',
+                    help: 'Text content should be clear and plain to ensure that it is easily understood.',
+                    helpUrl: 'https://www.wcag.com/uncategorized/3-1-5-reading-level/',
+                },
+            },
+        ]
+            .filter(rule => (disableOobee ? !rule.id.startsWith('oobee') : true))
+            .concat(enableWcagAaa
+            ? [
+                {
+                    id: 'color-contrast-enhanced',
+                    enabled: true,
+                },
+                {
+                    id: 'identical-links-same-purpose',
+                    enabled: true,
+                },
+                {
+                    id: 'meta-refresh-no-exceptions',
+                    enabled: true,
+                },
+            ]
+            : []),
+    };
+}

package/dist/crawlers/custom/gradeReadability.js

@@ -0,0 +1,23 @@
+import textReadability from 'text-readability';
+export function gradeReadability(sentences) {
+    try {
+        // Check if any valid sentences were extracted
+        if (sentences.length === 0) {
+            return ''; // Return an empty string if no valid sentences are found
+        }
+        // Join the valid sentences into a single string
+        const filteredText = sentences.join(' ').trim();
+        // Count the total number of words in the filtered text
+        const wordCount = filteredText.split(/\s+/).length;
+        // Grade the text content only if there are 20 words or more
+        const readabilityScore = wordCount >= 20 ? textReadability.fleschReadingEase(filteredText) : 0;
+        // Log details for debugging
+        // Determine the return value
+        const result = readabilityScore === 0 || readabilityScore > 50 ? '' : readabilityScore.toString(); // Convert readabilityScore to string
+        return result;
+    }
+    catch (error) {
+        console.error('Error extracting and grading text:', error);
+        return ''; // Return an empty string in case of an error
+    }
+}