hyper-html-api 0.12.0 → 0.14.0

package/README.md

@@ -91,7 +91,10 @@ HyperHtmlApi.upgrade.run({ sourceUrl?, dataByName?, fromVersion? })
 
 The join is name-match per rules tag: fields present in both carry over, fields
 only in the old data are discarded (and counted in `summary`), fields only in
-the new template keep its defaults, and list counts follow the old data. For
+the new template keep its defaults, and list counts follow the old data. A list
+item is the exception to defaults: it is the owner's own row, so a field the new
+template adds inside a list item starts empty (a list starts with no items)
+instead of taking the value of the template's sample item. For
 richer migrations (renames, splits, computed fields) the source declares a
 transform as a non-executing script tag in its own HTML:
 

package/conformance/MANIFEST.json

@@ -1,6 +1,6 @@
 {
-  "engine": "0.11.2",
+  "engine": "0.13.0",
   "cheerio": "1.2.0",
-  "cases": 77,
+  "cases": 89,
   "note": "Versions the expectations were generated against. Parity means parity with THIS pair; regenerate deliberately, never as a side effect of an install."
 }

package/conformance/cases/all-matches-read-quoted.expected.json

@@ -0,0 +1,3 @@
+{
+  "name": "Hyper"
+}

package/conformance/cases/all-matches-read-quoted.html

@@ -0,0 +1,5 @@
+<!doctype html><html><body>
+<header><span class="site-name">Hyper</span></header>
+<footer><span class="site-name">Old Hyper</span></footer>
+<script data-rules-name="api" data-rules-version="1">{"name": "span.site-name[*]"}</script>
+</body></html>

package/conformance/cases/all-matches-read-quoted.meta

@@ -0,0 +1,7 @@
+tier: 1
+face: tag
+token: api
+expect: ok
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: The [*] marker is not a quote-level token: a strict JSON quoted rule value lands on the
+note: same parse tree as the relaxed unquoted spelling in all-matches-read.

package/conformance/cases/all-matches-read-quoted.parsed.json

@@ -0,0 +1,3 @@
+{
+  "name": "span.site-name[*]"
+}

package/conformance/cases/all-matches-read.expected.json

@@ -0,0 +1,3 @@
+{
+  "name": "Hyper"
+}

package/conformance/cases/all-matches-read.html

@@ -0,0 +1,6 @@
+<!doctype html><html><body>
+<header><span class="site-name">Hyper</span></header>
+<main><h1>Hello</h1></main>
+<footer><span class="site-name">Old Hyper</span></footer>
+<script data-rules-name="api" data-rules-version="1">{name:"span.site-name[*]"}</script>
+</body></html>

package/conformance/cases/all-matches-read.meta

@@ -0,0 +1,7 @@
+tier: 1
+face: tag
+token: api
+expect: ok
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: The [*] marker belongs to the write face: extraction still reports the first match under
+note: an ordinary key, so a [*] rule reads like the same rule without the marker.

package/conformance/cases/all-matches-read.parsed.json

@@ -0,0 +1,3 @@
+{
+  "name": "span.site-name[*]"
+}

package/conformance/cases/stylevar-read.expected.json

@@ -0,0 +1,12 @@
+{
+  "accent": "#3b82f6",
+  "gap": "2rem",
+  "font": "\"Inter\", sans-serif",
+  "quoted": "\"a;b\"",
+  "bracketed": "rgb(1 2 3 / 50%)",
+  "lower": "red",
+  "upper": "blue",
+  "empty": "",
+  "missing": null,
+  "absent": null
+}

package/conformance/cases/stylevar-read.html

@@ -0,0 +1,7 @@
+<!doctype html><html style="color: black; --color-accent: #3b82f6"><body>
+<div id="d" style="--gap:1rem; --gap: 2rem !important; --gap: 3rem"></div>
+<p id="p" style="/* theme */ --font-body: &quot;Inter&quot;, sans-serif"></p>
+<i id="q" style='--q: "a;b"; --r: rgb(1 2 3 / 50%)'></i>
+<b id="c" style="--BG: blue; --bg: red; --empty:"></b>
+<span id="s"></span>
+</body></html>

