@markuplint/ml-spec 3.0.0-canary.5 → 3.0.0-dev.176

package/src/dom-traverse/may-be-focusable.ts

@@ -1,21 +0,0 @@
-import type { MLMLSpec } from '../types';
-
-import { getSelectorsByContentModelCategory } from '../specs/get-selectors-by-content-model-category';
-
-export function mayBeFocusable(el: Element, specs: Readonly<MLMLSpec>): boolean {
-	return [
-		/**
-		 * Interactive content
-		 *
-		 * @see  https://html.spec.whatwg.org/multipage/dom.html#interactive-content
-		 */
-		...getSelectorsByContentModelCategory(specs, '#interactive'),
-		/**
-		 * Interaction
-		 *
-		 * @see  https://html.spec.whatwg.org/multipage/interaction.html
-		 */
-		'[tabindex]',
-		'[contenteditable]:not([contenteditable="false" i])',
-	].some(selector => el.matches(selector));
-}

package/src/index.ts

@@ -1,23 +0,0 @@
-export * from './dom-traverse/accname-computation';
-export * from './dom-traverse/get-attr-specs';
-export * from './dom-traverse/get-computed-aria-props';
-export * from './dom-traverse/get-computed-role';
-export * from './dom-traverse/get-content-model';
-export * from './dom-traverse/get-implicit-role';
-export * from './dom-traverse/get-permitted-roles';
-export * from './dom-traverse/get-spec';
-export * from './dom-traverse/has-required-owned-elements';
-export * from './dom-traverse/is-exposed';
-export * from './dom-traverse/may-be-focusable';
-export * from './specs/aria-specs';
-export * from './specs/content-model-category-to-tag-names';
-export * from './specs/get-role-spec';
-export * from './specs/get-spec-by-tag-name';
-export * from './specs/is-palpable-elements';
-export * from './specs/is-void-element';
-export * from './specs/schema-to-spec';
-export * from './types';
-export * from './types/aria';
-export * from './types/attributes';
-export * from './types/permitted-structures';
-export * from './utils/resolve-namespace';

package/src/specs/aria-specs.ts

@@ -1,6 +0,0 @@
-import type { ARIAVersion, MLMLSpec } from '../types';
-
-export function ariaSpecs(specs: Readonly<MLMLSpec>, version: ARIAVersion) {
-	const aria = specs.def['#aria'];
-	return aria[version];
-}

package/src/specs/content-model-category-to-tag-names.ts

@@ -1,15 +0,0 @@
-import type { MLMLSpec } from '../types';
-import type { Category } from '../types/permitted-structures';
-
-const cache = new Map<Category, ReadonlyArray<string>>();
-
-export function contentModelCategoryToTagNames(contentModel: Category, def: MLMLSpec['def']): ReadonlyArray<string> {
-	const cached = cache.get(contentModel);
-	if (cached) {
-		return cached;
-	}
-	const tags: string[] | undefined = def['#contentModels'][contentModel];
-	const sortedTag = Object.freeze(tags && Array.isArray(tags) ? tags.sort() : []);
-	cache.set(contentModel, sortedTag);
-	return sortedTag;
-}

package/src/specs/get-aria.ts

