[5.1] Update Jooa11y with latest Sa11y build (Attempt #2)

administrator/language/en-GB/plg_system_jooa11y.sys.ini

@@ -4,4 +4,4 @@
 ; Note : All ini files need to be saved as UTF-8
 
 PLG_SYSTEM_JOOA11Y="System - Joomla Accessibility Checker"
-PLG_SYSTEM_JOOA11Y_XML_DESCRIPTION="The Joomla Accessibility Checker visually highlights common accessibility and usability issues. Geared towards content authors, the plugin identifies errors or warnings and provides guidance on how to fix them."
+PLG_SYSTEM_JOOA11Y_XML_DESCRIPTION="The Joomla Accessibility Checker visually highlights common accessibility and usability issues. Geared towards content authors, the plugin identifies errors or warnings and provides guidance on how to fix them. Please be aware that this plugin does not offer an exhaustive analysis of your website, nor does it automatically ensure your website's accessibility. It's important to select a theme that is inherently accessible to ensure your site meets accessibility standards."

build/build-modules-js/javascript/compile-to-es2017.es6.js

@@ -53,13 +53,15 @@ const collectExternals = () => {
     return;
   }
 
-  // Joomla modules
+  // Joomla and Vendor modules
   externalModules.push(
     'cropper-module',
     'codemirror',
     'joomla.dialog',
     'editor-api',
     'editor-decorator',
+    'sa11y',
+    'sa11y-lang',
   );
 
   // Codemirror modules

build/build-modules-js/settings.json

@@ -403,7 +403,7 @@
       "hotkeys-js": {
         "name": "hotkeysjs",
         "licenseFilename": "LICENSE",
-        "js" : {
+        "js": {
           "dist/hotkeys.js": "js/hotkeys.js",
           "dist/hotkeys.min.js": "js/hotkeys.min.js"
         },
@@ -458,10 +458,6 @@
         ],
         "licenseFilename": "LICENSE.txt"
       },
-      "@joomla/joomla-a11y-checker": {
-        "name": "joomla-a11y-checker",
-        "licenseFilename": "LICENSE.md"
-      },
       "joomla-ui-custom-elements": {
         "name": "joomla-custom-elements",
         "js": {
@@ -745,6 +741,66 @@
           }
         ]
       },
