seam-cli 0.5.38

CLI for the SeamJS compile-time rendering framework
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
/* src/cli/core/src/build/route/process/mod.rs */

mod assets;
mod i18n_export;
mod skeleton;

pub(crate) use i18n_export::export_i18n;
pub(crate) use skeleton::run_skeleton_renderer;

use std::collections::BTreeMap;
use std::path::Path;

use anyhow::{Context, Result, bail};

use super::helpers::path_to_filename;
use super::types::{
	I18nManifest, LayoutManifestEntry, RouteManifest, RouteManifestEntry, SkeletonLayout,
	SkeletonRoute,
};
use crate::build::types::{AssetFiles, BundleManifest, ViteDevInfo};
use crate::config::{I18nSection, OutputMode};
use crate::ui::{self, DIM, RESET, col};
use assets::compute_route_assets;
use seam_skeleton::{check_template_invariants, ctr_check, extract_template, sentinel_to_slots};
use seam_skeleton::{slot_warning, wrap_document};

/// Rendering parameters shared across layout and route processing.
pub(crate) struct RenderContext<'a> {
	pub root_id: &'a str,
	pub data_id: &'a str,
	pub dev_mode: bool,
	pub vite: Option<&'a ViteDevInfo>,
}

/// Optional per-page splitting context from the bundler.
pub(crate) struct BundleContext<'a> {
	pub manifest: Option<&'a BundleManifest>,
	pub source_file_map: Option<&'a BTreeMap<String, String>>,
}

/// Internal routing context shared between i18n and single-route processing.
struct RouteProcessCtx<'a> {
	templates_dir: &'a Path,
	assets: &'a AssetFiles,
	render: &'a RenderContext<'a>,
	i18n: Option<&'a I18nSection>,
	bundle: &'a BundleContext<'a>,
}

pub(crate) fn process_routes(
	layouts: &[SkeletonLayout],
	routes: &[SkeletonRoute],
	templates_dir: &Path,
	assets: &AssetFiles,
	render: &RenderContext<'_>,
	i18n: Option<&I18nSection>,
	bundle: &BundleContext<'_>,
) -> Result<RouteManifest> {
	let manifest_data_id =
		if render.data_id == "__data" { None } else { Some(render.data_id.to_string()) };
	let i18n_manifest = i18n.map(|cfg| I18nManifest {
		locales: cfg.locales.clone(),
		default: cfg.default.clone(),
		mode: cfg.mode.as_str().to_string(),
		cache: cfg.cache,
		route_hashes: BTreeMap::new(),
		content_hashes: BTreeMap::new(),
	});
	let mut manifest = RouteManifest {
		_meta: None,
		layouts: BTreeMap::new(),
		routes: BTreeMap::new(),
		data_id: manifest_data_id,
		i18n: i18n_manifest,
	};

	process_layout_templates(layouts, templates_dir, assets, render, &mut manifest)?;

	let ctx = RouteProcessCtx { templates_dir, assets, render, i18n, bundle };
	for route in routes {
		if let Some(ref locale_variants) = route.locale_variants {
			process_i18n_route(route, locale_variants, &ctx, &mut manifest)?;
		} else {
			process_single_route(route, &ctx, &mut manifest)?;
		}
	}
	Ok(manifest)
}

// -- Layout processing --

fn process_layout_templates(
	layouts: &[SkeletonLayout],
	templates_dir: &Path,
	assets: &AssetFiles,
	render: &RenderContext<'_>,
	manifest: &mut RouteManifest,
) -> Result<()> {
	for layout in layouts {
		let is_root = layout.parent.is_none();
		if let Some(ref locale_html) = layout.locale_html {
			let mut templates = BTreeMap::new();
			for (locale, html) in locale_html {
				let html = html.replace("<seam-outlet></seam-outlet>", "<!--seam:outlet-->");
				let html = sentinel_to_slots(&html);
				let document = if is_root {
					wrap_document(
						&html,
						&assets.css,
						&assets.js,
						render.dev_mode,
						render.vite,
						render.root_id,
					)
				} else {
					html
				};
				let locale_dir = templates_dir.join(locale);
				std::fs::create_dir_all(&locale_dir)
					.with_context(|| format!("failed to create {}", locale_dir.display()))?;
				let filename = format!("{}.html", layout.id);
				let filepath = locale_dir.join(&filename);
				std::fs::write(&filepath, &document)
					.with_context(|| format!("failed to write {}", filepath.display()))?;
				templates.insert(locale.clone(), format!("templates/{locale}/{filename}"));
			}
			ui::detail_ok(&format!(
				"layout {} {}-> {} locales{}",
				layout.id,
				col(DIM),
				locale_html.len(),
				col(RESET)
			));
			manifest.layouts.insert(
				layout.id.clone(),
				LayoutManifestEntry {
					template: None,
					templates: Some(templates),
					loaders: layout.loaders.clone(),
					parent: layout.parent.clone(),
					i18n_keys: layout.i18n_keys.clone(),
					projections: None,
				},
			);
		} else if let Some(ref html) = layout.html {
			let html = html.replace("<seam-outlet></seam-outlet>", "<!--seam:outlet-->");
			let html = sentinel_to_slots(&html);
			let document = if is_root {
				wrap_document(&html, &assets.css, &assets.js, render.dev_mode, render.vite, render.root_id)
			} else {
				html
			};
			let filename = format!("{}.html", layout.id);
			let filepath = templates_dir.join(&filename);
			std::fs::write(&filepath, &document)
				.with_context(|| format!("failed to write {}", filepath.display()))?;
			let template_rel = format!("templates/{filename}");
			ui::detail_ok(&format!("layout {} {}-> {template_rel}{}", layout.id, col(DIM), col(RESET)));
			manifest.layouts.insert(
				layout.id.clone(),
				LayoutManifestEntry {
					template: Some(template_rel),
					templates: None,
					loaders: layout.loaders.clone(),
					parent: layout.parent.clone(),
					i18n_keys: layout.i18n_keys.clone(),
					projections: None,
				},
			);
		}
	}
	Ok(())
}

