@markuplint/ml-spec 2.1.1 → 3.0.0-alpha.1

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

@@ -1013,123 +1013,13 @@ export type AttributeType =
 			  )
 			| 'Boolean'
 	  )
-	| {
-			token:
-				| (
-						| 'Any'
-						| 'NoEmptyAny'
-						| 'OneLineAny'
-						| 'Zero'
-						| 'Number'
-						| 'Int'
-						| 'Uint'
-						| 'XMLName'
-						| 'DOMID'
-						| 'FunctionBody'
-						| 'Pattern'
-						| 'DateTime'
-						| 'TabIndex'
-						| 'BCP47'
-						| 'URL'
-						| 'AbsoluteURL'
-						| 'HashName'
-						| 'OneCodePointChar'
-						| 'CustomElementName'
-						| 'BrowsingContextName'
-						| 'BrowsingContextNameOrKeyword'
-						| 'HTTPSchemaURL'
-						| 'MIMEType'
-						| 'ItemProp'
-						| 'Srcset'
-						| 'SourceSizeList'
-						| 'IconSize'
-						| 'AutoComplete'
-						| 'Accept'
-						| 'SerializedPermissionsPolicy'
-						| '<css-declaration-list>'
-						| '<class-list>'
-						| '<svg-font-size>'
-						| '<svg-font-size-adjust>'
-						| "<'color-profile'>"
-						| "<'color-rendering'>"
-						| "<'enable-background'>"
-						| '<list-of-svg-feature-string>'
-						| '<animatable-value>'
-						| '<begin-value-list>'
-						| '<end-value-list>'
-						| '<list-of-value>'
-						| '<clock-value>'
-						| '<color-matrix>'
-						| '<dasharray>'
-						| '<key-points>'
-						| '<key-splines>'
-						| '<key-times>'
-						| '<system-language>'
-						| '<origin>'
-						| '<svg-path>'
-						| '<points>'
-						| '<preserve-aspect-ratio>'
-						| '<view-box>'
-						| '<rotate>'
-						| '<text-coordinate>'
-						| '<list-of-lengths>'
-						| '<list-of-numbers>'
-						| '<list-of-percentages>'
-						| '<number-optional-number>'
-				  )
-				| {
-						enum: [string, ...string[]];
-						disallowToSurroundBySpaces?: boolean;
-						caseInsensitive?: boolean;
-						invalidValueDefault?: string;
-						missingValueDefault?: string;
-						sameStates?: {
-							[k: string]: unknown;
-						};
-				  };
-			disallowToSurroundBySpaces?: boolean;
-			allowEmpty?: boolean;
-			ordered?: boolean;
-			unique?: boolean;
-			caseInsensitive?: boolean;
-			number?:
-				| ('zeroOrMore' | 'oneOrMore')
-				| {
-						min: number;
-						max: number;
-				  };
-			separator: 'space' | 'comma';
-	  }
-	| {
-			enum: [string, ...string[]];
-			disallowToSurroundBySpaces?: boolean;
-			caseInsensitive?: boolean;
-			invalidValueDefault?: string;
-			missingValueDefault?: string;
-			sameStates?: {
-				[k: string]: unknown;
-			};
-	  }
-	| {
-			type: 'float' | 'integer';
-			gt?: number;
-			gte?: number;
-			lt?: number;
-			lte?: number;
-			clampable?: boolean;
-	  };
-export type AttributeCondition =
-	| {
-			ancestor: Selectors;
-	  }
-	| {
-			self: Selectors;
-	  };
-export type Selectors = string | [string, string, ...string[]];
+	| List
+	| Enum
+	| Number;
+export type AttributeCondition = string | [string, string, ...string[]];
 
 export interface AttributesSchema {
 	tag: string;
-	ref: string;
 	global?: GlobalAttributes;
 	attributes: Attributes;
 }
