@markuplint/ml-spec 3.0.0-alpha.82 → 3.0.0-dev.24

package/src/types/index.ts

@@ -1,10 +1,10 @@
 import type { ARIA } from './aria';
 import type { AttributeJSON, AttributeType, GlobalAttributes } from './attributes';
-import type { ContentModel, Category } from './permitted-structres';
+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;
@@ -97,7 +97,7 @@ export type ElementSpec = {
 	nonStandard?: true;
 
 	/**
-	 * Element cateogries
+	 * Element categories
 	 */
 	categories: Category[];
 
@@ -107,9 +107,9 @@ export type ElementSpec = {
 	contentModel: ContentModel;
 
 	/**
-	 * Tag omittion
+	 * Tag omission
 	 */
-	omittion: ElementSpecOmittion;
+	omission: ElementSpecOmission;
 
 	/**
 	 * Global Attributes
@@ -122,7 +122,7 @@ export type ElementSpec = {
 	attributes: Record<string, Attribute>;
 
 	/**
-	 * WAI-ARIA role and properies
+	 * WAI-ARIA role and properties
 	 */
 	aria: ARIA;
 
@@ -137,9 +137,9 @@ export type ElementSpec = {
 	possibleToAddProperties?: true;
 };
 
-type ElementSpecOmittion = false | ElementSpecOmittionTags;
+type ElementSpecOmission = false | ElementSpecOmissionTags;
 
-type ElementSpecOmittionTags = {
+type ElementSpecOmissionTags = {
 	startTag: boolean | ElementCondition;
 	endTag: boolean | ElementCondition;
 };

package/src/types/permitted-structres.ts

@@ -5,14 +5,14 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type PermittedContent =
+export type PermittedContentPattern =
 	| PermittedContentRequire
 	| PermittedContentOptional
 	| PermittedContentOneOrMore
 	| PermittedContentZeroOrMore
 	| PermittedContentChoice
-	| PermittedContentInterleave;
-export type Target = ContentType | ContentType[];
+	| PermittedContentTransparent;
+export type Model = ContentType | ContentType[];
 export type ContentType = string | Category;
 export type Category =
 	| '#text'
@@ -22,7 +22,6 @@ export type Category =
 	| '#heading'
 	| '#sectioning'
 	| '#metadata'
-	| '#transparent'
 	| '#embedded'
 	| '#palpable'
 	| '#script-supporting'
@@ -44,65 +43,58 @@ export type Category =
 	| '#SVGStructural'
 	| '#SVGStructurallyExternal'
 	| '#SVGTextContent'
-	| '#SVGTextContentChild'
-	| '#SVGOtherXMLNamespace';
-export type PermittedContentSpec = PermittedContent[];
+	| '#SVGTextContentChild';
 
 export interface ContentModelsSchema {
 	__contentModel?: ContentModel;
 }
 export interface ContentModel {
-	contents: PermittedContentSpec | boolean;
+	contents: PermittedContentPattern[] | boolean;
 	descendantOf?: string;
 	conditional?: {
 		condition: string;
-		contents: PermittedContentSpec | boolean;
+		contents: PermittedContentPattern[] | boolean;
 	}[];
 }
 export interface PermittedContentRequire {
-	require: Target;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	require: Model;
 	max?: number;
 	min?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentOptional {
-	optional: Target;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	optional: Model;
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentOneOrMore {
-	oneOrMore: Target | PermittedContentSpec;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	oneOrMore: Model | PermittedContentPattern[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentZeroOrMore {
-	zeroOrMore: Target | PermittedContentSpec;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	zeroOrMore: Model | PermittedContentPattern[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentChoice {
+	/**
+	 * @minItems 2
+	 * @maxItems 5
+	 */
 	choice:
-		| [PermittedContentSpec, PermittedContentSpec]
-		| [PermittedContentSpec, PermittedContentSpec, PermittedContentSpec]
-		| [PermittedContentSpec, PermittedContentSpec, PermittedContentSpec, PermittedContentSpec]
+		| [PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
 		| [
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
 		  ];
 	_TODO_?: string;
 }
-export interface PermittedContentInterleave {
-	interleave: [PermittedContentSpec, PermittedContentSpec, ...PermittedContentSpec[]];
-	_TODO_?: string;
+export interface PermittedContentTransparent {
+	transparent: string;
 }

package/src/types/permitted-structures.ts

@@ -0,0 +1,96 @@
+/* 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';
+
+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 {
+	choice:
+		| [PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+		  ];
+	_TODO_?: string;
+}
+export interface PermittedContentTransparent {
+	transparent: string;
+}

package/src/utils/get-ns.ts

@@ -1,4 +1,6 @@
-export function getNS(namespaceURI: string | null) {
+import type { Namespace } from '@markuplint/ml-ast';
+
+export function getNS(namespaceURI: string | null): Namespace {
 	switch (namespaceURI) {
 		case 'http://www.w3.org/2000/svg': {
 			return 'svg';
@@ -6,6 +8,9 @@ export function getNS(namespaceURI: string | null) {
 		case 'http://www.w3.org/1998/Math/MathML': {
 			return 'mml';
 		}
+		case 'http://www.w3.org/1999/xlink': {
+			return 'xlink';
+		}
 		default: {
 			return 'html';
 		}

package/src/utils/resolve-namespace.spec.ts

@@ -0,0 +1,37 @@
+import { resolveNamespace } from './resolve-namespace';
+
+test('tag', () => {
+	expect(resolveNamespace('a')).toStrictEqual({
+		localName: 'a',
+		localNameWithNS: 'a',
+		namespace: 'html',
+		namespaceURI: 'http://www.w3.org/1999/xhtml',
+	});
+	expect(resolveNamespace('svg:a')).toStrictEqual({
+		localName: 'a',
+		localNameWithNS: 'svg:a',
+		namespace: 'svg',
+		namespaceURI: 'http://www.w3.org/2000/svg',
+	});
+});
+
+test('attr', () => {
+	expect(resolveNamespace('href', 'http://www.w3.org/1999/xhtml')).toStrictEqual({
+		localName: 'href',
+		localNameWithNS: 'href',
+		namespace: 'html',
+		namespaceURI: 'http://www.w3.org/1999/xhtml',
+	});
+	expect(resolveNamespace('href', 'http://www.w3.org/2000/svg')).toStrictEqual({
+		localName: 'href',
+		localNameWithNS: 'svg:href',
+		namespace: 'svg',
+		namespaceURI: 'http://www.w3.org/2000/svg',
+	});
+	expect(resolveNamespace('xlink:href', 'http://www.w3.org/2000/svg')).toStrictEqual({
+		localName: 'href',
+		localNameWithNS: 'xlink:href',
+		namespace: 'xlink',
+		namespaceURI: 'http://www.w3.org/1999/xlink',
+	});
+});

package/src/utils/resolve-namespace.ts

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