@markuplint/ml-spec 3.0.0-dev.25 → 3.0.0-dev.38

package/src/types/index.ts

@@ -1,255 +0,0 @@
-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';
-
-/**
- * markuplint Markup-language spec
- */
-export interface MLMLSpec {
-	cites: Cites;
-	def: SpecDefs;
-	specs: ElementSpec[];
-}
-
-export type ExtendedElementSpec = Partial<Omit<ElementSpec, 'name' | 'attributes'>> & {
-	name: ElementSpec['name'];
-	attributes?: Record<string, Partial<Attribute>>;
-};
-
-export type ExtendedSpec = {
-	cites?: Cites;
-	def?: Partial<SpecDefs>;
-	specs?: ExtendedElementSpec[];
-};
-
-/**
- * Reference URLs
- */
-export type Cites = string[];
-
-export type SpecDefs = {
-	'#globalAttrs': Partial<{
-		'#extends': Record<string, Partial<Attribute>>;
-		'#HTMLGlobalAttrs': Record<string, Partial<Attribute>>;
-		[OtherGlobalAttrs: string]: Record<string, Partial<Attribute>>;
-	}>;
-	'#aria': {
-		'1.2': ARIASpec;
-		'1.1': ARIASpec;
-	};
-	'#contentModels': { [model in Category]?: string[] };
-};
-
-type ARIASpec = {
-	roles: ARIARoleInSchema[];
-	graphicsRoles: ARIARoleInSchema[];
-	props: ARIAProperty[];
-};
-
-/**
- * Element spec
- */
-export type ElementSpec = {
-	/**
-	 * Tag name
-	 */
-	name: string;
-
-	/**
-	 * Namespaces in XML
-	 * @see https://www.w3.org/TR/xml-names/
-	 */
-	namespace?: NamespaceURI;
-
-	/**
-	 * Reference URL
-	 */
-	cite: string;
-
-	/**
-	 * Description
-	 */
-	description?: string;
-
-	/**
-	 * Experimental technology
-	 */
-	experimental?: true;
-
-	/**
-	 * Obsolete or alternative elements
-	 */
-	obsolete?:
-		| true
-		| {
-				alt: string;
-		  };
-
-	/**
-	 * Deprecated
-	 */
-	deprecated?: true;
-
-	/**
-	 * Non-standard
-	 */
-	nonStandard?: true;
-
-	/**
-	 * Element categories
-	 */
-	categories: Category[];
-
-	/**
-	 * Permitted contents and permitted parents
-	 */
-	contentModel: ContentModel;
-
-	/**
-	 * Tag omission
-	 */
-	omission: ElementSpecOmission;
-
-	/**
-	 * Global Attributes
-	 */
-	globalAttrs: GlobalAttributes;
-
-	/**
-	 * Attributes
-	 */
-	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.
-	 *
-	 * @see https://v2.vuejs.org/v2/guide/components-slots.html#Scoped-Slots
-	 *
-	 * **It assumes to specify it on the parser plugin.**
-	 */
-	possibleToAddProperties?: true;
-};
-
-type ElementSpecOmission = false | ElementSpecOmissionTags;
-
-type ElementSpecOmissionTags = {
-	startTag: boolean | ElementCondition;
-	endTag: boolean | ElementCondition;
-};
-
-type ElementCondition = {
-	__WIP__: 'WORK_IN_PROGRESS';
-};
-
-export type Attribute = {
-	name: string;
-	type: AttributeType | AttributeType[];
-	description?: string;
-	caseSensitive?: true;
-	experimental?: boolean;
-	obsolete?: true;
-	deprecated?: boolean;
-	nonStandard?: true;
-} & ExtendableAttributeSpec;
-
-type ExtendableAttributeSpec = Omit<AttributeJSON, 'type'>;
-
-export type ARIARole = {
-	name: string;
-	isAbstract: boolean;
-	requiredContextRole: string[];
-	requiredOwnedElements: string[];
-	accessibleNameRequired: boolean;
-	accessibleNameFromAuthor: boolean;
-	accessibleNameFromContent: boolean;
-	accessibleNameProhibited: boolean;
-	childrenPresentational: boolean;
-	ownedProperties: ARIARoleOwnedProperties[];
-	prohibitedProperties: string[];
-};
-
-export type ARIARoleInSchema = Partial<
-	ARIARole & {
-		description: string;
-		generalization: string[];
-	}
-> & {
-	name: string;
-};
-
-export type ARIARoleOwnedProperties = {
-	name: string;
-	inherited?: true;
-	required?: true;
-	deprecated?: true;
-};
-
-export type ARIAProperty = {
-	name: string;
-	type: 'property' | 'state';
-	deprecated?: true;
-	isGlobal?: true;
-	value: ARIAAttributeValue;
-	conditionalValue?: {
-		role: string[];
-		value: ARIAAttributeValue;
-	}[];
-	enum: string[];
-	defaultValue?: string;
-	equivalentHtmlAttrs?: EquivalentHtmlAttr[];
-	valueDescriptions?: Record<string, string>;
-};
-
-export type ARIAAttributeValue =
-	| 'true/false'
-	| 'tristate'
-	| 'true/false/undefined'
-	| 'ID reference'
-	| 'ID reference list'
-	| 'integer'
-	| 'number'
-	| 'string'
-	| 'token'
-	| 'token list'
-	| 'URI';
-
-export type ARIAVersion = '1.1' | '1.2';
-
-export type EquivalentHtmlAttr = {
-	htmlAttrName: string;
-	isNotStrictEquivalent?: true;
-	value: string | null;
-};
-
-export type Matches = (selector: string) => boolean;
-
-export type ComputedRole = {
-	el: Element;
-	role:
-		| (ARIARole & {
-				superClassRoles: ARIARoleInSchema[];
-				isImplicit?: boolean;
-		  })
-		| null;
-	errorType?: RoleComputationError;
-};
-
-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