@@ -1216,6 +1106,9 @@ export interface GlobalAttributes {
 				| 'onwheel'
 		  )[];
 	'#DocumentElementEventAttrs'?: boolean | ('oncopy' | 'oncut' | 'onpaste')[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLLinkAndFetchingAttrs'?: (
 		| 'crossorigin'
 		| 'download'
@@ -1231,6 +1124,9 @@ export interface GlobalAttributes {
 		| 'type'
 		| 'fetchpriority'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLEmbededAndMediaContentAttrs'?: (
 		| 'autoplay'
 		| 'controls'
@@ -1243,6 +1139,9 @@ export interface GlobalAttributes {
 		| 'srcset'
 		| 'width'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLFormControlElementAttrs'?: (
 		| 'autocomplete'
 		| 'dirname'
@@ -1259,12 +1158,30 @@ export interface GlobalAttributes {
 		| 'readonly'
 		| 'required'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLTableCellElementAttrs'?: ('colspan' | 'headers' | 'rowspan')[];
 	'#ARIAAttrs'?: boolean;
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationAdditionAttrs'?: ('additive' | 'accumulate')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationAttributeTargetAttrs'?: ('attributeName' | 'attributeType')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationEventAttrs'?: ('onbegin' | 'onend' | 'onrepeat')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationTargetElementAttrs'?: ('href' | 'xlink:href')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationTimingAttrs'?: (
 		| 'begin'
 		| 'dur'
@@ -1276,6 +1193,9 @@ export interface GlobalAttributes {
 		| 'repeatDur'
 		| 'fill'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationValueAttrs'?: (
 		| 'calcMode'
 		| 'values'
@@ -1289,7 +1209,13 @@ export interface GlobalAttributes {
 		| 'autoReverse'
 		| 'speed'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGConditionalProcessingAttrs'?: ('requiredExtensions' | 'systemLanguage' | 'requiredFeatures')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGCoreAttrs'?: (
 		| 'id'
 		| 'tabindex'
@@ -1302,7 +1228,13 @@ export interface GlobalAttributes {
 		| 'xml:lang'
 		| 'xml:base'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGFilterPrimitiveAttrs'?: ('x' | 'y' | 'width' | 'height' | 'result' | 'in')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGPresentationAttrs'?: (
 		| 'cx'
 		| 'cy'
@@ -1386,6 +1318,9 @@ export interface GlobalAttributes {
 		| 'enable-background'
 		| 'kerning'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGTransferFunctionAttrs'?: (
 		| 'type'
 		| 'tableValues'
@@ -1395,6 +1330,9 @@ export interface GlobalAttributes {
 		| 'exponent'
 		| 'offset'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#XLinkAttrs'?: (
 		| 'xlink:href'
 		| 'xlink:title'
@@ -1413,8 +1351,6 @@ export interface Attributes {
  * via the `patternProperty` ".*".
  */
 export interface AttributeJSON {
-	_TODO_?: string;
-	ref: string;
 	type?: AttributeType | [AttributeType, ...AttributeType[]];
 	defaultValue?: string;
 	deprecated?: boolean;
@@ -1422,7 +1358,116 @@ export interface AttributeJSON {
 	requiredEither?: string[];
 	noUse?: boolean;
 	condition?: AttributeCondition;
-	ineffective?: Selectors;
+	ineffective?: AttributeCondition;
 	animatable?: boolean;
 	experimental?: boolean;
 }
+/**
+ * - [Space-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#space-separated-tokens)
+ * - [Comma-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#comma-separated-tokens)
+ */
+export interface List {
+	token:
+		| (
+				| 'Any'
+				| 'NoEmptyAny'
+				| 'OneLineAny'
+				| 'Zero'
+				| 'Number'
+				| 'Int'
+				| 'Uint'
+				| 'XMLName'
+				| 'DOMID'
+				| 'FunctionBody'
+				| 'Pattern'
+				| 'DateTime'
+				| 'TabIndex'
+				| 'BCP47'
+				| 'URL'
+				| 'AbsoluteURL'
+				| 'HashName'
+				| 'OneCodePointChar'
+				| 'CustomElementName'
+				| 'BrowsingContextName'
+				| 'BrowsingContextNameOrKeyword'
+				| 'HTTPSchemaURL'
+				| 'MIMEType'
+				| 'ItemProp'
+				| 'Srcset'
+				| 'SourceSizeList'
+				| 'IconSize'
+				| 'AutoComplete'
+				| 'Accept'
+				| 'SerializedPermissionsPolicy'
+				| '<css-declaration-list>'
+				| '<class-list>'
+				| '<svg-font-size>'
+				| '<svg-font-size-adjust>'
+				| "<'color-profile'>"
+				| "<'color-rendering'>"
+				| "<'enable-background'>"
+				| '<list-of-svg-feature-string>'
+				| '<animatable-value>'
+				| '<begin-value-list>'
+				| '<end-value-list>'
+				| '<list-of-value>'
+				| '<clock-value>'
+				| '<color-matrix>'
+				| '<dasharray>'
+				| '<key-points>'
+				| '<key-splines>'
+				| '<key-times>'
+				| '<system-language>'
+				| '<origin>'
+				| '<svg-path>'
+				| '<points>'
+				| '<preserve-aspect-ratio>'
+				| '<view-box>'
+				| '<rotate>'
+				| '<text-coordinate>'
+				| '<list-of-lengths>'
+				| '<list-of-numbers>'
+				| '<list-of-percentages>'
+				| '<number-optional-number>'
+		  )
+		| Enum;
+	disallowToSurroundBySpaces?: boolean;
+	allowEmpty?: boolean;
+	ordered?: boolean;
+	unique?: boolean;
+	caseInsensitive?: boolean;
+	number?:
+		| ('zeroOrMore' | 'oneOrMore')
+		| {
+				min: number;
+				max: number;
+		  };
+	separator: 'space' | 'comma';
+}
+/**
+ * [Enumerated attributes](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#enumerated-attribute)
+ */
+export interface Enum {
+	/**
+	 * @minItems 1
+	 */
+	enum: [string, ...string[]];
+	disallowToSurroundBySpaces?: boolean;
+	caseInsensitive?: boolean;
+	invalidValueDefault?: string;
+	missingValueDefault?: string;
+	sameStates?: {
+		[k: string]: unknown;
+	};
+}
+/**
+ * [Numbers](https://html.spec.whatwg.org/dev/common-microsyntaxes.html#numbers)
+ */
+export interface Number {
+	type: 'float' | 'integer';
+	gt?: number;
+	gte?: number;
+	lt?: number;
+	lte?: number;
+	clampable?: boolean;
+}

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

@@ -1,9 +1,10 @@
-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-structures';
+import type { NamespaceURI } from '@markuplint/ml-ast';
 
 /**
- * markuplit Markup-language spec
+ * markuplint Markup-language spec
  */
 export interface MLMLSpec {
 	cites: Cites;
@@ -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
@@ -88,43 +97,19 @@ export type ElementSpec = {
 	nonStandard?: true;
 
 	/**
-	 * Element cateogries
+	 * Element categories
 	 */
-	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
+	 * Tag omission
 	 */
-	omittion: ElementSpecOmittion;
+	omission: ElementSpecOmission;
 
 	/**
 	 * Global Attributes
@@ -136,6 +121,11 @@ export type ElementSpec = {
 	 */
 	attributes: Record<string, Attribute>;
 
+	/**
+	 * WAI-ARIA role and properties
+	 */
+	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,20 +137,9 @@ export type ElementSpec = {
 	possibleToAddProperties?: true;
 };
 
-/**
- * If `false`, this mean is "No corresponding role".
- */
-type ImplicitRole = string | false;
+type ElementSpecOmission = false | ElementSpecOmissionTags;
 
-/**
- * If `true`, this mean is "Any".
- * If `false`, this mean is "No".
- */
-export type PermittedRoles = string[] | boolean;
-
-type ElementSpecOmittion = false | ElementSpecOmittionTags;
-
-type ElementSpecOmittionTags = {
+type ElementSpecOmissionTags = {
 	startTag: boolean | ElementCondition;
 	endTag: boolean | ElementCondition;
 };
@@ -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/types/permitted-structres.ts

@@ -0,0 +1,101 @@
+/* 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.
+ */
+
+export type PermittedContentPattern =
+	| PermittedContentRequire
+	| PermittedContentOptional
+	| PermittedContentOneOrMore
+	| PermittedContentZeroOrMore
+	| PermittedContentChoice
+	| PermittedContentTransparent;
+export type Model = ContentType | ContentType[];
+export type ContentType = string | Category;
+export type Category =
+	| '#text'
+	| '#phrasing'
+	| '#flow'
+	| '#interactive'
+	| '#heading'
+	| '#sectioning'
+	| '#metadata'
+	| '#embedded'
+	| '#palpable'
+	| '#script-supporting'
+	| '#SVGAnimation'
+	| '#SVGBasicShapes'
+	| '#SVGContainer'
+	| '#SVGDescriptive'
+	| '#SVGFilterPrimitive'
+	| '#SVGFont'
+	| '#SVGGradient'
+	| '#SVGGraphics'
+	| '#SVGGraphicsReferencing'
+	| '#SVGLightSource'
+	| '#SVGNeverRendered'
+	| '#SVGNone'
+	| '#SVGPaintServer'
+	| '#SVGRenderable'
+	| '#SVGShape'
+	| '#SVGStructural'
+	| '#SVGStructurallyExternal'
+	| '#SVGTextContent'
+	| '#SVGTextContentChild'
+	| '#SVGOtherXMLNamespace';
+
+export interface ContentModelsSchema {
+	__contentModel?: ContentModel;
+}
+export interface ContentModel {
+	contents: PermittedContentPattern[] | boolean;
+	descendantOf?: string;
+	conditional?: {
+		condition: string;
+		contents: PermittedContentPattern[] | boolean;
+	}[];
+}
+export interface PermittedContentRequire {
+	require: Model;
+	max?: number;
+	min?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentOptional {
+	optional: Model;
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentOneOrMore {
+	oneOrMore: Model | PermittedContentPattern[];
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentZeroOrMore {
+	zeroOrMore: Model | PermittedContentPattern[];
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentChoice {
+	/**
+	 * @minItems 2
+	 * @maxItems 5
+	 */
+	choice:
+		| [PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+		  ];
+	_TODO_?: string;
+}
+export interface PermittedContentTransparent {
+	transparent: string;
+}