index.ts — astro Source File

Source Code

import path from 'node:path';
import { fileURLToPath } from 'node:url';
import type { AstroConfig, AstroIntegration, IntegrationResolvedRoute } from 'astro';
import type { EnumChangefreq, LinkItem as LinkItemBase, SitemapItemLoose } from 'sitemap';
import { ZodError } from 'zod/v4';

import { generateSitemap } from './generate-sitemap.js';
import { validateOptions } from './validate-options.js';
import { writeSitemap } from './write-sitemap.js';
import { writeSitemapChunk } from './write-sitemap-chunk.js';

export { EnumChangefreq as ChangeFreqEnum } from 'sitemap';

export type ChangeFreq = `${EnumChangefreq}`;
export type SitemapItem = Pick<
	SitemapItemLoose,
	'url' | 'lastmod' | 'changefreq' | 'priority' | 'links'
>;
export type LinkItem = LinkItemBase;

export type SitemapOptions =
	| {
			filenameBase?: string;
			filter?(page: string): boolean;
			customSitemaps?: string[];
			customPages?: string[];

			i18n?: {
				defaultLocale: string;
				locales: Record<string, string>;
			};
			// number of entries per sitemap file
			entryLimit?: number;
			// sitemap specific
			changefreq?: ChangeFreq;
			lastmod?: Date;
			priority?: number;

			// called for each sitemap item just before to save them on disk, sync or async
			serialize?(item: SitemapItem): SitemapItem | Promise<SitemapItem | undefined> | undefined;

			xslURL?: string;
			chunks?: Record<
				string,
				(item: SitemapItem) => SitemapItem | Promise<SitemapItem | undefined> | undefined
			>;
			// namespace configuration
			namespaces?: {
				news?: boolean;
				xhtml?: boolean;
				image?: boolean;
				video?: boolean;
			};
	  }
	| undefined;

function formatConfigErrorMessage(err: ZodError) {
	const errorList = err.issues.map((issue) => ` ${issue.path.join('.')}  ${issue.message + '.'}`);
	return errorList.join('\n');
}
// ... (217 more lines)