@@ -1,85 +0,0 @@
-import type { ARIAVersion, Matches, MLMLSpec } from '../types';
-import type { ARIA, PermittedRoles } from '../types/aria';
-
-import { getSpecByTagName } from './get-spec-by-tag-name';
-import { resolveVersion } from './resolve-version';
-
-const cache = new Map<string, Omit<ARIA, ARIAVersion> | null>();
-
-export function getARIA(
-	specs: Readonly<MLMLSpec>,
-	localName: string,
-	namespace: string | null,
-	version: ARIAVersion,
-	matches: Matches,
-): Omit<ARIA, ARIAVersion | 'conditions'> | null {
-	const aria = getVersionResolvedARIA(specs, localName, namespace, version);
-	if (!aria) {
-		return null;
-	}
-	const conditions = aria.conditions;
-	if (!conditions) {
-		return aria;
-	}
-	const conditionKeys = Object.keys(conditions);
-	let { implicitRole, permittedRoles, implicitProperties, properties, namingProhibited } = aria;
-	for (const cond of conditionKeys) {
-		if (!matches(cond)) {
-			continue;
-		}
-		const condARIA = conditions[cond];
-		implicitRole = condARIA.implicitRole ?? implicitRole;
-		permittedRoles = condARIA.permittedRoles ?? permittedRoles;
-		implicitProperties = condARIA.implicitProperties ?? implicitProperties;
-		properties = condARIA.properties ?? properties;
-		namingProhibited = condARIA.namingProhibited ?? namingProhibited;
-	}
-	return {
-		implicitRole,
-		permittedRoles,
-		implicitProperties,
-		properties,
-		namingProhibited,
-	};
-}
-
-function getVersionResolvedARIA(
-	specs: Readonly<MLMLSpec>,
-	localName: string,
-	namespace: string | null,
-	version: ARIAVersion,
-) {
-	const key = localName + namespace + version;
-	let aria = cache.get(key);
-	if (aria !== undefined) {
-		return aria;
-	}
-	const spec = getSpecByTagName(specs.specs, localName, namespace)?.aria;
-	if (!spec) {
-		cache.set(key, null);
-		return null;
-	}
-	aria = resolveVersion(spec, version);
-	if (aria.permittedRoles) {
-		aria.permittedRoles = optimizePermittedRoles(aria.permittedRoles);
-	}
-	cache.set(key, aria);
-	return aria;
-}
-
-function optimizePermittedRoles(permittedRoles: PermittedRoles) {
-	if (!Array.isArray(permittedRoles)) {
-		return permittedRoles;
-	}
-	const unique = new Set(permittedRoles);
-
-	// https://www.w3.org/TR/wai-aria-1.2/#note-regarding-the-aria-1-1-none-role
-	if (unique.has('presentation')) {
-		unique.add('none');
-	}
-	if (unique.has('none')) {
-		unique.add('presentation');
-	}
-
-	return Array.from(unique).sort();
-}

package/src/specs/get-attr-specs.ts

@@ -1,116 +0,0 @@
-import type { MLMLSpec, Attribute } from '../types';
-import type { NamespaceURI } from '@markuplint/ml-ast';
-
-import { resolveNamespace } from '../utils/resolve-namespace';
-
-const cacheMap = new Map<string, Attribute[] | null>();
-const schemaCache = new WeakSet<MLMLSpec>();
-
-export function getAttrSpecs(localName: string, namespace: NamespaceURI | null, schema: MLMLSpec) {
-	if (!schemaCache.has(schema)) {
-		cacheMap.clear();
-	}
-
-	const { localNameWithNS } = resolveNamespace(localName, namespace || undefined);
-
-	const cache = cacheMap.get(localNameWithNS);
-
-	if (cache !== undefined) {
-		return cache;
-	}
-
-	schemaCache.add(schema);
-
-	const elSpec = schema.specs.find(spec => spec.name === localNameWithNS);
-	if (!elSpec) {
-		cacheMap.set(localNameWithNS, null);
-		return null;
-	}
-
-	const globalAttrs = schema.def['#globalAttrs'];
-	let attrs: Record<string, Partial<Attribute>> = {};
-
-	for (const catName in elSpec.globalAttrs) {
-		// @ts-ignore
-		const catAttrs: boolean | string[] = elSpec.globalAttrs[catName];
-		if (!catAttrs) {
-			continue;
-		}
-		if (typeof catAttrs === 'boolean') {
-			const global = globalAttrs[catName];
-			attrs = {
-				...attrs,
-				...global,
-			};
-			continue;
-		}
-		if (Array.isArray(catAttrs)) {
-			const global = globalAttrs[catName];
-			if (!global) {
-				continue;
-			}
-			catAttrs.forEach(selectedName => {
-				const selected = global[selectedName];
-				attrs[selectedName] = {
-					...attrs[selectedName],
-					...selected,
-				};
-			});
-			continue;
-		}
-	}
-
-	for (const attrName in elSpec.attributes) {
-		const attr = elSpec.attributes[attrName];
-		if (!attr) {
-			continue;
-		}
-
-		const current = attrs[attrName] as Omit<Attribute, 'name'> | undefined;
-
-		attrs[attrName] = {
-			description: '',
-			...current,
-			...attr,
-		};
-	}
-
-	const attrList: Attribute[] = Object.keys(attrs).map<Attribute>(name => {
-		const attr = attrs[name];
-		return { name, type: 'Any', ...attr };
-	});
-
-	for (const attr of attrList) {
-		if (!attr.type) {
-			throw new Error(
-				`The type is empty in the ${attr.name} attribute of the ${localName} element,
-					'packages',
-					'@markuplint',
-					'html-spec',
-					'src',
-					'attributes',
-					nameWithNS.replace(':', '_') + '.json',
-				)})`,
-			);
-		}
-	}
-
-	attrList.sort(nameCompare);
-
-	cacheMap.set(localNameWithNS, attrList);
-	return attrList;
-}
-
-type HasName = { name: string };
-
-export function nameCompare(a: HasName | string, b: HasName | string) {
-	const nameA = typeof a === 'string' ? a : a.name.toUpperCase();
-	const nameB = typeof b === 'string' ? b : b.name.toUpperCase();
-	if (nameA < nameB) {
-		return -1;
-	}
-	if (nameA > nameB) {
-		return 1;
-	}
-	return 0;
-}

