html-validate 8.10.0 → 8.11.0

package/dist/schema/elements.json

@@ -93,9 +93,15 @@
         "implicitRole": {
           "title": "Implicit ARIA role for this element",
           "description": "Some elements have implicit ARIA roles.",
+          "deprecated": true,
           "function": true
         },
 
+        "aria": {
+          "title": "WAI-ARIA properties for this element",
+          "$ref": "#/definitions/Aria"
+        },
+
         "scriptSupporting": {
           "title": "Mark element as script-supporting",
           "description": "Script-supporting elements are elements which can be inserted where othersise not permitted to assist in templating",
@@ -184,6 +190,22 @@
   },
 
   "definitions": {
+    "Aria": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "implicitRole": {
+          "title": "Implicit ARIA role for this element",
+          "description": "Some elements have implicit ARIA roles.",
+          "anyOf": [{ "type": "string" }, { "function": true }]
+        },
+        "naming": {
+          "title": "Prohibit or allow this element to be named by aria-label or aria-labelledby",
+          "anyOf": [{ "type": "string", "enum": ["prohibited", "allowed"] }, { "function": true }]
+        }
+      }
+    },
+
     "contentCategory": {
       "anyOf": [{ "type": "boolean" }, { "$ref": "#/definitions/expression" }]
     },

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.40.4"
+      "packageVersion": "7.40.6"
     }
   ]
 }

package/dist/types/browser.d.ts

@@ -1,6 +1,22 @@
 import { ErrorObject } from 'ajv';
 import { SchemaObject } from 'ajv';
 
+/**
+ * Returns the normalized metadata property `aria.naming`.
+ *
+ * - Returns `allowed` if this element allows naming.
+ * - Returns `prohibited` if this element does not allow naming.
+ * - If the element doesn't have metadata `allowed` is returned.
+ *
+ * If the element contains an explicit `role` the role is used to determine
+ * whenever the element allows naming or not. Otherwise it uses metadata to
+ * determine.
+ *
+ * @public
+ * @param element - Element to get `aria.naming` from.
+ */
+export declare function ariaNaming(element: HtmlElement): "allowed" | "prohibited";
+
 /**
  * DOM Attribute.
  *
@@ -1346,6 +1362,35 @@ export declare interface Message {
     context?: any;
 }
 
+/**
+ * Element ARIA metadata.
+ *
+ * @public
+ * @since 8.11.0
+ */
+export declare interface MetaAria {
+    /**
+     * Implicit ARIA role.
+     *
+     * Can be set either to a string (element unconditionally has given role) or a
+     * callback (role depends on the context the element is used in).
+     *
+     * @since 8.11.0
+     */
+    implicitRole?: string | MetaImplicitRoleCallback;
+    /**
+     * If set to `"prohibited"` this element may not specify an accessible name
+     * with `aria-label` or `aria-labelledby`. Defaults to `"allowed"` if unset.
+     *
+     * Note: if the element overrides the `role` (i.e. the `role` attribute is set to
+     * something other than the implicit role) naming may or may not be allowed
+     * depending on the given role instead.
+     *
+     * @since 8.11.0
+     */
+    naming?: "allowed" | "prohibited" | ((node: HtmlElementLike) => "allowed" | "prohibited");
+}
+
 /**
  * @public
  */
@@ -1428,7 +1473,10 @@ export declare interface MetaData {
     /** Mark element as a form-associated element */
     formAssociated?: Partial<FormAssociated>;
     labelable?: boolean | PropertyExpression;
+    /** @deprecated use {@link MetaAria.implicitRole} instead */
     implicitRole?: MetaImplicitRoleCallback;
+    /** WAI-ARIA attributes */
+    aria?: MetaAria;
     deprecatedAttributes?: string[];
     requiredAttributes?: string[];
     attributes?: PermittedAttribute;
@@ -1480,7 +1528,10 @@ export declare interface MetaElement extends Omit<MetaData, "deprecatedAttribute
     tagName: string;
     focusable: boolean | MetaFocusableCallback;
     formAssociated?: FormAssociated;
+    /** @deprecated Use {@link MetaAria.implicitRole} instead */
     implicitRole: MetaImplicitRoleCallback;
+    /** WAI-ARIA attributes */
+    aria: NormalizedMetaAria;
     attributes: Record<string, MetaAttribute>;
     textContent?: TextContent;
 }
