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

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 = {
@@ -180,31 +159,39 @@ export type Attribute = {
 	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;
 }

package/src/{get-ns.ts → utils/get-ns.ts}

@@ -1,4 +1,4 @@
-export function getNS(namespaceURI: string) {
+export function getNS(namespaceURI: string | null) {
 	switch (namespaceURI) {
 		case 'http://www.w3.org/2000/svg': {
 			return 'svg';

package/src/utils/resolve-namespace.ts

@@ -0,0 +1,36 @@
+import type { NamespaceURI } from '@markuplint/ml-ast';
+
+import { getNS } from './get-ns';
+
+const cache = new Map<string, NamespacedElementName>();
+
+type NamespacedElementName = {
+	localNameWithNS: string;
+	localName: string;
+	namespace: 'html' | 'svg' | 'mml';
+	namespaceURI: NamespaceURI;
+};
+
+export function resolveNamespace(localName: string, namespaceURI: string | null = 'http://www.w3.org/1999/xhtml') {
+	const cached = cache.get(localName + namespaceURI);
+	if (cached) {
+		return cached;
+	}
+	const name = localName.split(':')[1] || localName;
+	const ns = getNS(namespaceURI || null);
+	const result: NamespacedElementName = {
+		localNameWithNS: `${ns === 'html' ? '' : `${ns}:`}${name}`,
+		localName: name,
+		namespace: ns,
+		namespaceURI:
+			(
+				[
+					'http://www.w3.org/1999/xhtml',
+					'http://www.w3.org/2000/svg',
+					'http://www.w3.org/1998/Math/MathML',
+				] as const
+			).find(ns => ns === namespaceURI) || 'http://www.w3.org/1999/xhtml',
+	};
+	cache.set(localName + namespaceURI, result);
+	return result;
+}