package/src/specs/get-implicit-role.ts

@@ -1,17 +0,0 @@
-import type { ARIAVersion, Matches, MLMLSpec } from '../types';
-
-import { getARIA } from './get-aria';
-
-export function getImplicitRole(
-	specs: Readonly<MLMLSpec>,
-	localName: string,
-	namespace: string | null,
-	version: ARIAVersion,
-	matches: Matches,
-) {
-	const aria = getARIA(specs, localName, namespace, version, matches);
-	if (!aria) {
-		return false;
-	}
-	return aria.implicitRole;
-}

package/src/specs/get-permitted-roles.ts

@@ -1,87 +0,0 @@
-import type { ARIAVersion, Matches, MLMLSpec } from '../types';
-
-import { mergeArray } from '../utils/merge-array';
-
-import { ariaSpecs } from './aria-specs';
-import { getARIA } from './get-aria';
-
-/**
- * Getting permitted ARIA roles.
- *
- * - If an array, it is role list.
- * - If `true`, this mean is "Any".
- * - If `false`, this mean is "No".
- */
-export function getPermittedRoles(
-	specs: Readonly<MLMLSpec>,
-	localName: string,
-	namespace: string | null,
-	version: ARIAVersion,
-	matches: Matches,
-): { name: string; deprecated?: boolean }[] {
-	const aria = getARIA(specs, localName, namespace, version, matches);
-	if (!aria) {
-		return [];
-	}
-	const { implicitRole, permittedRoles } = aria;
-	const { roles, graphicsRoles } = ariaSpecs(specs, version);
-
-	let permittedRoleList: { name: string }[] = [];
-
-	if (permittedRoles === true) {
-		permittedRoleList = mergeArray(
-			permittedRoleList,
-			roles
-				.filter(role => !role.isAbstract)
-				.map(role => ({
-					name: role.name,
-				})),
-		);
-	}
-
-	if (Array.isArray(permittedRoles)) {
-		permittedRoleList = mergeArray(
-			permittedRoleList,
-			permittedRoles.map(role => {
-				if (typeof role === 'string') {
-					return {
-						name: role,
-					};
-				}
-				return role;
-			}),
-		);
-	} else if (!(typeof permittedRoles === 'boolean')) {
-		if (permittedRoles['core-aam']) {
-			permittedRoleList = mergeArray(
-				permittedRoleList,
-				roles
-					.filter(role => !role.isAbstract)
-					.map(role => ({
-						name: role.name,
-					})),
-			);
-		}
-		if (permittedRoles['graphics-aam']) {
-			permittedRoleList = mergeArray(
-				permittedRoleList,
-				graphicsRoles
-					.filter(role => !role.isAbstract)
-					.map(role => ({
-						name: role.name,
-					})),
-			);
-		}
-	}
-
-	if (implicitRole) {
-		const implicitRoles =
-			implicitRole === 'presentation' || implicitRole === 'none' ? ['none', 'presentation'] : [implicitRole];
-		return mergeArray(
-			implicitRoles.map(r => ({ name: r })),
-			permittedRoleList,
-		);
-	}
-
-	return permittedRoleList;
-}

package/src/specs/get-role-spec.ts

