toiljs 0.0.10 → 0.0.12

package/test/fonts.test.ts

@@ -1,26 +1,28 @@
-import { describe, expect, it } from 'vitest';
-
-import { fontPreloadTags } from '../src/compiler/fonts';
-
-describe('fontPreloadTags', () => {
-    it('builds a crossorigin preload link per font, skipping non-fonts', () => {
-        const tags = fontPreloadTags(['fonts/a-abc.woff2', 'assets/x-1.js', 'fonts/b.ttf'], '/');
-        expect(tags).toHaveLength(2);
-        expect(tags[0]).toEqual({
-            tag: 'link',
-            attrs: {
-                rel: 'preload',
-                as: 'font',
-                type: 'font/woff2',
-                href: '/fonts/a-abc.woff2',
-                crossorigin: '',
-            },
-            injectTo: 'head',
-        });
-        expect(tags[1].attrs?.type).toBe('font/ttf');
-    });
-
-    it('respects a non-root base path', () => {
-        expect(fontPreloadTags(['fonts/a.woff2'], '/app/')[0].attrs?.href).toBe('/app/fonts/a.woff2');
-    });
-});
+import { describe, expect, it } from 'vitest';
+
+import { fontPreloadTags } from '../src/compiler/fonts';
+
+describe('fontPreloadTags', () => {
+    it('builds a crossorigin preload link per font, skipping non-fonts', () => {
+        const tags = fontPreloadTags(['fonts/a-abc.woff2', 'assets/x-1.js', 'fonts/b.ttf'], '/');
+        expect(tags).toHaveLength(2);
+        expect(tags[0]).toEqual({
+            tag: 'link',
+            attrs: {
+                rel: 'preload',
+                as: 'font',
+                type: 'font/woff2',
+                href: '/fonts/a-abc.woff2',
+                crossorigin: '',
+            },
+            injectTo: 'head',
+        });
+        expect(tags[1].attrs?.type).toBe('font/ttf');
+    });
+
+    it('respects a non-root base path', () => {
+        expect(fontPreloadTags(['fonts/a.woff2'], '/app/')[0].attrs?.href).toBe(
+            '/app/fonts/a.woff2',
+        );
+    });
+});

package/test/head.test.ts

@@ -1,35 +1,45 @@
-import { describe, expect, it } from 'vitest';
-
-import { mergeHead } from '../src/client/head/head';
-
-describe('mergeHead', () => {
-    it('takes the last title and applies a titleTemplate', () => {
-        expect(mergeHead([{ title: 'Home' }]).title).toBe('Home');
-        expect(mergeHead([{ title: 'A' }, { title: 'B' }]).title).toBe('B');
-        expect(mergeHead([{ titleTemplate: '%s · toiljs' }, { title: 'About' }]).title).toBe(
-            'About · toiljs',
-        );
-    });
-
-    it('leaves title undefined when nothing sets it', () => {
-        expect(mergeHead([{ meta: [{ name: 'x', content: 'y' }] }]).title).toBeUndefined();
-    });
-
-    it('dedupes meta by name/property, last wins', () => {
-        const resolved = mergeHead([
-            { meta: [{ name: 'description', content: 'old' }] },
-            { meta: [{ name: 'description', content: 'new' }, { property: 'og:title', content: 'T' }] },
-        ]);
-        expect(resolved.meta).toHaveLength(2);
-        expect(resolved.meta.find((m) => m.name === 'description')?.content).toBe('new');
-        expect(resolved.meta.find((m) => m.property === 'og:title')?.content).toBe('T');
-    });
-
-    it('dedupes links by rel+href', () => {
-        const resolved = mergeHead([
-            { link: [{ rel: 'icon', href: '/a.svg' }] },
-            { link: [{ rel: 'icon', href: '/a.svg' }, { rel: 'canonical', href: '/x' }] },
-        ]);
-        expect(resolved.link).toHaveLength(2);
-    });
-});
+import { describe, expect, it } from 'vitest';
+
+import { mergeHead } from '../src/client/head/head';
+
+describe('mergeHead', () => {
+    it('takes the last title and applies a titleTemplate', () => {
+        expect(mergeHead([{ title: 'Home' }]).title).toBe('Home');
+        expect(mergeHead([{ title: 'A' }, { title: 'B' }]).title).toBe('B');
+        expect(mergeHead([{ titleTemplate: '%s · toiljs' }, { title: 'About' }]).title).toBe(
+            'About · toiljs',
+        );
+    });
+
+    it('leaves title undefined when nothing sets it', () => {
+        expect(mergeHead([{ meta: [{ name: 'x', content: 'y' }] }]).title).toBeUndefined();
+    });
+
+    it('dedupes meta by name/property, last wins', () => {
+        const resolved = mergeHead([
+            { meta: [{ name: 'description', content: 'old' }] },
+            {
+                meta: [
+                    { name: 'description', content: 'new' },
+                    { property: 'og:title', content: 'T' },
+                ],
+            },
+        ]);
+        expect(resolved.meta).toHaveLength(2);
+        expect(resolved.meta.find((m) => m.name === 'description')?.content).toBe('new');
+        expect(resolved.meta.find((m) => m.property === 'og:title')?.content).toBe('T');
+    });
+
+    it('dedupes links by rel+href', () => {
+        const resolved = mergeHead([
+            { link: [{ rel: 'icon', href: '/a.svg' }] },
+            {
+                link: [
+                    { rel: 'icon', href: '/a.svg' },
+                    { rel: 'canonical', href: '/x' },
+                ],
+            },
+        ]);
+        expect(resolved.link).toHaveLength(2);
+    });
+});