package/conformance/cases/stylevar-read.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: query
+expect: ok
+note: `@--name` reads one custom property from the style attribute. The last declaration wins
+note: unless an earlier one is !important; comments are ignored; names are case sensitive; a
+note: semicolon inside quotes or brackets does not end a declaration; absent reads null.

package/conformance/cases/stylevar-read.parsed.json

@@ -0,0 +1,12 @@
+{
+  "accent": "html@--color-accent",
+  "gap": "#d@--gap",
+  "font": "#p@--font-body",
+  "quoted": "#q@--q",
+  "bracketed": "#q@--r",
+  "lower": "#c@--bg",
+  "upper": "#c@--BG",
+  "empty": "#c@--empty",
+  "missing": "#s@--x",
+  "absent": "#d@--nope"
+}

package/conformance/cases/stylevar-read.rules

@@ -0,0 +1 @@
+{"accent":"html@--color-accent","gap":"#d@--gap","font":"#p@--font-body","quoted":"#q@--q","bracketed":"#q@--r","lower":"#c@--bg","upper":"#c@--BG","empty":"#c@--empty","missing":"#s@--x","absent":"#d@--nope"}

package/conformance/cases/write-all-matches-attr.after.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{home:"a.home[*]@href"}</script><nav><a class="home" href="/start">Home</a><a class="home" href="/start">About</a></nav>

package/conformance/cases/write-all-matches-attr.after.json

@@ -0,0 +1,3 @@
+{
+  "home": "/start"
+}

package/conformance/cases/write-all-matches-attr.data.json

@@ -0,0 +1 @@
+{"home":"/start"}

package/conformance/cases/write-all-matches-attr.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{home:"a.home[*]@href"}</script><nav><a class="home" href="/">Home</a><a class="home" href="/about">About</a></nav>

package/conformance/cases/write-all-matches-attr.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: write
+expect: ok
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: The marker goes on the selector, before the @prop separator, and every match's attribute
+note: is written.

package/conformance/cases/write-all-matches-attr.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": true,
+  "spliced": true
+}

package/conformance/cases/write-all-matches-group.after.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{title:"title, span.site-name[*]"}</script><title>New title</title><header><span class="site-name">New title</span></header><footer><span class="site-name">New title</span></footer>

package/conformance/cases/write-all-matches-group.after.json

@@ -0,0 +1,3 @@
+{
+  "title": "New title"
+}

package/conformance/cases/write-all-matches-group.data.json

@@ -0,0 +1 @@
+{"title":"New title"}

package/conformance/cases/write-all-matches-group.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{title:"title, span.site-name[*]"}</script><title>Old title</title><header><span class="site-name">Old name</span></header><footer><span class="site-name">Old name</span></footer>

package/conformance/cases/write-all-matches-group.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: write
+expect: ok
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: The marker does not cover the whole group: it covers only the last selector in it, so
+note: title is written once and both .site-name matches are written.

package/conformance/cases/write-all-matches-group.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": true,
+  "spliced": true
+}

package/conformance/cases/write-all-matches-text.after.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{name:"span.site-name[*]"}</script><header><span class="site-name">Hyper</span></header><footer><span class="site-name">Hyper</span></footer>

package/conformance/cases/write-all-matches-text.after.json

@@ -0,0 +1,3 @@
+{
+  "name": "Hyper"
+}

package/conformance/cases/write-all-matches-text.data.json

@@ -0,0 +1 @@
+{"name":"Hyper"}

package/conformance/cases/write-all-matches-text.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{name:"span.site-name[*]"}</script><header><span class="site-name">Old name</span></header><footer><span class="site-name">Old name</span></footer>

package/conformance/cases/write-all-matches-text.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: write
+expect: ok
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: A [*] text rule writes every match of its selector, not just the first: this is how a
+note: site's shared value reaches every page element that shows it.

