@markuplint/ml-spec 2.0.1 → 3.0.0-alpha.0

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;
 }
@@ -1141,6 +1133,7 @@ export interface GlobalAttributes {
 				| 'onabort'
 				| 'onauxclick'
 				| 'onbeforeinput'
+				| 'onbeforematch'
 				| 'onblur'
 				| 'oncancel'
 				| 'oncanplay'
@@ -1228,6 +1221,7 @@ export interface GlobalAttributes {
 		| 'rel'
 		| 'target'
 		| 'type'
+		| 'fetchpriority'
 	)[];
 	'#HTMLEmbededAndMediaContentAttrs'?: (
 		| 'autoplay'
@@ -1411,8 +1405,6 @@ export interface Attributes {
  * via the `patternProperty` ".*".
  */
 export interface AttributeJSON {
-	_TODO_?: string;
-	ref: string;
 	type?: AttributeType | [AttributeType, ...AttributeType[]];
 	defaultValue?: string;
 	deprecated?: boolean;
@@ -1420,6 +1412,7 @@ export interface AttributeJSON {
 	requiredEither?: string[];
 	noUse?: boolean;
 	condition?: AttributeCondition;
-	ineffective?: Selectors;
+	ineffective?: AttributeCondition;
 	animatable?: boolean;
+	experimental?: boolean;
 }

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

@@ -1,6 +1,7 @@
-import type { AttributeJSON } from '.';
-import type { AttributeType, GlobalAttributes } from './attributes';
-import type { ContentModel, PermittedStructuresSchema } from './permitted-structres';
+import type { ARIA } from './aria';
+import type { AttributeJSON, AttributeType, GlobalAttributes } from './attributes';
+import type { ContentModel, Category } from './permitted-structres';
+import type { NamespaceURI } from '@markuplint/ml-ast';
 
 /**
  * markuplit Markup-language spec
@@ -33,9 +34,17 @@ export type SpecDefs = {
 		'#HTMLGlobalAttrs': Record<string, Partial<Attribute>>;
 		[OtherGlobalAttrs: string]: Record<string, Partial<Attribute>>;
 	}>;
-	'#ariaAttrs': ARIAAttribute[];
-	'#roles': ARIRRoleAttribute[];
-	'#contentModels': { [model in ContentModel]?: string[] };
+	'#aria': {
+		'1.2': ARIASpec;
+		'1.1': ARIASpec;
+	};
+	'#contentModels': { [model in Category]?: string[] };
+};
+
+type ARIASpec = {
+	roles: ARIARoleInSchema[];
+	graphicsRoles: ARIARoleInSchema[];
+	props: ARIAProperty[];
 };
 
 /**
@@ -51,7 +60,7 @@ export type ElementSpec = {
 	 * Namespaces in XML
 	 * @see https://www.w3.org/TR/xml-names/
 	 */
-	namespace?: 'http://www.w3.org/1999/xhtml' | 'http://www.w3.org/2000/svg' | 'http://www.w3.org/1998/Math/MathML';
+	namespace?: NamespaceURI;
 
 	/**
 	 * Reference URL
@@ -90,36 +99,12 @@ export type ElementSpec = {
 	/**
 	 * Element cateogries
 	 */
-	categories: ContentModel[];
+	categories: Category[];
 
 	/**
 	 * Permitted contents and permitted parents
 	 */
-	permittedStructures: PermittedStructuresSchema;
-
-	/**
-	 * Permitted ARIA roles
-	 */
-	permittedRoles: {
-		summary: string;
-		roles: PermittedRoles;
-		conditions?: {
-			condition: string;
-			roles: PermittedRoles;
-		}[];
-	};
-
-	/**
-	 * Implicit ARIA role
-	 */
-	implicitRole: {
-		summary: string;
-		role: ImplicitRole;
-		conditions?: {
-			condition: string;
-			role: ImplicitRole;
-		}[];
-	};
+	contentModel: ContentModel;
 
 	/**
 	 * Tag omittion
@@ -136,6 +121,11 @@ export type ElementSpec = {
 	 */
 	attributes: Record<string, Attribute>;
 
+	/**
+	 * WAI-ARIA role and properies
+	 */
+	aria: ARIA;
+
 	/**
 	 * If true, it is possible to add any properties as attributes,
 	 * for example, when using a template engine or a view language.
@@ -147,17 +137,6 @@ export type ElementSpec = {
 	possibleToAddProperties?: true;
 };
 
-/**
- * If `false`, this mean is "No corresponding role".
- */
-type ImplicitRole = string | false;
-
-/**
- * If `true`, this mean is "Any".
- * If `false`, this mean is "No".
- */
-export type PermittedRoles = string[] | boolean;
-
 type ElementSpecOmittion = false | ElementSpecOmittionTags;
 
 type ElementSpecOmittionTags = {
@@ -174,37 +153,45 @@ export type Attribute = {
 	type: AttributeType | AttributeType[];
 	description?: string;
 	caseSensitive?: true;
-	experimental?: true;
+	experimental?: boolean;
 	obsolete?: true;
 	deprecated?: boolean;
 	nonStandard?: true;
 } & ExtendableAttributeSpec;
 
-type ExtendableAttributeSpec = Omit<AttributeJSON, 'ref' | '_TODO_' | 'type'>;
+type ExtendableAttributeSpec = Omit<AttributeJSON, 'type'>;
 
-export type ARIRRoleAttribute = {
+export type ARIARole = {
 	name: string;
-	description: string;
-	isAbstract?: true;
-	generalization: string[];
-	requiredContextRole?: string[];
+	isAbstract: boolean;
+	requiredContextRole: string[];
+	requiredOwnedElements: string[];
 	accessibleNameRequired: boolean;
+	accessibleNameFromAuthor: boolean;
 	accessibleNameFromContent: boolean;
 	accessibleNameProhibited: boolean;
-	ownedAttribute: ARIARoleOwnedPropOrState[];
-	childrenPresentational?: boolean;
+	childrenPresentational: boolean;
+	ownedProperties: ARIARoleOwnedProperties[];
+	prohibitedProperties: string[];
 };
 
-export type ARIARoleOwnedPropOrState = {
+export type ARIARoleInSchema = Partial<
+	ARIARole & {
+		description: string;
+		generalization: string[];
+	}
+> & {
+	name: string;
+};
+
+export type ARIARoleOwnedProperties = {
 	name: string;
 	inherited?: true;
 	required?: true;
 	deprecated?: true;
-	prohibited?: true;
-	defaultValue?: boolean | string | number;
 };
 
-export type ARIAAttribute = {
+export type ARIAProperty = {
 	name: string;
 	type: 'property' | 'state';
 	deprecated?: true;
@@ -233,22 +220,36 @@ export type ARIAAttributeValue =
 	| 'token list'
 	| 'URI';
 
+export type ARIAVersion = '1.1' | '1.2';
+
 export type EquivalentHtmlAttr = {
 	htmlAttrName: string;
 	isNotStrictEquivalent?: true;
 	value: string | null;
 };
 
-export interface SpecOM {
-	[tagName: string]: MLDOMElementSpec;
-}
+export type Matches = (selector: string) => boolean;
+
+export type ComputedRole = {
+	el: Element;
+	role:
+		| (ARIARole & {
+				superClassRoles: ARIARoleInSchema[];
+				isImplicit?: boolean;
+		  })
+		| null;
+	errorType?: RoleComputationError;
+};
 
-export interface MLDOMElementSpec {
-	experimental: boolean;
-	obsolete: boolean | string;
-	deprecated: boolean;
-	nonStandard: boolean;
-	categories: ContentModel[];
-	permittedStructures: PermittedStructuresSchema;
-	attributes: Attribute[];
-}
+export type RoleComputationError =
+	| 'ABSTRACT'
+	| 'GLOBAL_PROP_MUST_NOT_BE_PRESENTATIONAL'
+	| 'IMPLICIT_ROLE_NAMESPACE_ERROR'
+	| 'INTERACTIVE_ELEMENT_MUST_NOT_BE_PRESENTATIONAL'
+	| 'INVALID_LANDMARK'
+	| 'INVALID_REQUIRED_CONTEXT_ROLE'
+	| 'NO_EXPLICIT'
+	| 'NO_OWNER'
+	| 'NO_PERMITTED'
+	| 'REQUIRED_OWNED_ELEMENT_MUST_NOT_BE_PRESENTATIONAL'
+	| 'ROLE_NO_EXISTS';

package/src/{permitted-structres.ts → types/permitted-structres.ts}

@@ -12,9 +12,10 @@ export type PermittedContent =
 	| PermittedContentZeroOrMore
 	| PermittedContentChoice
 	| PermittedContentInterleave;
-export type Target = Node | Node[];
-export type Node = string | '#text' | ContentModel;
-export type ContentModel =
+export type Target = ContentType | ContentType[];
+export type ContentType = string | Category;
+export type Category =
+	| '#text'
 	| '#phrasing'
 	| '#flow'
 	| '#interactive'
@@ -47,32 +48,21 @@ export type ContentModel =
 	| '#SVGOtherXMLNamespace';
 export type PermittedContentSpec = PermittedContent[];
 
-export interface PermittedStructuresSchema {
-	summary?: string;
-	tag: string;
+export interface ContentModelsSchema {
+	__contentModel?: ContentModel;
+}
+export interface ContentModel {
+	contents: PermittedContentSpec | boolean;
+	descendantOf?: string;
 	conditional?: {
-		condition:
-			| {
-					hasAttr: string;
-			  }
-			| {
-					parent: string;
-					/**
-					 * Not support yet
-					 */
-					hasNotAttr?: string;
-					_TODO_?: string;
-					_parent?: string;
-			  };
+		condition: string;
 		contents: PermittedContentSpec | boolean;
 	}[];
-	contents: PermittedContentSpec | boolean;
-	ancestor?: Node;
 }
 export interface PermittedContentRequire {
 	require: Target;
 	ignore?: Target;
-	notAllowedDescendants?: Node[];
+	notAllowedDescendants?: ContentType[];
 	max?: number;
 	min?: number;
 	_TODO_?: string;
@@ -80,21 +70,21 @@ export interface PermittedContentRequire {
 export interface PermittedContentOptional {
 	optional: Target;
 	ignore?: Target;
-	notAllowedDescendants?: Node[];
+	notAllowedDescendants?: ContentType[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentOneOrMore {
 	oneOrMore: Target | PermittedContentSpec;
 	ignore?: Target;
-	notAllowedDescendants?: Node[];
+	notAllowedDescendants?: ContentType[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentZeroOrMore {
 	zeroOrMore: Target | PermittedContentSpec;
 	ignore?: Target;
-	notAllowedDescendants?: Node[];
+	notAllowedDescendants?: ContentType[];
 	max?: number;
 	_TODO_?: string;
 }