toiljs 0.0.14 → 0.0.15

package/src/compiler/ssg.ts

@@ -0,0 +1,126 @@
+/**
+ * Build-time SSG for dynamic routes. After the client bundle is written, this loads each dynamic
+ * route that exports `generateStaticParams`, enumerates its concrete URLs, runs the route's
+ * `generateMetadata` per URL, and bakes a `<url>/index.html` (so JS-less crawlers get per-page tags)
+ * plus a `sitemap.xml` entry. Opt-in: a route without `generateStaticParams` is untouched, and the
+ * whole pass is skipped when no such route exists or `seo` is unconfigured. Build-only.
+ *
+ * Runs from `build()` (not the prerender Vite plugin) so it can reuse `createViteConfig` without the
+ * `vite.ts` <-> `prerender.ts` import cycle; it spins up a short-lived SSR server to load route source.
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+
+import { createServer } from 'vite';
+
+import { type ResolvedToilConfig } from './config.js';
+import { scanRoutes } from './routes.js';
+import { injectSeoHtml, routeSeo, sitemapXml } from './seo.js';
+import { createViteConfig } from './vite.js';
+
+type StaticParams = Record<string, string | string[]>;
+
+interface RouteModule {
+    generateStaticParams?: () => StaticParams[] | Promise<StaticParams[]>;
+    generateMetadata?: (args: {
+        params: StaticParams;
+        searchParams: URLSearchParams;
+        data: unknown;
+    }) => unknown;
+    loader?: (args: { params: StaticParams; searchParams: URLSearchParams }) => unknown;
+    metadata?: Record<string, unknown>;
+}
+
+/** Substitutes `:param` / `*catch-all` segments in a route pattern with concrete param values. */
+export function fillPattern(pattern: string, params: StaticParams): string {
+    return pattern.replace(/[:*]([A-Za-z0-9_]+)/g, (_m, name: string) => {
+        const value = params[name] as string | string[] | undefined;
+        if (Array.isArray(value)) return value.join('/');
+        return value ?? '';
+    });
+}
+
+/** Coerces an unknown module export to a typed Metadata-ish record, or null. */
+function asMetadata(value: unknown): Record<string, unknown> | null {
+    return typeof value === 'object' && value !== null ? (value as Record<string, unknown>) : null;
+}
+
+/**
+ * Pre-renders every dynamic route that opts in via `generateStaticParams`. Bakes per-URL HTML into
+ * `outDir` and rewrites `sitemap.xml` with the generated URLs. Returns the list of generated URLs.
+ */
+export async function prerenderStaticParams(cfg: ResolvedToilConfig): Promise<string[]> {
+    if (!cfg.seo) return [];
+    const outDir = path.resolve(cfg.root, cfg.outDir);
+    // Prefer the clean shell stashed by the prerender plugin (no per-route SEO baked in); fall back
+    // to the built index.html.
+    const stashed = path.join(cfg.toilDir, 'shell.html');
+    const shellPath = fs.existsSync(stashed) ? stashed : path.join(outDir, 'index.html');
+    if (!fs.existsSync(shellPath)) return [];
+
+    const allRoutes = scanRoutes(cfg.routesAbsDir);
+    const dynamic = allRoutes.filter(
+        (r) => r.slot === undefined && !r.intercept && /[:*]/.test(r.pattern),
+    );
+    if (dynamic.length === 0) return [];
+
+    const shell = fs.readFileSync(shellPath, 'utf8');
+    const server = await createServer({
+        ...(await createViteConfig(cfg)),
+        server: { middlewareMode: true, hmr: false },
+        appType: 'custom',
+        logLevel: 'silent',
+    });
+
+    const generated: string[] = [];
+    const warn = (msg: string): void => {
+        process.stderr.write(`  toil: SSG ${msg}\n`);
+    };
+    try {
+        for (const route of dynamic) {
+            let mod: RouteModule;
+            try {
+                mod = (await server.ssrLoadModule(route.file)) as RouteModule;
+            } catch (err) {
+                warn(`skipped ${route.pattern} (${err instanceof Error ? err.message : String(err)})`);
+                continue;
+            }
+            if (typeof mod.generateStaticParams !== 'function') continue;
+            const paramSets = await mod.generateStaticParams();
+            for (const params of paramSets) {
+                const url = fillPattern(route.pattern, params);
+                let metadata: Record<string, unknown> | null = null;
+                try {
+                    if (typeof mod.generateMetadata === 'function') {
+                        const searchParams = new URLSearchParams();
+                        const data =
+                            typeof mod.loader === 'function'
+                                ? await mod.loader({ params, searchParams })
+                                : undefined;
+                        metadata = asMetadata(await mod.generateMetadata({ params, searchParams, data }));
+                    } else if (mod.metadata) {
+                        metadata = asMetadata(mod.metadata);
+                    }
+                } catch (err) {
+                    warn(`metadata failed for ${url} (${err instanceof Error ? err.message : String(err)})`);
+                }
+                const html = injectSeoHtml(shell, routeSeo(cfg.seo, metadata, url));
+                const target = path.join(outDir, url.replace(/^\//, ''), 'index.html');
+                fs.mkdirSync(path.dirname(target), { recursive: true });
+                fs.writeFileSync(target, html);
+                generated.push(url);
+            }
+        }
+    } finally {
+        await server.close();
+    }
+
+    if (generated.length > 0) {
+        const sitemap = sitemapXml(cfg.seo, allRoutes, generated);
+        if (sitemap) fs.writeFileSync(path.join(outDir, 'sitemap.xml'), sitemap);
+        process.stdout.write(
+            `  ✓ prerendered ${String(generated.length)} dynamic route${generated.length === 1 ? '' : 's'}\n`,
+        );
+    }
+    return generated;
+}

package/test/dom/use-metadata.test.tsx

@@ -0,0 +1,58 @@
+// @vitest-environment jsdom
+import { afterEach, describe, expect, it } from 'vitest';
+import { cleanup, render } from '@testing-library/react';
+
+import { Metadata, useMetadata } from '../../src/client/head/metadata';
+import { setRouteHead } from '../../src/client/head/head';
+
+afterEach(() => {
+    cleanup();
+    setRouteHead(null);
+});
+
+const meta = (key: string): string | null =>
+    document.head.querySelector(`meta[${key}]`)?.getAttribute('content') ?? null;
+
+describe('useMetadata / <Metadata>', () => {
+    it('applies a full Metadata object to the document head from a component', () => {
+        function Article() {
+            useMetadata({
+                title: 'Article',
+                description: 'an article',
+                openGraph: { title: 'og title', type: 'website' },
+            });
+            return null;
+        }
+        render(<Article />);
+        expect(document.title).toBe('Article');
+        expect(meta('name="description"')).toBe('an article');
+        expect(meta('property="og:title"')).toBe('og title');
+    });
+
+    it('reverts the head when the component unmounts', () => {
+        function Article() {
+            useMetadata({ title: 'Temp' });
+            return null;
+        }
+        const { unmount } = render(<Article />);
+        expect(document.title).toBe('Temp');
+        unmount();
+        expect(document.title).not.toBe('Temp');
+    });
+
+    it('the declarative <Metadata> form applies too', () => {
+        render(<Metadata title="Declarative" />);
+        expect(document.title).toBe('Declarative');
+    });
+
+    it("a route's metadata still wins over a component's useMetadata", () => {
+        function Article() {
+            useMetadata({ title: 'Component' });
+            return null;
+        }
+        render(<Article />);
+        // The route baseline (applied last) takes precedence for keys it sets.
+        setRouteHead({ title: 'Route' });
+        expect(document.title).toBe('Route');
+    });
+});

package/test/ssg.test.ts

@@ -0,0 +1,36 @@
+import { describe, expect, it } from 'vitest';
+
+import { sitemapXml, type SeoConfig } from '../src/compiler/seo';
+import { fillPattern } from '../src/compiler/ssg';
+import { type ScannedRoute } from '../src/compiler/routes';
+
+describe('fillPattern', () => {
+    it('substitutes :param and *catch-all segments', () => {
+        expect(fillPattern('/:a/:b/:c', { a: 'x', b: 'y', c: 'z' })).toBe('/x/y/z');
+        expect(fillPattern('/blog/:id', { id: '42' })).toBe('/blog/42');
+        expect(fillPattern('/docs/*slug', { slug: ['a', 'b'] })).toBe('/docs/a/b');
+        expect(fillPattern('/static', {})).toBe('/static');
+    });
+});
+
+describe('sitemapXml with SSG paths', () => {
+    const seo: SeoConfig = { url: 'https://x.dev' };
+    const routes: ScannedRoute[] = [
+        { file: 'a', pattern: '/' },
+        { file: 'b', pattern: '/about' },
+        { file: 'c', pattern: '/blog/:id' },
+    ];
+
+    it('lists static routes plus enumerated SSG URLs, deduped, never the bare pattern', () => {
+        const xml = sitemapXml(seo, routes, ['/blog/1', '/blog/2', '/about']);
+        expect(xml).toContain('https://x.dev/blog/1');
+        expect(xml).toContain('https://x.dev/blog/2');
+        expect(xml).toContain('https://x.dev/about');
+        expect(xml).not.toContain('/blog/:id'); // dynamic pattern is never listed literally
+        expect((xml.match(/<loc>[^<]*\/about<\/loc>/g) ?? []).length).toBe(1); // deduped
+    });
+
+    it('is empty without a base url', () => {
+        expect(sitemapXml({}, routes, ['/blog/1'])).toBe('');
+    });
+});