// -- Route document rendering --

/// Render a route template into a final document. For routes with layouts,
/// returns the template as-is (head_meta now comes from skeleton output).
/// For standalone routes, wraps with full HTML document structure.
fn render_route_document(
	template: &str,
	has_layout: bool,
	assets: &AssetFiles,
	render: &RenderContext<'_>,
) -> String {
	if has_layout {
		template.to_string()
	} else {
		wrap_document(template, &assets.css, &assets.js, render.dev_mode, render.vite, render.root_id)
	}
}

fn ensure_template_invariants(
	route_path: &str,
	locale: Option<&str>,
	axes: &[seam_skeleton::Axis],
	variants: &[String],
	template: &str,
) -> Result<()> {
	let violations = check_template_invariants(axes, variants, template);
	if violations.is_empty() {
		return Ok(());
	}

	let route_label = match locale {
		Some(locale) => format!("{route_path} [{locale}]"),
		None => route_path.to_string(),
	};
	let details = violations
		.iter()
		.map(|violation| format!("- {}", violation.message))
		.collect::<Vec<_>>()
		.join("\n");

	bail!(
		"template invariant check failed for route {route_label}\n\n\
		 This likely indicates a Seam CTR extraction bug. The generated template violated structural \
		 array invariants, so the build was stopped before writing broken output.\n\n\
		 {details}"
	);
}

// -- i18n route processing --

fn process_i18n_route(
	route: &SkeletonRoute,
	locale_variants: &BTreeMap<String, super::types::LocaleRouteData>,
	ctx: &RouteProcessCtx<'_>,
	manifest: &mut RouteManifest,
) -> Result<()> {
	let mut templates = BTreeMap::new();
	for (locale, data) in locale_variants {
		let processed: Vec<_> = data.variants.iter().map(|v| sentinel_to_slots(&v.html)).collect();
		let template = extract_template(&data.axes, &processed);
		ensure_template_invariants(&route.path, Some(locale), &data.axes, &processed, &template)?;

		ctr_check::verify_ctr_equivalence(
			&route.path,
			&data.mock_html,
			&template,
			&route.mock,
			ctx.render.data_id,
		)?;

		if let Some(schema) = &route.page_schema {
			for w in slot_warning::check_slot_types(&template, schema) {
				ui::detail_warn(&format!("{} [{locale}] {w}", route.path));
			}
		}

		let document = render_route_document(&template, route.layout.is_some(), ctx.assets, ctx.render);

		let locale_dir = ctx.templates_dir.join(locale);
		std::fs::create_dir_all(&locale_dir)
			.with_context(|| format!("failed to create {}", locale_dir.display()))?;
		let filename = path_to_filename(&route.path);
		let filepath = locale_dir.join(&filename);
		std::fs::write(&filepath, &document)
			.with_context(|| format!("failed to write {}", filepath.display()))?;

		templates.insert(locale.clone(), format!("templates/{locale}/{filename}"));

		// Store head_meta from the default locale only
		if ctx.i18n.is_some_and(|cfg| locale == &cfg.default) {
			let route_assets =
				compute_route_assets(&route.path, ctx.bundle.source_file_map, ctx.bundle.manifest);
			manifest.routes.entry(route.path.clone()).or_insert_with(|| RouteManifestEntry {
				template: None,
				templates: None,
				layout: route.layout.clone(),
				loaders: route.loaders.clone(),
				derives: route.derives.clone(),
				head_meta: route.head_meta.clone(),
				i18n_keys: route.i18n_keys.clone(),
				assets: route_assets,
				procedures: None,
				projections: None,
				prerender: route.prerender,
			});
		}
	}

	let size = locale_variants.values().next().map(|d| d.mock_html.len() as u64).unwrap_or(0);
	ui::detail_ok(&format!(
		"{}  {}\u{2192} {} locales  (~{}){}",
		route.path,
		col(DIM),
		locale_variants.len(),
		ui::format_size(size),
		col(RESET)
	));

	if let Some(entry) = manifest.routes.get_mut(&route.path) {
		entry.templates = Some(templates);
	} else {
		let route_assets =
			compute_route_assets(&route.path, ctx.bundle.source_file_map, ctx.bundle.manifest);
		manifest.routes.insert(
			route.path.clone(),
			RouteManifestEntry {
				template: None,
				templates: Some(templates),
				layout: route.layout.clone(),
				loaders: route.loaders.clone(),
				derives: route.derives.clone(),
				head_meta: None,
				i18n_keys: route.i18n_keys.clone(),
				assets: route_assets,
				procedures: None,
				projections: None,
				prerender: route.prerender,
			},
		);
	}
	Ok(())
}

