v3

[rschristian]

Ideas for v3, as I'll forget them otherwise. Certainly not set in stone if anyone has concerns or other ideas. Feedback welcome and appreciated!

• Drops all subpath exports besides ./prerender
  • I believe this was the eventual intention back in the WMR days. I want to keep /prerender, and only offer the prerender script through it, to avoid some headaches with the RTS optional peer dep (see fix: RTS peer dep w/ Vite #13)
• Makes RTS an optional peer dep again
  • It's a minor thing but I'd prefer users having easier control over the versioning as iso is a really shallow wrapper around it.
• Drops hydrate() exports
  • This is a very thin wrapper that a) provides little value and b) is quite hard to name, as it toggles between render() and hydrate() internally and only functions correctly if used w/ iso's prerender().
  • I think we're better off dropping this, it's 4loc to replace in userland and that is much clearer to the user
• Merges useRoute and useLocation
  • useLocation and useRoute have some overlapping properties and can end up firing between renders, leading to tearing. Consolidating down is ideal IMO.
• Renames useRoute().params -> pathParams & useRoute().query -> searchParams
  • We match vue-router in our naming but personally I dislike the ambiguity (params can easily refer to both path parameters & query parameters) and a few people I've spoken to seem to agree. These seem to be better & immediately understandable to anyone, regardless of which routers they've used in the past.

To Do:

• useLocation().url and useLocation().path will just about always match
  • Potentially a bug related to [preact-iso] Support manual URL via <LocationProvider url="/" /> wmr#534
• At least loosely align with the URL Pattern spec
  • Probably the future of every router, we should try to ensure parity so we can easily switch to it in the future without further changes

To Think About:

• There's a bit of an issue in that the user can't easily watch the path and run some code on URL change -- if the component suspends, the URL will change before the new data has become available. We don't really have a good answer for that at the moment.
• Stop passing routing props to user-provided components, this is basically unused due to TS (understandably) getting grumpy over it & it causes extra rerenders w/ nested routers
  • This will break nested routing, so need new way to pass data down