@@ -1,72 +0,0 @@
-import type { ARIAVersion, ARIARoleInSchema, MLMLSpec, ARIARole } from '../types';
-import type { NamespaceURI } from '@markuplint/ml-ast';
-
-import { ariaSpecs } from './aria-specs';
-
-export function getRoleSpec(
-	specs: Readonly<MLMLSpec>,
-	roleName: string,
-	namespace: NamespaceURI,
-	version: ARIAVersion,
-): (ARIARole & { superClassRoles: ARIARoleInSchema[] }) | null {
-	const role = getRoleByName(specs, roleName, namespace, version);
-	if (!role) {
-		return null;
-	}
-	const superClassRoles = recursiveTraverseSuperClassRoles(specs, roleName, namespace, version);
-	return {
-		name: role.name,
-		isAbstract: !!role.isAbstract,
-		requiredContextRole: role.requiredContextRole ?? [],
-		requiredOwnedElements: role.requiredOwnedElements ?? [],
-		accessibleNameRequired: !!role.accessibleNameRequired,
-		accessibleNameFromAuthor: !!role.accessibleNameFromAuthor,
-		accessibleNameFromContent: !!role.accessibleNameFromContent,
-		accessibleNameProhibited: !!role.accessibleNameProhibited,
-		childrenPresentational: !!role.childrenPresentational,
-		ownedProperties: role.ownedProperties ?? [],
-		prohibitedProperties: role.prohibitedProperties ?? [],
-		superClassRoles,
-	};
-}
-
-function recursiveTraverseSuperClassRoles(
-	specs: Readonly<MLMLSpec>,
-	roleName: string,
-	namespace: NamespaceURI,
-	version: ARIAVersion,
-) {
-	const roles: ARIARoleInSchema[] = [];
-	const superClassRoles = getSuperClassRoles(specs, roleName, namespace, version);
-	if (superClassRoles) {
-		roles.push(...superClassRoles);
-		for (const superClassRole of superClassRoles) {
-			const ancestorRoles = recursiveTraverseSuperClassRoles(specs, superClassRole.name, namespace, version);
-			roles.push(...ancestorRoles);
-		}
-	}
-	return roles;
-}
-
-function getSuperClassRoles(
-	specs: Readonly<MLMLSpec>,
-	roleName: string,
-	namespace: NamespaceURI,
-	version: ARIAVersion,
-) {
-	const role = getRoleByName(specs, roleName, namespace, version);
-	return (
-		role?.generalization
-			?.map(roleName => getRoleByName(specs, roleName, namespace, version))
-			.filter((role): role is ARIARoleInSchema => !!role) || null
-	);
-}
-
-function getRoleByName(specs: Readonly<MLMLSpec>, roleName: string, namespace: NamespaceURI, version: ARIAVersion) {
-	const { roles, graphicsRoles } = ariaSpecs(specs, version);
-	let role = roles.find(r => r.name === roleName);
-	if (!role && namespace === 'http://www.w3.org/2000/svg') {
-		role = graphicsRoles.find(r => r.name === roleName);
-	}
-	return role;
-}

package/src/specs/get-selectors-by-content-model-category.ts

@@ -1,10 +0,0 @@
-import type { MLMLSpec } from '../types';
-import type { Category } from '../types/permitted-structures';
-
-export function getSelectorsByContentModelCategory(
-	specs: Readonly<MLMLSpec>,
-	category: Category,
-): ReadonlyArray<string> {
-	const selectors = specs.def['#contentModels'][category];
-	return selectors || [];
-}

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

@@ -1,20 +0,0 @@
-import type { ElementSpec } from '../types';
-
-import { resolveNamespace } from '../utils/resolve-namespace';
-
-const cache = new Map<string, any>();
-
-export function getSpecByTagName<K extends keyof ElementSpec = keyof ElementSpec>(
-	specs: Readonly<Pick<ElementSpec, 'name' | K>[]>,
-	localName: string,
-	namespace: string | null,
-) {
-	const { localNameWithNS } = resolveNamespace(localName, namespace || undefined);
-	let spec: Pick<ElementSpec, 'name' | K> | null | undefined = cache.get(localNameWithNS);
-	if (spec !== undefined) {
-		return spec;
-	}
-	spec = specs.find(spec => spec.name === localNameWithNS) || null;
-	cache.set(localNameWithNS, spec);
-	return spec;
-}

package/src/specs/is-palpable-elements.ts

