add sitemap

Author: ImShyMike

frontend/.env.example

@@ -1,2 +1,5 @@
 # Backend API URL
-PUBLIC_BACKEND_API_URL=http://localhost:3000
+PUBLIC_BACKEND_API_URL=http://localhost:3000
+
+# Public site URL
+PUBLIC_SITE_URL=http://localhost:5173

frontend/src/lib/utils/site.ts

@@ -0,0 +1,9 @@
+import { env } from '$env/dynamic/public';
+
+const DEFAULT_SITE_URL = 'https://rustytime.shymike.dev';
+
+export function getSiteUrl(): string {
+	const siteUrl = env.PUBLIC_SITE_URL ?? DEFAULT_SITE_URL;
+
+	return siteUrl.replace(/\/+$/, '');
+}

frontend/src/routes/robots.txt/+server.ts

@@ -0,0 +1,17 @@
+import { getSiteUrl } from '$lib/utils/site';
+import type { RequestHandler } from './$types';
+
+const SITE_URL = getSiteUrl();
+const CACHE_CONTROL_HEADER = 'max-age=0, s-maxage=3600';
+const BODY = `User-agent: *\nDisallow:\n\nSitemap: ${SITE_URL}/sitemap.xml\n`;
+
+export const prerender = true;
+
+export const GET: RequestHandler = async () => {
+	return new Response(BODY, {
+		headers: {
+			'Content-Type': 'text/plain; charset=utf-8',
+			'Cache-Control': CACHE_CONTROL_HEADER
+		}
+	});
+};

frontend/src/routes/sitemap.xml/+server.ts

@@ -0,0 +1,66 @@
+import { getSiteUrl } from '$lib/utils/site';
+import type { RequestHandler } from './$types';
+
+type SitemapEntry = {
+	path: string;
+	changefreq?: string;
+	priority?: string;
+	lastmod?: string;
+};
+
+const SITE_URL = getSiteUrl();
+const CACHE_CONTROL_HEADER = 'max-age=0, s-maxage=3600';
+const DEFAULT_CHANGE_FREQUENCY = 'daily';
+const DEFAULT_PRIORITY = '0.5';
+
+const PAGE_ENTRIES: Record<string, Omit<SitemapEntry, 'path'>> = {
+	'/': {
+		changefreq: 'daily',
+		priority: '1.0'
+	}
+};
+
+const generatedAt = new Date().toISOString();
+const sitemapXml = createSitemap(makeEntries(PAGE_ENTRIES, generatedAt));
+
+export const prerender = true;
+
+export const GET: RequestHandler = async () => {
+	return new Response(sitemapXml, {
+		headers: {
+			'Content-Type': 'application/xml',
+			'Cache-Control': CACHE_CONTROL_HEADER
+		}
+	});
+};
+
+function makeEntries(
+	pages: Record<string, Omit<SitemapEntry, 'path'>>,
+	generatedAtIso: string
+): SitemapEntry[] {
+	return Object.entries(pages)
+		.map(([path, config]) => ({
+			path,
+			changefreq: config.changefreq ?? DEFAULT_CHANGE_FREQUENCY,
+			priority: config.priority ?? DEFAULT_PRIORITY,
+			lastmod: config.lastmod ?? generatedAtIso
+		}))
+		.sort((a, b) => {
+			if (a.path === '/') return -1;
+			if (b.path === '/') return 1;
+			return a.path.localeCompare(b.path);
+		});
+}
+
+function createSitemap(entries: SitemapEntry[]): string {
+	const urls = entries.map(formatUrlEntry).join('\n');
+
+	return `<?xml version="1.0" encoding="UTF-8" ?>\n<urlset\n  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"\n  xmlns:news="https://www.google.com/schemas/sitemap-news/0.9"\n  xmlns:xhtml="https://www.w3.org/1999/xhtml"\n  xmlns:mobile="https://www.google.com/schemas/sitemap-mobile/1.0"\n  xmlns:image="https://www.google.com/schemas/sitemap-image/1.1"\n  xmlns:video="https://www.google.com/schemas/sitemap-video/1.1"\n>\n${urls}\n</urlset>`;
+}
+
+function formatUrlEntry({ path, changefreq, priority, lastmod }: SitemapEntry): string {
+	const loc = path === '/' ? SITE_URL : `${SITE_URL}${path}`;
+
+	return `  <url>\n    <loc>${loc}</loc>\n    <lastmod>${lastmod}</lastmod>\n    <changefreq>${changefreq}</changefreq>\n    <priority>${priority}</priority>\n  </url>`;
+}
+

frontend/static/robots.txt

@@ -20,7 +20,8 @@
 	],
 	"vars": {
 		"ENVIRONMENT": "production",
-		"PUBLIC_BACKEND_API_URL": "https://api-rustytime.shymike.dev"
+		"PUBLIC_BACKEND_API_URL": "https://api-rustytime.shymike.dev",
+		"PUBLIC_SITE_URL": "https://rustytime.shymike.dev"
 	},
 	"observability": {
 		"logs": {