Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update dependency sitemap to v8 #295

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented May 22, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
sitemap ^4.1.1 -> ^8.0.0 age adoption passing confidence

Release Notes

ekalinin/sitemap.js (sitemap)

v8.0.0

Compare Source

v7.1.2

Compare Source

v7.1.1

Compare Source

v7.1.0

Compare Source

  • bumped types dependency for node
  • bumped all dev dependencies - includes some prettier changes
  • package-lock updated to version 2

v7.0.0

Compare Source

[BREAKING]
  • dropped support for Node 10, added support for Node 16
  • removed deprecated createSitemapsAndIndex. use SitemapAndIndexStream or simpleSitemapAndIndex
  • dropped deprecated getSitemapStream option for SitemapAndIndexStream that does not return a write stream
  • fixed invalid documentation for #​357
non-breaking
  • Added option to simplesitemap publicBasePath: allows the user to set the location of sitemap files hosted on the site fixes [#​359]
  • bumped dependencies

v6.4.0

Compare Source

  • added support for content_loc parsing #​347 and uploader info attr
  • added error handler option to sitemapstream #​349 Thanks @​marcoreni

v6.3.6

Compare Source

  • bump dependencies

v6.3.5

Compare Source

  • Add option to silence or redirect logs from parse #​337
    • new XMLToSitemapItemStream({ logger: false }) or
    • new XMLToSitemapItemStream({ level: ErrorLevel.SILENT }) or
    • new XMLToSitemapItemStream({ logger: (level, ...message) => your.custom.logger(...message) })

v6.3.4

Compare Source

  • bump dependencies
  • correct return type of xmllint. Was Promise<null> but actually returned Promise<void>
  • add alternate option for lang, hreflang as that is the actual name of the printed attribute

v6.3.3

Compare Source

  • bump ts to 4
  • change file reference in sitemap-index to include .gz fixes #​334

v6.3.2

Compare Source

  • fix unreported timing issue in SitemapAndIndexStream uncovered in latest unit tests

v6.3.1

Compare Source

  • fix #​331 incorrect type on sourceData in simpleSitemapAndIndex.

v6.3.0

Compare Source

  • simpleSitemap will create the dest directory if it doesn't exist
  • allow user to not gzip fixes #​322

v6.2.0

Compare Source

  • Add simplified interface for creating sitemaps and index
  • fix bug where sitemap and index stream would not properly wait to emit finish event until all sitemaps had been written
  • bump deps

v6.1.7

Compare Source

  • Improve documentation and error messaging on ending a stream too early #​317
  • bump dependencies

v6.1.6

Compare Source

  • support allow_embed #​314
  • bump dependencies

v6.1.5

Compare Source

  • performance improvement for streamToPromise #​307

v6.1.4

Compare Source

  • remove stale files from dist #​298
  • Correct documentation on renamed XMLToSitemapOptions, XMLToSitemapItemStream #​297
  • bump node typedef to 14.0.1

v6.1.3

Compare Source

v6.1.2

Compare Source

v6.1.1

Compare Source

  • Fix #​286 sitemapindex tag not closing for deprecated createSitemapsAndIndex

v6.1.0

Compare Source

  • Added back xslUrl option removed in 5.0.0

v6.0.0

Compare Source

  • removed xmlbuilder as a dependency
  • added stronger validity checking on values supplied to sitemap
  • Added the ability to turn off or add custom xml namespaces
  • CLI and library now can accept a stream which will automatically write both the index and the sitemaps. See README for usage.
6.0.0 breaking changes
  • renamed XMLToISitemapOptions to XMLToSitemapOptions
  • various error messages changed.
  • removed deprecated Sitemap and SitemapIndex classes
  • replaced buildSitemapIndex with SitemapIndexStream
  • Typescript: various types renamed or made more specific, removed I prefix
  • Typescript: view_count is now exclusively a number
  • Typescript: price:type and price:resolution are now more restrictive types
  • sitemap parser now returns a sitemapItem array rather than a config object that could be passed to the now removed Sitemap class
  • CLI no longer accepts multiple file arguments or a mixture of file and streams except as a part of a parameter eg. prepend

v5.1.0

Compare Source

Fix for #​255. Baidu does not like timestamp in its sitemap.xml, this adds an option to truncate lastmod

new SitemapStream({ lastmodDateOnly: true });

v5.0.1

Compare Source

Fix for issue #​254.

warning: failed to load external entity "./schema/all.xsd"
Schemas parser error : Failed to locate the main schema resource at './schema/all.xsd'.
WXS schema ./schema/all.xsd failed to compile

v5.0.0

Compare Source

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
5.0 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

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants