html-standard 0.0.1 → 0.0.2

package/.prettierignore

@@ -0,0 +1 @@
+dist

package/.prettierrc

@@ -0,0 +1 @@
+{}

package/README.md

@@ -1 +1,19 @@
-# html-spec
+# html-standard
+
+`html-standard` is a **work-in-progress** JavaScript/TypeScript library that provides structured data from the [HTML Living Standard](https://html.spec.whatwg.org/).
+
+## Installation
+
+```console
+npm install html-standard
+```
+
+## Usage
+
+```js
+import { getElementSpec } from "html-standard";
+
+const divSpec = getElementSpec("div");
+
+divSpec.attributes.has("id"); // true
+```

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\.tsx?$": ["ts-jest",{}],
+  },
+};

package/package.json

@@ -1,11 +1,27 @@
 {
   "name": "html-standard",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "",
-  "main": "index.js",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.cjs"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup",
+    "ts": "tsc --noEmit",
+    "test": "jest"
   },
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.3.1",
+    "tsup": "^8.4.0"
+  }
 }

package/src/elements/common/attributes.ts

@@ -0,0 +1,34 @@
+export const globalAttributes = new Set([
+  "accesskey",
+  "autocapitalize",
+  "autocorrect",
+  "autofocus",
+  "contenteditable",
+  "dir",
+  "draggable",
+  "enterkeyhint",
+  "hidden",
+  "inert",
+  "inputmode",
+  "is",
+  "itemid",
+  "itemprop",
+  "itemref",
+  "itemscope",
+  "itemtype",
+  "lang",
+  "nonce",
+  "popover",
+  "spellcheck",
+  "style",
+  "tabindex",
+  "title",
+  "translate",
+  "writingsuggestions",
+  "class",
+  "id",
+  "slot",
+  "xmlns",
+  "xml:lang",
+  "xml:space",
+]);

package/src/elements/common/contents.ts

@@ -0,0 +1,191 @@
+export const contents = {
+  metadataContent: new Set([
+    "base",
+    "link",
+    "meta",
+    "noscript",
+    "script",
+    "style",
+    "template",
+    "title",
+  ]),
+  flowContent: new Set([
+    "a",
+    "abbr",
+    "address",
+    "area",
+    "article",
+    "aside",
+    "audio",
+    "b",
+    "bdi",
+    "bdo",
+    "blockquote",
+    "br",
+    "button",
+    "canvas",
+    "cite",
+    "code",
+    "data",
+    "datalist",
+    "del",
+    "details",
+    "dfn",
+    "dialog",
+    "div",
+    "dl",
+    "em",
+    "embed",
+    "fieldset",
+    "figure",
+    "footer",
+    "form",
+    "h1",
+    "h2",
+    "h3",
+    "h4",
+    "h5",
+    "h6",
+    "header",
+    "hgroup",
+    "hr",
+    "i",
+    "iframe",
+    "img",
+    "input",
+    "ins",
+    "kbd",
+    "label",
+    "link",
+    "main",
+    "map",
+    "mark",
+    "math",
+    "menu",
+    "meta",
+    "meter",
+    "nav",
+    "noscript",
+    "object",
+    "ol",
+    "output",
+    "p",
+    "picture",
+    "pre",
+    "progress",
+    "q",
+    "ruby",
+    "s",
+    "samp",
+    "script",
+    "search",
+    "section",
+    "select",
+    "slot",
+    "small",
+    "span",
+    "strong",
+    "sub",
+    "sup",
+    "svg",
+    "table",
+    "template",
+    "textarea",
+    "time",
+    "u",
+    "ul",
+    "var",
+    "video",
+    "wbr",
+    "#text",
+  ]),
+  phrasingContent: new Set([
+    "a",
+    "abbr",
+    "area",
+    "audio",
+    "b",
+    "bdi",
+    "bdo",
+    "br",
+    "button",
+    "canvas",
+    "cite",
+    "code",
+    "data",
+    "datalist",
+    "del",
+    "dfn",
+    "em",
+    "embed",
+    "i",
+    "iframe",
+    "img",
+    "input",
+    "ins",
+    "kbd",
+    "label",
+    "link",
+    "map",
+    "mark",
+    "math",
+    "meta",
+    "meter",
+    "noscript",
+    "object",
+    "output",
+    "picture",
+    "progress",
+    "q",
+    "ruby",
+    "s",
+    "samp",
+    "script",
+    "select",
+    "slot",
+    "small",
+    "span",
+    "strong",
+    "sub",
+    "sup",
+    "svg",
+    "template",
+    "textarea",
+    "time",
+    "u",
+    "var",
+    "video",
+    "wbr",
+    "#text",
+  ]),
+  scriptSupportingElements: new Set(["script", "template"]),
+  headingContent: new Set(["h1", "h2", "h3", "h4", "h5", "h6", "hgroup"]),
+  sectioningContent: new Set(["article", "aside", "nav", "section"]),
+  transparentContent: new Set(["#transparent"]),
+  interactiveContent: new Set([
+    "a",
+    "audio",
+    "button",
+    "details",
+    "embed",
+    "iframe",
+    "img",
+    "input",
+    "label",
+    "select",
+    "text",
+    "area",
+    "video",
+  ]),
+  text: new Set("#text"),
+  mediaElements: new Set(["audio", "video"]),
+  labelableElements: new Set([
+    "button",
+    "input",
+    "meter",
+    "output",
+    "progress",
+    "select",
+    "textarea",
+  ]),
+};

