@markuplint/ml-core 4.0.0-alpha.1 → 4.0.0-alpha.3

package/lib/configs.js

@@ -31,6 +31,7 @@ async function forceImportJsonInModule(modPath) {
             .replace(/^[\\/][a-z]:/i, '');
         log('Find JSON file path: %s', normalizePath);
         const fileContent = await readFile(normalizePath, { encoding: 'utf8' });
+        log('Success to read JSON file path: %s', normalizePath);
         return JSON.parse(fileContent);
     }
     return error.default ? error.default : error;

package/lib/index.d.ts

@@ -12,3 +12,4 @@ export * from './plugin/index.js';
 export * from './test/index.js';
 export * from './types.js';
 export * from './utils/index.js';
+export { AccessibilityProperties } from './ml-dom/node/types.js';

package/lib/ml-dom/node/document.d.ts

@@ -4,7 +4,7 @@ import type { MLDocumentType } from './document-type.js';
 import type { MLElement } from './element.js';
 import type { MLNode } from './node.js';
 import type { MLText } from './text.js';
-import type { DocumentNodeType } from './types.js';
+import type { AccessibilityProperties, DocumentNodeType } from './types.js';
 import type { MLRule } from '../../ml-rule/index.js';
 import type Ruleset from '../../ruleset/index.js';
 import type { MLSchema } from '../../types.js';
@@ -933,6 +933,7 @@ export declare class MLDocument<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Document`
      */
     get onscroll(): ((this: GlobalEventHandlers, ev: Event) => any) | null;
+    get onscrollend(): ((this: GlobalEventHandlers, ev: Event) => any) | null;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1428,6 +1429,7 @@ export declare class MLDocument<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Document`
      */
     exitPointerLock(): void;
+    getAccessibilityProp(node: MLNode<T, O>, ariaVersion?: "1.2"): AccessibilityProperties | null;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/document.js

@@ -1,7 +1,7 @@
 var _MLDocument_filename, _MLDocument_tokenList;
 import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
 import { exchangeValueOnRule, mergeRule } from '@markuplint/ml-config';
-import { schemaToSpec } from '@markuplint/ml-spec';
+import { schemaToSpec, getAccname, getComputedRole, mayBeFocusable, getComputedAriaProps, isExposed, ARIA_RECOMMENDED_VERSION, } from '@markuplint/ml-spec';
 import { ConfigParserError } from '@markuplint/parser-utils';
 import { InvalidSelectorError, matchSelector } from '@markuplint/selector';
 import { log as coreLog } from '../../debug.js';
