Upgrading sitemap from 9.x to 10.x

Comparison of the public API of sitemap 9.0.1 and 10.0.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	1
Changed signatures	2
Removed class or interface members	4
Changed class or interface members	6
Newly deprecated	3
Requirement changes (engines, peer dependencies)	1
New exports	5

Removed exports

import	export	kind	Before
`sitemap`	`UndefinedTargetFolder`	class	`class`

Changed signatures

export	Before	After
`sitemap · LIMITS`	{ readonly MAX_URL_LENGTH: 2048; readonly URL_PROTOCOL_REGEX: RegExp; readonly MIN_SITEMAP_ITEM_LIMIT: 1; readonly MAX_SITEMAP_ITEM_LIMIT: 50000; readonly MAX_VIDEO_TITLE_LENGTH: 100; readonly MAX_VIDEO_DESCRIPTION_LENGTH: 2048; readonly MAX_VIDEO_CATEGORY_LENGTH: 256; readonly MAX_TAGS_PER_VIDEO: 32; readonly MAX_NEWS_TITLE_LENGTH: 200; readonly MAX_NEWS_NAME_LENGTH: 256; readonly MAX_IMAGE_CAPTION_LENGTH: 512; readonly MAX_IMAGE_TITLE_LENGTH: 512; readonly MAX_IMAGES_PER_URL: 1000; readonly MAX_VIDEOS_PER_URL: 100; readonly MAX_LINKS_PER_URL: 100; readonly MAX_URL_ENTRIES: 50000; readonly IS…	{ readonly MAX_URL_LENGTH: 2048; readonly URL_PROTOCOL_REGEX: RegExp; readonly MIN_SITEMAP_ITEM_LIMIT: 1; readonly MAX_SITEMAP_ITEM_LIMIT: 50000; readonly MIN_PRIORITY: 0; readonly MAX_PRIORITY: 1; readonly PRIORITY_STRING_REGEX: RegExp; readonly MIN_VIDEO_DURATION: 0; readonly MAX_VIDEO_DURATION: 28800; readonly MIN_VIDEO_RATING: 0; readonly MAX_VIDEO_RATING: 5; readonly MIN_VIDEO_VIEW_COUNT: 0; readonly MAX_VIDEO_TITLE_LENGTH: 100; readonly MAX_VIDEO_DESCRIPTION_LENGTH: 2048; readonly MAX_VIDEO_CATEGORY_LENGTH: 256; readonly MAX_TAGS_PER_VIDEO: 32; readonly MAX_NEWS_TITLE_LENGTH: 200; readon…
`sitemap · simpleSitemapAndIndex`	`({ hostname, sitemapHostname, sourceData, destinationDir, limit, gzip, publicBasePath, xslUrl, }: SimpleSitemapAndIndexOptions): Promise<void>`	`({ hostname, sitemapHostname, sourceData, destinationDir, limit, gzip, publicBasePath, xslUrl, logger, }: SimpleSitemapAndIndexOptions): Promise<void>`

Removed class or interface members

member	import	Before
`SitemapStream.smiStream`	`sitemap`	`any`
`SitemapAndIndexStream.currentSitemap`	`sitemap`	`any`
`SitemapAndIndexStream.isCreatingSitemap`	`sitemap`	`any`
`SitemapAndIndexStream.currentSitemapPipeline`	`sitemap`	`any`

Changed class or interface members

member	Before	After
`SitemapStream.errorHandler`	`ErrorHandler \| undefined`	`(error: Error, level: ErrorLevel): void`
`InvalidAttrValue.constructor`	`(key: string, val: any, validator: RegExp): InvalidAttrValue`	`(key: string, val: any, validator: RegExp, url?: string \| undefined): InvalidAttrValue`
`SitemapItemLoose.priority`	`number \| undefined`	`string \| number \| undefined`
`XMLToSitemapItemStream.err`	`any`	`(msg: string): void`
`XMLToSitemapItemStream.logger`	`(level: "log" \| "warn" \| "error" \| "info", ...message: any): void`	`(level: "log" \| "warn" \| "error" \| "info", ...message: any[]): void`
`XMLToSitemapIndexStream.err`	`any`	`(msg: string): void`

Newly deprecated

export	@deprecated
`sitemap · EmptySitemap`	No longer thrown: since 10.0.0, `SitemapStream` emits an empty `<urlset>` when it ends without items. Kept so existing imports still resolve.
`sitemap · SitemapStream.xmlNS`	Use `xmlns`
`sitemap · XMLToSitemapItemStream.urlCount`	Use entryCount

Requirement changes (engines, peer dependencies)

	Before	After
`engines.node`	`>=20.19.5`	`>=22.22.1`

New exports (5)

import	export	kind
`sitemap`	`Logger`	type
`sitemap`	`InvalidURLError`	class
`sitemap`	`InvalidVideoYesNo`	class
`sitemap`	`InvalidLinkHreflang`	class
`sitemap`	`SaxParserStreamOptions`	interface

Give your AI agent these facts

Vigia is a free MCP server: your coding agent checks versions, breaking changes and vulnerabilities before it writes code. No signup, no API key.

claude mcp add --transport http vigia https://vigia.coredls.cloud/mcp

Add to Cursor Add to VS Code ★ Star on GitHub

Any other MCP client

{ "mcpServers": { "vigia": { "url": "https://vigia.coredls.cloud/mcp" } } }

Agent skill (SKILL.md): tells the agent when to use Vigia · GitHub Action for pull requests

Frequently asked questions

What are the breaking changes when upgrading sitemap from 9 to 10?

Between sitemap 9.0.1 and 10.0.0, Vigia found 1 removed exports, 2 changed signatures and 10 removed or changed class or interface members.

What became deprecated in sitemap 10?

3 exports or members are newly marked as deprecated in sitemap 10.0.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/sitemap/upgrade?from=9.0.1&to=10.0.0