@uuv/a11y 0.0.1 → 1.0.0-beta.10

package/CHANGELOG.md

@@ -0,0 +1,123 @@
+## [1.0.0-beta.10](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.9...a11y-v1.0.0-beta.10) (2024-02-15)
+
+
+### Bug Fixes
+
+* **runner-playwright:** update dependency axe-core to v4.8.4 ([1db34e2](https://github.com/Orange-OpenSource/uuv/commit/1db34e26b498bfc83d47cfd98064faa1aa65f558))
+
+## [1.0.0-beta.9](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.8...a11y-v1.0.0-beta.9) (2024-02-13)
+
+
+### Bug Fixes
+
+* update dependency multiple-cucumber-html-reporter to v3.6.2 ([95d85c3](https://github.com/Orange-OpenSource/uuv/commit/95d85c3f29ff261232f75c83175d795b63766a89))
+
+## [1.0.0-beta.8](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.7...a11y-v1.0.0-beta.8) (2024-02-13)
+
+
+### Features
+
+* **a11y:** add rgaa criteria 5.1 to 5.5, [#451](https://github.com/Orange-OpenSource/uuv/issues/451) ([fa3b369](https://github.com/Orange-OpenSource/uuv/commit/fa3b3693e102b54e1d72321aba573e66c864f4e3))
+* **a11y:** add rgaa criteria 5.6 to 5.8, [#451](https://github.com/Orange-OpenSource/uuv/issues/451) ([9cdf4ad](https://github.com/Orange-OpenSource/uuv/commit/9cdf4ad0e5ba16d7b8ddb90e014d96fc741acc17))
+
+## [1.0.0-beta.7](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.6...a11y-v1.0.0-beta.7) (2024-01-24)
+
+
+### Features
+
+* **a11y:** add rgaa topic 2, [#432](https://github.com/Orange-OpenSource/uuv/issues/432) ([#450](https://github.com/Orange-OpenSource/uuv/issues/450)) ([231d95b](https://github.com/Orange-OpenSource/uuv/commit/231d95b48ecfbeb0c86f44d0de0ca8c68df7b9f1))
+
+## [1.0.0-beta.6](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.5...a11y-v1.0.0-beta.6) (2024-01-23)
+
+
+### Features
+
+* **a11y:** add RGAA 1.1.6 and 1.1.3, [#429](https://github.com/Orange-OpenSource/uuv/issues/429) ([0e65889](https://github.com/Orange-OpenSource/uuv/commit/0e65889b479651c27e16c29fdb8e5123fe689f03))
+
+
+### Bug Fixes
+
+* **runner-playwright:** update dependency axe-core to v4.8.3 ([4623485](https://github.com/Orange-OpenSource/uuv/commit/46234851677cf0e5f0479fe30bc786ae2a607f1e))
+
+## [1.0.0-beta.5](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.4...a11y-v1.0.0-beta.5) (2024-01-21)
+
+
+### Bug Fixes
+
+* **a11y:** update dependency @testing-library/dom to v9.3.4 ([368b6b4](https://github.com/Orange-OpenSource/uuv/commit/368b6b4210f83d2da7695a0bfedd8ac593df171a))
+* **assistant:** fix assistant and enable uuv test for assistant, [#437](https://github.com/Orange-OpenSource/uuv/issues/437) ([da82e1b](https://github.com/Orange-OpenSource/uuv/commit/da82e1b588a391eb24573ac8c3f2db18cfdbf5a5))
+* **deps:** update dependency @easyops-cn/docusaurus-search-local to v0.40.1 ([d5ed3d7](https://github.com/Orange-OpenSource/uuv/commit/d5ed3d75f44e2b83af81fcd7227521dea00371e6))
+
+## [1.0.0-beta.4](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.3...a11y-v1.0.0-beta.4) (2024-01-11)
+
+
+### Features
+
+* **a11y:** add a contains sentence for a11y rgaa, [#424](https://github.com/Orange-OpenSource/uuv/issues/424) ([297cc33](https://github.com/Orange-OpenSource/uuv/commit/297cc3378798d1eb9c973a2038423ae6f874f70f))
+
+## [1.0.0-beta.3](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.2...a11y-v1.0.0-beta.3) (2024-01-08)
+
+
+### Features
+
+* **a11y:** reduce @uuv/a11y bundle size, [#330](https://github.com/Orange-OpenSource/uuv/issues/330) ([139b85a](https://github.com/Orange-OpenSource/uuv/commit/139b85a56e2ce4b8f370df4f6d410a9a1807e3b6))
+
+## [1.0.0-beta.2](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.1...a11y-v1.0.0-beta.2) (2024-01-08)
+
+
+### Bug Fixes
+
+* **a11y:** fix post first publish, [#330](https://github.com/Orange-OpenSource/uuv/issues/330) ([76cf65b](https://github.com/Orange-OpenSource/uuv/commit/76cf65ba219f6128c58ecdec608d3cb4fe72bcc9))
+* **a11y:** update unpkg usage and stackblitz link, [#330](https://github.com/Orange-OpenSource/uuv/issues/330) ([6032415](https://github.com/Orange-OpenSource/uuv/commit/6032415fdf16ae1be23e96785e7c66b779d8cbf9))
+
+## 1.0.0-beta.1 (2024-01-08)
+
+
+### Features
+
+* **a11y:** initialize @uuv/a11y lib, [#330](https://github.com/Orange-OpenSource/uuv/issues/330) ([3c27ac5](https://github.com/Orange-OpenSource/uuv/commit/3c27ac5a1698a407289123aac85e500508e2d8c6))
+* add accessibility tab and arrows, [#166](https://github.com/Orange-OpenSource/uuv/issues/166) ([9b926cd](https://github.com/Orange-OpenSource/uuv/commit/9b926cd322049860a5f06810027dbeb7efe6d795))
+* **assistant:** setting up electron, fixes [#132](https://github.com/Orange-OpenSource/uuv/issues/132) ([6d6e99c](https://github.com/Orange-OpenSource/uuv/commit/6d6e99cbbdb498e1d5f24a0386e52ae38fa1b161))
+* **docs:** add autocompletion searchfield to steps definition page, [#255](https://github.com/Orange-OpenSource/uuv/issues/255) ([a0323ee](https://github.com/Orange-OpenSource/uuv/commit/a0323eec01a6351f9b60399398d145cb2bc86779))
+* **runner-playwright:** add error details and screenshot to report, fixes [#110](https://github.com/Orange-OpenSource/uuv/issues/110) ([3c4a3cd](https://github.com/Orange-OpenSource/uuv/commit/3c4a3cd192b90242dd07bbdc4bb3ece780ee0c40))
+* **runner-playwright:** add tags option for runner-playwright, [#416](https://github.com/Orange-OpenSource/uuv/issues/416) ([8787581](https://github.com/Orange-OpenSource/uuv/commit/87875818114bbf77ff4b35ff8ccb26d525eba450))
+* **runner-playwright:** regenerate .spec when update, add or remove a .feature in open mode, [#236](https://github.com/Orange-OpenSource/uuv/issues/236) ([8a2599a](https://github.com/Orange-OpenSource/uuv/commit/8a2599a3fa4e577b9e626929537f2cc5f8e57bcc))
+* setup assistant-electron package, [#132](https://github.com/Orange-OpenSource/uuv/issues/132) ([76d69c2](https://github.com/Orange-OpenSource/uuv/commit/76d69c2b5d311b40cb42c9511d224d7911133e10))
+
+
+### Bug Fixes
+
+* **assistant:** fix assistant css problem, [#120](https://github.com/Orange-OpenSource/uuv/issues/120) ([026d66a](https://github.com/Orange-OpenSource/uuv/commit/026d66ad6ad7e9090282f1734335c5a7b1e417c6))
+* **assistant:** moving test app in component ([5bdc75b](https://github.com/Orange-OpenSource/uuv/commit/5bdc75b9ae4aec75f7a944513af0d57a4107cefd))
+* **deps:** update dependency @cucumber/cucumber to v9.3.0 ([212250b](https://github.com/Orange-OpenSource/uuv/commit/212250be47e040e34de18af33986a1f26f7b00a2))
+* **deps:** update dependency @cucumber/cucumber to v9.6.0 ([d0ac7ca](https://github.com/Orange-OpenSource/uuv/commit/d0ac7ca26b3d9d1fddd17d7cb6c7034ff640e483))
+* **deps:** update dependency @cucumber/cucumber to v9.6.0 ([52a3e4c](https://github.com/Orange-OpenSource/uuv/commit/52a3e4c14fbe3b87b9b7f97b56a3e437f71f36bf))
+* **deps:** update dependency @cypress/webpack-preprocessor to v5.17.1 ([9570e56](https://github.com/Orange-OpenSource/uuv/commit/9570e5689387a2c770994576d779a34ff242ca76))
+* **deps:** update dependency antd to v5.11.4 ([33a0cf4](https://github.com/Orange-OpenSource/uuv/commit/33a0cf4d6973e8bcc50c805a091b11deaa9afe72))
+* **deps:** update dependency antd to v5.12.2 ([0c472ee](https://github.com/Orange-OpenSource/uuv/commit/0c472eef7a05ed343c6aa9576092ba001c9ffb00))
+* **deps:** update dependency antd to v5.7.3 ([452fc3c](https://github.com/Orange-OpenSource/uuv/commit/452fc3c3861509e8aba46b3efa248f365bbfb747))
+* **deps:** update dependency axe-core to v4.7.2 ([965b9dc](https://github.com/Orange-OpenSource/uuv/commit/965b9dcb1445c369c770ed056ab990e3f966197b))
+* **deps:** update dependency axe-core to v4.8.2 ([66b7dc2](https://github.com/Orange-OpenSource/uuv/commit/66b7dc2fbd63a9d4429964abb50f63a88e06e99b))
+* **deps:** update dependency cypress to v12.17.2 ([49a3012](https://github.com/Orange-OpenSource/uuv/commit/49a3012f7ebf0e6ecc879d21ff86147938967607))
+* **deps:** update dependency cypress to v12.17.3 ([35c812b](https://github.com/Orange-OpenSource/uuv/commit/35c812bdabd1a3a2d27e972d3bb5c9323497c449))
+* **deps:** update dependency cypress to v12.17.4 ([998b754](https://github.com/Orange-OpenSource/uuv/commit/998b754038941de8b035abbd47800d45b1dac022))
+* **deps:** update dependency cypress-axe to v1.5.0 ([816775f](https://github.com/Orange-OpenSource/uuv/commit/816775f89ec46d385e3fb6d8322a70165c7e5ea5))
+* **deps:** update dependency cypress-real-events to v1.10.1 ([f60978d](https://github.com/Orange-OpenSource/uuv/commit/f60978da4bdd76483bcb2479324ccbbf3b36d87b))
+* **deps:** update dependency cypress-real-events to v1.10.3 ([9e3c991](https://github.com/Orange-OpenSource/uuv/commit/9e3c9914420c6d527f7ad8b0017a0f8e26250f86))
+* **deps:** update dependency cypress-real-events to v1.11.0 ([1694807](https://github.com/Orange-OpenSource/uuv/commit/169480777dc4c87f14a2deb5c10beb9cb0e43238))
+* **deps:** update dependency figlet to v1.7.0 ([8fbde74](https://github.com/Orange-OpenSource/uuv/commit/8fbde7405cef7576b1cd4151785be463a823e6ef))
+* **deps:** update dependency multiple-cucumber-html-reporter to v3.5.0 ([b8a9dab](https://github.com/Orange-OpenSource/uuv/commit/b8a9dabed814d5cea192be9aeefdeb8af93249ce))
+* **deps:** update dependency nanoid to v3.3.6 ([82fa0c3](https://github.com/Orange-OpenSource/uuv/commit/82fa0c31207a9004a8b365fe0e92fcaac38e1be3))
+* **deps:** update dependency nanoid to v3.3.7 ([7d1d60e](https://github.com/Orange-OpenSource/uuv/commit/7d1d60e32fd7f799c61beaace586a9869791f55b))
+* **deps:** update dependency primereact to v9.6.3 ([f52ee84](https://github.com/Orange-OpenSource/uuv/commit/f52ee84daccc1380586e2da95d10592f9dd87e8b))
+* **deps:** update dependency primereact to v9.6.4 ([ed3e76c](https://github.com/Orange-OpenSource/uuv/commit/ed3e76c6da6af1d9c17f98e0802ffbb1a46124a4))
+* **deps:** update dependency ts-node to v10.9.2 ([b5c5ebb](https://github.com/Orange-OpenSource/uuv/commit/b5c5ebbc1eb9556d66c9494d45b089018580ba70))
+* **deps:** update dependency tslib to v2.6.2 ([f43d897](https://github.com/Orange-OpenSource/uuv/commit/f43d8972746b85a386320ad67b80d9c7aa7bc313))
+* **deps:** update docusaurus monorepo to v2.4.1 ([9c0f5fb](https://github.com/Orange-OpenSource/uuv/commit/9c0f5fb6a641f54fc97d0940acfebdfb5106a790))
+* **deps:** update docusaurus monorepo to v2.4.3 ([9e7ccf7](https://github.com/Orange-OpenSource/uuv/commit/9e7ccf78176e5b38da147d6d26097730c7859da8))
+* prototype pollution in lodash - cve-2019-10744, [#219](https://github.com/Orange-OpenSource/uuv/issues/219) ([4b16741](https://github.com/Orange-OpenSource/uuv/commit/4b16741d53f814958ad0ee6d761e82d92374e5e8))
+* release 1.4.0 package.json and rchangelog was not updated, [#117](https://github.com/Orange-OpenSource/uuv/issues/117) ([cd7723d](https://github.com/Orange-OpenSource/uuv/commit/cd7723d6d790dd5fd928a5d9d41bfd075159378a))
+* **runner-cypress:** relocate cypress-real-events dependency into project package.json, [#213](https://github.com/Orange-OpenSource/uuv/issues/213) ([ffca8dd](https://github.com/Orange-OpenSource/uuv/commit/ffca8dd21d3858d0020f6bf1974437bbf38fe6c4))
+* **runner-playwright:** fix workspace lint during ci, [#108](https://github.com/Orange-OpenSource/uuv/issues/108) ([a3ac0d6](https://github.com/Orange-OpenSource/uuv/commit/a3ac0d68d27c34f36237b6f74b94e160b7cde9b8))
+* **runner-playwright:** regenerate package-lock.json to fix lint, [#109](https://github.com/Orange-OpenSource/uuv/issues/109) ([70044df](https://github.com/Orange-OpenSource/uuv/commit/70044dfd9efb2c6776a85cadd18966610d2d61f2))
+* **runner-playwright:** update @cucumber/cucumber dep version, [#93](https://github.com/Orange-OpenSource/uuv/issues/93) ([a891a70](https://github.com/Orange-OpenSource/uuv/commit/a891a70daad1cb5d7d34f25097a31d89f92b92c6))

package/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributors guide
+
+First, read the general [CONTRIBUTING](../../CONTRIBUTING.md) file
+
+## How Contribue to @uuv/a11y ?
+This [page](./STRUCTURE.md) gives you an overview of the @uuv/a11y module structure.
+
+### Add new RGAA rules
+1. Identify the file concerned by the new rule you want to add <br>
+For example :
+   - a rule on test **1**.1.4 will concern the file `a11y/src/lib/reference/rgaa/rules/1-image.ts`
+   - a rule on test **7**.1.1 will concern the file `a11y/src/lib/reference/rgaa/rules/7-script.ts`
+2. Make sure the rule doesn't already exist in the file
+3. Add your rule to the file, a rule can be :
+   - `Auto` : it can be checked automatically, then you can follow the example below :
+       ```typescript
+       AutoCheckA11yRule.from({
+            reference: "RGAA",
+            criterion: "1.1",
+            id: "1.1.5",
+           elementType: "svg",
+           query: new ByTagQuery([
+               "svg:not([role=img])"
+           ]),
+           description: "svg has no image role",
+           help: "set image role to svg"
+        })
+        ```
+   - `Manual` : It must be checked manually by a human, then you can follow the example below :
+       ```typescript
+       ManualCheckA11yRule.from({
+            reference: "RGAA",
+            criterion: "1.3",
+            wcag: "4.1.2 A",
+            id: "1.3.1",
+            elementType: "image",
+            query: new ByTagQuery(informativeContent.image.buildSelectorWithAttributes()),
+            attributes: informativeContent.image.ATTRIBUTES,
+            description: "if present, attributes alt, title, aria-label, aria-labelledby must be relevant",
+            help: "adapt these attributes to be relevant"
+       })
+        ```
+   **Adding a new rule may require you to create a new query, in which case remember to write the corresponding automated tests in the `a11y/test/query/**` directory and export it `index.ts` of same directory.**
+
+
+4. Create or enhance the automated topic test file in the directory `a11y/test/checker/**`.

package/LICENSE

@@ -2,7 +2,7 @@
 
                                     MIT License
 
-         Copyright (c) 2023 Orange
+         Copyright (c) 2024 Orange
 
         Permission is hereby granted, free of charge, to any person obtaining a copy of
         this software and associated documentation files (the "Software"), to deal in

package/README.md

@@ -68,7 +68,7 @@ The following references are available :
 
 For each criterion of the RGAA, the following algorithm is executed :
 
- ![Diagram a11Y RGAA](./docs/diagram-a11y-rgaa.png)
+ ![Diagram a11Y RGAA](https://unpkg.com/@uuv/a11y/docs/diagram-a11y-rgaa.png)
 
 **Consult [this page](https://orange-opensource.github.io/uuv/docs/tools/uuv-a11y#rgaa) to find out which RGAA verifications are implemented in the library**
 </p>  
@@ -77,21 +77,21 @@ For each criterion of the RGAA, the following algorithm is executed :
 ### With UNPKG
 1.  Add script tag to import @uuv/a11y in your html page :
     ```html
-    <script src="https://unpkg.com/@uuv/a11y/dist/bundle/uuv-a11y.bundle.js">
+    <script src="https://unpkg.com/@uuv/a11y/bundle/uuv-a11y.bundle.js">
     </script>
     ```
 2. Add script tag to execute
     ```html
-    <script>
-      const rgaaChecker = new uuvA11y.RgaaChecker(url, enabledRules);
+    <script type="module">
+      const rgaaChecker = new uuvA11y.RgaaChecker(window.location.url);
       const result = await rgaaChecker.validate().toPromise();
       // Print complete result
-      console.log(result);
+      console.log('result', result);
       // Print result summary group by criteria
-      console.log(result.summary());
+      console.log('summary', result.summary());
     </script>
     ```
-  [Stackblitz example](https://stackblitz.com/edit/web-platform-fihgra?file=index.html)
+  [Stackblitz example](https://stackblitz.com/edit/web-platform-fihgra?devToolsHeight=33&file=index.html)
 
 ### As a dependency
 1. Import @uuv/a11y npm dependency
@@ -113,77 +113,57 @@ For each criterion of the RGAA, the following algorithm is executed :
     // Print result summary group by criteria
     console.log(result.summary());
     ```
-### During E2E Testing (recommended usage car visualisation des noeuds)
+### During E2E Testing (recommended usage because it allows DOM nodes to be visualized)
 1. add `@uuv/cypress` npm dependency :
     ```shell
     npm install --save-dev @uuv/cypress
     ```
-2. create the file `uuv/e2e/a11y.feature` in the project root with the following content and replace url `https://e2e-test-quest.github.io/simple-webapp/a11y-test.html` by yours :
-    ```gherkin
-    Feature: A11y
-  
-    Scenario: Default RGAA
-      When I visit path "https://e2e-test-quest.github.io/simple-webapp/a11y-test.html"
-      Then I should not have any rgaa accessibility issue
-    
-    Scenario: RGAA with result
-      When I visit path "https://e2e-test-quest.github.io/simple-webapp/a11y-test.html"
-      Then I should have the following result based on the rgaa reference
-      """json
-        {
-          "status": "error",
-          "criteria": {
-            "1.1": {
-              "status": "error"
-            },
-            "1.2": {
-              "status": "error"
-            },
-            "1.3": {
-              "status": "manual"
-            },
-            "1.4": {
-              "status": "manual"
-            },
-            "1.5": {
-              "status": "manual"
-            },
-            "1.6": {
-              "status": "success"
-            },
-            "2.1": {
-              "status": "error"
-            },
-            "8.1": {
-              "status": "error"
-            },
-            "8.3": {
-              "status": "success"
-            },
-            "8.4": {
-              "status": "manual"
-            },
-            "8.5": {
-              "status": "error"
-            },
-            "8.6": {
-              "status": "manual"
-            },
-            "8.10": {
-              "status": "error"
-            },
-            "11.1": {
-              "status": "success"
-            }
-          }
-        }
-      """
-    ```
+   2. create the file `uuv/e2e/a11y.feature` in the project root with the following content and replace url `https://e2e-test-quest.github.io/simple-webapp/a11y-test.html` by yours :
+       ```gherkin
+       Feature: A11y validation
+          
+          Scenario: Default RGAA
+            When I visit path "https://e2e-test-quest.github.io/simple-webapp/a11y-test.html"
+            Then I should not have any rgaa accessibility issue
+      
+          Scenario: RGAA with partial result
+            When I visit path "https://e2e-test-quest.github.io/simple-webapp/a11y-test.html"
+            Then I should have the following partial result based on the rgaa reference
+               """json
+               {
+                  "status": "error",
+                  "criteria": {
+                     "1.5": {
+                        "status": "manual"
+                     },
+                     "1.6": {
+                        "status": "manual",
+                        "tests": {
+                           "1.6.5": {
+                              "status": "success"
+                           }
+                        }
+                     },
+                     "11.1": {
+                        "status": "success",
+                        "tests": {
+                           "11.1.1": {
+                              "status": "success"
+                           }
+                        }
+                     }
+                  }
+               }
+               """
+          ```
+   You can also see the [French example](https://github.com/Orange-OpenSource/uuv/blob/main/example/fr-rgaa.feature) or the complete [English example](https://github.com/Orange-OpenSource/uuv/blob/main/example/en-rgaa.feature).
 3. Then execute your tests :
     ```shell
     npx uuv e2e
     ```
 
+## Want to contribute ?
+Your help is welcome, see the [Contributors guide](https://github.com/Orange-OpenSource/uuv/blob/main/packages/a11y/CONTRIBUTING.md).
 
 ## License
 

package/STRUCTURE.md

@@ -0,0 +1,10 @@
+# Structure of the source
+
+The a11y sources are mainly located in the `packages/a11y/src/lib` directory :
+
+| Directory   | Description                                                                                                                                                                                                                                         |
+|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `engine`    | Represents execution engine                                                                                                                                                                                                                         |
+| `model`     | Contains classes and interfaces to describe rules and results                                                                                                                                                                                       |
+| `query`     | A query is a component used to retrieve dom elements according to certain criteria.<br> Exemple : <br> - `by-role.query` : retrieve dom nodes based on their accessible role<br> - `by-tag.query` : retrieve dom nodes based on their html tag name |
+| `reference` | Contains declarations of accessibility standards supported by the `@uuv/a11y` solution, in particular RGAA                                                                                                                                          |