@markuplint/ml-spec 2.1.0 → 3.0.0-alpha.82

package/src/specs/get-permitted-roles.ts

@@ -0,0 +1,87 @@
+import type { ARIAVersion, Matches, MLMLSpec } from '../types';
+
+import { mergeArray } from '../utils/merge-array';
+
+import { ariaSpecs } from './aria-specs';
+import { getARIA } from './get-aria';
+
+/**
+ * Getting permitted ARIA roles.
+ *
+ * - If an array, it is role list.
+ * - If `true`, this mean is "Any".
+ * - If `false`, this mean is "No".
+ */
+export function getPermittedRoles(
+	specs: Readonly<MLMLSpec>,
+	localName: string,
+	namespace: string | null,
+	version: ARIAVersion,
+	matches: Matches,
+): { name: string; deprecated?: boolean }[] {
+	const aria = getARIA(specs, localName, namespace, version, matches);
+	if (!aria) {
+		return [];
+	}
+	const { implicitRole, permittedRoles } = aria;
+	const { roles, graphicsRoles } = ariaSpecs(specs, version);
+
+	let permittedRoleList: { name: string }[] = [];
+
+	if (permittedRoles === true) {
+		permittedRoleList = mergeArray(
+			permittedRoleList,
+			roles
+				.filter(role => !role.isAbstract)
+				.map(role => ({
+					name: role.name,
+				})),
+		);
+	}
+
+	if (Array.isArray(permittedRoles)) {
+		permittedRoleList = mergeArray(
+			permittedRoleList,
+			permittedRoles.map(role => {
+				if (typeof role === 'string') {
+					return {
+						name: role,
+					};
+				}
+				return role;
+			}),
+		);
+	} else if (!(typeof permittedRoles === 'boolean')) {
+		if (permittedRoles['core-aam']) {
+			permittedRoleList = mergeArray(
+				permittedRoleList,
+				roles
+					.filter(role => !role.isAbstract)
+					.map(role => ({
+						name: role.name,
+					})),
+			);
+		}
+		if (permittedRoles['graphics-aam']) {
+			permittedRoleList = mergeArray(
+				permittedRoleList,
+				graphicsRoles
+					.filter(role => !role.isAbstract)
+					.map(role => ({
+						name: role.name,
+					})),
+			);
+		}
+	}
+
+	if (implicitRole) {
+		const implicitRoles =
+			implicitRole === 'presentation' || implicitRole === 'none' ? ['none', 'presentation'] : [implicitRole];
+		return mergeArray(
+			implicitRoles.map(r => ({ name: r })),
+			permittedRoleList,
+		);
+	}
+
+	return permittedRoleList;
+}

package/src/specs/get-role-spec.spec.ts

@@ -0,0 +1,67 @@
+import specs from '@markuplint/html-spec';
+
+import { getRoleSpec } from './get-role-spec';
+
+describe('getRoleSpec', () => {
+	test('the button role', () => {
+		const role = getRoleSpec(specs, 'button', 'http://www.w3.org/1999/xhtml', '1.2')!;
+		const superClassRoles = role.superClassRoles.map(r => r.name);
+		expect(role.ownedProperties.map(p => p.name + (p.deprecated ? ':deprecated' : ''))).toStrictEqual([
+			'aria-atomic',
+			'aria-busy',
+			'aria-controls',
+			'aria-current',
+			'aria-describedby',
+			'aria-details',
+			'aria-disabled',
+			'aria-dropeffect',
+			'aria-errormessage:deprecated',
+			'aria-expanded',
+			'aria-flowto',
+			'aria-grabbed',
+			'aria-haspopup',
+			'aria-hidden',
+			'aria-invalid:deprecated',
+			'aria-keyshortcuts',
+			'aria-label',
+			'aria-labelledby',
+			'aria-live',
+			'aria-owns',
+			'aria-pressed',
+			'aria-relevant',
+			'aria-roledescription',
+		]);
+		expect(role.isAbstract).toBe(false);
+		expect(superClassRoles).toStrictEqual(['command', 'widget', 'roletype']);
+	});
+
+	test('the roletype role', () => {
+		const role = getRoleSpec(specs, 'roletype', 'http://www.w3.org/1999/xhtml', '1.2')!;
+		const superClassRoles = role.superClassRoles.map(r => r.name);
+		expect(role.ownedProperties.map(p => p.name + (p.deprecated ? ':deprecated' : ''))).toStrictEqual([
+			'aria-atomic',
+			'aria-busy',
+			'aria-controls',
+			'aria-current',
+			'aria-describedby',
+			'aria-details',
+			'aria-disabled:deprecated',
+			'aria-dropeffect',
+			'aria-errormessage:deprecated',
+			'aria-flowto',
+			'aria-grabbed',
+			'aria-haspopup:deprecated',
+			'aria-hidden',
+			'aria-invalid:deprecated',
+			'aria-keyshortcuts',
+			'aria-label',
+			'aria-labelledby',
+			'aria-live',
+			'aria-owns',
+			'aria-relevant',
+			'aria-roledescription',
+		]);
+		expect(role.isAbstract).toBe(true);
+		expect(superClassRoles).toStrictEqual([]);
+	});
+});