package/test/metadata.test.ts

@@ -1,41 +1,42 @@
-import { describe, expect, it } from 'vitest';
-
-import { resolveMetadata } from '../src/client/head/metadata';
-
-describe('resolveMetadata', () => {
-    it('expands convenience fields into meta/link tags', () => {
-        const head = resolveMetadata({
-            title: 'About',
-            titleTemplate: '%s · toiljs',
-            description: 'desc',
-            keywords: ['a', 'b'],
-            robots: 'noindex',
-            themeColor: '#000',
-            canonical: 'https://x.test/about',
-            openGraph: { title: 'OG', type: 'website', image: 'https://x.test/og.png' },
-        });
-
-        expect(head.title).toBe('About');
-        expect(head.titleTemplate).toBe('%s · toiljs');
-        const byName = (name: string) => head.meta?.find((m) => m.name === name)?.content;
-        const byProp = (property: string) => head.meta?.find((m) => m.property === property)?.content;
-        expect(byName('description')).toBe('desc');
-        expect(byName('keywords')).toBe('a, b');
-        expect(byName('robots')).toBe('noindex');
-        expect(byName('theme-color')).toBe('#000');
-        expect(byProp('og:title')).toBe('OG');
-        expect(byProp('og:type')).toBe('website');
-        expect(byProp('og:image')).toBe('https://x.test/og.png');
-        expect(head.link?.find((l) => l.rel === 'canonical')?.href).toBe('https://x.test/about');
-    });
-
-    it('passes through raw meta/link and omits unset fields', () => {
-        const head = resolveMetadata({
-            title: 'X',
-            meta: [{ name: 'author', content: 'me' }],
-            link: [{ rel: 'alternate', href: '/rss' }],
-        });
-        expect(head.meta).toEqual([{ name: 'author', content: 'me' }]);
-        expect(head.link).toEqual([{ rel: 'alternate', href: '/rss' }]);
-    });
-});
+import { describe, expect, it } from 'vitest';
+
+import { resolveMetadata } from '../src/client/head/metadata';
+
+describe('resolveMetadata', () => {
+    it('expands convenience fields into meta/link tags', () => {
+        const head = resolveMetadata({
+            title: 'About',
+            titleTemplate: '%s · toiljs',
+            description: 'desc',
+            keywords: ['a', 'b'],
+            robots: 'noindex',
+            themeColor: '#000',
+            canonical: 'https://x.test/about',
+            openGraph: { title: 'OG', type: 'website', image: 'https://x.test/og.png' },
+        });
+
+        expect(head.title).toBe('About');
+        expect(head.titleTemplate).toBe('%s · toiljs');
+        const byName = (name: string) => head.meta?.find((m) => m.name === name)?.content;
+        const byProp = (property: string) =>
+            head.meta?.find((m) => m.property === property)?.content;
+        expect(byName('description')).toBe('desc');
+        expect(byName('keywords')).toBe('a, b');
+        expect(byName('robots')).toBe('noindex');
+        expect(byName('theme-color')).toBe('#000');
+        expect(byProp('og:title')).toBe('OG');
+        expect(byProp('og:type')).toBe('website');
+        expect(byProp('og:image')).toBe('https://x.test/og.png');
+        expect(head.link?.find((l) => l.rel === 'canonical')?.href).toBe('https://x.test/about');
+    });
+
+    it('passes through raw meta/link and omits unset fields', () => {
+        const head = resolveMetadata({
+            title: 'X',
+            meta: [{ name: 'author', content: 'me' }],
+            link: [{ rel: 'alternate', href: '/rss' }],
+        });
+        expect(head.meta).toEqual([{ name: 'author', content: 'me' }]);
+        expect(head.link).toEqual([{ rel: 'alternate', href: '/rss' }]);
+    });
+});

