@markuplint/ml-spec 2.1.1 → 3.0.0-alpha.1

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

@@ -0,0 +1,58 @@
+/**
+ * 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 declare type PermittedContentPattern = PermittedContentRequire | PermittedContentOptional | PermittedContentOneOrMore | PermittedContentZeroOrMore | PermittedContentChoice | PermittedContentTransparent;
+export declare type Model = ContentType | ContentType[];
+export declare type ContentType = string | Category;
+export declare 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' | '#SVGOtherXMLNamespace';
+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/lib/types/permitted-structres.js

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

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

@@ -0,0 +1,54 @@
+/**
+ * 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 declare type PermittedContentPattern = PermittedContentRequire | PermittedContentOptional | PermittedContentOneOrMore | PermittedContentZeroOrMore | PermittedContentChoice | PermittedContentTransparent;
+export declare type Model = ContentType | ContentType[];
+export declare type ContentType = string | Category;
+export declare 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' | '#SVGOtherXMLNamespace';
+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/lib/types/permitted-structures.js

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

package/lib/utils/get-ns.d.ts

@@ -0,0 +1,2 @@
+import type { Namespace } from '@markuplint/ml-ast';
+export declare function getNS(namespaceURI: string | null): Namespace;

package/lib/{get-ns.js → utils/get-ns.js}

@@ -9,6 +9,9 @@ function getNS(namespaceURI) {
         case 'http://www.w3.org/1998/Math/MathML': {
             return 'mml';
         }
+        case 'http://www.w3.org/1999/xlink': {
+            return 'xlink';
+        }
         default: {
             return 'html';
         }

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

@@ -0,0 +1,9 @@
+import type { NamespaceURI, Namespace } from '@markuplint/ml-ast';
+declare type NamespacedElementName = {
+    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

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveNamespace = void 0;
+const get_ns_1 = require("./get-ns");
+const cache = new Map();
+const namespaceURIMap = {
+    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',
+};
+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 = _localName !== null && _localName !== void 0 ? _localName : _explicitNS;
+    const namespace = ['html', 'svg', 'mml', 'xlink'].find(_ns => _ns === (explicitNS || (0, get_ns_1.getNS)(namespaceURI || null))) ||
+        'html';
+    const result = {
+        localNameWithNS: `${namespace === 'html' ? '' : `${namespace}:`}${localName}`,
+        localName,
+        namespace,
+        namespaceURI: namespaceURIMap[namespace],
+    };
+    cache.set(name + namespaceURI, result);
+    return result;
+}
+exports.resolveNamespace = resolveNamespace;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-spec",
-	"version": "2.1.1",
+	"version": "3.0.0-alpha.1",
 	"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>",
@@ -16,16 +16,20 @@
 		"dev": "tsc --build --watch",
 		"clean": "tsc --build --clean",
 		"schema:gen": "ts-node ./gen/gen.ts; prettier --write './schemas/*.json';",
-		"schema:structures": "json2ts ./schemas/permitted-structures.schema.json > ./src/permitted-structres.ts; prettier --write ./src/permitted-structres.ts; eslint --fix --config ../../../.eslintrc ./src/permitted-structres.ts",
-		"schema:attributes": "json2ts ./schemas/attributes.schema.json --cwd ./schemas > ./src/attributes.ts; prettier --write ./src/attributes.ts; eslint --fix --config ../../../.eslintrc ./src/attributes.ts",
-		"schema": "yarn schema:gen; yarn schema:structures; yarn schema:attributes; tsc;"
+		"schema:content-models": "json2ts ./schemas/content-models.schema.json > ./src/types/permitted-structres.ts; prettier --write ./src/types/permitted-structres.ts; eslint --fix --config ../../../.eslintrc ./src/types/permitted-structres.ts",
+		"schema:attributes": "json2ts ./schemas/attributes.schema.json --cwd ./schemas > ./src/types/attributes.ts; prettier --write ./src/types/attributes.ts; eslint --fix --config ../../../.eslintrc ./src/types/attributes.ts",
+		"schema:aria": "json2ts ./schemas/aria.schema.json --cwd ./schemas > ./src/types/aria.ts; prettier --write ./src/types/aria.ts; eslint --fix --config ../../../.eslintrc ./src/types/aria.ts",
+		"schema": "run-s schema:*"
 	},
 	"dependencies": {
-		"tslib": "^2.3.1"
+		"@markuplint/ml-ast": "3.0.0-alpha.1",
+		"dom-accessibility-api": "^0.5.14",
+		"tslib": "^2.4.0"
 	},
 	"devDependencies": {
-		"@markuplint/types": "2.2.0",
-		"json-schema-to-typescript": "^10.1.5"
+		"@markuplint/test-tools": "3.0.0-alpha.1",
+		"@markuplint/types": "3.0.0-alpha.1",
+		"json-schema-to-typescript": "^11.0.2"
 	},
-	"gitHead": "c28258b756d8c42890698e26c03cdc02c6833489"
+	"gitHead": "56de89456146a06777eb5b6d4e8ba456147dd18b"
 }

package/schema.json

@@ -17,7 +17,7 @@
 			],
 			"type": "string"
 		},
-		"AttributeCtegory": {
+		"AttributeCategory": {
 			"enum": ["aria", "eventhandler", "form", "global", "particular", "xml"],
 			"type": "string"
 		},
@@ -85,7 +85,7 @@
 					"items": {
 						"properties": {
 							"category": {
-								"$ref": "#/definitions/AttributeCtegory"
+								"$ref": "#/definitions/AttributeCategory"
 							},
 							"deprecated": {
 								"enum": [true],
@@ -162,7 +162,7 @@
 										{
 											"properties": {
 												"category": {
-													"$ref": "#/definitions/AttributeCtegory"
+													"$ref": "#/definitions/AttributeCategory"
 												},
 												"deprecated": {
 													"enum": [true],
@@ -211,7 +211,7 @@
 						"type": "array"
 					},
 					"categories": {
-						"description": "Element cateogries",
+						"description": "Element categories",
 						"items": {
 							"anyOf": [
 								{
@@ -294,7 +294,7 @@
 						],
 						"description": "Obsolete or alternative elements"
 					},
-					"omittion": {
+					"omission": {
 						"anyOf": [
 							{
 								"properties": {
@@ -338,7 +338,7 @@
 								"type": "boolean"
 							}
 						],
-						"description": "Tag omittion"
+						"description": "Tag omission"
 					},
 					"permittedContent": {
 						"description": "Permitted content",

package/schemas/aria.schema.json

@@ -0,0 +1,258 @@
+{
+	"definitions": {
+		"PermittedRoles": {
+			"description": "If `true`, this mean is \"Any\". If `false`, this mean is \"No\".",
+			"oneOf": [
+				{
+					"type": "boolean"
+				},
+				{
+					"type": "array",
+					"items": {
+						"oneOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"required": ["name"],
+								"minProperties": 2,
+								"properties": {
+									"name": { "type": "string" },
+									"deprecated": { "type": "boolean", "enum": [true] }
+								}
+							}
+						]
+					}
+				},
+				{
+					"type": "object",
+					"minProperties": 1,
+					"additionalProperties": false,
+					"properties": {
+						"core-aam": {
+							"type": "boolean",
+							"enum": [true]
+						},
+						"graphics-aam": {
+							"type": "boolean",
+							"enum": [true]
+						}
+					}
+				}
+			]
+		},
+		"PermittedARIAProperties": {
+			"description": "If set false:\n> No role or aria-* attributes",
+			"oneOf": [
+				{
+					"type": "boolean",
+					"enum": [false]
+				},
+				{
+					"type": "object",
+					"minProperties": 1,
+					"additionalProperties": false,
+					"properties": {
+						"global": {
+							"type": "boolean",
+							"enum": [true]
+						},
+						"role": {
+							"description": "Set true if the spec says \"and any aria-* attributes applicable to the allowed roles.\"",
+							"oneOf": [
+								{
+									"type": "boolean",
+									"enum": [true]
+								},
+								{
+									"type": "string"
+								},
+								{
+									"type": "array",
+									"minItems": 1,
+									"items": { "type": "string" }
+								}
+							]
+						},
+						"only": {
+							"type": "array",
+							"minItems": 1,
+							"items": {
+								"oneOf": [
+									{
+										"type": "string",
+										"pattern": "^aria-.+"
+									},
+									{
+										"type": "object",
+										"required": ["name"],
+										"additionalProperties": false,
+										"properties": {
+											"name": {
+												"type": "string",
+												"pattern": "^aria-.+"
+											},
+											"value": {
+												"type": "string"
+											}
+										}
+									}
+								]
+							}
+						},
+						"without": {
+							"type": "array",
+							"minItems": 1,
+							"items": {
+								"type": "object",
+								"required": ["type", "name"],
+								"additionalProperties": false,
+								"properties": {
+									"type": {
+										"type": "string",
+										"enum": ["not-recommended", "should-not", "must-not"]
+									},
+									"name": {
+										"type": "string",
+										"pattern": "^aria-.+"
+									},
+									"value": {
+										"type": "string"
+									},
+									"alt": {
+										"type": "object",
+										"required": ["method", "target"],
+										"additionalProperties": false,
+										"properties": {
+											"method": {
+												"type": "string",
+												"enum": ["remove-attr", "set-attr"]
+											},
+											"target": {
+												"type": "string"
+											}
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			]
+		},
+		"ImplicitRole": {
+			"description": "If `false`, this mean is \"No corresponding role\".",
+			"oneOf": [
+				{
+					"type": "boolean",
+					"enum": [false]
+				},
+				{
+					"type": "string"
+				}
+			]
+		},
+		"ImplicitProperties": {
+			"type": "object",
+			"minProperties": 1,
+			"patternProperties": {
+				"^aria-.+": {
+					"type": "string"
+				}
+			}
+		},
+		"ARIA": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["implicitRole", "permittedRoles"],
+			"properties": {
+				"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+				"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+				"namingProhibited": { "type": "boolean", "enum": [true] },
+				"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+				"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+				"conditions": {
+					"type": "object",
+					"minProperties": 1,
+					"patternProperties": {
+						".+": {
+							"type": "object",
+							"minProperties": 1,
+							"additionalProperties": false,
+							"properties": {
+								"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+								"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+								"namingProhibited": { "type": "boolean", "enum": [true] },
+								"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+								"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+							}
+						}
+					}
+				},
+				"1.2": {
+					"type": "object",
+					"additionalProperties": false,
+					"minProperties": 1,
+					"properties": {
+						"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+						"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+						"namingProhibited": { "type": "boolean", "enum": [true] },
+						"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+						"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+						"conditions": {
+							"type": "object",
+							"minProperties": 1,
+							"patternProperties": {
+								".+": {
+									"type": "object",
+									"minProperties": 1,
+									"additionalProperties": false,
+									"properties": {
+										"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+										"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+										"namingProhibited": { "type": "boolean", "enum": [true] },
+										"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+										"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+									}
+								}
+							}
+						}
+					}
+				},
+				"1.1": {
+					"type": "object",
+					"additionalProperties": false,
+					"minProperties": 1,
+					"properties": {
+						"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+						"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+						"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+						"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+						"conditions": {
+							"type": "object",
+							"minProperties": 1,
+							"patternProperties": {
+								".+": {
+									"type": "object",
+									"minProperties": 1,
+									"additionalProperties": false,
+									"properties": {
+										"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+										"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+										"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+										"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"type": "object",
+	"properties": {
+		"_": { "$ref": "#/definitions/ARIA" }
+	}
+}

package/schemas/attributes.schema.json

@@ -1,22 +1,7 @@
 {
 	"definitions": {
 		"AttributeName": { "type": "string", "pattern": "^(?:(xml|xlink):)?[a-z][a-zA-Z0-9-]*$" },
-		"AttributeCondition": {
-			"oneOf": [
-				{
-					"type": "object",
-					"additionalProperties": false,
-					"required": ["ancestor"],
-					"properties": { "ancestor": { "$ref": "#/definitions/Selectors" } }
-				},
-				{
-					"type": "object",
-					"additionalProperties": false,
-					"required": ["self"],
-					"properties": { "self": { "$ref": "#/definitions/Selectors" } }
-				}
-			]
-		},
+		"AttributeCondition": { "$ref": "#/definitions/Selectors" },
 		"Selectors": {
 			"oneOf": [{ "type": "string" }, { "type": "array", "minItems": 2, "items": { "type": "string" } }]
 		},
@@ -24,11 +9,8 @@
 		"AttributeJSON": {
 			"type": "object",
 			"additionalProperties": false,
-			"required": ["ref"],
-			"minProperties": 2,
+			"minProperties": 1,
 			"properties": {
-				"_TODO_": { "type": "string" },
-				"ref": { "type": "string", "format": "uri" },
 				"type": {
 					"oneOf": [
 						{ "$ref": "#/definitions/AttributeType" },
@@ -213,10 +195,9 @@
 	},
 	"type": "object",
 	"additionalProperties": false,
-	"required": ["tag", "ref", "attributes"],
+	"required": ["tag", "attributes"],
 	"properties": {
 		"tag": { "type": "string" },
-		"ref": { "type": "string", "format": "uri" },
 		"global": { "$ref": "#/definitions/GlobalAttributes" },
 		"attributes": { "$ref": "#/definitions/Attributes" }
 	}