@govtechsg/oobee 0.10.72 → 0.10.75

package/DETAILS.md

@@ -130,6 +130,7 @@ Note: Level AAA are disabled by default.  Please specify `enable-wcag-aaa` in ru
 | td-headers-attr             | Ensure that each cell in a table that uses the headers attribute refers only to other cells in that table                                             | Must Fix    | WCAG 1.3.1             |
 | th-has-data-cells           | Ensure that `<th>` elements and elements with role=columnheader/rowheader have data cells they describe                                               | Must Fix    | WCAG 1.3.1             |
 | video-caption               | Ensures `<video>` elements have captions                                                                                                              | Must Fix    | WCAG 1.2.2             |
+| summary-name                | Ensure summary elements have discernible text                                                                                                         | Must Fix    | WCAG 4.1.2    
 | oobee-confusing-alt-text               | The image alt text set as 'img', 'image', 'picture', 'photo', or 'graphic' is confusing or not useful                                                                                                                            | Must Fix    | WCAG 1.1.1  
 | oobee-accessible-label               | Clickable elements (i.e. elements with mouse-click interaction) must have accessible labels.                                                                                                              | Must Fix    | WCAG 2.1.1, WCAG 4.1.2             |
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@govtechsg/oobee",
   "main": "dist/npmIndex.js",
-  "version": "0.10.72",
+  "version": "0.10.75",
   "type": "module",
   "author": "Government Technology Agency <info@tech.gov.sg>",
   "dependencies": {
@@ -10,7 +10,7 @@
     "@napi-rs/canvas": "^0.1.53",
     "@sentry/node": "^9.13.0",
     "@types/aws-sdk": "^0.0.42",
-    "axe-core": "^4.10.3",
+    "axe-core": "^4.11.1",
     "axios": "^1.8.2",
     "base64-stream": "^1.0.0",
     "cheerio": "^1.0.0-rc.12",
@@ -75,7 +75,8 @@
     "tough-cookie": "^5.0.0-rc.2",
     "micromatch": "github:micromatch/micromatch.git#4.0.8",
     "brace-expansion": "^1.1.12",
-    "tmp": "0.2.4"
+    "tmp": "0.2.4",
+    "tar": "^7.5.6"
   },
   "optionalDependencies": {
     "@napi-rs/canvas-darwin-arm64": "^0.1.53",

package/src/combine.ts

@@ -328,4 +328,4 @@ const combineRun = async (details: Data, deviceToScan: string) => {
   }
 };
 
-export default combineRun;
+export default combineRun;

package/src/constants/common.ts