package/test/pages.test.ts

@@ -0,0 +1,105 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+
+import { afterEach, describe, expect, it } from 'vitest';
+
+import { buildPageIndex, pagesModuleSource } from '../src/compiler/pages';
+import type { ScannedRoute } from '../src/compiler/routes';
+
+const dirs: string[] = [];
+/** Writes a throwaway routes dir with the given `{ relPath: source }` files, returns its path. */
+function tmpRoutes(files: Record<string, string>): string {
+    const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'toil-pages-'));
+    dirs.push(dir);
+    for (const [rel, src] of Object.entries(files)) {
+        const full = path.join(dir, rel);
+        fs.mkdirSync(path.dirname(full), { recursive: true });
+        fs.writeFileSync(full, src);
+    }
+    return dir;
+}
+function route(
+    dir: string,
+    file: string,
+    pattern: string,
+    extra: Partial<ScannedRoute> = {},
+): ScannedRoute {
+    return { file: path.join(dir, file), pattern, ...extra };
+}
+
+afterEach(() => {
+    for (const d of dirs.splice(0)) fs.rmSync(d, { recursive: true, force: true });
+});
+
+describe('buildPageIndex', () => {
+    it('extracts each page metadata and flags dynamic routes', () => {
+        const dir = tmpRoutes({
+            'index.tsx': `export const metadata = { title: 'Home' };\nexport default () => null;\n`,
+            'blog/[id].tsx': `export const metadata = { title: 'Post' };\nexport default () => null;\n`,
+        });
+        const pages = buildPageIndex(process.cwd(), [
+            route(dir, 'index.tsx', '/'),
+            route(dir, 'blog/[id].tsx', '/blog/:id'),
+        ]);
+        expect(pages).toEqual([
+            { path: '/', dynamic: false, metadata: { title: 'Home' } },
+            { path: '/blog/:id', dynamic: true, metadata: { title: 'Post' } },
+        ]);
+    });
+
+    it('merges searchHints over static metadata (hints win) for dynamic discoverability', () => {
+        const dir = tmpRoutes({
+            'blog/[id].tsx':
+                `export const searchHints = { title: 'Blog', keywords: ['posts', 'articles'] };\n` +
+                `export const generateMetadata = ({ params }) => ({ title: params.id });\n` +
+                `export default () => null;\n`,
+        });
+        const [page] = buildPageIndex(process.cwd(), [route(dir, 'blog/[id].tsx', '/blog/:id')]);
+        expect(page).toEqual({
+            path: '/blog/:id',
+            dynamic: true,
+            metadata: { title: 'Blog', keywords: ['posts', 'articles'] },
+        });
+    });
+
+    it('uses an empty metadata object when a route declares none', () => {
+        const dir = tmpRoutes({ 'about.tsx': `export default () => null;\n` });
+        const pages = buildPageIndex(process.cwd(), [route(dir, 'about.tsx', '/about')]);
+        expect(pages).toEqual([{ path: '/about', dynamic: false, metadata: {} }]);
+    });
+
+    it('excludes slots and intercepting routes, and dedupes patterns', () => {
+        const dir = tmpRoutes({
+            'index.tsx': `export const metadata = { title: 'Home' };\nexport default () => null;\n`,
+            '@modal/photo.tsx': `export default () => null;\n`,
+            '(.)photo.tsx': `export default () => null;\n`,
+        });
+        const pages = buildPageIndex(process.cwd(), [
+            route(dir, 'index.tsx', '/'),
+            route(dir, '@modal/photo.tsx', '/photo', { slot: 'modal' }),
+            route(dir, '(.)photo.tsx', '/photo', { intercept: true }),
+        ]);
+        expect(pages.map((p) => p.path)).toEqual(['/']);
+    });
+
+    it('sorts the index by path for deterministic output', () => {
+        const dir = tmpRoutes({
+            'zed.tsx': `export default () => null;\n`,
+            'about.tsx': `export default () => null;\n`,
+        });
+        const pages = buildPageIndex(process.cwd(), [
+            route(dir, 'zed.tsx', '/zed'),
+            route(dir, 'about.tsx', '/about'),
+        ]);
+        expect(pages.map((p) => p.path)).toEqual(['/about', '/zed']);
+    });
+});
+
+describe('pagesModuleSource', () => {
+    it('emits a typed pages export with JSON-serialized entries', () => {
+        const src = pagesModuleSource([{ path: '/', dynamic: false, metadata: { title: 'Home' } }]);
+        expect(src).toContain('export const pages: PageMeta[] = [');
+        expect(src).toContain('{"path":"/","dynamic":false,"metadata":{"title":"Home"}}');
+    });
+});

