chore(deps): bump sitemap from 4.1.1 to 5.0.0 in /docs

[dependabot-preview]

Bumps sitemap from 4.1.1 to 5.0.0.

Release notes

Sourced from sitemap's releases.

Streams

This release is heavily focused on converting the core methods of this library to use streams. Why? Overall its made the API ~20% faster and uses only 10% or less of the memory. Some tradeoffs had to be made as in their nature streams are operate on individual segments of data as opposed to the whole. For instance, the streaming interface does not support removal of sitemap items as it does not hold on to a sitemap item after its converted to XML. It should however be possible to create your own transform that filters out entries should you desire it. The existing synchronous interfaces will remain for this release at least. Do not be surprised if they go away in a future breaking release.

Sitemap Index

This library interface has been overhauled to use streams internally. Although it would have been preferable to convert this to a stream as well, I could not think of an interface that wouldn't actually end up more complex or confusing. It may be altered in the near future to accept a stream in addition to a simple list.

Misc

• runnable examples, some pulled straight from README have been added to the examples directory.
• createSitemapsIndex was renamed createSitemapsAndIndex to more accurately reflect its function. It now returns a promise that resolves to true or throws with an error.
• You can now add to existing sitemap.xml files via the cli using npx sitemap --prepend existingSitemap.xml < listOfNewURLs.json.txt

Breaking Changes

• Dropped support for mobile sitemap - Google appears to have deleted their dtd and all references to it, strongly implying that they do not want you to use it. As its absence now breaks the validator, it has been dropped.
• normalizeURL(url, XMLRoot, hostname) -> normalizeURL(url, hostname)
  • The second argument was unused and has been eliminated
• Support for Node 8 dropped - Node 8 is reaching its EOL December 2019
• xslURL is being dropped from all apis - styling xml is out of scope of this library.
• createSitemapIndex has been converted to a promised based api rather than callback.
• createSitemapIndex now gzips by default - pass gzip: false to disable
• cacheTime is being dropped from createSitemapIndex - This didn't actually cache the way it was written so this should be a non-breaking change in effect.
• SitemapIndex as a class has been dropped. The class did all its work on construction and there was no reason to hold on to it once you created it.
• The options for the cli have been overhauled
  • --json is now inferred
  • --line-separated has been flipped to --single-line-json to by default output options immediately compatible with feeding back into sitemap

Changelog

Sourced from sitemap's changelog.

5.0.0

Streams

This release is heavily focused on converting the core methods of this library to use streams. Why? Overall its made the API ~20% faster and uses only 10% or less of the memory. Some tradeoffs had to be made as in their nature streams are operate on individual segments of data as opposed to the whole. For instance, the streaming interface does not support removal of sitemap items as it does not hold on to a sitemap item after its converted to XML. It should however be possible to create your own transform that filters out entries should you desire it. The existing synchronous interfaces will remain for this release at least. Do not be surprised if they go away in a future breaking release.

Sitemap Index

This library interface has been overhauled to use streams internally. Although it would have been preferable to convert this to a stream as well, I could not think of an interface that wouldn't actually end up more complex or confusing. It may be altered in the near future to accept a stream in addition to a simple list.

Misc

• runnable examples, some pulled straight from README have been added to the examples directory.
• createSitemapsIndex was renamed createSitemapsAndIndex to more accurately reflect its function. It now returns a promise that resolves to true or throws with an error.
• You can now add to existing sitemap.xml files via the cli using npx sitemap --prepend existingSitemap.xml < listOfNewURLs.json.txt

Breaking Changes

• Dropped support for mobile sitemap - Google appears to have deleted their dtd and all references to it, strongly implying that they do not want you to use it. As its absence now breaks the validator, it has been dropped.
• normalizeURL(url, XMLRoot, hostname) -> normalizeURL(url, hostname)
  • The second argument was unused and has been eliminated
• Support for Node 8 dropped - Node 8 is reaching its EOL December 2019
• xslURL is being dropped from all apis - styling xml is out of scope of this library.
• createSitemapIndex has been converted to a promised based api rather than callback.
• createSitemapIndex now gzips by default - pass gzip: false to disable
• cacheTime is being dropped from createSitemapIndex - This didn't actually cache the way it was written so this should be a non-breaking change in effect.
• SitemapIndex as a class has been dropped. The class did all its work on construction and there was no reason to hold on to it once you created it.
• The options for the cli have been overhauled
  • --json is now inferred
  • --line-separated has been flipped to --single-line-json to by default output options immediately compatible with feeding back into sitemap

Commits

• d0af1d2 release v5 (#248)
• ed82abb Sitemap streaming API (#243)
• ff0f5e1 Merge pull request #247 from NicoPennec/master
• d0776e3 Format markdown content
• 07e8051 Fix typos
• db83c2d Merge pull request #244 from accidentaldeveloper/patch-1
• 8157691 Use sm consistently in Sitemap API documentation
• aae23bc Merge pull request #242 from derduher/test-org
• d7ea6b4 move e2e tests into their own file
• 9678baf spaces between functions
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
• @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
• @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
• @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
• @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
• @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

• Update frequency (including time of day and day of week)
• Pull request limits (per update run and/or open at any time)
• Automerge options (never/patch/minor, and dev/runtime dependencies)
• Out-of-range updates (receive only lockfile updates, if desired)
• Security updates (receive only security updates, if desired)

[vercel]

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-dependabot-npmandyarndocssitemap-500.storybook.now.sh

[dependabot-preview]

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.