package/conformance/cases/write-all-matches-text.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": true,
+  "spliced": true
+}

package/conformance/cases/write-all-matches-unmatched.data.json

@@ -0,0 +1 @@
+{"name":"Hyper"}

package/conformance/cases/write-all-matches-unmatched.error.json

@@ -0,0 +1,14 @@
+{
+  "type": "WriteRejected",
+  "message": "write rejected: 0 unknown key(s), 1 rule(s) with no matching element",
+  "status": 400,
+  "details": {
+    "unknownKeys": [],
+    "unmatched": [
+      {
+        "path": "name",
+        "selector": ".missing"
+      }
+    ]
+  }
+}

package/conformance/cases/write-all-matches-unmatched.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{name:".missing[*]"}</script><header><span class="site-name">Old name</span></header>

package/conformance/cases/write-all-matches-unmatched.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: write
+expect: error
+skip: htmlclay=all-matches form not ported yet (multi-page sites release 1, step G1)
+note: Zero matches is still zero matches: the marker says "all of them", not "at least one",
+note: and the rejection reports the selector without the marker.

package/conformance/cases/write-refused-raw-style.data.json

@@ -0,0 +1 @@
+{"s":"--x: red"}

package/conformance/cases/write-refused-raw-style.error.json

@@ -0,0 +1,11 @@
+{
+  "type": "WriteRefused",
+  "message": "write refused: 1 write(s) broke the content-only policy",
+  "status": 400,
+  "details": [
+    {
+      "target": "<div#d>",
+      "reason": "attribute \"style\" is not content"
+    }
+  ]
+}

package/conformance/cases/write-refused-raw-style.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{s:"#d@style"}</script><div id=d style="color: red"></div>

package/conformance/cases/write-refused-raw-style.meta

@@ -0,0 +1,4 @@
+tier: 1
+face: write
+expect: error
+note: A raw `@style` write stays refused; only `@--name` reaches the style attribute.

package/conformance/cases/write-refused-stylevar-values.data.json

@@ -0,0 +1 @@
+{"a": "Url(https://example.invalid/x)", "b": "red; color: blue", "c": "rgb(1, 2, 3", "d": "\"Inter", "e": "/* c */ red", "f": "red\u0001", "g": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "h": "a)", "i": "<b>"}

package/conformance/cases/write-refused-stylevar-values.error.json

@@ -0,0 +1,43 @@
+{
+  "type": "WriteRefused",
+  "message": "write refused: 9 write(s) broke the content-only policy",
+  "status": 400,
+  "details": [
+    {
+      "target": "<div#d>",
+      "reason": "\"url()\" is not allowed in a custom property value"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "\";\" is not allowed in a custom property value"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "a custom property value must close its brackets"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "a custom property value must close its quotes"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "comments are not allowed in a custom property value"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "control characters are not allowed in a custom property value"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "custom property values are limited to 200 characters"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "\")\" does not close anything in this custom property value"
+    },
+    {
+      "target": "<div#d>",
+      "reason": "\"<\" is not allowed in a custom property value"
+    }
+  ]
+}

package/conformance/cases/write-refused-stylevar-values.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{a:"#d@--a", b:"#d@--b", c:"#d@--c", d:"#d@--d", e:"#d@--e", f:"#d@--f", g:"#d@--g", h:"#d@--h", i:"#d@--i"}</script><div id=d></div>

package/conformance/cases/write-refused-stylevar-values.meta

@@ -0,0 +1,5 @@
+tier: 1
+face: write
+expect: error
+note: Custom property values that could load a resource, close their declaration, carry markup
+note: or break the attribute are refused, one reason per value, in rule order.

package/conformance/cases/write-stylevar-clear.after.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{a:"#a@--gap", b:"#b@--gap"}</script><div id="a"></div><div id="b" style=" color: red"></div>

package/conformance/cases/write-stylevar-clear.after.json

@@ -0,0 +1,4 @@
+{
+  "a": null,
+  "b": null
+}

package/conformance/cases/write-stylevar-clear.data.json

