@uniweb/projections 0.4.0 → 0.5.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/package.json +3 -3
- package/src/markdown.js +66 -1
- package/src/search/extract.js +31 -2
- package/src/search/records.js +20 -10
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniweb/projections",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Projections of a Uniweb site's content — agent index, per-page markdown, search index. Pure JS, runs anywhere.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -31,8 +31,8 @@
|
|
|
31
31
|
"node": ">=20.19"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"@uniweb/
|
|
35
|
-
"@uniweb/
|
|
34
|
+
"@uniweb/core": "^0.13.0",
|
|
35
|
+
"@uniweb/content-writer": "^0.3.4"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"vitest": "^4.1.7",
|
package/src/markdown.js
CHANGED
|
@@ -100,6 +100,71 @@ function collectSection(section, blocks, includeChildren, ancestorAnchor) {
|
|
|
100
100
|
}
|
|
101
101
|
}
|
|
102
102
|
|
|
103
|
+
/**
|
|
104
|
+
* Replace `inset_placeholder` nodes with the author's own words.
|
|
105
|
+
*
|
|
106
|
+
* ## Why this is not "restore the inset"
|
|
107
|
+
*
|
|
108
|
+
* An inset is `` — an author's caption plus a
|
|
109
|
+
* FOUNDATION COMPONENT to render it with. The build splits them: the caption and
|
|
110
|
+
* params go to the section's `insets[]`, and the body keeps an
|
|
111
|
+
* `inset_placeholder` carrying only `{ refId, embedKind }`.
|
|
112
|
+
*
|
|
113
|
+
* ⛔ **`@Diagram` must never reach this output.** A component name is a rendering
|
|
114
|
+
* assignment, and this package's whole property is that a projection is of the
|
|
115
|
+
* SITE — identical under a swapped foundation. Emitting it here would break the
|
|
116
|
+
* same rule that keeps `type:` and params out (see the package's README/notes on
|
|
117
|
+
* why the exclusions are load-bearing rather than tidy-up).
|
|
118
|
+
*
|
|
119
|
+
* ⭐ **But the caption IS site content** — the author wrote it, and an agent
|
|
120
|
+
* retrieving this page should read it. So the placeholder becomes its title, as
|
|
121
|
+
* plain text, and nothing else.
|
|
122
|
+
*
|
|
123
|
+
* ⚠️ Before this, `proseMirrorToMarkdown` had no serializer for the node and
|
|
124
|
+
* dropped it with a warning per build — *"this is a tracked capability gap"*. It
|
|
125
|
+
* was: every inset caption was missing from every agent-facing page.
|
|
126
|
+
*
|
|
127
|
+
* @param {Object} content - the section's ProseMirror document
|
|
128
|
+
* @param {Array} insets - the section's `insets[]` (`{ refId, title }`)
|
|
129
|
+
* @returns {Object} content with placeholders resolved to text
|
|
130
|
+
*/
|
|
131
|
+
function resolveInsetCaptions(content, insets) {
|
|
132
|
+
if (!content?.content?.length) return content
|
|
133
|
+
// No insets array → nothing to resolve against. Dropping is then still the only
|
|
134
|
+
// option, but it is silent: the caption is genuinely not reachable from here.
|
|
135
|
+
const titleByRef = new Map(
|
|
136
|
+
(Array.isArray(insets) ? insets : [])
|
|
137
|
+
.filter((i) => i && typeof i.refId === 'string' && i.title)
|
|
138
|
+
.map((i) => [i.refId, String(i.title)])
|
|
139
|
+
)
|
|
140
|
+
|
|
141
|
+
// ⛔ THE REPLACEMENT'S SHAPE DEPENDS ON WHERE IT SITS, and getting this wrong
|
|
142
|
+
// fails SILENTLY IN THE WORSE DIRECTION: a bare text node at block level is not
|
|
143
|
+
// serializable, so the caption vanishes exactly as before — but the warning that
|
|
144
|
+
// used to announce it is gone. Measured while writing this: the first version
|
|
145
|
+
// emitted text unconditionally, removed the warning, and restored nothing.
|
|
146
|
+
const TEXTBLOCKS = new Set(['paragraph', 'heading'])
|
|
147
|
+
|
|
148
|
+
const visit = (nodes, inline) =>
|
|
149
|
+
nodes.flatMap((node) => {
|
|
150
|
+
if (!node) return []
|
|
151
|
+
if (node.type === 'inset_placeholder') {
|
|
152
|
+
const title = titleByRef.get(node.attrs?.refId)
|
|
153
|
+
// An inset with no caption contributes no author text — drop it, and do
|
|
154
|
+
// so quietly: there is nothing a reader is missing.
|
|
155
|
+
if (!title) return []
|
|
156
|
+
const text = { type: 'text', text: title }
|
|
157
|
+
return inline ? [text] : [{ type: 'paragraph', content: [text] }]
|
|
158
|
+
}
|
|
159
|
+
if (Array.isArray(node.content)) {
|
|
160
|
+
return [{ ...node, content: visit(node.content, TEXTBLOCKS.has(node.type)) }]
|
|
161
|
+
}
|
|
162
|
+
return [node]
|
|
163
|
+
})
|
|
164
|
+
|
|
165
|
+
return { ...content, content: visit(content.content, false) }
|
|
166
|
+
}
|
|
167
|
+
|
|
103
168
|
/**
|
|
104
169
|
* @param {Object} section
|
|
105
170
|
* @returns {string}
|
|
@@ -107,5 +172,5 @@ function collectSection(section, blocks, includeChildren, ancestorAnchor) {
|
|
|
107
172
|
function serializeSectionContent(section) {
|
|
108
173
|
const content = section?.content
|
|
109
174
|
if (!content?.content?.length) return ''
|
|
110
|
-
return proseMirrorToMarkdown(content).trim()
|
|
175
|
+
return proseMirrorToMarkdown(resolveInsetCaptions(content, section?.insets)).trim()
|
|
111
176
|
}
|
package/src/search/extract.js
CHANGED
|
@@ -235,10 +235,32 @@ function extractFromProseMirrorDoc(doc, options) {
|
|
|
235
235
|
return { title, textParts }
|
|
236
236
|
}
|
|
237
237
|
|
|
238
|
-
|
|
238
|
+
// ⛔ CONTAINERS WHOSE CHILDREN ARE ORDINARY AUTHOR PROSE. Until 2026-08-27 this
|
|
239
|
+
// walk was FLAT over `doc.content`, so anything nested one level down was
|
|
240
|
+
// invisible to search — measured: a blockquote's prose and every table cell were
|
|
241
|
+
// lost outright, on a site that looked perfectly indexed.
|
|
242
|
+
//
|
|
243
|
+
// ⭐ An ALLOWLIST rather than a blind recursion, deliberately: descending into
|
|
244
|
+
// everything would pull in `codeBlock` and `math_display`, which are not prose —
|
|
245
|
+
// they inflate the index and match on tokens nobody searches for. Adding a
|
|
246
|
+
// container here is a decision, not a default.
|
|
247
|
+
const DESCEND = new Set(['blockquote', 'table', 'tableRow', 'tableCell'])
|
|
248
|
+
|
|
249
|
+
const walk = (nodes) => {
|
|
250
|
+
for (const node of nodes || []) {
|
|
251
|
+
if (!node) continue
|
|
252
|
+
if (DESCEND.has(node.type)) {
|
|
253
|
+
walk(node.content)
|
|
254
|
+
continue
|
|
255
|
+
}
|
|
256
|
+
visit(node)
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
const visit = (node) => {
|
|
239
261
|
if (node.type === 'heading') {
|
|
240
262
|
const text = extractTextFromNode(node)
|
|
241
|
-
if (!text)
|
|
263
|
+
if (!text) return
|
|
242
264
|
|
|
243
265
|
// First H1 becomes the title
|
|
244
266
|
if (!foundFirstHeading && node.attrs?.level === 1) {
|
|
@@ -269,9 +291,16 @@ function extractFromProseMirrorDoc(doc, options) {
|
|
|
269
291
|
} else if ((node.type === 'bulletList' || node.type === 'orderedList') && includeLists) {
|
|
270
292
|
const listTexts = extractFromList(node)
|
|
271
293
|
textParts.push(...listTexts)
|
|
294
|
+
} else if (node.type === 'image') {
|
|
295
|
+
// ⭐ `alt` is the author describing their own image — the only words an
|
|
296
|
+
// image contributes, and what a reader searching for it would type.
|
|
297
|
+
const alt = typeof node.attrs?.alt === 'string' ? node.attrs.alt.trim() : ''
|
|
298
|
+
if (alt) textParts.push(alt)
|
|
272
299
|
}
|
|
273
300
|
}
|
|
274
301
|
|
|
302
|
+
walk(doc.content)
|
|
303
|
+
|
|
275
304
|
return { title, textParts }
|
|
276
305
|
}
|
|
277
306
|
|
package/src/search/records.js
CHANGED
|
@@ -79,11 +79,12 @@ const DISPLAY_VALUE_MAX = 200
|
|
|
79
79
|
* as an index OF collections or a collection's own listing. It is neither: it
|
|
80
80
|
* is a search index derived FROM records.
|
|
81
81
|
*
|
|
82
|
-
*
|
|
83
|
-
* `
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
82
|
+
* ✅ The RESULT was renamed to match, 2026-08-27 — `type: 'record'`, `group: name`,
|
|
83
|
+
* `id: "record:<group>:<slug>"`. That was a real data break against two live
|
|
84
|
+
* consumers (kit's endpoint search provider and hosting's search), taken
|
|
85
|
+
* deliberately rather than left to rot: doing it while the shape was already
|
|
86
|
+
* being discussed cost one coordinated change; leaving it would have made the
|
|
87
|
+
* entry the last place `collection` survived as a lane-crossing word.
|
|
87
88
|
*/
|
|
88
89
|
export function generateRecordSearchIndex(name, config, collectionData, locale) {
|
|
89
90
|
// ⛔ NO DEFAULT FIELD LIST. This was `|| ['title']` — a claim about someone
|
|
@@ -113,9 +114,18 @@ export function generateRecordSearchIndex(name, config, collectionData, locale)
|
|
|
113
114
|
// correctly, looks plausible, and 404s on click.
|
|
114
115
|
const route = item.route || composeRoute(config.route, slug)
|
|
115
116
|
return {
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
117
|
+
// ⛔ RENAMED 2026-08-27 — `collection` is FRAMEWORK'S build concept (a named
|
|
118
|
+
// set our build compiles to one file) and the live lane has no such thing:
|
|
119
|
+
// a host calls this with records fetched from a folder. Same category error
|
|
120
|
+
// the function name carried until it became `generateRecordSearchIndex`.
|
|
121
|
+
//
|
|
122
|
+
// ⭐ `record` is symmetric with the page entry's `type: 'page'` / `id:
|
|
123
|
+
// "page:<route>"`, and true on both lanes. `group` names what a result UI
|
|
124
|
+
// actually does with it — label or group results by the set they came from —
|
|
125
|
+
// without borrowing either lane's word for that set.
|
|
126
|
+
id: `record:${name}:${slug}`,
|
|
127
|
+
type: 'record',
|
|
128
|
+
group: name,
|
|
119
129
|
...(route ? { route } : {}),
|
|
120
130
|
title: item.title || item.name || slug,
|
|
121
131
|
content,
|
|
@@ -130,8 +140,8 @@ export function generateRecordSearchIndex(name, config, collectionData, locale)
|
|
|
130
140
|
// No `generated` timestamp — see the note in `generate.js`. A clock defeats
|
|
131
141
|
// content-addressing and byte-parity between publishers.
|
|
132
142
|
return {
|
|
133
|
-
type: '
|
|
134
|
-
|
|
143
|
+
type: 'record',
|
|
144
|
+
group: name,
|
|
135
145
|
locale,
|
|
136
146
|
entries,
|
|
137
147
|
}
|