// -- Single (non-i18n) route processing --

fn process_single_route(
	route: &SkeletonRoute,
	ctx: &RouteProcessCtx<'_>,
	manifest: &mut RouteManifest,
) -> Result<()> {
	let axes = route.axes.as_ref().expect("axes required when i18n is off");
	let variants = route.variants.as_ref().expect("variants required when i18n is off");
	let mock_html = route.mock_html.as_ref().expect("mock_html required when i18n is off");

	let processed: Vec<_> = variants.iter().map(|v| sentinel_to_slots(&v.html)).collect();
	let template = extract_template(axes, &processed);
	ensure_template_invariants(&route.path, None, axes, &processed, &template)?;

	ctr_check::verify_ctr_equivalence(
		&route.path,
		mock_html,
		&template,
		&route.mock,
		ctx.render.data_id,
	)?;

	if let Some(schema) = &route.page_schema {
		for w in slot_warning::check_slot_types(&template, schema) {
			ui::detail_warn(&format!("{} {w}", route.path));
		}
	}

	let document = render_route_document(&template, route.layout.is_some(), ctx.assets, ctx.render);

	let filename = path_to_filename(&route.path);
	let filepath = ctx.templates_dir.join(&filename);
	std::fs::write(&filepath, &document)
		.with_context(|| format!("failed to write {}", filepath.display()))?;

	let size = document.len() as u64;
	let template_rel = format!("templates/{filename}");
	ui::detail_ok(&format!(
		"{}  {}\u{2192} {template_rel}  ({}){}",
		route.path,
		col(DIM),
		ui::format_size(size),
		col(RESET)
	));

	let route_assets =
		compute_route_assets(&route.path, ctx.bundle.source_file_map, ctx.bundle.manifest);
	manifest.routes.insert(
		route.path.clone(),
		RouteManifestEntry {
			template: Some(template_rel),
			templates: None,
			layout: route.layout.clone(),
			loaders: route.loaders.clone(),
			derives: route.derives.clone(),
			head_meta: route.head_meta.clone(),
			i18n_keys: route.i18n_keys.clone(),
			assets: route_assets,
			procedures: None,
			projections: None,
			prerender: route.prerender,
		},
	);
	Ok(())
}

/// Apply output mode behavior matrix to route manifest entries.
///
/// | output  | no prerender | prerender=true | prerender=false |
/// |---------|--------------|----------------|-----------------|
/// | static  | SSG          | SSG            | warn, still SSG |
/// | server  | CTR          | warn, still CTR| CTR             |
/// | hybrid  | CTR          | SSG            | CTR             |
pub(crate) fn apply_output_mode(manifest: &mut RouteManifest, output: OutputMode) {
	for (path, entry) in &mut manifest.routes {
		let explicit = entry.prerender;
		let effective = match output {
			OutputMode::Static => {
				if explicit == Some(false) {
					ui::detail_warn(&format!(
						"{path}: prerender=false ignored in static mode (all pages are SSG)"
					));
				}
				Some(true)
			}
			OutputMode::Server => {
				if explicit == Some(true) {
					ui::detail_warn(&format!(
						"{path}: prerender=true ignored in server mode (all pages are CTR)"
					));
				}
				None
			}
			OutputMode::Hybrid => explicit,
		};
		entry.prerender = effective;
	}
}

#[cfg(test)]
mod tests {
	use super::ensure_template_invariants;
	use seam_skeleton::Axis;

	fn array_axis(path: &str) -> Axis {
		Axis { path: path.to_string(), kind: "array".to_string(), values: vec![] }
	}

	#[test]
	fn template_invariant_failure_mentions_route_and_axis() {
		let axes = vec![array_axis("watches.items")];
		let variants = vec![r#"<div><!--seam:watches.items.$.brand--></div>"#.to_string()];
		let template = r#"<div><!--seam:watches.items.$.brand--></div>"#;

		let err =
			ensure_template_invariants("/reviewed", None, &axes, &variants, template).unwrap_err();
		let message = err.to_string();

		assert!(message.contains("template invariant check failed for route /reviewed"));
		assert!(message.contains("array axis \"watches.items\""));
		assert!(message.contains("missing <!--seam:each:watches.items-->"));
	}
}