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.

Sign up for GitHub

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

Jump to bottom

feat: allow custom base path #169

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

feat: allow custom base path #169

wants to merge 10 commits into from

Conversation

freality
Copy link

🔗 Linked issue

Allow custom base path other than /api/auth #168

❓ Type of change

  • 📖 Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

By allowing the user to configure a basePath, the user can implement their NuxtAuthHandler on any route they chose.

This PR adds an optional basePath to the module configuration object (with default /api/auth for backwards compatibility). It generates a #build/auth.config.mjs with #auth-config alias. And uses the configuration variable where needed.

Docs are also updated to include the new basePath configuration.

resolves #168

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@freality
generate #auth-config module
24e7010 
* add basePath to module config w/ default /api/auth
* generate auth.config.mjs module file
* add #auth-config alias
@freality
use basePath variable
6f251a4 
replace hardcoded basePath with config variable
@freality
use ufo
6cb8261 
Use ufo for url manipulation to avoid bad string joins
@freality
update docs
6f76ab9
@freality
cleanup
8da234a
Hebilicious
Hebilicious requested changes Feb 20, 2024
View reviewed changes
Copy link
Owner

@Hebilicious Hebilicious left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for contributing.
This is looking great!
Looks like the tests are failing so this will need a bit more work.
Could you try to remove the ts-expect errors and add a declaration file to handle the config?

packages/authjs-nuxt/src/runtime/lib/server.ts Outdated Show resolved Hide resolved
packages/authjs-nuxt/src/runtime/lib/client.ts Show resolved Hide resolved
packages/authjs-nuxt/src/runtime/lib/client.ts Outdated Show resolved Hide resolved
@freality
Copy link
Author

Looks like the tests are failing so this will need a bit more work.

I'm seeing the same build error when run against the main branch.

@mdowton
Copy link

mdowton commented Mar 22, 2024

Really looking for the feature also is blocking our current work any update @Hebilicious

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hebilicious Hebilicious Awaiting requested review from Hebilicious Hebilicious is a code owner

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Allow custom base path other than /api/auth
3 participants
@freality @mdowton @Hebilicious