fix(nuxt): update middleware and layouts type declarations #31808

productdevbook · 2025-04-16T03:44:18Z

🔗 Linked issue

closes: productdevbook/better-auth-nuxt#3
resolves #31746

📚 Description

Refactor type declarations for middleware and layouts to correctly reference 'vue-router', improving type safety and consistency across the application.

when we type vue-router we do not see nuxt, the path is defined, why is this so.

…ue-router'

bolt-new-by-stackblitz · 2025-04-16T03:44:21Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-04-16T03:46:19Z

Walkthrough

This change updates the generation of TypeScript declaration files for middleware, layouts, and view transitions in the Nuxt pages module. It replaces the previous module augmentation target, which used a relative path to a local composables file in the build directory, with a fixed global module name 'nuxt/app'. This modification applies to the types/middleware.d.ts, types/layouts.d.ts, and, if enabled, types/view-transitions.d.ts templates. Additionally, the getContents functions for these templates have been simplified by removing the nuxt parameter where it was previously present, now only receiving app or no parameters. The semantic content of the generated types remains the same, with no changes to exported or public API signatures.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a702583 and 40d8785.

📒 Files selected for processing (1)

packages/nuxt/src/pages/module.ts (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/nuxt/src/pages/module.ts

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: code

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai · 2025-04-16T03:46:29Z

Walkthrough

The update adjusts the internal logic for generating TypeScript declaration files related to middleware, layouts, and view transitions in the Nuxt pages module. The main change is that the template functions responsible for producing these type declarations now only use the app parameter, omitting the previously used nuxt parameter. Additionally, the logic that computed a relative path to a composables file within the build directory has been removed. Instead of augmenting a module at a dynamically determined composables path, the type declarations now directly augment the 'vue-router' module. The structure and content of the type declarations themselves remain unchanged, and there are no modifications to any exported or public APIs—these adjustments are confined to the internal template generation process.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4edb14c and a702583.

📒 Files selected for processing (1)

packages/nuxt/src/pages/module.ts (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (3)

packages/nuxt/src/pages/module.ts (3)

591-602: Improved type declaration by directly augmenting 'vue-router'

This change simplifies the middleware type declarations by directly augmenting the 'vue-router' module instead of using a dynamically computed path. This ensures better type safety and developer experience when using middleware in Nuxt applications.

627-637: Simplified layouts type declarations with direct module augmentation

The layouts type declaration template now directly augments the 'vue-router' module, providing a more consistent approach to type declarations. This change removes the dependency on dynamically computed paths and better aligns with the Vue Router type system.

644-653: Standardized view transition type declarations

The view transition type declarations now follow the same pattern as middleware and layouts by directly augmenting the 'vue-router' module. This creates a more consistent approach to type declarations throughout the codebase.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-04-16T03:48:23Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@31808

nuxt

npm i https://pkg.pr.new/nuxt@31808

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@31808

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@31808

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@31808

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@31808

commit: 40d8785

codspeed-hq · 2025-04-16T03:59:00Z

CodSpeed Performance Report

Merging #31808 will not alter performance

_{Comparing productdevbook:fix/middleware-types (40d8785) with main (14e12b6)}

Summary

✅ 10 untouched benchmarks

danielroe · 2025-04-16T08:56:11Z

the type tests are failing. you might want to check the pr that introduced the fully resolved declaration path to see why we did it.

it would also be helpful if you could prepare a reproduction (without a module) that shows the issue?

productdevbook · 2025-04-16T10:56:17Z

it works in normal nuxt projects, but when you write .d.ts in .nuxt it will not work at all.

so how do we solve the 2nd problem here, the following problem

…larations (#31808)

productdevbook added 2 commits April 16, 2025 06:40

fix(types): update middleware and layouts type declarations to use 'v…

afcb69f

…ue-router'

fix(types): correct string quotes in 'vue-router' module declaration

a702583

productdevbook requested a review from danielroe as a code owner April 16, 2025 03:44

github-actions bot added 3.x bug labels Apr 16, 2025

productdevbook changed the title ~~fix(types): update middleware and layouts type declarations~~ fix(nuxt): update middleware and layouts type declarations Apr 16, 2025

productdevbook mentioned this pull request Apr 16, 2025

vue-router types don't change productdevbook/better-auth-nuxt#3

Closed

1 task

danielroe added 2 commits April 20, 2025 20:27

fix: augment nuxt/app module instead

da9626e

Merge remote-tracking branch 'origin/main' into fix/middleware-types

40d8785

danielroe approved these changes Apr 20, 2025

View reviewed changes

danielroe merged commit c888e07 into nuxt:main Apr 20, 2025
46 checks passed

github-actions bot mentioned this pull request Apr 20, 2025

v4.0.0 #27716

Draft

danielroe pushed a commit that referenced this pull request Apr 23, 2025

fix(nuxt): augment nuxt/app in generated middleware and layouts dec…

7b1cce0

…larations (#31808)

github-actions bot mentioned this pull request Apr 23, 2025

v3.17.0 #31687

Merged

productdevbook mentioned this pull request Apr 28, 2025

fix: middleware types productdevbook/better-auth-nuxt#5

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(nuxt): update middleware and layouts type declarations #31808

fix(nuxt): update middleware and layouts type declarations #31808

productdevbook commented Apr 16, 2025 •

edited by danielroe

Loading

bolt-new-by-stackblitz bot commented Apr 16, 2025

coderabbitai bot commented Apr 16, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot commented Apr 16, 2025

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

pkg-pr-new bot commented Apr 16, 2025 •

edited

Loading

codspeed-hq bot commented Apr 16, 2025 •

edited

Loading

danielroe commented Apr 16, 2025

productdevbook commented Apr 16, 2025 •

edited

Loading

fix(nuxt): update middleware and layouts type declarations #31808

fix(nuxt): update middleware and layouts type declarations #31808

Conversation

productdevbook commented Apr 16, 2025 • edited by danielroe Loading

🔗 Linked issue

📚 Description

bolt-new-by-stackblitz bot commented Apr 16, 2025

coderabbitai bot commented Apr 16, 2025 • edited Loading

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot commented Apr 16, 2025

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

pkg-pr-new bot commented Apr 16, 2025 • edited Loading

codspeed-hq bot commented Apr 16, 2025 • edited Loading

CodSpeed Performance Report

Merging #31808 will not alter performance

Summary

danielroe commented Apr 16, 2025

productdevbook commented Apr 16, 2025 • edited Loading

productdevbook commented Apr 16, 2025 •

edited by danielroe

Loading

coderabbitai bot commented Apr 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Apr 16, 2025 •

edited

Loading

codspeed-hq bot commented Apr 16, 2025 •

edited

Loading

productdevbook commented Apr 16, 2025 •

edited

Loading