package/src/elements/document/html.ts

@@ -0,0 +1,18 @@
+import { contentAttributes } from "../utils/contentAttributes";
+import { ElementSpec, GetElementSpec } from "../types";
+
+const htmlSpec: ElementSpec = {
+  contents: [
+    {
+      type: "required",
+      contents: new Set(["head"]),
+    },
+    {
+      type: "required",
+      contents: new Set(["body"]),
+    },
+  ],
+  attributes: contentAttributes(true),
+};
+
+export const html: GetElementSpec = () => htmlSpec;

package/src/elements/document-metadata/base.ts

@@ -0,0 +1,9 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const baseSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, ["href", "target"]),
+};
+
+export const base: GetElementSpec = () => baseSpec;

package/src/elements/document-metadata/head.ts

@@ -0,0 +1,21 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const headSpec: ElementSpec = {
+  contents: [
+    {
+      type: "oneOrMore",
+      contents: contents.metadataContent,
+      constraints: {
+        children: new Map([
+          ["title", { required: true }],
+          ["base", { max: 1 }],
+        ]),
+      },
+    },
+  ],
+  attributes: contentAttributes(true),
+};
+
+export const head: GetElementSpec = () => headSpec;

package/src/elements/document-metadata/link.ts

@@ -0,0 +1,27 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const linkSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "href",
+    "crossorigin",
+    "rel",
+    "media",
+    "integrity",
+    "hreflang",
+    "type",
+    "referrerpolicy",
+    "sizes",
+    "imagesrcset",
+    "imagesizes",
+    "as",
+    "blocking",
+    "color",
+    "disabled",
+    "fetchpriority",
+    "title",
+  ]),
+};
+
+export const link: GetElementSpec = () => linkSpec;

package/src/elements/document-metadata/meta.ts

@@ -0,0 +1,15 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const metaSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "name",
+    "http-equiv",
+    "content",
+    "charset",
+    "media",
+  ]),
+};
+
+export const meta: GetElementSpec = () => metaSpec;

package/src/elements/document-metadata/style.ts

@@ -0,0 +1,14 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const styleSpec: ElementSpec = {
+  contents: [
+    {
+      type: "required",
+      contents: new Set(["#text"]),
+    },
+  ],
+  attributes: contentAttributes(true, ["media", "blocking", "title"]),
+};
+
+export const style: GetElementSpec = () => styleSpec;

package/src/elements/document-metadata/title.ts

@@ -0,0 +1,14 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const titleSpec: ElementSpec = {
+  contents: [
+    {
+      type: "required",
+      contents: new Set(["#text"]),
+    },
+  ],
+  attributes: contentAttributes(true),
+};
+
+export const title: GetElementSpec = () => titleSpec;

package/src/elements/edits/del.ts

@@ -0,0 +1,15 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const delSpec: ElementSpec = {
+  contents: [
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+    },
+  ],
+  attributes: contentAttributes(true, ["cite", "datetime"]),
+};
+
+export const del: GetElementSpec = () => delSpec;

package/src/elements/edits/ins.ts

@@ -0,0 +1,15 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const insSpec: ElementSpec = {
+  contents: [
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+    },
+  ],
+  attributes: contentAttributes(true, ["cite", "datetime"]),
+};
+
+export const ins: GetElementSpec = () => insSpec;

package/src/elements/embedded-content/area.ts

