[Feature]: Fix/Add Correct "Sitemap.xml" Route routes/[sitemap.xml].tsx

[jimbrig]

Currently there is app/app/routes/site-map.tsx.

I think that we should have a proper sitemap.xml route exposed that uses the proper Remix routing file path (routes/[sitemap.xml].tsx) and provides the necessary loader() function to generate the sitemap given the request and context.

Something along the lines of:

// app/routes/[sitemap.xml].tsx

import type { LoaderFunctionArgs } from "@remix-run/server-runtime";

interface SitemapEntry {
  loc: string;
  lastmod?: string;
  changefreq?:
    | "never"
    | "yearly"
    | "monthly"
    | "weekly"
    | "daily"
    | "hourly"
    | "always";
  priority?: 1.0 | 0.9 | 0.8 | 0.7 | 0.6 | 0.5 | 0.4 | 0.3 | 0.2 | 0.1 | 0.0;
}

export async function loader({ request, context }: LoaderFunctionArgs) {
  const url = new URL(request.url);
  const guide = await context.resourceStore.getData();
  const entries: SitemapEntry[] = [
    { loc: url.origin, changefreq: "hourly", priority: 1 },
  ];

  for (const list of guide.metadata.lists ?? []) {
    entries.push({
      loc: `$url.origin}/${list.slug}`,
      changefreq: "hourly",
      priority: 0.8,
    });
  }

  for (const [resourceId, resource] of Object.entries(guide.value)) {
    const unknownResource = resource as unknown;
    entries.push({
      loc: `${url.origin}/resources/${resourceId}`,
      lastmod: (unknownResource as { updatedAt?: string }).updatedAt,
      changefreq: "weekly",
      priority: 0.5,
    });
  }

  const sitemap = `
        <?xml version="1.0" encoding="UTF-8"?>
        <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
            ${entries
              .map((entry) =>
                `
				<url>
					<loc>${entry.loc}</loc>
					${entry.lastmod ? `<lastmod>${entry.lastmod}</lastmod>` : ""}
					${entry.changefreq ? `<changefreq>${entry.changefreq}</changefreq>` : ""}
					${entry.priority ? `<priority>${entry.priority}</priority>` : ""}
				</url>
			`.trim(),
              )
              .join("\n")}
        </urlset>
    `.trim();

  return new Response(sitemap, {
    headers: {
      "Content-Type": "application/xml",
      "Content-Length": String(new TextEncoder().encode(sitemap).length),
    },
  });
}