@@ -1170,6 +1170,9 @@ export class MLDocument extends MLParentNode {
     get onscroll() {
         throw new UnexpectedCallError('Not supported "onscroll" property');
     }
+    get onscrollend() {
+        throw new UnexpectedCallError('Not supported "onscrollend" property');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1821,6 +1824,46 @@ export class MLDocument extends MLParentNode {
     exitPointerLock() {
         throw new UnexpectedCallError('Not supported "exitPointerLock" method');
     }
+    getAccessibilityProp(
+    // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+    node, ariaVersion = ARIA_RECOMMENDED_VERSION) {
+        if (!node.is(node.ELEMENT_NODE)) {
+            return null;
+        }
+        const exposed = isExposed(node, node.ownerMLDocument.specs, ariaVersion);
+        if (!exposed) {
+            return {
+                exposedToTree: false,
+            };
+        }
+        const aria = {
+            exposedToTree: true,
+        };
+        const role = getComputedRole(node.ownerMLDocument.specs, node, ariaVersion);
+        const name = getAccname(node).trim();
+        const focusable = mayBeFocusable(node, node.ownerMLDocument.specs);
+        const nameRequired = role.role?.accessibleNameRequired ?? false;
+        const nameProhibited = role.role?.accessibleNameProhibited ?? false;
+        aria.role = role.role?.name;
+        aria.nameRequired = nameRequired;
+        aria.nameProhibited = nameProhibited;
+        aria.name = name;
+        aria.focusable = focusable;
+        Object.values(getComputedAriaProps(node.ownerMLDocument.specs, node, ariaVersion)).forEach(prop => {
+            if (!prop.required) {
+                if (prop.from === 'default') {
+                    return;
+                }
+            }
+            aria.props = aria.props || {};
+            const propName = prop.name.replace('aria-', '');
+            aria.props[propName] = {
+                value: prop.value ?? null,
+                required: prop.required,
+            };
+        });
+        return aria;
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/element.d.ts

@@ -1165,6 +1165,7 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @implements DOM API: `Element`
      */
     get onscroll(): ((this: GlobalEventHandlers, ev: Event) => any) | null;
+    get onscrollend(): ((this: GlobalEventHandlers, ev: Event) => any) | null;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1373,6 +1374,14 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @see https://www.w3.org/TR/css-shadow-parts-1/#idl
      */
     get part(): DOMTokenList;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-popover
+     */
+    get popover(): string | null;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1720,6 +1729,14 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @see https://www.w3.org/TR/pointerevents2/#dom-element-haspointercapture
      */
     hasPointerCapture(pointerId: number): boolean;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-hidepopover
+     */
+    hidePopover(): void;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1889,6 +1906,14 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @see https://www.w3.org/TR/pointerevents2/#idl-def-element-setpointercapture-pointerid
      */
     setPointerCapture(pointerId: number): void;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-showpopover
+     */
+    showPopover(): void;
     /**
      * @implements `@markuplint/ml-core` API: `MLElement`
      */
@@ -1905,6 +1930,14 @@ export declare class MLElement<T extends RuleConfigValue, O extends PlainData =
      * @see https://dom.spec.whatwg.org/#ref-for-dom-element-toggleattribute%E2%91%A0
      */
     toggleAttribute(qualifiedName: string, force?: boolean): boolean;
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-togglepopover
+     */
+    togglePopover(force?: boolean): void;
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/element.js

@@ -1506,6 +1506,9 @@ export class MLElement extends MLParentNode {
     get onscroll() {
         throw new UnexpectedCallError('Not supported "onscroll" property');
     }
+    get onscrollend() {
+        throw new UnexpectedCallError('Not supported "onscrollend" property');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -1766,6 +1769,16 @@ export class MLElement extends MLParentNode {
     get part() {
         throw new UnexpectedCallError('Not supported "part" property');
     }
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-popover
+     */
+    get popover() {
+        throw new UnexpectedCallError('Not supported "popover" property');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2337,6 +2350,16 @@ export class MLElement extends MLParentNode {
     hasPointerCapture(pointerId) {
         throw new UnexpectedCallError('Not supported "hasPointerCapture" method');
     }
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-hidepopover
+     */
+    hidePopover() {
+        throw new UnexpectedCallError('Not supported "hidePopover" method');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *
@@ -2678,6 +2701,16 @@ export class MLElement extends MLParentNode {
     setPointerCapture(pointerId) {
         throw new UnexpectedCallError('Not supported "setPointerCapture" method');
     }
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-showpopover
+     */
+    showPopover() {
+        throw new UnexpectedCallError('Not supported "showPopover" method');
+    }
     /**
      * @implements `@markuplint/ml-core` API: `MLElement`
      */
@@ -2716,6 +2749,16 @@ export class MLElement extends MLParentNode {
     toggleAttribute(qualifiedName, force) {
         throw new UnexpectedCallError('Not supported "toggleAttribute" method');
     }
+    /**
+     * **IT THROWS AN ERROR WHEN CALLING THIS.**
+     *
+     * @unsupported
+     * @implements DOM API: `Element`
+     * @see https://html.spec.whatwg.org/multipage/popover.html#dom-togglepopover
+     */
+    togglePopover(force) {
+        throw new UnexpectedCallError('Not supported "togglePopover" method');
+    }
     /**
      * **IT THROWS AN ERROR WHEN CALLING THIS.**
      *

package/lib/ml-dom/node/types.d.ts

@@ -33,3 +33,17 @@ export type PretenderContextPretended<N extends MLElement<T, O>, T extends RuleC
     readonly type: 'origin';
     readonly origin: N;
 };
+export type AccessibilityProperties = {
+    exposedToTree: boolean;
+    role?: string;
+    roleDescription?: string;
+    name?: string;
+    nameRequired?: boolean;
+    nameProhibited?: boolean;
+    focusable?: boolean;
+    props?: Record<string, AccessibilityProperty>;
+};
+export type AccessibilityProperty = {
+    value: string | null;
+    required: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "4.0.0-alpha.1",
+	"version": "4.0.0-alpha.3",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -28,20 +28,20 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "4.0.0-alpha.1",
-		"@markuplint/html-parser": "4.0.0-alpha.1",
-		"@markuplint/html-spec": "4.0.0-alpha.1",
-		"@markuplint/i18n": "4.0.0-alpha.1",
-		"@markuplint/ml-ast": "4.0.0-alpha.1",
-		"@markuplint/ml-config": "4.0.0-alpha.1",
-		"@markuplint/ml-spec": "4.0.0-alpha.1",
-		"@markuplint/parser-utils": "4.0.0-alpha.1",
-		"@markuplint/selector": "4.0.0-alpha.1",
-		"@types/debug": "^4.1.8",
+		"@markuplint/config-presets": "4.0.0-alpha.3",
+		"@markuplint/html-parser": "4.0.0-alpha.3",
+		"@markuplint/html-spec": "4.0.0-alpha.3",
+		"@markuplint/i18n": "4.0.0-alpha.3",
+		"@markuplint/ml-ast": "4.0.0-alpha.3",
+		"@markuplint/ml-config": "4.0.0-alpha.3",
+		"@markuplint/ml-spec": "4.0.0-alpha.3",
+		"@markuplint/parser-utils": "4.0.0-alpha.3",
+		"@markuplint/selector": "4.0.0-alpha.3",
+		"@types/debug": "^4.1.9",
 		"debug": "^4.3.4",
 		"is-plain-object": "^5.0.0",
-		"tslib": "^2.6.1",
-		"type-fest": "^4.1.0"
+		"tslib": "^2.6.2",
+		"type-fest": "^4.3.1"
 	},
-	"gitHead": "22502ee22a378ae766033d687dbc0443e5ed35dc"
+	"gitHead": "380836f7adc1ff7e8eaf9d869e68d29eee8f3b7e"
 }