@@ -1257,14 +1257,14 @@ const cloneChromeProfileCookieFiles = (options: GlobOptionsWithFileTypesFalse, d
   if (os.platform() === 'win32') {
     profileCookiesDir = globSync('**/Network/Cookies', {
       ...options,
-      ignore: ['oobee/**'],
+      ignore: ['oobee*/**'],
     });
     profileNamesRegex = /User Data\\(.*?)\\Network/;
   } else if (os.platform() === 'darwin') {
     // maxDepth 2 to avoid copying cookies from the oobee directory if it exists
     profileCookiesDir = globSync('**/Cookies', {
       ...options,
-      ignore: 'oobee/**',
+      ignore: 'oobee*/**',
     });
     profileNamesRegex = /Chrome\/(.*?)\/Cookies/;
   }

package/src/constants/constants.ts

@@ -610,6 +610,7 @@ export const a11yRuleShortDescriptionMap = {
   'table-duplicate-name': 'Table caption and summary must not be identical',
   'meta-viewport': 'Pages must allow zoom and text scaling',
   'aria-allowed-role': 'Elements must use appropriate roles matching their actual behavior',
+  'summary-name': 'Summary must have discernible text'
 };
 
 export const a11yRuleLongDescriptionMap = {
@@ -801,6 +802,7 @@ export const a11yRuleLongDescriptionMap = {
   'meta-viewport':
     'Pages must allow users to zoom in and scale text using their browser or pinch-to-zoom on mobile devices. Disabling zoom locks people with low vision out of being able to enlarge content to read them comfortably. The viewport meta tag should allow scaling and not restrict maximum zoom.',
   'aria-allowed-role': `Buttons, links, and interactive elements should behave the way they're marked. e.g., if something looks and acts like a button (performs an action), it should be labeled as a button. If it goes to a different page, it should be labeled as a link. When the label doesn't match the actual behavior, screen reader users get confused about what will happen when they click. When possible, use real buttons (<button>) and real links (<a>) instead of creating fake buttons or links from plain text and code.`,
+  'summary-name': 'Ensure summary elements have discernible text that clearly indicates the topic or purpose of the information that will be revealed when using the summary control.'
 };
 
 export const disabilityBadgesMap = {

package/src/crawlers/crawlSitemap.ts

@@ -447,4 +447,4 @@ const crawlSitemap = async ({
   return { urlsCrawled, durationExceeded };
 };
 
-export default crawlSitemap;
+export default crawlSitemap;

package/src/mergeAxeResults.ts

@@ -210,7 +210,7 @@ const writeCsv = async (allIssues, storagePath) => {
           scanCompletedAt: allIssues.endTime ? allIssues.endTime.toISOString() : '',
           severity: severity || '',
           issueId: issueId || '',
-          issueDescription: issueDescription || '',
+          issueDescription: a11yRuleShortDescriptionMap[issueId] || issueDescription || '',
           wcagConformance: wcagConformance || '',
           url: url || '',
           pageTitle: affectedPage.pageTitle || 'No page title',
@@ -390,8 +390,37 @@ const writeHTML = async (
 
   outputStream.write(prefixData);
 
-  outputStream.write(`let proxyUrl = "${process.env.PROXY_API_BASE_URL}"\n`);
+  // For Proxied AI environments only
+  outputStream.write(`let proxyUrl = "${process.env.PROXY_API_BASE_URL || ""}"\n`);
 
+  // Initialize GenAI feature flag
+  outputStream.write(`
+  // Fetch GenAI feature flag from backend
+  window.oobeeGenAiFeatureEnabled = false;
+  if (proxyUrl !== "" && proxyUrl !== undefined && proxyUrl !== null) {
+    (async () => {
+      try {
+        const featuresUrl = proxyUrl + '/api/ai/features';
+        const response = await fetch(featuresUrl, {
+          method: 'GET',
+          headers: { 'Accept': 'application/json' }
+        });
+        if (response.ok) {
+          const features = await response.json();
+          window.oobeeGenAiFeatureEnabled = features.genai_ui_enabled || false;
+          console.log('GenAI UI feature flag:', window.oobeeGenAiFeatureEnabled);
+        } else {
+          console.warn('Failed to fetch GenAI feature flag:', response.status);
+        }
+      } catch (error) {
+        console.warn('Error fetching GenAI feature flag:', error);
+      }
+    })();
+  } else {
+    console.warn('Skipping fetch GenAI feature as it is local report');
+  }
+  \n`)
+  
   // outputStream.write("scanData = decompressJsonObject('");
   outputStream.write(
     "let scanDataPromise = (async () => { console.log('Loading scanData...'); scanData = await decodeUnzipParse('",
@@ -446,6 +475,13 @@ const writeSummaryHTML = async (
   fs.writeFileSync(`${storagePath}/${htmlFilename}.html`, html);
 };
 
+const writeSitemap = async (pagesScanned: PageInfo[], storagePath: string) => {
+  const sitemapPath = path.join(storagePath, 'sitemap.txt');
+  const content = pagesScanned.map(p => p.url).join('\n');
+  await fs.writeFile(sitemapPath, content, { encoding: 'utf-8' });
+  consoleLogger.info(`Sitemap written to ${sitemapPath}`);
+};
+
 const cleanUpJsonFiles = async (filesToDelete: string[]) => {
   consoleLogger.info('Cleaning up JSON files...');
   filesToDelete.forEach(file => {
@@ -799,10 +835,24 @@ const writeJsonAndBase64Files = async (
 
   // Refactor scanIssuesSummary to reuse the scanItemsMiniReport structure by stripping out pagesAffected
   const scanIssuesSummary = {
-    mustFix: items.mustFix.rules.map(({ pagesAffected, ...ruleInfo }) => ruleInfo),
-    goodToFix: items.goodToFix.rules.map(({ pagesAffected, ...ruleInfo }) => ruleInfo),
-    needsReview: items.needsReview.rules.map(({ pagesAffected, ...ruleInfo }) => ruleInfo),
-    passed: items.passed.rules.map(({ pagesAffected, ...ruleInfo }) => ruleInfo),
+
+    // Replace rule descriptions with short descriptions from the map
+    mustFix: items.mustFix.rules.map(({ pagesAffected, ...ruleInfo }) => ({
+      ...ruleInfo,
+      description: a11yRuleShortDescriptionMap[ruleInfo.rule] || ruleInfo.description,
+    })),
+    goodToFix: items.goodToFix.rules.map(({ pagesAffected, ...ruleInfo }) => ({
+      ...ruleInfo,
+      description: a11yRuleShortDescriptionMap[ruleInfo.rule] || ruleInfo.description,
+    })),
+    needsReview: items.needsReview.rules.map(({ pagesAffected, ...ruleInfo }) => ({
+      ...ruleInfo,
+      description: a11yRuleShortDescriptionMap[ruleInfo.rule] || ruleInfo.description,
+    })),
+    passed: items.passed.rules.map(({ pagesAffected, ...ruleInfo }) => ({
+      ...ruleInfo,
+      description: a11yRuleShortDescriptionMap[ruleInfo.rule] || ruleInfo.description,
+    })),
   };
 
   // Write out the scanIssuesSummary JSON using the new structure
@@ -1164,7 +1214,8 @@ const getTopTenIssues = allIssues => {
       rulesWithCounts.push({
         category,
         ruleId: rule.rule,
-        description: rule.description,
+        // Replace description with new Oobee short description if available
+        description: a11yRuleShortDescriptionMap[rule.rule] || rule.description,
         axeImpact: rule.axeImpact,
         conformance: rule.conformance,
         totalItems: rule.totalItems,
@@ -1951,6 +2002,7 @@ const generateArtifacts = async (
   }
 
   await writeCsv(allIssues, storagePath);
+  await writeSitemap(pagesScanned, storagePath);
   const {
     scanDataJsonFilePath,
     scanDataBase64FilePath,
@@ -2125,4 +2177,4 @@ export {
   formatAboutStartTime,
 };
 
-export default generateArtifacts;
+export default generateArtifacts;

package/src/services/s3Uploader.ts

@@ -181,4 +181,4 @@ export const getS3UploadPrefix = (): string | null => {
   }
 
   return `users/${userId}/scans/${scanId}`;
-};
+};

package/src/static/ejs/partials/scripts/ruleModal/constants.ejs

@@ -1,5 +1,5 @@
 <script>
-  const a11yPlaygroundLink = 'https://a11y.tech.gov.sg/';
+  const a11yPlaygroundLink = 'https://a11y.tech.gov.sg/?utm_source=oobee';
 
   const whyItMatters = {
     accesskeys:
@@ -945,5 +945,13 @@
       review: `Test with keyboard: Try clicking buttons (Space or Enter), try clicking links (Enter). Use a screen reader to hear if it's announced as a button or link. Confirm what it announces matches what it actually does.`,
       learn: 'Review and learn more about this issue on A11y Playground',
     },
+    'summary-name': {
+      check:
+        'Find summary elements with and check if text is inside, or has a label (aria-label or title). Check: Do they convey meaningful information about the details?',
+      fix: '(Developer) If summary are missing text or labels, add one to provide context or explanation to the details.',
+      review:
+        'Use a screen reader to navigate to the summary and ensure it is announced with clear information.',
+      learn: 'Review and learn more about this issue on A11y Playground',
+    },
   };
 </script>

package/src/static/ejs/partials/scripts/ruleModal/itemCardRenderer.ejs

@@ -147,6 +147,7 @@
 
   function createItemCard(item, isPurpleAiRule, oobeeAiQueryLabel, aiConfig) {
     const isGenAiSupportedRule = ['color-contrast', 'oobee-accessible-label', 'image-alt', 'listitem', 'link-in-text-block', 'target-size'].includes(aiConfig.ruleInCategory.rule);
+    const showGenAiUI = window.oobeeGenAiFeatureEnabled && isGenAiSupportedRule;
 
     return createElementFromString(`
       <div>
@@ -166,7 +167,7 @@
               : ''
           }
           ${isPurpleAiRule ? createAiSuggestionSection(item, oobeeAiQueryLabel, aiConfig) : ''}
-          ${isGenAiSupportedRule ? createGenAiSuggestFixSection(item, aiConfig) : ''}
+          ${showGenAiUI ? createGenAiSuggestFixSection(item, aiConfig) : ''}
         </div>
       </div>
     `);