@@ -0,0 +1,19 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const areaSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "alt",
+    "coords",
+    "shape",
+    "href",
+    "target",
+    "download",
+    "ping",
+    "rel",
+    "referrerpolicy",
+  ]),
+};
+
+export const area: GetElementSpec = () => areaSpec;

package/src/elements/embedded-content/audio.ts

@@ -0,0 +1,57 @@
+import { setsToMap } from "../../utils/set";
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const attributes = contentAttributes(true, [
+  "src",
+  "crossorigin",
+  "preload",
+  "autoplay",
+  "loop",
+  "muted",
+  "controls",
+]);
+
+const audioWithSrcSpec: ElementSpec = {
+  contents: [
+    {
+      type: "zeroOrMore",
+      contents: new Set(["track"]),
+    },
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+    },
+  ],
+  attributes,
+};
+
+const audioWithoutSrcSpec: ElementSpec = {
+  contents: [
+    {
+      type: "zeroOrMore",
+      contents: new Set("source"),
+    },
+    {
+      type: "zeroOrMore",
+      contents: new Set("track"),
+    },
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+      constraints: {
+        descendants: setsToMap({ disallow: true }, contents.mediaElements),
+      },
+    },
+  ],
+  attributes,
+};
+
+export const audio: GetElementSpec = (state) => {
+  const attributes = state?.attributes || {};
+  if (!!attributes["src"]) {
+    return audioWithSrcSpec;
+  }
+  return audioWithoutSrcSpec;
+};

package/src/elements/embedded-content/embed.ts

@@ -0,0 +1,9 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const embedSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, ["src", "type", "width", "height"]),
+};
+
+export const embed: GetElementSpec = () => embedSpec;

package/src/elements/embedded-content/iframe.ts

@@ -0,0 +1,20 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const iframeSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "src",
+    "srcdoc",
+    "name",
+    "sandbox",
+    "allow",
+    "allowfullscreen",
+    "width",
+    "height",
+    "referrerpolicy",
+    "loading",
+  ]),
+};
+
+export const iframe: GetElementSpec = () => iframeSpec;

package/src/elements/embedded-content/img.ts

@@ -0,0 +1,23 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const imgSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "alt",
+    "src",
+    "srcset",
+    "sizes",
+    "crossorigin",
+    "usemap",
+    "ismap",
+    "width",
+    "height",
+    "referrerpolicy",
+    "decoding",
+    "loading",
+    "fetchpriority",
+  ]),
+};
+
+export const img: GetElementSpec = () => imgSpec;

package/src/elements/embedded-content/map.ts

@@ -0,0 +1,15 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const mapSpec: ElementSpec = {
+  contents: [
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+    },
+  ],
+  attributes: contentAttributes(true, ["name"]),
+};
+
+export const map: GetElementSpec = () => mapSpec;

package/src/elements/embedded-content/object.ts

@@ -0,0 +1,22 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const objectSpec: ElementSpec = {
+  contents: [
+    {
+      type: "oneOrMore",
+      contents: contents.transparentContent,
+    },
+  ],
+  attributes: contentAttributes(true, [
+    "data",
+    "type",
+    "name",
+    "form",
+    "width",
+    "height",
+  ]),
+};
+
+export const object: GetElementSpec = () => objectSpec;

package/src/elements/embedded-content/picture.ts

@@ -0,0 +1,31 @@
+import { contents } from "../common/contents";
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const pictureSpec: ElementSpec = {
+  contents: [
+    {
+      type: "zeroOrMore",
+      contents: contents.scriptSupportingElements,
+    },
+    {
+      type: "zeroOrMore",
+      contents: new Set(["source"]),
+    },
+    {
+      type: "zeroOrMore",
+      contents: contents.scriptSupportingElements,
+    },
+    {
+      type: "required",
+      contents: new Set(["img"]),
+    },
+    {
+      type: "zeroOrMore",
+      contents: contents.scriptSupportingElements,
+    },
+  ],
+  attributes: contentAttributes(true),
+};
+
+export const picture: GetElementSpec = () => pictureSpec;

package/src/elements/embedded-content/source.ts

@@ -0,0 +1,17 @@
+import { ElementSpec, GetElementSpec } from "../types";
+import { contentAttributes } from "../utils/contentAttributes";
+
+const sourceSpec: ElementSpec = {
+  contents: null,
+  attributes: contentAttributes(true, [
+    "type",
+    "media",
+    "src",
+    "srcset",
+    "sizes",
+    "width",
+    "height",
+  ]),
+};
+
+export const source: GetElementSpec = () => sourceSpec;