+      "sa11y": {
+        "name": "sa11y",
+        "licenseFilename": "LICENSE.md",
+        "js": {
+          "dist/js/sa11y.esm.min.js": "js/sa11y.esm.min.js",
+          "dist/js/lang/bg.js": "js/bg.js",
+          "dist/js/lang/cs.js": "js/cs.js",
+          "dist/js/lang/da.js": "js/da.js",
+          "dist/js/lang/de.js": "js/de.js",
+          "dist/js/lang/el.js": "js/el.js",
+          "dist/js/lang/en.js": "js/en.js",
+          "dist/js/lang/enUS.js": "js/enUS.js",
+          "dist/js/lang/es.js": "js/es.js",
+          "dist/js/lang/et.js": "js/et.js",
+          "dist/js/lang/fi.js": "js/fi.js",
+          "dist/js/lang/fr.js": "js/fr.js",
+          "dist/js/lang/hu.js": "js/hu.js",
+          "dist/js/lang/id.js": "js/id.js",
+          "dist/js/lang/it.js": "js/it.js",
+          "dist/js/lang/ja.js": "js/ja.js",
+          "dist/js/lang/ko.js": "js/ko.js",
+          "dist/js/lang/lt.js": "js/lt.js",
+          "dist/js/lang/lv.js": "js/lv.js",
+          "dist/js/lang/nb.js": "js/nb.js",
+          "dist/js/lang/nl.js": "js/nl.js",
+          "dist/js/lang/pl.js": "js/pl.js",
+          "dist/js/lang/ptBR.js": "js/ptBR.js",
+          "dist/js/lang/ptPT.js": "js/ptPT.js",
+          "dist/js/lang/ro.js": "js/ro.js",
+          "dist/js/lang/sk.js": "js/sk.js",
+          "dist/js/lang/sl.js": "js/sl.js",
+          "dist/js/lang/sv.js": "js/sv.js",
+          "dist/js/lang/tr.js": "js/tr.js",
+          "dist/js/lang/ua.js": "js/ua.js",
+          "dist/js/lang/zh.js": "js/zh.js"
+        },
+        "css": {
+          "dist/css/sa11y.min.css": "css/sa11y.min.css"
+        },
+        "provideAssets": [
+          {
+            "name": "sa11y",
+            "type": "script",
+            "uri": "sa11y.esm.min.js",
+            "importmap": true
+          },
+          {
+            "name": "sa11y-lang",
+            "type": "script",
+            "uri": "en.js",
+            "importmap": true,
+            "description": "A placeholder asset which is later initialised by plugin, depending on active language."
+          },
+          {
+            "name": "sa11y",
+            "type": "style",
+            "uri": "sa11y.min.css"
+          }
+        ]
+      },
       "qrcode-generator": {
         "name": "qrcode",
         "js": {
@@ -793,32 +849,41 @@
         "text": "It looks like you are trying to run Joomla! from our git repository. To do so requires you complete a couple of extra steps first.",
         "link": "J4.x:Setting_Up_Your_Local_Environment",
         "linkText": "More Details",
-        "destFile": ["/templates/system/build_incomplete.html"]
+        "destFile": [
+          "/templates/system/build_incomplete.html"
+        ]
       },
       "unsupported": {
         "title": "Joomla: unsupported PHP version",
         "header": "Sorry, your PHP version is not supported",
         "text": "Your host needs to use PHP version {{phpversion}} or newer to run this version of Joomla!",
         "link": "J4.x:Unsupported_PHP_Version",
         "linkText": "Help me resolve this",
-        "destFile": ["/templates/system/incompatible.html", "/includes/incompatible.html"]
+        "destFile": [
+          "/templates/system/incompatible.html",
+          "/includes/incompatible.html"
+        ]
       },
       "noxml": {
         "title": "Joomla: Missing PHP-XML library",
         "header": "Sorry, your PHP is missing a vital library",
         "text": "Your host needs to use PHP with support for the XML library to run this version of Joomla!",
         "link": "J4.x:Missing_XML_Library",
         "linkText": "Help me resolve this",
-        "destFile": ["/media/system/html/noxml.html"]
+        "destFile": [
+          "/media/system/html/noxml.html"
+        ]
       },
       "fatal": {
         "title": "An Error Occurred: {{statusText}}",
         "header": "Sorry, there was a problem we could not recover from.",
         "text": "The server returned a \"{{statusCode_statusText}}\"",
         "link": "J4.x:FatalError",
         "linkText": "Help me resolve this",
-        "destFile": ["/templates/system/fatal-error.html"]
+        "destFile": [
+          "/templates/system/fatal-error.html"
+        ]
       }
     }
   }
-}
+}

build/media_source/plg_behaviour_compat/es5.asset.json

@@ -650,7 +650,8 @@
       "deprecated": true,
       "uri": "",
       "dependencies": [
-        "core", "messages"
+        "core",
+        "messages"
       ],
       "attributes": {
         "nomodule": true,

build/media_source/plg_system_jooa11y/joomla.asset.json

@@ -10,7 +10,9 @@
       "type": "script",
       "uri": "plg_system_jooa11y/jooa11y.min.js",
       "dependencies": [
-        "core"
+        "core",
+        "sa11y",
+        "sa11y-lang"
       ],
       "attributes": {
         "type": "module"
@@ -19,7 +21,12 @@
     {
       "name": "plg_system_jooa11y.jooa11y",
       "type": "style",
-      "uri": "plg_system_jooa11y/jooa11y.min.css"
+      "uri": "",
+      "deprecated": true,
+      "deprecatedMsg": "Use 'sa11y' style asset instead",
+      "dependencies": [
+        "sa11y"
+      ]
     }
   ]
 }

build/media_source/plg_system_jooa11y/js/jooa11y.es6.js