@@ -1,55 +0,0 @@
-import type { MLMLSpec } from '../types';
-
-/**
- * Exposable content models and elements
- *
- * **WARNING**:
- * This implementation is through the author's interpretation.
- * Want a issue request.
- * https://github.com/markuplint/markuplint/issues/new
- *
- * @see https://html.spec.whatwg.org/multipage/indices.html#elements-3
- */
-const exposableElementsThatAreNoBelongingAModel: string[] = [
-	'body',
-	'dd',
-	'dt',
-	'figcaption',
-	'html',
-	'legend',
-	'li',
-	'optgroup',
-	'option',
-	'rp',
-	'rt',
-	'summary',
-	'tbody',
-	'td',
-	'tfoot',
-	'th',
-	'thead',
-	'tr',
-];
-
-export function isPalpableElement(
-	el: Element,
-	specs: Readonly<MLMLSpec>,
-	options?: {
-		extendsSvg?: boolean;
-		extendsExposableElements?: boolean;
-	},
-) {
-	const conditions = [specs.def['#contentModels']['#palpable']?.join(',') || ''];
-
-	if (options?.extendsSvg !== false /* default true */) {
-		conditions.push(specs.def['#contentModels']['#SVGRenderable']?.join(',') || '');
-	}
-
-	if (options?.extendsExposableElements /* default false */) {
-		conditions.push(exposableElementsThatAreNoBelongingAModel.join(','));
-	}
-
-	return conditions.some(condition => {
-		return el.matches(condition);
-	});
-}

package/src/specs/is-presentational.ts

@@ -1,6 +0,0 @@
-export function isPresentational(roleName?: string) {
-	if (!roleName) {
-		return false;
-	}
-	return ['presentation', 'none'].includes(roleName);
-}

package/src/specs/is-void-element.ts

@@ -1,22 +0,0 @@
-/**
- * @see https://html.spec.whatwg.org/multipage/syntax.html#void-elements
- */
-const voidElements = [
-	'area',
-	'base',
-	'br',
-	'col',
-	'embed',
-	'hr',
-	'img',
-	'input',
-	'link',
-	'meta',
-	'source',
-	'track',
-	'wbr',
-];
-
-export function isVoidElement(el: Element) {
-	return voidElements.includes(el.localName);
-}

package/src/specs/resolve-version.ts

@@ -1,20 +0,0 @@
-import type { ARIAVersion } from '../types';
-import type { ARIA } from '../types/aria';
-
-export function resolveVersion(aria: ARIA, version: ARIAVersion): Omit<ARIA, ARIAVersion> {
-	const implicitRole = aria[version]?.implicitRole ?? aria.implicitRole;
-	const permittedRoles = aria[version]?.permittedRoles ?? aria.permittedRoles;
-	const implicitProperties = aria[version]?.implicitProperties ?? aria.implicitProperties;
-	const properties = aria[version]?.properties ?? aria.properties;
-	const namingProhibited =
-		version === '1.2' ? aria[version]?.namingProhibited ?? aria.namingProhibited : aria.namingProhibited;
-	const conditions = aria[version]?.conditions ?? aria.conditions;
-	return {
-		implicitRole,
-		permittedRoles,
-		implicitProperties,
-		properties,
-		namingProhibited,
-		conditions,
-	};
-}

package/src/specs/schema-to-spec.spec.ts

@@ -1,39 +0,0 @@
-import htmlSpec from '@markuplint/html-spec';
-
-import { schemaToSpec } from './schema-to-spec';
-
-describe('getSpec', () => {
-	test('Overriding', () => {
-		const exAttr = {
-			ref: 'N/A',
-			type: 'Boolean',
-			description: 'For the unit test.',
-		} as const;
-		const exAttr2 = {
-			ref: 'N/A',
-			type: 'Boolean',
-			description: 'For the unit test. Override.',
-		} as const;
-		const mergedSpec = schemaToSpec([
-			htmlSpec,
-			{
-				specs: [
-					{
-						name: 'a',
-						attributes: { 'extended-attr': exAttr },
-					},
-				],
-			},
-			{
-				specs: [
-					{
-						name: 'a',
-						attributes: { 'extended-attr': exAttr2 },
-					},
-				],
-			},
-		]);
-		const aElAttrs = mergedSpec.specs.find(el => el.name === 'a')!.attributes;
-		expect(aElAttrs['extended-attr']).toStrictEqual(exAttr2);
-	});
-});