@govtechsg/oobee 0.10.51 → 0.10.58

package/.github/workflows/bump-package-version.yml

@@ -0,0 +1,58 @@
+name: Bump Package Version
+
+on:
+  workflow_dispatch:  # Trigger manually from GitHub UI
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for creating new branches
+
+      - name: Set up Node.js 22
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Get current version
+        id: current
+        run: |
+          current_version=$(node -p "require('./package.json').version")
+          echo "version=$current_version" >> "$GITHUB_OUTPUT"
+
+      - name: Bump patch version
+        id: bump
+        run: |
+          new_version=$(npm version patch --no-git-tag-version)
+          echo "version=$new_version" >> "$GITHUB_OUTPUT"
+
+      - name: Create branch and commit changes
+        run: |
+          BRANCH="bump/version-${{ steps.bump.outputs.version }}"
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git checkout -b "$BRANCH"
+          git add package.json package-lock.json
+          git commit -m "chore: bump version ${{ steps.current.outputs.version }} → ${{ steps.bump.outputs.version }}"
+          git push origin "$BRANCH"
+          echo "BRANCH=$BRANCH" >> $GITHUB_ENV
+
+      - name: Authenticate GitHub CLI
+        run: |
+          echo "${{ secrets.GITHUB_TOKEN }}" | gh auth login --with-token
+
+      - name: Create pull request
+        run: |
+          gh pr create \
+            --title "chore: bump version to ${{ steps.bump.outputs.version }}" \
+            --body "Automated version bump from ${{ steps.current.outputs.version }} to ${{ steps.bump.outputs.version }}." \
+            --head "$BRANCH" \
+            --base "${{ github.ref_name }}"

package/.github/workflows/image.yml

@@ -119,25 +119,46 @@ jobs:
                | sed -E 's/^[[:space:]]*[0-9]+\) ([^"]+).*$/\1/')
           echo "id=$ID" >> $GITHUB_OUTPUT
 
-      - name: Sign required binaries for MacOS
+      - name: Sign all Mach-O binaries (deep)
+        shell: bash
         run: |
-          # Find a valid code signing certificate in your keychain for distribution outside Mac App Store
-          CERTIFICATE=$(security find-identity -v -p codesigning -s - | tail -n +2 | grep -o '"Developer ID Application:[^"]*"' | sed 's/"//g')
-
-          # Paths to the binaries you want to sign only ending with .node
-          BINARIES=($(find . -type f \( -name "*.node" -o -name "*.sh" -o -name "*.command" \) ! -path "*.framework/*" ! -path "*.dSYM/*"))
-
-          # Loop through the binary paths and sign each one with a secure timestamp
-          for binary in "${BINARIES[@]}"; do
-            # Check if the binary is already signed
-            codesign --timestamp -f -s "$CERTIFICATE" "$binary"
-            if [ $? -eq 0 ]; then
-              echo "Successfully signed (with secure timestamp): $binary"
-            else
-              echo "Failed to sign: $binary"
-            fi
-          done
+          set -euo pipefail
 