package/test/prerender.test.ts

@@ -1,46 +1,54 @@
-import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-
-import ts from 'typescript';
-import { afterEach, describe, expect, it } from 'vitest';
-
-import { extractStaticMetadata } from '../src/compiler/prerender';
-
-const written: string[] = [];
-function tmp(source: string): string {
-    const file = path.join(os.tmpdir(), `toil-prerender-${String(written.length)}-${process.pid}.tsx`);
-    fs.writeFileSync(file, source);
-    written.push(file);
-    return file;
-}
-afterEach(() => {
-    for (const f of written.splice(0)) fs.rmSync(f, { force: true });
-});
-
-describe('extractStaticMetadata', () => {
-    it('extracts a static metadata object literal (nested objects/arrays)', () => {
-        const file = tmp(
-            `export const metadata = { title: 'X', keywords: ['a', 'b'], openGraph: { type: 'website' } };\n` +
-                `export default function P() { return null; }\n`,
-        );
-        expect(extractStaticMetadata(ts, file)).toEqual({
-            title: 'X',
-            keywords: ['a', 'b'],
-            openGraph: { type: 'website' },
-        });
-    });
-
-    it('returns null when there is no static metadata export', () => {
-        expect(extractStaticMetadata(ts, tmp(`export default function P() { return null; }\n`))).toBeNull();
-        // generateMetadata (a function) is not a static object literal → not extracted.
-        expect(
-            extractStaticMetadata(ts, tmp(`export const generateMetadata = () => ({ title: 'X' });\n`)),
-        ).toBeNull();
-    });
-
-    it('skips computed/non-literal properties but keeps the static ones', () => {
-        const file = tmp(`const x = foo();\nexport const metadata = { title: 'X', dyn: x };\n`);
-        expect(extractStaticMetadata(ts, file)).toEqual({ title: 'X' });
-    });
-});
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+
+import ts from 'typescript';
+import { afterEach, describe, expect, it } from 'vitest';
+
+import { extractStaticMetadata } from '../src/compiler/prerender';
+
+const written: string[] = [];
+function tmp(source: string): string {
+    const file = path.join(
+        os.tmpdir(),
+        `toil-prerender-${String(written.length)}-${process.pid}.tsx`,
+    );
+    fs.writeFileSync(file, source);
+    written.push(file);
+    return file;
+}
+afterEach(() => {
+    for (const f of written.splice(0)) fs.rmSync(f, { force: true });
+});
+
+describe('extractStaticMetadata', () => {
+    it('extracts a static metadata object literal (nested objects/arrays)', () => {
+        const file = tmp(
+            `export const metadata = { title: 'X', keywords: ['a', 'b'], openGraph: { type: 'website' } };\n` +
+                `export default function P() { return null; }\n`,
+        );
+        expect(extractStaticMetadata(ts, file)).toEqual({
+            title: 'X',
+            keywords: ['a', 'b'],
+            openGraph: { type: 'website' },
+        });
+    });
+
+    it('returns null when there is no static metadata export', () => {
+        expect(
+            extractStaticMetadata(ts, tmp(`export default function P() { return null; }\n`)),
+        ).toBeNull();
+        // generateMetadata (a function) is not a static object literal → not extracted.
+        expect(
+            extractStaticMetadata(
+                ts,
+                tmp(`export const generateMetadata = () => ({ title: 'X' });\n`),
+            ),
+        ).toBeNull();
+    });
+
+    it('skips computed/non-literal properties but keeps the static ones', () => {
+        const file = tmp(`const x = foo();\nexport const metadata = { title: 'X', dyn: x };\n`);
+        expect(extractStaticMetadata(ts, file)).toEqual({ title: 'X' });
+    });
+});

