search

kinde-oss / kinde-auth-nextjs

Kinde NextJS SDK - authentication for server rendered apps
https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk/
MIT License
157 stars 24 forks source link

types: middleware types + refactor #209

Open peterphanouvong opened 2 months ago

peterphanouvong commented 2 months ago

Explain your changes

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes in the pull request enhance the authentication middleware by introducing TypeScript type annotations and improving its configurability. The authMiddleware function now accepts a NextRequest type, and the handleMiddleware function has been updated to accept optional parameters, including a structured options object. A new isAuthorized function is added for custom authorization logic. Additionally, the withAuth function is refactored for better flexibility, and a new KindeRequest type is introduced to extend NextRequest.

Changes

File Change Summary
src/authMiddleware/authMiddleware.ts - Modified authMiddleware to accept NextRequest.
- Updated handleMiddleware to accept optional parameters and a structured options object.
- Added KindeRequest type extending NextRequest with kindeAuth property.
- Refactored withAuth for flexible request handling.

Assessment against linked issues

Objective Addressed Explanation
Improve type safety in middleware (undefined) ✅
Enhance configurability of middleware (undefined) ✅

Possibly related issues

Possibly related PRs

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 6d92f1a374b48895309aabda1c0b44e31f3875bc and fddff918cba7be635898f9cc19f40d20620ff4e8.
Files selected for processing (1) * src/authMiddleware/authMiddleware.ts (4 hunks)
Additional comments not posted (4)
src/authMiddleware/authMiddleware.ts (4)
Line range hint `10-32`: **LGTM!** The `authMiddleware` function has been correctly updated to accept a `NextRequest` type for the `request` parameter, improving type safety. The function logic is correct and the `trimTrailingSlash` helper function is correctly implemented. --- `35-48`: **The updated function signature looks good!** The `handleMiddleware` function has been correctly updated to accept optional parameters, including a more structured `options` object and an `onSuccess` callback. This improves flexibility and configurability of the middleware. --- `123-141`: **The `withAuth` function looks good!** The function has been correctly updated to handle both a request object and a middleware function more flexibly. The `KindeRequest` type is correctly defined and enhances the structure of the request object. The function uses the `handleMiddleware` function, which has been reviewed and approved with a verification request. --- `77-82`: **Verify the `isTokenValid` function usage.** The `isTokenValid` utility function is used for token validation, but its implementation is not provided in the context. Please ensure that this function is correctly implemented and handles token validation as expected. Run the following script to verify the function usage:
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.