package/src/specs/get-role-spec.ts

@@ -0,0 +1,72 @@
+import type { ARIAVersion, ARIARoleInSchema, MLMLSpec, ARIARole } from '../types';
+import type { NamespaceURI } from '@markuplint/ml-ast';
+
+import { ariaSpecs } from './aria-specs';
+
+export function getRoleSpec(
+	specs: Readonly<MLMLSpec>,
+	roleName: string,
+	namespace: NamespaceURI,
+	version: ARIAVersion,
+): (ARIARole & { superClassRoles: ARIARoleInSchema[] }) | null {
+	const role = getRoleByName(specs, roleName, namespace, version);
+	if (!role) {
+		return null;
+	}
+	const superClassRoles = recursiveTraverseSuperClassRoles(specs, roleName, namespace, version);
+	return {
+		name: role.name,
+		isAbstract: !!role.isAbstract,
+		requiredContextRole: role.requiredContextRole ?? [],
+		requiredOwnedElements: role.requiredOwnedElements ?? [],
+		accessibleNameRequired: !!role.accessibleNameRequired,
+		accessibleNameFromAuthor: !!role.accessibleNameFromAuthor,
+		accessibleNameFromContent: !!role.accessibleNameFromContent,
+		accessibleNameProhibited: !!role.accessibleNameProhibited,
+		childrenPresentational: !!role.childrenPresentational,
+		ownedProperties: role.ownedProperties ?? [],
+		prohibitedProperties: role.prohibitedProperties ?? [],
+		superClassRoles,
+	};
+}
+
+function recursiveTraverseSuperClassRoles(
+	specs: Readonly<MLMLSpec>,
+	roleName: string,
+	namespace: NamespaceURI,
+	version: ARIAVersion,
+) {
+	const roles: ARIARoleInSchema[] = [];
+	const superClassRoles = getSuperClassRoles(specs, roleName, namespace, version);
+	if (superClassRoles) {
+		roles.push(...superClassRoles);
+		for (const superClassRole of superClassRoles) {
+			const ancestorRoles = recursiveTraverseSuperClassRoles(specs, superClassRole.name, namespace, version);
+			roles.push(...ancestorRoles);
+		}
+	}
+	return roles;
+}
+
+function getSuperClassRoles(
+	specs: Readonly<MLMLSpec>,
+	roleName: string,
+	namespace: NamespaceURI,
+	version: ARIAVersion,
+) {
+	const role = getRoleByName(specs, roleName, namespace, version);
+	return (
+		role?.generalization
+			?.map(roleName => getRoleByName(specs, roleName, namespace, version))
+			.filter((role): role is ARIARoleInSchema => !!role) || null
+	);
+}
+
+function getRoleByName(specs: Readonly<MLMLSpec>, roleName: string, namespace: NamespaceURI, version: ARIAVersion) {
+	const { roles, graphicsRoles } = ariaSpecs(specs, version);
+	let role = roles.find(r => r.name === roleName);
+	if (!role && namespace === 'http://www.w3.org/2000/svg') {
+		role = graphicsRoles.find(r => r.name === roleName);
+	}
+	return role;
+}

package/src/specs/get-selectors-by-content-model-category.ts

@@ -0,0 +1,10 @@
+import type { MLMLSpec } from '../types';
+import type { Category } from '../types/permitted-structres';
+
+export function getSelectorsByContentModelCategory(
+	specs: Readonly<MLMLSpec>,
+	category: Category,
+): ReadonlyArray<string> {
+	const selectors = specs.def['#contentModels'][category];
+	return selectors || [];
+}