package/test/search.test.ts

@@ -0,0 +1,114 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+
+import {
+    getPages,
+    type PageMeta,
+    pagePath,
+    registerPages,
+    searchPages,
+} from '../src/client/search/search';
+
+const PAGES: PageMeta[] = [
+    {
+        path: '/',
+        dynamic: false,
+        metadata: { title: 'Home', description: 'Welcome to the toil demo site' },
+    },
+    {
+        path: '/about',
+        dynamic: false,
+        metadata: { title: 'About', description: 'Who we are', keywords: ['team', 'company'] },
+    },
+    {
+        path: '/blog',
+        dynamic: false,
+        metadata: {
+            title: 'Blog',
+            description: 'Articles and updates',
+            openGraph: { title: 'The Blog', siteName: 'toil' },
+        },
+    },
+    { path: '/blog/:id', dynamic: true, metadata: { title: 'Blog post' } },
+    { path: '/get-started', dynamic: false, metadata: {} },
+];
+
+beforeEach(() => {
+    registerPages(PAGES);
+});
+
+describe('searchPages', () => {
+    it('returns no results for an empty / whitespace query', () => {
+        expect(searchPages('')).toEqual([]);
+        expect(searchPages('   ')).toEqual([]);
+    });
+
+    it('ranks a title match above a description-only match', () => {
+        const results = searchPages('about');
+        expect(results[0].page.path).toBe('/about');
+        // Two pages mention "about"? Only /about does here; the home page does not.
+        expect(results.map((r) => r.page.path)).toContain('/about');
+        expect(results[0].matches).toContain('title');
+    });
+
+    it('matches keywords', () => {
+        const results = searchPages('team');
+        expect(results).toHaveLength(1);
+        expect(results[0].page.path).toBe('/about');
+        expect(results[0].matches).toContain('keywords');
+    });
+
+    it('matches OpenGraph fields', () => {
+        const results = searchPages('blog', { fields: ['openGraph'] });
+        expect(results.map((r) => r.page.path)).toEqual(['/blog']);
+        expect(results[0].matches).toEqual(['openGraph']);
+    });
+
+    it('makes slugs word-searchable via the path field', () => {
+        const results = searchPages('started');
+        expect(results.map((r) => r.page.path)).toContain('/get-started');
+    });
+
+    it('excludes dynamic routes unless includeDynamic is set', () => {
+        expect(searchPages('post').map((r) => r.page.path)).not.toContain('/blog/:id');
+        expect(searchPages('post', { includeDynamic: true }).map((r) => r.page.path)).toContain(
+            '/blog/:id',
+        );
+    });
+
+    it('uses AND semantics: every term must match', () => {
+        expect(searchPages('blog updates').map((r) => r.page.path)).toEqual(['/blog']);
+        expect(searchPages('blog nonexistentword')).toEqual([]);
+    });
+
+    it('honors the limit option', () => {
+        // "toil" appears in the home description and the blog's OpenGraph siteName.
+        const all = searchPages('toil');
+        expect(all.length).toBeGreaterThan(1);
+        expect(searchPages('toil', { limit: 1 })).toHaveLength(1);
+    });
+
+    it('restricts matching to the requested fields', () => {
+        // "welcome" only lives in the home description; excluding it yields nothing.
+        expect(searchPages('welcome', { fields: ['title', 'keywords'] })).toEqual([]);
+        expect(searchPages('welcome', { fields: ['description'] }).map((r) => r.page.path)).toEqual(
+            ['/'],
+        );
+    });
+
+    it('is case-insensitive', () => {
+        expect(searchPages('ABOUT')[0].page.path).toBe('/about');
+    });
+});
+
+describe('registry helpers', () => {
+    it('getPages returns the registered index', () => {
+        expect(getPages()).toBe(PAGES);
+    });
+
+    it('pagePath normalizes results, pages, and raw strings', () => {
+        const result = searchPages('about')[0];
+        expect(pagePath(result)).toBe('/about');
+        expect(pagePath(result.page)).toBe('/about');
+        expect(pagePath('/raw')).toBe('/raw');
+    });
+});