feat: Export types like SitemapUrl

[MickL]

🆒 Your use case

I am having a third party backend api (Nitro) and I want to create an endpoint for sitemap urls. For this I need to return an array of SitemapUrl. I would love to use this interface:

import type { SitemapUrl } from '@nuxtjs/sitemap';

export default defineSitemapEventHandler(async (): Promise<SitemapUrl[]> => {
  // ...
});

But unfortunately this interface is not exported from the package. This interface also contains more interfaces that should be exported as well: Changefreq, AlternativeEntry, GoogleNewsEntry, ImageEntry and VideoEntry.

🆕 The solution you'd like

Export SitemapUrl and the other interfaces. I see in the code they are, but they dont end up to be importable.

🔍 Alternatives you've considered

Currently I copy line 329 to line 429 into my project.

[harlan-zw]

Please follow the docs for this https://nuxtseo.com/docs/sitemap/guides/dynamic-urls#_2-create-your-own-endpoint

[MickL]

I cant because the API is an external API, not a Nuxt project. If you would just export the types this would help a lot.

[harlan-zw]

Oh I see, sorry, I misunderstood the issue. I would just suggest copy+pasting the types as I may make changes to the interface that could break your implementation.

I'm open to creating a Nitro Sitemap module in the future, which may be a better thing to track.

[MickL]

But when you make changes this is exactly the point of not copy pasting, and instead importing from the package itself :)

Btw Nitro Sitemap module would be amazing for me personally! However this issue is also in the perspective of every other external API.