package/src/specs/get-spec-by-tag-name.spec.ts

@@ -0,0 +1,68 @@
+import specs from '@markuplint/html-spec';
+
+import { getSpecByTagName } from './get-spec-by-tag-name';
+
+const divSpec = {
+	conditional: [
+		{
+			condition: 'dl > div',
+			contents: [
+				{
+					zeroOrMore: '#script-supporting',
+				},
+				{
+					oneOrMore: 'dt',
+				},
+				{
+					zeroOrMore: '#script-supporting',
+				},
+				{
+					oneOrMore: 'dd',
+				},
+				{
+					zeroOrMore: '#script-supporting',
+				},
+			],
+		},
+	],
+	contents: [
+		{
+			zeroOrMore: '#flow',
+		},
+	],
+};
+
+test('html:div', () => {
+	expect(getSpecByTagName(specs, 'div', null)?.contentModel).toStrictEqual(divSpec);
+	expect(getSpecByTagName(specs, 'div', 'unknown-namespace')?.contentModel).toStrictEqual(divSpec);
+	expect(getSpecByTagName(specs, 'div', 'http://www.w3.org/1999/xhtml')?.contentModel).toStrictEqual(divSpec);
+});
+
+test('svg:svg', () => {
+	expect(getSpecByTagName(specs, 'svg', 'http://www.w3.org/2000/svg')?.contentModel).toStrictEqual({
+		contents: [
+			{
+				zeroOrMore: [
+					'#SVGAnimation',
+					'#SVGDescriptive',
+					'#SVGPaintServer',
+					'#SVGShape',
+					'#SVGStructural',
+					'svg|a',
+					'svg|clipPath',
+					'svg|filter',
+					'svg|foreignObject',
+					'svg|image',
+					'svg|marker',
+					'svg|mask',
+					'svg|script',
+					'svg|style',
+					'svg|switch',
+					'svg|text',
+					'svg|view',
+				],
+			},
+		],
+	});
+	expect(getSpecByTagName(specs, 'svg', null)).toBe(null);
+});

package/src/specs/get-spec-by-tag-name.ts

@@ -0,0 +1,16 @@
+import type { ElementSpec, MLMLSpec } from '../types';
+
+import { resolveNamespace } from '../utils/resolve-namespace';
+
+const cache = new Map<string, ElementSpec | null>();
+
+export function getSpecByTagName(specs: Readonly<MLMLSpec>, localName: string, namespace: string | null) {
+	const { localNameWithNS } = resolveNamespace(localName, namespace || undefined);
+	let spec = cache.get(localNameWithNS);
+	if (spec !== undefined) {
+		return spec;
+	}
+	spec = specs.specs.find(spec => spec.name === localNameWithNS) || null;
+	cache.set(localNameWithNS, spec);
+	return spec;
+}

package/src/specs/is-presentational.ts

@@ -0,0 +1,6 @@
+export function isPresentational(roleName?: string) {
+	if (!roleName) {
+		return false;
+	}
+	return ['presentation', 'none'].includes(roleName);
+}

package/src/specs/resolve-version.ts

@@ -0,0 +1,20 @@
+import type { ARIAVersion } from '../types';
+import type { ARIA } from '../types/aria';
+
+export function resolveVersion(aria: ARIA, version: ARIAVersion): Omit<ARIA, ARIAVersion> {
+	const implicitRole = aria[version]?.implicitRole ?? aria.implicitRole;
+	const permittedRoles = aria[version]?.permittedRoles ?? aria.permittedRoles;
+	const implicitProperties = aria[version]?.implicitProperties ?? aria.implicitProperties;
+	const properties = aria[version]?.properties ?? aria.properties;
+	const namingProhibited =
+		version === '1.2' ? aria[version]?.namingProhibited ?? aria.namingProhibited : aria.namingProhibited;
+	const conditions = aria[version]?.conditions ?? aria.conditions;
+	return {
+		implicitRole,
+		permittedRoles,
+		implicitProperties,
+		properties,
+		namingProhibited,
+		conditions,
+	};
+}

package/src/{get-spec.spec.ts → specs/schema-to-spec.spec.ts}

@@ -1,6 +1,6 @@
 import htmlSpec from '@markuplint/html-spec';
 
