@transclude/core 0.5.0 → 0.6.0

package/bin/build.js

@@ -24,6 +24,7 @@ import { sitemap } from '../src/sitemap.js';
 import { etagOf, loadAssets, loadStatic } from '../src/static-cache.js';
 import { buildSprite, readLibraries, refuseSpriteClash, spritePath } from '../src/icons.js';
 import { PRECACHE_PATH, precacheDocument, precacheList } from '../src/precache.js';
+import { speculateSettings, speculationRules } from '../src/speculate.js';
 import { cookiesOf } from '../src/cookies.js';
 import { pool } from '../src/pool.js';
 import { precompress } from '../src/compress.js';
@@ -171,6 +172,7 @@ async function render(route, { url, params }) {
     stylesheet,
     csp: config.csp,
     lang: config.lang,
+    speculate: speculateRules,
     include,
   });
 
@@ -240,6 +242,32 @@ if (manifest.error) {
   });
 }
 
+// ---- speculation rules ------------------------------------------------------
+//
+// Before the render, because every page carries the block and the pages are
+// about to be rendered. The URLs are already known: `targets` is what will be
+// written and `dynamic` is what will not, and a target that then fails to render
+// fails the build rather than leaving a rule pointing at nothing.
+//
+// Computed once and carried in the manifest, so the server rendering the dynamic
+// routes sends the same block the files carry. Two computations is two answers
+// to what a browser may prerender, and only one of them was ever checked.
+//
+// The split is the whole point. A file has no loader left to run, so
+// prerendering it is free. A server render's loader may read a cookie or count a
+// view, so the browser may fetch that and not run it. The 404 and 500 pages
+// carry a `file` rather than a route URL, which is what keeps them out of both.
+const speculate = speculateSettings(config.speculate);
+const speculateRules = speculate
+  ? speculationRules(
+      {
+        prerendered: targets.filter((entry) => !entry.file).map((entry) => entry.target.url),
+        dynamic: dynamic.map((route) => route.pattern),
+      },
+      speculate,
+    )
+  : null;
+
 const CONCURRENCY = Number(process.env.TRANSCLUDE_BUILD_CONCURRENCY ?? 8);
 
 const outcomes = await pool(targets, CONCURRENCY, async ({ route, target, file, label }) => {
@@ -256,7 +284,6 @@ const outcomes = await pool(targets, CONCURRENCY, async ({ route, target, file,
 
 const failures = outcomes.filter((outcome) => !outcome.ok);
 const prerendered = outcomes.filter((outcome) => outcome.ok).map((outcome) => outcome.url);
-
 // A file, like every other page. The served route answers the same document, but
 // `dist/static` is meant to be servable by a host that runs none of this, and a
 // site with no sitemap there would be missing one only on the host that needs it
@@ -309,6 +336,9 @@ fs.writeFileSync(
       notFound: manifest.notFound ? { id: manifest.notFound.id } : null,
       error: manifest.error ? { id: manifest.error.id } : null,
       stylesheet,
+      // Carried rather than recomputed. The server renders the routes that are
+      // not files, and those pages have to say what the files say.
+      speculate: speculateRules,
     },
     null,
     2,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transclude/core",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "An HTML-first server framework. A page is an .html file, the directory tree is the route table, and any fragment of a page is a URL of its own. Runs on Node, Bun, Deno and workerd, and ships no client JavaScript by default.",
   "keywords": [
     "html",

package/skills/transclude/SKILL.md

@@ -225,6 +225,12 @@ on something inside it.
 into the DOM it already rendered and never replaces a child. That is a compile
 error naming `shadow`. Add `export const shadow = true` or keep the list still.
 
+**A dialog does not need a click handler.** `command` and `commandfor` are the
+platform's invoker: `<button command="show-modal" commandfor="prefs">` opens
+`<dialog id="prefs">` with no script. Writing a listener for this is the common
+mistake, and it loses the keyboard and screen reader behavior the attributes
+already carry.
+
 **`setHTMLUnsafe()`, never `innerHTML`.** `innerHTML` does not process nested
 declarative shadow roots, so a child element becomes a dead `<template>`.
 

package/skills/transclude/references/elements.md

@@ -125,6 +125,35 @@ schedules the render, the way an attribute change does for a prop.
 </script>
 ```
 
+## Styling on state
+
+A boolean state field is reflected as a custom state, so CSS can select it. No
+attribute is written and no class is added, which is the point: the document
+still cannot read the state, and a stylesheet still reacts to it.
+
+```html
+<script state>
+  export default {
+    hot: false,
+  };
+</script>
+
+<style>
+  :scope:state(hot) output {
+    color: #b4232c;
+  }
+</style>
+
+<output>${n}</output>
+```
+
+Booleans only. A custom state is a name and not a value, so a number or a string
+has nothing to select on. The state lands with the render rather than with the
+assignment, so `await element.updateComplete` before asserting on it.
+
+Nothing is reflected on the server. A state field starts at the default its
+block declares, so the first paint is that default either way.
+
 ## Behavior
 
 A plain `<script>` block is the element's own code. `host` is the element,

package/skills/transclude/references/server.md

@@ -94,6 +94,7 @@ Source is JavaScript with JSDoc. Do not convert it to TypeScript.
 | `strict` | `false` | Full TypeScript strictness. |
 | `csrf` | `true` | `false` to turn it off, or an object for `hono/csrf`. |
 | `csp` | `false` | `true`, or `{ directives, reportOnly }`. |
+| `speculate` | `false` | `true` emits speculation rules. See below. |
 | `cookieSecret` | `null` | Signs cookies. |
 | `fragmentParam` | `'fragment'` | The query parameter that asks for a fragment. |
 | `fragmentHeader` | `null` | A request header that may name one. Adds it to `Vary`. |
@@ -106,6 +107,27 @@ Source is JavaScript with JSDoc. Do not convert it to TypeScript.
 | `precache` | `false` | `true` writes `/precache.json`. |
 | `onError` | `null` | `(error, { request, url, method })` per failed request. |
 
+
+### speculate
+
+`true` writes a `<script type="speculationrules">` block into every page, so the
+browser can fetch or render the next document before the reader clicks. No
+JavaScript of the framework's is involved.
+
+The split matters and the build decides it. A URL prerendered to a file has no
+loader left to run, so it goes in `prerender`. Every route the server still
+renders goes in `prefetch` only, because its loader may read a cookie or count a
+view and a prerender would run that for a reader who never clicked. Endpoints are
+in neither.
+
+```js
+speculate: { eagerness: 'moderate', exclude: ['/logout'] }
+```
+
+`eagerness` defaults to `moderate`, which waits for a hover. `exclude` is matched
+against the emitted pattern, so a route `/docs/:path{.+}` is excluded as
+`/docs/*`.
+
 ## The build
 
 ```sh

package/src/app.js

@@ -340,6 +340,9 @@ export function createApp({
                 stylesheet: manifest.stylesheet,
                 csp: config.csp,
                 lang: config.lang,
+                // Written by the build and carried here, so a server-rendered
+                // page says the same thing about speculation that a file does.
+                speculate: manifest.speculate ?? null,
                 include,
               })
             : await renderFragment(page, ctx, { region: region || null, include });
@@ -408,6 +411,7 @@ export function createApp({
             stylesheet: manifest.stylesheet,
             csp: config.csp,
             lang: config.lang,
+            speculate: manifest.speculate ?? null,
             include,
           });
 

package/src/document.js

@@ -566,13 +566,14 @@ export function methodsOf(page) {
  *
  * @param {object[]} chain the compiled modules, outermost first
  * @param {object[]} datas one per level, in the same order
- * @param {{ clientEntry?: string|null, stylesheet?: string|null, lang?: string }} [options]
+ * @param {{ clientEntry?: string|null, stylesheet?: string|null, lang?: string,
+ *   speculate?: string|null }} [options]
  * @returns {string} the document, starting at `<!doctype html>`
  */
 export function renderDocument(
   chain,
   datas,
-  { clientEntry, stylesheet, lang = 'en' } = {},
+  { clientEntry, stylesheet, lang = 'en', speculate = null } = {},
 ) {
   // Each level renders to a slot map and hands it to the level above, so a page
   // can fill more than one hole in its layout.
@@ -641,6 +642,7 @@ ${openTag('html', { lang, ...attrsOf(chain, datas, 'renderHtmlAttrs') })}
 <meta charset="utf-8">
 ${defaults}
 ${title}
+${speculate ? `<script type="speculationrules">${speculate}</script>` : ''}
 ${headScripts.join('\n')}
 ${stylesheet ? `<link rel="stylesheet" href="${stylesheet}">` : ''}
 ${head.join('\n')}

package/src/project.js

@@ -96,6 +96,7 @@ const DEFAULTS = {
   strict: false,
   csrf: true,
   csp: false,
+  speculate: false,
 };
 
 /**

package/src/runtime/index.js

@@ -986,7 +986,10 @@ export function defineLight(def, init) {
 
     constructor() {
       super();
-      if (def.formAssociated) this.#internals = this.attachInternals();
+      // Also when a boolean state can be reflected. Narrow on purpose: internals
+      // is attached for the thing that needs it and not for every element that
+      // happens to hold a number.
+      if (def.formAssociated || hasCustomStates(def)) this.#internals = this.attachInternals();
     }
 
     get internals() {
@@ -1059,6 +1062,9 @@ export function defineLight(def, init) {
 
     #data(raw) {
       this.#was = { ...stateOf(this, def.stateDefs) };
+      // The one place both classes work out current state, so the one place a
+      // custom state can be kept true without a third copy of the rule.
+      reflectStates(this.#internals, def.stateDefs, this.#was);
       return { ...this.#was, ...def.coerce(raw) };
     }
 
@@ -1088,6 +1094,41 @@ function hasMembers(def) {
   return Object.keys(def.members ?? {}).length > 0;
 }
 
+/**
+ * A boolean state field, as a custom state CSS can select.
+ *
+ * `:state(open)` rather than an attribute, which is the whole reason state is
+ * not in the document: the page has no business reading it, and CSS still has
+ * to be able to react to it. Booleans only, because a custom state is a name
+ * and not a value.
+ *
+ * Nothing is reflected on the server. A state field always starts at its
+ * declared default, so the first paint is the default either way and there was
+ * never anything for the markup to say.
+ */
+function reflectStates(internals, defs, state) {
+  if (!internals?.states) return;
+
+  for (const name of Object.keys(defs ?? {})) {
+    const value = state[name];
+    if (typeof value !== 'boolean') continue;
+
+    if (value) internals.states.add(name);
+    else internals.states.delete(name);
+  }
+}
+
+/**
+ * Whether any state field is declared a boolean.
+ *
+ * The declared default decides, at define time. A custom state is a name and
+ * not a value, so a number or a string has nothing to reflect, and an element
+ * holding only those is left without internals it would never use.
+ */
+function hasCustomStates(def) {
+  return Object.values(def.stateDefs ?? {}).some((value) => typeof value === 'boolean');
+}
+
 /** State counts as behavior: its accessors are the only way to change it. */
 function hasState(def) {
   return Object.keys(def.stateDefs ?? {}).length > 0;
@@ -1202,7 +1243,10 @@ export function defineComponent(def, init) {
       super();
       // In the constructor, which is where it belongs and where it can only
       // happen once. For a server-rendered element that is upgrade time.
-      if (def.formAssociated) this.#internals = this.attachInternals();
+      // Also when a boolean state can be reflected. Narrow on purpose: internals
+      // is attached for the thing that needs it and not for every element that
+      // happens to hold a number.
+      if (def.formAssociated || hasCustomStates(def)) this.#internals = this.attachInternals();
     }
 
     /** What this element would submit, if it is a control. */
@@ -1308,6 +1352,9 @@ export function defineComponent(def, init) {
      *  be hidden by one. The compiler rejects that clash anyway. */
     #data(raw) {
       this.#was = { ...stateOf(this, def.stateDefs) };
+      // The one place both classes work out current state, so the one place a
+      // custom state can be kept true without a third copy of the rule.
+      reflectStates(this.#internals, def.stateDefs, this.#was);
       return { ...this.#was, ...def.coerce(raw) };
     }
 

package/src/speculate.js

@@ -0,0 +1,103 @@
+// What the browser may fetch, or run, before the reader clicks.
+//
+// This framework ships no client router: every link is a document request. That
+// is the whole bet, and the cost of it is one round trip per navigation.
+// Speculation rules are the platform's answer, and they cost no JavaScript of
+// ours: a JSON block in the head, and the browser decides.
+//
+// The part worth writing down is what must *not* be speculated. A prerender
+// runs the page. A route this build wrote to a file has no loader left to run,
+// so prerendering it is free and safe. Everything else is a server render whose
+// loader may read a cookie, count a view or hand out a one-time token, and
+// prerendering that for a reader who never clicked is wrong rather than slow.
+// The build knows which is which. A hand-written rules block does not.
+//
+// No `node:` imports. The build calls this with the lists it already holds.
+
+/** What the spec allows, so a typo is caught here rather than ignored by Chrome. */
+const EAGERNESS = new Set(['immediate', 'eager', 'moderate', 'conservative']);
+
+/**
+ * A route pattern as something `href_matches` understands.
+ *
+ * Hono writes `/docs/:path{.+}` and `/people/:name`. Both become `*`: the regex
+ * half is Hono's own spelling and means nothing to a URL pattern, and a rule
+ * that matches too little is a missed prefetch while one that matches too much
+ * speculates a URL that 404s.
+ *
+ * @param {string} pattern
+ * @returns {string}
+ */
+export function hrefPattern(pattern) {
+  return pattern.replace(/:[A-Za-z0-9_]+(\{[^}]*\})?/g, '*');
+}
+
+/** `{ href_matches }` for each, or null when there is nothing to match. */
+function where(patterns) {
+  if (!patterns.length) return null;
+  return { or: patterns.map((pattern) => ({ href_matches: pattern })) };
+}
+
+/**
+ * The `<script type="speculationrules">` body for a site, or null.
+ *
+ * Two lists, because they are two different promises. `prerendered` is every URL
+ * written to a file, and the browser may run those. `dynamic` is every route the
+ * server still renders, and the browser may only fetch those: the response is
+ * the same document a click would have got, and no page script runs early.
+ *
+ * Endpoints are in neither. A `.js` route answers with whatever it builds, and
+ * speculating one spends a request on something no navigation will reuse.
+ *
+ * @param {object} site
+ * @param {string[]} [site.prerendered] URLs written to a file
+ * @param {string[]} [site.dynamic] route patterns the server renders
+ * @param {object} [options]
+ * @param {string[]} [options.exclude] patterns to leave out of both
+ * @param {string} [options.eagerness] how soon the browser may act
+ * @returns {string|null} JSON, or null when nothing is speculated
+ * @throws when `eagerness` is not one the spec names
+ */
+export function speculationRules({ prerendered = [], dynamic = [] }, options = {}) {
+  const { exclude = [], eagerness = 'moderate' } = options;
+
+  if (!EAGERNESS.has(eagerness)) {
+    throw new Error(
+      `[transclude] speculate.eagerness is ${JSON.stringify(eagerness)}. ` +
+        `It is one of ${[...EAGERNESS].join(', ')}.`,
+    );
+  }
+
+  const excluded = new Set(exclude);
+  const keep = (pattern) => !excluded.has(pattern);
+
+  // Sorted and deduplicated, so two builds of one site produce the same bytes
+  // and the CSP hash of this block does not change for no reason.
+  const clean = (list) => [...new Set(list)].filter(keep).sort();
+
+  const rules = {};
+  // A prerendered URL is already a URL. A route is a pattern, and `exclude` is
+  // matched against what comes out, so what an author writes is what they read
+  // in the emitted rules.
+  const run = where(clean(prerendered));
+  const fetchOnly = where(clean(dynamic.map(hrefPattern)));
+
+  if (run) rules.prerender = [{ where: run, eagerness }];
+  if (fetchOnly) rules.prefetch = [{ where: fetchOnly, eagerness }];
+
+  return run || fetchOnly ? JSON.stringify(rules) : null;
+}
+
+/**
+ * `speculate` as `{ exclude, eagerness }`, or null for off.
+ *
+ * Off by default, like every other thing here that changes what a browser is
+ * told to do. `true` is the defaults.
+ *
+ * @param {boolean|object} [setting]
+ * @returns {object|null}
+ */
+export function speculateSettings(setting) {
+  if (!setting) return null;
+  return setting === true ? {} : setting;
+}