@markuplint/ml-spec 3.2.0 → 3.4.0

package/lib/types/index.d.ts

@@ -6,189 +6,217 @@ import type { NamespaceURI } from '@markuplint/ml-ast';
  * markuplint Markup-language spec
  */
 export interface MLMLSpec {
-    cites: Cites;
-    def: SpecDefs;
-    specs: ElementSpec[];
+	cites: Cites;
+	def: SpecDefs;
+	specs: ElementSpec[];
 }
 export type ExtendedElementSpec = Partial<Omit<ElementSpec, 'name' | 'attributes'>> & {
-    name: ElementSpec['name'];
-    attributes?: Record<string, Partial<Attribute>>;
+	name: ElementSpec['name'];
+	attributes?: Record<string, Partial<Attribute>>;
 };
 export type ExtendedSpec = {
-    cites?: Cites;
-    def?: Partial<SpecDefs>;
-    specs?: ExtendedElementSpec[];
+	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[];
-    };
+	'#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[];
+	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;
+	/**
+	 * 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;
+	startTag: boolean | ElementCondition;
+	endTag: boolean | ElementCondition;
 };
 type ElementCondition = {
-    __WIP__: 'WORK_IN_PROGRESS';
+	__WIP__: 'WORK_IN_PROGRESS';
 };
 export type Attribute = {
-    name: string;
-    type: AttributeType | AttributeType[];
-    description?: string;
-    caseSensitive?: true;
-    experimental?: boolean;
-    obsolete?: true;
-    deprecated?: boolean;
-    nonStandard?: true;
+	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[];
+	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 ARIARoleInSchema = Partial<
+	ARIARole & {
+		description: string;
+		generalization: string[];
+	}
+> & {
+	name: string;
 };
 export type ARIARoleOwnedProperties = {
-    name: string;
-    inherited?: true;
-    required?: true;
-    deprecated?: true;
+	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>;
+	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 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;
+	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;
+	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';
+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/permitted-structures.d.ts

@@ -3,56 +3,95 @@
  * 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/utils/merge-array.d.ts

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

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

@@ -10,13 +10,14 @@ const namespaceURIMap = {
     xlink: 'http://www.w3.org/1999/xlink',
 };
 function resolveNamespace(name, namespaceURI = 'http://www.w3.org/1999/xhtml') {
+    var _a;
     const cached = cache.get(name + namespaceURI);
     if (cached) {
         return cached;
     }
     const [_explicitNS, _localName] = name.split(':');
     const explicitNS = _localName ? _explicitNS : null;
-    const localName = _localName !== null && _localName !== void 0 ? _localName : _explicitNS;
+    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))) ||
         'html';
     const result = {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-spec",
-	"version": "3.2.0",
+	"version": "3.4.0",
 	"description": "Types and schema that specs of the Markup languages for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -11,6 +11,9 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
 	"scripts": {
 		"build": "tsc",
 		"dev": "tsc --build --watch",
@@ -22,14 +25,14 @@
 		"schema": "run-s schema:*"
 	},
 	"dependencies": {
-		"@markuplint/ml-ast": "3.0.0-rc.5",
+		"@markuplint/ml-ast": "3.0.0",
 		"dom-accessibility-api": "^0.5.14",
 		"tslib": "^2.4.1"
 	},
 	"devDependencies": {
-		"@markuplint/test-tools": "3.0.0-rc.5",
-		"@markuplint/types": "3.1.0",
-		"json-schema-to-typescript": "^11.0.2"
+		"@markuplint/test-tools": "3.0.0",
+		"@markuplint/types": "3.3.0",
+		"json-schema-to-typescript": "11.0.2"
 	},
-	"gitHead": "26b04e045d91e29befca34c10dda2147b1bca9c7"
+	"gitHead": "a83e0f5f214a9bbcc0286b9e269074ddca6189e7"
 }