feat: user experience improvements and e2e test coverage

[aeneasr]

This patch resolves several issues:

• Adds test IDs to components used by e2e selectors
• Transports the return URL across flows (login/registration, recovery) and also when restarting flows (this should solve a lot of pain for users running into errors).

Related Issue or Design Document

Checklist

• I have read the contributing guidelines and signed the CLA.
• I have referenced an issue containing the design document if my change introduces a new feature.
• I have read the security policy.
• I confirm that this pull request does not address a security vulnerability.
  If this pull request addresses a security vulnerability,
  I confirm that I got approval (please contact [email protected]) from the maintainers to push the changes.
• I have added tests that prove my fix is effective or that my feature works.
• I have added the necessary documentation within the code base (if appropriate).

Further comments

[codecov]

Codecov Report

Attention: Patch coverage is 40.47619% with 50 lines in your changes missing coverage. Please review.

Project coverage is 42.80%. Comparing base (f3fad4d) to head (39a6367).
Report is 10 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #321      +/-   ##
==========================================
+ Coverage   42.43%   42.80%   +0.37%     
==========================================
  Files         136      138       +2     
  Lines        2008     2065      +57     
  Branches      288      303      +15     
==========================================
+ Hits          852      884      +32     
- Misses       1149     1172      +23     
- Partials        7        9       +2     

Components	Coverage Δ
@ory/elements-react	37.44% <40.47%> (+0.65%)	⬆️
@ory/nextjs	65.97% <ø> (ø)

[jonas-jonas]

Also, this change makes the init flow helper available to consumers: #326 wdyt about that?

[aeneasr]

The PR here is working for all flows, #326 is not. I recommend just merging this PR as it's been open long enough, and really doesn't change a lot of functionality except for fixing all the holes with e2e tests.

#326 did not run against the cloud e2e tests i've been working on, and I don't have enough time to spend to rebase it all. So let's get this one here through, and then we can still apply the missing pieces to #326 and merge those improvements.