+          # Ensure the build keychain is available & unlocked in THIS step
+          security list-keychains -d user -s build.keychain
+          security default-keychain -d user -s build.keychain
+          security unlock-keychain -p "" build.keychain
+
+          echo "Available signing identities in build.keychain:"
+          security find-identity -v -p codesigning build.keychain || true
+
+          # Extract the FULL identity name (between the quotes)
+          CERTIFICATE_NAME=$(security find-identity -v -p codesigning build.keychain \
+            | awk -F\" '/Developer ID Application:/{print $2; exit}')
+
+          if [[ -z "${CERTIFICATE_NAME}" ]]; then
+            echo "ERROR: No 'Developer ID Application' identity found in build.keychain."
+            exit 1
+          fi
+          echo "Using identity: ${CERTIFICATE_NAME}"
+
+          # Ensure we can re-sign files (node_modules sometimes read-only)
+          chmod -R u+w "$GITHUB_WORKSPACE/oobee"
+
+          # Sign all Mach-O (exec bits OR dylib OR node native addons)
+          while IFS= read -r f; do
+            echo "Signing $f"
+            codesign --force --options runtime --timestamp --sign "${CERTIFICATE_NAME}" "$f"
+          done < <(
+            find "$GITHUB_WORKSPACE/oobee" -type f \
+              \( -perm -111 -o -name "*.dylib" -o -name "*.node" \) \
+              ! -path "*/.git/*"
+          )
+
+          echo "Verifying signatures of Mach-O files..."
+          find "$GITHUB_WORKSPACE/oobee" -type f \( -perm -111 -o -name "*.dylib" -o -name "*.node" \) \
+            -exec codesign --verify --strict --verbose=2 {} \; || true
+          
       - name: Cleanup keychain
         if: always()
         run: security delete-keychain build.keychain

package/DETAILS.md

@@ -44,6 +44,7 @@ Note: Level AAA are disabled by default.  Please specify `enable-wcag-aaa` in ru
 | WCAG 1.4.6  | AAA   | Yes      |             |              |
 | WCAG 1.4.12 | AA    | Yes      |             |              |
 | WCAG 2.1.1  | A     | Yes      |             |              |
+| WCAG 2.1.3  | AAA   | Yes *    |             |              |
 | WCAG 2.2.1  | A     | Yes      |             |              |
 | WCAG 2.2.2  | A     | Yes      |             |              |
 | WCAG 2.2.4  | AAA   |          | Yes         |              |
@@ -60,12 +61,14 @@ Note: Level AAA are disabled by default.  Please specify `enable-wcag-aaa` in ru
 | WCAG 4.1.2  | A     | Yes      |             |              |
 | Best Practice|      |          | Yes         |              |
 
+* The WCAG 2.1.3 check is done by 'Scrollable region must have keyboard access' which is a WCAG 2.1.1 (Must Fix) rule.
+
 ### Summary of WCAG Clauses Supported
 | Level | Count |
 |-------|-------|
 | A     | 15    |
 | AA    | 5     |
-| AAA   | 5     |
+| AAA   | 6     |
 
 
 ## WCAG 2.0 Level A
@@ -120,7 +123,7 @@ Note: Level AAA are disabled by default.  Please specify `enable-wcag-aaa` in ru
 | no-autoplay-audio           | Ensures `<video>` or `<audio>` elements do not autoplay audio for more than 3 seconds without a control mechanism to stop or mute the audio           | Must Fix    | WCAG 1.4.2             |
 | object-alt                  | Ensures `<object>` elements have alternate text                                                                                                       | Must Fix    | WCAG 1.1.1             |
 | role-img-alt                | Ensures [role="img"] elements have alternate text                                                                                                     | Must Fix    | WCAG 1.1.1             |
-| scrollable-region-focusable | Ensure elements that have scrollable content are accessible by keyboard                                                                               | Must Fix    | WCAG 2.1.1             |
+| scrollable-region-focusable | Ensure elements that have scrollable content are accessible by keyboard                                                                               | Must Fix    | WCAG 2.1.1, WCAG 2.1.3 |
 | select-name                 | Ensures select element has an accessible name                                                                                                         | Must Fix    | WCAG 4.1.2             |
 | server-side-image-map       | Ensures that server-side image maps are not used                                                                                                      | Must Fix    | WCAG 2.1.1             |
 | svg-img-alt                 | Ensures `<svg>` elements with an img, graphics-document or graphics-symbol role have an accessible text                                               | Must Fix    | WCAG 1.1.1             |

package/INTEGRATION.md

@@ -53,7 +53,7 @@ Returns an instance of Oobee
 - `scanAboutMetadata` (optional)
   - Include additional information in the Scan About section of the report by passing in a JSON object.
 - `zip` (optional)
-  - Name of the generated zip of Oobee results at the end of scan. Defaults to "oobee-scan-results".
+  - Name of the generated zip of Oobee results at the end of scan. Defaults to "oobee-scan-results.zip".
 - `deviceChosen` (optional)
   - Name of the device to scan on. Example: `iPhone 13 Pro Max`
 - `strategy` (optional)
@@ -185,7 +185,7 @@ Create <code>cypress.config.js</code> with the following contents, and change yo
     // additional information to include in the "Scan About" section of the report
     const scanAboutMetadata = { browser: 'Chrome (Desktop)' };
     // name of the generated zip of the results at the end of scan
-    const resultsZipName = "oobee-scan-results"
+    const resultsZipName = "oobee-scan-results.zip";
 
     const oobeeA11y = await oobeeA11yInit({
       entryUrl: "https://govtechsg.github.io", // initial url to start scan
@@ -211,23 +211,23 @@ Create <code>cypress.config.js</code> with the following contents, and change yo
         e2e: {
             setupNodeEvents(on, _config) {
                 on("task", {
-                    getPurpleA11yScripts() {
+                    getOobeeA11yScripts() {
                         return oobeeA11y.getScripts();
                     },
                     gradeReadability(sentences) {
                         return oobeeA11y.gradeReadability(sentences);
                     },
-                    async pushPurpleA11yScanResults({res, metadata, elementsToClick}) {
+                    async pushOobeeA11yScanResults({res, metadata, elementsToClick}) {
                         return await oobeeA11y.pushScanResults(res, metadata, elementsToClick);
                     },
                     returnResultsDir() {
                         return `results/${oobeeA11y.randomToken}_${oobeeA11y.scanDetails.urlsCrawled.scanned.length}pages/report.html`;
                     },
-                    finishPurpleA11yTestCase() {
+                    finishOobeeA11yTestCase() {
                         oobeeA11y.testThresholds();
                         return null;
                     },
-                    async terminatePurpleA11y() {
+                    async terminateOobeeA11y() {
                         return await oobeeA11y.terminate();
                     },
                 });
@@ -237,15 +237,15 @@ Create <code>cypress.config.js</code> with the following contents, and change yo
 
 Create a sub-folder and file <code>cypress/support/e2e.js</code> with the following contents:
 
-    Cypress.Commands.add("injectPurpleA11yScripts", () => {
-        cy.task("getPurpleA11yScripts").then((s) => {
+    Cypress.Commands.add("injectOobeeA11yScripts", () => {
+        cy.task("getOobeeA11yScripts").then((s) => {
             cy.window().then((win) => {
                 win.eval(s);
             });
         });
     });
 
-    Cypress.Commands.add("runPurpleA11yScan", (items={}) => {
+    Cypress.Commands.add("runOobeeA11yScan", (items={}) => {
         cy.window().then(async (win) => {
             const { elementsToScan, elementsToClick, metadata } = items;
 
@@ -259,7 +259,7 @@ Create a sub-folder and file <code>cypress/support/e2e.js</code> with the follow
                         elementsToScan,
                         gradingReadabilityFlag,
                     );
-                    cy.task("pushPurpleA11yScanResults", {
+                    cy.task("pushOobeeA11yScanResults", {
                         res,
                         metadata,
                         elementsToClick,
@@ -268,12 +268,12 @@ Create a sub-folder and file <code>cypress/support/e2e.js</code> with the follow
                     });
                 },
             );
-            cy.task("finishPurpleA11yTestCase"); // test the accumulated number of issue occurrences against specified thresholds. If exceed, terminate oobeeA11y instance.
+            cy.task("finishOobeeA11yTestCase"); // test the accumulated number of issue occurrences against specified thresholds. If exceed, terminate oobeeA11y instance.
         });
     });
 
-    Cypress.Commands.add("terminatePurpleA11y", () => {
-        cy.task("terminatePurpleA11y");
+    Cypress.Commands.add("terminateOobeeA11y", () => {
+        cy.task("terminateOobeeA11y");
     });
 
 Create <code>cypress/e2e/spec.cy.js</code> with the following contents:
@@ -283,17 +283,17 @@ Create <code>cypress/e2e/spec.cy.js</code> with the following contents:
             cy.visit(
                 "https://govtechsg.github.io/purple-banner-embeds/purple-integrated-scan-example.htm"
             );
-            cy.injectPurpleA11yScripts();
-            cy.runPurpleA11yScan();
+            cy.injectOobeeA11yScripts();
+            cy.runOobeeA11yScan();
              cy.get("button[onclick=\"toggleSecondSection()\"]").click();
             // Run a scan on <input> and <button> elements
-            cy.runPurpleA11yScan({
+            cy.runOobeeA11yScan({
                 elementsToScan: ["input", "button"],
                 elementsToClick: ["button[onclick=\"toggleSecondSection()\"]"],
                 metadata: "Clicked button"
             });
 
-            cy.terminatePurpleA11y();
+            cy.terminateOobeeA11y();
         });
     });
 
@@ -373,7 +373,7 @@ Create <code>cypress.config.ts</code> with the following contents, and change yo
     // additional information to include in the "Scan About" section of the report
     const scanAboutMetadata: ScanAboutMetadata = { browser: 'Chrome (Desktop)' };
     // name of the generated zip of the results at the end of scan
-    const resultsZipName: string = "oobee-scan-results"
+    const resultsZipName: string = "oobee-scan-results.zip"
 
     const oobeeA11y = await oobeeA11yInit({
         "https://govtechsg.github.io", // initial url to start scan
@@ -399,23 +399,23 @@ Create <code>cypress.config.ts</code> with the following contents, and change yo
         e2e: {
             setupNodeEvents(on, _config) {
                 on("task", {
-                    getPurpleA11yScripts(): string {
+                    getOobeeA11yScripts(): string {
                         return oobeeA11y.getScripts();
                     },
                     gradeReadability(sentences: string[]): string {
                         return oobeeA11y.gradeReadability(sentences);
                     },
-                    async pushPurpleA11yScanResults({res, metadata, elementsToClick}: { res: any, metadata: any, elementsToClick: any[] }): Promise<{ mustFix: number, goodToFix: number }> {
+                    async pushOobeeA11yScanResults({res, metadata, elementsToClick}: { res: any, metadata: any, elementsToClick: any[] }): Promise<{ mustFix: number, goodToFix: number }> {
                         return await oobeeA11y.pushScanResults(res, metadata, elementsToClick);
                     },
                     returnResultsDir(): string {
                         return `results/${oobeeA11y.randomToken}_${oobeeA11y.scanDetails.urlsCrawled.scanned.length}pages/reports/report.html`;
                     },
-                    finishPurpleA11yTestCase(): null {
+                    finishOobeeA11yTestCase(): null {
                         oobeeA11y.testThresholds();
                         return null;
                     },
-                    async terminatePurpleA11y(): Promise<string> {
+                    async terminateOobeeA11y(): Promise<string> {
                         return await oobeeA11y.terminate();
                     },
                 });
@@ -427,15 +427,15 @@ Create <code>cypress.config.ts</code> with the following contents, and change yo
 
 Create a sub-folder and file <code>src/cypress/support/e2e.ts</code> with the following contents:
 
-    Cypress.Commands.add("injectPurpleA11yScripts", () => {
-        cy.task("getPurpleA11yScripts").then((s: string) => {
+    Cypress.Commands.add("injectOobeeA11yScripts", () => {
+        cy.task("getOobeeA11yScripts").then((s: string) => {
             cy.window().then((win) => {
                 win.eval(s);
             });
         });
     });
 
-    Cypress.Commands.add("runPurpleA11yScan", (items={}) => {
+    Cypress.Commands.add("runOobeeA11yScan", (items={}) => {
         cy.window().then(async (win) => {
             const { elementsToScan, elementsToClick, metadata } = items;
 
@@ -449,7 +449,7 @@ Create a sub-folder and file <code>src/cypress/support/e2e.ts</code> with the fo
                         elementsToScan,
                         gradingReadabilityFlag,
                     );
-                    cy.task("pushPurpleA11yScanResults", {
+                    cy.task("pushOobeeA11yScanResults", {
                         res,
                         metadata,
                         elementsToClick,
@@ -458,12 +458,12 @@ Create a sub-folder and file <code>src/cypress/support/e2e.ts</code> with the fo
                     });
                 },
             );
-            cy.task("finishPurpleA11yTestCase"); // test the accumulated number of issue occurrences against specified thresholds. If exceed, terminate oobeeA11y instance.
+            cy.task("finishOobeeA11yTestCase"); // test the accumulated number of issue occurrences against specified thresholds. If exceed, terminate oobeeA11y instance.
         });
     });
 
-    Cypress.Commands.add("terminatePurpleA11y", () => {
-        cy.task("terminatePurpleA11y");
+    Cypress.Commands.add("terminateOobeeA11y", () => {
+        cy.task("terminateOobeeA11y");
     });
 
 Create <code>src/cypress/e2e/spec.cy.ts</code> with the following contents:
@@ -473,17 +473,17 @@ Create <code>src/cypress/e2e/spec.cy.ts</code> with the following contents:
             cy.visit(
                 "https://govtechsg.github.io/purple-banner-embeds/oobee-integrated-scan-example.htm"
             );
-            cy.injectPurpleA11yScripts();
-            cy.runPurpleA11yScan();
+            cy.injectOobeeA11yScripts();
+            cy.runOobeeA11yScan();
              cy.get("button[onclick=\"toggleSecondSection()\"]").click();
             // Run a scan on <input> and <button> elements
-            cy.runPurpleA11yScan({
+            cy.runOobeeA11yScan({
                 elementsToScan: ["input", "button"],
                 elementsToClick: ["button[onclick=\"toggleSecondSection()\"]"],
                 metadata: "Clicked button"
             });
 
-            cy.terminatePurpleA11y();
+            cy.terminateOobeeA11y();
         });
     });
 
@@ -492,12 +492,12 @@ Create <code>cypress.d.ts</code> in the root directory with the following conten
 ```
 declare namespace Cypress {
   interface Chainable<Subject> {
-    injectPurpleA11yScripts(): Chainable<void>;
-    runPurpleA11yScan(options?: PurpleA11yScanOptions): Chainable<void>;
-    terminatePurpleA11y(): Chainable<any>;
+    injectOobeeA11yScripts(): Chainable<void>;
+    runOobeeA11yScan(options?: OobeeScanOptions): Chainable<void>;
+    terminateOobeeA11y(): Chainable<any>;
   }
 
-  interface PurpleA11yScanOptions {
+  interface OobeeScanOptions {
     elementsToScan?: string[];
     elementsToClick?: string[];
     metadata?: string;
@@ -535,7 +535,7 @@ Navigate to <code>node_modules/@govtechsg/oobee</code> and run <code>npm install
     npm run build
     cd ../../..
 
-On your project's root folder, create a Playwright test file <code>oobeeA11y-playwright-demo.js</code>:
+On your project's root folder, create a Playwright test file <code>oobee-playwright-demo.js</code>:
 
     import { chromium } from "playwright";
     import oobeeA11yInit from "@govtechsg/oobee";
@@ -547,6 +547,8 @@ On your project's root folder, create a Playwright test file <code>oobeeA11y-pla
     const thresholds = { mustFix: 20, goodToFix: 25 };
     // additional information to include in the "Scan About" section of the report
     const scanAboutMetadata = { browser: 'Chrome (Desktop)' };
+    // name of the generated zip of the results at the end of scan
+    const resultsZipName = "oobee-scan-results.zip";
 
     const oobeeA11y = await oobeeA11yInit({
         entryUrl: "https://govtechsg.github.io", // initial url to start scan
@@ -572,7 +574,7 @@ On your project's root folder, create a Playwright test file <code>oobeeA11y-pla
         const context = await browser.newContext();
         const page = await context.newPage();
 
-        const runPurpleA11yScan = async (elementsToScan, gradingReadabilityFlag) => {
+        const runOobeeA11yScan = async (elementsToScan, gradingReadabilityFlag) => {
             const scanRes = await page.evaluate(
                 async ({ elementsToScan, gradingReadabilityFlag }) => await runA11yScan(elementsToScan, gradingReadabilityFlag),
                 { elementsToScan, gradingReadabilityFlag },
@@ -587,11 +589,11 @@ On your project's root folder, create a Playwright test file <code>oobeeA11y-pla
         const sentences = await page.evaluate(() => extractText());
         const gradingReadabilityFlag = await oobeeA11y.gradeReadability(sentences);
 
-        await runPurpleA11yScan([], gradingReadabilityFlag);;
+        await runOobeeA11yScan([], gradingReadabilityFlag);
 
         await page.getByRole('button', { name: 'Click Me' }).click();
         // Run a scan on <input> and <button> elements
-        await runPurpleA11yScan(['input', 'button'])
+        await runOobeeA11yScan(['input', 'button'])
 
 
         // ---------------------
@@ -600,7 +602,7 @@ On your project's root folder, create a Playwright test file <code>oobeeA11y-pla
         await oobeeA11y.terminate();
     })();
 
-Run your test with <code>node oobeeA11y-playwright-demo.js</code> .
+Run your test with <code>node oobee-playwright-demo.js</code> .
 
 You will see Oobee results generated in <code>results</code> folder.
 
@@ -637,7 +639,7 @@ Navigate to <code>node_modules/@govtechsg/oobee</code> and run <code>npm install
     npm run build
     cd ../../..
 
-Create a sub-folder and Playwright test file <code>src/oobeeA11y-playwright-demo.ts</code> with the following contents:
+Create a sub-folder and Playwright test file <code>src/oobee-playwright-demo.ts</code> with the following contents:
 
     import { Browser, BrowserContext, Page, chromium } from "playwright";
     import oobeeA11yInit from "@govtechsg/oobee";
@@ -668,6 +670,8 @@ Create a sub-folder and Playwright test file <code>src/oobeeA11y-playwright-demo
     const thresholds: Thresholds = { mustFix: 20, goodToFix: 25 };
     // additional information to include in the "Scan About" section of the report
     const scanAboutMetadata: ScanAboutMetadata = { browser: 'Chrome (Desktop)' };
+    // name of the generated zip of the results at the end of scan
+    const resultsZipName: string = "oobee-scan-results.zip";
 
     const oobeeA11y = await oobeeA11yInit({
         entryUrl: "https://govtechsg.github.io", // initial url to start scan
@@ -693,7 +697,7 @@ Create a sub-folder and Playwright test file <code>src/oobeeA11y-playwright-demo
         const context: BrowserContext = await browser.newContext();
         const page: Page = await context.newPage();
 
-        const runPurpleA11yScan = async (elementsToScan?: string[], gradingReadabilityFlag?: string) => {
+        const runOobeeA11yScan = async (elementsToScan?: string[], gradingReadabilityFlag?: string) => {
             const scanRes = await page.evaluate(
                 async ({ elementsToScan, gradingReadabilityFlag }) => await runA11yScan(elementsToScan, gradingReadabilityFlag),
                 { elementsToScan, gradingReadabilityFlag },
@@ -708,11 +712,11 @@ Create a sub-folder and Playwright test file <code>src/oobeeA11y-playwright-demo
         const sentences = await page.evaluate(() => extractText());
         const gradingReadabilityFlag = await oobeeA11y.gradeReadability(sentences);
 
-        await runPurpleA11yScan([], gradingReadabilityFlag);
+        await runOobeeA11yScan([], gradingReadabilityFlag);
 
         await page.getByRole('button', { name: 'Click Me' }).click();
         // Run a scan on <input> and <button> elements
-        await runPurpleA11yScan(['input', 'button'])
+        await runOobeeA11yScan(['input', 'button'])
 
 
         // ---------------------
@@ -722,7 +726,7 @@ Create a sub-folder and Playwright test file <code>src/oobeeA11y-playwright-demo
     })();
 
 Compile your typescript code with <code>npx tsc</code>.  
-Run your test with <code>node dist/oobeeA11y-playwright-demo.js</code>.
+Run your test with <code>node dist/oobee-playwright-demo.js</code>.
 
 You will see Oobee results generated in <code>results</code> folder.
 
@@ -765,7 +769,7 @@ You will see Oobee results generated in <code>results</code> folder.
         return formattedCookies;
     };
 
-    const runPurpleA11yScan = command => {
+    const runOobeeA11yScan = command => {
         exec(command, (error, stdout, stderr) => {
             if (error) {
                 console.error(`Error: ${error.message}`);
@@ -790,8 +794,8 @@ You will see Oobee results generated in <code>results</code> folder.
                 // where -m "..." are the headers needed in the format "header1 value1, header2 value2" etc
                 // where -u ".../loginSuccess/" is the destination page after login
                 const command = `npm run cli -- -c website -u "https://authenticationtest.com/loginSuccess/" -p 1 -k "Your Name:email@domain.com" -m "${formattedCookies}"`;
-                console.log(`Executing PurpleA11y scan command:\n> ${command}\n`);
-                runPurpleA11yScan(command);
+                console.log(`Executing OobeeA11y scan command:\n> ${command}\n`);
+                runOobeeA11yScan(command);
             })
             .catch(err => {
                 console.error('Error:', err);
@@ -836,7 +840,7 @@ You will see Oobee results generated in <code>results</code> folder.
         return formattedCookies;
     };
 
-    const runPurpleA11yScan = (command: string): void => {
+    const runOobeeA11yScan = (command: string): void => {
         exec(command, (error, stdout, stderr) => {
             if (error) {
                 console.error(`Error: ${error.message}`);
@@ -861,8 +865,8 @@ You will see Oobee results generated in <code>results</code> folder.
                 // where -m "..." are the headers needed in the format "header1 value1, header2 value2" etc
                 // where -u ".../loginSuccess/" is the destination page after login
                 const command: string = `npm run cli -- -c website -u "https://authenticationtest.com/loginSuccess/" -p 1 -k "Your Name:email@domain.com" -m "${formattedCookies}"`;
-                console.log(`Executing PurpleA11y scan command:\n> ${command}\n`);
-                runPurpleA11yScan(command);
+                console.log(`Executing OobeeA11y scan command:\n> ${command}\n`);
+                runOobeeA11yScan(command);
             })
             .catch((err: Error) => {
                 console.error('Error:', err);

package/README.md

@@ -84,7 +84,8 @@ verapdf --version
 | Variable Name | Description | Default |
 | ------------- | ----------- | ------- |
 | OOBEE_VERBOSE | When set to `true`, log output goes to console | `false` |
-| RUNNING_FROM_PH_GUI | Legacy, replaced by OOBEE_VERBOSE | `false` |
+| OOBEE_FAST_CRAWLER| When set to `true`, increases scan concurrency at a rapid rate.  Experimental, may cause system stability issues on low-powered devices. | `false`|
+| OOBEE_VALIDATE_URL| When set to `true`, validates if URLs are valid and exits. | `false` |
 | WARN_LEVEL | Only used in tests. |  |
 
 #### Environment variables used internally (Do not set)
@@ -387,6 +388,8 @@ Options:
                                      (linux) base64 -d scanData.json.gz.b64 |
                                      gunzip > scanData.json\n
                                      [string] [choices: "yes", "no"] [default: "no"]
+  -l, --scanDuration                 Maximum scan duration in seconds (0 means u
+                                     nlimited)             [number] [default: 0]
 
 Examples:
   To scan sitemap of website:', 'npm run cli -- -c [ 1 | sitemap ] -u <url_lin

package/__tests__/test-sitemap-url-patterns.xml

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <!-- Valid HTTP(S) URLs -->
+  <url>
+    <loc>https://example.com/</loc>
+  </url>
+  <url>
+    <loc>https://example.com/about</loc>
+  </url>
+
+  <!-- Disallowed Schemes -->
+  <url>
+    <loc>mailto:hello@example.com</loc>
+  </url>
+  <url>
+    <loc>tel:+1234567890</loc>
+  </url>
+  <url>
+    <loc>sms:+1234567890</loc>
+  </url>
+  <url>
+    <loc>skype:live:username</loc>
+  </url>
+  <url>
+    <loc>zoommtg://zoom.us/join?confno=123456789</loc>
+  </url>
+  <url>
+    <loc>msteams://teams.microsoft.com/l/meetup-join/abc</loc>
+  </url>
+  <url>
+    <loc>whatsapp://send?text=Hello</loc>
+  </url>
+  <url>
+    <loc>slack://channel?id=xyz</loc>
+  </url>
+  <url>
+    <loc>tg://msg?text=hi</loc>
+  </url>
+  <url>
+    <loc>line://msg/text/hello</loc>
+  </url>
+  <url>
+    <loc>meet://conference/room</loc>
+  </url>
+  <url>
+    <loc>facetime://user@example.com</loc>
+  </url>
+  <url>
+    <loc>imessage://user@example.com</loc>
+  </url>
+  <url>
+    <loc>discord://channel/123</loc>
+  </url>
+  <url>
+    <loc>sgnl://invite/abc</loc>
+  </url>
+  <url>
+    <loc>webex://meeting/123</loc>
+  </url>
+  <url>
+    <loc>intent://some-intent</loc>
+  </url>
+  <url>
+    <loc>ms-outlook://calendar</loc>
+  </url>
+  <url>
+    <loc>ms-word://doc</loc>
+  </url>
+  <url>
+    <loc>ms-excel://sheet</loc>
+  </url>
+  <url>
+    <loc>ms-powerpoint://presentation</loc>
+  </url>
+  <url>
+    <loc>ms-office://open</loc>
+  </url>
+  <url>
+    <loc>onenote://note</loc>
+  </url>
+  <url>
+    <loc>vs://launch</loc>
+  </url>
+  <url>
+    <loc>chrome-extension://abc123/index.html</loc>
+  </url>
+  <url>
+    <loc>chrome-search://search?q=test</loc>
+  </url>
+  <url>
+    <loc>chrome://settings/</loc>
+  </url>
+  <url>
+    <loc>chrome-untrusted://example</loc>
+  </url>
+  <url>
+    <loc>devtools://devtools/bundled/inspector.html</loc>
+  </url>
+  <url>
+    <loc>isolated-app://app/index.html</loc>
+  </url>
+  <url>
+    <loc>#</loc>
+  </url>
+</urlset>

package/exclusions.txt

@@ -1,4 +1,5 @@
 \.*login.singpass.gov.sg\.*
+\.*login.id.singpass.gov.sg\.*
 \.*auth.singpass.gov.sg\.*
 \.*form.gov.sg\.*
 \.*login.microsoftonline.com\.*