-import { getSpec } from './get-spec';
+import { schemaToSpec } from './schema-to-spec';
 
 describe('getSpec', () => {
 	test('Overriding', () => {
@@ -14,7 +14,7 @@ describe('getSpec', () => {
 			type: 'Boolean',
 			description: 'For the unit test. Override.',
 		} as const;
-		const mergedSpec = getSpec([
+		const mergedSpec = schemaToSpec([
 			htmlSpec,
 			{
 				specs: [

package/src/{get-spec.ts → specs/schema-to-spec.ts}

@@ -1,6 +1,6 @@
-import type { ElementSpec, ExtendedSpec, MLMLSpec, Attribute } from './types';
+import type { ElementSpec, ExtendedSpec, MLMLSpec, Attribute } from '../types';
 
-import { mergeArray } from './utils';
+import { mergeArray } from '../utils/merge-array';
 
 /**
  * Merging HTML-spec schema and extended spec schemas
@@ -9,7 +9,7 @@ import { mergeArray } from './utils';
  *
  * @param schemas `MLDocument.schemas`
  */
-export function getSpec(schemas: readonly [MLMLSpec, ...ExtendedSpec[]]) {
+export function schemaToSpec(schemas: readonly [MLMLSpec, ...ExtendedSpec[]]) {
 	const [main, ...extendedSpecs] = schemas;
 	const result = { ...main };
 	for (const extendedSpec of extendedSpecs) {
@@ -17,17 +17,31 @@ export function getSpec(schemas: readonly [MLMLSpec, ...ExtendedSpec[]]) {
 			result.cites = [...result.cites, ...extendedSpec.cites];
 		}
 		if (extendedSpec.def) {
-			if (extendedSpec.def['#ariaAttrs']) {
-				result.def['#ariaAttrs'] = [...result.def['#ariaAttrs'], ...extendedSpec.def['#ariaAttrs']];
-			}
 			if (extendedSpec.def['#globalAttrs']?.['#extends']) {
 				result.def['#globalAttrs']['#HTMLGlobalAttrs'] = {
 					...(result.def['#globalAttrs']?.['#HTMLGlobalAttrs'] || {}),
 					...(extendedSpec.def['#globalAttrs']?.['#extends'] || {}),
 				};
 			}
-			if (extendedSpec.def['#roles']) {
-				result.def['#roles'] = [...result.def['#roles'], ...extendedSpec.def['#roles']];
+			if (extendedSpec.def['#aria']) {
+				result.def['#aria'] = {
+					'1.1': {
+						roles: mergeArray(result.def['#aria']['1.1'].roles, extendedSpec.def['#aria']['1.1'].roles),
+						props: mergeArray(result.def['#aria']['1.1'].props, extendedSpec.def['#aria']['1.1'].props),
+						graphicsRoles: mergeArray(
+							result.def['#aria']['1.1'].graphicsRoles,
+							extendedSpec.def['#aria']['1.1'].graphicsRoles,
+						),
+					},
+					'1.2': {
+						roles: mergeArray(result.def['#aria']['1.2'].roles, extendedSpec.def['#aria']['1.2'].roles),
+						props: mergeArray(result.def['#aria']['1.2'].props, extendedSpec.def['#aria']['1.2'].props),
+						graphicsRoles: mergeArray(
+							result.def['#aria']['1.2'].graphicsRoles,
+							extendedSpec.def['#aria']['1.2'].graphicsRoles,
+						),
+					},
+				};
 			}
 			if (extendedSpec.def['#contentModels']) {
 				const keys = new Set([

package/src/types/aria.ts

@@ -0,0 +1,147 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * If `false`, this mean is "No corresponding role".
+ */
+export type ImplicitRole = false | string;
+/**
+ * If `true`, this mean is "Any". If `false`, this mean is "No".
+ */
+export type PermittedRoles =
+	| boolean
+	| (
+			| string
+			| {
+					name: string;
+					deprecated?: true;
+					[k: string]: unknown;
+			  }
+	  )[]
+	| {
+			'core-aam'?: true;
+			'graphics-aam'?: true;
+	  };
+/**
+ * If set false:
+ * > No role or aria-* attributes
+ */
+export type PermittedARIAProperties =
+	| false
+	| {
+			global?: true;
+			/**
+			 * Set true if the spec says "and any aria-* attributes applicable to the allowed roles."
+			 */
+			role?: true | string | [string, ...string[]];
+			only?: [
+				(
+					| string
+					| {
+							name: string;
+							value?: string;
+					  }
+				),
+				...(
+					| string
+					| {
+							name: string;
+							value?: string;
+					  }
+				)[],
+			];
+			whithout?: [
+				{
+					type: 'not-recommended' | 'should-not' | 'must-not';
+					name: string;
+					value?: string;
+					alt?: {
+						method: 'remove-attr' | 'set-attr';
+						target: string;
+					};
+				},
+				...{
+					type: 'not-recommended' | 'should-not' | 'must-not';
+					name: string;
+					value?: string;
+					alt?: {
+						method: 'remove-attr' | 'set-attr';
+						target: string;
+					};
+				}[],
+			];
+	  };
+
+export interface AriaSchema {
+	_?: ARIA;
+	[k: string]: unknown;
+}
+export interface ARIA {
+	implicitRole: ImplicitRole;
+	permittedRoles: PermittedRoles;
+	namingProhibited?: true;
+	implicitProperties?: ImplicitProperties;
+	properties?: PermittedARIAProperties;
+	conditions?: {
+		/**
+		 * This interface was referenced by `undefined`'s JSON-Schema definition
+		 * via the `patternProperty` ".+".
+		 */
+		[k: string]: {
+			implicitRole?: ImplicitRole;
+			permittedRoles?: PermittedRoles;
+			namingProhibited?: true;
+			implicitProperties?: ImplicitProperties;
+			properties?: PermittedARIAProperties;
+		};
+	};
+	'1.2'?: {
+		implicitRole?: ImplicitRole;
+		permittedRoles?: PermittedRoles;
+		namingProhibited?: true;
+		implicitProperties?: ImplicitProperties;
+		properties?: PermittedARIAProperties;
+		conditions?: {
+			/**
+			 * This interface was referenced by `undefined`'s JSON-Schema definition
+			 * via the `patternProperty` ".+".
+			 */
+			[k: string]: {
+				implicitRole?: ImplicitRole;
+				permittedRoles?: PermittedRoles;
+				namingProhibited?: true;
+				implicitProperties?: ImplicitProperties;
+				properties?: PermittedARIAProperties;
+			};
+		};
+	};
+	'1.1'?: {
+		implicitRole?: ImplicitRole;
+		permittedRoles?: PermittedRoles;
+		implicitProperties?: ImplicitProperties;
+		properties?: PermittedARIAProperties;
+		conditions?: {
+			/**
+			 * This interface was referenced by `undefined`'s JSON-Schema definition
+			 * via the `patternProperty` ".+".
+			 */
+			[k: string]: {
+				implicitRole?: ImplicitRole;
+				permittedRoles?: PermittedRoles;
+				implicitProperties?: ImplicitProperties;
+				properties?: PermittedARIAProperties;
+			};
+		};
+	};
+}
+export interface ImplicitProperties {
+	/**
+	 * This interface was referenced by `ImplicitProperties`'s JSON-Schema definition
+	 * via the `patternProperty` "^aria-.+".
+	 */
+	[k: string]: string;
+}

package/src/{attributes.ts → types/attributes.ts}

@@ -1118,18 +1118,10 @@ export type AttributeType =
 			lte?: number;
 			clampable?: boolean;
 	  };
-export type AttributeCondition =
-	| {
-			ancestor: Selectors;
-	  }
-	| {
-			self: Selectors;
-	  };
-export type Selectors = string | [string, string, ...string[]];
+export type AttributeCondition = string | [string, string, ...string[]];
 
 export interface AttributesSchema {
 	tag: string;
-	ref: string;
 	global?: GlobalAttributes;
 	attributes: Attributes;
 }
@@ -1413,8 +1405,6 @@ export interface Attributes {
  * via the `patternProperty` ".*".
  */
 export interface AttributeJSON {
-	_TODO_?: string;
-	ref: string;
 	type?: AttributeType | [AttributeType, ...AttributeType[]];
 	defaultValue?: string;
 	deprecated?: boolean;
@@ -1422,7 +1412,7 @@ export interface AttributeJSON {
 	requiredEither?: string[];
 	noUse?: boolean;
 	condition?: AttributeCondition;
-	ineffective?: Selectors;
+	ineffective?: AttributeCondition;
 	animatable?: boolean;
 	experimental?: boolean;
 }