@@ -1,100 +0,0 @@
-/* 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 {
-	/**
-	 * @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;
-}

package/src/types/permitted-structures.ts

@@ -1,96 +0,0 @@
-/* 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,18 +0,0 @@
-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';
-		}
-		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/merge-array.ts

@@ -1,35 +0,0 @@
-type NamedDefinition = string | { name: string };
-
-export function mergeArray<T extends NamedDefinition>(a: T[], b: T[] | null | undefined): T[] {
-	if (!b) {
-		return a;
-	}
-	const result: T[] = a.slice();
-	for (const bItem of b) {
-		const bName = getName(bItem);
-		const aIndex = result.findIndex(item => getName(item) === bName);
-		if (aIndex === -1) {
-			result.push(bItem);
-			continue;
-		}
-		const aItem = result.splice(aIndex, 1)[0];
-		if (typeof bItem === 'string') {
-			continue;
-		}
-		if (typeof aItem === 'string') {
-			result.push(bItem);
-			continue;
-		}
-		const exItem = {
-			...(aItem as { name: string }),
-			...(bItem as { name: string }),
-		};
-		result.push(exItem as T);
-	}
-	return result;
-}
-
-function getName(def: NamedDefinition): string {
-	const result = typeof def === 'string' ? def : def.name;
-	return result.toLowerCase().trim();
-}

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

@@ -1,37 +0,0 @@
-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,40 +0,0 @@
-import type { NamespaceURI, Namespace } from '@markuplint/ml-ast';
-
-import { getNS } from './get-ns';
-
-const cache = new Map<string, NamespacedElementName>();
-
-type NamespacedElementName = {
-	localNameWithNS: string;
-	localName: string;
-	namespace: Namespace;
-	namespaceURI: 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 [_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: `${namespace === 'html' ? '' : `${namespace}:`}${localName}`,
-		localName,
-		namespace,
-		namespaceURI: namespaceURIMap[namespace],
-	};
-	cache.set(name + namespaceURI, result);
-	return result;
-}

package/tsconfig.test.json

@@ -1,3 +0,0 @@
-{
-	"extends": "../../../tsconfig.json"
-}