@markuplint/types 4.8.1 → 5.0.0-alpha.0

package/lib/whatwg/check-datetime/time-string.js

@@ -2,6 +2,8 @@ import { log } from '../../debug.js';
 import { TokenCollection } from '../../token/index.js';
 import { datetimeTokenCheck } from './datetime-tokens.js';
 /**
+ * Validates a time string in the format `HH:MM[:SS[.sss]]`.
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#times
  */
 export const checkTimeString = () => function checkTimeString(value) {

package/lib/whatwg/check-datetime/time-zone-offset-string.d.ts

@@ -1,7 +1,15 @@
 import type { Token } from '../../token/index.js';
 import type { CustomSyntaxChecker } from '../../types.js';
 /**
+ * Validates a time-zone offset string (`Z`, `+HH:MM`, or `-HH:MM`).
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#time-zones
  */
 export declare const checkTimeZoneOffsetString: CustomSyntaxChecker;
+/**
+ * Parses and validates a time-zone offset string (e.g., `Z`, `+09:00`, `-05:30`).
+ *
+ * @param zone - The time-zone string or token to validate
+ * @returns The validation result
+ */
 export declare function parseTimeZone(zone: string | Readonly<Token>): import("../../types.js").Result;

package/lib/whatwg/check-datetime/time-zone-offset-string.js

@@ -3,12 +3,20 @@ import { matched, unmatched } from '../../match-result.js';
 import { TokenCollection } from '../../token/index.js';
 import { datetimeTokenCheck } from './datetime-tokens.js';
 /**
+ * Validates a time-zone offset string (`Z`, `+HH:MM`, or `-HH:MM`).
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#time-zones
  */
 export const checkTimeZoneOffsetString = () => function checkTimeZoneOffsetString(value) {
     log('CHECK: time-zone-offset-string');
     return parseTimeZone(value);
 };
+/**
+ * Parses and validates a time-zone offset string (e.g., `Z`, `+09:00`, `-05:30`).
+ *
+ * @param zone - The time-zone string or token to validate
+ * @returns The validation result
+ */
 export function parseTimeZone(zone) {
     const value = typeof zone === 'string' ? zone : zone.value;
     const zoneTokens = TokenCollection.fromPatterns(zone, [

package/lib/whatwg/check-datetime/week-string.d.ts

@@ -1,5 +1,7 @@
 import type { CustomSyntaxChecker } from '../../types.js';
 /**
+ * Validates a week string in the format `YYYY-Www`.
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#weeks
  */
 export declare const checkWeekString: CustomSyntaxChecker;

package/lib/whatwg/check-datetime/week-string.js

@@ -2,6 +2,8 @@ import { log } from '../../debug.js';
 import { TokenCollection } from '../../token/index.js';
 import { datetimeTokenCheck } from './datetime-tokens.js';
 /**
+ * Validates a week string in the format `YYYY-Www`.
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#weeks
  */
 export const checkWeekString = () => function checkWeekString(value) {

package/lib/whatwg/check-datetime/year-string.d.ts

@@ -1,5 +1,7 @@
 import type { CustomSyntaxChecker } from '../../types.js';
 /**
+ * Validates a year string (four or more digits, greater than zero).
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html
  */
 export declare const checkYearString: CustomSyntaxChecker;

package/lib/whatwg/check-datetime/year-string.js

@@ -2,6 +2,8 @@ import { log } from '../../debug.js';
 import { TokenCollection } from '../../token/index.js';
 import { datetimeTokenCheck } from './datetime-tokens.js';
 /**
+ * Validates a year string (four or more digits, greater than zero).
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html
  */
 export const checkYearString = () => function checkYearString(value) {

package/lib/whatwg/check-datetime/yearless-date-string.d.ts

@@ -1,5 +1,7 @@
 import type { CustomSyntaxChecker } from '../../types.js';
 /**
+ * Validates a yearless date string in the format `MM-DD`.
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#yearless-dates
  */
 export declare const checkYearlessDateString: CustomSyntaxChecker;

package/lib/whatwg/check-datetime/yearless-date-string.js

@@ -2,6 +2,8 @@ import { log } from '../../debug.js';
 import { TokenCollection } from '../../token/index.js';
 import { datetimeTokenCheck } from './datetime-tokens.js';
 /**
+ * Validates a yearless date string in the format `MM-DD`.
+ *
  * @see https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#yearless-dates
  */
 export const checkYearlessDateString = () => function checkYearlessDateString(value) {

package/lib/whatwg/check-link-type.d.ts

@@ -1,6 +1,113 @@
 import type { CustomSyntaxChecker } from '../types.js';
 /**
- * Link Type
+ * A WHATWG-defined link type keyword with per-element context and body-ok flag.
+ *
+ * @see https://html.spec.whatwg.org/multipage/links.html#linkTypes
+ */
+export type DefLinkTypeWhatwg = {
+    readonly keyword: string;
+    readonly link: string;
+    readonly a: string;
+    readonly form: string;
+    readonly bodyOk: string;
+};
+/**
+ * A Microformats-registered link type keyword with per-element context flags.
+ *
+ * @see https://microformats.org/wiki/existing-rel-values
+ */
+export type DefLinkTypeMicroformats = {
+    readonly keyword: string;
+    readonly link: boolean;
+    readonly a: boolean;
+};
+/**
+ * A dropped, rejected, or non-HTML link type keyword from the Microformats registry.
+ *
+ * @see https://microformats.org/wiki/existing-rel-values
+ */
+export type DefLinkTypeMicroformatsDropped = {
+    readonly keyword: string;
+};
+/**
+ * @see https://html.spec.whatwg.org/multipage/links.html#linkTypes
+ *
+ * Scraping:
+ * ```js
+ * JSON.stringify(document.querySelectorAll('#table-link-relations tbody tr').values().toArray().map((el) => {
+ *     const keyword = el.querySelector('td').textContent.trim();
+ *     const link = el.querySelector('td:nth-child(2)').textContent.trim();
+ *     const a = el.querySelector('td[colspan="3"]:nth-child(2)')?.textContent.trim() ?? el.querySelector('td[colspan="2"]:nth-child(2)')?.textContent.trim() ?? el.querySelector('td:nth-child(3)')?.textContent.trim();
+ *     const form = el.querySelector('td[colspan="3"]:nth-child(2)')?.textContent.trim() ?? el.querySelector('td[colspan="2"]:nth-child(3)')?.textContent.trim() ?? el.querySelector('td[colspan="2"]:nth-child(2) + td')?.textContent.trim() ?? el.querySelector('td:nth-child(4)')?.textContent.trim();
+ *     const bodyOk = el.querySelector('td[colspan="3"]:nth-child(2) + td')?.textContent.trim() ?? el.querySelector('td[colspan="2"]:nth-child(3) + td')?.textContent.trim() ?? el.querySelector('td[colspan="2"]:nth-child(2) + td + td')?.textContent.trim() ?? el.querySelector('td:nth-child(5)')?.textContent.trim();
+ *     return { keyword, link, a, form, bodyOk }
+ * }));
+ * ```
+ */
+export declare const DEF_LINK_TYPE_WHATWG: DefLinkTypeWhatwg[];
+/**
+ * @see https://microformats.org/wiki/existing-rel-values#non_HTML_rel_values
+ *
+ * Scraping:
+ * ```js
+ * JSON.stringify($("h2:has('#non_HTML_rel_values') ~ table").eq(0).find('tr:has(td)').toArray().map((el) => {
+ *     const $tr = $(el);
+ *     const keyword = $tr.find('td')[0].textContent.trim();
+ *     return { keyword, link: true, a: true }
+ * }));
+ */
+export declare const DEF_LINK_TYPE_MICROFORMATS_NON_HTML_REL_VALUES: DefLinkTypeMicroformatsDropped[];
+/**
+ * @see https://microformats.org/wiki/existing-rel-values#dropped
+ *
+ * Scraping:
+ * ```js
+ * JSON.stringify($("h2:has('#dropped') ~ table").eq(0).find('tr:has(td)').toArray().map((el) => {
+ *     const $tr = $(el);
+ *     const keyword = $tr.find('td')[0].textContent.split(' ')[0]?.trim();
+ *     return { keyword }
+ * }));
+ */
+export declare const DEF_LINK_TYPE_MICROFORMATS_DROPPED: DefLinkTypeMicroformatsDropped[];
+/**
+ * @see https://microformats.org/wiki/existing-rel-values#dropped_without_prejudice
+ *
+ * Scraping:
+ * ```js
+ * JSON.stringify($("h2:has('#dropped_without_prejudice') ~ table").eq(0).find('tr:has(td)').toArray().map((el) => {
+ *     const $tr = $(el);
+ *     const keyword = $tr.find('td')[0].textContent.split(' ')[0]?.trim();
+ *     return { keyword }
+ * }));
+ * ```
+ */
+export declare const DEF_LINK_TYPE_MICROFORMATS_DROPPED_WITHOUT_PREJUDICE: DefLinkTypeMicroformatsDropped[];
+/**
+ * @see https://microformats.org/wiki/existing-rel-values#rejected
+ *
+ * Scraping:
+ * ```js
+ * JSON.stringify($("h2:has('#rejected') ~ table").eq(0).find('tr:has(td)').toArray().map((el) => {
+ *     const $tr = $(el);
+ *     const keyword = $tr.find('td')[0].textContent.split(' ')[0]?.trim();
+ *     return { keyword }
+ * }));
+ * ```
+ */
+export declare const DEF_LINK_TYPE_MICROFORMATS_REJECTED: DefLinkTypeMicroformatsDropped[];
+/**
+ * Combined list of all allowed Microformats link type keywords,
+ * excluding any that overlap with WHATWG standard keywords.
+ *
+ * @see https://microformats.org/wiki/existing-rel-values
+ */
+export declare const ALLOWED_LINK_TYPE_MICROFORMATS: DefLinkTypeMicroformats[];
+/**
+ * Validates a link type attribute value against WHATWG and Microformats registries.
+ *
+ * Filters allowed keywords based on the element context (link, body link, a/area, or form).
+ * Rejects dropped, non-HTML, and rejected link types from the Microformats wiki.
+ *
  * @see https://html.spec.whatwg.org/multipage/links.html#linkTypes
  */
 export declare const checkLinkType: CustomSyntaxChecker<{

package/lib/whatwg/check-link-type.js

@@ -15,7 +15,7 @@ import { TokenCollection } from '../token/token-collection.js';
  * }));
  * ```
  */
-const DEF_LINK_TYPE_WHATWG = [
+export const DEF_LINK_TYPE_WHATWG = [
     { keyword: 'alternate', link: 'Hyperlink', a: 'Hyperlink', form: 'not allowed', bodyOk: '·' },
     { keyword: 'canonical', link: 'Hyperlink', a: 'not allowed', form: 'not allowed', bodyOk: '·' },
     { keyword: 'author', link: 'Hyperlink', a: 'Hyperlink', form: 'not allowed', bodyOk: '·' },
@@ -353,7 +353,7 @@ const DEF_LINK_TYPE_MICROFORMATS_DUBLIN_CORE = [
  *     return { keyword, link: true, a: true }
  * }));
  */
-const DEF_LINK_TYPE_MICROFORMATS_NON_HTML_REL_VALUES = [
+export const DEF_LINK_TYPE_MICROFORMATS_NON_HTML_REL_VALUES = [
     { keyword: 'self' },
     { keyword: 'http://gdata.youtube.com/schemas/2007#in-reply-to' },
     { keyword: 'collection' },
@@ -394,7 +394,7 @@ const DEF_LINK_TYPE_MICROFORMATS_NON_HTML_REL_VALUES = [
  *     return { keyword }
  * }));
  */
-const DEF_LINK_TYPE_MICROFORMATS_DROPPED = [
+export const DEF_LINK_TYPE_MICROFORMATS_DROPPED = [
     { keyword: 'banner' },
     { keyword: 'begin' },
     { keyword: 'biblioentry' }, // cspell:disable-line
@@ -430,7 +430,7 @@ const DEF_LINK_TYPE_MICROFORMATS_DROPPED = [
  * }));
  * ```
  */
-const DEF_LINK_TYPE_MICROFORMATS_DROPPED_WITHOUT_PREJUDICE = [
+export const DEF_LINK_TYPE_MICROFORMATS_DROPPED_WITHOUT_PREJUDICE = [
     { keyword: 'first' },
     { keyword: 'index' },
     { keyword: 'last' },
@@ -448,11 +448,17 @@ const DEF_LINK_TYPE_MICROFORMATS_DROPPED_WITHOUT_PREJUDICE = [
  * }));
  * ```
  */
-const DEF_LINK_TYPE_MICROFORMATS_REJECTED = [
+export const DEF_LINK_TYPE_MICROFORMATS_REJECTED = [
     { keyword: 'logo' },
     { keyword: 'pavatar' }, // cspell:disable-line
 ];
-const ALLOWED_LINK_TYPE_MICROFORMATS = [
+/**
+ * Combined list of all allowed Microformats link type keywords,
+ * excluding any that overlap with WHATWG standard keywords.
+ *
+ * @see https://microformats.org/wiki/existing-rel-values
+ */
+export const ALLOWED_LINK_TYPE_MICROFORMATS = [
     ...DEF_LINK_TYPE_MICROFORMATS_FORMATS,
     ...DEF_LINK_TYPE_MICROFORMATS_PROPOSALS,
     ...DEF_LINK_TYPE_MICROFORMATS_HTML5_LINK_TYPE_EXTENSIONS,
@@ -461,7 +467,11 @@ const ALLOWED_LINK_TYPE_MICROFORMATS = [
     ...DEF_LINK_TYPE_MICROFORMATS_DUBLIN_CORE,
 ].filter(def => !DEF_LINK_TYPE_WHATWG.some(whatwg => whatwg.keyword === def.keyword));
 /**
- * Link Type
+ * Validates a link type attribute value against WHATWG and Microformats registries.
+ *
+ * Filters allowed keywords based on the element context (link, body link, a/area, or form).
+ * Rejects dropped, non-HTML, and rejected link types from the Microformats wiki.
+ *
  * @see https://html.spec.whatwg.org/multipage/links.html#linkTypes
  */
 export const checkLinkType = options => value => {

package/lib/whatwg/check-mime-type.d.ts

@@ -1,6 +1,9 @@
 import type { CustomSyntaxChecker } from '../types.js';
 /**
- * MIME Type
+ * Validates a MIME type string according to the WHATWG MIME Sniffing specification.
+ *
+ * Optionally restricts to MIME types with no parameters.
+ *
  * @see https://mimesniff.spec.whatwg.org/#valid-mime-type
  */
 export declare const checkMIMEType: CustomSyntaxChecker<{

package/lib/whatwg/check-mime-type.js

@@ -1,5 +1,5 @@
-// @ts-ignore
-import MIMEType from 'whatwg-mimetype';
+// @ts-ignore -- whatwg-mimetype v5 has no type definitions
+import { MIMEType } from 'whatwg-mimetype';
 import { matched, unmatched } from '../match-result.js';
 import { Token } from '../token/index.js';
 const expects = (withoutParameters) => [
@@ -9,7 +9,10 @@ const expects = (withoutParameters) => [
     },
 ];
 /**
- * MIME Type
+ * Validates a MIME type string according to the WHATWG MIME Sniffing specification.
+ *
+ * Optionally restricts to MIME types with no parameters.
+ *
  * @see https://mimesniff.spec.whatwg.org/#valid-mime-type
  */
 export const checkMIMEType = options => value => {

package/lib/whatwg/is-abs-url.d.ts

@@ -1,5 +1,7 @@
 import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
+ * Checks whether a string is a valid absolute URL.
+ *
  * @see https://url.spec.whatwg.org/#syntax-url-absolute
  *
  * > An absolute-URL string must be one of the following:

package/lib/whatwg/is-abs-url.js

@@ -1,4 +1,6 @@
 /**
+ * Checks whether a string is a valid absolute URL.
+ *
  * @see https://url.spec.whatwg.org/#syntax-url-absolute
  *
  * > An absolute-URL string must be one of the following:
@@ -17,10 +19,7 @@ export const isAbsURL = () => {
             new URL(value);
         }
         catch (error) {
-            if (error &&
-                typeof error === 'object' &&
-                'code' in error && // @ts-ignore
-                error.code === 'ERR_INVALID_URL') {
+            if (error instanceof TypeError) {
                 return false;
             }
             throw error;

package/lib/whatwg/is-browser-context-name.d.ts

@@ -1,5 +1,6 @@
 import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
+ * Checks whether a string is a valid browsing context name.
  *
  * @see https://html.spec.whatwg.org/multipage/browsers.html#valid-browsing-context-name
  *
@@ -7,7 +8,6 @@ import type { FormattedPrimitiveTypeCreator } from '../types.js';
  * > that does not start with a U+005F LOW LINE character.
  * > (Names starting with an underscore are reserved for special keywords.)
  *
- * @deprecated
- *
+ * @deprecated Use {@link isNavigableTargetName} instead.
  */
 export declare const isBrowserContextName: FormattedPrimitiveTypeCreator;

package/lib/whatwg/is-browser-context-name.js

@@ -1,4 +1,5 @@
 /**
+ * Checks whether a string is a valid browsing context name.
  *
  * @see https://html.spec.whatwg.org/multipage/browsers.html#valid-browsing-context-name
  *
@@ -6,8 +7,7 @@
  * > that does not start with a U+005F LOW LINE character.
  * > (Names starting with an underscore are reserved for special keywords.)
  *
- * @deprecated
- *
+ * @deprecated Use {@link isNavigableTargetName} instead.
  */
 export const isBrowserContextName = () => {
     return value => {

package/lib/whatwg/is-custom-element-name.d.ts

@@ -1,6 +1,6 @@
 import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
- * valid name of custom element
+ * Checks whether a string is a valid custom element name.
  *
  * > PotentialCustomElementName ::=
  * >   [a-z] (PCENChar)* '-' (PCENChar)*

package/lib/whatwg/is-custom-element-name.js

@@ -11,7 +11,7 @@ const onlyPCENChar =
 // eslint-disable-next-line no-misleading-character-class
 /^[-.\d_a-z\u00B7\u00C0-\u00D6[\u00D8-\u00F6\u00F8-\u037D\u037F-\u1FFF\u200C\u200D\u203F\u2040\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u{10000}-\u{EFFFF}]*$/u;
 /**
- * valid name of custom element
+ * Checks whether a string is a valid custom element name.
  *
  * > PotentialCustomElementName ::=
  * >   [a-z] (PCENChar)* '-' (PCENChar)*

package/lib/whatwg/is-itemprop-name.d.ts

@@ -1,5 +1,6 @@
 import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
+ * Checks whether a string is a valid itemprop property name.
  *
  * @see https://html.spec.whatwg.org/multipage/microdata.html#defined-property-name
  *

package/lib/whatwg/is-itemprop-name.js

@@ -1,4 +1,5 @@
 /**
+ * Checks whether a string is a valid itemprop property name.
  *
  * @see https://html.spec.whatwg.org/multipage/microdata.html#defined-property-name
  *

package/lib/whatwg/is-navigable-target-name.d.ts

@@ -1,5 +1,7 @@
 import type { FormattedPrimitiveTypeCreator } from '../types.js';
 /**
+ * Checks whether a string is a valid navigable target name.
+ *
  * @see https://html.spec.whatwg.org/multipage/document-sequences.html#valid-navigable-target-name
  *
  * > A valid navigable target name is any string with at least one character

package/lib/whatwg/is-navigable-target-name.js

@@ -5,6 +5,8 @@
  */
 const TAB_OR_NEWLINE = /[\t\n\r]/;
 /**
+ * Checks whether a string is a valid navigable target name.
+ *
  * @see https://html.spec.whatwg.org/multipage/document-sequences.html#valid-navigable-target-name
  *
  * > A valid navigable target name is any string with at least one character

package/package.json

@@ -1,10 +1,13 @@
 {
 	"name": "@markuplint/types",
-	"version": "4.8.1",
+	"version": "5.0.0-alpha.0",
 	"description": "Type declaration and value checker",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
 	"license": "MIT",
+	"engines": {
+		"node": ">=22"
+	},
 	"type": "module",
 	"exports": {
 		".": {
@@ -29,16 +32,15 @@
 		"schema:prettier": "npx prettier --write \"./src/types.schema.ts\" \"./types.schema.json\" --log-level warn"
 	},
 	"dependencies": {
-		"@markuplint/shared": "4.4.12",
+		"@markuplint/shared": "5.0.0-alpha.0",
 		"@types/css-tree": "2.3.11",
 		"@types/debug": "4.1.12",
-		"@types/whatwg-mimetype": "3.0.2",
 		"bcp-47": "2.1.0",
 		"css-tree": "3.1.0",
 		"debug": "4.4.3",
 		"leven": "4.1.0",
-		"type-fest": "4.41.0",
-		"whatwg-mimetype": "4.0.0"
+		"type-fest": "5.4.4",
+		"whatwg-mimetype": "5.0.0"
 	},
-	"gitHead": "6213ea30269ef404f030e67bbcc7fc7443ec1060"
+	"gitHead": "13dcfc84ec83d87360c720e253383b60767e1b56"
 }

package/types.schema.json

@@ -1274,13 +1274,22 @@
 				"ref": { "type": "string" }
 			}
 		},
+		"pattern": {
+			"type": "object",
+			"required": ["pattern"],
+			"additionalProperties": false,
+			"properties": {
+				"pattern": { "type": "string" }
+			}
+		},
 		"type": {
 			"oneOf": [
 				{ "$ref": "#/definitions/keyword-defined-type" },
 				{ "$ref": "#/definitions/list" },
 				{ "$ref": "#/definitions/enum" },
 				{ "$ref": "#/definitions/number" },
-				{ "$ref": "#/definitions/directive" }
+				{ "$ref": "#/definitions/directive" },
+				{ "$ref": "#/definitions/pattern" }
 			]
 		}
 	},