@@ -1497,7 +1548,7 @@ export declare interface MetaElement extends Omit<MetaData, "deprecatedAttribute
 export declare type MetaFocusableCallback = (node: HtmlElementLike) => boolean;
 
 /**
- * Callback for the `implicitRole` property of `MetaData`. It takes a node and
+ * Callback for the `implicitRole` property of `MetaAria`. It takes a node and
  * returns the implicit ARIA role, if any.
  *
  * @public
@@ -1602,6 +1653,32 @@ export declare enum NodeType {
     DOCUMENT_NODE = 9
 }
 
+/**
+ * Element ARIA metadata.
+ *
+ * @public
+ * @since 8.11.0
+ */
+export declare interface NormalizedMetaAria {
+    /**
+     *
+     * Normalized version of {@link MetaAria.implicitRole}. Always a callback
+     * returning the role.
+     *
+     * @since 8.11.0
+     * @returns string with role or null if no corresponding role.
+     */
+    implicitRole(node: HtmlElementLike): string | null;
+    /**
+     *
+     * Normalized version of {@link MetaAria.naming}. Always a callback
+     * returning `"allowed"` or `"prohibited"`.
+     *
+     * @since 8.11.0
+     */
+    naming(node: HtmlElementLike): "allowed" | "prohibited";
+}
+
 /* Excluded from this release type: ParseBeginEvent */
 
 /* Excluded from this release type: ParseEndEvent */

package/dist/types/index.d.ts

@@ -1,6 +1,22 @@
 import { ErrorObject } from 'ajv';
 import { SchemaObject } from 'ajv';
 
+/**
+ * Returns the normalized metadata property `aria.naming`.
+ *
+ * - Returns `allowed` if this element allows naming.
+ * - Returns `prohibited` if this element does not allow naming.
+ * - If the element doesn't have metadata `allowed` is returned.
+ *
+ * If the element contains an explicit `role` the role is used to determine
+ * whenever the element allows naming or not. Otherwise it uses metadata to
+ * determine.
+ *
+ * @public
+ * @param element - Element to get `aria.naming` from.
+ */
+export declare function ariaNaming(element: HtmlElement): "allowed" | "prohibited";
+
 /**
  * DOM Attribute.
  *
@@ -1571,6 +1587,35 @@ export declare interface Message {
     context?: any;
 }
 
+/**
+ * Element ARIA metadata.
+ *
+ * @public
+ * @since 8.11.0
+ */
+export declare interface MetaAria {
+    /**
+     * Implicit ARIA role.
+     *
+     * Can be set either to a string (element unconditionally has given role) or a
+     * callback (role depends on the context the element is used in).
+     *
+     * @since 8.11.0
+     */
+    implicitRole?: string | MetaImplicitRoleCallback;
+    /**
+     * If set to `"prohibited"` this element may not specify an accessible name
+     * with `aria-label` or `aria-labelledby`. Defaults to `"allowed"` if unset.
+     *
+     * Note: if the element overrides the `role` (i.e. the `role` attribute is set to
+     * something other than the implicit role) naming may or may not be allowed
+     * depending on the given role instead.
+     *
+     * @since 8.11.0
+     */
+    naming?: "allowed" | "prohibited" | ((node: HtmlElementLike) => "allowed" | "prohibited");
+}
+
 /**
  * @public
  */
