Skip to content

Conversation

@dependabot
Copy link

@dependabot dependabot bot commented on behalf of github Apr 1, 2024

Bumps itty-router from 3.0.12 to 5.0.4.

Release notes

Sourced from itty-router's releases.

v5.0.4

itty-router v5

This represents a large shift in the ecosystem. While mostly backwards compatible, a few small tweaks will be needed to swap in the new Router or AutoRouter.

See https://itty.dev/itty-router/migrations/v4-v5 for migration guide and details.

Changes in v5

v4.0.0

This is an extensive v4.x update, bringing a series of quality of life additions, as well as a potentially breaking change for TypeScript users:

!Breaking Changes!

  • TYPES HAVE CHANGED FOR THE ROUTER. The core TypeScript and exposed types for the Router itself have been completely retooled to allow much better, strong type support throughout your routes. Previously this required complex custom setups to work around the lack of internal typing. Now it's included out of the box, but you'll need to follow the instructions.

    This was not an easy change to commit to, but was long overdue. The solution finally settled on allows for a more flexible (yet boiler-platey) approach, or a more rigid one... but allows for many more scenarios than the previous types did.

Other Changes

  • added: nearly all the extras from itty-router-extras have moved in-house to the core library. This library will be deprecated as a result.
  • added: createCors from itty-cors has moved into the core library as well
  • feature: withParams middleware (previously from itty-router-extras) is now possible to use as upstream middleware (e.g. globally) to reduce boilerplate. Previously this was not possible.

Official Documentation Site

We've just launched a itty.dev to house documentation for all the itty projects going forward. Previously, we auto-generated docs from the README, but clearly the documentation needs far outweighed what could feasibly fit within a single long README. See the itty-router section for more details!

See the migration guide for complete details.

Changelog

Sourced from itty-router's changelog.

Changelog

  • v5.0.4
    • fixed: (TypeScript) middleware corrupting downstream request types and args
  • v5.0.2
    • fixed: AutoRouter was missing the router-level generics support of the other 2 routers.
    • fixed: All 3 routers had their 3rd generic argument, ResponseType added per the spec.
  • v5.0.0
    • BREAKING: router.fetch replaces router.handle (now deprecated)
    • BREAKING: "createCors" has been deprecated in favor of "cors" (new options & requirements)
    • changed: previous Router (smallest) is now IttyRouter
    • added: Router (full backwards compatability with previous Router) has been added, including:
      • "before" stage (array of request handlers)
      • "finally" stage (array of response handlers)
      • "catch" stage (single error handler)
    • added: AutoRouter (batteries-included Router)
    • fixed (TS): Routers types have been modified to allow both rotuer-level generics AND route-level generics in the same instance.
    • docs: see Migration guide at https://itty.dev/itty-router/migrations/v4-v5
  • v4.2.2
    • fixed: withContent should return undefined if request.body is undefined
  • v4.2.1
    • maintenance: updated deps, test coverage, removed isomorphic-fetch dev dep
  • v4.2.0
    • added: withContent now parses JSON->formData->text with fallthrough
  • v4.1.1
    • fixed: withContent will successfully parse non-JSON as fallback, preventing errors
  • v4.1.0
    • added: createResponse and all Response helpers support web standards Headers class
  • v4.0.28
    • fixed: withContent throws 400 (instead of 500) on failed JSON parse (@​smcstewart)
  • v4.0.27
    • fixed: .toUpperCase issue that prevented serialization of entire router
  • v4.0.24
    • fixed: createResponse(undefined) should return undefined (not a Response)
  • v4.1.0
    • added: HasContent<ContentType> type to withContent (@​alexrosenfeld10)
    • added: Adds basic text/formData support to supplement the native JSON support of withContent
  • v4.0.00 - Partial changelog below
    • BREAKING: heavy TS rewrite for core Router (thank you, ChatGPT)
    • added: nearly all extras from itty-router-extras
    • added: createCors from itty-cors
    • added: complete documentation at https://itty.dev
    • feature: withParams may be used as upstream middleware (hooray!)
  • v3.0.11 - changed environment build to rollup (from tsup) and code golfed the toQuery logic. (@​DrLoopFall)
  • v3.0.9 - fixes some TS issue, previously requiring you to define Router Methods to chain request definitions. (@​jahands)
  • v3.0.0 - total TS conversion with improved types, adding greedy params (@​markusahlstrand)
  • v2.6.4 - merely a republish, attempting to solve NPM test scores vs CI/CD
  • v2.6.2 - fixes issue with using base path of "/" with route definitions starting with "/" (creating double slash)
  • v2.6.1 - fixes named export in ESM/mjs export
  • v2.6.0 - package now is hybrid export, supporting both ESM (.mjs) and CJS (.js) minified versions

... (truncated)

Commits

Dependabot compatibility score

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 show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @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)

Bumps [itty-router](https://github.com/kwhitley/itty-router) from 3.0.12 to 5.0.4.
- [Release notes](https://github.com/kwhitley/itty-router/releases)
- [Changelog](https://github.com/kwhitley/itty-router/blob/v5.x/CHANGELOG.md)
- [Commits](kwhitley/itty-router@v3.0.12...v5.0.4)

---
updated-dependencies:
- dependency-name: itty-router
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Apr 1, 2024
@dependabot @github
Copy link
Author

dependabot bot commented on behalf of github Apr 8, 2024

Superseded by #54.

@dependabot dependabot bot closed this Apr 8, 2024
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/itty-router-5.0.4 branch April 8, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant