@verajs/renderer 0.1.5 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +975 -27
- package/dist/development/vera-renderer-hydrate.d.ts +32 -13
- package/dist/development/vera-renderer-hydrate.d.ts.map +1 -1
- package/dist/development/vera-renderer-hydrate.js +1786 -231
- package/dist/development/vera-renderer-hydrate.js.map +1 -1
- package/dist/development/vera-renderer-keyed.d.ts +17 -0
- package/dist/development/vera-renderer-keyed.d.ts.map +1 -0
- package/dist/development/vera-renderer-keyed.js +322 -0
- package/dist/development/vera-renderer-keyed.js.map +1 -0
- package/dist/development/vera-renderer-profiler.d.ts +57 -17
- package/dist/development/vera-renderer-profiler.d.ts.map +1 -1
- package/dist/development/vera-renderer-profiler.js +1419 -206
- package/dist/development/vera-renderer-profiler.js.map +1 -1
- package/dist/development/vera-renderer-slots.d.ts +103 -0
- package/dist/development/vera-renderer-slots.d.ts.map +1 -0
- package/dist/development/vera-renderer-slots.js +1387 -0
- package/dist/development/vera-renderer-slots.js.map +1 -0
- package/dist/development/vera-renderer-spread.d.ts +51 -0
- package/dist/development/vera-renderer-spread.d.ts.map +1 -0
- package/dist/development/vera-renderer-spread.js +499 -0
- package/dist/development/vera-renderer-spread.js.map +1 -0
- package/dist/development/vera-renderer-tag.d.ts +61 -0
- package/dist/development/vera-renderer-tag.d.ts.map +1 -0
- package/dist/development/vera-renderer-tag.js +727 -0
- package/dist/development/vera-renderer-tag.js.map +1 -0
- package/dist/development/vera-renderer.d.ts +41 -16
- package/dist/development/vera-renderer.d.ts.map +1 -1
- package/dist/development/vera-renderer.js +1349 -197
- package/dist/development/vera-renderer.js.map +1 -1
- package/dist/vera-renderer-hydrate.min.js +1 -1
- package/dist/vera-renderer-hydrate.min.js.map +1 -1
- package/dist/vera-renderer-keyed.min.js +2 -0
- package/dist/vera-renderer-keyed.min.js.map +1 -0
- package/dist/vera-renderer-slots.min.js +2 -0
- package/dist/vera-renderer-slots.min.js.map +1 -0
- package/dist/vera-renderer-spread.min.js +2 -0
- package/dist/vera-renderer-spread.min.js.map +1 -0
- package/dist/vera-renderer-tag.min.js +2 -0
- package/dist/vera-renderer-tag.min.js.map +1 -0
- package/dist/vera-renderer.min.js +1 -1
- package/dist/vera-renderer.min.js.map +1 -1
- package/package.json +24 -1
|
@@ -1,3 +1,86 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `true ` only: the one home for *"is this value something an attribute can carry?"*
|
|
3
|
+
*
|
|
4
|
+
* **Why it is a closed vocabulary and not a predicate.** The first design asked whether a value
|
|
5
|
+
* stringifies meaningfully — `String(v) === '[object Object]'` means it lost its data. Driven
|
|
6
|
+
* through 16 value shapes rather than reasoned about, that broke four ways, and the first is
|
|
7
|
+
* disqualifying: `String()` THROWS on `Object.create(null)`, on `{ toString: null }`, and on any
|
|
8
|
+
* object whose `toString` throws — so a diagnostic would have killed the page for an author using
|
|
9
|
+
* the recommended dictionary idiom. It also passed `["a","b"]` as `"a,b"` (one junk class, if that
|
|
10
|
+
* was a `class` binding) and `new Date()` as a timezone-bearing string, which is an SSR/CSR
|
|
11
|
+
* divergence manufactured out of correct-looking code. And it passed `Symbol('s')` while
|
|
12
|
+
* `` `${sym}` `` throws — a guard and its sink disagreeing about a single expression.
|
|
13
|
+
*
|
|
14
|
+
* "Does it stringify meaningfully" is an OPEN predicate over an unbounded, environment-dependent
|
|
15
|
+
* space, and open predicates cannot be audited. So the test is inverted and closed: **primitives
|
|
16
|
+
* pass; everything else is reported; anything else that should pass is a named row added on
|
|
17
|
+
* evidence.** The list has exactly one member so far.
|
|
18
|
+
*
|
|
19
|
+
* Credit where it is due: the four breaks were found by the omni engine's session, which drove the
|
|
20
|
+
* shapes rather than arguing about them, and the closed-vocabulary form is theirs.
|
|
21
|
+
*/
|
|
22
|
+
/**
|
|
23
|
+
* Blessed non-primitives — types whose `toString` IS the value the author means.
|
|
24
|
+
*
|
|
25
|
+
* Tested by brand rather than `instanceof`, which is false across realms: a `URL` built in an
|
|
26
|
+
* iframe is not `instanceof` the parent's `URL`, and a diagnostic that fires on a correct value in
|
|
27
|
+
* one frame and not another is worse than none.
|
|
28
|
+
*/
|
|
29
|
+
const brand = (value) => Object.prototype.toString.call(value);
|
|
30
|
+
/** One message per element+name+kind, so a value rebuilt every render does not flood the console. */
|
|
31
|
+
let reported;
|
|
32
|
+
/**
|
|
33
|
+
* Returns the complaint, or `null` when the value is fine. Never throws — the shapes that break a
|
|
34
|
+
* naive guard are exactly the ones worth reporting, so they reach the `object` arm and are named.
|
|
35
|
+
*/
|
|
36
|
+
const attributeValueComplaint = (tag, name, value) => {
|
|
37
|
+
const type = typeof value;
|
|
38
|
+
if (type === 'string' || type === 'number' || type === 'boolean' || type === 'bigint')
|
|
39
|
+
return null;
|
|
40
|
+
if (type === 'object' && brand(value) === '[object URL]')
|
|
41
|
+
return null;
|
|
42
|
+
/**
|
|
43
|
+
* Keyed by BRAND, not by `typeof` — `Date`, `Array` and a plain object are all `'object'`, so a
|
|
44
|
+
* coarser key reported whichever arrived first and silently swallowed the rest. An author who
|
|
45
|
+
* fixed the Date would never have been told about the array.
|
|
46
|
+
*/
|
|
47
|
+
const key = `${tag}|${name}|${type === 'object' ? brand(value) : type}`;
|
|
48
|
+
reported ??= new Set();
|
|
49
|
+
if (reported.has(key))
|
|
50
|
+
return null;
|
|
51
|
+
reported.add(key);
|
|
52
|
+
/**
|
|
53
|
+
* A function into an attribute is never what the author meant, but the REASON matters: on a
|
|
54
|
+
* custom element the Lit-era convention is that complex values are set as properties, so
|
|
55
|
+
* `<my-chart formatter={fn}>` is a coherent intention that this sink simply cannot express. The
|
|
56
|
+
* message names the binding that can, rather than blaming the author.
|
|
57
|
+
*/
|
|
58
|
+
const said = type === 'function'
|
|
59
|
+
? `a function, which becomes its own SOURCE TEXT`
|
|
60
|
+
: type === 'symbol'
|
|
61
|
+
? `a symbol, which every DOM conversion refuses`
|
|
62
|
+
: Array.isArray(value)
|
|
63
|
+
? `an array, which becomes its members joined by commas`
|
|
64
|
+
: brand(value) === '[object Date]'
|
|
65
|
+
? `a Date, whose text carries the TIMEZONE of whichever side rendered it`
|
|
66
|
+
: `an ${type}, which cannot survive as text`;
|
|
67
|
+
/**
|
|
68
|
+
* Returned WITHOUT the `[vera]` prefix, which each call site writes as a literal.
|
|
69
|
+
* `tests/diagnostics-convention.test.mjs` reads the prefix off the call, so a message handed over
|
|
70
|
+
* as a variable is invisible to it — and its answer to that is an allowance list. Taking the
|
|
71
|
+
* allowance would have excused these two calls rather than checked them, which is the
|
|
72
|
+
* reclassification this audit keeps refusing; the literal at the call site is what every other
|
|
73
|
+
* diagnostic in the repo does anyway.
|
|
74
|
+
*/
|
|
75
|
+
return (`renderer: the attribute \`${name}\` on <${tag}> was given ${said}. ` +
|
|
76
|
+
`An attribute value is a string and nothing else.\n` +
|
|
77
|
+
`If the element is meant to RECEIVE this value, bind a property instead — \`.${name}=\${value}\` ` +
|
|
78
|
+
`— which is how a custom element takes anything that is not text. If it is meant to be read as ` +
|
|
79
|
+
`text, convert it where you know what it means: \`date.toISOString()\`, \`list.join(' ')\`. ` +
|
|
80
|
+
`A Date in particular serializes with the SERVER's timezone on one side and the browser's on ` +
|
|
81
|
+
`the other, so it will not survive hydration.`);
|
|
82
|
+
};
|
|
83
|
+
|
|
1
84
|
/**
|
|
2
85
|
* @verajs/renderer — a ground-up, keyed, template-identity renderer.
|
|
3
86
|
*
|
|
@@ -57,18 +140,6 @@
|
|
|
57
140
|
* deliberately do not match the pattern: the first is an interop wire format, the second is called
|
|
58
141
|
* by the DOM itself.
|
|
59
142
|
*/
|
|
60
|
-
/**
|
|
61
|
-
* Marks a template result with a stable key so list reconciliation moves it instead of rewriting
|
|
62
|
-
* it. Key all items in a list or none — mixing is undefined behaviour, as are duplicate keys.
|
|
63
|
-
*
|
|
64
|
-
* ```js
|
|
65
|
-
* rows.map((r) => keyed(r.id, html`<tr>...</tr>`))
|
|
66
|
-
* ```
|
|
67
|
-
*/
|
|
68
|
-
const keyed = (key, result) => {
|
|
69
|
-
result.key = key;
|
|
70
|
-
return result;
|
|
71
|
-
};
|
|
72
143
|
/**
|
|
73
144
|
* Preserves the DOM of templates a child position toggles away from, instead of destroying it —
|
|
74
145
|
* form values, scroll positions and media playback survive the round trip (lit-html calls this
|
|
@@ -77,12 +148,22 @@ const keyed = (key, result) => {
|
|
|
77
148
|
* ```js
|
|
78
149
|
* html`<div>${hold(editing ? editor() : viewer())}</div>`
|
|
79
150
|
* ```
|
|
151
|
+
*
|
|
152
|
+
* **Anything that is not a template passes straight through.** There is nothing to park for a
|
|
153
|
+
* string, a list, `null` or `false`, and the branch that produces one is the ordinary shape of the
|
|
154
|
+
* expression this wraps — `hold(editing && editor())`, `hold(row ?? null)`. Wrapping those handed
|
|
155
|
+
* the renderer a `{ $h }` carrying a non-template, which reached the held-commit path and threw on
|
|
156
|
+
* `result.strings`: a whole render lost, from a value the same expression renders happily one
|
|
157
|
+
* character to the left. Decided here rather than in the renderer so the hot path pays nothing.
|
|
80
158
|
*/
|
|
81
|
-
const hold = (result) =>
|
|
159
|
+
const hold = (result) => result != null && typeof result === 'object' && isTemplateResult(result)
|
|
160
|
+
? { $h: result }
|
|
161
|
+
: result;
|
|
82
162
|
/**
|
|
83
163
|
* Unique per module load, so user text can never collide with it. Randomness here cannot break
|
|
84
164
|
* template caching — the marker only ever pairs a scan with its own Template construction.
|
|
85
165
|
*/
|
|
166
|
+
|
|
86
167
|
const MARKER = '$v' + ((Math.random() * 1e9) >>> 0).toString(36) + '$';
|
|
87
168
|
/** `<?xyz>` parses as a bogus comment whose data is `?xyz`. */
|
|
88
169
|
const MARKER_COMMENT_DATA = '?' + MARKER;
|
|
@@ -103,7 +184,37 @@ const markerWalker = doc.createTreeWalker(doc, 129 /* ELEMENT | COMMENT */);
|
|
|
103
184
|
* TreeWalker allocation per instance, which is 10 000 allocations in a 10 000-row create.
|
|
104
185
|
*/
|
|
105
186
|
const instanceWalker = doc.createTreeWalker(doc, 5 /* ELEMENT | TEXT */);
|
|
106
|
-
|
|
187
|
+
/**
|
|
188
|
+
* Elements whose children a parser reads as **text**, so a marker written inside one arrives as
|
|
189
|
+
* characters rather than a comment and the binding never becomes a part.
|
|
190
|
+
*
|
|
191
|
+
* `iframe` and `noscript` were missing, and both were measured broken in a browser rather than
|
|
192
|
+
* reasoned about: `html\`<iframe>${v}</iframe>\`` painted the literal marker — `<?$v8hpsho$>` — onto
|
|
193
|
+
* the page in **all three engines** and never updated.
|
|
194
|
+
*
|
|
195
|
+
* **`noscript` is the one worth the comment, because the engines disagree.** A template's contents
|
|
196
|
+
* are parsed with the scripting flag *disabled*, which is what decides whether `noscript` is raw
|
|
197
|
+
* text — and Chromium and WebKit parse it as markup there while Firefox parses it as text. So
|
|
198
|
+
* `html\`<noscript>${v}</noscript>\`` worked in two engines and painted the marker in the third: an
|
|
199
|
+
* app developed in Chrome shipping the framework's internals onto the page for Firefox users.
|
|
200
|
+
*
|
|
201
|
+
* Listing it here is safe in both parses. Where the marker became a comment the raw-text branch does
|
|
202
|
+
* not trigger, because it looks for the marker in `textContent` and finds none.
|
|
203
|
+
*/
|
|
204
|
+
const RAW_TEXT_TAGS = /^(?:script|style|textarea|title|iframe|noscript)$/i;
|
|
205
|
+
/**
|
|
206
|
+
* The void elements, as a regex rather than the `Set` in `@verajs/shared-utils`, and NOT imported
|
|
207
|
+
* from it — measured: an imported `new Set([...])` survives production because neither rollup nor
|
|
208
|
+
* terser can prove the constructor call is side-effect-free, so it sat at module scope costing
|
|
209
|
+
* **62 B gzipped on the base bundle** for a diagnostic production does not even run. A regex
|
|
210
|
+
* literal read only by `warnTagShape` goes when that dead function goes.
|
|
211
|
+
*
|
|
212
|
+
* So this is a second home for a fact `@verajs/shared-utils` owns, kept deliberately and in a
|
|
213
|
+
* different SHAPE because a hot file's byte budget forbids the shared one. That is only acceptable
|
|
214
|
+
* with an enforcer: `tests/markup-grammar-homes.test.mjs` drives this regex and the canonical set
|
|
215
|
+
* against each other, member by member, in both directions.
|
|
216
|
+
*/
|
|
217
|
+
const VOID_TAGS = /^(?:area|base|br|col|embed|hr|img|input|link|meta|param|source|track|wbr)$/i;
|
|
107
218
|
const ATTR_NAME_DELIMITER = /[\s"'>=/]/;
|
|
108
219
|
/** What an expression position turned out to be. */
|
|
109
220
|
const CHILD = 0;
|
|
@@ -123,7 +234,31 @@ const IN_BOUND_VALUE = 5; // collecting a bound attribute's statics
|
|
|
123
234
|
* A small state machine rather than tail regexes, because `>` inside quoted attribute values and
|
|
124
235
|
* inside comments must not terminate a tag, and raw-text elements swallow markup.
|
|
125
236
|
*/
|
|
126
|
-
|
|
237
|
+
/**
|
|
238
|
+
* `true ` only: the two ways a hand-written template describes a tree the parser will not build.
|
|
239
|
+
*
|
|
240
|
+
* `@verajs/jsx` normalises both at compile time, so this is the channel for the BUILDLESS path —
|
|
241
|
+
* which is this framework's baseline, not its fallback, and was the surface left broken when the
|
|
242
|
+
* compiler fix landed. It reaches the browser console on the client and during hydration; a
|
|
243
|
+
* server-only render never runs this scanner, so an SSR page that is never hydrated is not covered.
|
|
244
|
+
*
|
|
245
|
+
* The self-close test is `markup` ending in `/`, which is the same approximation the raw-text
|
|
246
|
+
* branch below already makes: an unquoted attribute value ending in a slash (`<div data-x=a/>`)
|
|
247
|
+
* reads the same way. That is not a false positive in any way that matters — measured, such a tag
|
|
248
|
+
* is an OPEN tag too and swallows what follows it exactly as `<div/>` does, so both the warning and
|
|
249
|
+
* the fix it names are correct for it.
|
|
250
|
+
*/
|
|
251
|
+
const warnTagShape = (tag, closing, selfClosed) => {
|
|
252
|
+
if (!closing && selfClosed && !VOID_TAGS.test(tag))
|
|
253
|
+
console.warn(`[vera] renderer: <${tag}> is left OPEN by this template, so everything after it becomes its ` +
|
|
254
|
+
`child rather than its sibling. HTML has no self-closing syntax outside <svg> and <math> — ` +
|
|
255
|
+
`\`<${tag} />\` is an open tag, not an empty element. Write \`<${tag}></${tag}>\`. ` +
|
|
256
|
+
`(@verajs/jsx rewrites this for you; a hand-written template has to say it.)`);
|
|
257
|
+
else if (closing && VOID_TAGS.test(tag))
|
|
258
|
+
console.warn(`[vera] renderer: \`</${tag}>\` is read by the parser as ANOTHER <${tag}>, so this template ` +
|
|
259
|
+
`renders two where it describes one. A void element has no end tag — write \`<${tag}>\` alone.`);
|
|
260
|
+
};
|
|
261
|
+
const scan = (strings, type = 1) => {
|
|
127
262
|
const specs = [];
|
|
128
263
|
let markup = '';
|
|
129
264
|
let state = IN_TEXT;
|
|
@@ -132,6 +267,16 @@ const scan = (strings) => {
|
|
|
132
267
|
let rawTag = ''; // which raw-text element we are inside
|
|
133
268
|
let tagNameStart = 0; // markup index where the current tag's name begins
|
|
134
269
|
let isClosing = false;
|
|
270
|
+
/**
|
|
271
|
+
* `true ` only. Depth of `<svg>`/`<math>` nesting, because foreign content is the one place the
|
|
272
|
+
* parser DOES honour XML self-closing, so neither warning applies inside it. An `svg`/`mathml`
|
|
273
|
+
* template is already inside one, hence the seed from `type`.
|
|
274
|
+
*
|
|
275
|
+
* `<foreignObject>` re-enters HTML content and is deliberately not tracked: suppressing a warning
|
|
276
|
+
* there is a missed warning, while tracking it wrongly would be a wrong one, and a diagnostic
|
|
277
|
+
* that cries wolf is worse than one that stays quiet.
|
|
278
|
+
*/
|
|
279
|
+
let foreign = type === 1 ? 0 : 1;
|
|
135
280
|
let attrName = '';
|
|
136
281
|
let statics = [];
|
|
137
282
|
let pending = ''; // the static chunk currently being collected IN_BOUND_VALUE
|
|
@@ -158,7 +303,9 @@ const scan = (strings) => {
|
|
|
158
303
|
statics.push(pending);
|
|
159
304
|
const quoteChar = quote || '"';
|
|
160
305
|
markup += ` ${specs.length}${MARKER}=${quoteChar}${statics.join(MARKER)}${quoteChar}`;
|
|
161
|
-
specs.push(
|
|
306
|
+
specs.push(true
|
|
307
|
+
? { _type: ATTRIBUTE, _name: attrName, _tag: markup.slice(tagNameStart).match(/^[a-zA-Z][^\s/>]*/)?.[0] }
|
|
308
|
+
: { _type: ATTRIBUTE, _name: attrName });
|
|
162
309
|
state = IN_TAG;
|
|
163
310
|
if (quote !== '')
|
|
164
311
|
pos++; // consume the closing quote; unquoted terminators reprocess IN_TAG
|
|
@@ -190,6 +337,14 @@ const scan = (strings) => {
|
|
|
190
337
|
}
|
|
191
338
|
else if (ch === '>') {
|
|
192
339
|
const tagName = markup.slice(tagNameStart).match(/^[a-zA-Z][^\s/>]*/)?.[0] ?? '';
|
|
340
|
+
if (true ) {
|
|
341
|
+
const lower = tagName.toLowerCase();
|
|
342
|
+
const selfClosed = markup.endsWith('/');
|
|
343
|
+
if (lower === 'svg' || lower === 'math')
|
|
344
|
+
foreign += isClosing ? -1 : selfClosed ? 0 : 1;
|
|
345
|
+
else if (foreign < 1)
|
|
346
|
+
warnTagShape(tagName, isClosing, selfClosed);
|
|
347
|
+
}
|
|
193
348
|
if (!isClosing && RAW_TEXT_TAGS.test(tagName) && !markup.endsWith('/')) {
|
|
194
349
|
rawTag = tagName.toLowerCase();
|
|
195
350
|
state = IN_RAW_TEXT;
|
|
@@ -278,6 +433,44 @@ const scan = (strings) => {
|
|
|
278
433
|
* Element-position expression — an element REF, not a no-op. Marked exactly like a bound
|
|
279
434
|
* attribute ('&' cannot begin a real attribute binding), so no new machinery exists for it.
|
|
280
435
|
*/
|
|
436
|
+
if (true && (markup.endsWith('<') || markup.endsWith('</'))) {
|
|
437
|
+
/**
|
|
438
|
+
* Except in **tag position**, where it is a mistake with no useful reading. `<${name}>`
|
|
439
|
+
* lands here because the tag has no name yet, and what the parser then makes of a ref on
|
|
440
|
+
* a nameless element is escaped punctuation. Naming the entry that does support it is
|
|
441
|
+
* more use than an element ref nobody asked for.
|
|
442
|
+
*/
|
|
443
|
+
console.error(`[vera] an expression in tag position (\`<\${…}>\`) is not a dynamic tag name — the ` +
|
|
444
|
+
`template has no element there and the markup around it is rendered as text.\n` +
|
|
445
|
+
`Runtime tag names live in @verajs/renderer/tag:\n\n` +
|
|
446
|
+
` import { html, tag } from '@verajs/renderer/tag';\n` +
|
|
447
|
+
` const heading = tag\`h1\`;\n` +
|
|
448
|
+
` html\`<\${heading}>…</\${heading}>\`\n`);
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* **And in attribute-*name* position, which is the same mistake one step along.**
|
|
452
|
+
*
|
|
453
|
+
* `<b ${name}="x">`, `<b data-${name}="1">` and `<b a${name}b="1">` all land here: the
|
|
454
|
+
* marker is not preceded by `=`, so it reads as an element ref, and the `="x"` after it
|
|
455
|
+
* stays literal markup. The browser's parser then makes `<b ="x"="">` of it — attributes
|
|
456
|
+
* nobody wrote, silently.
|
|
457
|
+
*
|
|
458
|
+
* **The server already refuses this**, and said so in its README while the client shipped
|
|
459
|
+
* the garbage. A developer rendering only in a browser saw malformed output with no clue,
|
|
460
|
+
* and adding SSR later turned it into a throw with no obvious connection.
|
|
461
|
+
*
|
|
462
|
+
* Told apart from a real element ref by what follows it: a ref is always followed by
|
|
463
|
+
* whitespace, `>` or `/`. Anything else means the marker landed inside a name.
|
|
464
|
+
*/
|
|
465
|
+
const after = strings[i + 1] ?? '';
|
|
466
|
+
if (true && after !== '' && !/^[\s>/]/.test(after)) {
|
|
467
|
+
console.error(`[vera] an expression in attribute-name position (\`<b \${…}="x">\`) is not a dynamic ` +
|
|
468
|
+
`attribute name — a marker is not a name, and the parser makes attributes nobody ` +
|
|
469
|
+
`wrote out of what follows it.\n` +
|
|
470
|
+
`Runtime-named bindings live in @verajs/renderer/spread:\n\n` +
|
|
471
|
+
` import { spread } from '@verajs/renderer/spread';\n` +
|
|
472
|
+
` html\`<b \${spread({ [name]: 'x' })}>…</b>\`\n`);
|
|
473
|
+
}
|
|
281
474
|
markup += ` ${specs.length}${MARKER}="${MARKER}"`;
|
|
282
475
|
specs.push({ _type: ATTRIBUTE, _name: '&' });
|
|
283
476
|
}
|
|
@@ -285,13 +478,92 @@ const scan = (strings) => {
|
|
|
285
478
|
}
|
|
286
479
|
return { markup, specs };
|
|
287
480
|
};
|
|
481
|
+
/**
|
|
482
|
+
* The container of the renderInto call currently committing — how a slot part learns its root
|
|
483
|
+
* (light element vs shadow root) at Instance construction. Commits are synchronous per flush, so
|
|
484
|
+
* one module slot suffices (the `currentInstance` pattern); null outside renderInto (hydration's
|
|
485
|
+
* adoption path constructs elsewhere and the seam stays inert there until it learns adoption).
|
|
486
|
+
*/
|
|
487
|
+
let _slotRoot = null;
|
|
488
|
+
/** See the slotless branch in `Instance`. Once per host tag, so a list cannot flood a console. */
|
|
489
|
+
const warnedSlotless = new Set();
|
|
490
|
+
const warnSlotless = (root) => {
|
|
491
|
+
const tag = root.localName;
|
|
492
|
+
if (warnedSlotless.has(tag))
|
|
493
|
+
return;
|
|
494
|
+
warnedSlotless.add(tag);
|
|
495
|
+
console.warn(`[vera] renderer: <${tag}> renders a \`<slot>\` into LIGHT DOM, but no 'slot' insert is wired — ` +
|
|
496
|
+
`nothing can fill it, so it always shows its fallback, and any content the host is given for ` +
|
|
497
|
+
`it sits beside the component as stray markup instead. Wire it at the app entry, BEFORE anything renders: ` +
|
|
498
|
+
`\`import { slots } from '@verajs/renderer/slots'; wire([renderer, slots])\`. Wiring it later ` +
|
|
499
|
+
`does not help a template that has already rendered — a template resolves this once, at ` +
|
|
500
|
+
`construction, and is interned per call site for the life of the page.`);
|
|
501
|
+
};
|
|
502
|
+
/**
|
|
503
|
+
* `true ` only: the HTML parser dropped an element a binding was written on.
|
|
504
|
+
*
|
|
505
|
+
* Named where it is discovered rather than after the walk, because the SKIP knows exactly which
|
|
506
|
+
* spec went missing — `specs[from]` is the casualty by construction. A post-hoc count can only
|
|
507
|
+
* report the LAST unclaimed spec, which positional pairing makes the wrong element every time, and
|
|
508
|
+
* pointing an author at a tag that rendered correctly is the precise failure this message exists
|
|
509
|
+
* to cure.
|
|
510
|
+
*/
|
|
511
|
+
/**
|
|
512
|
+
* **A child binding directly inside `<table>` renders one shape and PARSES as another.**
|
|
513
|
+
*
|
|
514
|
+
* `<table>${rows}</table>` is conforming HTML — `<tbody>` is omissible — and it is the one place a
|
|
515
|
+
* legal template does not survive a round trip through the platform:
|
|
516
|
+
*
|
|
517
|
+
* - CLIENT RENDER inserts the rows with DOM calls, which apply no parser rules: `table > tr`.
|
|
518
|
+
* - The SAME markup PARSED — a server render the browser re-parses, `innerHTML`, a static file —
|
|
519
|
+
* gets the implied section: `table > tbody > tr`.
|
|
520
|
+
*
|
|
521
|
+
* Measured, both shapes, same template. So a stylesheet written `table > tr` matches on one path
|
|
522
|
+
* and not the other, and hydration discards the server's markup for that container and rebuilds it
|
|
523
|
+
* (*"expected `<tr>` and found `<tbody>`"*) — silently in production, where this call is folded away.
|
|
524
|
+
*
|
|
525
|
+
* **Why this is a warning and not a repair.** Whatever is emitted, the browser re-parses it, and the
|
|
526
|
+
* parser ALWAYS inserts the section — so the only shape all three paths agree on is one where the
|
|
527
|
+
* section is already in the template. The framework could insert it, but that changes the DOM shape
|
|
528
|
+
* of every existing client-rendered table, across the renderer AND `@verajs/ssr`'s serializer, and
|
|
529
|
+
* rests on the SSR shim agreeing with browsers about implied tags. One word from the author reaches
|
|
530
|
+
* the same fixed point with none of that. Owner's call, recorded rather than assumed.
|
|
531
|
+
*
|
|
532
|
+
* Scoped to `<table>` deliberately: `<tbody>` (from rows) and `<colgroup>` (from `<col>`) are the
|
|
533
|
+
* only implied START tags reachable inside a template fragment, and both are children of `<table>`.
|
|
534
|
+
* The omissible END tags — `</li>`, `</p>`, `</td>`, `</option>` and the rest — insert nothing, so
|
|
535
|
+
* they round-trip correctly and are pinned doing so in `tests/dropped-element-bindings.test.mjs`.
|
|
536
|
+
*/
|
|
537
|
+
const warnImplicitSection = (parent) => {
|
|
538
|
+
if (parent?.localName !== 'table')
|
|
539
|
+
return;
|
|
540
|
+
console.warn('[vera] renderer: a binding sits directly inside <table>, where the HTML parser inserts a ' +
|
|
541
|
+
'<tbody> that a client render does not. The same template then renders as `table > tr` and ' +
|
|
542
|
+
'parses as `table > tbody > tr`, so `table > tr` selectors match on only one path and ' +
|
|
543
|
+
'hydration rebuilds this container instead of adopting it. Write the section explicitly — ' +
|
|
544
|
+
'`<table><tbody>${rows}</tbody></table>` — and every path agrees.');
|
|
545
|
+
};
|
|
546
|
+
const warnDroppedBinding = (specs, from, count) => {
|
|
547
|
+
const lost = specs[from];
|
|
548
|
+
const where = lost?._tag
|
|
549
|
+
? `\`${lost._type === ATTRIBUTE ? `${lost._name}=` : ''}\` on <${lost._tag}>`
|
|
550
|
+
: 'a binding';
|
|
551
|
+
console.warn(`[vera] renderer: ${where} never reached the parsed tree — the HTML parser DROPPED the element ` +
|
|
552
|
+
`it was written on, because its parent's content model forbids it (\`<select>\` takes only ` +
|
|
553
|
+
`options, \`<form>\` cannot nest, and so on).\n` +
|
|
554
|
+
`${count} binding(s) lost. The element is gone from the DOM and its binding does nothing; ` +
|
|
555
|
+
`the bindings AFTER it are unaffected, because each marker carries its own index. ` +
|
|
556
|
+
`(Before that they all shifted onto the wrong elements, which is why this kind of mistake ` +
|
|
557
|
+
`used to surface somewhere you had not edited.)\n` +
|
|
558
|
+
`Move the element out of its parent, or use one the parent can hold.`);
|
|
559
|
+
};
|
|
288
560
|
const templateCache = new WeakMap();
|
|
289
561
|
class Template {
|
|
290
562
|
_element;
|
|
291
563
|
_parts = [];
|
|
292
564
|
constructor(result) {
|
|
293
565
|
const type = result._$litType$ ?? 1;
|
|
294
|
-
const { markup, specs } = scan(result.strings);
|
|
566
|
+
const { markup, specs } = scan(result.strings, type);
|
|
295
567
|
this._element = doc.createElement('template');
|
|
296
568
|
/** svg/mathml fragments only parse inside their root; wrap, then unwrap below. */
|
|
297
569
|
this._element.innerHTML = type === 2 ? `<svg>${markup}</svg>` : type === 3 ? `<math>${markup}</math>` : markup;
|
|
@@ -325,6 +597,27 @@ class Template {
|
|
|
325
597
|
if (element.hasAttributes()) {
|
|
326
598
|
for (const attributeName of element.getAttributeNames()) {
|
|
327
599
|
if (attributeName.endsWith(MARKER)) {
|
|
600
|
+
/**
|
|
601
|
+
* **Each marker carries its own spec index in its NAME**, so pairing is addressed
|
|
602
|
+
* rather than positional — and a marker that never arrived is visible the moment the
|
|
603
|
+
* next one does. Both halves matter and neither works alone:
|
|
604
|
+
*
|
|
605
|
+
* - REPAIR: an element the parser drops takes its marker with it. Paired by walk
|
|
606
|
+
* order, that shifted every later binding onto the wrong element, silently —
|
|
607
|
+
* `html\`<select><div title=${'${a}'}>x</div></select><b title=${'${b}'}>\`` rendered
|
|
608
|
+
* `<b title="a">`. Consuming the gap keeps every surviving binding on its own
|
|
609
|
+
* element; only the dropped one is lost.
|
|
610
|
+
* - REPORT: the repair would otherwise SILENCE the problem, which is a correct
|
|
611
|
+
* refusal with nothing to tell the author — so the skip is where the warning lives.
|
|
612
|
+
*/
|
|
613
|
+
const declared = parseInt(attributeName, 10);
|
|
614
|
+
if (declared > specIndex) {
|
|
615
|
+
if (true )
|
|
616
|
+
warnDroppedBinding(specs, specIndex, declared - specIndex);
|
|
617
|
+
do
|
|
618
|
+
parts.push({ _type: IGNORED, _index: -1 });
|
|
619
|
+
while (++specIndex < declared);
|
|
620
|
+
}
|
|
328
621
|
/**
|
|
329
622
|
* The marker attribute's value carries the statics; the REAL (case-preserved) name
|
|
330
623
|
* comes from the spec — the HTML parser lowercases attribute names, which would
|
|
@@ -336,6 +629,15 @@ class Template {
|
|
|
336
629
|
_index: -1,
|
|
337
630
|
_name: spec._name,
|
|
338
631
|
_statics: element.getAttribute(attributeName).split(MARKER),
|
|
632
|
+
/**
|
|
633
|
+
* Computed here — once per template, ever — so the first commit of a nullish
|
|
634
|
+
* binding knows whether a fresh clone even carries the attribute. It usually does
|
|
635
|
+
* not, and the unconditional removal this feeds cost a real DOM call per element
|
|
636
|
+
* per create: 1,000 no-op `removeAttribute`s on the 1,000-row benchmark. The one
|
|
637
|
+
* case that must still remove — `<b title="a" title=${null}>`, where the parser
|
|
638
|
+
* keeps the first duplicate — is exactly what this reads.
|
|
639
|
+
*/
|
|
640
|
+
_present: element.hasAttribute(spec._name),
|
|
339
641
|
_node: element,
|
|
340
642
|
});
|
|
341
643
|
element.removeAttribute(attributeName);
|
|
@@ -367,10 +669,41 @@ class Template {
|
|
|
367
669
|
/** Re-aim the walker before removing the node it stands on. */
|
|
368
670
|
markerWalker.currentNode = primedText;
|
|
369
671
|
node.remove();
|
|
672
|
+
if (true )
|
|
673
|
+
warnImplicitSection(primedText.parentNode);
|
|
370
674
|
parts.push({ _type: CHILD, _index: -1, _node: primedText });
|
|
371
675
|
consumeIgnored();
|
|
372
676
|
}
|
|
373
677
|
}
|
|
678
|
+
/**
|
|
679
|
+
* **CONSERVATION OF MARKERS — the walk must claim every spec the scan emitted.**
|
|
680
|
+
*
|
|
681
|
+
* The loop above pairs specs with markers in document order. If the HTML parser DROPPED the
|
|
682
|
+
* element a binding was written on, that marker never exists, the loop runs out of nodes early,
|
|
683
|
+
* and `specIndex` stops short — and because pairing is POSITIONAL, every binding after the
|
|
684
|
+
* missing one has already been handed the value of its predecessor. Measured:
|
|
685
|
+
*
|
|
686
|
+
* html`<select><div title=${a}>x</div></select><b title=${b}>after</b>`
|
|
687
|
+
*
|
|
688
|
+
* renders `<b title="a">` — the value written for the `<div>`, on an unrelated element, with
|
|
689
|
+
* no error anywhere. `<form>` inside `<form>` does the same. HTML's parser drops elements its
|
|
690
|
+
* content model forbids, which is correct of it and invisible to everything else here.
|
|
691
|
+
*
|
|
692
|
+
* **This is deliberately not a content-model check.** A table of what may contain what is a
|
|
693
|
+
* closed vocabulary over an open space: it catches what somebody enumerated, needs maintenance
|
|
694
|
+
* as HTML evolves, and would cover the compiler only — while this counts what actually
|
|
695
|
+
* happened, in JSX and hand-written templates alike, for every dropping context including the
|
|
696
|
+
* ones nobody listed. The cost of knowing is one integer comparison the construction already
|
|
697
|
+
* had lying around.
|
|
698
|
+
*
|
|
699
|
+
* The gap it cannot close, named rather than implied: a dropped element carrying NO bindings
|
|
700
|
+
* loses nothing to count. That is harmless to the renderer — nothing shifts — and it is the
|
|
701
|
+
* restructuring class, which `tests/jsx-tree-parity.test.mjs` records instead.
|
|
702
|
+
*/
|
|
703
|
+
if (true && specIndex < specs.length) {
|
|
704
|
+
/** A casualty at the very END has no later marker to reveal it, so the tail is checked too. */
|
|
705
|
+
warnDroppedBinding(specs, specIndex, specs.length - specIndex);
|
|
706
|
+
}
|
|
374
707
|
/** Pass 2 — INDEX over ELEMENT | TEXT, the mask instances walk with. */
|
|
375
708
|
instanceWalker.currentNode = content;
|
|
376
709
|
let nodeIndex = -1;
|
|
@@ -388,6 +721,40 @@ class Template {
|
|
|
388
721
|
}
|
|
389
722
|
for (const part of parts)
|
|
390
723
|
part._node = undefined;
|
|
724
|
+
/**
|
|
725
|
+
* THE SLOT WALK — the whole template-side seam, and it runs only when a 'slot' insert is
|
|
726
|
+
* wired at construction. One dedicated pass discovers `<slot>` elements AND indexes them in
|
|
727
|
+
* the same ELEMENT|TEXT numbering the instance walk uses (Text has no localName, so no
|
|
728
|
+
* nodeType check is needed). Passes 1 and 2 above are byte-identical to their pre-seam
|
|
729
|
+
* selves: an unwired app's construction path is untouched, and its only cost is this one
|
|
730
|
+
* registry lookup per template construction.
|
|
731
|
+
*
|
|
732
|
+
* **Resolved per TEMPLATE, and templates are cached per call site for the life of the page** —
|
|
733
|
+
* so a shape first constructed before `wire([slots])` ran never gains slot support, silently.
|
|
734
|
+
* That is the ordinary insert contract (wire at the app entry, beside the renderer, before
|
|
735
|
+
* anything renders) and it is stated in the slots module's own docs; resolving per INSTANCE
|
|
736
|
+
* instead would move a registry lookup onto the hot path for every app, which is the trade
|
|
737
|
+
* this design refuses.
|
|
738
|
+
*/
|
|
739
|
+
const seam = slotSeam();
|
|
740
|
+
/**
|
|
741
|
+
* **Dev-only: remember that this markup HAS slots even when nothing can distribute them.**
|
|
742
|
+
* Without it the two ways of getting the wiring wrong are indistinguishable from a component
|
|
743
|
+
* that simply has no slots — see the warning at the instance's slot mount.
|
|
744
|
+
*/
|
|
745
|
+
if (true && seam === undefined && markup.includes('<slot'))
|
|
746
|
+
this._slotless = true;
|
|
747
|
+
if (seam !== undefined) {
|
|
748
|
+
instanceWalker.currentNode = content;
|
|
749
|
+
let index = -1;
|
|
750
|
+
while ((node = instanceWalker.nextNode()) !== null) {
|
|
751
|
+
index++;
|
|
752
|
+
if (node.localName === 'slot') {
|
|
753
|
+
this._seam = seam;
|
|
754
|
+
(this._slots ??= []).push(index);
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
}
|
|
391
758
|
}
|
|
392
759
|
}
|
|
393
760
|
const getTemplate = (result) => {
|
|
@@ -399,8 +766,6 @@ const getTemplate = (result) => {
|
|
|
399
766
|
const IGNORED_PART = { _commit: (_values, index) => index + 1 };
|
|
400
767
|
/** Never equal to any user value, so the first commit always runs. */
|
|
401
768
|
const UNSET = {};
|
|
402
|
-
/** Removal target: nodes moved here are dropped when it is emptied. */
|
|
403
|
-
const SCRATCH = doc.createDocumentFragment();
|
|
404
769
|
/** A fresh markered part: two comments inserted before `ref` in `parent`. */
|
|
405
770
|
const createMarkeredPart = (parent, ref) => {
|
|
406
771
|
const start = comment();
|
|
@@ -409,13 +774,58 @@ const createMarkeredPart = (parent, ref) => {
|
|
|
409
774
|
parent.insertBefore(end, ref);
|
|
410
775
|
return new ChildPart(start, end);
|
|
411
776
|
};
|
|
412
|
-
|
|
777
|
+
/**
|
|
778
|
+
* Text for an attribute built from several expressions.
|
|
779
|
+
*
|
|
780
|
+
* `` `${value}` `` rather than `String(value)`, and the difference is exactly one case. Both are
|
|
781
|
+
* ToString with hint `'string'` for everything else; `String` alone special-cases a **symbol** and
|
|
782
|
+
* returns its description instead of throwing. Every single-expression binding assigns straight to
|
|
783
|
+
* the DOM and gets WebIDL's `DOMString` conversion, which throws on one — so `title=${symbol}` threw
|
|
784
|
+
* and `title="a ${symbol} b"` quietly rendered `a Symbol(s) b`. The same sigil on the same attribute,
|
|
785
|
+
* disagreeing with itself depending on whether static text sat beside it.
|
|
786
|
+
*/
|
|
787
|
+
const toText = (value) => (value == null ? '' : `${value}`);
|
|
413
788
|
/** Binding kinds, resolved once from the attribute name's first character. */
|
|
414
789
|
const ATTR = 0; // plain attribute
|
|
415
790
|
const PROPERTY = 1; // .name
|
|
416
791
|
const BOOLEAN = 2; // ?name
|
|
417
|
-
|
|
418
|
-
|
|
792
|
+
/**
|
|
793
|
+
* `!name` — a property written from the *live* DOM rather than from what this binding last wrote.
|
|
794
|
+
*
|
|
795
|
+
* Numbered below `EVENT` deliberately: `kind >= EVENT` is what decides a value is passed raw rather
|
|
796
|
+
* than joined from the statics, and a live binding is a property, so `!title="a${x}b"` has to join
|
|
797
|
+
* like every other one.
|
|
798
|
+
*/
|
|
799
|
+
const LIVE = 3;
|
|
800
|
+
const EVENT = 4; // @name
|
|
801
|
+
/** A binding that must never write — see the `__proto__` refusal in the constructor. */
|
|
802
|
+
const REFUSED = -1;
|
|
803
|
+
/**
|
|
804
|
+
* Calls an element ref, and survives one that throws.
|
|
805
|
+
*
|
|
806
|
+
* A ref runs in the middle of committing a template's parts, so an unguarded throw left the commit
|
|
807
|
+
* half applied and unwound the render that triggered it — the component's shadow root ended up
|
|
808
|
+
* **empty and stayed that way**, and every later update threw at the same line. The error was
|
|
809
|
+
* reported, so the only symptom was a component that had silently stopped existing.
|
|
810
|
+
*
|
|
811
|
+
* The same judgement `handleEvent` makes a few lines up: a mistake in code the template was handed
|
|
812
|
+
* is named, not raised from inside the framework at a point where the value's origin is long gone.
|
|
813
|
+
* The prefix goes on our own sentence and the error is passed alongside, so it stays filterable
|
|
814
|
+
* without misattributing someone else's `Error`.
|
|
815
|
+
*/
|
|
816
|
+
const applyRef = (callback, element) => {
|
|
817
|
+
try {
|
|
818
|
+
callback(element);
|
|
819
|
+
}
|
|
820
|
+
catch (error) {
|
|
821
|
+
/** The sentence is development's; production keeps the prefix and the error carries the rest. */
|
|
822
|
+
if (true )
|
|
823
|
+
console.error('[vera] an element ref threw; the render continued without it.', error);
|
|
824
|
+
else
|
|
825
|
+
console.error('[vera] ref threw', error);
|
|
826
|
+
}
|
|
827
|
+
};
|
|
828
|
+
const REF = 5; // element-position expression
|
|
419
829
|
class AttrPart {
|
|
420
830
|
_element;
|
|
421
831
|
_name;
|
|
@@ -425,15 +835,52 @@ class AttrPart {
|
|
|
425
835
|
_isFullValue; // exactly one expression with no static text around it
|
|
426
836
|
_committed = UNSET;
|
|
427
837
|
_handler = null;
|
|
428
|
-
|
|
838
|
+
/** `<select>.value`, which cannot be applied where it is written — see `pendingSelects`. */
|
|
839
|
+
_select = false;
|
|
840
|
+
/** The template statically wrote this attribute, so a first nullish commit must still remove. */
|
|
841
|
+
_present;
|
|
842
|
+
constructor(element, name, statics, present = false) {
|
|
429
843
|
const first = name[0];
|
|
430
|
-
let kind = first === '.'
|
|
844
|
+
let kind = first === '.'
|
|
845
|
+
? PROPERTY
|
|
846
|
+
: first === '?'
|
|
847
|
+
? BOOLEAN
|
|
848
|
+
: first === '@'
|
|
849
|
+
? EVENT
|
|
850
|
+
: first === '&'
|
|
851
|
+
? REF
|
|
852
|
+
: first === '!'
|
|
853
|
+
? LIVE
|
|
854
|
+
: ATTR;
|
|
431
855
|
let realName = kind ? name.slice(1) : name;
|
|
856
|
+
/**
|
|
857
|
+
* **`__proto__` is not a property write, so no property binding may make one.**
|
|
858
|
+
*
|
|
859
|
+
* `element.__proto__ = value` hits `Object.prototype`'s `__proto__` ACCESSOR and replaces the
|
|
860
|
+
* element's prototype, stripping every DOM method it has. `.__proto__=${x}` crashed out of the
|
|
861
|
+
* commit with an unreadable internal error; `!__proto__=${x}` bricked the element silently and
|
|
862
|
+
* the wreckage surfaced in a LATER render, naming the renderer rather than the binding. There
|
|
863
|
+
* is no legitimate use, so unlike `.innerHTML` there is no spelling to point at — the binding
|
|
864
|
+
* is refused and never writes.
|
|
865
|
+
*
|
|
866
|
+
* **The deliberate twin of `refusedSink` in `./spread.ts`**, which refuses the same name for
|
|
867
|
+
* the same reason. The two entries are independent bundles and neither imports the other, so
|
|
868
|
+
* the rule is copied on purpose (the repo's standing note: sigil rules live in both AttrPart
|
|
869
|
+
* and spread, and a fix has to visit every copy). `tests/dangerous-binding-matrix.test.mjs`
|
|
870
|
+
* fails if one of them starts refusing something the other allows.
|
|
871
|
+
*/
|
|
872
|
+
if ((kind === PROPERTY || kind === LIVE) && realName === '__proto__') {
|
|
873
|
+
kind = REFUSED;
|
|
874
|
+
if (true )
|
|
875
|
+
console.warn(`[vera] <${element.localName}> binds \`${name}\`, which would replace the element's own ` +
|
|
876
|
+
`prototype and destroy it — no property write does this, and no use of it is legitimate. ` +
|
|
877
|
+
`The binding is ignored.`);
|
|
878
|
+
}
|
|
432
879
|
/**
|
|
433
880
|
* React muscle-memory, buildless: `onClick=${fn}` ≡ `@click=${fn}`. Strictly `on` + a capital —
|
|
434
881
|
* all-lowercase `onclick` stays a plain attribute (legal inline-handler HTML).
|
|
435
882
|
*
|
|
436
|
-
* `@verajs/spread` repeats these rules rather than importing them. Sharing them through
|
|
883
|
+
* `@verajs/renderer/spread` repeats these rules rather than importing them. Sharing them through
|
|
437
884
|
* `@verajs/shared-utils` was tried and reverted: the shared form has to return both the kind and
|
|
438
885
|
* the name, and the tuple it allocates cost this bundle 10 B. Principle #5 allows deliberate
|
|
439
886
|
* duplication where two things can legitimately diverge; here #7 decides it — weight is the
|
|
@@ -449,14 +896,84 @@ class AttrPart {
|
|
|
449
896
|
this._statics = statics;
|
|
450
897
|
this._slots = statics.length - 1;
|
|
451
898
|
this._isFullValue = this._slots === 1 && statics[0] === '' && statics[1] === '';
|
|
899
|
+
/** Resolved once, here, so the commit path costs one boolean rather than two comparisons. */
|
|
900
|
+
this._select = kind === PROPERTY && realName === 'value' && element.localName === 'select';
|
|
901
|
+
this._present = present;
|
|
452
902
|
}
|
|
453
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* Releases an element ref, because the element it named is going away.
|
|
905
|
+
*
|
|
906
|
+
* A ref was told about attachment and never about detachment, so it kept a detached node alive and
|
|
907
|
+
* a component reading `myRef.value` after a subtree was replaced got the old element back. Lit
|
|
908
|
+
* passes `undefined` for the same reason.
|
|
909
|
+
*
|
|
910
|
+
* `null` rather than `undefined`, because `.value` is a store property and `null` reads as
|
|
911
|
+
* "deliberately nothing" where `undefined` reads as "never set".
|
|
912
|
+
*
|
|
913
|
+
* **Reached when a subtree is rendered away, and deliberately not when a component is removed
|
|
914
|
+
* from the document.** The two are the same event to a reader and not to this renderer: a
|
|
915
|
+
* disconnect here is not a destruction, since moving a node between parents fires one and the
|
|
916
|
+
* component renders again on reconnect. Releasing there would blank every ref for the frame a
|
|
917
|
+
* move takes, and `_committed = UNSET` below means the re-apply could only happen on the next
|
|
918
|
+
* pass. Measured in `tests/renderer-ref-lifetime.test.mjs`, which asserts both halves so the
|
|
919
|
+
* asymmetry is a decision rather than something nobody looked at.
|
|
920
|
+
*
|
|
921
|
+
* A **self-applying** value is
|
|
922
|
+
* skipped: `_$apply$` receives the part and owns its own lifecycle, so telling it about detachment
|
|
923
|
+
* here would be a second protocol contradicting the first.
|
|
924
|
+
*/
|
|
925
|
+
_release() {
|
|
926
|
+
const value = this._committed;
|
|
927
|
+
if (typeof value === 'function')
|
|
928
|
+
applyRef(value, null);
|
|
929
|
+
else if (value !== null && typeof value === 'object' && value._$apply$ === undefined)
|
|
930
|
+
value.value = null;
|
|
931
|
+
this._committed = UNSET;
|
|
932
|
+
}
|
|
933
|
+
/**
|
|
934
|
+
* Stable listener; swapping one function for another never touches the DOM.
|
|
935
|
+
*
|
|
936
|
+
* **It is not registered exactly once, and the difference is load-bearing.** A handler set back to
|
|
937
|
+
* `undefined` or `false` nulls `_handler` *without removing the listener* — inert, because
|
|
938
|
+
* `handleEvent` finds nothing callable — so the next non-null value sees `_handler === null` and
|
|
939
|
+
* calls `addEventListener` again. Measured: `function -> undefined -> function` registers twice.
|
|
940
|
+
*
|
|
941
|
+
* That is harmless only because the listener passed is **`this`, the part object itself**. The
|
|
942
|
+
* platform ignores a repeated `(type, listener, capture)` triple, verified with no framework
|
|
943
|
+
* involved — the same listener object added three times fires once. Pass a fresh closure here
|
|
944
|
+
* instead and dedup stops applying: every toggle through null adds another live listener, silently,
|
|
945
|
+
* and only in components that turn a handler off and on again.
|
|
946
|
+
*
|
|
947
|
+
* `tests/event-binding-fuzz.test.mjs` holds that as an invariant — it counts *fires*, not
|
|
948
|
+
* `addEventListener` calls, and making this listener a closure fails it.
|
|
949
|
+
*
|
|
950
|
+
* **Two shapes, because `addEventListener` takes two.** A function is called with the element as
|
|
951
|
+
* `this`; an object with a `handleEvent` method is invoked through it — the platform's own
|
|
952
|
+
* `EventListenerObject` protocol, which every engine accepts and lit supports. This used to call
|
|
953
|
+
* `.call()` unconditionally, so passing the platform's own listener shape bound successfully and
|
|
954
|
+
* then threw `this._handler.call is not a function` on **every** dispatch.
|
|
955
|
+
*
|
|
956
|
+
* Anything else is inert rather than throwing. A truthy non-function is a mistake, and
|
|
957
|
+
* development names it at the binding (see the `EVENT` branch in `_commit`) — where the mistake
|
|
958
|
+
* still is. Throwing here instead would raise from inside the framework on every user click, at a
|
|
959
|
+
* point where the value's origin is long gone.
|
|
960
|
+
*/
|
|
454
961
|
handleEvent(event) {
|
|
455
|
-
|
|
456
|
-
|
|
962
|
+
const handler = this._handler;
|
|
963
|
+
if (typeof handler === 'function')
|
|
964
|
+
handler.call(this._element, event);
|
|
965
|
+
else if (typeof handler?.handleEvent === 'function')
|
|
966
|
+
handler.handleEvent(event);
|
|
457
967
|
}
|
|
458
|
-
|
|
968
|
+
/**
|
|
969
|
+
* `adopting` is set only by `@verajs/renderer/hydrate`, and only changes what happens to the
|
|
970
|
+
* three form-value properties the server can express in markup — see the branch below.
|
|
971
|
+
*/
|
|
972
|
+
_commit(values, index, adopting) {
|
|
459
973
|
const kind = this._kind;
|
|
974
|
+
/** Refused in the constructor and never writes — it still has to consume its slots. */
|
|
975
|
+
if (kind === REFUSED)
|
|
976
|
+
return index + this._slots;
|
|
460
977
|
let value;
|
|
461
978
|
if (this._isFullValue || kind >= EVENT) {
|
|
462
979
|
value = values[index]; // raw and uncoerced — events and refs receive the actual value
|
|
@@ -468,21 +985,109 @@ class AttrPart {
|
|
|
468
985
|
joined += toText(values[index + i]) + statics[i + 1];
|
|
469
986
|
value = joined;
|
|
470
987
|
}
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
988
|
+
/**
|
|
989
|
+
* **A live property asks the element, not its own memory.**
|
|
990
|
+
*
|
|
991
|
+
* Every other kind skips a write when the value matches what it last wrote. That is what keeps
|
|
992
|
+
* a field someone has typed into — and it is wrong for a control whose DOM state changes as a
|
|
993
|
+
* *side effect of interacting with a sibling*. Clicking one radio unchecks the others with no
|
|
994
|
+
* event on them, so their bindings still say `true`, still match `_committed`, and never write
|
|
995
|
+
* again: the model and the page diverge and no amount of re-rendering reconciles them. A
|
|
996
|
+
* `<select>`'s options are the same shape.
|
|
997
|
+
*
|
|
998
|
+
* Deliberately narrow. This is not for text inputs — bind those with `.value` and let a
|
|
999
|
+
* person's typing stand. `?hidden` and plain attributes are not offered either: nothing changes
|
|
1000
|
+
* them behind the renderer's back, so there is nothing to re-read.
|
|
1001
|
+
*/
|
|
1002
|
+
if (kind === LIVE) {
|
|
474
1003
|
this._committed = value;
|
|
1004
|
+
/**
|
|
1005
|
+
* **Except while adopting.** Hydration reaches a DOM a person may already have used, and the
|
|
1006
|
+
* click that checked a radio happened before any handler existed to tell the store about it —
|
|
1007
|
+
* so re-asserting the server's choice here would throw the interaction away and nothing would
|
|
1008
|
+
* ever put it back. Recorded, not written, exactly as the other form properties are; the
|
|
1009
|
+
* first state-driven render after that applies live semantics normally.
|
|
1010
|
+
*/
|
|
1011
|
+
if (!(false && adopting)) {
|
|
1012
|
+
const liveTarget = this._element;
|
|
1013
|
+
if (liveTarget[this._name] !== value)
|
|
1014
|
+
liveTarget[this._name] = value;
|
|
1015
|
+
}
|
|
1016
|
+
return index + this._slots;
|
|
1017
|
+
}
|
|
1018
|
+
/**
|
|
1019
|
+
* **A `<select>`'s value cannot be applied where it is written.**
|
|
1020
|
+
*
|
|
1021
|
+
* Assigning it selects an option, and at the moment this part commits the options may not exist:
|
|
1022
|
+
* parts commit in document order, so a nested `${items.map(…)}` has not run, and an `<option
|
|
1023
|
+
* value=${id}>` has not been given its value either. The assignment then matches nothing, and the
|
|
1024
|
+
* select falls back to its first option — silently showing the wrong one. Measured: a nested list
|
|
1025
|
+
* selected index 0 instead of 1, and dynamic option values selected nothing at all.
|
|
1026
|
+
* **lit-html has the same defect, byte for byte** — it was measured there too. React solves it by
|
|
1027
|
+
* special-casing `<select value>` and applying it after children mount, which is what this is.
|
|
1028
|
+
*
|
|
1029
|
+
* Queued rather than dirty-checked, and that is deliberate: the value can be unchanged while the
|
|
1030
|
+
* *options* are replaced, which drops the selection just as thoroughly. Re-asserting once per
|
|
1031
|
+
* render pass is what keeps it right, and a select carries one binding, so it is one push.
|
|
1032
|
+
*/
|
|
1033
|
+
if (this._select) {
|
|
1034
|
+
this._committed = value;
|
|
1035
|
+
/** Adoption never re-asserts a form value — the person may have changed it. See below. */
|
|
1036
|
+
if (!(false && adopting))
|
|
1037
|
+
(pendingSelects ??= []).push(this._element, value);
|
|
1038
|
+
return index + this._slots;
|
|
1039
|
+
}
|
|
1040
|
+
if (value !== this._committed) {
|
|
475
1041
|
if (kind === ATTR) {
|
|
1042
|
+
/**
|
|
1043
|
+
* A nullish value removes the attribute — except on the first commit of a template that
|
|
1044
|
+
* never statically wrote it, where a fresh clone has nothing to remove. That skip used to
|
|
1045
|
+
* be unconditional-removal instead, for the one case that genuinely needs it:
|
|
1046
|
+
* `<b title="a" title=${null}>` parses keeping the first duplicate, so the binding —
|
|
1047
|
+
* written last, and authoritative on the server too — must clear it. `_present` is that
|
|
1048
|
+
* case, read off the parsed template once ever; without it the removal was a real DOM call
|
|
1049
|
+
* per nullish binding per element on create — 1,000 no-ops in the 1,000-row benchmark.
|
|
1050
|
+
*/
|
|
476
1051
|
if (value == null) {
|
|
477
|
-
if (
|
|
1052
|
+
if (this._present || this._committed !== UNSET)
|
|
478
1053
|
this._element.removeAttribute(this._name);
|
|
479
1054
|
}
|
|
480
|
-
else
|
|
1055
|
+
else {
|
|
1056
|
+
/**
|
|
1057
|
+
* The same question `@verajs/renderer/spread` asks at its own sink, from the same home —
|
|
1058
|
+
* the two are deliberately separate implementations (see spread's header on why), and a
|
|
1059
|
+
* diagnostic that lived in only one of them would be the very defect this audit found.
|
|
1060
|
+
* `setAttribute` performs the DOMString conversion itself; nothing is stringified here.
|
|
1061
|
+
*/
|
|
1062
|
+
if (true ) {
|
|
1063
|
+
const complaint = attributeValueComplaint(this._element.localName, this._name, value);
|
|
1064
|
+
if (complaint !== null)
|
|
1065
|
+
console.warn(`[vera] ${complaint}`);
|
|
1066
|
+
}
|
|
481
1067
|
this._element.setAttribute(this._name, value);
|
|
1068
|
+
}
|
|
482
1069
|
}
|
|
483
1070
|
else if (kind === PROPERTY) {
|
|
484
1071
|
const target = this._element;
|
|
485
1072
|
const name = this._name;
|
|
1073
|
+
/**
|
|
1074
|
+
* **Adopting a form value: record it, do not write it.**
|
|
1075
|
+
*
|
|
1076
|
+
* `value`, `checked` and `selected` are exactly the properties `@verajs/ssr` mirrors into
|
|
1077
|
+
* markup, so the element already holds what this binding says — *unless a person changed
|
|
1078
|
+
* it*, which is the entire reason to server-render: the page is usable before the bundle
|
|
1079
|
+
* lands, and the window between the two is where someone types their name, ticks a box or
|
|
1080
|
+
* picks an option. Writing the binding then threw that away, silently, on every hydrating
|
|
1081
|
+
* page. The part is told it already committed this value, so it stays live and the next
|
|
1082
|
+
* genuine state change still applies.
|
|
1083
|
+
*
|
|
1084
|
+
* Only these three, and only while adopting. A property the server cannot express — any
|
|
1085
|
+
* other `.prop` — is not in the DOM yet and must be written.
|
|
1086
|
+
*/
|
|
1087
|
+
if (false && adopting && (name === 'value' || name === 'checked' || name === 'selected')) {
|
|
1088
|
+
this._committed = value;
|
|
1089
|
+
return index + this._slots;
|
|
1090
|
+
}
|
|
486
1091
|
target[name] = value;
|
|
487
1092
|
/**
|
|
488
1093
|
* Detection only, and deliberately not repair.
|
|
@@ -501,13 +1106,13 @@ class AttrPart {
|
|
|
501
1106
|
* `declare` mandatory anyway, because a property assigned imperatively is unrecoverable:
|
|
502
1107
|
* the renderer never saw it, and by the time `init()` runs the value is already gone.
|
|
503
1108
|
*
|
|
504
|
-
* So this is `true`-only and production pays nothing — no check, no message, no
|
|
1109
|
+
* So this is `true `-only and production pays nothing — no check, no message, no
|
|
505
1110
|
* `whenDefined` subscription. Lit reached the same place from the other direction and
|
|
506
1111
|
* throws (`lit.dev/msg/class-field-shadowing`); a warning suffices here because Vera has no
|
|
507
1112
|
* prototype accessors to shadow permanently — the damage is one lost value, not a property
|
|
508
1113
|
* that never updates again.
|
|
509
1114
|
*/
|
|
510
|
-
if (true) {
|
|
1115
|
+
if (true ) {
|
|
511
1116
|
const tag = this._element.localName;
|
|
512
1117
|
if (tag.indexOf('-') > 0 && !customElements.get(tag)) {
|
|
513
1118
|
customElements.whenDefined(tag).then(() => {
|
|
@@ -519,7 +1124,7 @@ class AttrPart {
|
|
|
519
1124
|
* the next render either.
|
|
520
1125
|
*/
|
|
521
1126
|
if (target[name] !== value)
|
|
522
|
-
console.warn(
|
|
1127
|
+
console.warn(`[vera] renderer: the value bound by \`.${name}=\${…}\` on <${tag}> was replaced ` +
|
|
523
1128
|
`while the element upgraded. A class field is the usual cause: at ES2022 ` +
|
|
524
1129
|
`\`${name}?: …\` emits \`${name};\`, which runs during upgrade and overwrites ` +
|
|
525
1130
|
`whatever was set beforehand — write it \`declare ${name}?: …\` instead, which ` +
|
|
@@ -531,10 +1136,26 @@ class AttrPart {
|
|
|
531
1136
|
}
|
|
532
1137
|
}
|
|
533
1138
|
else if (kind === BOOLEAN) {
|
|
534
|
-
|
|
535
|
-
|
|
1139
|
+
/** Unconditional for the same reason: `<b hidden ?hidden=${false}>` must end up not hidden. */
|
|
1140
|
+
this._element.toggleAttribute(this._name, !!value);
|
|
536
1141
|
}
|
|
537
1142
|
else if (kind === EVENT) {
|
|
1143
|
+
/**
|
|
1144
|
+
* A listener is the most deferred call a template makes — it is validated when a *user*
|
|
1145
|
+
* clicks, which in development may be never. So it is checked where it is written, the same
|
|
1146
|
+
* rule the setters took on: the stack at dispatch no longer contains the binding.
|
|
1147
|
+
*
|
|
1148
|
+
* `false` is deliberately allowed and silent. `@click=${enabled && onClick}` is the ordinary
|
|
1149
|
+
* way to bind conditionally and produces exactly that, and it already behaves correctly —
|
|
1150
|
+
* `handleEvent` finds nothing callable and does nothing. `true` is not produced by any
|
|
1151
|
+
* idiom, so it is named along with strings, numbers and objects that cannot listen.
|
|
1152
|
+
*/
|
|
1153
|
+
if (true && value != null && value !== false && typeof value !== 'function' &&
|
|
1154
|
+
typeof value?.handleEvent !== 'function')
|
|
1155
|
+
console.warn(`[vera] @${this._name} on <${this._element.localName}> was given ${typeof value === 'object' ? 'an object with no handleEvent method' : `a ${typeof value}`}, ` +
|
|
1156
|
+
`which cannot listen — the event will do nothing.\n` +
|
|
1157
|
+
`Pass a function, or an object with a handleEvent method. A missing handler is ` +
|
|
1158
|
+
`\`undefined\` or \`false\`, both of which are fine; this is neither.`);
|
|
538
1159
|
if (this._handler === null && value != null)
|
|
539
1160
|
this._element.addEventListener(this._name, this);
|
|
540
1161
|
this._handler = value ?? null;
|
|
@@ -545,8 +1166,9 @@ class AttrPart {
|
|
|
545
1166
|
* the element assigned to `.value` — which makes core's own `ref()` double as an element
|
|
546
1167
|
* ref, reactively. Runs once per distinct value, not once per render.
|
|
547
1168
|
*/
|
|
1169
|
+
notifyOnRemoval = true;
|
|
548
1170
|
if (typeof value === 'function')
|
|
549
|
-
value
|
|
1171
|
+
applyRef(value, this._element);
|
|
550
1172
|
else if (typeof value === 'object') {
|
|
551
1173
|
/**
|
|
552
1174
|
* A self-applying value: anything that knows what to do with an element applies itself.
|
|
@@ -566,16 +1188,90 @@ class AttrPart {
|
|
|
566
1188
|
}
|
|
567
1189
|
// any other value type at element position is consumed and ignored
|
|
568
1190
|
}
|
|
1191
|
+
this._committed = value;
|
|
569
1192
|
}
|
|
570
1193
|
return index + this._slots;
|
|
571
1194
|
}
|
|
572
1195
|
}
|
|
1196
|
+
/**
|
|
1197
|
+
* `<select>.value` assignments held until the whole pass has committed — see the note in `_commit`.
|
|
1198
|
+
* Flat pairs rather than tuples: one array, no per-entry allocation.
|
|
1199
|
+
*/
|
|
1200
|
+
let pendingSelects = null;
|
|
1201
|
+
const flushSelects = () => {
|
|
1202
|
+
const queued = pendingSelects;
|
|
1203
|
+
if (queued === null)
|
|
1204
|
+
return;
|
|
1205
|
+
/** Cleared first: an assignment can run a `change` handler that renders again. */
|
|
1206
|
+
pendingSelects = null;
|
|
1207
|
+
for (let i = 0; i < queued.length; i += 2)
|
|
1208
|
+
queued[i].value = queued[i + 1];
|
|
1209
|
+
};
|
|
1210
|
+
const SCRATCH = doc.createDocumentFragment();
|
|
1211
|
+
/**
|
|
1212
|
+
* Marks a node as the render root's OWN output — see `ChildPart._insert`. Sigil-named so property
|
|
1213
|
+
* mangling cannot rename it: this is read by `@verajs/renderer/slots`, across a bundle boundary,
|
|
1214
|
+
* and a module-scoped Symbol would be minted twice on a CDN page (the `@verajs/styles` lesson).
|
|
1215
|
+
*
|
|
1216
|
+
* A fragment is stamped through to its children, because inserting one moves the children and the
|
|
1217
|
+
* fragment itself never enters the document — the observer reports the children.
|
|
1218
|
+
*
|
|
1219
|
+
* **Defined rather than assigned, so it is NON-ENUMERABLE.** A plain `node._$own$ = true` is an own
|
|
1220
|
+
* enumerable property: measured, it then shows up in `Object.keys(element)` — which is `[]` for
|
|
1221
|
+
* every other DOM element — and in `for…in`. Invisibility to everything outside the framework is
|
|
1222
|
+
* the whole reason this is a property and not a marker or an attribute, and an enumerable one is
|
|
1223
|
+
* not invisible. The descriptor is shared, so this allocates nothing per node, and the path is
|
|
1224
|
+
* gated on slots being wired, so no app that does not use them ever reaches it.
|
|
1225
|
+
*/
|
|
1226
|
+
const OWN_DESCRIPTOR = { value: true, enumerable: false, configurable: true, writable: true };
|
|
1227
|
+
/**
|
|
1228
|
+
* The stamp is VALUED, and the value is the discriminator (`docs` in the slots module read it):
|
|
1229
|
+
*
|
|
1230
|
+
* `true` — the render root's own output: never slot content.
|
|
1231
|
+
* a ChildPart — light content PLACED by that part from an outer template. The part identity
|
|
1232
|
+
* is the ordering group: a grown row belongs after ITS part's other rows, and
|
|
1233
|
+
* `<host>${a}${b}</host>` must not interleave a's refill into b's content —
|
|
1234
|
+
* which is exactly what happens if the group is the render root, shared by both.
|
|
1235
|
+
* absent — an imperative user mutation; the light region orders it by document position.
|
|
1236
|
+
*
|
|
1237
|
+
* One shared, mutated descriptor: `defineProperty` reads it synchronously, so this allocates
|
|
1238
|
+
* nothing per node while keeping the property non-enumerable (see the invisibility note above).
|
|
1239
|
+
*/
|
|
1240
|
+
const stampOwn = (node, value = true) => {
|
|
1241
|
+
OWN_DESCRIPTOR.value = value;
|
|
1242
|
+
if (node.nodeType === 11) {
|
|
1243
|
+
for (let child = node.firstChild; child !== null; child = child.nextSibling)
|
|
1244
|
+
Object.defineProperty(child, '_$own$', OWN_DESCRIPTOR);
|
|
1245
|
+
return;
|
|
1246
|
+
}
|
|
1247
|
+
Object.defineProperty(node, '_$own$', OWN_DESCRIPTOR);
|
|
1248
|
+
};
|
|
1249
|
+
/** A row is either an element-mode instance or a markered part; both can hold appliers. */
|
|
1250
|
+
const detachItem = (item) => {
|
|
1251
|
+
item._instance?._teardown();
|
|
1252
|
+
item._part?._detach();
|
|
1253
|
+
};
|
|
573
1254
|
class Instance {
|
|
574
1255
|
_parts = [];
|
|
575
1256
|
_fragment;
|
|
576
1257
|
constructor(template) {
|
|
577
|
-
/**
|
|
578
|
-
|
|
1258
|
+
/**
|
|
1259
|
+
* `importNode`, not `cloneNode` — the difference is custom-element upgrade, not the document.
|
|
1260
|
+
* Template content lives in the inert template document, so `cloneNode` copies stay
|
|
1261
|
+
* un-upgraded until insertion; a `.prop` committed in that window lands as an OWN property
|
|
1262
|
+
* that permanently shadows a defined class's setter (the setter never fires — every
|
|
1263
|
+
* accessor-based element, Lit's included, receives a dead value) and a bound value on a
|
|
1264
|
+
* class-field element is clobbered by the field initializer at insert, silently, because the
|
|
1265
|
+
* `whenDefined` detector below only watches definitions that arrive LATE. Hydration commits
|
|
1266
|
+
* onto server-parsed, already-upgraded elements, so the two render paths disagreed about the
|
|
1267
|
+
* same template. `importNode`'s cloning steps upgrade defined elements at clone time — in
|
|
1268
|
+
* every engine and in jsdom — which makes the commit order match hydration and the platform.
|
|
1269
|
+
* Undefined elements are untouched: nothing can upgrade them, and the pre-upgrade posture
|
|
1270
|
+
* (own property, clobber on define, development warning) stands as pinned in
|
|
1271
|
+
* `tests/pre-upgrade-property.test.mjs`. Measured cost of losing `cloneNode`: ~2–7% of the
|
|
1272
|
+
* raw clone operation across the three engines — nanoseconds per instance.
|
|
1273
|
+
*/
|
|
1274
|
+
this._fragment = doc.importNode(template._element.content, true);
|
|
579
1275
|
const templateParts = template._parts;
|
|
580
1276
|
/** Shared walker, ELEMENT | TEXT — child anchors are the primed text nodes themselves. */
|
|
581
1277
|
instanceWalker.currentNode = this._fragment;
|
|
@@ -593,14 +1289,130 @@ class Instance {
|
|
|
593
1289
|
}
|
|
594
1290
|
this._parts.push(templatePart._type === CHILD
|
|
595
1291
|
? new TextPart(node)
|
|
596
|
-
: new AttrPart(node, templatePart._name, templatePart._statics));
|
|
1292
|
+
: new AttrPart(node, templatePart._name, templatePart._statics, templatePart._present));
|
|
1293
|
+
}
|
|
1294
|
+
/**
|
|
1295
|
+
* Slot records mount OUTSIDE the parts array — one extra walk from the top, paid only by
|
|
1296
|
+
* templates that HAVE slots, only inside a renderInto commit (null root — hydration's
|
|
1297
|
+
* adoption path — stays inert), and only when the 'slot' insert answers. Taking over sets
|
|
1298
|
+
* `notifyOnRemoval`: `_$park$` must rescue the USER'S nodes before a bulk `_clear` discards
|
|
1299
|
+
* the DOM holding them on a branch-away. `_update` never sees any of this.
|
|
1300
|
+
*/
|
|
1301
|
+
if (template._seam !== undefined && _slotRoot !== null) {
|
|
1302
|
+
const slotRecords = template._slots;
|
|
1303
|
+
/**
|
|
1304
|
+
* RESOLVE every slot element to its clone in ONE walk, and mount them AFTER the first
|
|
1305
|
+
* `_update` — see `_mountSlots`. Collect-then-act, because the seam MUTATES the fragment
|
|
1306
|
+
* (it lifts each `<slot>` out and drops in anchors) and a walk that interleaved resolution
|
|
1307
|
+
* with those mutations would read shifted indices and miss later slots.
|
|
1308
|
+
*/
|
|
1309
|
+
instanceWalker.currentNode = this._fragment;
|
|
1310
|
+
nodeIndex = -1;
|
|
1311
|
+
const slotNodes = [];
|
|
1312
|
+
for (let i = 0; i < slotRecords.length; i++) {
|
|
1313
|
+
while (nodeIndex < slotRecords[i]) {
|
|
1314
|
+
node = instanceWalker.nextNode();
|
|
1315
|
+
nodeIndex++;
|
|
1316
|
+
}
|
|
1317
|
+
slotNodes.push(node);
|
|
1318
|
+
}
|
|
1319
|
+
this._pendingSlots = slotNodes;
|
|
597
1320
|
}
|
|
1321
|
+
/** Standalone rather than an `else` branch: `_slotless` is only ever set when there was no
|
|
1322
|
+
* seam, so the condition stands alone — and a lone `if (true …)` folds away cleanly. */
|
|
1323
|
+
if (true && template._slotless === true && _slotRoot !== null && _slotRoot.nodeType === 1) {
|
|
1324
|
+
/**
|
|
1325
|
+
* **A `<slot>` in a LIGHT render that nothing will distribute.** Both ways of arriving here
|
|
1326
|
+
* are silent otherwise, and both leave the same confusing picture. Measured, for a host given
|
|
1327
|
+
* `<b slot="a">MINE</b>`:
|
|
1328
|
+
*
|
|
1329
|
+
* <b slot="a">MINE</b><!----><div class="box"><slot name="a">FB</slot></div>
|
|
1330
|
+
*
|
|
1331
|
+
* — the content is not destroyed, it is stranded ahead of the render while the slot shows its
|
|
1332
|
+
* fallback. The message says "any content the host is given" rather than asserting the host
|
|
1333
|
+
* HAS some: a component that consumes its own children before rendering and also declares
|
|
1334
|
+
* slots — `@verajs/ui`'s select is one — warns with nothing stray on the page, and a reader
|
|
1335
|
+
* sent looking for markup that is not there concludes the diagnostic is confused.
|
|
1336
|
+
*
|
|
1337
|
+
* 1. `@verajs/renderer/slots` was never wired at all.
|
|
1338
|
+
* 2. It was wired AFTER this template first rendered. Templates are interned per call site
|
|
1339
|
+
* for the life of the page and resolve the seam once, at construction — so a component
|
|
1340
|
+
* that rendered before the wiring keeps a slotless template forever, and every later use
|
|
1341
|
+
* of it fails the same way. Measured: the same `draw()` distributes at a fresh call site
|
|
1342
|
+
* and not at this one.
|
|
1343
|
+
*
|
|
1344
|
+
* A shadow root never reaches here: the platform slots there, which is why this is gated on
|
|
1345
|
+
* an element root.
|
|
1346
|
+
*/
|
|
1347
|
+
warnSlotless(_slotRoot);
|
|
1348
|
+
}
|
|
1349
|
+
}
|
|
1350
|
+
/**
|
|
1351
|
+
* One walk, both jobs: release the element refs in this instance and tell any child applier
|
|
1352
|
+
* under it that it is going away.
|
|
1353
|
+
*
|
|
1354
|
+
* They were two walks over the same array — `_release` for refs, `_detach` for appliers — which
|
|
1355
|
+
* is the same tree traversed twice for two answers that arrive at the same moment. Merged, the
|
|
1356
|
+
* per-part cost is one `_kind` compare and one `_upgraded` read.
|
|
1357
|
+
*
|
|
1358
|
+
* Reached only when this instance's template holds a ref, or some applier somewhere declared
|
|
1359
|
+
* teardown. An app with neither never runs it: this is the per-node work the bulk removal exists
|
|
1360
|
+
* to skip, and the gate is what keeps it out of the path.
|
|
1361
|
+
*
|
|
1362
|
+
* Through `_upgraded`, not just `_parts`. A child position is instantiated as a `TextPart` and
|
|
1363
|
+
* **upgrades** to a `ChildPart` the first time it takes an object — so the part holding a
|
|
1364
|
+
* applier is almost never the one in this array, it is the one that array's entry points at.
|
|
1365
|
+
* Walking `_parts` alone found nothing at all.
|
|
1366
|
+
*/
|
|
1367
|
+
_teardown() {
|
|
1368
|
+
const parts = this._parts;
|
|
1369
|
+
for (let i = 0; i < parts.length; i++) {
|
|
1370
|
+
const part = parts[i];
|
|
1371
|
+
if (part._kind === REF)
|
|
1372
|
+
part._release();
|
|
1373
|
+
part._upgraded?._detach();
|
|
1374
|
+
}
|
|
1375
|
+
/** Taken-over slots park the USER'S nodes before this instance's DOM is discarded. */
|
|
1376
|
+
this._slotStates?.forEach((state) => state._$park$?.());
|
|
598
1377
|
}
|
|
599
1378
|
_update(values) {
|
|
600
1379
|
let valueIndex = 0;
|
|
601
1380
|
const parts = this._parts;
|
|
602
1381
|
for (let i = 0; i < parts.length; i++)
|
|
603
1382
|
valueIndex = parts[i]._commit(values, valueIndex);
|
|
1383
|
+
if (this._pendingSlots !== undefined)
|
|
1384
|
+
this._mountSlots();
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* **Slots mount after the first `_update`, not during construction, because a `<slot>`'s own
|
|
1388
|
+
* bindings are part of its meaning.** `<slot name=${section}>` has no name at all until its
|
|
1389
|
+
* `AttrPart` has committed, and mounting first read the static markup and got `''` — the slot
|
|
1390
|
+
* registered as a second DEFAULT slot, took the default content, and left the real default slot
|
|
1391
|
+
* showing fallback. Committing first also means `@slotchange` and `&ref` are already attached to
|
|
1392
|
+
* the element by the time anything is dispatched on it.
|
|
1393
|
+
*
|
|
1394
|
+
* Once per instance: the fields are cleared here and every later `_update` costs one compare.
|
|
1395
|
+
*/
|
|
1396
|
+
_mountSlots() {
|
|
1397
|
+
const slotNodes = this._pendingSlots;
|
|
1398
|
+
this._pendingSlots = undefined;
|
|
1399
|
+
/**
|
|
1400
|
+
* `_slotRoot` still holds the container: it is set for the whole of one `renderInto` and every
|
|
1401
|
+
* instance under it — nested templates included — is constructed and first-updated inside that
|
|
1402
|
+
* same synchronous span, so this is the root the constructor saw.
|
|
1403
|
+
*/
|
|
1404
|
+
const root = _slotRoot;
|
|
1405
|
+
const seam = slotSeam();
|
|
1406
|
+
if (seam === undefined || root === null)
|
|
1407
|
+
return;
|
|
1408
|
+
for (let i = 0; i < slotNodes.length; i++) {
|
|
1409
|
+
const slot = slotNodes[i];
|
|
1410
|
+
const state = seam(slot, root, slot.getAttribute('name') ?? '');
|
|
1411
|
+
if (state != null) {
|
|
1412
|
+
(this._slotStates ??= []).push(state);
|
|
1413
|
+
notifyOnRemoval = true;
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
604
1416
|
}
|
|
605
1417
|
}
|
|
606
1418
|
/** A single property read — this runs once per list item per render, so it must be minimal. */
|
|
@@ -636,9 +1448,26 @@ class TextPart {
|
|
|
636
1448
|
*/
|
|
637
1449
|
const start = comment();
|
|
638
1450
|
const end = comment();
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
1451
|
+
/**
|
|
1452
|
+
* **Markers go where the part LIVES, which is not always where its text node is.** In a
|
|
1453
|
+
* light host wired for slots, this text node was captured and distributed into the
|
|
1454
|
+
* component's tree — planting markers beside it there put them inside the slot's range,
|
|
1455
|
+
* the slot's next fill swept them into the holding fragment, and the part spent the rest
|
|
1456
|
+
* of the page rendering into detached space (measured: `<host>${text}</host>` toggling
|
|
1457
|
+
* through null showed FALLBACK forever). `_$home$` answers with the host's light-region
|
|
1458
|
+
* sentinel for a captured node and null for everything else, so every app without light
|
|
1459
|
+
* slots takes the second branch untouched.
|
|
1460
|
+
*/
|
|
1461
|
+
const home = slotSeam()?._$home$?.(this._text) ?? null;
|
|
1462
|
+
const parent = home !== null ? home.parentNode : this._text.parentNode;
|
|
1463
|
+
if (home !== null) {
|
|
1464
|
+
parent.insertBefore(start, home);
|
|
1465
|
+
parent.insertBefore(end, home);
|
|
1466
|
+
}
|
|
1467
|
+
else {
|
|
1468
|
+
parent.insertBefore(start, this._text);
|
|
1469
|
+
parent.insertBefore(end, this._text.nextSibling);
|
|
1470
|
+
}
|
|
642
1471
|
const part = new ChildPart(start, end);
|
|
643
1472
|
part._mode = TEXT;
|
|
644
1473
|
part._text = this._text;
|
|
@@ -654,16 +1483,75 @@ class TextPart {
|
|
|
654
1483
|
return index + 1;
|
|
655
1484
|
}
|
|
656
1485
|
}
|
|
1486
|
+
/**
|
|
1487
|
+
* The registry this renderer reads `'value'` handlers from, handed over by {@link renderer}.
|
|
1488
|
+
*
|
|
1489
|
+
* Not imported. The renderer carries no registry of its own for the same reason the router does
|
|
1490
|
+
* not: a production bundle inlines `@verajs/inserts`, so importing it would give this package one
|
|
1491
|
+
* registry and core another, and an app would register into whichever it happened to import — the
|
|
1492
|
+
* failure `connectInserts` used to repair.
|
|
1493
|
+
*/
|
|
1494
|
+
let registry = null;
|
|
1495
|
+
/**
|
|
1496
|
+
* The ONE lookup for the `'slot'` insert. Three callers want the same thing in the same shape —
|
|
1497
|
+
* template construction (are there slots to record?), the first render into a container (capture
|
|
1498
|
+
* the host's children), and hydration's rescue (un-distribute before a mismatch discards) — and
|
|
1499
|
+
* the seam carries its cross-bundle members as sigil-named keys, which every caller had to spell
|
|
1500
|
+
* out again. One accessor, spelled once.
|
|
1501
|
+
*/
|
|
1502
|
+
/**
|
|
1503
|
+
* **Whether ANY app on this page wired light slots**, latched the first time the seam answers.
|
|
1504
|
+
*
|
|
1505
|
+
* The ownership stamp in `_insert`/`$c` exists only for `@verajs/renderer/slots` to read, and its
|
|
1506
|
+
* guard has to be free for everyone else — `_slotRoot` is set for every `renderInto`, so without
|
|
1507
|
+
* this an app with no slots at all would stamp every top-level node it renders, which for a list
|
|
1508
|
+
* at the root is a property write per ROW. One boolean instead, false for the life of a page that
|
|
1509
|
+
* never wires them.
|
|
1510
|
+
*/
|
|
1511
|
+
let slotsWired = false;
|
|
1512
|
+
const slotSeam = () => {
|
|
1513
|
+
const seam = registry?.get('slot')?.[0];
|
|
1514
|
+
if (seam !== undefined)
|
|
1515
|
+
slotsWired = true;
|
|
1516
|
+
return seam;
|
|
1517
|
+
};
|
|
1518
|
+
const noHandlers = [];
|
|
1519
|
+
const valueHandlers = () => (registry ? (registry.get('value') ?? noHandlers) : noHandlers);
|
|
1520
|
+
/**
|
|
1521
|
+
* Kinds this package still ships. They read from a local list rather than the registry because the
|
|
1522
|
+
* renderer cannot register into one it was merely handed — that needs `wire`, which it does not
|
|
1523
|
+
* import. The list empties when they move to packages; until then a wired handler is checked first,
|
|
1524
|
+
* so a module can pre-empt a built-in exactly as the priority order promises.
|
|
1525
|
+
*/
|
|
1526
|
+
const builtIns = [];
|
|
1527
|
+
/**
|
|
1528
|
+
* Whether anything in this process has asked to be told when a subtree is removed — an element ref
|
|
1529
|
+
* to release, or a child applier that declared `_$detach$`.
|
|
1530
|
+
*
|
|
1531
|
+
* **One flag for both, and it is process-wide.** Teardown cannot be discovered from the template the
|
|
1532
|
+
* way a ref can — a ref is a `&` part the scan sees, while an applier arrives as a *value* and no
|
|
1533
|
+
* template shape predicts it — so the coarser gate is the only one that serves both.
|
|
1534
|
+
*
|
|
1535
|
+
* The finer, per-template gate for refs was measured and dropped: it saved 34 B less than nothing,
|
|
1536
|
+
* because the walk it avoided is not the expensive part. With one unrelated ref on the page, a
|
|
1537
|
+
* 1 000-row clear walks 1 000 instances and measures 3.98 ms against 4.03 ms with no ref at all —
|
|
1538
|
+
* the DOM removal dominates completely. What matters is that an app asking for neither walks
|
|
1539
|
+
* **zero**, and that still holds.
|
|
1540
|
+
*/
|
|
1541
|
+
let notifyOnRemoval = false;
|
|
1542
|
+
|
|
1543
|
+
const _applierSwaps = /* @__PURE__ */ new WeakMap();
|
|
657
1544
|
/** What a ChildPart currently contains. */
|
|
658
1545
|
const EMPTY = 0;
|
|
659
1546
|
const TEXT = 1;
|
|
660
1547
|
const TEMPLATE = 2;
|
|
661
1548
|
const LIST = 3;
|
|
1549
|
+
const NODE = 4;
|
|
662
1550
|
/**
|
|
663
1551
|
* Development-only profiling hook, armed by `@verajs/renderer/profiler`. Null until something
|
|
664
1552
|
* arms it, so an unprofiled development render pays one null check per template commit.
|
|
665
1553
|
*
|
|
666
|
-
* Every reference sits behind `true`, which `defineDev()` folds to `false` before terser runs —
|
|
1554
|
+
* Every reference sits behind `true `, which `defineDev()` folds to `false` before terser runs —
|
|
667
1555
|
* so the declaration, the constants and every call site are removed from the production bundle.
|
|
668
1556
|
* Verified by byte comparison, not assumed.
|
|
669
1557
|
*/
|
|
@@ -691,6 +1579,10 @@ class ChildPart {
|
|
|
691
1579
|
_keyedList = false;
|
|
692
1580
|
/** Held instances by template identity; survives clears so state outlives interim content. */
|
|
693
1581
|
_held = null;
|
|
1582
|
+
/** Whatever the last `_$child$` at this part returned — its continuity across renders. */
|
|
1583
|
+
_applierState = undefined;
|
|
1584
|
+
/** Which applier that state belongs to, so two of them at one part cannot read each other's. */
|
|
1585
|
+
_applier = undefined;
|
|
694
1586
|
constructor(start, end) {
|
|
695
1587
|
this._start = start;
|
|
696
1588
|
this._end = end;
|
|
@@ -699,13 +1591,117 @@ class ChildPart {
|
|
|
699
1591
|
this._set(values[index]);
|
|
700
1592
|
return index + 1;
|
|
701
1593
|
}
|
|
1594
|
+
/**
|
|
1595
|
+
* **A component's own output is STAMPED, so the slot system cannot mistake it for content.**
|
|
1596
|
+
*
|
|
1597
|
+
* `@verajs/renderer/slots` captures a top-level element carrying a `slot` attribute as the
|
|
1598
|
+
* host's content — which a component's own rendered root may legitimately be, when it renders
|
|
1599
|
+
* something destined for ITS parent's slot. Measured: with slots wired,
|
|
1600
|
+
* `renderInto(html\`<div slot="x">…</div>\`, element)` distributed the component's output into
|
|
1601
|
+
* its own holding fragment and the component rendered NOTHING, on the first render, with no
|
|
1602
|
+
* children involved and nothing thrown.
|
|
1603
|
+
*
|
|
1604
|
+
* The renderer is the one party that knows: it is inserting at the top level of the container
|
|
1605
|
+
* it was asked to render into. `_slotRoot` is that container for the whole of one `renderInto`,
|
|
1606
|
+
* so `parent === _slotRoot` is exactly "this is the component's own output" and distinguishes it
|
|
1607
|
+
* from `<x-card>${value}</x-card>`, where the part's parent is the host but the render root is
|
|
1608
|
+
* an ancestor — the user's light content, which must still be captured.
|
|
1609
|
+
*
|
|
1610
|
+
* Two comparisons on a path that is already touching the DOM, and the stamp is a PROPERTY:
|
|
1611
|
+
* invisible to CSS, to serialization and to `children`, unlike any marker or attribute, and it
|
|
1612
|
+
* rides on text nodes, which no attribute can. An app without slots wired writes it and nothing
|
|
1613
|
+
* ever reads it.
|
|
1614
|
+
*/
|
|
1615
|
+
/**
|
|
1616
|
+
* **One property read decides all stamping, and root-part-ness decides the value.**
|
|
1617
|
+
*
|
|
1618
|
+
* `_$hosted$` is set on the host element itself by `@verajs/renderer/slots` at capture, so
|
|
1619
|
+
* "does anything care about ownership here" is a single own-property read — no seam call, no
|
|
1620
|
+
* registry lookup, and pages that are not captured hosts (every container in most apps) cost
|
|
1621
|
+
* exactly that read and write nothing. The mark cannot go stale in the direction that matters:
|
|
1622
|
+
* a part's first commit runs in a detached fragment before its host is captured, reads
|
|
1623
|
+
* `undefined`, and stamps nothing — and that content is exactly what the initial capture walk
|
|
1624
|
+
* lifts anyway. Every later commit sees the mark.
|
|
1625
|
+
*
|
|
1626
|
+
* The VALUE is structural, not temporal. `_end === null` is true of root parts alone (see
|
|
1627
|
+
* `_clear`), and a root part's inserts are by definition the render's own output — a fact that
|
|
1628
|
+
* stays true for an applier committing from a microtask hours after `renderInto` returned,
|
|
1629
|
+
* where the earlier `parent === _slotRoot` test read null and left ASYNC output unstamped for
|
|
1630
|
+
* the flipped capture rule to eat. Everything else inserting into a host is placing content
|
|
1631
|
+
* INTO it from outside, stamped with the part — the ordering group.
|
|
1632
|
+
*/
|
|
702
1633
|
_insert(node) {
|
|
703
|
-
this._start.parentNode
|
|
1634
|
+
const parent = this._start.parentNode;
|
|
1635
|
+
if (slotsWired && parent._$hosted$ === true)
|
|
1636
|
+
stampOwn(node, this._end === null ? true : this);
|
|
1637
|
+
parent.insertBefore(node, this._end);
|
|
1638
|
+
}
|
|
1639
|
+
/**
|
|
1640
|
+
* Tells every child applier under this part that it is going away.
|
|
1641
|
+
*
|
|
1642
|
+
* Reached only when some applier somewhere declared teardown — see `notifyOnRemoval` — because
|
|
1643
|
+
* this is the per-node walk the bulk removal exists to skip. **Every** removal path calls it, not
|
|
1644
|
+
* just `_clear`: a keyed row is dropped by moving its nodes to a scratch fragment and an index-mode
|
|
1645
|
+
* list shrinks by removing nodes directly, so a version that only hooked `_clear` notified a
|
|
1646
|
+
* applier when its container was replaced and stayed silent when its row was deleted — told
|
|
1647
|
+
* sometimes, which is a worse contract than never.
|
|
1648
|
+
*/
|
|
1649
|
+
_detach() {
|
|
1650
|
+
if (this._applier !== undefined)
|
|
1651
|
+
this._applier._$detach$?.(this._applierState);
|
|
1652
|
+
this._instance?._teardown();
|
|
1653
|
+
const items = this._items;
|
|
1654
|
+
if (items != null)
|
|
1655
|
+
for (let i = 0; i < items.length; i++)
|
|
1656
|
+
detachItem(items[i]);
|
|
704
1657
|
}
|
|
705
1658
|
_clear() {
|
|
1659
|
+
/**
|
|
1660
|
+
* One gate, two jobs. A template that holds an element ref must release it; a subtree holding a
|
|
1661
|
+
* applier that declared teardown must be told. Both are found by the same walk, and an app
|
|
1662
|
+
* with neither reads two booleans and walks nothing.
|
|
1663
|
+
*/
|
|
1664
|
+
if (notifyOnRemoval)
|
|
1665
|
+
this._detach();
|
|
706
1666
|
const parent = this._start.parentNode;
|
|
707
1667
|
const end = this._end;
|
|
1668
|
+
const items = this._items;
|
|
708
1669
|
/**
|
|
1670
|
+
* **Content that is no longer between the markers.** `@verajs/renderer/slots` distributes a
|
|
1671
|
+
* light host's children by MOVING them into the component's tree, so a part rendering those
|
|
1672
|
+
* children keeps its markers in the host while its content lives inside the component.
|
|
1673
|
+
*
|
|
1674
|
+
* Both branches below are wrong for that, and wrong in opposite directions. The walk finds
|
|
1675
|
+
* the markers adjacent and removes nothing — the content stays on screen after being cleared
|
|
1676
|
+
* (a template swap in a light host showed the OLD template forever). The whole-parent fast
|
|
1677
|
+
* path is the dangerous one: it would `textContent = ''` the HOST, component render and all.
|
|
1678
|
+
*
|
|
1679
|
+
* Every mode knows its content by IDENTITY, which is parent-agnostic and split-proof: items
|
|
1680
|
+
* through `$m`, TEXT through `_text`, NODE through `_value`, TEMPLATE through the top-level
|
|
1681
|
+
* node array recorded at commit. The one shape that cannot be found this way is a
|
|
1682
|
+
* DocumentFragment committed at NODE position (its children scatter and it keeps no record);
|
|
1683
|
+
* that falls through to the walk, as before.
|
|
1684
|
+
*/
|
|
1685
|
+
if (this._start.nextSibling === end && this._mode !== EMPTY) {
|
|
1686
|
+
if (items !== null) {
|
|
1687
|
+
for (const item of items)
|
|
1688
|
+
if (item !== null)
|
|
1689
|
+
this.$m(item, null, SCRATCH);
|
|
1690
|
+
SCRATCH.textContent = '';
|
|
1691
|
+
}
|
|
1692
|
+
else if (this._mode === TEXT) {
|
|
1693
|
+
this._text?.remove();
|
|
1694
|
+
}
|
|
1695
|
+
else if (this._mode === TEMPLATE) {
|
|
1696
|
+
if (Array.isArray(this._value))
|
|
1697
|
+
for (const node of this._value)
|
|
1698
|
+
node.remove();
|
|
1699
|
+
}
|
|
1700
|
+
else if (this._mode === NODE && typeof this._value.remove === 'function') {
|
|
1701
|
+
this._value.remove();
|
|
1702
|
+
}
|
|
1703
|
+
}
|
|
1704
|
+
else /**
|
|
709
1705
|
* When this part owns its parent's entire contents, one `textContent = ''` replaces removing
|
|
710
1706
|
* every node individually. For a 1 000-row table body that is the difference between ~22 ms
|
|
711
1707
|
* (lit-html's per-node teardown) and ~5 ms.
|
|
@@ -717,8 +1713,7 @@ class ChildPart {
|
|
|
717
1713
|
* always owns an end marker, so `_end === null` alone never held for it.
|
|
718
1714
|
*
|
|
719
1715
|
* Re-appending both anchors in order restores the part's boundary exactly as it was.
|
|
720
|
-
*/
|
|
721
|
-
if (this._start.previousSibling === null && (end === null || end.nextSibling === null)) {
|
|
1716
|
+
*/ if (this._start.previousSibling === null && (end === null || end.nextSibling === null)) {
|
|
722
1717
|
parent.textContent = '';
|
|
723
1718
|
parent.appendChild(this._start);
|
|
724
1719
|
if (end !== null)
|
|
@@ -742,6 +1737,27 @@ class ChildPart {
|
|
|
742
1737
|
this._instance = null;
|
|
743
1738
|
this._items = null;
|
|
744
1739
|
this._shape = null;
|
|
1740
|
+
this._applierState = undefined;
|
|
1741
|
+
this._applier = undefined;
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* How a child-position applier renders. Named to survive property mangling — `/^_[a-z]/` is the
|
|
1745
|
+
* pattern, and `_$…$` does not match it — because this is the half of the protocol that third
|
|
1746
|
+
* parties call.
|
|
1747
|
+
*/
|
|
1748
|
+
_$commit$(value) {
|
|
1749
|
+
/**
|
|
1750
|
+
* The applier's own state survives its own rendering. Committing different content usually
|
|
1751
|
+
* runs `_clear`, which drops the state so a part that was emptied by *anything else* cannot
|
|
1752
|
+
* hand an applier continuity it no longer has — but an applier rendering its own next value
|
|
1753
|
+
* has not gone away, and losing continuity there made `until()` fall back to its placeholder on
|
|
1754
|
+
* the render after it resolved.
|
|
1755
|
+
*/
|
|
1756
|
+
const applierState = this._applierState;
|
|
1757
|
+
const applier = this._applier;
|
|
1758
|
+
this._set(value);
|
|
1759
|
+
this._applierState = applierState;
|
|
1760
|
+
this._applier = applier;
|
|
745
1761
|
}
|
|
746
1762
|
_set(value) {
|
|
747
1763
|
if (value == null) {
|
|
@@ -778,7 +1794,7 @@ class ChildPart {
|
|
|
778
1794
|
* them, in practice), commit costs one identity compare before touching the values.
|
|
779
1795
|
*/
|
|
780
1796
|
if (this._shape === value.strings) {
|
|
781
|
-
if (true
|
|
1797
|
+
if (true && _profileHook)
|
|
782
1798
|
_profileHook(PROFILE_UPDATE, this, value.strings);
|
|
783
1799
|
this._instance._update(value.values);
|
|
784
1800
|
return;
|
|
@@ -788,7 +1804,7 @@ class ChildPart {
|
|
|
788
1804
|
* subtree below is about to be destroyed and rebuilt rather than updated. That is what
|
|
789
1805
|
* `?hidden=${…}` over a swapped subtree exists to avoid, and it is otherwise invisible.
|
|
790
1806
|
*/
|
|
791
|
-
if (true
|
|
1807
|
+
if (true && _profileHook) {
|
|
792
1808
|
_profileHook(this._mode === TEMPLATE ? PROFILE_REBUILD : PROFILE_CREATE, this, value.strings);
|
|
793
1809
|
}
|
|
794
1810
|
const template = getTemplate(value);
|
|
@@ -796,18 +1812,86 @@ class ChildPart {
|
|
|
796
1812
|
this._clear();
|
|
797
1813
|
const instance = new Instance(template);
|
|
798
1814
|
instance._update(value.values);
|
|
1815
|
+
/**
|
|
1816
|
+
* The instance's top-level nodes, recorded while they are still in the fragment. `_value`
|
|
1817
|
+
* is unused in TEMPLATE mode, and this is what lets `_clear` and `hold`'s parking find the
|
|
1818
|
+
* content after `@verajs/renderer/slots` has moved it out of the marker range — per node,
|
|
1819
|
+
* parent-agnostic, so even content split across two slots comes back. Costs one small array
|
|
1820
|
+
* on a path that just built an Instance and cloned a template; same-shape updates never
|
|
1821
|
+
* reach here.
|
|
1822
|
+
*/
|
|
1823
|
+
this._value = [...instance._fragment.childNodes];
|
|
799
1824
|
this._insert(instance._fragment);
|
|
800
1825
|
this._instance = instance;
|
|
801
1826
|
this._shape = value.strings;
|
|
802
1827
|
this._mode = TEMPLATE;
|
|
803
1828
|
return;
|
|
804
1829
|
}
|
|
805
|
-
|
|
806
|
-
|
|
1830
|
+
const handlers = valueHandlers();
|
|
1831
|
+
for (let i = 0; i < handlers.length; i++)
|
|
1832
|
+
if (handlers[i](this, value))
|
|
1833
|
+
return;
|
|
1834
|
+
for (let i = 0; i < builtIns.length; i++)
|
|
1835
|
+
if (builtIns[i](this, value))
|
|
1836
|
+
return;
|
|
1837
|
+
/**
|
|
1838
|
+
* **A child-position value that applies itself.** The same idea as `_$apply$` at element
|
|
1839
|
+
* position — which is how `@verajs/renderer/spread` ships as a separate package the renderer
|
|
1840
|
+
* knows nothing about — at the one other position worth extending.
|
|
1841
|
+
*
|
|
1842
|
+
* `_$child$(part, previous)` is handed the part and whatever it returned last time at this
|
|
1843
|
+
* part, and calls `part._$commit$(value)` to render content. Keeping continuity in the return
|
|
1844
|
+
* value rather than in an applier *instance* is what keeps this a protocol rather than a
|
|
1845
|
+
* framework: there is no base class, no factory and no lifecycle to learn, and an applier is
|
|
1846
|
+
* an object literal.
|
|
1847
|
+
*
|
|
1848
|
+
* Placed **after** the template check on purpose. A template is overwhelmingly the common
|
|
1849
|
+
* object at a child position, and it returns above without ever reading this property — so the
|
|
1850
|
+
* check costs the hot path nothing and only arrays, nodes and appliers pay for it. Measured:
|
|
1851
|
+
* +22 B gzipped, and no runtime difference distinguishable from noise.
|
|
1852
|
+
*
|
|
1853
|
+
* There is deliberately no teardown hook. `_clear` bulk-removes DOM and, when the part owns its
|
|
1854
|
+
* parent, does `parent.textContent = ''` — the thing that makes clearing a 1 000-row table ~5 ms
|
|
1855
|
+
* against lit-html's ~22 ms. Calling teardown on a nested applier would mean walking the part
|
|
1856
|
+
* tree on every removal, which is precisely the per-node work that fast path exists to skip. So
|
|
1857
|
+
* an applier here can render, and cannot yet be told it has gone away.
|
|
1858
|
+
*/
|
|
1859
|
+
const applyChild = value._$child$;
|
|
1860
|
+
if (applyChild !== undefined) {
|
|
1861
|
+
/** `previous` belongs to *this* applier; a different one at the same part starts fresh. */
|
|
1862
|
+
const previous = this._applier === applyChild ? this._applierState : undefined;
|
|
1863
|
+
|
|
1864
|
+
if (true && this._applier !== undefined && this._applier !== applyChild) {
|
|
1865
|
+
const swaps = (_applierSwaps.get(this) ?? 0) + 1;
|
|
1866
|
+
_applierSwaps.set(this, swaps);
|
|
1867
|
+
if (swaps === 3) {
|
|
1868
|
+
console.warn(`[vera] a child applier changed identity ${swaps} times at one part, so \`previous\` ` +
|
|
1869
|
+
`is always undefined and it restarts every render.\n` +
|
|
1870
|
+
`Hoist the applier — written as an object-literal method it is a new function per ` +
|
|
1871
|
+
`call:\n\n` +
|
|
1872
|
+
` function applyThing(part, previous) { … } // once, at module scope\n` +
|
|
1873
|
+
` const thing = (x) => ({ _$child$: applyThing, x }); // state on the object\n`);
|
|
1874
|
+
}
|
|
1875
|
+
}
|
|
1876
|
+
this._applier = applyChild;
|
|
1877
|
+
if (applyChild._$detach$ !== undefined)
|
|
1878
|
+
notifyOnRemoval = true;
|
|
1879
|
+
this._applierState = applyChild.call(value, this, previous);
|
|
807
1880
|
return;
|
|
808
1881
|
}
|
|
809
|
-
if (
|
|
810
|
-
|
|
1882
|
+
if (value.nodeType !== undefined) {
|
|
1883
|
+
/**
|
|
1884
|
+
* A DOM node renders as itself — a canvas a charting library owns, a `<template>`'s content,
|
|
1885
|
+
* an element built by hand. Placed after the template check and before the list check
|
|
1886
|
+
* because `nodeType` is one property read and nothing else that reaches here has one.
|
|
1887
|
+
*/
|
|
1888
|
+
if (this._mode !== NODE || this._value !== value) {
|
|
1889
|
+
if (this._mode !== EMPTY)
|
|
1890
|
+
this._clear();
|
|
1891
|
+
this._insert(value);
|
|
1892
|
+
this._value = value;
|
|
1893
|
+
this._mode = NODE;
|
|
1894
|
+
}
|
|
811
1895
|
return;
|
|
812
1896
|
}
|
|
813
1897
|
// any other object: render as text
|
|
@@ -821,13 +1905,21 @@ class ChildPart {
|
|
|
821
1905
|
}
|
|
822
1906
|
const held = (this._held ??= new Map());
|
|
823
1907
|
if (this._mode === TEMPLATE) {
|
|
824
|
-
/** Park the live nodes back in their instance's own (empty) fragment.
|
|
1908
|
+
/** Park the live nodes back in their instance's own (empty) fragment. When the range is
|
|
1909
|
+
* empty but content existed, slots relocated it — the recorded top-level nodes park it
|
|
1910
|
+
* from wherever it lives, split slots and holding included. */
|
|
825
1911
|
const fragment = this._instance._fragment;
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
1912
|
+
if (this._start.nextSibling === this._end && Array.isArray(this._value)) {
|
|
1913
|
+
for (const node of this._value)
|
|
1914
|
+
fragment.appendChild(node);
|
|
1915
|
+
}
|
|
1916
|
+
else {
|
|
1917
|
+
let node = this._start.nextSibling;
|
|
1918
|
+
while (node !== this._end) {
|
|
1919
|
+
const next = node.nextSibling;
|
|
1920
|
+
fragment.appendChild(node);
|
|
1921
|
+
node = next;
|
|
1922
|
+
}
|
|
831
1923
|
}
|
|
832
1924
|
held.set(this._shape, this._instance);
|
|
833
1925
|
}
|
|
@@ -836,6 +1928,7 @@ class ChildPart {
|
|
|
836
1928
|
}
|
|
837
1929
|
const instance = held.get(result.strings) ?? new Instance(getTemplate(result));
|
|
838
1930
|
instance._update(result.values);
|
|
1931
|
+
this._value = [...instance._fragment.childNodes];
|
|
839
1932
|
this._insert(instance._fragment);
|
|
840
1933
|
this._instance = instance;
|
|
841
1934
|
this._shape = result.strings;
|
|
@@ -845,7 +1938,15 @@ class ChildPart {
|
|
|
845
1938
|
* Creates one list item. A single-root template instance becomes an element-mode item with no
|
|
846
1939
|
* markers at all; anything else gets its own start/end marker pair so moves can never dangle.
|
|
847
1940
|
*/
|
|
848
|
-
|
|
1941
|
+
$c(value, parent, ref) {
|
|
1942
|
+
/** Rows reach the DOM here rather than through `_insert`; same one-read gate, same
|
|
1943
|
+
* structural value — a root list's rows are the render's own output, any other part's rows
|
|
1944
|
+
* are content it places into the host, stamped with the part as the ordering group. */
|
|
1945
|
+
const stamp = slotsWired && parent._$hosted$ === true
|
|
1946
|
+
? this._end === null
|
|
1947
|
+
? true
|
|
1948
|
+
: this
|
|
1949
|
+
: null;
|
|
849
1950
|
if (value !== null && typeof value === 'object' && value.strings !== undefined) {
|
|
850
1951
|
const result = value;
|
|
851
1952
|
const template = getTemplate(result);
|
|
@@ -853,9 +1954,11 @@ class ChildPart {
|
|
|
853
1954
|
instance._update(result.values);
|
|
854
1955
|
const rootNode = instance._fragment.firstChild;
|
|
855
1956
|
if (rootNode !== null && rootNode.nodeType === 1 && rootNode.nextSibling === null) {
|
|
1957
|
+
if (stamp !== null)
|
|
1958
|
+
stampOwn(rootNode, stamp);
|
|
856
1959
|
parent.insertBefore(rootNode, ref);
|
|
857
1960
|
return {
|
|
858
|
-
|
|
1961
|
+
$k: result.key,
|
|
859
1962
|
_element: rootNode,
|
|
860
1963
|
_instance: instance,
|
|
861
1964
|
_shape: result.strings,
|
|
@@ -867,15 +1970,18 @@ class ChildPart {
|
|
|
867
1970
|
part._instance = instance;
|
|
868
1971
|
part._shape = result.strings;
|
|
869
1972
|
part._mode = TEMPLATE;
|
|
1973
|
+
part._value = [...instance._fragment.childNodes];
|
|
1974
|
+
if (stamp !== null)
|
|
1975
|
+
stampOwn(instance._fragment, stamp);
|
|
870
1976
|
part._start.parentNode.insertBefore(instance._fragment, part._end);
|
|
871
|
-
return {
|
|
1977
|
+
return { $k: result.key, _element: null, _instance: null, _shape: null, _part: part };
|
|
872
1978
|
}
|
|
873
1979
|
const part = createMarkeredPart(parent, ref);
|
|
874
1980
|
part._set(value);
|
|
875
|
-
return {
|
|
1981
|
+
return { $k: value?.key, _element: null, _instance: null, _shape: null, _part: part };
|
|
876
1982
|
}
|
|
877
1983
|
/** Commits a new value into an existing item, demoting element mode if the shape changed. */
|
|
878
|
-
|
|
1984
|
+
$u(item, value) {
|
|
879
1985
|
if (item._element !== null) {
|
|
880
1986
|
if (value !== null && typeof value === 'object' && value.strings === item._shape) {
|
|
881
1987
|
item._instance._update(value.values);
|
|
@@ -893,10 +1999,28 @@ class ChildPart {
|
|
|
893
1999
|
item._part._set(value);
|
|
894
2000
|
}
|
|
895
2001
|
/** The item's first node — its move/removal handle and the insertion reference before it. */
|
|
896
|
-
|
|
2002
|
+
$f(item) {
|
|
897
2003
|
return item._element ?? item._part._start;
|
|
898
2004
|
}
|
|
899
|
-
|
|
2005
|
+
/**
|
|
2006
|
+
* Moving and removing an item read `_element` and `_part`, which are mangled — so they stay here
|
|
2007
|
+
* rather than travelling with the algorithm that calls them. `$m` and `$d` are the price: two
|
|
2008
|
+
* cold methods, exempt from mangling, two characters each.
|
|
2009
|
+
*/
|
|
2010
|
+
$m(item, ref, parent = this._start.parentNode) {
|
|
2011
|
+
/**
|
|
2012
|
+
* **Already where it is going.** A reorder asks for many positions that are already correct,
|
|
2013
|
+
* and re-inserting a node that is in place is not free: it detaches and re-attaches, which
|
|
2014
|
+
* blurs focus, restarts a CSS transition and wakes every MutationObserver watching. The
|
|
2015
|
+
* relocated path below leans on this — it re-places every item rather than computing which
|
|
2016
|
+
* ones moved — but the ordinary two-ended diff gets the same saving.
|
|
2017
|
+
*
|
|
2018
|
+
* The item's LAST node is the one whose `nextSibling` decides this, and reading `_element` /
|
|
2019
|
+
* `_part._end` is why the check lives here rather than travelling with the algorithm.
|
|
2020
|
+
*/
|
|
2021
|
+
const last = item._element ?? item._part._end;
|
|
2022
|
+
if (last.nextSibling === ref && last.parentNode === parent)
|
|
2023
|
+
return;
|
|
900
2024
|
if (item._element !== null) {
|
|
901
2025
|
parent.insertBefore(item._element, ref);
|
|
902
2026
|
return;
|
|
@@ -910,8 +2034,10 @@ class ChildPart {
|
|
|
910
2034
|
}
|
|
911
2035
|
}
|
|
912
2036
|
/** Removal is a move into a scratch fragment that is immediately emptied. */
|
|
913
|
-
|
|
914
|
-
|
|
2037
|
+
$d(item) {
|
|
2038
|
+
if (notifyOnRemoval)
|
|
2039
|
+
detachItem(item);
|
|
2040
|
+
this.$m(item, null, SCRATCH);
|
|
915
2041
|
SCRATCH.textContent = '';
|
|
916
2042
|
}
|
|
917
2043
|
_commitList(newValues) {
|
|
@@ -931,7 +2057,7 @@ class ChildPart {
|
|
|
931
2057
|
}
|
|
932
2058
|
return;
|
|
933
2059
|
}
|
|
934
|
-
const isKeyed = newValues[0] != null && newValues[0]
|
|
2060
|
+
const isKeyed = newValues[0] != null && newValues[0].$r !== undefined;
|
|
935
2061
|
if (isKeyed !== this._keyedList && this._items.length) {
|
|
936
2062
|
this._clear();
|
|
937
2063
|
this._items = [];
|
|
@@ -944,7 +2070,7 @@ class ChildPart {
|
|
|
944
2070
|
/** Initial fill builds off-document and lands in one insert. */
|
|
945
2071
|
const fragment = doc.createDocumentFragment();
|
|
946
2072
|
for (let i = 0; i < count; i++)
|
|
947
|
-
items.push(this
|
|
2073
|
+
items.push(this.$c(newValues[i], fragment, null));
|
|
948
2074
|
this._insert(fragment);
|
|
949
2075
|
return;
|
|
950
2076
|
}
|
|
@@ -952,159 +2078,185 @@ class ChildPart {
|
|
|
952
2078
|
// index mode: update in place, grow at the end, shrink from the end
|
|
953
2079
|
const shared = items.length < count ? items.length : count;
|
|
954
2080
|
for (let i = 0; i < shared; i++)
|
|
955
|
-
this
|
|
2081
|
+
this.$u(items[i], newValues[i]);
|
|
956
2082
|
if (count > items.length) {
|
|
957
2083
|
const fragment = doc.createDocumentFragment();
|
|
958
2084
|
for (let i = items.length; i < count; i++)
|
|
959
|
-
items.push(this
|
|
2085
|
+
items.push(this.$c(newValues[i], fragment, null));
|
|
960
2086
|
this._insert(fragment);
|
|
961
2087
|
}
|
|
962
2088
|
else if (count < items.length) {
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
2089
|
+
if (notifyOnRemoval)
|
|
2090
|
+
for (let i = count; i < items.length; i++)
|
|
2091
|
+
detachItem(items[i]);
|
|
2092
|
+
/**
|
|
2093
|
+
* **Removed through the items, not by walking the range.** The walk this replaced ran from
|
|
2094
|
+
* the first doomed item to the last one's end and called `parent.removeChild` on each node,
|
|
2095
|
+
* which assumes every one of them is still a child of `parent`. `@verajs/renderer/slots`
|
|
2096
|
+
* moves a light host's children into the component's tree, and the walk then threw
|
|
2097
|
+
* `NotFoundError` out of the middle of a render — a plain `<x-card>${rows}</x-card>` losing
|
|
2098
|
+
* one row was enough, with no keyed list anywhere in it.
|
|
2099
|
+
*
|
|
2100
|
+
* `$m` into the scratch fragment is indifferent to where a node currently lives, and the
|
|
2101
|
+
* batch is dropped by one clear at the end, so the contiguous-run saving the walk was for
|
|
2102
|
+
* is kept.
|
|
2103
|
+
*/
|
|
2104
|
+
for (let i = count; i < items.length; i++)
|
|
2105
|
+
this.$m(items[i], null, SCRATCH);
|
|
2106
|
+
SCRATCH.textContent = '';
|
|
971
2107
|
items.length = count;
|
|
972
2108
|
}
|
|
973
2109
|
return;
|
|
974
2110
|
}
|
|
975
2111
|
/**
|
|
976
|
-
*
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
*
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
this._updateItem(items[i], newValues[i]);
|
|
985
|
-
i++;
|
|
986
|
-
}
|
|
987
|
-
if (i === count)
|
|
988
|
-
return;
|
|
989
|
-
}
|
|
990
|
-
/**
|
|
991
|
-
* Keyed reconciliation — the standard head/tail algorithm (as in lit's `repeat` and Vue):
|
|
992
|
-
* skip matching prefixes and suffixes, detect the two swap shapes directly, and fall back to
|
|
993
|
-
* key maps for arbitrary moves, removals and insertions.
|
|
2112
|
+
* Keyed reconciliation is not here. It lives in `@verajs/renderer/keyed`, and it arrives on
|
|
2113
|
+
* the values themselves — `keyed()` stamps each result with the strategy that understands it,
|
|
2114
|
+
* so importing the marker is what loads the algorithm. Nothing registers, nothing is wired, and
|
|
2115
|
+
* two strategies cannot disagree about a list because the list names its own.
|
|
2116
|
+
*
|
|
2117
|
+
* The protocol is three cold members (`$c`, `$u`, `$f`) plus a returned array. Everything a
|
|
2118
|
+
* strategy would otherwise have to reach for — the mode switch, the empty case, the initial
|
|
2119
|
+
* fill — is already done above and passed in.
|
|
994
2120
|
*/
|
|
995
|
-
|
|
996
|
-
const newKeys = new Array(count);
|
|
997
|
-
for (let i = 0; i < count; i++)
|
|
998
|
-
newKeys[i] = newValues[i].key;
|
|
999
|
-
const newItems = new Array(count);
|
|
1000
|
-
let oldHead = 0;
|
|
1001
|
-
let oldTail = oldItems.length - 1;
|
|
1002
|
-
let newHead = 0;
|
|
1003
|
-
let newTail = count - 1;
|
|
1004
|
-
let newKeyToIndex;
|
|
1005
|
-
let oldKeyToIndex;
|
|
1006
|
-
const refAt = (i) => i < count && newItems[i] !== undefined ? this._firstNode(newItems[i]) : this._end;
|
|
1007
|
-
while (oldHead <= oldTail && newHead <= newTail) {
|
|
1008
|
-
if (oldItems[oldHead] === null)
|
|
1009
|
-
oldHead++;
|
|
1010
|
-
else if (oldItems[oldTail] === null)
|
|
1011
|
-
oldTail--;
|
|
1012
|
-
else if (oldItems[oldHead]._key === newKeys[newHead]) {
|
|
1013
|
-
this._updateItem((newItems[newHead] = oldItems[oldHead]), newValues[newHead]);
|
|
1014
|
-
oldHead++;
|
|
1015
|
-
newHead++;
|
|
1016
|
-
}
|
|
1017
|
-
else if (oldItems[oldTail]._key === newKeys[newTail]) {
|
|
1018
|
-
this._updateItem((newItems[newTail] = oldItems[oldTail]), newValues[newTail]);
|
|
1019
|
-
oldTail--;
|
|
1020
|
-
newTail--;
|
|
1021
|
-
}
|
|
1022
|
-
else if (oldItems[oldHead]._key === newKeys[newTail]) {
|
|
1023
|
-
const item = oldItems[oldHead];
|
|
1024
|
-
this._moveItem(item, refAt(newTail + 1));
|
|
1025
|
-
this._updateItem(item, newValues[newTail]);
|
|
1026
|
-
newItems[newTail] = item;
|
|
1027
|
-
oldHead++;
|
|
1028
|
-
newTail--;
|
|
1029
|
-
}
|
|
1030
|
-
else if (oldItems[oldTail]._key === newKeys[newHead]) {
|
|
1031
|
-
const item = oldItems[oldTail];
|
|
1032
|
-
this._moveItem(item, this._firstNode(oldItems[oldHead]));
|
|
1033
|
-
this._updateItem(item, newValues[newHead]);
|
|
1034
|
-
newItems[newHead] = item;
|
|
1035
|
-
oldTail--;
|
|
1036
|
-
newHead++;
|
|
1037
|
-
}
|
|
1038
|
-
else {
|
|
1039
|
-
if (newKeyToIndex === undefined) {
|
|
1040
|
-
newKeyToIndex = new Map();
|
|
1041
|
-
for (let i = newHead; i <= newTail; i++)
|
|
1042
|
-
newKeyToIndex.set(newKeys[i], i);
|
|
1043
|
-
oldKeyToIndex = new Map();
|
|
1044
|
-
for (let i = oldHead; i <= oldTail; i++) {
|
|
1045
|
-
if (oldItems[i] !== null)
|
|
1046
|
-
oldKeyToIndex.set(oldItems[i]._key, i);
|
|
1047
|
-
}
|
|
1048
|
-
}
|
|
1049
|
-
if (!newKeyToIndex.has(oldItems[oldHead]._key)) {
|
|
1050
|
-
this._dropItem(oldItems[oldHead]);
|
|
1051
|
-
oldHead++;
|
|
1052
|
-
}
|
|
1053
|
-
else if (!newKeyToIndex.has(oldItems[oldTail]._key)) {
|
|
1054
|
-
this._dropItem(oldItems[oldTail]);
|
|
1055
|
-
oldTail--;
|
|
1056
|
-
}
|
|
1057
|
-
else {
|
|
1058
|
-
const oldIndex = oldKeyToIndex.get(newKeys[newHead]);
|
|
1059
|
-
if (oldIndex === undefined) {
|
|
1060
|
-
newItems[newHead] = this._createItem(newValues[newHead], parent, this._firstNode(oldItems[oldHead]));
|
|
1061
|
-
}
|
|
1062
|
-
else {
|
|
1063
|
-
const item = oldItems[oldIndex];
|
|
1064
|
-
this._moveItem(item, this._firstNode(oldItems[oldHead]));
|
|
1065
|
-
this._updateItem(item, newValues[newHead]);
|
|
1066
|
-
newItems[newHead] = item;
|
|
1067
|
-
oldItems[oldIndex] = null;
|
|
1068
|
-
}
|
|
1069
|
-
newHead++;
|
|
1070
|
-
}
|
|
1071
|
-
}
|
|
1072
|
-
}
|
|
1073
|
-
while (newHead <= newTail) {
|
|
1074
|
-
newItems[newHead] = this._createItem(newValues[newHead], parent, refAt(newTail + 1));
|
|
1075
|
-
newHead++;
|
|
1076
|
-
}
|
|
1077
|
-
while (oldHead <= oldTail) {
|
|
1078
|
-
const item = oldItems[oldHead++];
|
|
1079
|
-
if (item !== null)
|
|
1080
|
-
this._dropItem(item);
|
|
1081
|
-
}
|
|
1082
|
-
this._items = newItems;
|
|
2121
|
+
this._items = newValues[0].$r(this, newValues, items, parent, this._end);
|
|
1083
2122
|
}
|
|
1084
2123
|
}
|
|
1085
2124
|
const rootParts = new WeakMap();
|
|
1086
2125
|
/**
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
2126
|
+
* Writes a template result into a container. The renderer's imperative draw: no reactivity, no
|
|
2127
|
+
* lifecycle, no knowledge of components. Slots into Vera via `wire([renderer])`; core's built-in
|
|
2128
|
+
* `html` tag already produces the accepted shape, so no `setHtml` call is required — though
|
|
2129
|
+
* lit-html's `html` also works, its results being structurally identical.
|
|
2130
|
+
*
|
|
2131
|
+
* **It owns its own range and nothing else.** The first call appends a marker and anchors a root
|
|
2132
|
+
* part there; later calls with the same container reuse that part and walk only the value slots, so
|
|
2133
|
+
* nodes are updated in place rather than rebuilt. Content that was already in the container stays.
|
|
1090
2134
|
*
|
|
1091
|
-
*
|
|
2135
|
+
* **Named for the relationship, not the act.** It was `render` until 0.2.0, which collided with
|
|
2136
|
+
* core's `render` — a different function, with a different arity, that declares a *reactive*
|
|
2137
|
+
* template and commits a component's setup. Both were public and both were documented, so a reader
|
|
2138
|
+
* who knew one misread the other. `renderElement` and `renderDom` were considered and rejected: this
|
|
2139
|
+
* renders *into* a container, and the container is a `Node` — a shadow root and a fragment are both
|
|
2140
|
+
* valid, so "element" would be a lie in the type. Argument order is lit-html's on purpose.
|
|
2141
|
+
*
|
|
2142
|
+
* HYDRATION lives in `@verajs/renderer/hydrate` — a drop-in superset entry whose `renderInto` adopts
|
|
1092
2143
|
* existing server-rendered children on first render. SSR apps import from there instead of here;
|
|
1093
2144
|
* this entry carries zero hydration code.
|
|
1094
2145
|
*/
|
|
1095
|
-
const
|
|
1096
|
-
|
|
2146
|
+
const renderInto = (result, container) => {
|
|
2147
|
+
/**
|
|
2148
|
+
* The container is the argument people forget, and forgetting it failed with
|
|
2149
|
+
* `Cannot read properties of undefined (reading 'appendChild')` — a message about the internals of
|
|
2150
|
+
* a function the caller never named. Everything after this line assumes a node.
|
|
2151
|
+
*/
|
|
2152
|
+
if (true && (!container || typeof container.appendChild !== 'function'))
|
|
2153
|
+
throw new TypeError(`renderInto: expected a container node as the second argument and received ${String(container)}. ` +
|
|
2154
|
+
`It renders *into* something — \`renderInto(html\`…\`, document.body)\`.`);
|
|
2155
|
+
if (true && _profileHook)
|
|
1097
2156
|
_profileHook(PROFILE_FRAME_START, container, null);
|
|
1098
2157
|
let part = rootParts.get(container);
|
|
1099
2158
|
if (part === undefined) {
|
|
2159
|
+
/**
|
|
2160
|
+
* FIRST render into this container. If it is a light element host and a 'slot' insert is
|
|
2161
|
+
* wired, capture its children NOW — so slot content provided before its (possibly
|
|
2162
|
+
* conditional) `<slot>` mounts is held rather than left visible in the host, matching native
|
|
2163
|
+
* "unassigned light children do not render". Once per container lifetime; shadow roots
|
|
2164
|
+
* (nodeType 11) and fragments are excluded.
|
|
2165
|
+
*/
|
|
2166
|
+
/**
|
|
2167
|
+
* **The marker goes in FIRST, and capture is handed it as the light region's boundary.**
|
|
2168
|
+
*
|
|
2169
|
+
* This part's start marker already delimits where the render's output begins, so the boundary
|
|
2170
|
+
* slots needs is a node the renderer was creating anyway — the sentinel it used to append for
|
|
2171
|
+
* itself landed immediately before this one, two adjacent comments doing the same job. Passing
|
|
2172
|
+
* it removes one comment from every light host and keeps the two in step by construction: they
|
|
2173
|
+
* cannot drift apart if they are the same node.
|
|
2174
|
+
*
|
|
2175
|
+
* Appending before capture is safe and necessary. Safe because a comment is never a slottable,
|
|
2176
|
+
* so the children walk steps over it; necessary because capture LIFTS the host's children, and
|
|
2177
|
+
* a marker appended afterwards would land in the same place either way — this way slots has it.
|
|
2178
|
+
*/
|
|
1100
2179
|
const marker = comment();
|
|
1101
2180
|
container.appendChild(marker);
|
|
2181
|
+
if (container.nodeType === 1)
|
|
2182
|
+
slotSeam()?._$capture$?.(container, marker);
|
|
1102
2183
|
rootParts.set(container, (part = new ChildPart(marker, null)));
|
|
1103
2184
|
}
|
|
1104
|
-
|
|
1105
|
-
|
|
2185
|
+
/**
|
|
2186
|
+
* **The flush is in a `finally`, and that is not tidiness.** A render that throws after a
|
|
2187
|
+
* `<select>.value` has been queued but before the flush left the queue holding the element — which
|
|
2188
|
+
* retains it in module state, and, worse, hands the stranded value to the *next* `renderInto` call.
|
|
2189
|
+
* An unrelated component's render then silently changed a select it has nothing to do with.
|
|
2190
|
+
* Measured: a failed update left the value to be applied by the following render.
|
|
2191
|
+
*
|
|
2192
|
+
* Flushing on the way out applies it with its own pass, where it belongs, and leaves nothing
|
|
2193
|
+
* behind either way. The error still propagates.
|
|
2194
|
+
*/
|
|
2195
|
+
_slotRoot = container;
|
|
2196
|
+
try {
|
|
2197
|
+
part._set(result);
|
|
2198
|
+
}
|
|
2199
|
+
finally {
|
|
2200
|
+
_slotRoot = null;
|
|
2201
|
+
flushSelects();
|
|
2202
|
+
}
|
|
2203
|
+
if (true && _profileHook)
|
|
1106
2204
|
_profileHook(PROFILE_FRAME_END, container, null);
|
|
1107
2205
|
};
|
|
2206
|
+
/**
|
|
2207
|
+
* Lists, as a registered kind rather than a branch — the built-in going through the same door a
|
|
2208
|
+
* package will. Moving it to `@verajs/renderer/lists` is step 5; nothing else has to change when
|
|
2209
|
+
* it does, which is what this shape is for.
|
|
2210
|
+
*/
|
|
2211
|
+
builtIns.push((part, value) => {
|
|
2212
|
+
if (Array.isArray(value)) {
|
|
2213
|
+
part._commitList(value);
|
|
2214
|
+
return true;
|
|
2215
|
+
}
|
|
2216
|
+
if (value !== null && typeof value[Symbol.iterator] === 'function') {
|
|
2217
|
+
part._commitList([...value]);
|
|
2218
|
+
return true;
|
|
2219
|
+
}
|
|
2220
|
+
return false;
|
|
2221
|
+
});
|
|
2222
|
+
/**
|
|
2223
|
+
* Everything this renderer needs, in one entry: `wire([renderer])`.
|
|
2224
|
+
*
|
|
2225
|
+
* It registers on the `'render'` chain *and* takes the registry, because a package that both
|
|
2226
|
+
* provides a capability and reads one should not cost an app two lines. This replaced
|
|
2227
|
+
* `setRenderer`, which existed only because there was no general way to say "this app has a
|
|
2228
|
+
* renderer" — and which resolved the shadow root at registration, so a renderer wired any other
|
|
2229
|
+
* way silently rendered into the light DOM. That resolution lives in core's dispatch now.
|
|
2230
|
+
*/
|
|
2231
|
+
/**
|
|
2232
|
+
* A `true `-only hint for `wire`, so the module and the raw function beside it can share a package
|
|
2233
|
+
* without wiring the wrong one being silent.
|
|
2234
|
+
*
|
|
2235
|
+
* A bare function has no `on`, so `wire` reads it as a connector and hands it the registry. Nothing
|
|
2236
|
+
* registers, nothing throws, and the page renders nothing. The marker lets `wire` name the export
|
|
2237
|
+
* that was meant. This mattered most when the function was called `render` and the mistake was two
|
|
2238
|
+
* characters wide; `renderInto` is harder to confuse, and the guard costs nothing in production.
|
|
2239
|
+
*
|
|
2240
|
+
* `$module` is deliberately generic — any package exporting a raw function next to a module of a
|
|
2241
|
+
* similar name can set it. Production carries neither the property nor the check that reads it.
|
|
2242
|
+
*/
|
|
2243
|
+
if (true )
|
|
2244
|
+
renderInto.$module = 'renderer';
|
|
2245
|
+
const renderer = {
|
|
2246
|
+
name: '@verajs/renderer',
|
|
2247
|
+
on: 'render',
|
|
2248
|
+
fn: renderInto,
|
|
2249
|
+
priority: 50,
|
|
2250
|
+
/**
|
|
2251
|
+
* Typed against the registry `wire` actually hands over, not a narrower shape that happens to
|
|
2252
|
+
* describe the one lookup this makes. A structural `{ get(name: 'value'): … }` is **not**
|
|
2253
|
+
* assignable from `Inserts`, so `wire([renderer])` failed to compile in a consumer's project while
|
|
2254
|
+
* this repo's own typecheck — which reads sources, not the shipped `.d.ts` — saw nothing.
|
|
2255
|
+
*/
|
|
2256
|
+
connect: (given) => {
|
|
2257
|
+
registry = given;
|
|
2258
|
+
},
|
|
2259
|
+
};
|
|
1108
2260
|
|
|
1109
2261
|
const CSS = `
|
|
1110
2262
|
:host { all: initial; }
|
|
@@ -1254,20 +2406,26 @@ const mountOverlay = (read, isActive, control, options = {}) => {
|
|
|
1254
2406
|
* (or bundler alias) at it instead of `@verajs/renderer` and nothing else changes:
|
|
1255
2407
|
*
|
|
1256
2408
|
* ```js
|
|
1257
|
-
* import {
|
|
2409
|
+
* import { renderInto, startProfiling, stopProfiling, formatReport } from '@verajs/renderer/profiler';
|
|
1258
2410
|
* startProfiling();
|
|
1259
2411
|
* // …drive the app…
|
|
1260
2412
|
* console.log(formatReport(stopProfiling()));
|
|
1261
2413
|
* ```
|
|
1262
2414
|
*
|
|
1263
2415
|
* **Development only, by construction.** The instrumentation in `renderer.ts` sits behind
|
|
1264
|
-
* `true`, which the build folds to `false` before terser runs — so a production renderer carries
|
|
2416
|
+
* `true `, which the build folds to `false` before terser runs — so a production renderer carries
|
|
1265
2417
|
* no hook, no call sites and no cost, and this entry is not built for production at all. Profiling
|
|
1266
2418
|
* minified, property-mangled output would not be meaningful anyway.
|
|
1267
2419
|
*
|
|
1268
2420
|
* Like `./hydrate.ts`, this bundle contains its own copy of the renderer. Import the app's renderer
|
|
1269
2421
|
* *through* this entry; importing both side by side gives you two renderer modules with two
|
|
1270
2422
|
* template caches, and the profiler would observe an instance nothing renders into.
|
|
2423
|
+
*
|
|
2424
|
+
* **A hydrating app therefore cannot be profiled**, and that is worth stating rather than leaving to
|
|
2425
|
+
* be inferred: `/hydrate` is a drop-in replacement for the same public API, so an app can have this
|
|
2426
|
+
* one or that one and not both. Measured — a hydrating app driven through three renders reports zero
|
|
2427
|
+
* frames while rendering correctly. `formatReport` says so when it observed nothing, because a zero
|
|
2428
|
+
* report is otherwise indistinguishable from an app with nothing to optimise.
|
|
1271
2429
|
*/
|
|
1272
2430
|
let active = false;
|
|
1273
2431
|
let frames = 0;
|
|
@@ -1395,34 +2553,89 @@ const stopProfiling = () => {
|
|
|
1395
2553
|
return getReport();
|
|
1396
2554
|
};
|
|
1397
2555
|
const isProfiling = () => active;
|
|
1398
|
-
|
|
1399
|
-
const profile = (fn) => {
|
|
2556
|
+
function profile(fn) {
|
|
1400
2557
|
startProfiling();
|
|
2558
|
+
let result;
|
|
1401
2559
|
try {
|
|
1402
|
-
|
|
2560
|
+
result = fn();
|
|
1403
2561
|
}
|
|
1404
2562
|
catch (error) {
|
|
1405
2563
|
stopProfiling();
|
|
1406
2564
|
throw error;
|
|
1407
2565
|
}
|
|
1408
|
-
|
|
2566
|
+
/**
|
|
2567
|
+
* An **async** driver is awaited before the report is taken.
|
|
2568
|
+
*
|
|
2569
|
+
* Driving an application means awaiting frames — the render scheduler is `requestAnimationFrame`,
|
|
2570
|
+
* so nothing commits within one synchronous turn. Stopping immediately therefore reported zero
|
|
2571
|
+
* updates, zero rebuilds and no churn for a page doing plenty of all three: a plausible-looking
|
|
2572
|
+
* answer, and the reader's conclusion is "nothing to fix here".
|
|
2573
|
+
*/
|
|
2574
|
+
if (result && typeof result.then === 'function')
|
|
2575
|
+
return result.then((value) => ({ result: value, report: stopProfiling() }), (error) => {
|
|
2576
|
+
stopProfiling();
|
|
2577
|
+
throw error;
|
|
2578
|
+
});
|
|
2579
|
+
return { result: result, report: stopProfiling() };
|
|
2580
|
+
}
|
|
2581
|
+
/** The panel currently mounted, so a second `showProfiler()` replaces it rather than stacking. */
|
|
2582
|
+
let mounted = null;
|
|
1409
2583
|
/**
|
|
1410
2584
|
* Mounts a live panel in the corner of the page and starts profiling. Returns a function that
|
|
1411
2585
|
* removes it and stops. Plain DOM in a closed shadow root — it never renders itself through the
|
|
1412
2586
|
* renderer, which would fold its own commits into the numbers it reports.
|
|
2587
|
+
*
|
|
2588
|
+
* **Calling it twice replaces the panel; it does not stack a second one.** Two panels are positioned
|
|
2589
|
+
* in the same corner, so they overlap and neither is readable — and the failure went further than
|
|
2590
|
+
* cosmetic. Each panel owns a `setInterval`, and each teardown calls `stopProfiling()`, which is
|
|
2591
|
+
* global: closing the *second* panel stopped profiling for the *first*, which then repainted a
|
|
2592
|
+
* frozen report on its own timer with nothing to say it had stopped. Worse, the natural way to reach
|
|
2593
|
+
* this is a console — `showProfiler()`, look, `showProfiler()` again — where the first return value
|
|
2594
|
+
* is gone, so that first interval could never be stopped at all.
|
|
2595
|
+
*
|
|
2596
|
+
* Replacing rather than returning the existing teardown, so a second call with different `options`
|
|
2597
|
+
* takes effect instead of being silently ignored.
|
|
1413
2598
|
*/
|
|
1414
2599
|
const showProfiler = (options) => {
|
|
2600
|
+
mounted?.();
|
|
1415
2601
|
startProfiling();
|
|
1416
2602
|
const unmount = mountOverlay(getReport, isProfiling, { start: startProfiling, stop: stopProfiling }, options);
|
|
1417
|
-
|
|
2603
|
+
/**
|
|
2604
|
+
* A **stale** teardown — the handle from a panel that has since been replaced — is harmless: its
|
|
2605
|
+
* `unmount` removes a host already removed and clears a timer already cleared, and the
|
|
2606
|
+
* `stopProfiling()` it also does is visible in the live panel's own toggle rather than silent.
|
|
2607
|
+
*
|
|
2608
|
+
* There is deliberately no `mounted = null` here. A version of this line existed, commented as
|
|
2609
|
+
* stopping a late teardown from orphaning a newer panel; mutation testing showed **nothing** could
|
|
2610
|
+
* observe it, and a 50-cycle `WeakRef` probe measured identical retention with and without it. A
|
|
2611
|
+
* line whose comment claims a purpose it does not have is the defect this audit keeps finding, so
|
|
2612
|
+
* it is not shipped as a precaution.
|
|
2613
|
+
*/
|
|
2614
|
+
return (mounted = () => {
|
|
1418
2615
|
unmount();
|
|
1419
2616
|
stopProfiling();
|
|
1420
|
-
};
|
|
2617
|
+
});
|
|
1421
2618
|
};
|
|
1422
2619
|
/** Human-readable summary. The overlay renders the same data; this is for a console or a log. */
|
|
1423
2620
|
const formatReport = (report) => {
|
|
1424
2621
|
const committed = report.updates + report.creates + report.rebuilds;
|
|
1425
2622
|
const share = committed === 0 ? 0 : Math.round((report.rebuilds / committed) * 100);
|
|
2623
|
+
/**
|
|
2624
|
+
* **Nothing observed is the one result that cannot be read.** It is what a healthy idle app looks
|
|
2625
|
+
* like, and it is also what profiling the *wrong renderer* looks like — and this entry, `/hydrate`
|
|
2626
|
+
* and `@verajs/renderer` each carry their own copy with their own hook, so an app that renders
|
|
2627
|
+
* through any of the others is invisible here no matter how busy it is. Measured: a hydrating app
|
|
2628
|
+
* driven through three renders reports `0 frames` while rendering perfectly.
|
|
2629
|
+
*
|
|
2630
|
+
* A zero report is therefore where the explanation belongs. It costs a production build nothing —
|
|
2631
|
+
* this entry is not built for production at all.
|
|
2632
|
+
*/
|
|
2633
|
+
if (report.frames === 0)
|
|
2634
|
+
return ('No renders observed.\n' +
|
|
2635
|
+
'If the app is rendering, it is rendering through a different copy of the renderer: this ' +
|
|
2636
|
+
'entry, @verajs/renderer/hydrate and @verajs/renderer each bundle their own, with their own ' +
|
|
2637
|
+
'hook.\nImport the app\'s renderer through this entry — and note that a hydrating app cannot ' +
|
|
2638
|
+
'be profiled, because /hydrate is a drop-in replacement too and only one of them can be it.');
|
|
1426
2639
|
const lines = [
|
|
1427
2640
|
`${report.frames} frame(s), ${report.ms.toFixed(1)}ms total, slowest ${report.slowestFrameMs.toFixed(1)}ms`,
|
|
1428
2641
|
`${report.updates} updated in place, ${report.creates} created, ${report.rebuilds} rebuilt (${share}% of commits)`,
|
|
@@ -1437,5 +2650,5 @@ const formatReport = (report) => {
|
|
|
1437
2650
|
return lines.join('\n');
|
|
1438
2651
|
};
|
|
1439
2652
|
|
|
1440
|
-
export { formatReport, getReport, hold, isProfiling,
|
|
2653
|
+
export { formatReport, getReport, hold, isProfiling, profile, renderInto, renderer, showProfiler, startProfiling, stopProfiling };
|
|
1441
2654
|
//# sourceMappingURL=vera-renderer-profiler.js.map
|