@@ -1653,7 +1698,10 @@ export declare interface MetaData {
     /** Mark element as a form-associated element */
     formAssociated?: Partial<FormAssociated>;
     labelable?: boolean | PropertyExpression;
+    /** @deprecated use {@link MetaAria.implicitRole} instead */
     implicitRole?: MetaImplicitRoleCallback;
+    /** WAI-ARIA attributes */
+    aria?: MetaAria;
     deprecatedAttributes?: string[];
     requiredAttributes?: string[];
     attributes?: PermittedAttribute;
@@ -1705,7 +1753,10 @@ export declare interface MetaElement extends Omit<MetaData, "deprecatedAttribute
     tagName: string;
     focusable: boolean | MetaFocusableCallback;
     formAssociated?: FormAssociated;
+    /** @deprecated Use {@link MetaAria.implicitRole} instead */
     implicitRole: MetaImplicitRoleCallback;
+    /** WAI-ARIA attributes */
+    aria: NormalizedMetaAria;
     attributes: Record<string, MetaAttribute>;
     textContent?: TextContent;
 }
@@ -1722,7 +1773,7 @@ export declare interface MetaElement extends Omit<MetaData, "deprecatedAttribute
 export declare type MetaFocusableCallback = (node: HtmlElementLike) => boolean;
 
 /**
- * Callback for the `implicitRole` property of `MetaData`. It takes a node and
+ * Callback for the `implicitRole` property of `MetaAria`. It takes a node and
  * returns the implicit ARIA role, if any.
  *
  * @public
@@ -1852,6 +1903,32 @@ export declare enum NodeType {
     DOCUMENT_NODE = 9
 }
 
+/**
+ * Element ARIA metadata.
+ *
+ * @public
+ * @since 8.11.0
+ */
+export declare interface NormalizedMetaAria {
+    /**
+     *
+     * Normalized version of {@link MetaAria.implicitRole}. Always a callback
+     * returning the role.
+     *
+     * @since 8.11.0
+     * @returns string with role or null if no corresponding role.
+     */
+    implicitRole(node: HtmlElementLike): string | null;
+    /**
+     *
+     * Normalized version of {@link MetaAria.naming}. Always a callback
+     * returning `"allowed"` or `"prohibited"`.
+     *
+     * @since 8.11.0
+     */
+    naming(node: HtmlElementLike): "allowed" | "prohibited";
+}
+
 /* Excluded from this release type: ParseBeginEvent */
 
 /* Excluded from this release type: ParseEndEvent */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-validate",
-  "version": "8.10.0",
+  "version": "8.11.0",
   "description": "Offline html5 validator",
   "keywords": [
     "html",
@@ -168,6 +168,7 @@
       "!src/vitest/vitest.ts",
       "!src/utils/compatibility-check.browser.ts",
       "!src/utils/compatibility-check.nodejs.ts",
+      "!**/*.d.ts",
       "!**/__fixtures__/**"
     ],
     "moduleNameMapper": {
@@ -205,10 +206,10 @@
     "@html-validate/eslint-config-jest": "5.13.2",
     "@html-validate/eslint-config-typescript": "5.13.1",
     "@html-validate/eslint-config-typescript-typeinfo": "5.13.1",
-    "@html-validate/jest-config": "3.8.0",
+    "@html-validate/jest-config": "3.9.0",
     "@html-validate/prettier-config": "2.4.12",
     "@html-validate/release-scripts": "6.2.0",
-    "@microsoft/api-extractor": "7.40.4",
+    "@microsoft/api-extractor": "7.40.6",
     "@rollup/plugin-commonjs": "25.0.7",
     "@rollup/plugin-json": "6.1.0",
     "@rollup/plugin-node-resolve": "15.2.3",
@@ -218,9 +219,9 @@
     "@types/babel__code-frame": "7.0.6",
     "@types/jest": "29.5.12",
     "@types/minimist": "1.2.5",
-    "@types/node": "16.18.82",
+    "@types/node": "16.18.83",
     "@types/prompts": "2.4.9",
-    "@types/semver": "7.5.7",
+    "@types/semver": "7.5.8",
     "@types/stream-buffers": "3.0.7",
     "babar": "0.2.3",
     "husky": "9.0.11",
@@ -229,8 +230,9 @@
     "jest-diff": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
     "jest-snapshot": "29.7.0",
+    "jsdom": "20.0.3",
     "marked": "12.0.0",
-    "memfs": "4.7.6",
+    "memfs": "4.7.7",
     "npm-pkg-lint": "2.1.0",
     "npm-run-all2": "6.1.2",
     "rollup": "4.12.0",