123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
import { merge } from "../core/utils/object.ts";import { Page } from "../core/file.ts";import { stringify } from "../deps/xml.ts";
import type Site from "../core/site.ts";import type { Data } from "../core/file.ts";
type ChangeFreq =  | "always"  | "hourly"  | "daily"  | "weekly"  | "monthly"  | "yearly"  | "never";
export interface Options {  /** The sitemap file name */  filename?: string;
  /** The query to search pages included in the sitemap */  query?: string;
  /** The values to sort the sitemap */  sort?: string;
  /** The key to use for the lastmod field or a custom function */  lastmod?: string | ((data: Data) => Date);
  /** The key to use for the changefreq field or a custom function */  changefreq?: string | ((data: Data) => ChangeFreq);
  /** The key to use for the priority field or a custom function */  priority?: string | ((data: Data) => number);}
// Default optionsexport const defaults: Options = {  filename: "/sitemap.xml",  query: "",  sort: "url=asc",  lastmod: "date",};
/** A plugin to generate a sitemap.xml from page files after build */export default function (userOptions?: Options) {  const options = merge(defaults, userOptions);
  return (site: Site) => {    site.addEventListener("beforeSave", async () => {      // Create the sitemap.xml page      const sitemap = Page.create({        url: options.filename,        content: generateSitemap(          site.search.pages(options.query, options.sort),        ),      });
      // Add the sitemap page to pages      site.pages.push(sitemap);
      // Add or update `robots.txt` with the sitemap url      const robots = await site.getOrCreatePage("/robots.txt");      const content = robots.content as string || `User-agent: *\nAllow: /\n`;      robots.content = `${content}\nSitemap: ${        site.url(options.filename, true)      }`;    });
    function generateSitemap(pages: Data[]): string {      const sitemap = {        xml: {          "@version": "1.0",          "@encoding": "UTF-8",        },        urlset: {          "@xmlns": "http://www.sitemaps.org/schemas/sitemap/0.9",          "@xmlns:xhtml": "http://www.w3.org/1999/xhtml",          url: pages.map((data) => {            const node: UrlItem = {              loc: site.url(data.url, true),            };
            const lastmod = getValue<Date>(data, options.lastmod)              ?.toISOString();            if (lastmod) {              node.lastmod = lastmod;            }
            const changefreq = getValue<ChangeFreq>(data, options.changefreq);            if (changefreq) {              node.changefreq = changefreq;            }
            const priority = getValue<number>(data, options.priority);            if (priority) {              node.priority = priority;            }
            if (data.alternates?.length) {              node["xhtml:link"] = data.alternates.map((alternate: Data) => ({                "@rel": "alternate",                "@hreflang": alternate.lang!,                "@href": site.url(alternate.url, true),              }));            }            if (data.unmatchedLangUrl) {              node["xhtml:link"]?.push({                "@rel": "alternate",                "@hreflang": "x-default",                "@href": site.url(data.unmatchedLangUrl, true),              });            }
            return node;          }),        },      };
      return stringify(sitemap);    }  };}
interface UrlItem {  loc: string;  lastmod?: string;  changefreq?: ChangeFreq;  priority?: number;  "xhtml:link"?: {    "@rel": "alternate";    "@hreflang": string;    "@href": string;  }[];}
function getValue<T>(  data: Data,  key?: string | ((data: Data) => T),): T | undefined {  if (!key) {    return undefined;  }
  if (typeof key === "function") {    return key(data);  }
  return data[key];}