@@ -0,0 +1 @@
+{"a":"","b":""}

package/conformance/cases/write-stylevar-clear.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{a:"#a@--gap", b:"#b@--gap"}</script><div id=a style="--gap: 1rem"></div><div id=b style="--gap:1rem; color: red; --gap: 2rem"></div>

package/conformance/cases/write-stylevar-clear.meta

@@ -0,0 +1,5 @@
+tier: 1
+face: write
+expect: ok
+note: An empty `@--name` write removes every declaration of the property, and the style
+note: attribute itself once nothing is left in it.

package/conformance/cases/write-stylevar-clear.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": true,
+  "spliced": true
+}

package/conformance/cases/write-stylevar-set.after.html

@@ -0,0 +1,2 @@
+<!DOCTYPE html><html style="color: black; --color-accent: #3b82f6"><head><script data-rules-name="api" data-rules-version="1">{accent:"html@--color-accent", gap:"#d@--gap", x:"#e@--x"}</script></head><body><div id="d" style="--gap: 2rem"></div><div id="e" style="--x: c !important; color: red"></div>
+</body></html>

package/conformance/cases/write-stylevar-set.after.json

@@ -0,0 +1,5 @@
+{
+  "accent": "#3b82f6",
+  "gap": "2rem",
+  "x": "c"
+}

package/conformance/cases/write-stylevar-set.data.json

@@ -0,0 +1 @@
+{"accent":"  #3b82f6 ","gap":"2rem","x":"c"}

package/conformance/cases/write-stylevar-set.html

@@ -0,0 +1 @@
+<!doctype html><html style="color: black; --color-accent: red"><head><script data-rules-name="api" data-rules-version="1">{accent:"html@--color-accent", gap:"#d@--gap", x:"#e@--x"}</script></head><body><div id=d></div><div id=e style="--x: a !important; color: red; --x: b"></div></body></html>

package/conformance/cases/write-stylevar-set.meta

@@ -0,0 +1,6 @@
+tier: 1
+face: write
+expect: ok
+note: `@--name` writes rewrite the first declaration in place (keeping !important), drop later
+note: duplicates, append a property not yet present, trim the value, and leave every other
+note: declaration as it was.

package/conformance/cases/write-stylevar-set.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": true,
+  "spliced": false
+}

package/conformance/cases/write-stylevar-unchanged.after.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{bg:"#a@--bg"}</script><div id=a style="--bg: url(a.png)"></div>

package/conformance/cases/write-stylevar-unchanged.after.json

@@ -0,0 +1,3 @@
+{
+  "bg": "url(a.png)"
+}

package/conformance/cases/write-stylevar-unchanged.data.json

@@ -0,0 +1 @@
+{"bg":"url(a.png)"}

package/conformance/cases/write-stylevar-unchanged.html

@@ -0,0 +1 @@
+<script data-rules-name="api" data-rules-version="1">{bg:"#a@--bg"}</script><div id=a style="--bg: url(a.png)"></div>

package/conformance/cases/write-stylevar-unchanged.meta

@@ -0,0 +1,5 @@
+tier: 1
+face: write
+expect: ok
+note: Posting back the value a custom property already has is a no-op, even when the policy
+note: would refuse that value as a new write, so a read posted back unchanged never errors.

package/conformance/cases/write-stylevar-unchanged.write.json

@@ -0,0 +1,4 @@
+{
+  "changed": false,
+  "spliced": true
+}

package/conformance/write-policy.json

@@ -75,5 +75,27 @@
     "javascript",
     "vbscript",
     "data"
-  ]
+  ],
+  "customPropertyValues": {
+    "maxLength": 200,
+    "refusedCharacters": [
+      ";",
+      "{",
+      "}",
+      "<",
+      ">",
+      "\\"
+    ],
+    "refusedFunctions": [
+      "url",
+      "src",
+      "image",
+      "image-set",
+      "-webkit-image-set",
+      "cross-fade",
+      "element",
+      "expression",
+      "paint"
+    ]
+  }
 }