@markuplint/ml-spec 3.14.0 → 4.0.0-alpha.10

package/lib/types/attributes.js

@@ -1,7 +1,6 @@
-"use strict";
 /**
  * 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.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/types/index.d.ts

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

package/lib/types/index.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/types/permitted-structures.d.ts

@@ -3,95 +3,56 @@
  * 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 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 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;
+    __contentModel?: ContentModel;
 }
 export interface ContentModel {
-	contents: PermittedContentPattern[] | boolean;
-	descendantOf?: string;
-	conditional?: {
-		condition: string;
-		contents: PermittedContentPattern[] | boolean;
-	}[];
+    contents: PermittedContentPattern[] | boolean;
+    descendantOf?: string;
+    conditional?: {
+        condition: string;
+        contents: PermittedContentPattern[] | boolean;
+    }[];
 }
 export interface PermittedContentRequire {
-	require: Model | PermittedContentPattern[];
-	max?: number;
-	min?: number;
-	_TODO_?: string;
+    require: Model | PermittedContentPattern[];
+    max?: number;
+    min?: number;
+    _TODO_?: string;
 }
 export interface PermittedContentOptional {
-	optional: Model | PermittedContentPattern[];
-	max?: number;
-	_TODO_?: string;
+    optional: Model | PermittedContentPattern[];
+    max?: number;
+    _TODO_?: string;
 }
 export interface PermittedContentOneOrMore {
-	oneOrMore: Model | PermittedContentPattern[];
-	max?: number;
-	_TODO_?: string;
+    oneOrMore: Model | PermittedContentPattern[];
+    max?: number;
+    _TODO_?: string;
 }
 export interface PermittedContentZeroOrMore {
-	zeroOrMore: Model | PermittedContentPattern[];
-	max?: number;
-	_TODO_?: string;
+    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;
+    /**
+     * @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;
+    transparent: string;
 }

package/lib/types/permitted-structures.js

@@ -1,7 +1,6 @@
-"use strict";
 /**
  * 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.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/utils/get-ns.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNS = void 0;
-function getNS(namespaceURI) {
+export function getNS(namespaceURI) {
     switch (namespaceURI) {
         case 'http://www.w3.org/2000/svg': {
             return 'svg';
@@ -17,4 +14,3 @@ function getNS(namespaceURI) {
         }
     }
 }
-exports.getNS = getNS;

package/lib/utils/merge-array.d.ts

@@ -1,10 +1,5 @@
-type NamedDefinition =
-	| string
-	| {
-			readonly name: string;
-	  };
-export declare function mergeArray<T extends NamedDefinition>(
-	a: readonly T[],
-	b: readonly T[] | null | undefined,
-): readonly T[];
+type NamedDefinition = string | {
+    readonly name: string;
+};
+export declare function mergeArray<T extends NamedDefinition>(a: readonly T[], b: readonly T[] | null | undefined): readonly T[];
 export {};

package/lib/utils/merge-array.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeArray = void 0;
-function mergeArray(a, b) {
+export function mergeArray(a, b) {
     if (!b) {
         return a;
     }
-    const result = a.slice();
+    const result = [...a];
     for (const bItem of b) {
         const bName = getName(bItem);
         const aIndex = result.findIndex(item => getName(item) === bName);
@@ -29,7 +26,6 @@ function mergeArray(a, b) {
     }
     return result;
 }
-exports.mergeArray = mergeArray;
 function getName(def) {
     const result = typeof def === 'string' ? def : def.name;
     return result.toLowerCase().trim();

package/lib/utils/resolve-namespace.d.ts

@@ -1,9 +1,9 @@
 import type { NamespaceURI, Namespace } from '@markuplint/ml-ast';
 type NamespacedElementName = {
-	localNameWithNS: string;
-	localName: string;
-	namespace: Namespace;
-	namespaceURI: NamespaceURI;
+    localNameWithNS: string;
+    localName: string;
+    namespace: Namespace;
+    namespaceURI: NamespaceURI;
 };
 export declare function resolveNamespace(name: string, namespaceURI?: string | null): NamespacedElementName;
 export {};

package/lib/utils/resolve-namespace.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveNamespace = void 0;
-const get_ns_1 = require("./get-ns");
+import { getNS } from './get-ns.js';
 const cache = new Map();
 const namespaceURIMap = {
     html: 'http://www.w3.org/1999/xhtml',
@@ -9,16 +6,15 @@ const namespaceURIMap = {
     mml: 'http://www.w3.org/1998/Math/MathML',
     xlink: 'http://www.w3.org/1999/xlink',
 };
-function resolveNamespace(name, namespaceURI = 'http://www.w3.org/1999/xhtml') {
-    var _a;
+export function resolveNamespace(name, namespaceURI = '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 = (_a = _localName !== null && _localName !== void 0 ? _localName : _explicitNS) !== null && _a !== void 0 ? _a : '';
-    const namespace = ['html', 'svg', 'mml', 'xlink'].find(_ns => _ns === (explicitNS || (0, get_ns_1.getNS)(namespaceURI !== null && namespaceURI !== void 0 ? namespaceURI : null))) ||
+    const localName = _localName ?? _explicitNS ?? '';
+    const namespace = ['html', 'svg', 'mml', 'xlink'].find(_ns => _ns === (explicitNS || getNS(namespaceURI ?? null))) ||
         'html';
     const result = {
         localNameWithNS: `${namespace === 'html' ? '' : `${namespace}:`}${localName}`,
@@ -29,4 +25,3 @@ function resolveNamespace(name, namespaceURI = 'http://www.w3.org/1999/xhtml') {
     cache.set(name + namespaceURI, result);
     return result;
 }
-exports.resolveNamespace = resolveNamespace;

package/lib/utils/{validateAriaVersion.d.ts → validate-aria-version.d.ts}

@@ -1,2 +1,2 @@
-import type { ARIAVersion } from '../types';
+import type { ARIAVersion } from '../types/index.js';
 export declare function validateAriaVersion(version: string): version is ARIAVersion;

package/lib/utils/validate-aria-version.js

@@ -0,0 +1,4 @@
+import { ariaVersions } from '../constant/aria-version.js';
+export function validateAriaVersion(version) {
+    return ariaVersions.includes(version);
+}