@markuplint/ml-spec 1.5.0 → 2.0.0-dev.26

package/schemas/permitted-structures.schema.json

@@ -3,10 +3,22 @@
 		"Node": {
 			"oneOf": [
 				{
+					"description": "HTML Element",
 					"type": "string",
-					"pattern": "^[a-z][a-z0-9]+$"
+					"pattern": "^[a-z][a-z0-9]*$"
 				},
 				{
+					"description": "Namespaced HTML Element",
+					"type": "string",
+					"pattern": "^html:[a-z][a-z0-9]*$"
+				},
+				{
+					"description": "SVG Element",
+					"type": "string",
+					"pattern": "^svg:(?:[a-z][a-zA-Z0-9]*|[a-z][a-z0-9]*-[a-z][a-z0-9]*)$"
+				},
+				{
+					"description": "Text Node",
 					"type": "string",
 					"enum": ["#text"]
 				},
@@ -25,7 +37,27 @@
 				"#transparent",
 				"#embedded",
 				"#palpable",
-				"#script-supporting"
+				"#script-supporting",
+				"#SVGAnimation",
+				"#SVGBasicShapes",
+				"#SVGContainer",
+				"#SVGDescriptive",
+				"#SVGFilterPrimitive",
+				"#SVGFont",
+				"#SVGGradient",
+				"#SVGGraphics",
+				"#SVGGraphicsReferencing",
+				"#SVGLightSource",
+				"#SVGNeverRendered",
+				"#SVGNone",
+				"#SVGPaintServer",
+				"#SVGRenderable",
+				"#SVGShape",
+				"#SVGStructural",
+				"#SVGStructurallyExternal",
+				"#SVGTextContent",
+				"#SVGTextContentChild",
+				"#SVGOtherXMLNamespace"
 			]
 		},
 		"Target": {

package/src/attributes.ts

@@ -0,0 +1,140 @@
+/* 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 AttributeType =
+	| (
+			| 'String'
+			| 'NonEmptyString'
+			| 'Boolean'
+			| 'Function'
+			| 'Date'
+			| 'Int'
+			| 'Uint'
+			| 'Float'
+			| 'NonZeroUint'
+			| 'ZeroToOne'
+			| 'AcceptList'
+			| 'AutoComplete'
+			| 'BCP47'
+			| 'Color'
+			| 'ColSpan'
+			| 'Coords'
+			| 'Crossorigin'
+			| 'DateTime'
+			| 'Destination'
+			| 'DOMID'
+			| 'DOMIDList'
+			| 'IRI'
+			| 'ItemType'
+			| 'LinkSizes'
+			| 'LinkType'
+			| 'LinkTypeList'
+			| 'MediaQuery'
+			| 'MediaQueryList'
+			| 'MIMEType'
+			| 'ReferrerPolicy'
+			| 'RowSpan'
+			| 'SourceSizeList'
+			| 'SrcSet'
+			| 'TabIndex'
+			| 'Target'
+			| 'URL'
+			| 'URLHash'
+			| 'URLList'
+			| 'CSSAngle'
+			| 'CSSBlendMode'
+			| 'CSSClipPath'
+			| 'CSSCustomIdent'
+			| 'CSSDisplay'
+			| 'CSSFilter'
+			| 'CSSFontFamily'
+			| 'CSSFontSize'
+			| 'CSSFontVariant'
+			| 'CSSFontWeight'
+			| 'CSSMask'
+			| 'CSSOpacity'
+			| 'CSSTextDecoration'
+			| 'CSSTransformList'
+			| 'CSSTransformOrigin'
+			| 'CSSURL'
+			| 'SVGAnimatableValue'
+			| 'SVGBeginValueList'
+			| 'SVGClockValue'
+			| 'SVGColorMatrix'
+			| 'SVGDashArray'
+			| 'SVGEndValueList'
+			| 'SVGFilterPrimitiveReference'
+			| 'SVGKernelMatrix'
+			| 'SVGKeyPoints'
+			| 'SVGKeySplines'
+			| 'SVGKeyTimes'
+			| 'SVGLanguageTags'
+			| 'SVGLength'
+			| 'SVGLengthList'
+			| 'SVGNumberList'
+			| 'SVGNumberOptionalNumber'
+			| 'SVGOrigin'
+			| 'SVGPaint'
+			| 'SVGPathCommands'
+			| 'SVGPercentage'
+			| 'SVGPercentageList'
+			| 'SVGPoints'
+			| 'SVGPreserveAspectRatio'
+			| 'SVGViewBox'
+	  )
+	| {
+			enum: string[];
+	  };
+export type AttributeCondition =
+	| {
+			ancestor: string;
+	  }
+	| {
+			self: string | string[];
+	  };
+
+export interface AttributesSchema {
+	tag: string;
+	attributes: (
+		| (
+				| '#globalAttrs'
+				| '#ariaAttrs'
+				| '#SVGAnimationAdditionAttrs'
+				| '#SVGAnimationAttributeTargetAttrs'
+				| '#SVGAnimationEventAttrs'
+				| '#SVGAnimationTargetElementAttrs'
+				| '#SVGAnimationTimingAttrs'
+				| '#SVGAnimationValueAttrs'
+				| '#SVGConditionalProcessingAttrs'
+				| '#SVGCoreAttrs'
+				| '#SVGDocumentElementEventAttrs'
+				| '#SVGDocumentEventAttrs'
+				| '#SVGFilterPrimitiveAttrs'
+				| '#SVGGlobalEventAttrs'
+				| '#SVGGraphicalEventAttrs'
+				| '#SVGPresentationAttrs'
+				| '#SVGTransferFunctionAttrs'
+				| '#XLinkAttrs'
+		  )
+		| AttributeJSON
+		| DefineDefaultAttributeType
+	)[];
+}
+export interface AttributeJSON {
+	name: string;
+	type: AttributeType | [AttributeType, ...AttributeType[]];
+	defaultValue?: string;
+	deprecated?: boolean;
+	required?: boolean | AttributeCondition;
+	requiredEither?: string[];
+	noUse?: boolean;
+	condition?: AttributeCondition;
+}
+export interface DefineDefaultAttributeType {
+	name: string;
+	defaultValue: string;
+}

package/src/get-ns.ts

@@ -0,0 +1,13 @@
+export function getNS(namespaceURI: string) {
+	switch (namespaceURI) {
+		case 'http://www.w3.org/2000/svg': {
+			return 'svg';
+		}
+		case 'http://www.w3.org/1998/Math/MathML': {
+			return 'mml';
+		}
+		default: {
+			return 'html';
+		}
+	}
+}

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

@@ -1,4 +1,4 @@
-import { Attribute, MLDOMElementSpec, MLMLSpec, SpecOM } from './types';
+import type { Attribute, MLDOMElementSpec, MLMLSpec, SpecOM } from './types';
 
 function getSpecOM({ specs }: MLMLSpec): SpecOM {
 	const som: SpecOM = {};
@@ -18,8 +18,7 @@ function getSpecOM({ specs }: MLMLSpec): SpecOM {
 	return som;
 }
 
-export function getSpecByTagName(tagName: string, specs: MLMLSpec): MLDOMElementSpec | null {
+export function getSpecByTagName(nameWithNS: string, specs: MLMLSpec): MLDOMElementSpec | null {
 	const specOM = getSpecOM(specs);
-	tagName = tagName.toLowerCase();
-	return specOM[tagName] || null;
+	return specOM[nameWithNS] || null;
 }

package/src/get-spec.spec.ts

@@ -1,4 +1,7 @@
-import htmlSpec, { Attribute } from '@markuplint/html-spec';
+import type { Attribute } from '@markuplint/html-spec';
+
+import htmlSpec from '@markuplint/html-spec';
+
 import { getSpec } from './get-spec';
 
 describe('getSpec', () => {

package/src/get-spec.ts

@@ -1,4 +1,5 @@
-import { ElementSpec, ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
+import type { ElementSpec, ExtendedSpec, MLMLSpec } from './types';
+
 import { mergeArray } from './utils';
 
 /**
@@ -19,8 +20,11 @@ export function getSpec(schemas: readonly [MLMLSpec, ...ExtendedSpec[]]) {
 			if (extendedSpec.def['#ariaAttrs']) {
 				result.def['#ariaAttrs'] = [...result.def['#ariaAttrs'], ...extendedSpec.def['#ariaAttrs']];
 			}
-			if (extendedSpec.def['#globalAttrs']) {
-				result.def['#globalAttrs'] = [...result.def['#globalAttrs'], ...extendedSpec.def['#globalAttrs']];
+			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']];

package/src/index.ts

@@ -1,4 +1,6 @@
 export * from './permitted-structres';
+export * from './attributes';
 export * from './get-spec-by-tag-name';
 export * from './get-spec';
+export * from './get-ns';
 export * from './types';

package/src/permitted-structres.ts

@@ -24,7 +24,27 @@ export type ContentModel =
 	| '#transparent'
 	| '#embedded'
 	| '#palpable'
-	| '#script-supporting';
+	| '#script-supporting'
+	| '#SVGAnimation'
+	| '#SVGBasicShapes'
+	| '#SVGContainer'
+	| '#SVGDescriptive'
+	| '#SVGFilterPrimitive'
+	| '#SVGFont'
+	| '#SVGGradient'
+	| '#SVGGraphics'
+	| '#SVGGraphicsReferencing'
+	| '#SVGLightSource'
+	| '#SVGNeverRendered'
+	| '#SVGNone'
+	| '#SVGPaintServer'
+	| '#SVGRenderable'
+	| '#SVGShape'
+	| '#SVGStructural'
+	| '#SVGStructurallyExternal'
+	| '#SVGTextContent'
+	| '#SVGTextContentChild'
+	| '#SVGOtherXMLNamespace';
 export type PermittedContentSpec = PermittedContent[];
 
 export interface PermittedStructuresSchema {

package/src/types.ts

@@ -1,4 +1,5 @@
-import { ContentModel, PermittedStructuresSchema } from './permitted-structres';
+import type { AttributeCondition, AttributeType } from './attributes';
+import type { ContentModel, PermittedStructuresSchema } from './permitted-structres';
 
 /**
  * markuplit Markup-language spec
@@ -23,9 +24,13 @@ export type ExtendedSpec = {
 export type Cites = string[];
 
 export type SpecDefs = {
-	'#globalAttrs': Attribute[];
-	'#roles': ARIRRoleAttribute[];
+	'#globalAttrs': Partial<{
+		'#extends': Attribute[];
+		'#HTMLGlobalAttrs': Attribute[];
+		[OtherGlobalAttrs: string]: Attribute[];
+	}>;
 	'#ariaAttrs': ARIAAttribute[];
+	'#roles': ARIRRoleAttribute[];
 	'#contentModels': { [model in ContentModel]?: string[] };
 };
 
@@ -38,6 +43,12 @@ export type ElementSpec = {
 	 */
 	name: string;
 
+	/**
+	 * 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';
+
 	/**
 	 * Reference URL
 	 */
@@ -141,64 +152,19 @@ type ElementCondition = {
 
 export type Attribute = {
 	name: string;
-	type: AttributeType;
+	type: AttributeType | [AttributeType, ...AttributeType[]];
 	description: string;
 	caseSensitive?: true;
 	experimental?: true;
 	obsolete?: true;
-	deprecated?: true;
+	deprecated?: boolean;
 	nonStandard?: true;
-	required?: true | AttributeCondition;
+	required?: boolean | AttributeCondition;
 	requiredEither?: string[];
-	enum?: string[];
 	noUse?: boolean;
 	condition?: AttributeCondition;
 };
 
-export type AttributeCondition = {
-	ancestor?: string;
-	self?: string | string[];
-};
-
-// type AttributeCtegory = 'global' | 'xml' | 'aria' | 'eventhandler' | 'form' | 'particular';
-
-export type AttributeType =
-	| 'String'
-	| 'NonEmptyString'
-	| 'Boolean'
-	| 'Function' // JavaScript function body
-	| 'Date'
-	| 'Int' // Integer
-	| 'Uint' // Non-negative integer
-	| 'Float' // Floating-point number
-	| 'NonZeroUint' // Non-negative integer greater than zero
-	| 'AcceptList' // https://html.spec.whatwg.org/multipage/input.html#attr-input-accept
-	| 'AutoComplete' // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens
-	| 'BCP47' // https://tools.ietf.org/html/bcp47
-	| 'Color' // https://drafts.csswg.org/css-color/#typedef-color
-	| 'ColSpan' // https://html.spec.whatwg.org/multipage/tables.html#attr-tdth-colspan
-	| 'Coords' // https://html.spec.whatwg.org/multipage/image-maps.html#attr-area-coords
-	| 'DateTime' // https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value
-	| 'Destination' // https://html.spec.whatwg.org/multipage/semantics.html#attr-link-as
-	| 'DOMID'
-	| 'DOMIDList'
-	| 'ItemType' // https://html.spec.whatwg.org/multipage/microdata.html#attr-itemtype
-	| 'LinkSizes' // https://html.spec.whatwg.org/multipage/semantics.html#attr-link-sizes
-	| 'LinkType' // https://html.spec.whatwg.org/multipage/links.html#linkTypes
-	| 'LinkTypeList' // https://html.spec.whatwg.org/multipage/links.html#linkTypes
-	| 'MediaQuery' // https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-media-query-list
-	| 'MediaQueryList' // https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-media-query-list
-	| 'MIMEType' // https://mimesniff.spec.whatwg.org/#valid-mime-type
-	| 'ReferrerPolicy' // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#referrer-policy-attributes
-	| 'RowSpan' // https://html.spec.whatwg.org/multipage/tables.html#attr-tdth-rowspan
-	| 'SourceSizeList' // https://html.spec.whatwg.org/multipage/images.html#sizes-attributes
-	| 'SrcSet' // https://html.spec.whatwg.org/multipage/images.html#srcset-attribute
-	| 'TabIndex' // https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
-	| 'Target' // https://html.spec.whatwg.org/multipage/links.html#attr-hyperlink-target
-	| 'URL' // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#valid-url-potentially-surrounded-by-spaces
-	| 'URLHash' // https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-hash-name-reference
-	| 'URLList'; // https://html.spec.whatwg.org/multipage/urls-and-fetching.html#valid-url-potentially-surrounded-by-spaces
-
 export type ARIRRoleAttribute = {
 	name: string;
 	description: string;
@@ -227,8 +193,14 @@ export type ARIAAttribute = {
 	deprecated?: true;
 	isGlobal?: true;
 	value: ARIAAttributeValue;
+	conditionalValue?: {
+		role: string[];
+		value: ARIAAttributeValue;
+	}[];
 	enum: string[];
 	defaultValue?: string;
+	equivalentHtmlAttrs?: EquivalentHtmlAttr[];
+	valueDescriptions?: Record<string, string>;
 };
 
 export type ARIAAttributeValue =
@@ -244,6 +216,12 @@ export type ARIAAttributeValue =
 	| 'token list'
 	| 'URI';
 
+export type EquivalentHtmlAttr = {
+	htmlAttrName: string;
+	isNotStrictEquivalent?: true;
+	value: string | null;
+};
+
 export interface SpecOM {
 	[tagName: string]: MLDOMElementSpec;
 }

package/tsconfig.test.json

@@ -1,8 +1,3 @@
 {
-	"extends": "../../../tsconfig.json",
-	"compilerOptions": {
-		"composite": true
-	},
-	"include": ["./src/**/*"],
-	"exclude": ["node_modules"]
+	"extends": "../../../tsconfig.json"
 }