@uuv/a11y 1.0.0-beta.2 → 1.0.0-beta.21

package/CHANGELOG.md

@@ -1,3 +1,171 @@
+# [1.0.0-beta.21](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.20...a11y-v1.0.0-beta.21) (2024-04-04)
+
+
+### Bug Fixes
+
+* update nx to version 18.2.1, fixes [#562](https://github.com/Orange-OpenSource/uuv/issues/562) ([669a363](https://github.com/Orange-OpenSource/uuv/commit/669a36307b02d8aa5b41609a08e794eae335b4ed))
+
+# [1.0.0-beta.20](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.19...a11y-v1.0.0-beta.20) (2024-03-28)
+
+
+### Features
+
+* **deps:** update node.js to v20 ([f771f22](https://github.com/Orange-OpenSource/uuv/commit/f771f22197d7efc32bba6f8a345b5f6b2f3dd114))
+
+# [1.0.0-beta.19](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.18...a11y-v1.0.0-beta.19) (2024-03-15)
+
+
+### Bug Fixes
+
+* **runner-cypress:** update dependency @cypress/webpack-preprocessor to v6 ([2e9a52b](https://github.com/Orange-OpenSource/uuv/commit/2e9a52b2cc1bfb05e96c212cdec0fd644f41d02b))
+
+# [1.0.0-beta.18](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.17...a11y-v1.0.0-beta.18) (2024-03-10)
+
+
+### Bug Fixes
+
+* **runner-cypress:** update dependency @testing-library/cypress to v10 ([8ef11bf](https://github.com/Orange-OpenSource/uuv/commit/8ef11bfde65efb9ace5942113a03c06c6f8c3b6e))
+* **runner-playwright:** update dependency axe-playwright to v2 ([7e3f1f4](https://github.com/Orange-OpenSource/uuv/commit/7e3f1f4793f89c9d826c341bb73f59d698c3dfa0))
+
+# [1.0.0-beta.17](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.16...a11y-v1.0.0-beta.17) (2024-03-07)
+
+
+### Bug Fixes
+
+* fix husky migration to v9, [#530](https://github.com/Orange-OpenSource/uuv/issues/530) ([dbce11e](https://github.com/Orange-OpenSource/uuv/commit/dbce11e2c8edb8e759538eb9731fbe0ecfb06552))
+
+
+### Features
+
+* **flutter-finder-usercentric:** initialize flutter usercentric finder, [#423](https://github.com/Orange-OpenSource/uuv/issues/423) ([cedcc3a](https://github.com/Orange-OpenSource/uuv/commit/cedcc3a8803b07a21a9fa3ca18c86d7359743ebc))
+* **runner-flutter:** initialize uuv_flutter e2e cucumber library, [#423](https://github.com/Orange-OpenSource/uuv/issues/423) ([bace2f6](https://github.com/Orange-OpenSource/uuv/commit/bace2f6a6e12b48d99fb69b84e7ce930b0292d4a))
+
+# [1.0.0-beta.16](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.15...a11y-v1.0.0-beta.16) (2024-03-04)
+
+
+### Bug Fixes
+
+* **assistant:** update dependency @ant-design/icons to v5.3.1 ([a428304](https://github.com/Orange-OpenSource/uuv/commit/a428304f37759003424e79d93dc1d5582ef34626))
+* **assistant:** update dependency antd to v5.15.0 ([cb516bc](https://github.com/Orange-OpenSource/uuv/commit/cb516bcd7bb6993c6d7de8ec3f24c7d0ce4dd8b7))
+* fix semantic release ([aef0c23](https://github.com/Orange-OpenSource/uuv/commit/aef0c234009fa8eb6e6a1b63c158af7c407f318a))
+* **runner-playwright:** update playwright monorepo to v1.42.1 ([d0e78f6](https://github.com/Orange-OpenSource/uuv/commit/d0e78f6c73be178e7c00bf4e88d57aef3b537a70))
+
+## [1.0.0-beta.15](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.14...a11y-v1.0.0-beta.15) (2024-02-26)
+
+
+### Features
+
+* **a11y:** add rgaa criteria 8.*, [#476](https://github.com/Orange-OpenSource/uuv/issues/476) ([426184b](https://github.com/Orange-OpenSource/uuv/commit/426184b56bec5648f85dd86d54a733e445e7fdcd))
+
+
+### Bug Fixes
+
+* **runner-playwright:** update playwright monorepo to v1.41.2 ([8791934](https://github.com/Orange-OpenSource/uuv/commit/87919348646fb4e5fefed2dc8a16a86e61e7dfc2))
+
+## [1.0.0-beta.14](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.13...a11y-v1.0.0-beta.14) (2024-02-25)
+
+
+### Features
+
+* add junit xml report option, [#491](https://github.com/Orange-OpenSource/uuv/issues/491) ([b64b0b2](https://github.com/Orange-OpenSource/uuv/commit/b64b0b2a60200269f558bcf7e0c75d8a74ffc226))
+
+
+### Bug Fixes
+
+* **runner-playwright:** update dependency @cucumber/tag-expressions to v6.1.0 ([47fb579](https://github.com/Orange-OpenSource/uuv/commit/47fb579ee50c26ed67af6390f4e678f8206b7226))
+
+## [1.0.0-beta.13](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.12...a11y-v1.0.0-beta.13) (2024-02-24)
+
+
+### Bug Fixes
+
+* **assistant:** update dependency antd to v5.14.2 ([1335df6](https://github.com/Orange-OpenSource/uuv/commit/1335df676dd4641a4bda7b7f36d29d8216de0da4))
+* **runner-cypress:** update dependency cypress-real-events to v1.12.0 ([55794fd](https://github.com/Orange-OpenSource/uuv/commit/55794fd04362ad2ece397d108ba400c50b152d59))
+
+## [1.0.0-beta.12](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.11...a11y-v1.0.0-beta.12) (2024-02-23)
+
+
+### Features
+
+* **a11y:** add rgaa topic 6, [#457](https://github.com/Orange-OpenSource/uuv/issues/457) ([ae59c46](https://github.com/Orange-OpenSource/uuv/commit/ae59c46a8973ba4ad24d2d7479362c3f9a5b0b0b))
+
+
+### Bug Fixes
+
+* **a11y:** fix topic 5 typo in warning message, [#451](https://github.com/Orange-OpenSource/uuv/issues/451) ([ac503f0](https://github.com/Orange-OpenSource/uuv/commit/ac503f0641574c05222967eff0babc95bbc3f5fc))
+* **assistant:** update dependency @ant-design/icons to v5.3.0 ([b4b2782](https://github.com/Orange-OpenSource/uuv/commit/b4b2782cfa93290a2e3cece937c02c1b00aec938))
+
+## [1.0.0-beta.11](https://github.com/Orange-OpenSource/uuv/compare/a11y-v1.0.0-beta.10...a11y-v1.0.0-beta.11) (2024-02-21)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @mdx-js/react to v3.0.1 ([e4ba234](https://github.com/Orange-OpenSource/uuv/commit/e4ba234ec2883f93e6003a7c27843a35f119281b))
+
+## [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)
 
 

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

@@ -125,262 +125,45 @@ For each criterion of the RGAA, the following algorithm is executed :
           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
+      
+          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 result based on the rgaa reference
-            """json
-            {
-              "status": "error",
-              "criteria": {
-                "1.1": {
+            Then I should have the following partial result based on the rgaa reference
+               """json
+               {
                   "status": "error",
-                  "tests" : {
-                    "1.1.1": {
-                      "status": "error"
-                    },
-                    "1.1.2": {
-                      "status": "error"
-                    },
-                    "1.1.3": {
-                      "status": "success"
-                    },
-                    "1.1.4": {
-                      "status": "success"
-                    },
-                    "1.1.5": {
-                      "status": "error"
-                    },
-                    "1.1.6": {
-                      "status": "error"
-                    },
-                    "1.1.7": {
-                      "status": "error"
-                    },
-                    "1.1.8": {
-                      "status": "success"
-                    }
-                  }
-                },
-                "1.2": {
-                  "status": "success",
-                  "tests": {
-                    "1.2.1": {
-                      "status": "success"
-                    },
-                    "1.2.2": {
-                      "status": "success"
-                    },
-                    "1.2.3": {
-                      "status": "success"
-                    },
-                    "1.2.4": {
-                      "status": "success"
-                    },
-                    "1.2.5": {
-                      "status": "success"
-                    },
-                    "1.2.6": {
-                      "status": "success"
-                    }
-                  }
-                },
-                "1.3": {
-                  "status": "manual",
-                  "tests": {
-                    "1.3.1": {
-                      "status": "manual"
-                    },
-                    "1.3.2": {
-                      "status": "manual"
-                    },
-                    "1.3.3": {
-                      "status": "manual"
-                    },
-                    "1.3.4": {
-                      "status": "success"
-                    },
-                    "1.3.5": {
-                      "status": "success"
-                    },
-                    "1.3.6": {
-                      "status": "success"
-                    },
-                    "1.3.7": {
-                      "status": "success"
-                    },
-                    "1.3.9": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "1.4": {
-                  "status": "manual",
-                  "tests": {
-                    "1.4.1": {
-                      "status": "manual"
-                    },
-                    "1.4.2": {
-                      "status": "manual"
-                    },
-                    "1.4.3": {
-                      "status": "manual"
-                    },
-                    "1.4.4": {
-                      "status": "success"
-                    },
-                    "1.4.5": {
-                      "status": "success"
-                    },
-                    "1.4.6": {
-                      "status": "success"
-                    },
-                    "1.4.7": {
-                      "status": "success"
-                    }
-                  }
-                },
-                "1.5": {
-                  "status": "manual",
-                  "tests": {
-                    "1.5.1": {
-                      "status": "manual"
-                    },
-                    "1.5.2": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "1.6": {
-                  "status": "manual",
-                  "tests": {
-                    "1.6.1": {
-                      "status": "success"
-                    },
-                    "1.6.2": {
-                      "status": "success"
-                    },
-                    "1.6.3": {
-                      "status": "success"
-                    },
-                    "1.6.4": {
-                      "status": "success"
-                    },
-                    "1.6.5": {
-                      "status": "success"
-                    },
-                    "1.6.6": {
-                      "status": "success"
-                    },
-                    "1.6.7": {
-                      "status": "success"
-                    },
-                    "1.6.8": {
-                      "status": "success"
-                    },
-                    "1.6.9": {
-                      "status": "manual"
-                    },
-                    "1.6.10": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "2.1": {
-                  "status": "error",
-                  "tests": {
-                    "2.1.1": {
-                      "status": "error"
-                    }
-                  }
-                },
-                "2.2": {
-                  "status": "manual",
-                  "tests": {
-                    "2.2.1": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "3.1": {
-                  "status": "manual",
-                  "tests": {
-                    "3.1.3": {
-                      "status": "success"
-                    },
-                    "3.1.5": {
-                      "status": "manual"
-                    },
-                    "3.1.6": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "8.1": {
-                  "status": "error",
-                  "tests": {
-                    "8.1.1": {
-                      "status": "error"
-                    }
-                  }
-                },
-                "8.3": {
-                  "status": "success",
-                  "tests": {
-                    "8.3.1": {
-                      "status": "success"
-                    }
-                  }
-                },
-                "8.4": {
-                  "status": "manual",
-                  "tests": {
-                    "8.4.1": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "8.5": {
-                  "status": "error",
-                  "tests": {
-                    "8.5.1": {
-                      "status": "error"
-                    }
-                  }
-                },
-                "8.6": {
-                  "status": "manual",
-                  "tests": {
-                    "8.6.1": {
-                      "status": "manual"
-                    }
-                  }
-                },
-                "8.10": {
-                  "status": "error",
-                  "tests": {
-                    "8.10.1": {
-                      "status": "error"
-                    }
-                  }
-                },
-                "11.1": {
-                  "status": "success",
-                  "tests": {
-                    "11.1.1": {
-                      "status": "success"
-                    }
-                  }
-                }
-              }
-            }
-          """
-       ```
+                  "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                                                                                                                                          |