@@ -1,17 +1,11 @@
-import { Jooa11y, Lang } from '@joomla/joomla-a11y-checker/dist/js/joomla-a11y-checker.esm.js';
+// eslint-disable-next-line import/no-unresolved
+import { Sa11y, Lang } from 'sa11y';
+// eslint-disable-next-line import/no-unresolved
+import Sa11yLang from 'sa11y-lang';
 
-if (!Joomla) {
-  throw new Error('Joomla API is not properly initialised');
-}
-
-const stringPrefix = 'PLG_SYSTEM_JOOA11Y_';
-
-Lang.translate = (string) => Joomla.Text._(stringPrefix + string, string);
-
-const options = Joomla.getOptions('jooa11yOptions');
+Lang.addI18n(Sa11yLang.strings);
 
 window.addEventListener('load', () => {
-  // Instantiate
-  const checker = new Jooa11y(options);
-  checker.doInitialCheck();
+  // eslint-disable-next-line no-new
+  new Sa11y(Joomla.getOptions('jooa11yOptions', {}));
 });

package.json

@@ -78,6 +78,7 @@
     "punycode": "^2.3.0",
     "qrcode-generator": "^1.4.4",
     "roboto-fontface": "^0.10.0",
+    "sa11y": "^3.0.8",
     "shepherd.js": "^11.2.0",
     "short-and-sweet": "^1.0.4",
     "skipto": "^4.1.7",

plugins/system/jooa11y/jooa11y.xml

@@ -33,6 +33,66 @@
 					<option value="0">JOFF</option>
 					<option value="1">JON</option>
 				</field>
+				<field
+					name="contrastPlugin"
+					type="radio"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_CONTRAST"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_CONTRAST_DESC"
+					layout="joomla.form.field.radio.switcher"
+					default="1"
+					filter="integer"
+					>
+					<option value="0">JOFF</option>
+					<option value="1">JON</option>
+				</field>
+				<field
+					name="formLabelsPlugin"
+					type="radio"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_FORM_LABELS"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_FORM_LABELS_DESC"
+					layout="joomla.form.field.radio.switcher"
+					default="1"
+					filter="integer"
+					>
+					<option value="0">JOFF</option>
+					<option value="1">JON</option>
+				</field>
+				<field
+					name="linksAdvancedPlugin"
+					type="radio"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_LINKS_ADVANCED"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_LINKS_ADVANCED_DESC"
+					layout="joomla.form.field.radio.switcher"
+					default="1"
+					filter="integer"
+					>
+					<option value="0">JOFF</option>
+					<option value="1">JON</option>
+				</field>
+				<field
+					name="colourFilterPlugin"
+					type="radio"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_COLOUR_FILTER"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_COLOUR_FILTER_DESC"
+					layout="joomla.form.field.radio.switcher"
+					default="1"
+					filter="integer"
+					>
+					<option value="0">JOFF</option>
+					<option value="1">JON</option>
+				</field>
+				<field
+					name="additionalChecks"
+					type="radio"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_ADDITIONAL_CHECKS"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_ADDITIONAL_CHECKS_DESC"
+					layout="joomla.form.field.radio.switcher"
+					default="0"
+					filter="integer"
+					>
+					<option value="0">JOFF</option>
+					<option value="1">JON</option>
+				</field>
 				<field
 					name="checkRoot"
 					type="text"
@@ -56,6 +116,25 @@
 					description="PLG_SYSTEM_JOOA11Y_FIELD_CONTAINER_IGNORE_DESC"
 					filter="string"
 				/>
+				<field
+					name="shadowComponents"
+					type="text"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_WEB_COMPONENTS"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_WEB_COMPONENTS_DESC"
+					filter="string"
+				/>
+				<field
+					name="extraProps"
+					type="subform"
+					label="PLG_SYSTEM_JOOA11Y_FIELD_EXTRA_PROPS"
+					description="PLG_SYSTEM_JOOA11Y_FIELD_EXTRA_PROPS_DESC"
+					multiple="true"
+					>
+					<form>
+						<field type="text" name="key" label="PLG_SYSTEM_JOOA11Y_KEY"/>
+						<field type="text" name="value" label="PLG_SYSTEM_JOOA11Y_VALUE"/>
+					</form>
+				</field>
 			</fieldset>
 		</fields>
 	</config>